sinope-zha

This is a custom quirks for sinope zigbee devices for testing before it is added to zha-device-handlers. It also explain how to setup those quirks in Home Assistant to use and test them before they are merged in zha-device-handlers.

Home assistant configuration:

• in /config directory create a new directory zhaquirks -> /config/zhaquirks
• in configuration.yaml add the following:

  zha:
  database_path: zigbee.db
  custom_quirks_path: /config/zhaquirks/

  Copy the quirks

  In /config/zhaquirks copy the fourth files, light.py, switch.py, thermostat.py and sensor.py then restart Home Assistant

Logging

In configuration.yaml you can add this to get logging info for the quirks:

logger:
  default: warning
  logs:
    zhaquirks: debug

You should see the following:

...[zhaquirks] Loading quirks module zhaquirks.aduro
...
...[zhaquirks] Loading custom quirks from /config/zhaquirks
...[zhaquirks] Loading custom quirks module light
...[zhaquirks] Loading custom quirks module switch
...[zhaquirks] Loading custom quirks module thermostat
...[zhaquirks] Loading custom quirks module sensor

Editing the quirks:

You can edit the files as you like and restart HA to test your changes. Don't forget to delete the __pycache__ folder in /config/zhaquirks before restarting HA so your changes will be added.

Custom cluster attributes details:

I'll list here all the custom cluster attribute with explanation about how to use them in your automation.

• Thermostats:

• lights and dimmer: (SW2500ZB, DM2500ZB, DM2550ZB)

• Switch SP2600ZB, SP2610ZB

• Switch RM3250ZB, Load Controller

• Switch RM3500ZB, Calypso water tank controller

• Switch MC3100ZB, multi controller

• Switch valve VA4200WZ, VA4201WZ, VA4200ZB VA4201ZB, VA4220ZB, VA4221ZB

• Switch valve VA4220ZB G2, VA4221ZB G2 with flow meter

• Sensors WL4200, WL4200S, WL4200C, WL4210

• Sensors LM4110-ZB, tank level monitor

Propane level is reported as gauge needle angle cluster 0x000c, attribute 0x0055. There is no % value. In neviweb this is calculated depending on gauge type 5-95 or 10-80. If you need to set an alarm at 20% tank capacity then target angle 182 for 5-95 and 10-80 gauge. For 30% value 5-95 = 221 and 10-80 = 216.

Devices reporting

Device reporting allow device to report any changes that occur on some cluster attributes. If your device was connected to Neviweb before you don't need to activate reporting, except for light and dimmer double tap and long press reporting. If your device is bran new then it should be necessary to implement device reporting. To proceed you can do it by installing ZHA Toolkit (https://github.com/mdeweerd/zha-toolkit) v0.8.31 or higher, and following example below:

Following are the cluster/attributes set for reproting in Neviweb:

• Thermostat:

• Light and dimmer:

• load control RM3250ZB:

• Valve:

• Leak sensors:

• Tank monitor LM4110-ZB:

• Calypso RM3500ZB:

Setting the flow meter model for your VA422xZB valve 2n gen.

To add your flow meter to your valve, you need to use the service ZHA Toolkit: Write Attribute. The data to set the flow meter is written in an attr_type array. The command is different for each type of flow meter:

• FS4220: (3/4 inch)

  service: zha_toolkit.attr_write
  data:
  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
  endpoint: 1
  cluster: 0xff01
  attribute: 0x0240
  attr_type: 0x48
  attr_val: [32, 12, 0, 194, 17, 0, 0, 136, 119, 0, 0, 1, 0, 0, 0]
  read_before_write: true
  read_after_write: true

• FS4221: (one inch)

  service: zha_toolkit.attr_write
  data:
  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
  endpoint: 1
  cluster: 0xff01
  attribute: 0x0240
  attr_type: 0x48
  attr_val: [32, 12, 0, 159, 38, 0, 0, 76, 85, 1, 0, 1, 0, 0, 0]
  read_before_write: true
  read_after_write: true

• FS4222: (1.5 inch)

  service: zha_toolkit.attr_write
  data:
  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
  endpoint: 1
  cluster: 0xff01
  attribute: 0x0240
  attr_type: 0x48
  attr_val: [32, 12, 0, 1, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0]
  read_before_write: true
  read_after_write: true

• No flow meter:

  service: zha_toolkit.attr_write
  data:
  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
  endpoint: 1
  cluster: 0xff01
  attribute: 0x0240
  attr_type: 0x48
  attr_val: [32, 12, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0]
  read_before_write: true
  read_after_write: true

Light switch and dimmer double tap, long press reporting :

Sinopé light switches (SW2500ZB), dimmer (DM2500ZB and DM2550ZB) supports single, double and long click, but requires to enable device reporting on attribute 0x0054, cluster 0xff01 to get the action fired in ZHA. To proceed use zha_toolkit services and follow the example bellow :

a) create the reporting :

Here is an exemple of how to proceed. In this exemple :

• 50:0b:91:40:00:03:db:c2 is your light switch
• 00:12:4b:00:24:c0:c1:e0 is your Zigbee Coordinator

service: zha_toolkit.conf_report
data:
  ieee: 50:0b:91:40:00:03:db:c2
  cluster: 0xff01
  attribute: 0x0054
  manf: 4508
  min_interval: 0
  max_interval: 0
  reportable_change: 1
  tries: 3
  event_success: zha_report_success_trigger_event
  event_fail: zha_report_fail_trigger_event
  event_done: zha_done

b) Specify the bind to your coordinator :

service: zha_toolkit.bind_ieee
data:
  ieee: 50:0b:91:40:00:03:db:c2
  command_data: 00:12:4b:00:24:c0:c1:e0
  cluster: 65281
  event_done: zha_done

c) Automation example :

alias: Enable desk light when double tap on light switch
description: ""
trigger:
  - platform: event
    event_type: zha_event
    event_data:
      device_ieee: 50:0b:91:40:00:03:db:c2
      cluster_id: 65281
      args:
        attribute_id: 84
        attribute_name: action_report
        value: 4
condition: []
action:
  - type: toggle
    device_id: 8b11765575b04f899d9867165fa16069
    entity_id: light.interrupteur_lumiere_bureau_light_2
    domain: light
mode: single

For automations you will have acces to those events in the UI for device triggers:

• "Turn on" pressed
• "Turn off" pressed
• "Turn on" double clicked
• "Turn off" double clicked
• "Turn on" continuously pressed
• "Turn off" continuously pressed

LM4110-ZB setup for angle and level % reporting :

This sensor is a sleepy device. That mean the device is sleeping and wake up at specific interval to report his state. When it is sleeping it is impossible to reach hit. We can't send any command to that devive except when it is awake. To be able to configure the device you need to install ZHA-TOOLKIT component. This will allow to do all operations to setup the device.

the steps to configure your LM4110-ZB sensor is as follow:

setup reporting:

service: zha_toolkit.execute
data:
  ieee: «your LM4110 ieee »
  command: conf_report
  endpoint: 1
  cluster: 0x000c
  attribute: 0x0055
  min_interval: 5
  max_interval: 3757
  reportable_change: 1
  tries: 100
  event_done: zha_done

Check your log until you get :

'success': True, 'result_conf': [[ConfigureReportingResponseRecord(status=0)]]

zha-toolkit will submit the command until it reach 100 retry or zha_done event.

bind reporting:

Once you have it correctly, you need to bind your LM410ZB to your zigbee gateway so the report is sent to the correct place:

service: zha_toolkit.bind_ieee
data:
  ieee: «your LM4110 ieee »
  command_data: «your zigbee gateway ieee »
  cluster: 0x000c
  endpoint: 1
  dst_endpoint: 1
  tries: 100
  event_done: zha_done

service: zha_toolkit.execute can be replaced by service: zha_toolkit.conf_report. In that case remove the «command: conf_report line». The most important is to retry many time to catch the moment the LM4110 is awake.

setup automation to catch angle reporting:

To get the angle value you can try this method:

- platform: sql
  db_url: sqlite:////config/zigbee.db
  scan_interval: 10
  queries:
    - name: current_angle
      query: "SELECT value FROM attributes_cache_v7 where ieee = 'your LM4110 ieee' and cluster = 12 and attrid = 85"
      column: "value"

or you can use this method if you don't want to setup the sql platform:

service: zha_toolkit.execute
data:
  command: attr_read
  ieee: «your LM4110 ieee »
  cluster: 0x000c
  attribute: 0x0055
  state_id: sensor.current_angle
  allow_create: True
  tries: 100

This automation will create the sensor.current_angle or any other name you want.

- id: '1692841759194'
  alias: Lecture niveau propane
  description: Lecture du niveau de réservoir à chaque heure
  trigger:
  - platform: time_pattern
    hours: /1
  condition: []
  action:
  - service: zha_toolkit.execute
    data:
      command: attr_read
      ieee: "«your LM4110 ieee »"
      cluster: 12
      attribute: 85
      state_id: sensor.current_angle
      allow_create: true
      tries: 100
  mode: single

Do the calculation to transfert angle to % level:

There are two different tank gauge, scale from 10 to 80 (R3D 10-80) or scale from 5 to 95 (R3D 5-95). Calculation is different for each one.

• First set gauge type and value offset. For this you need to create input_number and input_text to set those value in configuration.yaml

  input_number:
  gauge_offset:
  name: "gauge offset"
  initial: 2
  min: 1
  max: 4
  step: 1

input_text:
  tank_gauge:
    name: "tank gauge"
    initial: "10-80" # or "5-95"

• Calculates propane tank % level according to value returned by Sinope device (for R3D 10-80 gauge or R3D 5-95 gauge)

  template:
  - trigger:
  - platform: time_pattern
    hours: "/5"
  - sensor:
  - name: "Tank remaining level"
    unit_of_measurement: "%"
    unique_id: sensor.tank_remaining_level
    icon: mdi:propane-tank
    state_class: measurement
    state: >
      {% set gauge = states('input_text.tank_gauge') %} # must match the above input_text name
      {% set angle = states('sensor.current_angle') | float %}
      {% set offset = states('input_number.gauge_offset') | float %} # must match the above input_number name
      {% if (gauge == "10-80") %}
        {% set x_min = 110 | float %}
        {% set x_max = 406 | float %}
        {% set delta = 46 | float %}
        {% set low = 10 | float %}
        {% set high = 80 | float %}
      {% else %}
        {% set x_min = 120 | float %}
        {% set x_max = 415 | float %}
        {% set delta = 55 | float %}
        {% set low = 5 | float %}
        {% set high = 95 | float %}
      {% endif %}
  
      {% if ((delta <= angle) and (70 >= angle)) %}
        {{ (((delta-x_min)/(x_max-x_min)*(high-low))+low+offset) | round(0) }}
      {% elif ((0 <= angle) and (delta > angle)) %}
        {{ (((angle)+360-x_min)/(x_max-x_min)*(high-low)+low+offset) | round(0) }}
      {% else %}
        {{ (((angle)-x_min)/(x_max-x_min)*(high-low)+low+offset) | round(0) }}
      {% endif %}

Automation examples:

• Sending outside temperature to thermostats:

• Celsius:

• alias: Send-OutdoorTemp trigger:

  • platform: state # send temperature when there are changes entity_id: sensor.local_temp # sensor to get local temperature variables: thermostats:
    • 50:0b:91:40:00:02:2d:6d #ieee of your thermostat dvices, one per line
    • 50:0b:91:40:00:02:2a:65 action:
  • repeat: #service will be call for each ieee count: "{{thermostats|length}}" sequence:
    • service: zha.set_zigbee_cluster_attribute data: ieee: "{{ thermostats[repeat.index-1] }}" endpoint_id: 1 cluster_id: 0xff01 # 65281 cluster_type: in attribute: 0x0010 # 16 value: "{{ ( trigger.to_state.state|float * 100 ) |int }}" # sending temperature in hundredth of a degree mode: single

  • Farenheight:

• alias: Update outside Temperature description: '' trigger:

  • platform: time_pattern # send temperature evey 45 minutes minutes: '45' action:
  • service: zha.set_zigbee_cluster_attribute data: ieee: 50:0b:91:32:01:03:6b:2f endpoint_id: 1 cluster_id: 65281 cluster_type: in attribute: 16 value: >- {{ (((state_attr('weather.home', 'temperature' ) - 32) 5/9)|float100)|int }} mode: single

    
    You can use either 0xff01 or 65281 in automation. You can send temperature on regular timely basis or when the outside temperature change. Do not pass over 60 minutes or thermostat display will go back to setpoint display. You can change that delay with the outdoor_temp_timeout attribute 0x0011.

• setting the outside temperature sensor:

You can use any temperature source, local or remote.

  - platform: template
    sensors:
      local_temp:
        friendly_name: "Outside_temperature"
        value_template: "{{ state_attr('weather.dark_sky', 'temperature') }}"

• Sending time to your thermostats. This should be done once a day to keep the time display accurate.

• alias: set_time trigger:
  • platform: time at: "01:00:00" ## at 1:00 AM variables: thermostats:
    • 50:0b:91:40:00:02:26:6d ## add all your IEEE zigbee thermostats, one per line action:
  • repeat: count: "{{thermostats|length}}" sequence:
    • service: zha.set_zigbee_cluster_attribute data: ieee: "{{ thermostats[repeat.index-1] }}" endpoint_id: 1 cluster_id: 0xff01 cluster_type: in attribute: 0x0020 value: "{{ (as_timestamp(utcnow()) - as_timestamp('2000-01-01'))| int }}" mode: single

• Setting the little icon Eco to flash on the thermostat during peak. To stop the icon flashing make another automation with value: -128 at the end of peak period.

• id: eco flash alias: eco_flash trigger:
  • platform: time at:
    • "06:00:00"
    • "16:00:00" condition: condition: state entity_id: binary_sensor.hydroqc_maison_upcoming_critical_peak state: 'on' variables: thermostats:
    • 50:0b:91:40:00:02:26:6d
    • 38:5c:fb:ff:fe:d9:ea:f4 action:
  • repeat: count: "{{thermostats|length}}" sequence:
    • service: zha.set_zigbee_cluster_attribute data: ieee: "{{ thermostats[repeat.index-1] }}" endpoint_id: 1 cluster_id: 0xff01 cluster_type: in attribute: 0x0071 value: 0 mode: single

      
      # Device hard reset:

• Thermostats:

  • Raise the temperature until the display change.
  • Push the two button until CLR appear on the screen.
  • Push once the upper button to get YES on the display.
  • Push both button simutanously and release immediately. DONE should appear on the screen.
  • The thermostat will restart with factory setup.

Buy me a coffee

If you want to make donation as appreciation of my work, you can do so via PayPal. Thank you!