16-bit I/O Sample Indicator - 0x83

Description

This frame type is emitted when a device configured with legacy API output—AO (API Output Options) = 2— receives an I/O sample frame from a remote device configured to use 64-bit source addressing—MY = 0xFFFE. Only devices running in API mode will send I/O samples out the serial port.

Note This frame format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. For new designs, we encourage you to use I/O Sample Indicator - 0x92 for reception of I/O samples.

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

16-bit I/O Sample Indicator - 0x83
4 16-bit 16-bit source address

The sender's 16-bit network address.
6 8-bit RSSI Received Signal Strength Indicator. The Hexadecimal equivalent of (-dBm) value. For example if RX signal strength is -40 dBm, then 0x28 (40 decimal) is returned.
7 8-bit

Options

Bit field of options that apply to the received message:

  • Bit 0: Reserved
  • Bit 1: Packet was sent as a broadcast [0x02]
  • Bit 2: 802.15.4 only - Packet was broadcast across all PANs [0x04]

Note Option values may be combined.
8 8-bit Number of samples The number of sample sets included in the payload.
9 16-bit Sample mask

Bit field that indicates which I/O lines on the remote are configured as inputs, if any:

bit 0: DIO0

bit 1: DIO1

bit 2: DIO2

bit 3: DIO3

bit 4: DIO4

bit 5: DIO5

bit 6: DIO6

bit 7: DIO7

bit 8: DIO8

bit 9: ADC0

bit 10: ADC1

bit 11: ADC2

bit 12: ADC3

bit 13: N/A

bit 14: N/A

bit 15: N/A

Each bit represents either a DIO line or ADC channel. Bit set to 1 if channel is active.
11 16-bit Digital samples (if included)

If the sample set includes any digital I/O lines—Digital channel mask > 0— this field contain samples for all enabled digital I/O lines. If no digital lines are configured as inputs or outputs, this field will be omitted.

DIO lines that do not have sampling enabled return 0. Bits in this field are arranged the same as they are in the channel mask field.
13 16-bit variable Analog samples (if included)

If the sample set includes any analog I/O lines, each enabled analog input returns a 16-bit value indicating the ADC measurement of that input.

Analog samples are ordered sequentially from AD0 to AD3.
EOF 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).