IS (I/O Sample)

This command applies to the XBee 3 802.15.4 RF Module.

Immediately forces an I/O sample to be generated for the digital and analog I/O lines that are configured for the local device. If you issue the command to the local device, the sample data is sent out the local serial interface. If sent remotely, the sample is taken on the destination and the sample data is returned as an Local AT Command Response - 0x88.

If the device receives ERROR as a response to an IS query, there are no valid I/O lines to sample.

The IS command cannot be issued from within MicroPython or over BLE.

Refer to On-demand sampling for more information on using this command and examples.

Standard I/O capability

If AO (API Output Options) is set to 2, the XBee 3 802.15.4 RF Module's IS I/O options are D0 (DIO0/ADC0/Commissioning Configuration) - D8 (DIO8/DTR/SLP_Request Configuration) and four analog channels: AD0/DIO0 - AD3/DIO3.

When operating in Transparent mode (AP (API Enable) = 0 and AO (API Output Options) = 2), the data is returned in the following format:

All bytes are converted to ASCII:

number of samples<CR>

AIO/DIO mask (Bits 0 - 8 are digital I/O; Bits 9 - 12 analog channels)<CR>

DIO data<CR> (If DIO lines are enabled)

ADC channel Data<CR> (This will repeat for every enabled ADC channel)

<CR> (end of data noted by extra <CR>)

When operating in API mode (AP = 1), the command immediately returns an OK response. The data follows in the normal API format for DIO data.

Extended I/O capability

If A0 is set to 0 or 1, the XBee 3 802.15.4 RF Module's IS I/O options are D0 (DIO0/ADC0/Commissioning Configuration) - D9 (DIO9/ON_SLEEP Configuration) and P0 (DIO10/RSSI/PWM0 Configuration) - P4 (DIO14/UART_DIN Configuration) and four analog channels AD0/DIO0 - AD3/DIO3.

When operating in Transparent mode (AP = 0 and AO = 0, AO = 1), the data is returned in the following format:

All bytes are converted to ASCII:

number of samples<CR>

DIO mask (Bits 0 - 14 are digital I/O<CR>

AIO mask (Bits 0 - 3 are Analog channels<CR>

DIO data<CR> (If DIO lines are enabled)

ADC channel Data<CR> (This will repeat for every enabled ADC channel)

<CR> (end of data noted by extra <CR>)

When operating in API mode (AP = 1), the command immediately returns an OK response. The data follows in the normal API format for DIO data.

Parameter range

N/A

Default

N/A