ha-hildebrandglow icon indicating copy to clipboard operation
ha-hildebrandglow copied to clipboard

Published 20 hours ago • verified publisher icon unlobito

Migrate to MQTT from HTTPS polling

Open unlobito opened this issue 4 years ago • 3 comments

The integration currently uses HTTPS polling to retrieve data from the CAD, but it'd be beneficial to use mqtt for real-time data instead.

This PR will cover implementing this in various stages:

  • [x] Use Bright appID rather than public appID (closes #15)
  • [x] Extend Glow bindings to implement the /api/v0-1/device endpoint for ZigBee device discovery
  • [x] Discover the Zigbee Glow Stick hardwareId for MQTT topic setup (SMART/HILD/$hardwareId)
  • [x] Migrate HTTPS sensors to MQTT (closes #14)
    • [x] Current electricity usage
    • [x] Last reported gas usage (closes #10)
  • [ ] Extend with more sensors from MQTT data (closes #12, #13)
    • [ ] Investigate available data fields
  • [~] ~Create services for historical usage reads~

unlobito avatar Aug 12 '20 20:08 unlobito

I think next up is refactoring Glow's constructor to accept the username/password from the restored ConfigEntry rather than a session token. Once the object has instance variables for the credentials, these can be used to calculate the MQTT connection URI (rather than the currently hardcoded USER:PASS).

Locally, this PR currently causes my HomeAssistant instance to console print the JSON messages received over MQTT (but the individual sensors report unavailable).

unlobito avatar May 16 '21 22:05 unlobito

Very rough on the edges, but we now have instantaneous electricity consumption being routed to an electricity sensor after MQTT autodiscovery.

imagen

MQTTPayload is heavily based on https://gist.github.com/ndfred/b373eeafc4f5b0870c1b8857041289a9, but I'd like to rewrite this to use a Colander schema instead of the if ... else None catches.

Afterwords, I'd like to route messages to sensors on a more unique key than the resource classifier (e.g. "electricity.consumption") so gas meters can be supported.

unlobito avatar May 17 '21 13:05 unlobito

Today:

  • Attempted rewriting MQTTPayload in Colander but was unable to transparently rename the JSON key names (see stackoverflow/17975416)
  • Built out MQTTPayload with manual payload mapping
  • untested: attempted gas meter integration

I don't have a gas supply at home, so I'm eagerly looking for feedback on the gas readings added in 71af3ba. I've released this branch so far as https://github.com/unlobito/ha-hildebrandglow/releases/tag/0.1.0-beta for easier installation through HACS.

Next, will look into exposing more of the MQTT data as separate sensors so this PR can be released (services shouldn't hold this back).

unlobito avatar May 17 '21 21:05 unlobito