Description

This frame type is only used for GPM commands on this product.

Query NP (Maximum Packet Payload Bytes) to read the maximum number of payload bytes that can be sent in a GPM request.

64-bit addressing

  • For broadcast transmissions, set the 64-bit destination address to 0x000000000000FFFF

  • For unicast transmissions, set the 64-bit address field to the address of the desired destination node

Reserved endpoints

For serial data transmissions, the 0xE8 endpoint should be used for both source and destination endpoints.

The active Digi endpoints are:

  • 0xE8 - Digi Data endpoint

  • 0xE6 - Digi Device Object (DDO) endpoint

Reserved cluster IDs

The following cluster IDs can be used on the 0xE8 data endpoint:

  • 0x0023 - General Purpose Memory cluster ID: allows for reading and writing flash on the device.

Reserved profile IDs

The Digi profile ID should always be 0xC105.

Format

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

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 Addressing Command Request - 0x11

4

8-bit

Frame ID

Identifies the data frame for the host to correlate with a subsequent response. If set to 0, the device will not emit a response frame.

5

64-bit

64-bit destination address

Not used.

13

16-bit

16 bit address

Not used.

15

8-bit

Source Endpoint

Source endpoint for the transmission. Serial data transmissions should use 0xE8.

16

8-bit

Destination Endpoint

Destination endpoint for the transmission. Serial data transmissions should use 0xE8.

17

16-bit

Cluster ID

The Cluster ID that the host uses for GPM access is 0x0023.

19

16-bit

Profile ID

The Profile ID should always be 0xC105.

21

8-bit

Broadcast radius

Not used.

22

8-bit

Transmit options

Not used.

23-n

variable

Command data

Data to be sent to the destination device.  Up to NP bytes per packet.

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.

Loopback Packet

Sending a loopback transmission to a device with the 64-bit address of 0013A20012345678 using Cluster ID 0x0012. To better understand the raw performance, retries and acknowledgments are disabled.

The corresponding Extended Transmit Status - 0x8B response with a matching Frame ID can be used to verify that the transmission was sent.

The destination will not emit a receive frame, instead it will return the transmission back to the sender. The source device will emit the receive frame—the frame type is determined by the value of AO—if the packet looped back successfully.

7E 00 1A 11 F8 00 13 A2 00 12 34 56 78 FF FE E8 E8 00 12 C1 05 00 01 54 78 44 61 74 61 41
Frame type Frame ID 64-bit dest Source EP Dest EP Cluster Profile Bcast radius Tx options Command data

0x11

0xF8

0x0013A200
12345678

0xE8

0xE8

0x0012

0xC105

0x00

0x01

0x547844617461 

Explicit request

Matches response

Destination

Digi data

Digi data

Data

Digi profile

N/A

Disable retries

"TxData"