AO (API Options)
This command applies to the XBee 3 Zigbee RF Module.
Configure the serial output options for received API frames. This parameter is only applicable when the device is operating in API mode (AP = 1 or 2). For more information about ZDO packet handling, see Receiving ZDO commands and responses.
- When AO is set to 0, a basic 0x90 receive frame type will be emitted when data packets are received by the device. No ZDO messages are emitted when configured this way.
- When AO is non-zero, received data packets will be emitted as explicit 0x91 frames.
- AO bits 1, 2, and 3 determine the routing of received ZDO messages. By default, the XBee application will handle all received messages, but for supporting external Zigbee applications, the received messages can instead be passed through to the serial port by setting these bits.
- AO bit 4 will allow supported ZDO message that are handled by the XBee application to be echoed to the serial port.
Leave unused bits clear so future API options are not inadvertently enabled during a firmware update.
Bit field
Unused bits must be set to 0. These bits may be logically OR'ed together:
Bit | Description |
---|---|
0 |
0 = Native API output (0x90 frame type) 1 = Explicit API output (0x91 frame type) |
1 |
0 = XBee handles Supported ZDO requests 1 = Supported ZDO request pass-through |
2 |
0 = XBee handles UnsupportedZDOrequests (responds with ZDO not supported) 1 = Unsupported ZDO request pass-through |
3 |
0 = XBee handles Binding requests (responds with ZDO not supported) 1 = Binding request pass-through |
4 |
This bit is only applicable when AO bit 1 = 0 (XBee handles incoming ZDO) 1 = Echo supported ZDO requests to the serial port |
5 |
1 = Prevent any ZDO messages from going out the serial port. This will also disable any pass-through set by other AO bits. |
Parameter range
0 - 0xFF
Default
0