IAS zone Cluster

---

Zigbee IAS zone cluster commands.

Required Header

#include <zigbee.h>

Overview

The IAS Zone cluster defines an interface to the functionality of an IAS security zone device. IAS Zone supports up to two alarm types per zone, low battery reports and supervision of the IAS network.

Functions
int	zb_zcl_zone_enroll_response (zb_zigbee_h handle, zb_nwk_addr addr16, zb_end_point ep, unsigned char enroll_response_code, unsigned char zone_id)
	Sends 'zone enroll response' command.

---

Enumeration Type Documentation

enum zb_ias_zone_enroll_response_e

Values of the Enroll Response Code in Zigbee Cluster Library.

Since :

5.0

Enumerator:

ZB_ZCL_IAS_ZONE_ENROLL_SUCCESS	Success
ZB_ZCL_IAS_ZONE_ENROLL_NOT_SUPPORTED	This specific Zone type is not known to the CIE and is not supported
ZB_ZCL_IAS_ZONE_ENROLL_NO_ENROLL_PERMITTED	CIE does not permit new zones to enroll at this time.
ZB_ZCL_IAS_ZONE_ENROLL_TOO_MANY_ZONES	CIE reached its limit of number of enrolled zones

enum zb_zcl_ias_zone_type_e

Values of the Zone type attribute.

Since :

5.0

Enumerator:

ZB_ZCL_IAS_ZONE_TYPE_STANDARD_CIE	Zone type = Standard CIE, Alarm1 = System Alarm, Alarm2 = N/A
ZB_ZCL_IAS_ZONE_TYPE_MOTION_SENSOR	Zone type = Motion sensor, Alarm1 = Intrusion indication, Alarm2 = Presence indication
ZB_ZCL_IAS_ZONE_TYPE_CONTACT_SWITCH	Zone type = Contact switch, Alarm1 = 1st portal Open-Close, Alarm2 = 2nd portal Open-Close
ZB_ZCL_IAS_ZONE_TYPE_FIRE_SENSOR	Zone type = Fire sensor, Alarm1 = Fire indication, Alarm2 : N/A
ZB_ZCL_IAS_ZONE_TYPE_WATER_SENSOR	Zone type = Water sensor, Alarm1 = Water overflow indication, Alarm2 = N/A
ZB_ZCL_IAS_ZONE_TYPE_GAS_SENSOR	Zone type : Gas sensor, Alarm1 = CO indication, Alarm2 = Cooking indication
ZB_ZCL_IAS_ZONE_TYPE_PERSONAL_EMERGENCY_SENSOR	Zone type = Personal emergency Sensor, Alarm1 = Fall / Concussion, Alarm2 = Emergency button
ZB_ZCL_IAS_ZONE_TYPE_MOVEMENT_SENSOR	Zone type = Vibration or Movement sensor, Alarm1 = Movement indication, Alarm2 = Vibration
ZB_ZCL_IAS_ZONE_TYPE_REMOTE_CONTROL	Zone type = Remote control, Alarm1 = Panic, Alarm2 = Emergency
ZB_ZCL_IAS_ZONE_TYPE_KEY_FOB	Zone type : Key fob, Alarm1 = Panic, Alarm2 = Emergency
ZB_ZCL_IAS_ZONE_TYPE_KEYPAD	Zone type : Keypad, Alarm1 = Panic, Alarm2 = Emergency
ZB_ZCL_IAS_ZONE_TYPE_STANDARD_WARNING_DEVICE	Zone type = Standard Warning Device (e.g., Intruder Alarm Systems), Alarm1 = N/A, Alarm2 = N/A
ZB_ZCL_IAS_ZONE_TYPE_INVALID	Zone type : Invalid zone type, Alarm1 = N/A, Alarm2 = N/A

---

Function Documentation

int zb_zcl_zone_enroll_response	(	zb_zigbee_h	handle,
		zb_nwk_addr	addr16,
		zb_end_point	ep,
		unsigned char	enroll_response_code,
		unsigned char	zone_id
	)

Sends 'zone enroll response' command.

On receipt, the device embodying the Zone server is notified that it is now enrolled as an active alarm device.

The device embodying the Zone server must authenticate received messages by checking the address of their sender against IAS_CIE_Address. This is to ensure that only messages from the correct CIE are accepted.

Since :

5.0

Privilege Level:

public

Privilege:

http://tizen.org/privilege/zigbee

Parameters:

[in]	handle	The handle of zigbee
[in]	addr16	Network address
[in]	ep	Endpoint ID
[in]	enroll_response_code	ZB_ZCL_IAS_ZONE_ENROLL_SUCCESS ZB_ZCL_IAS_ZONE_ENROLL_NOT_SUPPORTED ZB_ZCL_IAS_ZONE_ENROLL_NO_ENROLL_PERMITTED ZB_ZCL_IAS_ZONE_ENROLL_TOO_MANY_ZONES
[in]	zone_id	The Zone ID field is the index into the zone table of the CIE. This field is only relevant if the response code is success.

Returns:

0 on success, otherwise a negative error value.

Return values:

ZIGBEE_ERROR_NONE	Successful
ZIGBEE_ERROR_INVALID_PARAMETER	Invalid parameter
ZIGBEE_ERROR_INVALID_ENDPOINT	Invalid endpoint. 0 is reserved for ZDP
ZIGBEE_ERROR_INVALID_ADDRESS	Invalid address
ZIGBEE_ERROR_IO_ERROR	Unexpected d-bus error
ZIGBEE_ERROR_PERMISSION_DENIED	Permission denied
ZIGBEE_ERROR_NOT_SUPPORTED	Not supported