Zigbee Connection Standard for Siren Alarm

A Zigbee siren alarm is an alarm device with an uninterruptible power supply (UPS), used to indicate alarm status.

Use the IAS Warning Device in the Zigbee 3.0 standard to achieve this feature.

Terms and definitions

Term	Description
Zigbee SDK	The Zigbee SDK is developed based on the Silicon Labs Zigbee 3.0 protocol stack and tailored, optimized, and encapsulated to create a Tuya Zigbee module SDK.
Attribute	A data value that reflects the physical quantity or status.
Cluster	Each cluster contains one or more attributes.
Endpoint	The entry point for the application layer of the protocol stack. Each endpoint can be regarded as the location where the application object exists. It is defined as a cluster that is used to implement a device description.
Device ID	The serial number that is defined for each Zigbee device.
ELV (extra-low voltage) device	A battery-powered device, which is called a sleep end device in the Zigbee protocol.
Electrical device	A device powered by mains electricity or stabilized voltage supply from mains electricity, which is called a router device in the Zigbee protocol
Product ID (PID)	It represents product ID. Each product created in the Tuya Developer Platform will generate a unique product identifier. This ID is associated with specific data points of the product, app control panel, shipping information, and other information related to the product
SoC	System On Chip (SoC). The hardware does not have an MCU, and the control program is written into the cloud module.
SDK	A software development kit (SDK) contains the documents, examples, and tools required to develop software. In order to encourage developers to use their system or language, many SDKs are provided for free, such as Tuya.
Firmware	The programs that are written to the erasable programmable read-only memory (EROM) or electrically erasable programmable read-only memory (EEPROM). Firmware is used to drive programs that are embedded in devices, such as CD-ROM and CD-R. The firmware enables operating systems to drive devices based on standard device drivers. Firmware is the software that completes the most basic bottom-layer tasks of a system.
OTA	It means firmware update over the air. Tuya supports OTA.

Functional description of Zigbee devices

Zigbee protocol version

The product is developed based on the Zigbee 3.0 standard protocol.

Zigbee feature ID	Value
Profile ID	0x0104
Device ID	0x0403

Endpoint

Endpoint	Description
1	Siren alarm

Supported clusters

Input cluster (server)	Output cluster (client)
Basic (0x0000)	OTA (0x0019)
Power configuration (0x0001)	-
Identify (0x0003)	-
IAS zone (0x0500)	-
IAS zone (0x0502)	-

Supported clusters

Each gateway can read and write specific attributes of Zigbee devices to get the device information.

Basic cluster

Attributes

ID	name	Data type	Range	Default value
0x0000	ZCLVersion	uint8 -0x20	0x00-0xff	0x03
0x0001	ApplicationVersion	uint8 -0x20	0x00-0xff	For example, 0b 01 00 0001 = 1.0.1, where 0x41 is 1.0.1. The OTA function uses this version number. At the beginning of OTA, the gateway reads the version number of the OTA package and pushes it to the device. Once the device is restarted after OTA updates, the gateway reads the version number to check whether the update is successful. Only updates to a higher version are supported.
0x0002	StackVersion	uint8-0x20	0x00-0xff	0x02
0x0003	HWVersion	uint8-0x20	0x00-0xff	0x01
0x0004	ManufactureName	string-0x42	0-32 bytes	XXX…XXX (16 bytes in length, including an 8-byte prefix and an 8-byte PID). No. 0-7 bytes: TYZB01 and No. 8-16 bytes: PID (created on the Tuya Developer Platform). Default PID: ujpnvzum. This field determines the UI experience and functions of the app. If no specific PID is required, the default one can be used.
0x0005	ModeIdentifier	string -0x42	0-32 bytes	TS0216. This field is used by the gateway to quickly identify the device type and improve the experience.
0x0007	PowerSource	enum8-0x30	0x00-0xff	0x03
0xFFFD	Cluster revision	uint16 -0x21	0x0000-0xffff	0x0001

Commands:

ID	name	Direction	Description
0x00	Reset to factory defaults	C->S

Power configuration cluster

Attributes

ID	name	Data type	Range	Default value
0x0000	Mains voltage	uint16-0x21	0x0000-0xffff	0x0000
0x0020	Battery voltage	Int8-0x20	0x00-0xff	0x00
0x0021	Remaining battery capacity	Int8-0x20	0x00-0xff	0x00
0xFFFD	Cluster revision	uint16-0x21	0x0000-0xffff	0x0001

Commands:

NA

Identify cluster

Attributes (server):

ID	Name	Data type	Range	Default value
0x0000	Identify time	uint16-0x21	0x0000-0xffff	0x0000
0xFFFD	Cluster revision	uint16-0x21	0x0000-0xffff	0x0001

Attributes (client):

ID	Name	Data type	Range	Default value
0xFFFD	Cluster revision	uint16-0x21	0x0000-0xffff	0x0001

IAS zone cluster

Attributes

ID	name	Data type	Range	Default value
0x0000	Zone enroll state	enum8-0x21	0x00-0xff	0x00
0x0001	Zone type	uint16-0x21	0x0000-0xffff	0x0225
0x0002	Zone status	bitmap16-0x19	0x0000-0xffff	0x0000
0x0010	IAS CIE address	ieee address-0xF0	8 bytes	Null
0x0011	Zone ID	Int8-0x20	0x00-0xff	0x0000
0xFFFD	Cluster revision	uint16-0x21	0x0000-0xffff	0x0001

Commands:

NA

IAS WD cluster

Attributes

ID	name	Data type	Range	Default value
0x0000	Max duration	uint16-0x21	x0000-0xffff	0–3600s, local save
0x0001	Alarm light	int8 -0x20	0x00-0xff	Brightness value. 0: off. 30: low light. 60: medium light. 100: high light.
0x0002	Alarm radio	int8 -0x20	0x00-0xff	0–50%, local save
0x0003	Disalarm	bool -0x10	true/false	Storage arming and disarming status is currently not enabled. Disable this item.
0xF000	Private attribute: a custom private attribute used to display prompts on the app.	int8 -0x20	true/false	0: Disarm the alarm. 1: Sound alarm. 2: Light alarm. 3: Sound and light alarm.

Things to note:

1. The alarm currently only recognizes the Waring Mode field of the gateway’s Start Waring.
   For example, an alarm is sent in case of fire, and the actions will be performed according to local storage parameters.

2. After receiving the alarm and stop alarm commands, the alarm will send the zone status change notification command. The lowest bit Alarm0 bit is 0 or 1, and then reports the zone status attribute.

Commands:

NA

OTA update cluster

Attributes

ID	name	Data type	Range	Default value
0x0000	UpgradeServerID	EUI64-0xF0	—	0xffffffffffffffff
0x0001	FileOffset	uint32-0x23	—	0x00000000
0x0002	CurrentFileVersion	uint32-0x23	—	0x21050002
0x0006	ImageUpgradeStatus	enum8-0x30	—	0x00
0x0007	Manufacturer ID	uint16-0x21	—	0x1168
0x0008	Image type ID	uint16-0x21	—	0x80f6
0x0009	Minimum block request period	uint16-0x21	—	0x0000
0xfffd	Cluster revision	uint16-0x21	0x0000-0xffff	0x0001

Commands:

ID	name	Direction	Description
0x00	Image notification	S->C	-
0x01	Query the next image request	C->S	-
0x03	Image block request	C->S	-
0x06	Update end request	C->S	-

Zigbee device management requirements

Networking

Beacon request channels are scanned at an interval of greater than 200 ms. Important channels are to be scanned in priority.

The timeout value for each scanning task is five minutes.

If data reporting is required after Zigbee devices are networked, data is reported at a random interval of 5s, 10s, or more seconds.

Device restart after power off

The device starts to report data more than 15 seconds after it is powered off and on again.

Link maintenance

The device voltage and battery level are reported every four hours.

When any data is successfully reported, the device voltage and battery level are reported after a delay of 4 hours.

Data reporting

If data retransmission is enabled for the application support sublayer (APS), we recommend that you set Disable Default Response to 1 to avoid excessive acknowledgments (ACKs).

The Transaction Sequence Number attribute cannot be modified during data transmission.

The retransmission interval must be greater than 250 ms. We recommend that you set the retransmission duration to less than three seconds.

To process broadcast, multicast, and scene DPs, we recommend that you set the latency of data reporting to a random value from one minute to two minutes. If a unicast DP is received during the latency, the status data is immediately reported.

Development method

1. Developed based on Tuya Zigbee SDK:

   • You only need to modify the module model and hardware configuration of the demo sample to complete the above functions, including groups and scenes.
   • Tuya provides complete flashing, authorization, production testing process, software and hardware tools
     • Zigbee Chip SDK
     • Production Test Tools

2. Self-developed with non-Tuya Zigbee module:

   • Need to fully implement the above technical details
   • Complete device authorization

3. Authorize by using Tuya’s complete authorization tool

   • Through the module and the host computer serial communication authorization: See Production Test of Zigbee SDK.

   • Serial communication sample code: See Authorize by Using Tuya Authorization SDK.

4. Self-developed with Tuya Zigbee module:

   • Only need to implement firmware function details.
   • Purchase the authorized Tuya Zigbee module.