Explicit Receive Indicator - 0x91

Request frames:

Description

This frame type is emitted when a device configured with explicit API output—AO (API Options) bit1 set—receives a packet.

Typically this frame is emitted as a result of a device on the network sending serial data using the Transmit Request - 0x10 or Explicit Addressing Command Request - 0x11 addressed either as a broadcast or unicast transmission.

This frame is also emitted as a response to ZDO command requests, see Receiving ZDO command and responses for more information. The Cluster ID and endpoints are used to identify the type of transaction that occurred.

Format

The following table provides the contents of the frame. For details on frame structure, see API frame format.

Offset	Size	Frame Field	Description
0	8-bit	Start Delimiter	Indicates the start of an API frame.
1	16-bit	Length	Number of bytes between the length and checksum.
3	8-bit	Frame type	Explicit Receive Indicator - 0x91
4	64-bit	64-bit source address	The sender's 64-bit address.
12	16-bit	16-bit source address	The sender's 16-bit network address.
14	8-bit	Source endpoint	Endpoint of the source that initiated transmission.
15	8-bit	Destination endpoint	Endpoint of the destination that the message is addressed to.
16	16-bit	Cluster ID	The Cluster ID that the frame is addressed to.
18	16-bit	Profile ID	The Profile ID that the fame is addressed to.
20	8-bit	Receive options	Bit field of options that apply to the received message for packets sent using Digi endpoints (0xDC-0xEE): Bit 0: Packet was Acknowledged [0x01] Bit 1: Packet was sent as a broadcast [0x02] Bit 2: Reserved Bit 3: Reserved Bit 4: Packet was sent across a secure session [0x10] Bit 5: Packet encrypted with Zigbee APS security [0x20] Bit 6: Packet was sent from an End Device [0x40] Bit 6, 7: DigiMesh delivery method b’00 = <invalid option> b’01 = Point-multipoint [0x40] b’10 = Directed Broadcast [0x80] b’11 = DigiMesh [0xC0] Note Option values may be combined.
21-n	variable	Received data	The RF payload data that the device receives.
EOF	8-bit	Checksum	0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).

Examples

Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded.

64-bit unicast

A device with the 64-bit address of 0013A20087654321 sent a unicast transmission to a specific device with the payload of "TxData". The following frame is emitted if the destination is configured with AO > 1.

7E 00 18 91 00 13 A2 00 87 65 43 21 87 BD E8 E8 00 11 C1 05 01 54 78 44 61 74 61 37

Frame type	64-bit source	16-bit source	Source EP	Dest EP	Cluster	Profile	Rx options	Received data
0x91	0x0013A200 87654321	0x87BD	0xE8	0xE8	0x0011	0xC105	0x01	0x547844617461
Explicit output		Network address	Digi data	Digi data	Data	Digi profile	ACK was sent	"TxData"

ZDO command - ZDP IEEE Address Response

A ZDP IEEE address request is issued in order to identify the 64-bit address of a Zigbee device with the 16-bit network address of 0x046D. The following response is emitted out of the device that issued the request if configured to do so. In order to output the response to the ZDO command request, the sender must be configured to emit explicit receive frames by setting bit 0 of AO (API Options) (AO = 1). See Receiving ZDO command and responses for more information.

Note Each field in the ZDO frame is in little-endian, the rest of the Digi API frame is big-endian.

7E 00 1E 91 00 13 A2 00 12 34 56 78 04 6D 00 00 80 01 00 00 01 B5 00 78 56 34 12 00 A2 13 00 6D 04 C3

Frame type	64-bit source	16-bit source	Source EP	Dest EP	Cluster	Profile	Rx options	Received data
91	0013A200 12345678	046D	00	00	8001	0000	01	B5 00 78563412 00A21300 6D04
0x91	0x0013A200 87654321	0x046D	0x00	0x00	0x8001	0xC105	0x01	0xB5 0x00 0x0013A200 12345678 0x046D
Explicit output		Network address	ZDO	ZDO	IEEE Address Response	ZDO	ACK was sent	Sequence Num Status IEEE Address NWK Address