IAS Zone Server#
API and Callbacks for the IAS Zone Server Component.
An IAS Server implementation that reports notifications to the client that has configured it. This requires extending to trigger alarms. The component must store the client IEEE address attribute to flash. This means, for the IAS CIE address attribute (0x0010) of the IAS Zone cluster (0x500), the user must select the check box that stores that attribute to flash.
Modules#
API#
Update the zone status for an endpoint.
Get the CIE assigned zone ID of a given endpoint.
Determine the enrollment status of a given endpoint.
Set the enrollment status.
Configure the retry parameters of the status queue.
Set the retry parameters of the status queue to default.
Discard any pending events in the status queue and sets it inactive.
Print information on the status queue.
Print the status queue config.
Enumerations#
API Documentation#
emberAfPluginIasZoneServerUpdateZoneStatus#
EmberStatus emberAfPluginIasZoneServerUpdateZoneStatus (uint8_t endpoint, uint16_t newStatus, uint16_t timeSinceStatusOccurredQs)
Update the zone status for an endpoint.
| N/A | endpoint | The endpoint whose zone status attribute is to be updated. |
| N/A | newStatus | The new status to write to the attribute. |
| N/A | timeSinceStatusOccurredQs | The amount of time (in quarter seconds) that has passed since the status change occurred. |
This function updates the zone status attribute of the specified endpoint using the specified new zone status. Then, it notifies the CIE of the updated status.
Returns
EMBER_SUCCESS if the attribute update and notify succeeded, error code otherwise.
84 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfPluginIasZoneServerGetZoneId#
uint8_t emberAfPluginIasZoneServerGetZoneId (uint8_t endpoint)
Get the CIE assigned zone ID of a given endpoint.
| N/A | endpoint | The endpoint whose ID is to be queried. |
This function returns the zone ID that was assigned to the given endpoint by the CIE at time of enrollment.
Returns
The zone ID assigned by the CIE at time of enrollment.
98 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfIasZoneClusterAmIEnrolled#
bool emberAfIasZoneClusterAmIEnrolled (uint8_t endpoint)
Determine the enrollment status of a given endpoint.
| N/A | endpoint | The endpoint whose enrollment status is to be queried. |
This function returns true or false depending on whether the specified endpoint has undergone IAS Zone Enrollment.
Returns
True if enrolled, false otherwise.
109 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfPluginIasZoneClusterSetEnrollmentMethod#
EmberAfStatus emberAfPluginIasZoneClusterSetEnrollmentMethod (uint8_t endpoint, EmberAfIasZoneEnrollmentMode method)
Set the enrollment status.
| N/A | endpoint | The endpoint whose enrollment method is to be set |
| N/A | method | The enrollment method that should be set |
This function returns the status of the set enrollment method attempt.
Returns
An EmberAfStatus value indicating the status of the set action.
120 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfIasZoneServerConfigStatusQueueRetryParams#
EmberStatus emberAfIasZoneServerConfigStatusQueueRetryParams (IasZoneStatusQueueRetryConfig * retryConfig)
Configure the retry parameters of the status queue.
| N/A | retryConfig | Status queue retry configuration. |
This function configures the status queue retry parameters.
129 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfIasZoneServerSetStatusQueueRetryParamsToDefault#
void emberAfIasZoneServerSetStatusQueueRetryParamsToDefault (void )
Set the retry parameters of the status queue to default.
| N/A |
This function sets the status queue retry parameters to their default values.
135 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfIasZoneServerDiscardPendingEventsInStatusQueue#
void emberAfIasZoneServerDiscardPendingEventsInStatusQueue (void )
Discard any pending events in the status queue and sets it inactive.
| N/A |
This function discards any pending event pending in the status queue. Also, the status queue event control manager will be inactivated.
142 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfPluginIasZoneServerPrintQueue#
void emberAfPluginIasZoneServerPrintQueue (void )
Print information on the status queue.
| N/A |
146 of file app/framework/plugin/ias-zone-server/ias-zone-server.hemberAfPluginIasZoneServerPrintQueueConfig#
void emberAfPluginIasZoneServerPrintQueueConfig (void )
Print the status queue config.
| N/A |
150 of file app/framework/plugin/ias-zone-server/ias-zone-server.hEnumeration Documentation#
EmberAfIasZoneEnrollmentMode#
EmberAfIasZoneEnrollmentMode
| Enumerator | |
|---|---|
| EMBER_ZCL_IAS_ZONE_ENROLLMENT_MODE_TRIP_TO_PAIR | |
| EMBER_ZCL_IAS_ZONE_ENROLLMENT_MODE_AUTO_ENROLLMENT_RESPONSE | |
| EMBER_ZCL_IAS_ZONE_ENROLLMENT_MODE_REQUEST | |
50 of file app/framework/plugin/ias-zone-server/ias-zone-server.hMacro Definition Documentation#
EM_AF_UNKNOWN_ENDPOINT#
#define EM_AF_UNKNOWN_ENDPOINTValue:
0
44 of file app/framework/plugin/ias-zone-server/ias-zone-server.hIAS_ZONE_STATUS_QUEUE_RETRY_ABS_MAX_BACKOFF_TIME_SEC#
#define IAS_ZONE_STATUS_QUEUE_RETRY_ABS_MAX_BACKOFF_TIME_SECValue:
(24 * 60 * 60)
47 of file app/framework/plugin/ias-zone-server/ias-zone-server.h