Get general parameters

Macros
#define	ZB_JOINED()   zb_zdo_joined()

Functions
zb_bool_t	zb_get_rx_on_when_idle (void)
const zb_char_t *	zb_get_version (void)
	Get ZBOSS version. More...
zb_uint32_t	zboss_version_get (void)
	Get ZBOSS numeric 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)

Detailed Description

Macro Definition Documentation

ZB_JOINED

#define ZB_JOINED

(

)

zb_zdo_joined()

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

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

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Get the currently used channel.

zb_get_current_page()

zb_uint8_t zb_get_current_page

(

void

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

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

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

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

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

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

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Returns the maximum number of children allowed

Deprecated:

This function will be removed in the next Major release after March 2025 Use zb_nwk_get_max_ed_capacity() instead

zb_get_network_role()

zb_nwk_device_type_t zb_get_network_role

(

void

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

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

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Get 16-bit PAN ID

zb_get_rx_on_when_idle()

zb_bool_t zb_get_rx_on_when_idle

(

void

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

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

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Get current short address of the device

zb_get_version()

const zb_char_t* zb_get_version

(

void

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Get ZBOSS version.

Returns

Pointer to zero-terminated version string.

zboss_version_get()

zb_uint32_t zboss_version_get

(

void

)

#include </home/developer/.conan/data/ti_zigbee/1.01.00.10/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api.h>

Get ZBOSS numeric version.

Returns

(MAJOR << 24 | MINOR << 16 | REVISION)