LINEAR EQUIPAMENTOS RUA SÃO JORGE, 267/269 - TELEFONE: (11) SÃO CAETANO DO SUL - SP - CEP:

Transcrição

1 LINEAR EQUIPAMENTOS RUA SÃO JORGE, 267/269 - TELEFONE: (11) SÃO CAETANO DO SUL - SP - CEP: SISTEMA HCS 2005 PROTOCOLO DE COMUNICAÇÃO (Baseado no Guarita Vr5.0x Última modificação: 09/03/2009) INFORMAÇÕES INICIAIS O Módulo Guarita possui entre outras funções a comunicação com o computador, permitindo assim a execução de várias tarefas sem necessitar operação direta com o Guarita. A comunicação entre este e o computador é feita através de um Cabo de Comunicação, que é conectado em uma de suas extremidades na Porta Serial do computador (padrão DB9), e a outra no próprio Módulo Guarita (conector PC-RS232, 3 vias): Caso o computador não possua uma porta serial livre, pode-se utilizar um Conversor USB/Serial, encontrado facilmente em lojas de informática. Cada comando utilizado é formado por frame de bytes, e cada byte tem sua interpretação, assim como cada frame tem sua quantidade de bytes variada. A função do computador é enviar esse frame ao Guarita e aguardar uma resposta, para então interpretá-la e exibi-la de forma correta para o usuário final. Caso o frame enviado ao Guarita seja incorreto, o mesmo não responderá, cabendo ao programador lidar com essa situação, implementando timeouts, por exemplo. A taxa de transmissão padrão utilizada para a comunicação é de bps (baudrate), sem paridade, 8 bits de dados por byte, e 1 bit de parada (stop bit). Cada byte do frame deverá ser enviado num intervalo mínimo de 1 ms e máximo de 6 ms. A taxa de transmissão pode ser configurada no Módulo Guarita também para 9600 bps e bps. Para garantir a integridade do frame, o último byte sempre será um checksum, indicado neste protocolo por <CS>, e corresponde a soma dos bytes anteriores do frame. Esse byte, em hexadecimal, assume valor máximo igual a FFh. Logo, se a soma exceder esse valor, deve-se considerar apenas os dois nibbles menos significativos do byte. Exemplo: a soma de certos bytes resultou em 145h, logo o byte <CS> será apenas 45h. Também é possível efetuar a leitura direta das informações armazenadas pela Memória Externa, quando conectada ao Módulo Guarita. Neste caso, o frame de comando terá um byte identificado como <indexador>, que assume os valores 00 para leitura da Memória Interna, ou 01 a 08, relativos aos 8 bancos da Memória Externa respectivamente. Caso o byte assuma um dos valores não nulos e a Memória Externa não esteja conectada, o Módulo irá devolver uma resposta padrão para o comando utilizado (00 + <comando> + CS).

2 2 ÍNDICE DE COMANDOS COMANDOS PARA CONFIGURAÇÕES Escrever Identificação (Linha 2) Escrever Identificação (Linha 3) Ler Identificação Programar Módulo Guarita Ler Programação do Módulo Guarita Alterar Data e Hora Ler Data e Hora Acionar Saídas (Relés) Gravar Labels (Progressivo) Ler Labels (Progressivo)... 4 COMANDOS PARA MANIPULAÇÃO DE CONTROLES Ler Número de Controles/TAGs/Cartões Ler Controles/TAGs/Cartões (Backup Módulo Guarita ao PC Progressivo) Enviar Controles/TAGs/Cartões (Restore PC ao Módulo Guarita Progressivo) Cadastrar Controles/TAGs/Cartões Apagar Controles/TAGs/Cartões Ler Controle Específico Editar Controles/TAGs/Cartões Atualizar Receptores... 6 COMANDOS PARA MANIPULAÇÃO DE EVENTOS Ler Número de Eventos Ler Eventos (Progressivo) Enviar Automaticamente o Evento Ler Último Evento com Apagamento Automático Apagar Todos os Eventos Apagar Evento Atual... 8 OUTROS COMANDOS Reset Remoto Ler Estado das Entradas Digitais (Módulo Passagem) Ler Pacote de Eventos Ler Pacote de Controles/TAGs/Cartões Enviar Automaticamente Pacote de Eventos Ler Pacote de Labels Ler versão do Módulo Guarita... 9 EXEMPLOS DE FRAMES... 10

3 3 COMANDOS PARA CONFIGURAÇÕES Os comandos abaixo são relativos às configurações de funcionamento e visualização do Módulo Guarita. 1. Escrever Identificação (Linha 2) Altera o texto da Linha 2 no LCD do Módulo Guarita <20 caracteres em ASCII> + <CS> Escrever Identificação (Linha 3) Altera o texto da Linha 3 no LCD do Módulo Guarita <20 caracteres em ASCII> + <CS> Ler Identificação Permite a leitura da Linha 2 e Linha 3 do LCD <indexador> + <CS> <indexador> + <40 caracteres em ASCII> + <CS> 4. Programar Módulo Guarita Permite a alteração da parametrização do Módulo Guarita <num. andares> + <num. aptos. por andar> + <num. blocos> + <tempo teclas> + <flag setup 1> + <num_logs> + <tempo_logs> + <conta atualizações> + <tempo desp. porteiro> + <início desp. porteiro> + <fim desp. porteiro> + <relé desp. porteiro> + <relé pânico> + <porta serial> + <função tecla 1> + <função tecla 2> + <função tecla 3> + <função tecla 4> + <função tecla 5> + <função tecla 6> + <CS> Ler Programação do Módulo Guarita Permite a visualização da parametrização do Módulo Guarita ou da Memória Externa A + <indexador> + <CS> A + <indexador> + <num. andares> + <num. aptos. por andar> + <num. blocos> + <tempo teclas> + <flag setup 1> + <num_logs> + <tempo_logs> + <conta atualizações> + <tempo desp. porteiro> + <início desp. porteiro> + <fim desp. porteiro> + <relé desp. porteiro> + <relé pânico> + <porta serial> + <função tecla 1> + <função tecla 2> + <função tecla 3> + <função tecla 4> + <função tecla 5> + <função tecla 6> + <CS> Onde: <num. andares> De 0 a 99 andares (00h a 63h) <num. aptos. por andar> De 0 a 99 aptos. por andar (00h a 63h) <num. blocos> Bloco A a Bloco P (00h a 0Fh) <tempo teclas> Temporização das Teclas: 00h = Desligado; 01h a 63h = 1 a 99 seg. Bit 7 e 6: Filtro de Eventos Externos (00 = Nível 1; 01 = Nível 2; 11 = Nível 3) Bit 5: Botão de Pânico (0 = B3 e B4; 1 = B4) Bit 4: Pânico (0 = Desligado; 1 = Ligado) <flag setup 1> Bit 3: Vago Bit 2: Vago Bit 1: Desperta-Porteiro Silencioso (0 = Desligado; 1 = Ligado) Bit 0: Pânico Silencioso (0 = Desligado; 1 = Ligado) <num_logs> Quantidade de eventos a acumular: 00h = OFF / 01h a 32h = 1 a 50 <tempo_logs> Tempo em min. para enviar acumulados: 00h = OFF / 01 a 63 = 1 a 99 min. <conta atualizações> Este byte não deve ser alterado. Manter valor anterior. <tempo desp. porteiro> 00h = Desabilitado; 0Fh = 15 min; 1Eh = 30 min; 2Dh = 45 min <início desp. porteiro> 0 horas a 23 horas (00h a 23h) <fim desp. porteiro> 0 horas a 23 horas (00h a 23h) <relé desp. porteiro> 0 seg. a 30 seg. (00h a 1Eh) <relé pânico> 0 seg. a 30 seg. (00h a 1Eh) <porta serial> 00h = 9600 bps; 01h = bps; 02h = bps Bit 7 e 6: Tipo do Dispositivo (00 = Rec. RF; 01 = Rec. TAG; 10 = Módulo Passagem; 11 = <função tecla 1 a 6> Rec. Cartão) Bit 5, 4 e 3: Número do Dispositivo (000 = 1 a 111 = 8)

4 4 Bit 2, 1 e 0: Saída (001 = 1 a 100 = 4) Se bits 2, 1 e 0 iguais a 000, tecla configurada para NENHUM (desabilitada). 6. Alterar Data e Hora Altera a data e a hora exibidas pelo Módulo Guarita B + <dia> + <mês> + <ano> + <hora> + <minutos> + <segundos> + <CS> Frame Guarita B + 0B 7. Ler Data e Hora Permite a visualização da Data e da Hora atuais C + 0C C + <dia> + <mês> + <ano> + <hora> + <minutos> + <segundos> + <CS> 8. Acionar Saídas (Relés) Permite acionar os relés dos dispositivos conectados ao Módulo Guarita D + <tipo dispositivo> + <num. dispositivo> + <saída> + <CS> Não retorna resposta Onde: <tipo dispositivo> Rec. RF (00h), Rec. TAG (01h), Mod. Passagem (02h), Rec. Cartão (03h) <num. dispositivo> 1 a 8 (00h a 07h) <saída> Saída 1 a 4 (01h a 04h) dos Receptores ou Módulo Passagem 9. Gravar Labels (Progressivo) Possibilita a programação dos 64 labels de identificação disponíveis no Módulo Guarita <frame label> + <CS> 00h = Guarita recebeu, envie o próximo frame. 10. Ler Labels (Progressivo) Efetua a leitura dos 64 labels de identificação do Módulo Guarita ou da Memória Externa <indexador> + <CS> <indexador> + <frame label> + <CS> Após o recebimento da resposta, o Módulo Guarita aguarda, durante 5 segundos, um byte confirmando o recebimento pelo computador para enviar, assim, o próximo frame de label: 00h Computador recebeu, envie o próximo frame. FFh Computador não recebeu, envie o mesmo frame. Onde: Dados <frame label> (8 caracteres ASCII) Nome para Receptor RF (1 a 8) 1 a 8 Nome para Saídas (1 a 3) do Receptor RF 1 9 a 11 Nome para Saídas (1 a 3) do Receptor RF 2 12 a 14 Nome para Saídas (1 a 3) do Receptor RF 3 15 a 17 Nome para Saídas (1 a 3) do Receptor RF 4 18 a 20 Nome para Saídas (1 a 3) do Receptor RF 5 21 a 23 Nome para Saídas (1 a 3) do Receptor RF 6 24 a 26 Nome para Saídas (1 a 3) do Receptor RF 7 27 a 29 Nome para Saídas (1 a 3) do Receptor RF 8 30 a 32 Nome para Rec. Cartão (1 a 8) 33 a 40 Nome para Blocos (A a P) 41 a 56 Nome para Rec. TAG (1 a 8) 57 a 64

5 5 COMANDOS PARA MANIPULAÇÃO DE CONTROLES Os comandos abaixo são utilizados para leitura e alteração das informações de Controles RF, TAGs e Cartões armazenados pelo Módulo Guarita, ou por uma Memória Externa. 11. Ler Número de Controles/TAGs/Cartões Envia a quantidade de controles cadastrados no Módulo Guarita, ou armazenados na Memória Externa <indexador> + <CS> <indexador> + <num. high> + <num. low> + <CS> Onde <num. high> e <num. low> são respectivamente o byte mais significativo e menos significativo da informação. Basta concatená-los para obter a quantidade de controles (4 bytes). 12. Ler Controles/TAGs/Cartões (Backup Módulo Guarita ao PC Progressivo) Envia ao computador o frame de controle, contendo as informações de cadastro deste E + <indexador> + <CS> E + <indexador> + <frame controle> + <CS> Após o recebimento da resposta, o Módulo Guarita aguarda, durante 5 segundos, um byte confirmando o recebimento pelo computador para enviar, assim, o próximo frame de controle: 00h Computador recebeu, envie o próximo frame. FFh Computador não recebeu, envie o mesmo frame. 13. Enviar Controles/TAGs/Cartões (Restore PC ao Módulo Guarita Progressivo) Executa o processo inverso ao Backup, enviando o frame de controle ao Módulo Guarita. Note que nesta operação, os Controles/TAGs/Cartões atualmente cadastrados no Módulo serão substituídos pelos frames restaurados! F + <frame controle> + <CS> 00h = Guarita recebeu, envie o próximo frame Para garantir que todos os frames foram restaurados com sucesso, o computador deverá enviar, ao final de todos os frames de controle, um frame nulo (todos os 32 bytes com FFh). O frame de controle, ou <frame controle>, é formado por 32 bytes: 01 Nibble Alto - Tipo de controle (0 = Apagado; 1 = RF; 2 = TAG; 3 = Cartão) Nibble Baixo - Dígito 1 do Número de Série 02 Dígitos 2 e 3 do Número de Série 03 Dígitos 4 e 5 do Número de Série 04 Dígitos 6 e 7 do Número de Série 05 Parte Alta do Contador de Acionamentos 06 Parte Baixa do Contador de Acionamentos 07 0 a 99 andares (00h a 63h) 08 Bit 7: Dígitos de Apartamento (0 = 1 Dígito; 1 = 2 Dígitos) Bit 6 a 0: 0 a 99 apartamentos ( a ) 09 Nibble Alto - Bloco A a P (0h a Fh) Nibble Baixo - Vago 10 Receptores onde o controle RF irá funcionar. Bit 7 a 0: Receptor RF 8 a 1 (0 = Não cadastrado; 1 = Cadastrado) 11 Rec. TAG ou Rec. Cartão onde o TAG ou Cartão irá funcionar. Bit 7 a 0: Rec. TAG/Cartão 8 a 1 (0 = Não cadastrado; 1 = Cadastrado) 12 a Caracteres em ASCII (Identificação do Controle) 32 Nibble Alto Última saída acionada (1 a 4 = RF / 1 a 2 = TAG e Cartão) Nibble Baixo - Status da bateria (0 a F = Boa a Ruim) 14. Cadastrar Controles/TAGs/Cartões Cadastra um controle no Módulo Guarita <frame controle> + <CS> <resultado> + <CS> Onde o byte <resultado> retorna: 00h (Cadastrado com sucesso), 01h (Memória cheia), 02h (Controle já aprendido) e 03h (Controle fora da parametrização). Dica: Para o cadastramento de controles são necessários, principalmente, o número de série e o valor do contador de acionamentos do mesmo. Essas informações podem ser obtidas na tela do próprio Módulo Guarita (quando em Modo de Programação), ou ainda através de um frame específico que é enviado ao computador, quando também em Modo de Programação.

6 Vire a chave de programação do Módulo, pressione ENTER para entrar no menu principal e selecione a opção P01 - Grava. Selecione uma das opções (Tx, TAG ou Cartão) e siga a orientação mostrada. Um frame de 8 bytes será enviado ao PC: 01 Nibble Alto: 0 - Vago Nibble Baixo: Dígito 1 do Número de Série 02 Dígito 2 e 3 do Número de Série 03 Dígito 4 e 5 do Número de Série 04 Dígito 6 e 7 do Número de Série 05 Parte Alta do Contador de Acionamentos 06 Parte Baixa do Contador de Acionamentos Bit 7 a 4: Tipo de controle (0001 = Controle RF; 0010 = Controle TAG; 0011 = Controle Cartão) 07 Bit 3: Estado da bateria (0 = Boa; 1 = Fraca) Bit 2, 1 e 0: Botão acionado (001 = B1; 010 = B2; 011 = B3; 100 = B4) 08 Checksum Apagar Controles/TAGs/Cartões Remove um controle específico do Módulo Guarita <SA> + <SB> + <SC> + <SD> + <CS> <resultado> + <CS> Onde: <SA> <SB> <SC> <SD> <Resultado> Identificação Nibble Alto: 0 - Vago Nibble Baixo: Dígito 1 do Número de Série Dígito 2 e 3 do Número de Série Dígito 4 e 5 do Número de Série Dígito 6 e 7 do Número de Série 00h = Apagado com sucesso; 01h = Controle não encontrado; 02h = Falha 16. Ler Controle Específico Efetua a leitura das informações de um controle específico B + <SA> + <SB> + <SC> + <SD> + <CS> B + <frame controle> + <CS> Caso o controle não seja encontrado, o <frame controle> conterá apenas um byte zerado (FFh). 17. Editar Controles/TAGs/Cartões Altera as informações de um controle já cadastrado C + <frame controle> + <CS> C + <resultado> + <CS> Onde o byte <resultado> retorna: 00h (Controle alterado), 01h (Controle não encontrado) e 02h (Controle fora da parametrização) 18. Atualizar Receptores Solicita a atualização da memória dos Receptores D + 1D D + 1D

7 7 COMANDOS PARA MANIPULAÇÃO DE EVENTOS Os comandos abaixo são utilizados para leitura dos eventos armazenados no Módulo Guarita ou na Memória Externa. 19. Ler Número de Eventos Retorna a quantidade de eventos armazenados no Módulo Guarita ou na Memória Externa <indexador> + <CS> <indexador> + <num. high> + <num. low> + <CS> Onde <num. high> e <num. low> são respectivamente, o byte mais significativo e menos significativo da informação. Basta concatená-los para obter a quantidade de eventos (4 bytes). 20. Ler Eventos (Progressivo) Envia ao computador o frame de evento armazenado no Módulo Guarita ou na Memória Externa <indexador> + <CS> <indexador> + <frame evento> + <CS> Após o recebimento da resposta, o Módulo Guarita aguarda, durante 5 segundos, um byte confirmando o recebimento pelo computador para enviar, assim, o próximo frame de evento: 00h Computador recebeu, envie o próximo frame. FFh Computador não recebeu, envie o mesmo frame. O <frame evento> é formado por 16 bytes: Nibble Alto: Tipo de Evento 0 = Controle Acionado (Controle RF, TAG ou Cartão) 1 = Evento de Passagem (Módulo Passagem) 2 = Módulo Guarita Ligado 3 = Desperta-Porteiro 4 = Mudança da Programação do Guarita 5 = Acionamento das Teclas do Guarita 6 = Vago 01 7 = Vago 8 = Tentativa de Clonagem 9 = Pânico A = Estado das Entradas Digitais (Módulo Passagem) B = Restore Efetuado C = TAG sem Vaga D = Backup Automático Realizado E = Backup Manual Realizado Nibble Baixo: Dígito 1 do Número de Série 02 Dígito 2 e 3 do Número de Série 03 Dígito 4 e 5 do Número de Série 04 Dígito 6 e 7 do Número de Série 05 : 06 : 07 Hora : Minuto : Segundos 08 / 09 / 10 Dia / Mês / Ano Nibble Alto: Tipo de Dispositivo 0 = Receptor RF 1 = Receptor TAG 11 2 = Módulo Passagem 3 = Receptor Cartão Nibble Baixo: Número do Dispositivo 1 a 8 (0 a 7) 12 Andar Bit 7: Dígitos de Apartamento (0 = 1 Dígito; 1 = 2 Dígitos) 13 Bit 6 a 0: Apartamento Nibble Alto: Bloco A a P (0 a F) Nibble Baixo: 14 Bit 3: Estado da Bateria (0 = Boa; 1 = Fraca) Bit 2: Vago Bit 1 e 0: Botão acionado (01 = B1; 02 = B2; 11 = B3; 00 = B4) Nibble Alto: Tipo de controle (0 = Apagado; 1 = Controle RF; 2 = TAG; 3 = Cartão) 15 Nibble Baixo: Saída acionada (1 a 4) ou Evento de Passagem (Módulo Passagem) ou Estado das Entradas Digitais (Módulo Passagem) Tempo de Passagem (00h a FFh) x 10 ms, se Tipo de Evento = 1 16 Pânico ou Desperta-Porteiro não atendido (FFh), se Tipo de Evento = 3 ou 9

8 21. Enviar Automaticamente o Evento Quando ocorre um acionamento ou outro evento com o Módulo Guarita, este envia automaticamente para o computador o frame de evento, constituindo assim, um evento em tempo real. Não necessário <frame evento> + <CS> Ler Último Evento com Apagamento Automático Nesta opção, é possível receber o último evento e apagá-lo automaticamente, evitando que o mesmo seja armazenado na memória do Módulo Guarita <frame evento> + <CS> 23. Apagar Todos os Eventos Apaga todos os eventos armazenados no Módulo Guarita Obs.: Dependendo da quantidade de eventos a serem apagados, o Módulo poderá demorar para enviar a resposta. 24. Apagar Evento Atual Apaga o último evento ocorrido (atual) e salvo no Módulo Guarita

9 9 OUTROS COMANDOS 25. Reset Remoto Efetua a função da tecla Reset presente no Módulo Guarita Ler Estado das Entradas Digitais (Módulo Passagem) Solicita a situação das 4 entradas digitais presentes no Módulo Passagem, quando conectado ao Módulo Guarita <num. passagem> + <CS> <estado> + <CS> Onde <num. passagem> varia de 00h a 07h e corresponde ao número do Módulo Passagem na rede CAN (1 a 8). Como Resposta, será enviado: <estado> Nibble Alto: Vago (0) Nibble Baixo: Estado das entradas Bit 3: Entrada Digital 4 (0 = Desligado; 1 = Ligado) Bit 2: Entrada Digital 3 (0 = Desligado; 1 = Ligado) Bit 1: Entrada Digital 2 (0 = Desligado; 1 = Ligado) Bit 0: Entrada Digital 1 (0 = Desligado; 1 = Ligado) 27. Ler Pacote de Eventos Envia ao computador pacotes com 50 frames de evento, otimizando o processo de leitura F F 50 x [00 + 1F <frame evento> + <CS>] Após o recebimento do pacote, o Módulo Guarita aguarda, durante 15 segundos, um byte confirmando o recebimento pelo computador para enviar, assim, o próximo pacote: 00h Computador recebeu, envie o próximo pacote. FFh Computador não recebeu, envie o mesmo pacote. 28. Ler Pacote de Controles/TAGs/Cartões Envia ao computador pacotes com 27 frames de controle, otimizando o processo de leitura x [ <frame controle> + <CS>] Após o recebimento do pacote, o Módulo Guarita aguarda, durante 15 segundos, um byte confirmando o recebimento pelo computador para enviar, assim, o próximo pacote: 00h Computador recebeu, envie o próximo pacote. FFh Computador não recebeu, envie o mesmo pacote. 29. Enviar Automaticamente Pacote de Eventos Envia automaticamente ao computador os últimos eventos gerados, em quantidade ou tempo específico. Não necessário Y x [ <frame evento> + <CS>] O parâmetro Y de repetição do frame depende da configuração de envio do Módulo Guarita, que pode ser: 1 a 50 Número de eventos a acumular. 1 a 99 Tempo de envio dos pacotes, em minutos. 30. Ler Pacote de Labels Envia ao computador um pacote com os 64 frames de label x [ <frame label> + <CS>] 31. Ler versão do Módulo Guarita Envia ao computador a versão do hardware do Módulo Guarita <versao1> + <versao2> + <release> + <build> + <cs> Os bytes <versao1>, <versao2>, <release> e <build> encontram-se em ASCII.

10 10 EXEMPLOS DE FRAMES Abaixo seguem alguns exemplos de frames em hexadecimal, para familiarização com os comandos. Ler Identificação (Memória Interna) P C 49 4E R D A Onde os 40 bytes em ASCII representam: Linha 2 : LINEAR HCS Linha 3 : SISTEMA HCS 2008 Ler Data e Hora P R 00 0C 0C 00 0C A Data : 09/01/08 Hora : 11:33:18 Acionar Saídas (Relés) P 00 0D E R - Aciona a Saída 1 (Relé 1) do Receptor RF 1. Ler Número de Eventos (Memória Interna) Ler versão do Módulo Guarita P R D1 DD Quantidade de eventos: 1745 P R B 28 Versão: k ou Versão: 5.02k (conforme display do Módulo Guarita) Frame de Controle (<frame controle>) Tradução: AB F 6E F 6C C Item Descrição Tipo de Dispositivo Controle RF Número de Série 40050AB Contador de Acionamentos 0281 (ou 614 em decimal) Andar 24 Apartamento 02 (dois dígitos de apartamento) Bloco A Cadastrado no Receptor RF? Sim, Receptor RF 1 Cadastrado no Receptor TAG ou Cartão? Não Identificação Controle 4 teclas (em ASCII) Último botão acionado Botão 2 Status da bateria Boa

11 11 Frame de Evento (<frame evento>) Tradução: AB Item Descrição Tipo de Eventos Controle acionado Número de Série 40050AB Hora do Evento 12:04:54 Data do Evento 09/01/08 Dispositivo Acionado Receptor RF 1 Andar 24 Apartamento 02 (dois dígitos de apartamento) Bloco A Bateria Boa Botão Acionado Botão 1 Tipo do Dispositivo Controle RF Saída Acionada Saída 1 (Relé 1)