This view allows you to encode (generate) and decode (interpret) any type of API frame and inspect it in detail.
The tool is split into two panes:
-
Frame input pane: This pane is located at the left side of the tab and allows you to switch between encoding and decoding an API frame by entering the corresponding parameters for each case.
-
Frame details pane: It is located on the right side of the tab and contains detailed information of the encoded or decoded frame.
Encode an API frame
To encode or generate an API frame you must select the Encode API frame tab from the Frame input pane. The contents of the pane change displaying all the parameters required to encode an API frame. These are:
| Field | Description |
|---|---|
Protocol |
Radio protocol of the frame to be encoded. Select All to display all protocols. |
Mode |
API mode (API or API escaped) of the frame to encode. |
Frame type |
API frame type of the frame to encode. |
Frame parameters |
Options depend on the selected Frame type. Hover over the information icon next to each setting to view a short description of the setting and its parameters. |
Generated frame |
Byte array result of API frame generation. You can select and copy the text. |
Fill in all the fields to encode your API frame. Once the frame is generated successfully, the Frame details pane displays a detailed summary of the encoded frame.
Decode an API frame
To decode or interpret an API frame you must select the Decode API frame tab from the Frame input pane. The contents of the pane change displaying all the parameters required to decode an API frame. These are:
| Field | Description |
|---|---|
Mode |
API mode (API or API escaped) of the frame to decode. |
XBee API frame raw data |
Byte array of the API frame to decode.
The value of each byte must be hexadecimal without the |
Fill in all the fields to decode your API frame. Once the frame is interpreted successfully, the Frame details pane displays a detailed summary of the decoded frame.
