Modules#
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.
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#
Macros#
API Documentation#
emberAfPluginIasZoneServerUpdateZoneStatus#
EmberStatus emberAfPluginIasZoneServerUpdateZoneStatus (uint8_t endpoint, uint16_t newStatus, uint16_t timeSinceStatusOccurredQs)
Update the zone status for an endpoint.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint whose zone status attribute is to be updated. |
| uint16_t | N/A | newStatus | The new status to write to the attribute. |
| uint16_t | 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.
emberAfPluginIasZoneServerGetZoneId#
uint8_t emberAfPluginIasZoneServerGetZoneId (uint8_t endpoint)
Get the CIE assigned zone ID of a given endpoint.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | 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.
emberAfIasZoneClusterAmIEnrolled#
bool emberAfIasZoneClusterAmIEnrolled (uint8_t endpoint)
Determine the enrollment status of a given endpoint.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | 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.
emberAfPluginIasZoneClusterSetEnrollmentMethod#
EmberAfStatus emberAfPluginIasZoneClusterSetEnrollmentMethod (uint8_t endpoint, EmberAfIasZoneEnrollmentMode method)
Set the enrollment status.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint whose enrollment method is to be set |
| EmberAfIasZoneEnrollmentMode | 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.
emberAfIasZoneServerConfigStatusQueueRetryParams#
EmberStatus emberAfIasZoneServerConfigStatusQueueRetryParams (IasZoneStatusQueueRetryConfig * retryConfig)
Configure the retry parameters of the status queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| IasZoneStatusQueueRetryConfig * | N/A | retryConfig | Status queue retry configuration. |
This function configures the status queue retry parameters.
emberAfIasZoneServerSetStatusQueueRetryParamsToDefault#
void emberAfIasZoneServerSetStatusQueueRetryParamsToDefault (void )
Set the retry parameters of the status queue to default.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
This function sets the status queue retry parameters to their default values.
emberAfIasZoneServerDiscardPendingEventsInStatusQueue#
void emberAfIasZoneServerDiscardPendingEventsInStatusQueue (void )
Discard any pending events in the status queue and sets it inactive.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
This function discards any pending event pending in the status queue. Also, the status queue event control manager will be inactivated.
emberAfPluginIasZoneServerPrintQueue#
void emberAfPluginIasZoneServerPrintQueue (void )
Print information on the status queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberAfPluginIasZoneServerPrintQueueConfig#
void emberAfPluginIasZoneServerPrintQueueConfig (void )
Print the status queue config.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Enumeration 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 | |