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.

Format

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

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	Reserved	Unused, but this field is typically set to 0xFFFE.
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: Reserved Bit 5: Reserved Bit 6: Reserved 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 41 AE B5 4E FF FE E8 E8 00 11 C1 05 C1 54 78 44 61 74 61 1C

Frame type	64-bit source	Reserved	Source EP	Dest EP	Cluster	Profile	Rx options	Received data
0x91	0x0013A200 41AEB54E	0x87BD	0xE8	0xE8	0x0011	0xC105	0xC1	0x547844617461
Explicit output		Unused	Digi data	Digi data	Data	Digi profile	ACK was sent in DigiMesh network	"TxData"