Developing with ZBOSS for Zigbee
Data Structures | |
| struct | zb_tx_power_params_s |
| A struct with params for zb_get_tx_power_async and zb_set_tx_power_async. More... | |
Typedefs | |
| typedef struct zb_tx_power_params_s | zb_tx_power_params_t |
| A struct with params for zb_get_tx_power_async and zb_set_tx_power_async. More... | |
| typedef void(* | zb_set_manufacturer_code_cb_t) (zb_ret_t status) |
| typedef zb_uint8_t | nwk_requested_timeout_t |
| Type for End Device (ED) timeout request. More... | |
| typedef zb_uint8_t | nwk_keepalive_supported_method_t |
| Type for ZC/ZR supported keepalive methods. More... | |
Channel pages' numbers | |
Note: These values were members of | |
| #define | ZB_CHANNEL_PAGE0_2_4_GHZ 0U |
| #define | ZB_CHANNEL_PAGE23_SUB_GHZ 23U |
| #define | ZB_CHANNEL_PAGE24_SUB_GHZ 24U |
| #define | ZB_CHANNEL_PAGE25_SUB_GHZ 25U |
| #define | ZB_CHANNEL_PAGE26_SUB_GHZ 26U |
| #define | ZB_CHANNEL_PAGE27_SUB_GHZ 27U |
| #define | ZB_CHANNEL_PAGE28_SUB_GHZ 28U |
| #define | ZB_CHANNEL_PAGE29_SUB_GHZ 29U |
| #define | ZB_CHANNEL_PAGE30_SUB_GHZ 30U |
| #define | ZB_CHANNEL_PAGE31_SUB_GHZ 31U |
End Device (ED) timeout request | |
| #define | ED_AGING_TIMEOUT_10SEC 0U |
| #define | ED_AGING_TIMEOUT_2MIN 1U |
| #define | ED_AGING_TIMEOUT_4MIN 2U |
| #define | ED_AGING_TIMEOUT_8MIN 3U |
| #define | ED_AGING_TIMEOUT_16MIN 4U |
| #define | ED_AGING_TIMEOUT_32MIN 5U |
| #define | ED_AGING_TIMEOUT_64MIN 6U |
| #define | ED_AGING_TIMEOUT_128MIN 7U |
| #define | ED_AGING_TIMEOUT_256MIN 8U |
| #define | ED_AGING_TIMEOUT_512MIN 9U |
| #define | ED_AGING_TIMEOUT_1024MIN 10U |
| #define | ED_AGING_TIMEOUT_2048MIN 11U |
| #define | ED_AGING_TIMEOUT_4096MIN 12U |
| #define | ED_AGING_TIMEOUT_8192MIN 13U |
| #define | ED_AGING_TIMEOUT_16384MIN 14U |
ZC/ZR supported keepalive methods | |
| #define | ED_KEEPALIVE_DISABLED 0U |
| #define | MAC_DATA_POLL_KEEPALIVE 1U |
| #define | ED_TIMEOUT_REQUEST_KEEPALIVE 2U |
| #define | BOTH_KEEPALIVE_METHODS 3U |
| #define BOTH_KEEPALIVE_METHODS 3U |
ZC/ZR supports both MAC Data Poll and ED Timeout Request as Keepalive methods
| #define ED_AGING_TIMEOUT_1024MIN 10U |
| #define ED_AGING_TIMEOUT_10SEC 0U |
| #define ED_AGING_TIMEOUT_128MIN 7U |
| #define ED_AGING_TIMEOUT_16384MIN 14U |
| #define ED_AGING_TIMEOUT_16MIN 4U |
| #define ED_AGING_TIMEOUT_2048MIN 11U |
| #define ED_AGING_TIMEOUT_256MIN 8U |
| #define ED_AGING_TIMEOUT_2MIN 1U |
| #define ED_AGING_TIMEOUT_32MIN 5U |
| #define ED_AGING_TIMEOUT_4096MIN 12U |
| #define ED_AGING_TIMEOUT_4MIN 2U |
| #define ED_AGING_TIMEOUT_512MIN 9U |
| #define ED_AGING_TIMEOUT_64MIN 6U |
| #define ED_AGING_TIMEOUT_8192MIN 13U |
| #define ED_AGING_TIMEOUT_8MIN 3U |
| #define ED_KEEPALIVE_DISABLED 0U |
ZC/ZR doesn't support Keepalive feature
| #define ED_TIMEOUT_REQUEST_KEEPALIVE 2U |
ZC/ZR supports Keepalive feature by means of ED Timeout Request
| #define MAC_DATA_POLL_KEEPALIVE 1U |
ZC/ZR supports Keepalive feature by means of MAC Data Poll
| #define ZB_CHANNEL_PAGE0_2_4_GHZ 0U |
| #define ZB_CHANNEL_PAGE23_SUB_GHZ 23U |
| #define ZB_CHANNEL_PAGE24_SUB_GHZ 24U |
| #define ZB_CHANNEL_PAGE25_SUB_GHZ 25U |
| #define ZB_CHANNEL_PAGE26_SUB_GHZ 26U |
| #define ZB_CHANNEL_PAGE27_SUB_GHZ 27U |
| #define ZB_CHANNEL_PAGE28_SUB_GHZ 28U |
| #define ZB_CHANNEL_PAGE29_SUB_GHZ 29U |
| #define ZB_CHANNEL_PAGE30_SUB_GHZ 30U |
| #define ZB_CHANNEL_PAGE31_SUB_GHZ 31U |
Type for ZC/ZR supported keepalive methods.
Holds one of keepalive_supported_method. Kept only for backward compatibility as keepalive_supported_method were declared previously as enum. Can be removed in future releases.
| typedef zb_uint8_t nwk_requested_timeout_t |
Type for End Device (ED) timeout request.
| typedef void(* zb_set_manufacturer_code_cb_t) (zb_ret_t status) |
Declares callback that is called after setting manufacturer code
| status | - status of manufacturer code setting |
| typedef struct zb_tx_power_params_s zb_tx_power_params_t |
A struct with params for zb_get_tx_power_async and zb_set_tx_power_async.
| zb_ret_t zb_channel_list_add | ( | zb_channel_list_t | channel_list, |
| zb_uint8_t | page_num, | ||
| zb_uint32_t | channel_mask | ||
| ) |
Add channel mask for a specified channel page in a channel list
| channel_list | - pointer to a channel list |
| page_num | - channel page number - channel_pages_numbers |
| channel_mask | - Zigbee channel mask |
| void zb_channel_list_init | ( | zb_channel_list_t | channel_list | ) |
Initialize a channel list
| channel_list | - pointer to a channel list |
| void zb_get_tx_power_async | ( | zb_bufid_t | param | ) |
Get transceiver power for given page and channel asynchronously.
This function requires param to contain zb_tx_power_params_t. Will return status RET_UNINITIALIZED if the channel/page storage hasn't been initialized yet.
| param | - buffer, containing zb_tx_power_params_t. |
| void zb_set_channel_mask | ( | zb_uint32_t | channel_mask | ) |
Set channel mask on device.
| channel_mask | - Zigbee channel mask |
Example:
| void zb_set_ed_timeout | ( | zb_uint_t | to | ) |
Set end device timeout.
Use it on End Device to specify End Device timeout period used in ED Timeout request.
| to | - index in nwk_requested_timeout |
| void zb_set_extended_pan_id | ( | const zb_ext_pan_id_t | ext_pan_id | ) |
Set APS Use Extended Pan ID (apsUseExtendedPANID attribute)
Note: that function is obsolete. Use zb_set_use_extended_pan_id() instead!
| ext_pan_id | - Long (64-bit) Extended Pan ID |
| void zb_set_keepalive_mode | ( | nwk_keepalive_supported_method_t | mode | ) |
Set keep alive mode.
Use it to set which method a device should use in poll context.
| mode | - the keepalive mode a device wants to set |
| void zb_set_keepalive_timeout | ( | zb_uint_t | to | ) |
Set keep alive timeout.
Use it on End Device to specify how often device should poll its parent.
| to | - timeout, in beacon intervals |
| void zb_set_long_address | ( | const zb_ieee_addr_t | addr | ) |
Set 64-bit long address
| addr | - long address structure |
| void zb_set_max_children | ( | zb_uint8_t | max_children | ) |
Set the maximum number of connected devices. Used for coordinators and routers
| max_children | - maximum number of connected devices |
| void zb_set_network_coordinator_role | ( | zb_uint32_t | channel_mask | ) |
Initiate device as a Zigbee 3.0 (not SE!) coordinator
| channel_mask | - Zigbee channel mask |
| void zb_set_network_coordinator_role_ext | ( | zb_channel_list_t | channel_list | ) |
Initiate device as a Zigbee 3.0 BDB coordinator with channel list. Provides functionality to set mask for 2.4 GHz or Sub-GHz page.
| channel_list | - Zigbee channels list |
| void zb_set_network_coordinator_role_legacy | ( | zb_uint32_t | channel_mask | ) |
Initiate device as a legacy (pre-r21) Zigbee coordinator
| channel_mask | - Zigbee channel mask |
| void zb_set_network_ed_role | ( | zb_uint32_t | channel_mask | ) |
Initiate device as a Zigbee Zigbee 3.0 (not SE!) End Device
| channel_mask | - Zigbee channel mask |
| void zb_set_network_ed_role_ext | ( | zb_channel_list_t | channel_list | ) |
Initiate device as a Zigbee 3.0 BDB End Device with channel list. Provides functionality to set mask for 2.4 GHz or Sub-GHz page.
| channel_list | - Zigbee channels list |
| void zb_set_network_ed_role_legacy | ( | zb_uint32_t | channel_mask | ) |
Initiate device as a legacy (pre-r21) Zigbee End Device
| channel_mask | - Zigbee channel mask |
| void zb_set_network_router_role | ( | zb_uint32_t | channel_mask | ) |
Initiate device as a Zigbee Zigbee 3.0 (not SE!) router
| channel_mask | - Zigbee channel mask |
| void zb_set_network_router_role_ext | ( | zb_channel_list_t | channel_list | ) |
Initiate device as a Zigbee 3.0 BDB router with channel list. Provides functionality to set mask for Sub-GHz and 2.4GHz page.
| channel_list | - Zigbee channels list |
| void zb_set_network_router_role_legacy | ( | zb_uint32_t | channel_mask | ) |
Initiate device as a legacy (pre-r21) Zigbee router
| channel_mask | - Zigbee channel mask |
| void zb_set_node_descriptor_manufacturer_code_req | ( | zb_uint16_t | manuf_code, |
| zb_set_manufacturer_code_cb_t | cb | ||
| ) |
Set Manufacturer code of Node Descriptor Request
| manuf_code | - manufacturer code to set |
| cb | - callback that is called after manufacturer code setting |
| void zb_set_pan_id | ( | zb_uint16_t | pan_id | ) |
Set 16-bit PAN ID.
| [in] | pan_id | - PAN ID |
| void zb_set_rx_on_when_idle | ( | zb_bool_t | rx_on | ) |
Set RxOnWhenIdle attribute
| rx_on | - attribute value |
Example:
| void zb_set_tx_power_async | ( | zb_bufid_t | param | ) |
Set transceiver power to a given value on a given page and channel asynchronously.
This function requires param to contain zb_tx_power_params_t. If the power change is for the current channel, the function will attempt to change power immediately, otherwise it will save the change until channel switch.
| param | - buffer, containing zb_tx_power_params_t. |