Extended Modem Status - 0x98
Description
The Extended Modem Status - 0x98 frame is intended to provide additional in-frame diagnostic information over the traditional Modem Status - 0x8A frame.
This frame type can be used to troubleshoot Zigbee network association. To enable verbose join information, use DC (Joining Device Controls).
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 |
Extended Modem Status - 0x98 |
| 4 | 8-bit | Status code |
Refer to the tables below for appropriate status codes |
| n | variable | Status data (optional) | Additional fields that provide information about the status |
| EOF | 8-bit | Checksum | 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). |
Secure Session status codes
When AZ (Extended API Options) is configured to output extended secure session statuses, whenever Secure Session API Frames are emitted, the extended modem status will provide additional details about the event.
| Status code | Description | Status data | Size | Description |
|---|---|---|---|---|
| 0x3B | A Secure Session was established with this node | Address |
64-bit |
The address of the client in the session. |
| Options |
8-bit |
Session options set by the client. |
||
| Timeout | 16-bit | Session timeout set by the client. | ||
| 0x3C | A Secure Session ended | Address | 64-bit | The address of the other node in this session. |
| Reason | 8-bit |
The reason the session was ended: 0x00 - Session was terminated by the other node 0x01 - Session Timed out 0x02 - Received a transmission with an invalid encryption counter 0x03 - Encryption counter overflow - the maximum number of transmissions for a single session has been reached 0x04 - Remote node out of memory |
||
| 0x3D | A Secure Session authentication attempt failed |
Address |
64-bit | Address of the client node. |
| Error | 8-bit |
Error that caused the authentication to fail. |
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.
Secure Session established
A device has established a secure session with the local node that has AZ (Extended API Options) configured to output extended secure session information. The following frame is emitted that announces the secure session establishment.
7E 00 0D 98 3B 00 13 A2 00 12 34 56 78 00 46 50 CD
| Frame type | Status code | Status data |
|---|---|---|
| 0x98 | 0x3B |
|
| Extended status | Secure Session established |
|
Zigbee Verbose join messages
The following example shows a successful association of a device that has DC (Joining Device Controls) configured to enable Verbose Join messages. The device is operating in Transparent mode—AP = 0—to allow a human-friendly way to troubleshoot association issues, if set for API mode—AP = 1—equivalent 0x98 Extended Modem Status frames would be emitted.
| Message | Description |
|---|---|
|
V AI -SearchingforParent:FF |
...search has started |
| V Scanning:03FFF800 | ...channels 11 through 25 are enabled by the SC setting for the Active Search. |
| V BeaconRsp:0000000000000042A6010B949AC8FF |
|
| V Reject ID | ...beacon response's extendedPanId does not match this radio's ID setting of 3151 |
| V BeaconRsp:0200000000000002AB010C55D2B2DB |
|
| V Reject ZS |
...beacon response's ZS does not match this radio's ZS setting |
| V BeaconRsp:000000000000003151010EE29FDFFF |
|
| V BeaconSaved:0E05E29F0000000000003151 | ...this beacon response is acceptable as a candidate for association |
| V Joining:0E05E29F0000000000003151 | ...sending association request |
| V StackStatus: joined, network up 0290 | ...we are joined, the network is up, we can send and transmit |
| V Joined unsecured network: |
|
| V AI -AssociationSucceeded:00 |
|
PDF
