Z-Wave Entity Naming

This is a work in progress, based upon reports in the forum, the author’s own devices and reading of various documentation. It will be incomplete, so if you have a device that isn’t reported here or have a device that reports a different value, please provide a report in the Z-Wave section of the forum or the #zwave channel on Discord.

Binary Sensor

Devices that support the Binary Sensor command class will create one (or more) entities starting with binary_sensor. For example, if the node is door_sensor then the binary sensor entity will be binary_sensor.door_sensor.

These will normally be on when the sensor is active, otherwise they will be off. Some devices use on for closed, and some use on for open, and some devices allow you to change how they report.

Alarm

This is for a single purpose sensor, multi sensors are explained under Multi Sensor.

Devices (usually sensors) that support the Alarm command class will create entities starting with sensor, and with some generic suffixes, and a suffix that relates to the supported alarm class. For example, the smoke detector lounge will have an entity sensor.lounge_smoke, and possibly also sensor.lounge_alarm_type and sensor.lounge_alarm_level. If the device creates a binary_sensor entity, it is recommended to use that rather then the sensor entity.

Alarm Type Entity

alarm_type: Reports the type of the sensor

0: General purpose

1: Smoke sensor

2: Carbon Monoxide (CO) sensor

3: Carbon Dioxide (CO2) sensor

4: Heat sensor

5: Water leak sensor

6: Access control

9: Lock jammed

18: Lock locked with user code

19: Lock unlocked with user code

21: Manual lock

22: Manual unlock

24: Locked by RF

25: Unlocked by RF

27: Auto lock

33: User deleted

112: Master code changed, or user added

113: Duplicate PIN code error

130: RF Module power cycled

161: Tamper alarm

167: Low battery

168: Critical battery level

169: Battery too low to operate

Alarm Level Entity

The meaning of the alarm_level entity depends on the nature of the alarm sensor.

Smoke, CO, and CO2

1: Detection - will include a Node Location Report

2: Detection (unknown location)

254: Unknown event

Heat

1: Overheat detected - will include a Node Location Report

2: Overheat detected (unknown location)

3: Rapid temperature rise - will include a Node Location Report

4: Rapid temperature rise (unknown location)

5: Underheat detection - will include a Node Location Report

6: Underheat detection (unknown location)

254: Unknown event

Water leak

1: Water leak detected - will include a Node Location Report

2: Water leak detected (unknown location)

3: Water level dropped - will include a Node Location Report

4: Water level dropped (unknown location)

254: Unknown event

Access control

1: Manual lock

2: Manual unlock

3: RF lock

4: RF unlock

5: Keypad lock - will include the User Identifier of the User Code Report

6: Keypad unlock - will include the User Identifier of the User Code Report

Burglar Entity

burglar: These may vary between brands

0: Not active

2: Smoke (?)

3: Tamper

8: Motion

22: Open

23: Closed

254: Deep sleep

255: Case open

If your device has a burglar entity, but not a binary_sensor equivalent, you can use a template binary sensor to create one (here we’ve defined it as a motion sensor, but you can use [any relevant device class](/components/binary_sensor/#device-class: