Device Table#

emberAfDeviceTableCliIndexSend#

void emberAfDeviceTableCliIndexSend (uint16_t index)

Send a message using the device table.

Sends the current framework ZCL command to the device specified by an index.

emberAfDeviceTableSend#

void emberAfDeviceTableSend (EmberEUI64 eui64, uint8_t endpoint)

Send a message using the device table.

Sends the current framework ZCL command using a device specified by the EUI64 and endpoint.

emberAfDeviceTableCliIndexSendWithEndpoint#

void emberAfDeviceTableCliIndexSendWithEndpoint (uint16_t index, uint8_t endpoint)

Send a CLI command based on an index and an endpoint.

Sends the current framework ZCL command using a device indexed in the device table.

emberAfDeviceTableCommandIndexSend#

void emberAfDeviceTableCommandIndexSend (uint16_t index)

Send an internally-generated command.

Sends an internally-generated command, such as generated by the emberAfFillCommandOnOffClusterOn(); command. Note: this is different from the above send command, which works with the CLI-generated outgoing commands.

emberAfDeviceTableCommandSendWithEndpoint#

void emberAfDeviceTableCommandSendWithEndpoint (EmberEUI64 eui64, uint8_t endpoint)

Send an internally-generated command.

Sends an internally-generated command, such as generated by the emberAfFillCommandOnOffClusterOn(); command. Note: this is different from the above send command, which works with the CLI-generated outgoing commands.

emberAfDeviceTableCommandIndexSendWithEndpoint#

void emberAfDeviceTableCommandIndexSendWithEndpoint (uint16_t index, uint8_t endpoint)

Send an internally-generated command.

Sends an internally-generated command, such as generated by the emberAfFillCommandOnOffClusterOn(); command. Note: this is different from the above send command, which works with the CLI-generated outgoing commands.

emberAfDeviceTableGetEui64FromNodeId#

bool emberAfDeviceTableGetEui64FromNodeId (EmberNodeId emberNodeId, EmberEUI64 eui64)

Compute the EUI64 from the node ID in the device table.

This function looks up the device-table entry using the node ID and return the EUI64.

Returns

• bool True if an EUI can be found, false if not.

emberAfDeviceTableGetNodeIdFromIndex#

uint16_t emberAfDeviceTableGetNodeIdFromIndex (uint16_t index)

Compute the node ID from the device table index.

Looks up the device table entry based on the index and returns the node ID.

Returns

• The node ID of the device.

emberAfDeviceTableGetEndpointFromNodeIdAndEndpoint#

uint16_t emberAfDeviceTableGetEndpointFromNodeIdAndEndpoint (EmberNodeId emberNodeId, uint8_t endpoint)

Find the endpoint index from node ID and endpoint number.

Computes the index into the endpoint table based on the node ID and the endpoint number.

Returns

• The index of the device.

emberAfDeviceTableGetIndexFromNodeId#

uint16_t emberAfDeviceTableGetIndexFromNodeId (EmberNodeId emberNodeId)

Find the index based on the node ID.

Computes the device-table index based on the node ID.

Returns

• The index in the device-table.

emberAfDeviceTableGetFirstIndexFromEui64#

uint16_t emberAfDeviceTableGetFirstIndexFromEui64 (EmberEUI64 eui64)

Find the index based on the EUI64.

Computes the first device table index from the EUI64.

Returns

• The first index that matches the EUI64.

emberAfDeviceTableGetIndexFromEui64AndEndpoint#

uint16_t emberAfDeviceTableGetIndexFromEui64AndEndpoint (EmberEUI64 eui64, uint8_t endpoint)

Find the index based on the EUI64 and endpoint.

Computes the node ID based on the device table entry that matches the EUI64.

Returns

• Index that matches the EUI64

emberAfDeviceTableGetNodeIdFromEui64#

uint16_t emberAfDeviceTableGetNodeIdFromEui64 (EmberEUI64 eui64)

Find the node ID based on the EUI64.

Computes the node ID based on the device table entry that matches the EUI64.

Returns

• The node ID that matches the EUI64.

emberAfPluginDeviceTableMessageSentStatus#

void emberAfPluginDeviceTableMessageSentStatus (EmberNodeId nodeId, EmberStatus status, uint16_t profileId, uint16_t clusterId)

Change the device status based on the last sent message.

If the last sent message was a success, change the device state to "joined". However, if the last message sent was not a success, change the device state to unresponsive.

emberAfPluginDeviceTableSendLeave#

void emberAfPluginDeviceTableSendLeave (uint16_t index)

Send a leave message to a device based on the index.

Sends a leave message to the device indicated by the index.

emberAfPluginDeviceTableMessageReceived#

void emberAfPluginDeviceTableMessageReceived (EmberNodeId nodeId)

Inform the device table that a message was received.

The device table keeps track of whether a device has become unresponsive. Hearing from a known device causes the device table to transition the device state from "unresponsive" to "joined". Hearing from an unknown device causes the device table to discover the device, potentially fixing routing issues (i.e., if the node ID has changed).

emberAfPluginDeviceTableInitiateRouteRepair#

void emberAfPluginDeviceTableInitiateRouteRepair (EmberNodeId nodeId)

Kick off device table route repair.

A message was sent to the device and failed. Therefore, the route repair will be attempted and the node marked as unresponsive. Currently, route repair simply sends a broadcast message looking for the node ID based on the EUI64. It may be replaced with something more sophisticated in the future.

emberAfDeviceTablePointer#

EmberAfPluginDeviceTableEntry* emberAfDeviceTablePointer (void )

Return a pointer to the device table structure.

Returns a pointer to the device table structure.

Returns

• A pointer to the device table structure.

emberAfDeviceTableFindDeviceTableEntry#

EmberAfPluginDeviceTableEntry* emberAfDeviceTableFindDeviceTableEntry (uint16_t index)

Return a pointer to the device table entry.

Returns a pointer to the device table entry based on the device table index.

Returns

• A pointer to the device table entry.

emberAfDeviceTableNewDeviceJoinHandler#

void emberAfDeviceTableNewDeviceJoinHandler (EmberNodeId newNodeId, EmberEUI64 newNodeEui64)

Inform the device table that a new device joined.

Call this function in the device table when a device joins, rejoins, or sends an end-device announce. If the device is new, it will generate a new device table entry and kick off the discovery process. If the device is not new, the device-table will make sure the node ID matches the EUI64 and make an update if necessary. It will also check to verify the discovery process has completed and attempt to complete it.

emberAfDeviceTableTimeSinceLastMessage#

uint32_t emberAfDeviceTableTimeSinceLastMessage (uint16_t index)

Calculate time since the device heard the last message.

Computes the amount of time, in seconds, since receiving a message from the device.

Returns

• The time since the last message (in seconds).

emberAfDeviceTableMatchEui64#

bool emberAfDeviceTableMatchEui64 (EmberEUI64 a, EmberEUI64 b)

Return true if the two EUI64 parameters match.

Determines whether two EUI64 values are the same. The function will print a feedback message to indicate if both EUI64 values are NULL. The function will also print out a feedback message to indicate if the EUI64 values match but in reverse order.

emberAfDeviceTableClear#

void emberAfDeviceTableClear (void )

Clear the device table.

Clears the device table and the backup file of the device table is also cleared if it is a host.

emberAfPluginDeviceTableIndexRemovedCallback#

void emberAfPluginDeviceTableIndexRemovedCallback (uint16_t currentIndex)

Called when a device has been removed from the device table.

Called when the device has been removed from the table.

emberAfPluginDeviceTableInitialized#

void emberAfPluginDeviceTableInitialized (void )

Called when the device table has been initialized.

Called when the device table has been initialized

EmberAfPluginDeviceTableDeviceState#

EmberAfPluginDeviceTableDeviceState

EmberAfPluginDeviceTableDeviceState#

typedef uint8_t EmberAfPluginDeviceTableDeviceState

EMBER_AF_PLUGIN_DEVICE_TABLE_CLUSTER_SIZE#

#define EMBER_AF_PLUGIN_DEVICE_TABLE_CLUSTER_SIZE

20

EMBER_AF_PLUGIN_DEVICE_TABLE_DEVICE_TABLE_SIZE#

#define EMBER_AF_PLUGIN_DEVICE_TABLE_DEVICE_TABLE_SIZE

250

EMBER_AF_PLUGIN_DEVICE_TABLE_NULL_NODE_ID#

#define EMBER_AF_PLUGIN_DEVICE_TABLE_NULL_NODE_ID

0xffff

EMBER_AF_PLUGIN_DEVICE_TABLE_NULL_INDEX#

#define EMBER_AF_PLUGIN_DEVICE_TABLE_NULL_INDEX

0xffff

DEVICE_ID_ON_OFF_SWITCH#

#define DEVICE_ID_ON_OFF_SWITCH

0x0000

DEVICE_ID_LEVEL_CONTROL_SWITCH#

#define DEVICE_ID_LEVEL_CONTROL_SWITCH

0x0001

DEVICE_ID_ON_OFF_OUTPUT#

#define DEVICE_ID_ON_OFF_OUTPUT

0x0002

DEVICE_ID_LEVEL_CONTROL_OUTPUT#

#define DEVICE_ID_LEVEL_CONTROL_OUTPUT

0x0003

DEVICE_ID_SCENE_SELECTOR#

#define DEVICE_ID_SCENE_SELECTOR

0x0004

DEVICE_ID_CONFIG_TOOL#

#define DEVICE_ID_CONFIG_TOOL

0x0005

DEVICE_ID_REMOTE_CONTROL#

#define DEVICE_ID_REMOTE_CONTROL

0x0006

DEVICE_ID_COMBINED_INTERFACE#

#define DEVICE_ID_COMBINED_INTERFACE

0x0007

DEVICE_ID_RANGE_EXTENDER#

#define DEVICE_ID_RANGE_EXTENDER

0x0008

DEVICE_ID_MAINS_POWER_OUTLET#

#define DEVICE_ID_MAINS_POWER_OUTLET

0x0009

DEVICE_ID_DOOR_LOCK#

#define DEVICE_ID_DOOR_LOCK

0x000a

DEVICE_ID_DOOR_LOCK_CONTROLLER#

#define DEVICE_ID_DOOR_LOCK_CONTROLLER

0x000b

DEVICE_ID_SIMPLE_SENSOR#

#define DEVICE_ID_SIMPLE_SENSOR

0x000c

DEVICE_ID_CONSUMPTION_AWARENESS_DEVICE#

#define DEVICE_ID_CONSUMPTION_AWARENESS_DEVICE

0x000d

DEVICE_ID_HOME_GATEWAY#

#define DEVICE_ID_HOME_GATEWAY

0x0050

DEVICE_ID_SMART_PLUG#

#define DEVICE_ID_SMART_PLUG

0x0051

DEVICE_ID_WHITE_GOODS#

#define DEVICE_ID_WHITE_GOODS

0x0052

DEVICE_ID_METER_INTERFACE#

#define DEVICE_ID_METER_INTERFACE

0x0053

DEVICE_ID_ON_OFF_LIGHT#

#define DEVICE_ID_ON_OFF_LIGHT

0x0100

DEVICE_ID_DIMMABLE_LIGHT#

#define DEVICE_ID_DIMMABLE_LIGHT

0x0101

DEVICE_ID_COLOR_DIMMABLE_LIGHT#

#define DEVICE_ID_COLOR_DIMMABLE_LIGHT

0x0102

DEVICE_ID_ON_OFF_LIGHT_SWITCH#

#define DEVICE_ID_ON_OFF_LIGHT_SWITCH

0x0103

DEVICE_ID_DIMMER_SWITCH#

#define DEVICE_ID_DIMMER_SWITCH

0x0104

DEVICE_ID_COLOR_DIMMER_SWITCH#

#define DEVICE_ID_COLOR_DIMMER_SWITCH

0x0105

DEVICE_ID_LIGHT_SENSOR#

#define DEVICE_ID_LIGHT_SENSOR

0x0106

DEVICE_ID_OCCUPANCY_SENSOR#

#define DEVICE_ID_OCCUPANCY_SENSOR

0x0107

DEVICE_ID_SHADE#

#define DEVICE_ID_SHADE

0x0200

DEVICE_ID_SHADE_CONTROLLER#

#define DEVICE_ID_SHADE_CONTROLLER

0x0201

DEVICE_ID_WINDOW_COVERING_DEVICE#

#define DEVICE_ID_WINDOW_COVERING_DEVICE

0x0202

DEVICE_ID_WINDOW_COVERING_CONTROLLER#

#define DEVICE_ID_WINDOW_COVERING_CONTROLLER

0x0203

DEVICE_ID_HEATING_COOLING_UNIT#

#define DEVICE_ID_HEATING_COOLING_UNIT

0x0300

DEVICE_ID_THERMOSTAT#

#define DEVICE_ID_THERMOSTAT

0x0301

DEVICE_ID_TEMPERATURE_SENSOR#

#define DEVICE_ID_TEMPERATURE_SENSOR

0x0302

DEVICE_ID_PUMP#

#define DEVICE_ID_PUMP

0x0303

DEVICE_ID_PUMP_CONTROLLER#

#define DEVICE_ID_PUMP_CONTROLLER

0x0304

DEVICE_ID_PRESSURE_SENSOR#

#define DEVICE_ID_PRESSURE_SENSOR

0x0305

DEVICE_ID_FLOW_SENSOR#

#define DEVICE_ID_FLOW_SENSOR

0x0306

DEVICE_ID_MINI_SPLIT_AC#

#define DEVICE_ID_MINI_SPLIT_AC

0x0307

DEVICE_ID_IAS_CIE#

#define DEVICE_ID_IAS_CIE

0x0400

DEVICE_ID_IAS_ANCILLARY_CONTROL#

#define DEVICE_ID_IAS_ANCILLARY_CONTROL

0x0401

DEVICE_ID_IAS_ZONE#

#define DEVICE_ID_IAS_ZONE

0x0402

DEVICE_ID_IAS_WARNING#

#define DEVICE_ID_IAS_WARNING

0x0403