![]() |
nRF5 SDK for Thread and Zigbee v1.0.0
|
Choose documentation: | nRF5 SDK | S112 SoftDevice API | S132 SoftDevice API | S140 SoftDevice API | S212 SoftDevice API |
#include <zboss_api_internal.h>
Data Fields | |
zb_bitfield_t | used:1 |
zb_bitfield_t | ext_neighbor:1 |
zb_bitfield_t | device_type:2 |
zb_bitfield_t | depth:4 |
zb_bitfield_t | permit_joining:1 |
zb_bitfield_t | rx_on_when_idle:1 |
zb_bitfield_t | relationship:3 |
zb_bitfield_t | need_rejoin:1 |
zb_bitfield_t | dummy: 1 |
zb_bitfield_t | keepalive_received:1 |
zb_uint8_t | transmit_failure_cnt |
zb_uint8_t | lqi |
zb_int8_t | rssi |
union { | |
struct zb_ext_neighbor_s { | |
zb_uint16_t short_addr | |
zb_ieee_addr_compressed_t long_addr | |
zb_uint8_t update_id | |
zb_bitfield_t panid_ref:5 | |
zb_bitfield_t router_capacity:1 | |
zb_bitfield_t end_device_capacity:1 | |
zb_bitfield_t potential_parent:1 | |
zb_bitfield_t logical_channel:5 | |
zb_bitfield_t stack_profile:2 | |
zb_bitfield_t reserved:1 | |
} ext | |
struct zb_base_neighbor_s { | |
zb_uint8_t key_seq_number | |
zb_address_ieee_ref_t addr_ref | |
zb_bitfield_t nwk_ed_timeout:4 | |
zb_bitfield_t outgoing_cost:3 | |
zb_bitfield_t age:2 | |
zb_uint32_t incoming_frame_counter | |
zb_time_t time_to_expire | |
} base | |
} | u |
Neighbor table entry
zb_bitfield_t zb_neighbor_tbl_ent_s::age |
< The number of nwkLinkStatusPeriod intervals since a link status command was received
zb_bitfield_t zb_neighbor_tbl_ent_s::depth |
The network depth of this device. A value of 0x00 indicates that this device is the ZigBee coordinator for the network.
zb_bitfield_t zb_neighbor_tbl_ent_s::device_type |
Neighbor device type -
zb_bitfield_t zb_neighbor_tbl_ent_s::dummy |
not used bit
zb_bitfield_t zb_neighbor_tbl_ent_s::end_device_capacity |
This value is set to TRUE if the device is capable of accepting join requests from end devices seeking to join the network and is set to FALSE otherwise.
zb_bitfield_t zb_neighbor_tbl_ent_s::ext_neighbor |
if 1, this is ext neighbor record, else base neighbor
zb_uint32_t zb_neighbor_tbl_ent_s::incoming_frame_counter |
incoming NWK frame counter for this device after key change
zb_bitfield_t zb_neighbor_tbl_ent_s::keepalive_received |
This value indicates at least one keepalive has been received from the end device since the router has rebooted.
zb_uint8_t zb_neighbor_tbl_ent_s::key_seq_number |
key number for which incoming_frame_counter is valid
zb_bitfield_t zb_neighbor_tbl_ent_s::logical_channel |
The current logical channel occupied by the network.
zb_ieee_addr_compressed_t zb_neighbor_tbl_ent_s::long_addr |
64 bit address (packed)
zb_uint8_t zb_neighbor_tbl_ent_s::lqi |
Link quality. Also used to calculate incoming cost
zb_bitfield_t zb_neighbor_tbl_ent_s::need_rejoin |
Need send rejoin response without receive request
zb_bitfield_t zb_neighbor_tbl_ent_s::outgoing_cost |
The cost of an outgoing link. Got from link status.
zb_bitfield_t zb_neighbor_tbl_ent_s::panid_ref |
ref to the extended pan id
zb_bitfield_t zb_neighbor_tbl_ent_s::permit_joining |
A value of TRUE indicates that at least one ZigBee router on the network currently permits joining, i.e. its NWK has been issued an NLME-PERMIT-JOINING primitive and, the time limit if given, has not yet expired.
zb_bitfield_t zb_neighbor_tbl_ent_s::potential_parent |
This field usage - see 3.6.1.4.1.1 Child Procedure: If the Status parameter indicates a refusal to permit joining on the part of the neighboring device (that is, PAN at capacity or PAN access denied), then the device attempting to join should set the Potential parent bit to 0 in the corresponding neighbor table entry to indicate a failed join attempt.
zb_bitfield_t zb_neighbor_tbl_ent_s::relationship |
The relationship between the neighbor and the current device: 0x00=neighbor is the parent 0x01=neighbor is a child 0x02=neighbor is a sibling 0x03=none of the above 0x04=previous child 0x05=unauthenticated child This field shall be present in every neighbor table entry.
zb_bitfield_t zb_neighbor_tbl_ent_s::router_capacity |
This value is set to TRUE if this device is capable of accepting join requests from router- capable devices and is set to FALSE otherwise.
zb_int8_t zb_neighbor_tbl_ent_s::rssi |
Received signal strength indicator
zb_bitfield_t zb_neighbor_tbl_ent_s::rx_on_when_idle |
Indicates if neighbor receiver enabled during idle periods: TRUE = Receiver is on FALSE = Receiver is off This field should be present for entries that record the parent or children of a ZigBee router or ZigBee coordinator.
zb_uint16_t zb_neighbor_tbl_ent_s::short_addr |
16 bit network address of the neighboring device
zb_bitfield_t zb_neighbor_tbl_ent_s::stack_profile |
A ZBOSS profile identifier.
zb_uint8_t zb_neighbor_tbl_ent_s::transmit_failure_cnt |
Transmit failure counter (used to initiate device address search).
zb_uint8_t zb_neighbor_tbl_ent_s::update_id |
This field reflects the value of nwkUpdateId from the NIB.
zb_bitfield_t zb_neighbor_tbl_ent_s::used |
Record has used