nRF5 SDK for Thread and Zigbee v3.2.0
Typedefs | Enumerations | Functions
Set general parameters before zboss_start() call

Typedefs

typedef enum
nwk_requested_timeout_e 
nwk_requested_timeout_t
 

Enumerations

enum  nwk_requested_timeout_e {
  ED_AGING_TIMEOUT_10SEC = 0, ED_AGING_TIMEOUT_2MIN, ED_AGING_TIMEOUT_4MIN, ED_AGING_TIMEOUT_8MIN,
  ED_AGING_TIMEOUT_16MIN, ED_AGING_TIMEOUT_32MIN, ED_AGING_TIMEOUT_64MIN, ED_AGING_TIMEOUT_128MIN,
  ED_AGING_TIMEOUT_256MIN, ED_AGING_TIMEOUT_512MIN, ED_AGING_TIMEOUT_1024MIN, ED_AGING_TIMEOUT_2048MIN,
  ED_AGING_TIMEOUT_4096MIN, ED_AGING_TIMEOUT_8192MIN, ED_AGING_TIMEOUT_16384MIN
}
 

Functions

zb_void_t zb_set_channel (zb_uint32_t channel_mask)
 
zb_ret_t zb_set_tx_power (zb_uint8_t tx_power)
 
zb_void_t zb_set_rx_on_when_idle (zb_bool_t rx_on)
 
zb_void_t zb_set_long_address (const zb_ieee_addr_t addr)
 
zb_void_t zb_set_extended_pan_id (const zb_ext_pan_id_t ext_pan_id)
 
zb_void_t zb_set_node_descriptor_manufacturer_code (zb_uint16_t manuf_code)
 
void zb_set_network_coordinator_role (zb_uint32_t channel_mask)
 
void zb_set_network_coordinator_role_legacy (zb_uint32_t channel_mask)
 
void zb_set_network_router_role (zb_uint32_t channel_mask)
 
void zb_set_network_router_role_legacy (zb_uint32_t channel_mask)
 
void zb_set_network_ed_role (zb_uint32_t channel_mask)
 
void zb_set_network_ed_role_legacy (zb_uint32_t channel_mask)
 
zb_void_t zb_set_max_children (zb_uint8_t max_children)
 
void zb_set_ed_timeout (zb_uint_t to)
 
void zb_set_keepalive_timeout (zb_uint_t to)
 

Detailed Description

Typedef Documentation

Enum all values used in End Device timeout request

Enumeration Type Documentation

Enum all values used in End Device timeout request

Enumerator
ED_AGING_TIMEOUT_10SEC 

10 second timeout

ED_AGING_TIMEOUT_2MIN 

2 minutes

ED_AGING_TIMEOUT_4MIN 

4 minutes

ED_AGING_TIMEOUT_8MIN 

8 minutes

ED_AGING_TIMEOUT_16MIN 

16 minutes

ED_AGING_TIMEOUT_32MIN 

32 minutes

ED_AGING_TIMEOUT_64MIN 

64 minutes

ED_AGING_TIMEOUT_128MIN 

128 minutes

ED_AGING_TIMEOUT_256MIN 

256 minutes

ED_AGING_TIMEOUT_512MIN 

512 minutes

ED_AGING_TIMEOUT_1024MIN 

1024 minutes

ED_AGING_TIMEOUT_2048MIN 

2048 minutes

ED_AGING_TIMEOUT_4096MIN 

4096 minutes

ED_AGING_TIMEOUT_8192MIN 

8192 minutes

ED_AGING_TIMEOUT_16384MIN 

16384 minutes

Function Documentation

zb_void_t zb_set_channel ( zb_uint32_t  channel_mask)

Set channel mask on device.

Parameters
channel_mask- ZigBee channel mask

Example:

zb_set_channel((1l<<13) | (1l<<14));
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.

Parameters
to- index in nwk_requested_timeout_e
zb_void_t zb_set_extended_pan_id ( const zb_ext_pan_id_t  ext_pan_id)

Set Extended Pan ID (apsUseExtendedPANID attribute)

Parameters
ext_pan_id- Long (64-bit) Extented Pan ID
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.

Parameters
to- timeout, in beacon intervals
zb_void_t zb_set_long_address ( const zb_ieee_addr_t  addr)

Set 64-bit long address

Parameters
addr- long address structure
zb_void_t zb_set_max_children ( zb_uint8_t  max_children)

Set the maximum number of connected devices. Used for coordinators and routers

Parameters
max_children- maximum number of connected devices.
void zb_set_network_coordinator_role ( zb_uint32_t  channel_mask)

Initiate device as a ZigBee coordinator

Parameters
channel_mask- ZigBee channel mask
void zb_set_network_coordinator_role_legacy ( zb_uint32_t  channel_mask)

Initiate device as a legacy (pre-r21) ZigBee coordinator

Parameters
channel_mask- ZigBee channel mask
void zb_set_network_ed_role ( zb_uint32_t  channel_mask)

Initiate device as a ZigBee End Device

Parameters
channel_mask- ZigBee channel mask
void zb_set_network_ed_role_legacy ( zb_uint32_t  channel_mask)

Initiate device as a legacy (pre-r21) ZigBee End Device

Parameters
channel_mask- ZigBee channel mask
void zb_set_network_router_role ( zb_uint32_t  channel_mask)

Initiate device as a ZigBee router

Parameters
channel_mask- ZigBee channel mask
void zb_set_network_router_role_legacy ( zb_uint32_t  channel_mask)

Initiate device as a legacy (pre-r21) ZigBee router

Parameters
channel_mask- ZigBee channel mask
zb_void_t zb_set_node_descriptor_manufacturer_code ( zb_uint16_t  manuf_code)

Update ZDP Node Descriptor manufacturer code

Parameters
manuf_code- Manufacturer code
zb_void_t zb_set_rx_on_when_idle ( zb_bool_t  rx_on)

Set RxOnWhenIdle attribute

Parameters
rx_on- attribute value

Example:

zb_set_rx_on_when_idle(ZB_FALSE); // switch device to rx off
zb_ret_t zb_set_tx_power ( zb_uint8_t  tx_power)

Set transmit power.

Parameters
tx_power- Transmit power [dBm].

Example:


Documentation feedback | Developer Zone | Subscribe | Updated