Missing Manufacturer Specific mode and valve control for Aeotec TRV

[maivorbim]

The problem

Currently, climate entity exposes only Heat and Off modes and three presets for Aeotec Thermostat Radiator Valve (ZWA021).

However, Aeotec TRV supports a third mode, namely Manufacturer Specific, which allows direct valve control. Enabling this should expose a new entity (dimmer or cover type) allowing 0-100 / 0-255 valve control of the TRV.

When using Zwavejs2mqtt via mosquitto broker and mqtt integration, this third mode can be enabled by adding the following code in the ZWJS2M control panel - with fan_only: 31 being used to set the TRV to Manufacturer Specific

  "mode_map": {
    "off": 0,
    "auto": 1,
    "fan_only": 31

.......

  "discovery_payload": {
    "min_temp": 8,
    "max_temp": 28,
    "modes": [
      **"off",
      "auto",
      "fan_only"

........

    "mode_state_template": "{{ {0: \"off\",1: \"auto\",31: \"fan_only\"}[value_json.value] | default('off') }}",

This lets the user set the thermostat in Manufacturer Specific mode and control the valve position via a separate light dimmer entity. This allows to move the valve logic from the controller level up to HA level and allows the user to create more useful and precise automations for the TRV.

I know that the Zwave-js integration is at its beginning, but it would be useful if we could replicate this functionality via the Z-wave JS integration, without having to depend on a mqtt broker.

Environment

HA core-2021.2.0b1 supervisor-2021.01.8 Z-Wave JS addon 0.1.1

[probot-home-assistant]

Hey there @home-assistant/z-wave, mind taking a look at this issue as its been labeled with an integration (zwave_js) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[marcelveldt]

The Z-Wave JS integration is about the native HA integration with Z-Wave JS (using the WS Server).
This issue is about MQTT discovery of topics created by Z-Wave JS 2 MQTT...

For best experience in HA you might want to switch to the new Z-Wave JS integration, you can even use the zwavejs2mqtt docker/addon (just enable the WS Server in settings). If you'd like to stay with MQTT, you should file this report to zwavejs2mqtt on github.

[marcelveldt]

Or do you mean you actually want the described behavior in the Z-Wave JS integration ?
In that case we'll have to look into it how to deal with this as we don't have any device/model specific quirks in the code now.

EDIT: After carefully reading again I see that you indeed say that you miss this specific feature in the Z-Wave JS integration, the MQTT stuff was just additional info

[maivorbim]

Or do you mean you actually want the described behavior in the Z-Wave JS integration ?
In that case we'll have to look into it how to deal with this as we don't have any device/model specific quirks in the code now.

EDIT: After carefully reading again I see that you indeed say that you miss this specific feature in the Z-Wave JS integration, the MQTT stuff was just additional info

correct, i would like to have these features in Z-wave JS integration. The MQTT stuff I was just pasting in the hope that it would be a bit clearer what I wanted to accomplish. :)

[marcelveldt]

Yeah, It's clear now. I didn't read well enough first time ;-)
Implementing your request is not easy because "Manufacturer specific" is kind of really generic.
We're looking into ways to accomplish this, maybe by some definitions file where device specific quirks are specified.
To be continued....

[maivorbim]

unfortunately I do not know much about programming more than basic edits, but this is something I managed to do on the legacy zwave integration to expose cover/dimmer control for the Aeotec TRV valve position (also applies for the Eurotronic Spirit TRV which is the same device). Do not know if this is in anyway helpful however for the zwave-js integration:

https://gist.github.com/insajd/b1c922284ec2e38e84704db16429e001/revisions

Also for reference: https://community.home-assistant.io/t/eurotronic-spirit-z-wave-external-temperature-sensor/88430/31

[marcelveldt]

For completeness, can you please share a dump of your mesh with us to investigate ?
You can download the dump in HA --> Zwave JS integraion --> Configure --> download dump
Thanks!

[maivorbim]

Attached. Rename to .jsonl
zwave_js_dump.txt

[AlCalzone]

That sounds like something that should be changed with a compat flag in our config files. How is the additional dimmer added? Or is that already exposed by some device endpoint?

[UmbraMalison]

Just further clarify, in open zwave beta these thermostats in my case the eurotronic spiritz enumerated with a valve position attribute that could be read in any mode.
The configuration of the device includes a parameter for setting the report period based on the %change of the valve.

And then in manufacturer specific mode that attribute becomes the only mechanism to set the valve %.

I use the valve % to calculate heat demand in my house, which in turn activates the boiler to provide the heat.

So it's going to be a little colder this week, and looking at the weather forecast it is going to be quite a bit cooler, with snow ❄️ on the weekend!

[UmbraMalison]

temp solution that's working for me is to get the valve position via MQTT. I'm doing this by:

1. use zwavejs2mqtt,
2. enable gateway/mqtt.
3. in home assistant:

- platform: mqtt
  name: "Lounge thermostat valve position"
  unit_of_measurement: "%"
  state_topic: "zwave/nodeID_33/38/0/currentValue"
  value_template: "{{ value_json.value }}"

[stefans2904]

I have the same issue with Eurotronics Spirit Thermostat Radiator Valves.
I do see the number entity for each TRV appearing, but the TRV's need to be in the specific mode 'Manufacturer Specific' to be able to set the valve position manually.

Currently the only modes that can be specified are: 'None', 'Energy heat', 'Full power'. According to the manual this should be:

Is it possible to get the 'Manufacturer Specific' mode available in Zwave JS? I'm running core-2021.3.2

[AlCalzone]

Does the thermostat report this mode as supported?

[stefans2904]

Does the thermostat report this mode as supported?

It seems not, during inclusion it shows the following:

14:34:30.431 CNTRLR [Node 041] ThermostatModeCC: doing a complete interview...
14:34:30.432 CNTRLR » [Node 041] querying supported thermostat modes...
14:34:30.497 CNTRLR « [Node 041] received supported thermostat modes:
· Off
· Heat
· Energy heat
· Full power

I do see the following in the Zwave JS dump:

See below the full dump of the node:
{ "nodeId": 40, "index": 0, "installerIcon": 4608, "userIcon": 4608, "status": 4, "ready": true, "deviceClass": { "basic": { "key": 4, "label": "Routing Slave" }, "generic": { "key": 8, "label": "Thermostat" }, "specific": { "key": 6, "label": "General Thermostat V2" }, "mandatorySupportedCCs": [ 32, 114, 64, 67, 134 ], "mandatoryControlledCCs": [] }, "isListening": false, "isFrequentListening": true, "isRouting": true, "maxBaudRate": 40000, "isSecure": false, "version": 4, "isBeaming": true, "manufacturerId": 328, "productId": 1, "productType": 3, "firmwareVersion": "0.16", "zwavePlusVersion": 1, "nodeType": 0, "roleType": 7, "deviceConfig": { "filename": "/usr/lib/node_modules/zwave-js/node_modules/@zwave-js/config/config/devices/0x0148/spirit.json", "manufacturerId": 328, "manufacturer": "Eurotronics", "label": "Spirit", "description": "Thermostatic Valve", "devices": [ { "productType": "0x0003", "productId": "0x0001" }, { "productType": "0x0003", "productId": "0x0003" } ], "firmwareVersion": { "min": "0.0", "max": "255.255" }, "paramInformation": { "_map": {} } }, "label": "Spirit", "neighbors": [ 1, 5, 7, 15, 18, 23, 25, 28, 29, 35 ], "interviewAttempts": 1, "interviewStage": 7, "commandClasses": [ { "id": 38, "name": "Multilevel Switch", "version": 1, "isSecure": false }, { "id": 49, "name": "Multilevel Sensor", "version": 5, "isSecure": false }, { "id": 64, "name": "Thermostat Mode", "version": 3, "isSecure": false }, { "id": 67, "name": "Thermostat Setpoint", "version": 3, "isSecure": false }, { "id": 89, "name": "Association Group Information", "version": 1, "isSecure": false }, { "id": 90, "name": "Device Reset Locally", "version": 1, "isSecure": false }, { "id": 94, "name": "Z-Wave Plus Info", "version": 2, "isSecure": false }, { "id": 108, "name": "Supervision", "version": 1, "isSecure": false }, { "id": 112, "name": "Configuration", "version": 1, "isSecure": false }, { "id": 113, "name": "Notification", "version": 8, "isSecure": false }, { "id": 114, "name": "Manufacturer Specific", "version": 1, "isSecure": false }, { "id": 117, "name": "Protection", "version": 1, "isSecure": false }, { "id": 122, "name": "Firmware Update Meta Data", "version": 3, "isSecure": false }, { "id": 128, "name": "Battery", "version": 1, "isSecure": false }, { "id": 133, "name": "Association", "version": 2, "isSecure": false }, { "id": 134, "name": "Version", "version": 2, "isSecure": false }, { "id": 152, "name": "Security", "version": 1, "isSecure": true } ], "endpoints": [ { "nodeId": 40, "index": 0, "installerIcon": 4608, "userIcon": 4608 } ], "values": [ { "endpoint": 0, "commandClass": 38, "commandClassName": "Multilevel Switch", "property": "targetValue", "propertyName": "targetValue", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "min": 0, "max": 99, "label": "Target value" }, "value": 99 }, { "endpoint": 0, "commandClass": 38, "commandClassName": "Multilevel Switch", "property": "duration", "propertyName": "duration", "ccVersion": 1, "metadata": { "type": "duration", "readable": true, "writeable": true, "label": "Transition duration" } }, { "endpoint": 0, "commandClass": 38, "commandClassName": "Multilevel Switch", "property": "currentValue", "propertyName": "currentValue", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 99, "label": "Current value" }, "value": 99 }, { "endpoint": 0, "commandClass": 38, "commandClassName": "Multilevel Switch", "property": "Up", "propertyName": "Up", "ccVersion": 1, "metadata": { "type": "boolean", "readable": true, "writeable": true, "label": "Perform a level change (Up)", "ccSpecific": { "switchType": 2 } } }, { "endpoint": 0, "commandClass": 38, "commandClassName": "Multilevel Switch", "property": "Down", "propertyName": "Down", "ccVersion": 1, "metadata": { "type": "boolean", "readable": true, "writeable": true, "label": "Perform a level change (Down)", "ccSpecific": { "switchType": 2 } } }, { "endpoint": 0, "commandClass": 49, "commandClassName": "Multilevel Sensor", "property": "Air temperature", "propertyName": "Air temperature", "ccVersion": 5, "metadata": { "type": "number", "readable": true, "writeable": false, "unit": "\u00b0C", "label": "Air temperature", "ccSpecific": { "sensorType": 1, "scale": 0 } }, "value": 18.14 }, { "endpoint": 0, "commandClass": 64, "commandClassName": "Thermostat Mode", "property": "mode", "propertyName": "mode", "ccVersion": 3, "metadata": { "type": "number", "readable": true, "writeable": true, "min": 0, "max": 255, "states": { "0": "Off", "1": "Heat", "11": "Energy heat", "15": "Full power" }, "label": "Thermostat mode" }, "value": 1 }, { "endpoint": 0, "commandClass": 64, "commandClassName": "Thermostat Mode", "property": "manufacturerData", "propertyName": "manufacturerData", "ccVersion": 3, "metadata": { "type": "any", "readable": true, "writeable": true } }, { "endpoint": 0, "commandClass": 67, "commandClassName": "Thermostat Setpoint", "property": "setpoint", "propertyKey": 1, "propertyName": "setpoint", "propertyKeyName": "Heating", "ccVersion": 3, "metadata": { "type": "number", "readable": true, "writeable": true, "min": 8, "max": 28, "unit": "\u00b0C", "ccSpecific": { "setpointType": 1 } }, "value": 17 }, { "endpoint": 0, "commandClass": 67, "commandClassName": "Thermostat Setpoint", "property": "setpoint", "propertyKey": 11, "propertyName": "setpoint", "propertyKeyName": "Energy Save Heating", "ccVersion": 3, "metadata": { "type": "number", "readable": true, "writeable": true, "min": 8, "max": 28, "unit": "\u00b0C", "ccSpecific": { "setpointType": 11 } }, "value": 0 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 1, "propertyName": "LCD Invert", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": 0, "max": 1, "default": 0, "format": 0, "allowManualEntry": false, "states": { "0": "LCD-content normal", "1": "LCD-content inverted (UK Edition)" }, "label": "LCD Invert", "isFromConfig": true }, "value": 0 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 2, "propertyName": "LCD Timeout", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": 0, "max": 30, "default": 0, "unit": "s", "format": 0, "allowManualEntry": true, "label": "LCD Timeout", "isFromConfig": true }, "value": 0 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 3, "propertyName": "Backlight", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": 0, "max": 1, "default": 1, "format": 0, "allowManualEntry": false, "states": { "0": "Backlight disabled", "1": "Backlight enabled" }, "label": "Backlight", "isFromConfig": true }, "value": 0 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 4, "propertyName": "Battery report", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": 0, "max": 1, "default": 1, "format": 0, "allowManualEntry": false, "states": { "0": "system notification", "1": "Send battery status unsolicited once a day." }, "label": "Battery report", "isFromConfig": true }, "value": 1 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 5, "propertyName": "Measured Temperature report", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": 0, "max": 50, "default": 5, "unit": "\u00b0C", "format": 0, "allowManualEntry": true, "label": "Measured Temperature report", "isFromConfig": true }, "value": 5 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 6, "propertyName": "Valve opening percentage report", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": 0, "max": 100, "default": 0, "unit": "%", "format": 0, "allowManualEntry": true, "label": "Valve opening percentage report", "isFromConfig": true }, "value": 50 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 7, "propertyName": "Window open detection", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": 0, "max": 3, "default": 2, "format": 0, "allowManualEntry": false, "states": { "0": "Disabled", "1": "Sensitivity low", "2": "Sensitivity medium", "3": "Sensitivity high" }, "label": "Window open detection", "isFromConfig": true }, "value": 0 }, { "endpoint": 0, "commandClass": 112, "commandClassName": "Configuration", "property": 8, "propertyName": "Temperature Offset", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "valueSize": 1, "min": -128, "max": 50, "default": 0, "unit": "1/10 \u00b0C", "format": 0, "allowManualEntry": true, "label": "Temperature Offset", "isFromConfig": true }, "value": 0 }, { "endpoint": 0, "commandClass": 113, "commandClassName": "Notification", "property": "alarmType", "propertyName": "alarmType", "ccVersion": 8, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 255, "label": "Alarm Type" } }, { "endpoint": 0, "commandClass": 113, "commandClassName": "Notification", "property": "alarmLevel", "propertyName": "alarmLevel", "ccVersion": 8, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 255, "label": "Alarm Level" } }, { "endpoint": 0, "commandClass": 113, "commandClassName": "Notification", "property": "Power Management", "propertyKey": "Battery maintenance status", "propertyName": "Power Management", "propertyKeyName": "Battery maintenance status", "ccVersion": 8, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 255, "label": "Battery maintenance status", "states": { "0": "idle", "10": "Replace battery soon", "11": "Replace battery now" }, "ccSpecific": { "notificationType": 8 } }, "value": 0 }, { "endpoint": 0, "commandClass": 113, "commandClassName": "Notification", "property": "System", "propertyKey": "Hardware status", "propertyName": "System", "propertyKeyName": "Hardware status", "ccVersion": 8, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 255, "label": "Hardware status", "states": { "0": "idle", "3": "System hardware failure (with failure code)" }, "ccSpecific": { "notificationType": 9 } }, "value": 0 }, { "endpoint": 0, "commandClass": 114, "commandClassName": "Manufacturer Specific", "property": "manufacturerId", "propertyName": "manufacturerId", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 65535, "label": "Manufacturer ID" }, "value": 328 }, { "endpoint": 0, "commandClass": 114, "commandClassName": "Manufacturer Specific", "property": "productType", "propertyName": "productType", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 65535, "label": "Product type" }, "value": 3 }, { "endpoint": 0, "commandClass": 114, "commandClassName": "Manufacturer Specific", "property": "productId", "propertyName": "productId", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 65535, "label": "Product ID" }, "value": 1 }, { "endpoint": 0, "commandClass": 117, "commandClassName": "Protection", "property": "local", "propertyName": "local", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": true, "label": "Local protection state", "states": { "0": "Unprotected", "1": "ProtectedBySequence", "2": "NoOperationPossible" } }, "value": 0 }, { "endpoint": 0, "commandClass": 128, "commandClassName": "Battery", "property": "level", "propertyName": "level", "ccVersion": 1, "metadata": { "type": "number", "readable": true, "writeable": false, "min": 0, "max": 100, "unit": "%", "label": "Battery level" }, "value": 55 }, { "endpoint": 0, "commandClass": 128, "commandClassName": "Battery", "property": "isLow", "propertyName": "isLow", "ccVersion": 1, "metadata": { "type": "boolean", "readable": true, "writeable": false, "label": "Low battery level" }, "value": false }, { "endpoint": 0, "commandClass": 134, "commandClassName": "Version", "property": "libraryType", "propertyName": "libraryType", "ccVersion": 2, "metadata": { "type": "any", "readable": true, "writeable": false, "label": "Library type" }, "value": 3 }, { "endpoint": 0, "commandClass": 134, "commandClassName": "Version", "property": "protocolVersion", "propertyName": "protocolVersion", "ccVersion": 2, "metadata": { "type": "any", "readable": true, "writeable": false, "label": "Z-Wave protocol version" }, "value": "4.61" }, { "endpoint": 0, "commandClass": 134, "commandClassName": "Version", "property": "firmwareVersions", "propertyName": "firmwareVersions", "ccVersion": 2, "metadata": { "type": "any", "readable": true, "writeable": false, "label": "Z-Wave chip firmware versions" }, "value": [ "0.16" ] }, { "endpoint": 0, "commandClass": 134, "commandClassName": "Version", "property": "hardwareVersion", "propertyName": "hardwareVersion", "ccVersion": 2, "metadata": { "type": "any", "readable": true, "writeable": false, "label": "Z-Wave chip hardware version" } } ] }

[AlCalzone]

Doesn't seem like it reports the mode as supported:

14:34:30.497 CNTRLR « [Node 041] received supported thermostat modes:
· Off
· Heat
· Energy heat
· Full power

So you'll have to wait for the workaround in zwave-js/node-zwave-js#1625 to be implemented or (like I like to preach) bug the manufacturer to fix their shit.

Btw, this is the table you should be looking at (Thermostat Mode, not Basic CC):

Side note: I'm not sure what's possible in HA, but you should be able to simply set this value to 31 (0x1f) even though that mode is not reported.

[MartinHjelmare]

We have a service to change config parameters.
https://www.home-assistant.io/integrations/zwave_js/#service-zwave_jsset_config_parameter

[AlCalzone]

@MartinHjelmare this is not about config parameters.

[stefans2904]

Doesn't seem like it reports the mode as supported:

14:34:30.497 CNTRLR « [Node 041] received supported thermostat modes:
· Off
· Heat
· Energy heat
· Full power

So you'll have to wait for the workaround in zwave-js/node-zwave-js#1625 to be implemented or (like I like to preach) bug the manufacturer to fix their shit.

Btw, this is the table you should be looking at (Thermostat Mode, not Basic CC):

Side note: I'm not sure what's possible in HA, but you should be able to simply set this value to 31 (0x1f) even though that mode is not reported.

It seems that the 'Manufacturer Specific' mode must be enabled via the BASIC command class. See here for some more information: https://community.openhab.org/t/eurotronic-spirit-unsupported-mode-type-31/57265/35

Is this something that we can enable for this device in ZwaveJS?

[AlCalzone]

@stefans2904 we could keep the Basic CC from being hidden, so you can use it to enable the mode until the workaround is in place. But this also won't be perfect:

Setting the BASIC_MODE to “Manual” changes the THERMOSTAT_MODE to “Manual”. (but not vice versa)
So changing the THERMOSTAT_MODE to Heating does not change the BASIC_MODE to Heating.(it remains “Manual”) And I think this (changing Thermostat mode) could happen when you press the buttons on the physical device.

[stefans2904]

@stefans2904 we could keep the Basic CC from being hidden, so you can use it to enable the mode until the workaround is in place. But this also won't be perfect:

Setting the BASIC_MODE to “Manual” changes the THERMOSTAT_MODE to “Manual”. (but not vice versa)
So changing the THERMOSTAT_MODE to Heating does not change the BASIC_MODE to Heating.(it remains “Manual”) And I think this (changing Thermostat mode) could happen when you press the buttons on the physical device.

For me that won't be a problem as I can use an Automation that triggers when the Thermostat mode changes after pressing the buttons on the device. That automation can then change the Basic Mode to Heating.

[stefans2904]

@AlCalzone is this something that can be done (keep the Basic CC from being hidden)? Can I manually do this somehow?

[AlCalzone]

@stefans2904 you would have to edit the config file for the device and add the compat flag commandClasses.add:
https://zwave-js.github.io/node-zwave-js/#/config-files/file-format?id=commandclassesadd
for CC 0x20, add "isSupported": true for each endpoint

Mount that config file into the correct location in the container, re-interview the node to enable it.
The only thing I don't know is if HA creates entities for the Basic CC.