Device Database#

API and Callbacks for the Device Database Component.

This component provides an API to add/remove a device from a list of known devices, and to record their list of endpoints and clusters.

API#

const EmberAfDeviceInfo *

emberAfPluginDeviceDatabaseGetDeviceByIndex(uint16_t index)

Get device by index.

const EmberAfDeviceInfo *

emberAfPluginDeviceDatabaseFindDeviceByStatus(EmberAfDeviceDiscoveryStatus status)

Find device by status.

const EmberAfDeviceInfo *

emberAfPluginDeviceDatabaseFindDeviceByEui64(EmberEUI64 eui64)

Find device by EUI64.

const EmberAfDeviceInfo *

emberAfPluginDeviceDatabaseAdd(EmberEUI64 eui64, uint8_t zigbeeCapabilities)

Add to the device database.

bool

emberAfPluginDeviceDatabaseEraseDevice(EmberEUI64 eui64)

Erase device from device database.

bool

emberAfPluginDeviceDatabaseSetEndpoints(const EmberEUI64 eui64, const uint8_t *endpointList, uint8_t endpointCount)

Set device endpoints.

uint8_t

emberAfPluginDeviceDatabaseGetDeviceEndpointFromIndex(const EmberEUI64 eui64, uint8_t index)

Get device endpoint from index.

uint8_t

emberAfPluginDeviceDatabaseGetIndexFromEndpoint(uint8_t endpoint, const EmberEUI64 eui64)

Get index from endpoint.

bool

emberAfPluginDeviceDatabaseSetClustersForEndpoint(const EmberEUI64 eui64, const EmberAfClusterList *clusterList)

Set clusters from endpoint.

bool

emberAfPluginDeviceDatabaseClearAllFailedDiscoveryStatus(uint8_t maxFailureCount)

Clear the failed DB discovery count.

const char *

emberAfPluginDeviceDatabaseGetStatusString(EmberAfDeviceDiscoveryStatus status)

Get device database status string.

bool

emberAfPluginDeviceDatabaseSetStatus(const EmberEUI64 deviceEui64, EmberAfDeviceDiscoveryStatus newStatus)

Set device database status.

const EmberAfDeviceInfo *

emberAfPluginDeviceDatabaseAddDeviceWithAllInfo(const EmberAfDeviceInfo *newDevice)

Add device to database with all information.

EmberStatus

emberAfPluginDeviceDatabaseDoesDeviceHaveCluster(EmberEUI64 deviceEui64, EmberAfClusterId clusterToFind, bool server, uint8_t *returnEndpoint)

Check if a device has cluster.

void

emberAfPluginDeviceDatabaseCreateNewSearch(EmberAfDeviceDatabaseIterator *iterator)

Create a new search.

EmberStatus

emberAfPluginDeviceDatabaseFindDeviceSupportingCluster(EmberAfDeviceDatabaseIterator *iterator, EmberAfClusterId clusterToFind, bool server, uint8_t *returnEndpoint)

Find device supporting cluster.

API Documentation#

emberAfPluginDeviceDatabaseGetDeviceByIndex#

const EmberAfDeviceInfo * emberAfPluginDeviceDatabaseGetDeviceByIndex (uint16_t index)

Get device by index.

Parameters

Type	Direction	Argument Name	Description
uint16_t	N/A	index	Ver.: always

Returns

EmberAfDeviceInfo Device Information struct

emberAfPluginDeviceDatabaseFindDeviceByStatus#

const EmberAfDeviceInfo * emberAfPluginDeviceDatabaseFindDeviceByStatus (EmberAfDeviceDiscoveryStatus status)

Find device by status.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceDiscoveryStatus	N/A	status	Ver.: always

Returns

EmberAfDeviceInfo Device Information struct

emberAfPluginDeviceDatabaseFindDeviceByEui64#

const EmberAfDeviceInfo * emberAfPluginDeviceDatabaseFindDeviceByEui64 (EmberEUI64 eui64)

Find device by EUI64.

Parameters

Type	Direction	Argument Name	Description
EmberEUI64	N/A	eui64

Returns

EmberAfDeviceInfo Device Information struct

emberAfPluginDeviceDatabaseAdd#

const EmberAfDeviceInfo * emberAfPluginDeviceDatabaseAdd (EmberEUI64 eui64, uint8_t zigbeeCapabilities)

Add to the device database.

Parameters

Type	Direction	Argument Name	Description
EmberEUI64	N/A	eui64	Ver.: always
uint8_t	N/A	zigbeeCapabilities	Ver.: always

Returns

EmberDeviceInfo

emberAfPluginDeviceDatabaseEraseDevice#

bool emberAfPluginDeviceDatabaseEraseDevice (EmberEUI64 eui64)

Erase device from device database.

Parameters

Type	Direction	Argument Name	Description
EmberEUI64	N/A	eui64	Ver.: always

Returns

bool true is success

emberAfPluginDeviceDatabaseSetEndpoints#

bool emberAfPluginDeviceDatabaseSetEndpoints (const EmberEUI64 eui64, const uint8_t * endpointList, uint8_t endpointCount)

Set device endpoints.

Parameters

Type	Direction	Argument Name
const EmberEUI64	N/A	eui64
const uint8_t *	N/A	endpointList
uint8_t	N/A	endpointCount

Returns

bool true is success

emberAfPluginDeviceDatabaseGetDeviceEndpointFromIndex#

uint8_t emberAfPluginDeviceDatabaseGetDeviceEndpointFromIndex (const EmberEUI64 eui64, uint8_t index)

Get device endpoint from index.

Parameters

Type	Direction	Argument Name	Description
const EmberEUI64	N/A	eui64
uint8_t	N/A	index

Returns

uint8_t

emberAfPluginDeviceDatabaseGetIndexFromEndpoint#

uint8_t emberAfPluginDeviceDatabaseGetIndexFromEndpoint (uint8_t endpoint, const EmberEUI64 eui64)

Get index from endpoint.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	endpoint
const EmberEUI64	N/A	eui64

Note

Explicitly made the eui64 the second argument to prevent confusion between this function and the emberAfPluginDeviceDatabaseGetDeviceEndpointsFromIndex()

emberAfPluginDeviceDatabaseSetClustersForEndpoint#

bool emberAfPluginDeviceDatabaseSetClustersForEndpoint (const EmberEUI64 eui64, const EmberAfClusterList * clusterList)

Set clusters from endpoint.

Parameters

Type	Direction	Argument Name	Description
const EmberEUI64	N/A	eui64
const EmberAfClusterList *	N/A	clusterList

Returns

bool true is success

emberAfPluginDeviceDatabaseClearAllFailedDiscoveryStatus#

bool emberAfPluginDeviceDatabaseClearAllFailedDiscoveryStatus (uint8_t maxFailureCount)

Clear the failed DB discovery count.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	maxFailureCount

Returns

bool true is success

emberAfPluginDeviceDatabaseGetStatusString#

const char * emberAfPluginDeviceDatabaseGetStatusString (EmberAfDeviceDiscoveryStatus status)

Get device database status string.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceDiscoveryStatus	N/A	status

Returns

const char* status string

emberAfPluginDeviceDatabaseSetStatus#

bool emberAfPluginDeviceDatabaseSetStatus (const EmberEUI64 deviceEui64, EmberAfDeviceDiscoveryStatus newStatus)

Set device database status.

Parameters

Type	Direction	Argument Name	Description
const EmberEUI64	N/A	deviceEui64
EmberAfDeviceDiscoveryStatus	N/A	newStatus

Returns

bool true is success.

emberAfPluginDeviceDatabaseAddDeviceWithAllInfo#

const EmberAfDeviceInfo * emberAfPluginDeviceDatabaseAddDeviceWithAllInfo (const EmberAfDeviceInfo * newDevice)

Add device to database with all information.

Parameters

Type	Direction	Argument Name	Description
const EmberAfDeviceInfo *	N/A	newDevice	Struct pointer to device infor

Returns

EmberDeviceInfo

emberAfPluginDeviceDatabaseDoesDeviceHaveCluster#

EmberStatus emberAfPluginDeviceDatabaseDoesDeviceHaveCluster (EmberEUI64 deviceEui64, EmberAfClusterId clusterToFind, bool server, uint8_t * returnEndpoint)

Check if a device has cluster.

Parameters

Type	Direction	Argument Name
EmberEUI64	N/A	deviceEui64
EmberAfClusterId	N/A	clusterToFind
bool	N/A	server
uint8_t *	N/A	returnEndpoint

Returns

EmberStatus status code

emberAfPluginDeviceDatabaseCreateNewSearch#

void emberAfPluginDeviceDatabaseCreateNewSearch (EmberAfDeviceDatabaseIterator * iterator)

Create a new search.

Parameters

Type	Direction	Argument Name	Description
EmberAfDeviceDatabaseIterator *	N/A	iterator

emberAfPluginDeviceDatabaseFindDeviceSupportingCluster#

EmberStatus emberAfPluginDeviceDatabaseFindDeviceSupportingCluster (EmberAfDeviceDatabaseIterator * iterator, EmberAfClusterId clusterToFind, bool server, uint8_t * returnEndpoint)

Find device supporting cluster.

Parameters

Type	Direction	Argument Name
EmberAfDeviceDatabaseIterator *	N/A	iterator
EmberAfClusterId	N/A	clusterToFind
bool	N/A	server
uint8_t *	N/A	returnEndpoint

Returns

EmberStatus status code