AeroComm ZB2430 manual Api Operation, A P I T r a n s m i t P a c k e t

API OPERATION

9

API Operation is a powerful alternative to the default Transparent operation of the ZB2430 and provides dynamic packet routing and packet accounting abilities to the OEM Host without requiring extensive programming by the OEM Host.. API operation utilizes specific packet formats; specifying various vital parameters used to control radio settings and packet routing on a packet-by-packet basis. The API features can be used in any combination that suits the OEM’s specific needs and can be different between radios operating on the same network.

A P I T r a n s m i t P a c k e t

API Transmit Packet is a powerful command that allows the OEM Host to send data to a single or multiple (broadcast) transceivers on a packet-by-packet basis. This can be useful for many applications; including polling and/or mesh networks.

API Transmit Packet is enabled when bit-1 of the API Control byte is enabled. The OEM Host should use the format shown in Figure 12 below to transmit a packet over the RF.

F i g u r e 1 2 : T r a n s m i t A P I p a c k e t f o r m a t

Start Delimiter

0x81

Request

Data

Byte 2: Payload Data Lenth (0x00 – 0x54)

Byte 3: Reserved. Set to 0x00

Byte 4: Number of Network Retries/Broadcast Attempts

Byte 5: Reserved. Set to 0x00

Byte 6-7: 16 bit Network Destination Address (Hi,Lo) 0x….: Unicast Address

0xFFFC: Broadcast to all Routers and Coordinators

0xFFFD: Broadcast to all with RXOnWhenIdel = True

0xFFFF: Broadcast to all Devices

Byte 8-n: Payload Data

A P I S e n d D a t a C o m p l e t e

API Send Data complete can be used as a software acknowledgement indicator. When a radio sends an addressed packet, it will look for a received acknowledgement (transparent to the OEM Host). If an acknowledgement is not received, the packet will be retransmitted until one is received or all retries have been exhausted.

For applications where data loss is not an option, the OEM Host may wish to monitor the acknowledgement process using the API Send Data Complete. If an acknowledgement is not received (Failure), the OEM Host can send the packet to the transceiver once again.

API Send Data Complete is enabled when bit-2 of the API Control byte is enabled. The transceiver sends the OEM Host the data shown in Figure 13 upon receiving an RF acknowledge or exhausting all attempts.

www.aerocomm.com