Developing with ZBOSS SDK for Zigbee

Modules

 General parameters to be set before start
 
 ZBOSS commissioning signals handler
 
 NVRAM
 
 Sleep API
 

Macros

#define ZB_JOINED()   zb_zdo_joined()
 

Functions

zb_bool_t zb_get_rx_on_when_idle (void)
 
const zb_char_t ZB_IAR_CODE * zb_get_version (void)
 Get ZBOSS version. More...
 
void zb_get_long_address (zb_ieee_addr_t addr)
 
zb_uint16_t zb_get_pan_id (void)
 
zb_uint16_t zb_get_short_address (void)
 
void zb_get_extended_pan_id (zb_ext_pan_id_t ext_pan_id)
 
zb_uint8_t zb_get_current_page (void)
 
zb_uint8_t zb_get_current_channel (void)
 
zb_nwk_device_type_t zb_get_network_role (void)
 
zb_uint8_t zb_get_max_children (void)
 
void zb_set_mac_transaction_persistence_time (zb_uint16_t ms)
 Set the 'macTransactionPersistenceTime' attribute in the MAC PIB. More...
 

Detailed Description

Macro Definition Documentation

◆ ZB_JOINED

#define ZB_JOINED ( )    zb_zdo_joined()

Checks that device is joined to the network.

Returns
true if device is joined; false - otherwise

Function Documentation

◆ zb_get_current_channel()

zb_uint8_t zb_get_current_channel ( void  )

Get the currently used channel.

◆ zb_get_current_page()

zb_uint8_t zb_get_current_page ( void  )

Get the currently used channel page.

◆ zb_get_extended_pan_id()

void zb_get_extended_pan_id ( zb_ext_pan_id_t  ext_pan_id)

Get Extended Pan ID (nwkExtendedPANId attribute)

Parameters
ext_pan_id- pointer to memory where result will be stored

◆ zb_get_long_address()

void zb_get_long_address ( zb_ieee_addr_t  addr)

Get 64-bit long address

Parameters
addr- pointer to memory where result will be stored

◆ zb_get_max_children()

zb_uint8_t zb_get_max_children ( void  )

Returns the maximum number of children allowed

◆ zb_get_network_role()

zb_nwk_device_type_t zb_get_network_role ( void  )

Returns the device role ID

Returns
- zb_nwk_device_type_t device_role_id

◆ zb_get_pan_id()

zb_uint16_t zb_get_pan_id ( void  )

Get 16-bit PAN ID

◆ zb_get_rx_on_when_idle()

zb_bool_t zb_get_rx_on_when_idle ( void  )

Returns current state of RX-ON-When-Idle of Zigbee ZED

Returns
ZB_TRUE if ZED is not sleepy ZED, ZB_FALSE if ZED is a sleepy ZED

◆ zb_get_short_address()

zb_uint16_t zb_get_short_address ( void  )

Get current short address of the device

◆ zb_get_version()

const zb_char_t ZB_IAR_CODE* zb_get_version ( void  )

Get ZBOSS version.

Returns
Pointer to zero-terminated version string.

◆ zb_set_mac_transaction_persistence_time()

void zb_set_mac_transaction_persistence_time ( zb_uint16_t  ms)

Set the 'macTransactionPersistenceTime' attribute in the MAC PIB.

Parameters
ms- value in milliseconds