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#

IasZoneStatusQueueRetryConfig

API#

EmberStatus
emberAfPluginIasZoneServerUpdateZoneStatus(uint8_t endpoint, uint16_t newStatus, uint16_t timeSinceStatusOccurredQs)

Update the zone status for an endpoint.

uint8_t

Get the CIE assigned zone ID of a given endpoint.

bool

Determine the enrollment status of a given endpoint.

emberAfPluginIasZoneClusterSetEnrollmentMethod(uint8_t endpoint, EmberAfIasZoneEnrollmentMode method)

Set the enrollment status.

EmberStatus
emberAfIasZoneServerConfigStatusQueueRetryParams(IasZoneStatusQueueRetryConfig *retryConfig)

Configure the retry parameters of the status queue.

void

Set the retry parameters of the status queue to default.

void

Discard any pending events in the status queue and sets it inactive.

void

Print information on the status queue.

void

Print the status queue config.

Enumerations#

enum
EMBER_ZCL_IAS_ZONE_ENROLLMENT_MODE_TRIP_TO_PAIR = 0x00
EMBER_ZCL_IAS_ZONE_ENROLLMENT_MODE_AUTO_ENROLLMENT_RESPONSE = 0x01
EMBER_ZCL_IAS_ZONE_ENROLLMENT_MODE_REQUEST = 0x02
}

API Documentation#

emberAfPluginIasZoneServerUpdateZoneStatus#

EmberStatus emberAfPluginIasZoneServerUpdateZoneStatus (uint8_t endpoint, uint16_t newStatus, uint16_t timeSinceStatusOccurredQs)

Update the zone status for an endpoint.

Parameters
N/Aendpoint

The endpoint whose zone status attribute is to be updated.

N/AnewStatus

The new status to write to the attribute.

N/AtimeSinceStatusOccurredQs

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.


Definition at line 84 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfPluginIasZoneServerGetZoneId#

uint8_t emberAfPluginIasZoneServerGetZoneId (uint8_t endpoint)

Get the CIE assigned zone ID of a given endpoint.

Parameters
N/Aendpoint

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.


Definition at line 98 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfIasZoneClusterAmIEnrolled#

bool emberAfIasZoneClusterAmIEnrolled (uint8_t endpoint)

Determine the enrollment status of a given endpoint.

Parameters
N/Aendpoint

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.


Definition at line 109 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfPluginIasZoneClusterSetEnrollmentMethod#

EmberAfStatus emberAfPluginIasZoneClusterSetEnrollmentMethod (uint8_t endpoint, EmberAfIasZoneEnrollmentMode method)

Set the enrollment status.

Parameters
N/Aendpoint

The endpoint whose enrollment method is to be set

N/Amethod

The enrollment method that should be set

This function returns the status of the set enrollment method attempt.

Returns


Definition at line 120 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfIasZoneServerConfigStatusQueueRetryParams#

EmberStatus emberAfIasZoneServerConfigStatusQueueRetryParams (IasZoneStatusQueueRetryConfig * retryConfig)

Configure the retry parameters of the status queue.

Parameters
N/AretryConfig

Status queue retry configuration.

This function configures the status queue retry parameters.


Definition at line 129 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfIasZoneServerSetStatusQueueRetryParamsToDefault#

void emberAfIasZoneServerSetStatusQueueRetryParamsToDefault (void )

Set the retry parameters of the status queue to default.

Parameters
N/A

This function sets the status queue retry parameters to their default values.


Definition at line 135 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfIasZoneServerDiscardPendingEventsInStatusQueue#

void emberAfIasZoneServerDiscardPendingEventsInStatusQueue (void )

Discard any pending events in the status queue and sets it inactive.

Parameters
N/A

This function discards any pending event pending in the status queue. Also, the status queue event control manager will be inactivated.


Definition at line 142 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfPluginIasZoneServerPrintQueue#

void emberAfPluginIasZoneServerPrintQueue (void )

Print information on the status queue.

Parameters
N/A

Definition at line 146 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

emberAfPluginIasZoneServerPrintQueueConfig#

void emberAfPluginIasZoneServerPrintQueueConfig (void )

Print the status queue config.

Parameters
N/A

Definition at line 150 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

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

Definition at line 50 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

Macro Definition Documentation#

EM_AF_UNKNOWN_ENDPOINT#

#define EM_AF_UNKNOWN_ENDPOINT
Value:
0

Definition at line 44 of file app/framework/plugin/ias-zone-server/ias-zone-server.h

IAS_ZONE_STATUS_QUEUE_RETRY_ABS_MAX_BACKOFF_TIME_SEC#

#define IAS_ZONE_STATUS_QUEUE_RETRY_ABS_MAX_BACKOFF_TIME_SEC
Value:
(24 * 60 * 60)

Definition at line 47 of file app/framework/plugin/ias-zone-server/ias-zone-server.h