sxa_cached_group_t Struct Reference

Cached register group value. More...

#include "xbee/sxa.h"

Data Fields
uint16_t	id
	Arbitrary numeric ID of this group (see SXA_CACHED_NODE_ID etc.)
uint16_t	flags_offs
	Offset (within sxa_node_t) of cache group status flags (_SXA_CACHED_OK etc.) This field is zero to indicate end of array of sxa_cached_group_t. More...
const xbee_atcmd_reg_t FAR *	get_list
	If not NULL, is a command list used to update all cached values in the group.
sxa_cache_upd_fn	get_fn
	If not NULL, is a function to call (after get_list, if any) in order to perform any necessary post processing. More...

Detailed Description

Cached register group value.

This struct is used to manage related groups of registers. A group is used when registers are almost always used together or when special actions need to be taken on updates or queries.

Note

There is a static (const) array of these set up for the standard groups (_sxa_default_cache_groups). In sxa_node_t.groups points to this array by default.

The function _sxa_cache_group_by_id() returns one of the default cached groups by looking up its ID.

Field Documentation

uint16_t flags_offs

Offset (within sxa_node_t) of cache group status flags (_SXA_CACHED_OK etc.) This field is zero to indicate end of array of sxa_cached_group_t.

sxa_cache_upd_fn get_fn

If not NULL, is a function to call (after get_list, if any) in order to perform any necessary post processing.

---

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

• include/xbee/sxa.h