NWK MTORR functionality

Data Structures
struct	zb_route_record_s
	Route record for public API usage. More...

Typedefs
typedef struct zb_route_record_s	zb_route_record_t
	Route record for public API usage. More...

Functions
zb_ret_t	zb_get_source_route (zb_route_record_t *p_route_record, zb_uint16_t short_dst_addr)
void	zb_start_concentrator_mode (zb_uint8_t radius, zb_uint32_t disc_time)
void	zb_stop_concentrator_mode (void)

Detailed Description

Typedef Documentation

zb_route_record_t

typedef struct zb_route_record_s zb_route_record_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_nwk.h>

Route record for public API usage.

Function Documentation

zb_get_source_route()

zb_ret_t zb_get_source_route	(	zb_route_record_t *	p_route_record,
		zb_uint16_t	short_dst_addr
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_nwk.h>

Search the local source route table for a route to the device.

Warning

This function will NOT trigger MTORR.

Parameters

p_route_record	- pointer to the structure to be filled with the route record
short_dst_addr	- short address of the device to search route to

Returns

RET_OK on success, this is the only case when p_route_record will be filled with valid data.
RET_INVALID_PARAMETER if NULL pointer provided.
RET_NOT_IMPLEMENTED if Concentrator role is not enabled for the device.
RET_NOT_FOUND if route record for the short_dst_addr is not found in local source route table.

zb_start_concentrator_mode()

void zb_start_concentrator_mode	(	zb_uint8_t	radius,
		zb_uint32_t	disc_time
	)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_nwk.h>

Enable Concentrator mode for the device (disabled by default). It's possible to call this function to send MTORR immediately, e.g. after a new device joined the network. It does affect only for Coordinator role.

Parameters

radius	- the hop count radius for concentrator route discoveries. If the value is set zero then the default radius will be used.
disc_time	- the time in seconds between concentrator route discoveries. If the value is set to zero, the route discoveries are done by the application layer only.

zb_stop_concentrator_mode()

void zb_stop_concentrator_mode

(

void

)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_nwk.h>

Disable Concentrator mode for the device. It does affect only for Coordinator role.