"zha-toolkit" - a big set of Zigbee commands on top of ZHA/zigpy

le_top · February 6, 2023, 11:15pm

@tube0013 Can you see in the log that zha_toolkit is loadling before zha?
What version of HA are you using?

EDIT: I released v0.8.33 - hopefully that will allow zha-toolkit to be setup - it no longer expects “the gateway” to be defined in ZHA to do its own initialisation. Hopefully that fixes it. If not, zha-toolkit will have to be setup not testing anything about zha at startup at all and report that zha is missing later (on every zha-toolkit service call).

Lars_Eriksson · February 27, 2023, 11:28am

Hey.

Ive created a sensor with attr_read/allow_create: true, but how do i remove that sensor?

  - service: zha_toolkit.execute
    data:
      command: attr_read
      ieee: 1f:ff:00:00:00:00:00:00
      cluster: 0x0000
      attribute: 0x0000
      state_id: sensor.new_sensor
      state_value_template: value / 100
      allow_create: true

le_top · February 27, 2023, 2:39pm

So on Link to Entities – My Home Assistant you can tick the checkbox at the start of the line for an entity. A menu will appear at the top where the “red button” allows you to delete the selected entities.

tube0013 · February 27, 2023, 5:15pm

I just had a chance to update, and seems to be reliably loading now. thanks!

ddeconin · March 1, 2023, 10:21am

Hi,
Lately my zigbee coordinator goes offline sometimes.
I tried setting up an automation to warn me about that using the device_offline trigger, but that doesn’t seem to help. can zha_toolkit help here?

le_top · March 1, 2023, 12:33pm

An indirect way of checking if you coordinator is offline, is likely to check the last_seen value of one or more devices that should always be online.

I gave an example how to access this data here:

ant there is also an example in the zha_toolkit repository:

github.com

mdeweerd/zha-toolkit/blob/02030f5309f3f6ab816aa1c241f1369c789d1c04/examples/script_use_zha_devices.yaml

---
alias: Loop over zha_devices, extract some device data
sequence:
  - parallel:
      - sequence:
          - wait_for_trigger:
              - platform: event
                event_type: zha_devices_ready
          - service: system_log.write
            data:
              logger: zha_devices
              level: error
              message: '{{ "Got event %s" % ( wait.trigger.event.data.devices ) }}'
          - service: system_log.write
            alias: List unavailable only
            data:
              logger: zha_devices
              level: error
              message: >
                {% set ns = namespace(names=[]) %}

This file has been truncated. show original

That could be adjusted to find the most recent last_seen value, update a state and then use that state to generate an alert if the date is too old.

Klausi · April 1, 2023, 7:24pm

Hello @le_top. Thank you for your great work. Is it possible, to convert the zigbee2mqtt room-loadbalancing-blueprint fron napalm to zha? I use danfoss ally thermostats at my whole house (actually 11, but later 15) but sometimes grouped heaters are uneven hot. With z2m and room loadbalancing, they get even heat. But i have a lot of issues with z2m and would like to go back to zha.

Zigbee2MQTT - Danfoss Ally TRV Room Load Balancing - Blueprints Exchange - Home Assistant Community (home-assistant.io)

le_top · April 2, 2023, 11:00am

It is possible to implement this under ZHA, but there is some work to transform this, mainly to work with the load values.

I think of these 3 ways to do it (I can think of more, but these would be the ones I consider):

Work purely with a yaml automation (/blueprint) and zha-toolkit features to read the load values;
Extend the existing danfoss quirk/zha_device_handlers (+ZHA?) to add the load values as a state attribute. Then use this attribute in a yaml script.
Implement part of the code in Python, and mix with a yaml automation. It is easy and dynamic to add a new service to ZHA-Toolkit. There could be a set of danfoss specific services, and we would need one that accepts a list of devices that need load balancing, and the python code would take care of getting the current load indicators, compute the totals and send them to the devices.
It would then suffice to call this service on a regular basis.

1. Using Yaml and ZHA-Toolkit features.

a. One should verify/configure the Load reporting configuration of the Danfoss Valves. This is a one time configuration that could be added to the existing Danfoss configuration script.
A correct configuration ensures that the valves are reporting their load without a need to send a zigbee attribute read request to the valves.
b. The load values would then end up in the cached values in the zigpy/zha database. They can be read using a service call like this (the example is for reading a cached temperature value). The key elements in this example are (1) use_cache which avoids sending a read request to the valve, and (2) writing the result directly to a state value or state attribute which is then useable in the automation.

  - alias: Try to get more precise temperature (should work if zigbee temperature
      sensor)
    service: zha_toolkit.attr_read
    data:
      ieee: '{{ temp_sensor_id }}'
      use_cache: true
      cluster: 1026
      attribute: 0
      state_id: '{{ temp_sensor_id }}'
      state_attr: best_val
      state_value_template: value/100

c. Compute the total load value - use a repeat loop in yaml and use the attr_read service as shown in (b) to get the load value, and compute the required sum. After the sum, loop again and use attr_write to send this value to the valves.

2. Update the zha_quirk

Implies starting from the existing quirk and make necessary changes to make the load value accessible from Home Assistant. I know that ZHA has evolve recently to make some of that easier to implement.

3. Implement part of the code in Python

One could start by adding a user service as shown in the _user.py example and documented here.

Zha-toolkit reloads the code before calling it so one can evolve and test the code without restarting HA.

The command_data argument/field can be used to provide the list of devices in one room. The python code would then loop over this list, either use the ‘attr_read’ service by calling it internally with the proper arguments, or implement the reads more explicitly and check the cache using code as in zcl_attr.py.

Klausi · April 2, 2023, 5:45pm

Thank you for your explanation. I thought, it would be much easier to implement this feature. Too bad, that my coding knowledge is nearly zero. Well, i have to stay at z2m then i think.

Hedda · April 29, 2023, 4:23pm

@le_top Thanks again for continuing to develop zha-toolkit! Wondering if can suggest that you update your original post in this thread for the current feature so that it summarize is correct when it is linked:

le_top · July 14, 2023, 3:00pm

HA2023.7 with zigpy 0.56.0 has breaking changes, you need to update to zha-toolkit v0.9.4

Hedda · July 17, 2023, 7:05am

Can “responding services” feature from Home Assistant Core 2023.7 make ZHA Toolkit more useful?

https://www.home-assistant.io/blog/2023/07/05/release-20237/#services-can-now-respond

Sounds also like this feature could make it easier to use ZHA services directly in an automation?

le_top · July 17, 2023, 12:46pm

Hi @Hedda

zha-toolkit did not wait for such a feature for providing responses which can be fouind in the event data. There are some examples that demonstrate how to use that.

However, it would certainly beneficial to provide the data directly to the automation rather than having to retrieve it from the event (which is kind of complex to capture in an automation).
However, I did not find technical documentation on how to generate those responses in a component’s python by following the links in the release notes.

Hedda · July 18, 2023, 8:04am

Home Assistant Developers Blog only mentions “service return values” which might be the same thing?

https://developers.home-assistant.io/blog/2023/06/14/service-calls/

https://github.com/home-assistant/architecture/discussions/777#discussioncomment-6127898

I did find this example on “Response Data” for services in the Home Assistant documentation:

https://www.home-assistant.io/docs/scripts/service-calls#use-templates-to-handle-response-data

and this about “service response data” in the developer’s documentation:

https://developers.home-assistant.io/docs/dev_101_services/#response-data

Release notes also mention that integration developers first need to enable it per service. So you can not get responses from just any service, instead, it has been enabled in the integration for each specific service that you want to be able to give a response.

https://developers.home-assistant.io/docs/dev_101_services/#supporting-response-data

As I understand, the release notes implies that other than for scripts it has so far only been enabled for calendar.list_events and conversation.process services in the Calander integration as an example so guess that integration developers would need to use that as a reference?

Perhaps @allenporter has more info or links on implementing responses for services in integrations?

allenporter · July 18, 2023, 1:59pm

You found everything… The last link is the developer docs for implementing this.

le_top · July 19, 2023, 10:09pm

@Hedda Thanks for pulling this together.
@allenporter I agree that Integration Services | Home Assistant Developer Docs holds the relevant information.

The documentation suggests:

      hass.services.async_register(
          DOMAIN,
          SEARCH_ITEMS_SERVICE_NAME,
          search_items,
          schema=SEARCH_ITEMS_SCHEMA,
          SupportsResponse.ONLY,
      )

but then I get SyntaxError: positional argument follows keyword argument - I will find the correct way to do it (named argumetn or positional argument).

pdecat · July 22, 2023, 8:28am

Submitted docs: fix Supporting Response Data example by pdecat · Pull Request #1853 · home-assistant/developers.home-assistant · GitHub to fix the documentation example.

le_top · July 23, 2023, 11:06pm

zha-toolkit is now updated to provide response data and I updated one of the scripts to use it:

github.com

mdeweerd/zha-toolkit/blob/2e0e9ba0638c9bdd2709c9000495cc047758a252/examples/script_use_zha_devices_response.yaml

---
alias: Loop over zha_devices, extract some device data.  For HA>=2023.7
sequence:
  - service: zha_toolkit.zha_devices
    response_variable: dev_data
  - service: system_log.write
    data:
      logger: zha_devices
      level: error
      message: '{{ "Got device_data %s" % ( dev_data.devices ) }}'
  - service: system_log.write
    alias: List unavailable only
    data:
      logger: zha_devices
      level: error
      message: >
        {% set ns = namespace(names=[]) %}
        {% for item in dev_data.devices if not item.available %}
          {% set ns.names = ns.names + [ "'%s'" % (item.name) ] %}
        {% endfor %}

This file has been truncated. show original

The response data is also provided by when calling the service interactively which is handier than having to check the even_data.

Thomas_Munster · July 31, 2023, 11:04am

Hi

I’m trying to use Toolkit, which has been installed/activated correctly. I also activated the custom component under “log” in my configuration. I understand that the feedback from running the services will be listed in the Home Assistant core log file - correct? The problem is I see nothing in the log file.

Is there somebody who can point me in the direction of a solution?!

le_top · August 1, 2023, 9:37am

One way to verify that zha-toolkit is correctly set up is to verify that they appear in “Developrer Tools > Services” (example in French):

Using that same location to run services, you can dynamically change the log level (no need to add them to you static configuration - the configuration is kept until reboot or another change):

service: logger.set_level
data:
  custom_components.zha_toolkit: debug
  zigpy.zcl: debug

It is true that the traces should occur in the log (/config/home-assistant.log).

With Home Assistant >=2023.7 and zha-toolkit>=v0.9.7, you can also see the response when using th e “Developer Tools>Services” without the need to activate logging or listen to events:

And when using a zha-toolkit service, you can get the result in a variable by adding “response_variable: …” to the service arguments.

Do you see the zha toolkit services? Do you have zha insdtalled as well (zha-toolkit ‘extends’ zha)? zha has services as well, so you can check that you have access to those: