Gateway ConnectivityConnect Sub-Devices to GatewaysIntegration by Protocol DevelopmentZigbee ConnectivityContact Sensor

Contact Sensor

Last Updated on : 2023-09-07 10:23:12download

Zigbee basics

Parameter	Value
Profile ID	0x0104
Device ID	0x0402

Endpoint

Endpoint	Description
1	The endpoint used by the current contact sensor.

Supported clusters

Input clusters (server)	Output clusters (client)
Basic (0x0000)	OTA Upgrade (0x0019)
Power Configuration (0x0001)	/
IAS Zone (0x0500)	/

Supported attributes and commands

Basic cluster

Attributes

ID	Name	Data type (ID)	Range	Default
0x0000	ZCLVersion	uint8 (0x20)	0x00 to 0xff	0x03
0x0001	ApplicationVersion	uint8 (0x20)	0x00 to 0xff	For example, `0b 01 00 0001` indicates `1.0.1`, that is, `0x41` represents version 1.0.1. This attribute is used for OTA updates. When an OTA update is initiated, the gateway reads the version number of the update and pushes it to the Zigbee device. After the Zigbee device is restarted after the update, the gateway reads the current version to check for the update result. The firmware can only be updated to a higher version.
0x0002	StackVersion	uint8 (0x20)	0x00 to 0xff	0x02
0x0003	HWVersion	uint8 (0x20)	0x00 to 0xff	0x01
0x0004	ManufacturerName	string (0x42)	0 to 32 bytes	The value of this attribute is 16 bytes in length, consisting of 8-byte prefix and 8-byte PID. 0 to 7 bytes: `_TZ3000_`. 8 to 16 bytes: The PID, the unique identifier of the Zigbee product you create on the Tuya IoT Development Platform. This field determines the UI experience and functions of the app. If no specific PID is required, the default one can be used.
0x0005	ModelIdentifier	string (0x42)	0 to 32 bytes	TY0203
0x0007	PowerSource	enum8 (0x30)	0x00 to 0xff	0x03
0xFFFD	ClusterRevision	uint16 (0x21)	0x0000 to 0xffff	0x0001

Power Configuration

Attributes

ID	Name	Data type (ID)	Range	Default
0x0000	MainsVoltage	uint16 (0x21)	0x0000 to 0xffff	0x03
0x0020	BatteryVoltage	uint8 (0x20)	24 to 30 (2.4V to 3.0V)	30
0x0021	BatteryPercentageRemaining	uint8 (0x20)	0 to 200 (0 to 100%)	200
0xfffd	ClusterRevision	uint16 (0x21)	0x0000 to 0xffff	0x0001

IAS Zone

Attributes

ID	Name	Data type (ID)	Range	Default
0x0000	Zone State	enum8 (0x30)	0x00 to 0xff	0x00
0x0001	Zone Type	enum16 (0x31)	0x0000 to 0xffff	0x0015
0x0002	Zone Status	bitmap16 (0x19)	0x0000 to 0xffff	0x0000
0x0010	IAS CIE Address	EUI64 (0xF0)	8 bytes	NULL
0x0011	Zone ID	uint8 (0x20)	0x00 to 0xff	0x0000
0xFFFD	ClusterRevision	uint16 (0x21)	0x0000 to 0xffff	0x0001

Commands

ID	Name	Direction	Description
0x00	Zone Status Change Notification	Server to client	The Zigbee device reports alarms to the gateway.
0x01	Zone Enroll Request	Server to client	The Zigbee device requests the Zone ID from the gateway.
0x00	Zone Enroll Response	Client to server	The gateway returns the Zone ID to the Zigbee device.

Over The Air Upgrade

Attributes

ID	Name	Data type (ID)	Range	Default
0x0000	UpgradeServerID	EUI64 (0xF0)	/	0xffffffffffffffff
0x0001	FileOffset	uint32 (0x23)	/	0x00000000
0x0002	CurrentFileVersion	uint32 (0x23)	/	0x00000040
0x0006	ImageUpgradeStatus	enum8 (0x30)	/	0x00
0x0007	Manufacturer ID	uint16 (0x21)	/	0x1002
0x0008	Image Type ID	uint16 (0x21)	/	0x1602
0x0009	MinimumBlockPeriod	uint16 (0x21)	/	0x0000
0xfffd	ClusterRevision	uint16 (0x21)	0x0000 to 0xffff	0x0001

Commands

ID	Name	Direction
0x00	Image Notify	Server to client
0x01	Query Next Image Request	Client to server
0x02	Query Next Image Response	Server to client
0x03	Image Block Request	Client to server
0x05	Image Block Response	Server to client
0x06	Upgrade End Request	Client to server
0x07	Upgrade End Response	Server to client

Mapping between DPs and clusters

DPID	DP description	Standard command
1	Contact sensor	Yes
2	Battery level	Yes
4	Tamper alarm	Yes

DP1 Contact sensor

Direction	Cluster ID	Attribute ID	Value
Server to client	0x0500	0x0002 (ZoneStatus)	Bit0 (alarm1). `0`: no alarm `1`: alarm

The sensor reports 1 when the door is opened and reports 0 when the door is closed.

DP2 Battery level

Direction	Cluster ID	Attribute ID	Value
Server to client	0x0001	0x0020 (BatteryVoltage)	0x00 to 0xff
Server to client	0x0001	0x0021 (BatteryPercentageRemaining)	0x00 to 0xff

If the reported value of BatteryVoltage is 30, it indicates 3.0V voltage. If the reported value of BatteryPercentageRemaining is 180, it indicates a battery level of 90%.

DP4 Tamper alarm

Direction	Cluster ID	Attribute ID	Value
Server to client	0x0500	0x0002 (ZoneStatus)	Bit2 (tamper). `0`: no alarm `1`: alarm

The sensor reports the alarm status when the sensor detects tampering and reports no alarm when the alarm is canceled.

Default heartbeat (4 hours, report battery level)

For more information, see DP4 Battery level.

Prev DocLuminance Sensor

Next DocVibration Sensor