Binding Frames#

Name: clearBindingTable

ID: 0x002A

Description: Deletes all binding table entries.

Command Parameters: None

Response Parameters:

sl_status_t status

An sl_status_t value indicating success or the reason for failure.

Name: setBinding

ID: 0x002B

Description: Sets an entry in the binding table.

Command Parameters:

uint8_t index

The index of a binding table entry.

sl_zigbee_binding_table_entry_t value

The contents of the binding entry.

Response Parameters:

sl_status_t status

An sl_status_t value indicating success or the reason for failure.

Name: getBinding

ID: 0x002C

Description: Gets an entry from the binding table.

Command Parameters:

uint8_t index

The index of a binding table entry.

Response Parameters:

sl_status_t status

An sl_status_t value indicating success or the reason for failure.

sl_zigbee_binding_table_entry_t value

The contents of the binding entry.

Name: deleteBinding

ID: 0x002D

Description: Deletes a binding table entry.

Command Parameters:

uint8_t index

The index of a binding table entry.

Response Parameters:

sl_status_t status

An sl_status_t value indicating success or the reason for failure.

Name: bindingIsActive

ID: 0x002E

Description: Indicates whether any messages are currently being sent using this binding table entry. Note that this command does not indicate whether a binding is clear. To determine whether a binding is clear, check whether the type field of the sl_zigbee_binding_table_entry_t has the value SL_ZIGBEE_UNUSED_BINDING.

Command Parameters:

uint8_t index

The index of a binding table entry.

Response Parameters:

bool active

True if the binding table entry is active, false otherwise.

Name: getBindingRemoteNodeId

ID: 0x002F

Description: Returns the node ID for the binding's destination, if the ID is known. If a message is sent using the binding and the destination's ID is not known, the stack will discover the ID by broadcasting a ZDO address request. The application can avoid the need for this discovery by using setBindingRemoteNodeId when it knows the correct ID via some other means. The destination's node ID is forgotten when the binding is changed, when the local node reboots or, much more rarely, when the destination node changes its ID in response to an ID conflict.

Command Parameters:

uint8_t index

The index of a binding table entry.

Response Parameters:

sl_802154_short_addr_t nodeId

The short ID of the destination node or SL_ZIGBEE_NULL_NODE_ID if no destination is known.

Name: setBindingRemoteNodeId

ID: 0x0030

Description: Set the node ID for the binding's destination. See getBindingRemoteNodeId for a description.

Command Parameters:

uint8_t index

The index of a binding table entry.

sl_802154_short_addr_t nodeId

The short ID of the destination node.

Response Parameters: None

Name: remoteSetBindingHandler

ID: 0x0031

Description: The NCP used the external binding modification policy to decide how to handle a remote set binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.

This frame is a response to the callback command.

Response Parameters:

sl_zigbee_binding_table_entry_t entry

The requested binding.

uint8_t index

The index at which the binding was added.

sl_status_t policyDecision

SL_STATUS_OK if the binding was added to the table and any other status if not.

Name: remoteDeleteBindingHandler

ID: 0x0032

Description: The NCP used the external binding modification policy to decide how to handle a remote delete binding request. The Host cannot change the current decision, but it can change the policy for future decisions using the setPolicy command.

This frame is a response to the callback command.

Response Parameters:

uint8_t index

The index of the binding whose deletion was requested.

sl_status_t policyDecision

SL_STATUS_OK if the binding was removed from the table and any other status if not.