Device Database#

sl_zigbee_af_device_database_get_device_by_index#

const sl_zigbee_af_device_info_t * sl_zigbee_af_device_database_get_device_by_index (uint16_t index)

Get device by index.

Returns

• NULL if no device exists at that index, else a valid pointer to the entry.

sl_zigbee_af_device_database_find_device_by_status#

const sl_zigbee_af_device_info_t * sl_zigbee_af_device_database_find_device_by_status (sl_zigbee_af_device_discovery_status_t status)

Find the first device that matches input status.

Returns

• NULL if no device matches status, else a valid pointer to the entry.

sl_zigbee_af_device_database_find_device_by_eui64#

const sl_zigbee_af_device_info_t * sl_zigbee_af_device_database_find_device_by_eui64 (sl_802154_long_addr_t eui64)

Find device by EUI64.

Returns

• NULL if device is not found, else a valid pointer to the entry.

sl_zigbee_af_device_database_add#

sl_status_t sl_zigbee_af_device_database_add (sl_802154_long_addr_t eui64, uint8_t macCapabilities)

Add to the device database.

Returns

• SL_STATUS_OK upon success, SL_STATUS_ALREADY_EXISTS if device is already in table, else SL_STATUS_FULL if table is full.

sl_zigbee_af_device_database_erase_device#

bool sl_zigbee_af_device_database_erase_device (sl_802154_long_addr_t eui64)

Erase device from device database.

Returns

• True if the device is found, else false.

sl_zigbee_af_device_database_set_endpoints#

bool sl_zigbee_af_device_database_set_endpoints (const sl_802154_long_addr_t eui64, const uint8_t * endpointList, uint8_t endpointCount)

Set device endpoints.

Returns

• True if the device is found, else false.

sl_zigbee_af_device_database_get_device_endpoint_from_index#

uint8_t sl_zigbee_af_device_database_get_device_endpoint_from_index (const sl_802154_long_addr_t eui64, uint8_t index)

Get device endpoint from index.

Returns

• The endpoint value from the entry at the given index.

sl_zigbee_af_device_database_get_index_from_endpoint#

uint8_t sl_zigbee_af_device_database_get_index_from_endpoint (uint8_t endpoint, const sl_802154_long_addr_t eui64)

Get endpoint index for a given endpoint value on the specified device.

Returns

• The index at which ::endpoint is stored in the entry for ::eui64, else 0xFF if the device or endpoint are not found.

sl_zigbee_af_device_database_set_clusters_for_endpoint#

bool sl_zigbee_af_device_database_set_clusters_for_endpoint (const sl_802154_long_addr_t eui64, const sl_zigbee_af_cluster_list_t * clusterList)

Set clusters for device endpoint.

Returns

• True upon successful update, else false if device or endpoint on device is not found.

Note

• The endpoint specified in ::clusterList must previously be written to the entry using sl_zigbee_af_device_database_set_endpoints.

sl_zigbee_af_device_database_clear_all_failed_discovery_status#

bool sl_zigbee_af_device_database_clear_all_failed_discovery_status (uint8_t maxFailureCount)

Searches for any entries that have a failed discovery state (SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_FAILED) and whose number of failures is less than ::maxFailureCount. Clears those entries' statuses by setting them to SL_ZIGBEE_AF_DEVICE_DISCOVERY_STATUS_NEW.

Returns

• True if at least one entry was cleared, false otherwise.

Note

• This component works alongside the Device Query Service component, which manages device status in this Device Database component. The user is not expected to call these APIs to update device status.

sl_zigbee_af_device_database_set_status#

bool sl_zigbee_af_device_database_set_status (const sl_802154_long_addr_t deviceEui64, sl_zigbee_af_device_discovery_status_t newStatus)

Set device database status for a given device. This API is used by other components to handle device state when probing the device, for instance. The generic device state is stored in this Device Database component, but this component performs no action based on that state.

Returns

• True if the device is found, else false.

Note

• This component works alongside the Device Query Service component, which manages device status in this Device Database component. The user is not expected to call these APIs to update device status.

sl_zigbee_af_device_database_add_device_with_all_info#

sl_status_t sl_zigbee_af_device_database_add_device_with_all_info (const sl_zigbee_af_device_info_t * newDevice)

Add device to database with all information filled out.

Returns

• SL_STATUS_OK upon success, SL_STATUS_ALREADY_EXISTS if device is already in table, else SL_STATUS_FULL if table is full.

sl_zigbee_af_device_database_does_device_have_cluster#

sl_status_t sl_zigbee_af_device_database_does_device_have_cluster (sl_802154_long_addr_t deviceEui64, sl_zigbee_af_cluster_id_t clusterToFind, bool server, uint8_t * returnEndpoint)

Check if a device has cluster.

Returns

• SL_STATUS_OK if found, SL_STATUS_INVALID_PARAMETER if device not in database, else SL_STATUS_NOT_FOUND if device is found but no match on cluster.

sl_zigbee_af_device_database_create_new_search#

void sl_zigbee_af_device_database_create_new_search (sl_zigbee_af_device_database_iterator_t * iterator)

Create a new search. Resets iterator starting index to 0.

Note

• This function is typically called before calling sl_zigbee_af_device_database_find_device_supporting_cluster, which is done to find the entry index of a device matching an input cluster.

Returns

• None

Note

• This function is used when a caller wants to know which index in the database matches a given search criterion.

sl_zigbee_af_device_database_find_device_supporting_cluster#

sl_status_t sl_zigbee_af_device_database_find_device_supporting_cluster (sl_zigbee_af_device_database_iterator_t * iterator, sl_zigbee_af_cluster_id_t clusterToFind, bool server, uint8_t * returnEndpoint)

Finds the next device that supports the given cluster.

Returns

• SL_STATUS_OK if found, SL_STATUS_INVALID_INDEX if iterator index is beyond max table size, else SL_STATUS_NOT_FOUND if no device in the database supports the desired cluster.