Description

This frame type is emitted in response to specific conditions. The status field of this frame indicates the device behavior.

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

Modem Status - 0x8A

4

8-bit

Modem status

Complete list of modem statuses:

  • 0x00 = Hardware reset or power up

  • 0x01 = Watchdog timer reset

  • 0x0D = Voltage supply limit exceeded—see Over-voltage detection in the XBee 3 RF Module Hardware Reference Manual.

  • 0x50 = Wi-SUN join state has changed to disconnected

  • 0x51 = Wi-SUN join state has changed to selecting a PAN

  • 0x52 = Wi-SUN join state has changed to authenticate with selected PAN

  • 0x53 = Wi-SUN join state has changed to acquiring selected PAN’s config

  • 0x54 = Wi-SUN join state has changed to determining routing config

  • 0x55 = Wi-SUN join state has changed to operational

  • 0x56 = Wi-SUN join state has changed to disconnecting

  • 0x57 = Wi-SUN join state has changed to parent selection

  • 0x58 = Wi-SUN join state has changed to dhcp

  • 0x59 = Wi-SUN join state has changed to earo

  • 0x5A = Wi-SUN join state has changed to dao

  • 0x5B = Wi-SUN join state has changed to connected

  • 0x5C = Wi-SUN connection has been lost and module is attempting to reconnect

  • 0x5D = Wi-SUN stack error has occurred

  • 0x5E = Wi-SUN global IP has been updated

  • 0x5F = Wi-SUN primary parent has been updated

  • 0x60 = Wi-SUN secondary parent has been updated

  • 0x61 = Wi-SUN parameters not supported

  • 0x62 = WI-SUN invalid private key

  • 0x63 = WI-SUN invalid device cert

  • 0x64 = WI-SUN invalid CA cert

  • 0x65 = WI-SUN Cert memory allocation error

  • 0x66 = WI-SUN No Cert data found

EOF

8-bit

Checksum

0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).

Modem status codes

Statuses for specific modem types are listed here.

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.

Boot status

When a device powers up, it returns the following API frame:

7E 00 02 8A 00 75
Frame type Modem Status

0x8A

0x00

Status

Hardware Reset