ESI Management#

emberAfPluginEsiManagementEsiLookUpByShortIdAndEndpoint#

EmberAfPluginEsiManagementEsiEntry* emberAfPluginEsiManagementEsiLookUpByShortIdAndEndpoint (EmberNodeId shortId, uint8_t endpoint)

Search in the ESI table by the pair node (short ID, endopoint).

Returns a pointer to the entry if a matching entry was found. Otherwise, it returns NULL.

emberAfPluginEsiManagementEsiLookUpByLongIdAndEndpoint#

EmberAfPluginEsiManagementEsiEntry* emberAfPluginEsiManagementEsiLookUpByLongIdAndEndpoint (EmberEUI64 longId, uint8_t endpoint)

Search in the ESI table by the pair node (long ID, endopoint).

Returns a pointer to the entry if a matching entry was found. Otherwise, it returns NULL.

emberAfPluginEsiManagementIndexLookUpByShortIdAndEndpoint#

uint8_t emberAfPluginEsiManagementIndexLookUpByShortIdAndEndpoint (EmberNodeId shortId, uint8_t endpoint)

Allow retrieving the index of an entry that matches the passed short ID and endpoint.

Returns the index of the matching entry if a matching entry was found. Otherwise, it returns 0xFF.

emberAfPluginEsiManagementIndexLookUpByLongIdAndEndpoint#

uint8_t emberAfPluginEsiManagementIndexLookUpByLongIdAndEndpoint (EmberEUI64 longId, uint8_t endpoint)

Allow retrieving the index of an entry that matches the passed long ID and endpoint.

Returns the index of the matching entry if a matching entry was found. Otherwise, it returns 0xFF.

emberAfPluginEsiManagementEsiLookUpByIndex#

EmberAfPluginEsiManagementEsiEntry* emberAfPluginEsiManagementEsiLookUpByIndex (uint8_t index)

Search in the ESI table by the table index.

Returns a pointer to the ESI entry stored at the index passed as parameter.

emberAfPluginEsiManagementGetNextEntry#

EmberAfPluginEsiManagementEsiEntry* emberAfPluginEsiManagementGetNextEntry (EmberAfPluginEsiManagementEsiEntry * entry, uint8_t age)

Iterate through the entries in the table that are within a certain age threshold.

If the passed pointer is NULL, it returns the first active entry with age lesser or equal than the passed age parameter (if any). Otherwise, it returns the next active entry that satisfy the age requirement. If the are no entries after the passed entry that satisfy the age requirement, it returns NULL.

emberAfPluginEsiManagementGetFreeEntry#

EmberAfPluginEsiManagementEsiEntry* emberAfPluginEsiManagementGetFreeEntry (void )

Allow obtaining a free entry in the ESI table. It is the requester responsibility to properly set all the fields in the obtained free entry such as nodeId, age, and so on to avoid inconsistencies in the table.

Returns a free entry (if any), otherwise it clears the oldest entry whose age is at least EMBER_AF_PLUGIN_ESI_MANAGEMENT_MIN_ERASING_AGE (if any) and returns it, otherwise it returns NULL.

emberAfPluginEsiManagementDeleteEntry#

void emberAfPluginEsiManagementDeleteEntry (uint8_t index)

Delete the entry indicated by the parameter 'index' from the ESI table.

emberAfPluginEsiManagementAgeAllEntries#

void emberAfPluginEsiManagementAgeAllEntries (void )

Increase the age of all the active entries in the table. A non-active entry is an entry whose short ID is set to EMBER_NULL_NODE_ID.

emberAfPluginEsiManagementClearTable#

void emberAfPluginEsiManagementClearTable (void )

Clear the ESI table, i.e., set the short ID of each entry to EMBER_NULL_NODE_ID.

emberAfPluginEsiManagementSubscribeToDeletionAnnouncements#

bool emberAfPluginEsiManagementSubscribeToDeletionAnnouncements (EmberAfEsiManagementDeletionCallback callback)

Allow a plugin to subscribe to ESI entries deletion announcements by passing its own deletion callback function. Upon an entry deletion, all the deletion callback function are called passing the index of the deleted entry.

It returns true if the subscription was successful, false otherwise.

emberAfPluginEsiManagementUpdateEsiAndGetIndex#

uint8_t emberAfPluginEsiManagementUpdateEsiAndGetIndex (const EmberAfClusterCommand * cmd)

Perform the following steps:

• Search for the source node of the passed command in the ESI table.

• Add a new entry in the ESI table if the source node is not present in the ESI table yet, or update the current entry if needed.

Returns

• The index of the source node of the passed command in the ESI table, or it returns 0xFF if the ESI was not present in the table and a new entry could not be added since the table was full.

EmberAfEsiManagementDeletionCallback#

typedef void(* EmberAfEsiManagementDeletionCallback) (uint8_t) )(uint8_t)