HyperHDR: Home assistant hyperion integration is broken

@nurikk @tavalin @bverwijst @thehijacker @deimoszero @awawa-dev

…I plan to make a fork of the HA integration & hyperion-py library to try and see if I can adapt it and/or create a proper HyperHDR HA integration…

It took a long time but I finally had a chance to sit down and dig into the code. Now there exists a proper HyperHDR custom component for Home Assistant and it even has a toggle for HDR Tone Mapping! 😁

I’ve tested it at my house and it works well so I thought I’d share!

This is my first time working with python and HA custom components so let me know if any parts of it don’t work as expected by opening an issue on my repo; no need to clog up the issue tracker here.

Cheers! 🎉

@nurikk @thehijacker @awawa-dev

I’ve done some digging as to why my installation was working while others are unable to get it going and found a workaround until there is a proper HyperHDR HA integration. It was because I had Hyperion.ng set up and running with HA before I installed HyperHDR on my Pi, and I never removed the HA integration during the changeover.

I did some tests this morning and found an easy way for anyone to do the same. Steps to replicate:

• log into your router and set a DHCP reservation, or static IP, for the Pi running HyperHDR
• power down your Pi and remove your HyperHDR SD card
• grab an extra SD card and install any version of Hyperion.ng (I performed this test with 2.0.0-alpha.10)
• set up the HA Hyperion Integration
• power down the Pi, remove the Hyperion SD card and reinstall your HyperHDR SD card
• in HyperHDR settings, uncheck “Classic HyperHDR calibration” on the ‘Image Processing’ & ‘Remote Control’ pages
• done!

With this workaround, the only thing really missing in HA is the ability to toggle HDR Tone Mapping/HDR Global which can easily be done through HA or Node-RED.

I think the root of the incompatibilty is that the HA integration has a requirement (in its manifest.json) which defines use of hyperion-py

In the hyperion-py library are some constants referring specifically to Hyperion and it looks like HyperHDR’s description.xml now no longer has any references to hyperion (as of v17), which is probably for the best and also why it used to ‘just work’ with v16.

I plan to make a fork of the HA integration & hyperion-py library to try and see if I can adapt it and/or create a proper HyperHDR HA integration. I’m pretty familiar with coding but know nothing of python so it could take a while. Hopefully the workaround I described above will help others to get HyperHDR working with the existing HA Hyperion integration until then.

@tavalin Hi Daniel, I just used Node-RED, notably the node https://flows.nodered.org/node/node-red-contrib-plex-ws. It has only had limited testing but has worked so far in my case, I’m sure the flow could be improved upon. Then use a filter node to block changes if msg.session.Media[0].videoProfile does not change. Next a switch node to route on whether msg.session.Media[0].videoProfile == main 10, or not. Finally, use http request nodes to send the commands to HyperHDR. I hope that helps, any issues just ask and if you find a way of improving please let me know.

Managed to implement this json_rpc using HA rest call. FYI:

rest_commands:
  hyperhdr_usb_capture:
    url: http://192.168.28.64:8090/json-rpc
    method: POST
    headers:
      accept: 'application/json, text/html'
      user-agent: 'Mozilla/5.0 {{ useragent }}'
    payload: '{	"command":"componentstate", "componentstate": { "component":"VIDEOGRABBER", "state": {{ state }} } }'
    content_type:  'application/json; charset=utf-8'
  hyperhdr_led_device:
    url: http://192.168.28.64:8090/json-rpc
    method: POST
    headers:
      accept: 'application/json, text/html'
      user-agent: 'Mozilla/5.0 {{ useragent }}'
    payload: '{	"command":"componentstate", "componentstate": { "component":"LEDDEVICE", "state": {{ state }} } }'
    content_type:  'application/json; charset=utf-8'

And then in my automation:

automation:
  - alias: 'TV power over 60W turn on Ambilight'
    id: 'tv_power_over_60W_turn_on_ambilight'
    trigger:
      - platform: template
        value_template: >-
          {{ states('sensor.blitz_socket_sony_energy_power') | int > 60 and is_state('media_player.chromecast_audio', 'off') }}
    action:
      # Prižgi USB capture
      - service: rest_command.hyperhdr_usb_capture
        data: {state: "true"}
      # Prižgi LED okrog TV
      - service: rest_command.hyperhdr_led_device
        data: {state: "true"}

Now to test how is CPU usage on my RPi Zero W. It was just under 100% when USB grabber was on. I think I need better Raspberry Pi for running HyperHDR.

Great job @mjoshd ! Although I don’t use HA I’ve managed to install it to test the plugin on my backup Rpi and seems it works fine for my basic configuration 👍 I will mention about your project in readme.md and in next release info.

To all concerned, I’ve found the cause of the issue, it is due to the JSON returned from sysinfo command http://192.168.1.72:8090/json-rpc?request={“command”:“sysinfo”}. The key returned for the id is info.hyperhdr.id whereas the HA integration relies on dermotduffy/hyperion-py which looks for info.hyperion.id as can be seen in the code at line 1471 in client.py: sysinfo_id = ( sysinfo.get(const.KEY_INFO, {}) .get(const.KEY_HYPERION, {}) .get(const.KEY_ID, None) and const.py defines KEY_HYPERION as: KEY_HYPERION = "hyperion"

It would be great if someone more knowledgable than I could merge dermotduffy’s code and the HA Hyperion integration into a new HyperHDR integration, I’d certainly help where I could.

Hi, I found a fairly easy way to resolve by modifying line 402 of config_flow.py in the usr/src/homeassistant/homeassistant/components/hyperion folder in my docker container:

Change: hyperion_id = await hyperion_client.async_sysinfo_id() To: hyperion_id= "your_serial_no"

Serial no obtained from description.xml file as described above.

Until an update resolves this, it will need changed on every homeassistant installation update though.

I’d love to be able to do a HyperHDR integration but I’m just not that experienced, I don’t understand most of the code tbh.

EDIT: I managed to understand it enough to edit the code to add the switch entity for HDR Mode though!

@awawa-dev Thanks for this latest version, managed to get HDR Mode to switch automatically when using Plex 😃

For what it’s worth, I set up a new sdcard (rpi4, aarch64) and only had to uncheck “Classic HyperHDR calibration” on the ‘Image Processing’ & ‘Remote Control’ pages to get back the standard ‘Brightness’ percentage (instead of ‘Luminance’) and now it seems to work perfectly well with the existing HA Hyperion NG integration.

Is there any down-side to disabling “Classic” calibration?

I had to implement my own toggle for enabling/disabling HDR Tone Mapping but that was pretty easy thanks to the new JSON API playground.

Perhaps some day someone will consider making a proper HyperHDR integration for HA… who knows, Hacktoberfest is coming.

HyperHDR is really amazing and blows Hyperion out of the water!

Thanks! @awawa-dev

Hi It’s not broken but no longer compatible with Hyperion NG plugin. Still you can use HyperHDR’s JSON API (now it is even extended with new features compared to Hyperion one) to send commands. For most of them you can use new JSON wizard (‘advanced’ tab) to create them for you: probably link ‘All instances (Global)’ could work here.