____________________________________________________________________________

Mdulo RF U-BEEMAX
V 2.0 Protocolo IEEE 802.15.4 REV 10-18072013

Fractum Indstria e Comrcio de Equipamentos Eletrnicos LTDA - Av. Antnio Amrico Junqueira 335 Pr do Sol - Santa Rita do Sapuca-MG - CEP 37540-000 - TEL: 55 35 3471 0019

Site: www.fractumrf.com - Email: contato@fractumrf.com

____________________________________________________________________________________________________________________

- 1 - Rev01

____________________________________________________________________________

1-MDULO U-BEE
O modulo de RF U-Bee foi desenvolvido para trabalhar sob a especificao IEEE 802.15.4 atendendo s necessidades de baixo custo, baixo consumo de energia, e monitoramento de sensores em redes sem fio. O mdulo requer mnimo consumo para operao e oferece comunicao e troca de dados entre dispositivos de forma segura. O U-Bee trabalha na banda de freqncia ISM 2,4GHz.

1.1-CARACTERSTICAS ESPECIAIS
Mdulo RF Alcance Indoor/Centros urbanos: at 300m (Antena 3dBi Omni) Alcance Outdoor Visada Direta: at 1300m (Antena 3dBi Omni) Potncia de Transmisso: 158mW (+22 dBm) Sensibilidade de Recepo: -102 dBm Taxa de Dados: 250 Kbps Rede e Segurana Suporta reenvio de mensagens e recebimento de ACKs (Acknowledgements) DSSS (Direct Sequence Spread Spectrum) Endereamento de Fonte/Destino Comunicaes Broadcast e Unicast Suporta topologias Ponto-a-Ponto, Ponto-a-Multiponto, Peer-to-Peer, Mesh Baixo Consumo Corrente de Transmisso: 49mA Corrente de Recepo: 52mA Consumo em Sleep: 50uA Conversor Analgico-Digital 6 Entradas para Converso Analgica para Digital de 10bits Facilidade de uso Simplicidade de montagem Pequeno formato do mdulo Modo de comandos AT para configurao dos parmetros do mdulo Modo API Application Programming Interface Variedade de Comandos
____________________________________________________________________________________________________________________

- 2 - Rev01

____________________________________________________________________________

1.2-ESPECIFICAES
A tabela abaixo mostra as especificaes tcnicas para o mdulo U-Bee:

Desempenho Indoor/Centros Urbanos - 300m (Antena 3dBi Omni) Visada Direta - 1300m (Antena 3dBi Omni) Potencia mxima de sada de transmisso 158mW (+22dBm) Taxa de Dados RF 250 Kbps Taxa de Dados Serial (Configurvel por Software) - 2400-115200 bps Sensibilidade Receptor - -102 dBm Especificaes Tcnicas Tenso de Operao 2.4-3.6V (3.3V tpico) Consumo de corrente (tpico): Modo TX 49mA Modo RX 52mA Especificaes Gerais Freqncia de Operao ISM 2.4GHz Dimenses 48mm x 25mm Faixa de temperatura: -40 0 C a +85 0 C (Industrial) Especificaes de Rede (Networking) Topologias de Rede Ponto a ponto, Ponto - multiponto, Peer-to-peer, Mesh Canal de Operao Configurvel por Software 16 Canais sequenciais Opes de endereamento Rede, Canal e Endereos

____________________________________________________________________________________________________________________

- 3 - Rev01

____________________________________________________________________________

1.3-DESENHO MECNICO
A figura abaixo mostra o desenho mecnico para o mdulo de RF U-Bee.

Figura 1.01 Desenho Mecnico U-Bee

____________________________________________________________________________________________________________________

- 4 - Rev01

____________________________________________________________________________

1.4-PINAGEM
A tabela abaixo mostra a pinagem para o mdulo U-Bee: Pino 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Nome VCC DOUT DIN RESET DIO9 IFALHA IRX CLOCKOUT DIO8 GND AD3/DIO3 DIO6 ________ ON / SLEEP AD0/DIO0 AD4/DIO4 AD5/DIO5 DI07 AD2/DIO2 AD1/DIO1 REDE Direo Sada Entrada Entrada Entrada/Sada Sada Sada Sada Entrada/Sada Entrada/Sada Entrada/Sada Entrada Entrada/Sada Entrada/Sada Entrada/Sada Entrada/Sada Entrada/Sada Entrada/Sada Sada Descrio Alimentao + 3,3V Sada de dados da USART Entrada de dados da USART Inicializa mdulo (um pulso nvel 0 de pelo menos 200ms) Entrada/Sada Digital 1 Indicao de Falha na Comunicao Indicao de dado recebido Sada de Clock de 4MHz Entrada / Sada Digital 8 Terra Entrada Analgica 3 / Entrada / Sada Digital 3 Entrada/Sada Digital 6 Modo de Operao Entrada Analgica 0 / Entrada / Sada Digital 0 Entrada Analgica 4/ Entrada / Sada Digital 4 Entrada Analgica 5 / Entrada / Sada Digital 5 Entrada / Sada Digital 7 Entrada Analgica 2 / Entrada / Sada Digital 2 Entrada Analgica 1 / Entrada / Sada Digital 1 Indicao de REDE

____________________________________________________________________________________________________________________

- 5 - Rev01

____________________________________________________________________________

Montagem: Conexo mnima: VCC, GND, DIN:

O resistor R1 apenas garante que na ausncia de conexes seriais o dispositivo tenha um valor fixo em sua entrada de dados serial. Para configurar o dispositivo no necessrio retirar o resistor de pull-up (R1). Caso j possua um circuito de comunicao serial conectado permanentemente ao modulo U-Bee este resistor poder ser dispensado. Este resistor pode ser de 10K a 150Kohms. Conexo para atualizao de firmware: VCC, GND, DOUT, DIN. O mdulo inclui um resistor de Pull-up de 150Kohms no pino de RESET.

____________________________________________________________________________________________________________________

- 6 - Rev01

____________________________________________________________________________

1.5-CARACTERSTICAS ELTRICAS
Caractersticas DC (3.6Vdc):
Smbolo ITX IRX ISLEEP Caracterstica Corrente Transmisso Corrente Recepo Corrente em Sleep Condio VCC=3.3V VCC=3.3V VCC=3.3V Mnimo 50 Tpico 49 52 95 Mximo 200 Unidade mA mA uA

Caractersticas Conversor Analgico-Digital (2.4-3.6Vdc):

Smbolo NR ET VAIN TX Caracterstica Resoluo Erro total Tenso Analgica de entrada Impedncia da fonte de tenso analgica Condio Mnimo VSS-0.3 Tpico 10 1 Mximo Unidade bits LSb V k

3
VCC + 0.3 10

2-FUNCIONAMENTO MDULO U-BEE

2.1-COMUNICAO SERIAL
O mdulo UBee faz a interface com o dispositivo host atravs de uma porta serial assncrona. Atravs dela, o mdulo pode se comunicar com qualquer dispositivo que seja compatvel com os nveis lgicos e de tenso da USART; ou atravs de um conversor de nvel para qualquer dispositivo (Exemplo: RS-232, RS485 ou interface USB).

____________________________________________________________________________________________________________________

- 7 - Rev01

____________________________________________________________________________

2.2-FLUXO DE DADOS USART

Dispositivos que possuem interface USART podem se conectar diretamente com os pinos do mdulo RF assim como mostra a figura abaixo:

Diagrama do fluxo de dados da interface USART

Os dados entram na USART atravs do pino DI (pino 03) como um sinal serial assncrono. Quando no houver dado sendo transmitido (idle), o pino deve permanecer em nvel lgico alto. Cada byte de dados consiste em um start bit (baixo), 8 bits de dados (bit menos significativo primeiro) e um stop bit (alto). A figura a seguir ilustra a transmisso do caractere A:

Transmisso da letra A (0x41 hex) A USART executa algumas tarefas necessrias para a comunicao, como cronometragem e verificao de paridade. Por isso, a comunicao serial exige que as duas USARTs estejam configuradas igualmente (baud rate, paridade, nmero de start e stop bits, e o tamanho da palavra).

____________________________________________________________________________________________________________________

- 8 - Rev01

____________________________________________________________________________

2.3-MODO TRANSPARENTE
Por padro, o mdulo U-Bee trabalha no Modo Transparente, ou tambm chamado de Modo Modem. Quando operando neste modo, o mdulo atua como uma substituio linha serial, ou seja, todos os dados recebidos na USART atravs do pino DI so enfileirados para a transmisso em RF. Quando a informao recebida por RF, o dado enviado para o pino DO. Empacotamento de dados seriais: Os dados vindos do pino DI so armazenados no buffer DI at que uma das seguintes possibilidades cause a transmisso dos dados via RF: Nenhum caractere recebido durante um tempo determinado pelo parmetro RO*10ms (Timeout para empacotamento dos dados). Se RO=0, a transmisso ocorre assim que um caractere recebido.

Se o mdulo no puder transmitir os dados imediatamente (por exemplo, se estiver recebendo dados via RF) os dados seriais so armazenados no buffer DI. Quando estiver em condio de transmitir, os dados so empacotados e enviados assim que ocorra um estouro de tempo pelo parmetro RO, ou assim que o buffer DI atinja seu limite. Se o buffer DI completar seu limite, o controle de fluxo por hardware ou software deve ser feito para que no haja overflow.

____________________________________________________________________________________________________________________

- 9 - Rev01

____________________________________________________________________________

2.4 - DIAGRAMA INTERNO DO FLUXO DE DADOS

Diagrama interno do fluxo de dados

Data In Buffer (DI Buffer) Os dados que chegam ao mdulo RF atravs do pino DI (pino 03) so armazenados no DI Buffer at que possam ser processados. Para que no haja problemas de Overflow, procure enviar mensagens que tenham tamanho menor que o do DI Buffer (100 bytes). Tambm, faa a interface com uma taxa de comunicao menor (parmetro BD, Taxa de Dados da Interface) que a taxa de dados de sada. Um fator que pode causar Overflow o recebimento de dados via RF continuamente. Os dados seriais vindos do pino DI so armazenados no Buffer DI, porm s podero ser processados e transmitidos pelo ar quando o mdulo no estiver mais recebendo dados da rede. Data Out Buffer (DO Buffer) Quando os dados so recebidos via RF, os dados so enviados ao DO Buffer e so enviados ao dispositivo host atravs do pino de sada DO da porta serial. Uma vez que o DO Buffer atinge sua capacidade mxima, qualquer outro dado recebido via RF perdido. O que pode causar Overflow no DO Buffer quando a taxa de dados via RF maior que a taxa de dados da interface de sada do mdulo, ou seja, o mdulo receber dados vindos do mdulo transmissor mais rpido do que ele pode enviar ao dispositivo host.

____________________________________________________________________________________________________________________

- 10 Rev01

____________________________________________________________________________

2.5 MODO API APPLICATION PROGRAMMING INTERFACE

O Modo API um modo de operao opcional em relao ao modo transparente. Atravs do Modo API possvel ler/configurar todos os parmetros do mdulo e enviar dados seriais atravs de um protocolo simples e de fcil utilizao. Os frames so divididos como: - Frames de configurao - Frames de envio dados - Frame de recepo de dados - Frame de resposta ao comando Este modo de operao um mtodo simples para enviar dados e realizar configuraes no mdulo sem a necessidade de entrar no modo de comando.

____________________________________________________________________________________________________________________

- 11 Rev01

____________________________________________________________________________

3-ENDEREAMENTO UBEE
Cada pacote de dados enviado contm um campo de Endereo de Origem e Endereo de Destino em seu cabealho. Os mdulos UBee, podem assumir a seguinte faixa de endereo: Endereo de Fonte (SA) : 0 254 Endereo de Destino (DA): 0 255

3.1-MODO UNICAST
O Modo Unicast a forma que o mdulo se comunica somente com outro mdulo. Este modo o nico capaz de reenviar uma mensagem com confirmao de recebimento (ACK). Enquanto estiver operando neste modo, os mdulos receptores enviam um ACK (reconhecimento) da recepo do pacote de RF ao transmissor. Se o mdulo transmissor no receber o ACK, ele reenviar o pacote de dados at o nmero de vezes configurado em ATNR ou at que o mdulo receba o ACK. Para operar neste modo, o mdulo deve estar configurado com um endereo de destino (ATDA) diferente de 255.

3.2-MODO BROADCAST
Este modo de operao quando se deseja enviar uma mensagem para todos os mdulos que estiverem ao alcance da transmissor. Neste modo, no possvel enviar ou receber uma mensagem de confirmao (ACK). Qualquer mdulo dentro do alcance da rede ir aceitar um pacote contendo um endereo Broadcast(ATDA 255). Para enviar um pacote Broadcast para todos os mdulos configure o endereo de destino de todos os mdulos como 255 (ATDA 255).

3.3-IDENTIFICADOR DE REDE
Cada mdulo UBee possui um endereo de fonte (SA), um endereo de destino (DA) e um endereo de rede, ou identificador de rede. Este identificador de rede serve para agrupar vrios mdulos em somente uma rede nica.

____________________________________________________________________________________________________________________

- 12 Rev01

____________________________________________________________________________

O identificador de rede configurado pelo comando ATID, e pode variar de 0 255. Todos os mdulos de uma mesma rede, devem ter o mesmo identificador.

4-MODO DE COMANDO AT
Para ler ou modificar os parmetros do mdulo UBee, o mdulo deve primeiro entrar no Modo Comando. Para entrar no modo de comando AT, deve-se enviar 3 caracteres sequenciais (+++ ) e depois Enter. Em ASCII deve ser enviado os seguintes caracteres: 0x2B 0x2B 0x2B 0x0D Para enviar comandos AT, deve-se enviar a sintaxe como mostra a figura abaixo:

Sintaxe para comandos Para salvar o novo valor em uma memria no voltil, envie o comando ATWR. Isso far com que os valores dos parmetros continuem sendo os parmetros de configurao do mdulo mesmo aps uma reinicializao do mdulo. Para sair do Modo de Comando AT, deve-se enviar o comando ATCN + ENTER. Resposta do Sistema Quando um comando for enviado ao mdulo, ele ir analisar e executar o comando. Aps execut-lo com sucesso, o mdulo retorna uma mensagem OK. Se a execuo do comando resultar em um erro, o mdulo ir retornar uma mensagem de ERRO.

____________________________________________________________________________________________________________________

- 13 Rev01

____________________________________________________________________________

5- TABELA DE COMANDOS AT
Os comandos esto contidos dentro das seguintes categorias: Especiais Rede Interface Serial Configurao I/O Diagnsticos de rede Opes de Comandos Sleep/Relatrio

aconselhvel utilizar a mesma verso de firmware para os mdulos operando em uma mesma rede.
Comandos Especiais
Comando AT WR RF RE RR PW SM Categoria Comando Especiais Especiais Especiais Especiais Especiais Especiais Nome e Descrio Write. Escreve o valor do parmetro em uma memria no voltil fazendo com que as modificaes nos parmetros continuem mesmo aps um reset ou Power-up. Restore Fbrica. Restaura os valores de fbrica dos parmetros. Reinicia o mdulo. Reinicia o mdulo remoto. Caso DA seja 255 reinicia todos os mdulos da rede Power. Atenua a potncia de transmisso do rdio com passo de 1dB. Mensagem Inicial. Ativa ou desabilita a mensagem inicial Faixa de Valores 0-31 0 - Desabilita 1 - Habilita Valor Padro 0 1

Comandos Rede
Comando AT CH ID Categoria Comando Rede (Endereamento) Rede (Endereamento) Nome e Descrio Canal de Operao. L/Configura o nmero do canal de operao utilizado para transmitir e receber mensagens entre os mdulos de RF (utiliza os nmeros de canais do protocolo IEEE 802.15.4). PAN ID. L/Configura o PAN ID da rede (Personal Area Network Identification). Faixa de Valores 11 26 1-255 Valor Padro 11 1

____________________________________________________________________________________________________________________

- 14 Rev01

____________________________________________________________________________

DA SA REN TR NR AE

Rede (Endereamento) Rede (Endereamento) Rede (Roteamento) Rede (Configurao) Rede (configurao) Rede (configurao)

Endereo de Destino. L/Configura o endereo de destino da mensagem que se deseja. Configurar ATDA 255 ativa o modo broadcast. Endereo de Fonte. L/Configura o endereo de fonte de onde se deseja que parta a mensagem do mdulo de RF. Habilita modo roteamento. Todas as mensagens recebidas, sero retransmitidas caso no seja este mdulo o destino. Tempo de Retransmisso. Configura o tempo de retransmisso de uma mensagem com ACK. O valor configurado sempre mltiplo de 10ms. Nmero de Retransmisses. Configura o nmero de retransmisses de uma mensagem com ACK. ACK Enable. Habilita ou desabilita o envio de ACK (mensagem de confirmao de recebimento da mensagem)

0-255 0-254 0 - Desabilita 1 - Habilita 10 -1000 0 - 20 0-Desabilita 1-Habilita

255 0 0 100 5 1

Interface Serial
Comando AT Categoria Comando Nome e Descrio Faixa de Valores 0-6 0 = 2400bps 1 = 4800 bps 2 = 9600 bps 3 = 19200 bps 4 = 38400 bps 5 = 57600 bps 6 = 115200 bps Valor Padro

BD

Interface Serial

Taxa de Dados da Serial. L/Configura o valor da taxa de comunicao entre a porta serial do modulo de RF e o Host. A taxa alterada somente se for enviado o comando ATWR e reinicializado o mdulo.

RO

Interface Serial

Timeout para empacotamento dos dados. L/Configura o tempo de silncio antes do envio dos dados armazenados no buffer de entrada via RF. Configurando RO = 0 os dados que chegam pela serial so enviados imediatamente. Os dados que estiverem no buffer de entrada serial (para RO>0) so enviados via RF aps um time out de RO*10ms quando no receber mais caracteres. API Enable. Habilita ou desabilita o modo API

0-100

10

API

Interface Serial

0 Desabilita 1 Habilita

I/Os
Comando AT DOI Categoria Comando Configuraes I/O Nome e Descrio Configura o estado inicial dos I/Os ao ligar o mdulo. Se for enviado 0 todos os pinos estaro em nvel lgico baixo, se for enviado 1023 todos os pinos estaro em nvel lgico alto. Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing 4 - Entrada Analgica Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing 4 - Entrada Analgica Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing 4 - Entrada Analgica Faixa de Valores 0-1023 Valor Padro 0

CT0

Configuraes I/O

0-4

CT1

Configuraes I/O

0-4

CT2

Configuraes I/O

0-4

____________________________________________________________________________________________________________________

- 15 Rev01

____________________________________________________________________________

CT3

Configuraes I/O

CT4

Configuraes I/O

CT5

Configuraes I/O

CT6

Configuraes I/O

CT7

Configuraes I/O

CT8

Configuraes I/O

CT9

Configuraes I/O

MLP

Configuraes I/O

PLP

Configuraes I/O

RLI

I/O

Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing 4 - Entrada Analgica Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing 4 - Entrada Analgica Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing 4 - Entrada Analgica Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing Configurao da funcionalidade do terminal. Indica a funcionalidade do terminal: 0 - Sada 1 - Entrada 2 - Sada I/O Line Passing 3 - Entrada I/O Line Passing Ativa o envio do I/O Line passing por mudana de estado . Colocando em 0 desativa o envio por mudana de estado, colocando em 1 ativa o envio por mudana de estado no pino. Para habilitar o modo I/O line passing essencial que habilite o ATMLP 1 Ativa o envio do I/O Line passing por modo peridico Habilita o envio do estado do I/O no modo peridico sendo o valor estipulado sendo mltiplo de 10ms. O Modo desabilitado colocando 65535. Ex1 : ATPLP 100 Corresponde ao envio de dados peridicos de Line passing a cada 1 segundo Ex2 : ATPLP 65535 Desabilita o envio de I/O Linepassing peridico Leitura local dos I/Os Faz a leitura de todos os I/Os, Ex1: ATRLI 1111100000 OK Nesse caso todos os I/Os foram configurados como entrada

0-4

0-4

0-4

03

03

03

03

0 - Desabilita 1- Habilita

0 65535

____________________________________________________________________________________________________________________

- 16 Rev01

____________________________________________________________________________

Ex2: ATRLI --00000000 OK Nesse caso, os I/Os 0 e 1 no so entradas. RLI0 RLI1 RLI2 RLI3 RLI4 RLI5 RLI6 RLI7 RLI8 RLI9 WLO I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O Leitura local do I/O 0 Leitura local do I/O 1 Leitura local do I/O 2 Leitura local do I/O 3 Leitura local do I/O 4 Leitura local do I/O 5 Leitura local do I/O 6 Leitura local do I/O 7 Leitura local do I/O 8 Leitura local do I/O 9 Escreve em todas as sadas locais. Ex.: ATWLO 1023 Escreve 1023 ( 1023 em binrio : 1111111111) em todo o portal DIO. Escreve no DIO0 Ex.: ATWLO0 1 Coloca em nvel lgico alto o DIO0 Escreve no DIO1 Ex.: ATWLO1 1 Coloca em nvel lgico alto o DIO1 Escreve no DIO2 Ex.: ATWLO2 1 Coloca em nvel lgico alto o DIO2 Escreve no DIO3 Ex.: ATWLO3 1 Coloca em nvel lgico alto o DIO3 Escreve no DIO4 Ex.: ATWLO4 1 Coloca em nvel lgico alto o DIO4 Escreve no DIO5 Ex.: ATWLO5 1 Coloca em nvel lgico alto o DIO5 Escreve no DIO6 Ex.: ATWLO6 1 Coloca em nvel lgico alto o DIO6 Escreve no DIO7 Ex.: ATWLO7 1 Coloca em nvel lgico alto o DIO7 Escreve no DIO8 Ex.: ATWLO8 1 Coloca em nvel lgico alto o DIO8 Escreve no DIO9 Ex.: ATWLO9 1 Coloca em nvel lgico alto o DIO9 L todas as entradas analgicas locais Faz a leitura de todas as entradas ADs com o valor convertido em decimal: ATRLA ADC0: 612 ADC1: 1023 ADC2: 0 ADC3: 10 ADC4: 55 ADC5: 20 OK 0-1023 -

WLO0

I/O

0-1

WLO1

I/O

0-1

WLO2

I/O

0-1

WLO3

I/O

0-1

WLO4

I/O

0-1

WLO5

I/O

0-1

WLO6

I/O

0-1

WLO7

I/O

0-1

WLO8

I/O

0-1

WLO9

I/O

0-1

RLA

I/O

0 - 1023

____________________________________________________________________________________________________________________

- 17 Rev01

____________________________________________________________________________

L a entrada analgica local AD0 Ex: ATRLA0 Faz a leitura do AD0 caso seja uma entrada analgica o mdulo retorna o valor convertido em decimal: ATRLA0 611 OK L a entrada analgica local AD1 Ex: ATRLA1 Faz a leitura do AD1 caso seja uma entrada analgica o mdulo retorna o valor convertido em decimal: ATRLA1 10 OK L a entrada analgica local AD2 Ex: ATRLA2 Faz a leitura do AD2 caso seja uma entrada analgica o mdulo retorna o valor convertido em decimal: ATRLA2 0 OK L a entrada analgica local AD3 Ex: ATRLA3 Faz a leitura do AD3 caso seja uma entrada analgica o mdulo retorna o valor convertido em decimal: ATRLA3 525 OK L a entrada analgica local AD4 Ex: ATRLA4 Faz a leitura do AD4 caso seja uma entrada analgica o mdulo retorna o valor convertido em decimal: ATRLA4 611 OK L a entrada analgica local AD5 Ex: ATRLA5 Faz a leitura do AD5 caso seja uma entrada analgica o mdulo retorna o valor convertido em decimal: ATRLA5 1023 OK L todas as entradas digitais remotas L todas as entradas do mdulo remoto cujo endereo (SA) seja igual ao DA deste mdulo. Ex: ATRRI Faz a leitura de todos os I/Os: ATRRI NR:0 1111100000 OK Obs.: caso DA esteja configurado como 255(Broadcast) no ser executado nenhuma leitura. L o DIO0 remoto Ex: ATRRI0 Faz a leitura do I/O 0, caso seja uma entrada o mdulo retorna o nvel lgico dela: ATRRI0 NR:0 1 OK Caso o I/O 0 no seja entrada a resposta ser: ATRRI1 NR:0 OK L o DIO1 remoto L o DIO2 remoto L o DIO3 remoto L o DIO4 remoto

RLA0

I/O

0 - 1023

RLA1

I/O

0 - 1023

RLA2

I/O

0 - 1023

RLA3

I/O

0 - 1023

RLA4

I/O

0 - 1023

RLA5

I/O

0 - 1023

RRI

I/O

01

RRI0

I/O

01

RRI1 RRI2 RRI3 RRI4

I/O I/O I/O I/O

01 01 01 01

____________________________________________________________________________________________________________________

- 18 Rev01

____________________________________________________________________________

RRI5 RRI6 RRI7 RRI8 RRI9

I/O I/O I/O I/O I/O

L o DIO5 remoto L o DIO6 remoto L o DIO7 remoto L o DIO8 remoto L o DIO9 remoto L todas as entradas analgicas remotas L todas as entradas analgicas do mdulo remoto cujo endereo (SA) seja igual ao DA deste mdulo. Ex: ATRRA Faz a leitura de todas as entradas ADs: ATRRA NR:0 ADC0: 413 ADC1: 1023 ADC2: 0 ADC3: 100 ADC4: 550 ADC5: 200 OK L a entrada analgica AD0 remota Ex: ATRRA0 Faz a leitura do AD0 caso seja uma entrada analgica o mdulo retorna o valor convertido em decimal: ATRRA0 NR:0 413 OK Caso o AD0 no seja entrada analgica, a resposta ser: ATRRA0 NR:0 OK L a entrada analgica AD1 remota L a entrada analgica AD2 remota L a entrada analgica AD3 remota L a entrada analgica AD4 remota L a entrada analgica AD5 remota Escreve em todas as sadas remotas. Ex.: ATWLO 1023 Escreve 1023 ( 1023 em binrio : 1111111111) em todo o portal DIO Escreva na sada DIO0 remota EX.: ATWRO0 1 NR:0 OK Coloca em nvel lgico alto o DIO0 remoto Escreva na sada DIO1 remota Escreva na sada DIO2 remota Escreva na sada DIO3 remota Escreva na sada DIO4 remota Escreva na sada DIO5 remota Escreva na sada DIO6 remota Escreva na sada DIO7 remota Escreva na sada DIO8 remota Escreva na sada DIO9 remota

01 01 01 01 01

RRA

I/O

0 - 1023

RRA0

I/O

0 - 1023

RRA1 RRA2 RRA3 RRA4 RRA5 WRO

I/O I/O I/O I/O I/O I/O

0 - 1023 0 - 1023 0 - 1023 0 - 1023 0 - 1023

0 - 1023 01 01 01 01 01 01 01 01 01 01

WRO0 WRO1 WRO2 WRO3 WRO4 WRO5 WRO6 WRO7 WRO8 WRO9

I/O I/O I/O I/O I/O I/O I/O I/O I/O I/O

Diagnsticos
____________________________________________________________________________________________________________________

- 19 Rev01

____________________________________________________________________________

Comando AT NS

Categoria Comando Diagnsticos

Nome e Descrio Nvel do Sinal Recebido. L o nvel de sinal (em %) dos ltimos 4 pacotes recebido (RSSI). O valor mostrado ser a mdia desses pacotes. Indicao de Rede Sinal Recebido Habilita a indicao de rede por nvel de sinal recebido, pode-se ligar um LED a este pino para visualizao de status de rede. Status Forma de visualizao Sinal Forte LED ligado Sinal Mdio LED piscando de forma rpida 300 ms Sinal Fraco LED piscando de forma lenta 800 ms Sem Sinal LED Apagado

Faixa de Valores 0 100%

Valor Padro -

IND

Diagnsticos

0 - Desabilita 1 - Habilita

BAT MSE

Diagnsticos Diagnsticos

TN

Diagnsticos

Nvel de tenso de alimentao. Atravs deste comando pode-se visualizar o nvel de tenso da fonte de alimentao do mdulo ou bateria. Mensagem de Status do ACK. Habilita a mensagem de Status de uma transmisso com ACK. Tempo de Notificao. Configura o tempo de envio de pacote de notificao . Este pacote serve para atualizar as indicaes de rede. necessrio que todos os mdulos tenham o mesmo valor configurado. O parmetro configurado ser multiplicado por 10ms. Este pacote somente enviado caso no haja nenhum fluxo de dados na rede.

0 - Desabilita 1 - Habilita

50 - 1000

100

Opes de Comandos
Comando AT CN Categoria Comando Opes Comandos AT Nome e Descrio Termina Modo de Comando. Sai do modo de Comando. Faixa de Valores Valor Padro -

Sleep/Relatrio
Comando AT MS Categoria Comando Sleep Nome e Descrio Modo Sleep. Este comando seleciona se o mdulo estar habilitado para operar no modo sleep e de que forma. Tempo de Sleep. Quando selecionado MS = 2, habilitado o envio do relatrio no modo sleep peridico, sendo o valor mltiplo de 8,45s. Ativa o envio do relatrio por modo peridico Habilita o envio do relatrio para o destino por modo peridico sendo o valor mltiplo de 10ms. O Modo desabilitado colocando 65535. Ex1 : ATPR 100 Corresponde ao envio de relatrio peridico de a cada 1 segundo Ex2 : ATPR 65535 Desabilita o envio do relatrio peridico Ativa o relatrio local por modo peridico Habilita o envio do relatrio local por modo peridico sendo o valor mltiplo de 10ms. O Modo desabilitado colocando 65535. Ex1 : ATMPR 100 Corresponde ao envio de relatrio peridico de a cada 1 segundo Ex2 : ATMPR 65535 Desabilita o relatrio peridico Faixa de Valores 0 = desabilitado 1 = habilitado 2 = habilitado e peridico 0 - 65535 Valor Padro 2

TS

Sleep

PR

Relatrio

1-65535

65535

MPR

Relatrio local

1-65535

65535

____________________________________________________________________________________________________________________

- 20 Rev01

____________________________________________________________________________

6- MODO DE OPERAO API APPLICATION PROGRAMMING INTERFACE

No modo de operao API toda a comunicao USART como mdulo UBee se d atravs de um protocolo estruturado. possvel neste modo configurar todos os parmetros do mdulo UBee e ainda enviar dados de forma estruturada e controlada atravs de um protocolo. Para habilitar este modo necessrio entrar no modo de comando e enviar ATAPI 1. Por padro de fbrica o mdulo UBee opera no modo transparente, ou seja, todos os dados que estiverem em RX sero enviados ao TX do mdulo de destino. Quando o mdulo estiver operando no modo API, todo dado recebido pela serial ser tratado como um frame API. Todos os dados do frame API devem ser caracteres em ASCII. Existem os seguintes tipos de frames API: Frame de configurao START TIPO COMANDO PARMETRO CHECKSUM STOP

Frame de dados com configurao START TIPO SA DA ID CH ACK PAYLOAD CHECKSUM STOP

Frame de dados sem configurao START TIPO PAYLOAD CHECKSUM STOP

Todos os frames possuem os seguintes bytes iguais: START 1 byte fixo com valor 0x2A, em ASCII correspondente ao caractere * CHECKSUM 3 bytes, ele a soma de todos os bytes do pacote de dados menos os bytes de checksum e de stop. STOP 1 byte fixo com valor 0x23, em ASCII correspondente ao caractere #

____________________________________________________________________________________________________________________

- 21 Rev01

____________________________________________________________________________

6.1-FRAME DE CONFIGURAO
Todo frame API de configurao formado pelos seguintes campos: START TIPO COMANDO PARMETRO CHECKSUM STOP

START 1 byte fixo com valor 0x2A, em ASCII correspondente ao caractere * TIPO 2 bytes variveis que determinam o tipo de comando de configurao PARMETRO 1 6 bytes A estrutura do protocolo definida com os seguintes campos: START TIPO COMANDO PARMETRO CHECKSUM STOP

O START correspondente ao caractere * em ASCII ou em valor absoluto 0x2A. O TIPO define o tipo de comando a ser enviado, podendo ser: 01 Comandos Especias 02 - Comandos de REDE 03 Interface Serial 04 I/Os 05 Diagnsticos 06 Sleep/Relatrio 10 Mensagem de dados com configurao 11 Mensagem de dados sem configurao 00 Mensagem de Sucesso 88 Mensagem de Erro 99 Mensagem de Erro de Checksum O COMANDO similar ao comando AT que se deseja configurar ou ler, por exemplo: O TIPO 01 pode ter os seguintes comandos WR, RF, RE, RR, PW ou SM. O PARMETRO o valor que se deseja configurar ou ler. O CHECKSUM utilizado para garantir a integridade dos dados. Ele a soma de todos os bytes do pacote de dados menos os bytes de checksum e de stop. O STOP correspondente ao caractere # em ASCII ou em valor absoluto 0x23. Exemplos de utilizao:
____________________________________________________________________________________________________________________

- 22 Rev01

____________________________________________________________________________

a) Deseja-se configurar o canal 11 como sendo o de operao, portanto, basta enviar: *02CH11377# (em ASCII) Start ASCII * Valor 0x2A Absoluto Tipo 02 0x30 0x32 Comando CH 0x43 0x48 Parmetro 11 0x31 0x31 CheckSum 377 0x33 0x37 0x37 Stop # 0x23

Calculando o CheckSum: 0x2A+0x30+0x32+0x43+0x48+0x31+0x31 = 377 em decimal b) Deseja-se configurar o endereo de destino como 001: *02DA001418# Start ASCII * Valor 0x2A Absoluto Tipo 02 0x30 0x32 Comando DA 0x44 0x41 Parmetro 001 0x30 0x30 0x31 CheckSum 418 0x34 0x31 0x38 Stop # 0x23

Calculando o CheckSum: 0x2A+0x30+0x32+0x44+0x41+0x30+0x30+0x31 = 418 em decimal

____________________________________________________________________________________________________________________

- 23 Rev01

____________________________________________________________________________

6.1.1-FRAME DE CONFIGURAO TIPO 01

O frame de configurao tipo 01 corresponde aos comandos AT especiais, e so eles:
Leitura/Escrita Escrita Escrita Escrita Escrita Leitura/Escrita Leitura/Escrita

START Tipo Comando API * * * * * * 01 01 01 01 01 01 WR RF RE RR PW SM

Parmetro 0 0 0 0 00 31 0 ou 1

CHECKSUM 356 339 338 351 xxx xxx

STOP # # # # # #

EXEMPLO *01WR0356# *01RF0339# *01RE0338# *01RR0351# *01PW00402# *01SM0347#

Todo frame API enviado ao mdulo resulta em uma resposta, podendo ser do tipo: 00 Frame de Sucesso 01 Frame de Leitura 88 Frame de Erro 99 Frame de Erro de Checksum Para realizar a leitura de um certo parmetro basta enviar no lugar do parmetro o caractere ? (0x3F). Exemplo de uso: Deseja-se ler o valor configurado em PW, portanto basta enviar *01PW??432#. Observe que so dois caracteres ?, pois o parmetro deste comando possui no mximo dois caracteres. Ao enviar este frame o mdulo responde: *01PW00402#, onde podemos observer os seguintes campos: Start * Tipo 01 Comando PW Parmetro 00 Valor Lido CheckSum 402 Stop #

Portanto, o valor configurado em PW 00. *01PW??432# *01PW00402# UBEE

____________________________________________________________________________________________________________________

- 24 Rev01

____________________________________________________________________________

6.1.2-FRAME DE CONFIGURAO TIPO 02

O frame de configurao tipo 02 corresponde aos comandos AT de rede, e so eles:
START * * * * * * Tipo 02 02 02 02 02 02 Comando API CH ID DA SA REN TR Parmetro 11 26 001 255 000 255 000 254 0 ou 1 0010 1000 CHECKSUM xxx xxx xxx xxx xxx xxx STOP # # # # # # EXEMPLO *02CH11377# *02ID001426# *02DA001418# *02SA001433# *02REN1418# *02TR????558# Leitura/Escrita Leitura/Escrita Leitura/Escrita Leitura/Escrita Leitura/Escrita Leitura/Escrita Leitura/Escrita

Todo frame API enviado ao mdulo resulta em uma resposta, podendo ser: 00 Frame de Sucesso 02 Frame de Leitura 88 Frame de Erro 99 Frame de Erro de Checksum

6.1.3-FRAME DE CONFIGURAO TIPO 03

O frame de configurao tipo 03 corresponde aos comandos AT Serias, e so eles:
START * * * Tipo 03 03 03 Comando API BD RO API Parmetro 06 000 100 01 CHECKSUM xxx xxx xxx STOP # # # EXEMPLO *03BD3326# *03RO010447# *03API?422# Leitura/Escrita Leitura/Escrita Leitura/Escrita Leitura/Escrita

Todo frame API enviado ao mdulo resulta em uma resposta, podendo ser: 00 Frame de Sucesso 03 Frame de Leitura 88 Frame de Erro 99 Frame de Erro de Checksum

____________________________________________________________________________________________________________________

- 25 Rev01

____________________________________________________________________________

6.1.4-FRAME DE CONFIGURAO TIPO 04

O frame de configurao tipo 04 corresponde aos comandos AT I/Os, e so eles:
START Tipo Comando API * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 04 DOI CT0 CT1 CT2 CT3 CT4 CT5 CT6 CT7 CT8 CT9 MLP PLP RLI WLO0 WLO1 WLO2 WLO3 WLO4 WLO5 WLO6 WLO7 WLO8 WLO9 RLA RRI RRA WRO0 WRO1 WRO2 WRO3 WRO4 WRO5 WRO6 WRO7 Parmetro 0000 1023 04 04 04 04 04 04 03 03 03 03 0 ou 1 00000 65535 09 0 ou 1 0 ou 1 0 ou 1 0 ou 1 0 ou 1 0 ou 1 0 ou 1 0 ou 1 0 ou 1 0 ou 1 05 0-9 0-5 0-1 0-1 0-1 0-1 0-1 0-1 0-1 0-1 CHECKSUM STOP xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx xxx # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # EXEMPLO *04DOI0000554# *04CT00389# *04CT14394# *04CT24395# *04CT34396# *04CT44397# *04CT54398# *04CT63398# *04CT73399# *04CT80397# *04CT90398# *04MLP1424# *04PLP01000619# *04RLI1422# *04WLO01481# *04WLO11482# *04WLO21483# *04WLO31484# *04WLO40484# *04WLO50485# *04WLO60486# *04WLO70487# *04WLO80488# *04WLO90489# *04RLA0413# *04RRI9436# *04RRA0419# *04WRO00486# *04WRO10487# *04WRO20488# *04WRO30489# *04WRO40490# *04WRO50491# *04WRO60492# *04WRO70493#

____________________________________________________________________________________________________________________

- 26 Rev01

____________________________________________________________________________

* *

04 04

WRO8 WRO9

0-1 0-1

xxx xxx

# #

*04WRO80494# *04WRO90495#

Todo frame API enviado ao mdulo resulta em uma resposta, podendo ser: 00 Frame de Sucesso 04 Frame de Leitura 88 Frame de Erro 99 Frame de Erro de Checksum

6.1.5-FRAME DE CONFIGURAO TIPO 05

O frame de configurao tipo 05 corresponde aos comandos AT de Diagnsticos e so eles:
START * * * * * * * Tipo Comando API 05 05 05 05 05 05 05 NS IND BAT MSE TN FV HV Parmetro ? 0 ou 1 ? 0 ou 1 0050 1000 ???? ?? CHECKSUM 352 xxx 421 xxx xxx xxx xxx STOP EXEMPLO # # # # # # # *05NS?367# *05IND0410# *05BAT?421# *05MSE1421# *05TN0100498# *05FV????551# *05HV??427#

Todo frame API enviado ao mdulo resulta em uma resposta, podendo ser: 00 Frame de Sucesso 05 Frame de Leitura 88 Frame de Erro 99 Frame de Erro de Checksum

____________________________________________________________________________________________________________________

- 27 Rev01

____________________________________________________________________________

6.1.6-FRAME DE CONFIGURAO TIPO 06

O frame de configurao tipo 06 corresponde aos comandos AT de Sleep e Relatrio e so eles:
START Tipo Comando API * * * * 06 06 06 06 MS TS PR MPR Parmetro 02 00000 65535 00001 65535 00001 65535 CHECKSUM STOP Exemplo xxx xxx xxx xxx # # # # *06MS0352# *06TS00010552# *06PR00100547# *06MPR65535647#

Todo frame API enviado ao mdulo resulta em uma resposta, podendo ser: 00 Frame de Sucesso 06 Frame de Leitura 88 Frame de Erro 99 Frame de Erro de Checksum

6.1.7-FRAME DE SUCESSO TIPO 00

O frame de sucesso tipo 00 uma reposta que o mdulo envia assim que um comando de configurao enviado e processado com sucesso. Ele formado pelos seguintes campos:

START Tipo Comando API * 00 YY

Parmetro OK

CHECKSUM STOP Exemplo xxx # *00YYOKxxx#

O campo Comando API formado pelo mesmo comando enviado. O campo Parmetro fixo em OK. Exemplo: Deseja-se configurar o endereo de destino DA como 255, portanto basta enviar *02DA255429#. *02DA255429# *00DAOK425# UBEE

____________________________________________________________________________________________________________________

- 28 Rev01

____________________________________________________________________________

6.1.8-FRAME DE ERRO TIPO 88

O frame de ERRO tipo 88 uma reposta que o mdulo envia assim que um comando de configurao enviado e no processado com sucesso. Ele formado pelos seguintes campos:

START Tipo Comando API * 88 YY

Parmetro ERRO

CHECKSUM STOP Exemplo xxx # *00YYOKxxx#

O campo Comando API formado pelo mesmo comando enviado. O campo Parmetro fixo em ERRO. Este frame enviado toda vez que o mdulo recebe um frame de configurao com parmetro invlido. Exemplo: Deseja-se configurar o endereo de destino DA como 500, sabe-se que o valor mximo 255, portanto basta enviar *02DA500422#. O mdulo ao receber este frame de configurao, verifica que o valor de DA invlido e envia o frame de erro: *02DA500422# *88DAERRO594# UBEE

____________________________________________________________________________________________________________________

- 29 Rev01

____________________________________________________________________________

6.1.9-FRAME DE ERRO DE CHECKSUM TIPO 99

O frame de ERRO de CheckSum tipo 99 uma reposta que o mdulo envia assim que um comando de configurao enviado com checksum errado. Ele formado pelos seguintes campos:

START Tipo * 99

Parmetro ccc

CHECKSUM STOP Exemplo xxx # *99cccxxx#

O campo Parmetro o checksum calculado pelo mdulo da ltima mensagem. O campo CheckSum o checksum dessa mensagem. Este frame enviado toda vez que o mdulo recebe um frame com checksum invlido. Exemplo: Deseja-se configurar o endereo de fonte SA como 010, portanto basta enviar *02SA010433#. Porm foi realizado o clculo errado e foi enviado *02SA010555#, assim que o mdulo recebe este frame ele envia o frame de erro de checksum: *02SA010555# *99433310# Observe que o campo parmetro o checksum correto da mensagem anterior, neste caso 433. UBEE

____________________________________________________________________________________________________________________

- 30 Rev01

____________________________________________________________________________

6.1.10-FRAME DE DADOS COM CONFIGURAO TIPO 10

O frame de Dados com configurao uma forma alternativa ao modo transparente de enviar dados com as configuraes de rede. Este frame composto dos seguintes campos:

START *

Tipo 10

SA 000-254

DA 000-255

ID 000-255

CH 11-26

ACK 0-1

PAYLOAD 79BYTES

CHECKSUM ccc

STOP #

Abaixo a descrio de cada campo: SA - endereo de fonte que o mdulo deve assumir. DA - endereo de destino que o mdulo deve enviar a mensagem. ID identificador da rede CH canal de operao ACK se for 0 ACK desabilitado, se for 1 ACK habilitado. PAYLOAD dados que devero ser enviados ao destino, com tamanho mximo de 79bytes CHECKSUM soma de todos os campos menos o campo de checksum e stop, caso o checksum seja maior do que 999 deve-se dividir o checksum por 16 e considerar somente o valor inteiro.

____________________________________________________________________________________________________________________

- 31 Rev01

____________________________________________________________________________

6.1.11-FRAME DE DADOS COM CONFIGURAO TIPO 11

O frame de Dados sem configurao uma forma alternativa ao modo transparente de enviar dados com as configuraes j salvas no mdulo. Este frame composto dos seguintes campos:

START *

Tipo 11

PAYLOAD 91BYTES

CHECKSUM ccc

STOP #

Abaixo a descrio de cada campo: PAYLOAD dados que devero ser enviados ao destino, com tamanho mximo de 91bytes CHECKSUM soma de todos os campos menos o campo de checksum e stop, caso o checksum seja maior do que 999 deve-se dividir o checksum por 16 e considerar somente o valor inteiro.

____________________________________________________________________________________________________________________

- 32 Rev01

____________________________________________________________________________

Fractum Indstria e Comrcio de Equipamentos Elet rnicos LTDA - Av. Antnio Amrico Junqueira 335 Pr do Sol - Santa Rita do Sapuca-MG - CEP 37540-000 - TEL: 55 35 3471 0019

Site: www.fractumrf.com - Email: contato@fractumrf.com

____________________________________________________________________________________________________________________

- 33 Rev01