Data Fields
int	is_state
	1 if a "state", 0 if a "setting", or other values for special purposes. More...

const char *	alias
	Two-character AT command string for this register (except entry for <dest_addr> is "DH/DL"). More...

uint16_t	cxval
	Custom xbee_type value (bitfield) for query descriptor. More...

_xbee_rci_type_t	rci_type
	RCI type.

uint16_t	sxa_offs
	Offset in SXA node structure of cached field value.

uint16_t	sxa_len
	Length of cached field value.

uint16_t	sxa_cache_group
	SXA cache group (bitfield), or SXA_CACHED_MISC if not grouped.

Field Documentation

const char* alias

Two-character AT command string for this register (except entry for <dest_addr> is "DH/DL").

Referenced by _sxa_io_process_response().

uint16_t cxval

Custom xbee_type value (bitfield) for query descriptor.

This field is a bitmask, which determines whether this entry is applicable to a given XBee module type. A mask (M) for the module is obtained by (e.g.) M = sxa_module_type_mask(sxa). Then, only if (M & cxval) == M is the entry applicable.

One of the bits in cxval is for a "gateway" i.e. a local module. If this bit is NOT set in cxval, then such commands are not usually performed on local devices, usually because changing that register might disrupt the network and make it inaccessible. In cases where it really is necessary to change one of these registers, the gateway bit in M can be reset before applying the above bitmask test.

Note: This mask behavior is derived from NDS and is used by iDigi.

int is_state

1 if a "state", 0 if a "setting", or other values for special purposes.

A state is read-only, and reflects dynamic state such as error counts. A setting is read/write or write-only, which can (in principle) be saved to non-volatile storage on the device.

The documentation for this struct was generated from the following file:

include/xbee/reg_descr.h

Data Fields

Field Documentation