Add support for energy sensor on S31 #4

boojew · 2019-02-03T22:04:01Z

Requires insertjokehere/python-hassdevice#1

Add support for S31 Sensor

boojew · 2019-02-04T05:16:56Z

Hmm. Found a bug in which the switch doesn’t always respond to MQTT commands. I’ll fix this during the week

boojew · 2019-02-06T02:56:05Z

Ok so I checked closer and my PR didnt cause instability with Homemate.. My test box did ;) It's all good now. One thing to note is that I rarely see energy update events on the "wire"; however, when the homemate app is open, it seems to send one every few seconds .- so my guess is that there is a cmd to send to tell it to send them; however, I can't get the stream_decode.py to work. I have the 16 character key, but I always get the complaint about the keysize.. any feedback?

bens-MBP:research babecassis$ python3 stream_decode.py mobile 
Switch sends
Magic: b'hd'
Length: 186 (True)
Type: b'pk'
CRC32: (2406255143, 2406255143, True)
id: b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
Traceback (most recent call last):
  File "stream_decode.py", line 70, in <module>
    print(crypto(v))
  File "stream_decode.py", line 34, in crypto
    algorithms.AES(keys[payload[4]]),
  File "/usr/local/lib/python3.7/site-packages/cryptography/hazmat/primitives/ciphers/algorithms.py", line 30, in __init__
    self.key = _verify_key_size(self, key)
  File "/usr/local/lib/python3.7/site-packages/cryptography/hazmat/primitives/ciphers/algorithms.py", line 17, in _verify_key_size
    len(key) * 8, algorithm.name
ValueError: Invalid key size (136) for AES.

insertjokehere · 2019-02-07T04:03:26Z

At a guess, you've either got a trailing new line character at the end of the orvibo.key file, or you've written the base64 encoded version rather than the raw bytes.

Try something like: echo -n kh..... > orvibo.key

insertjokehere

Left some notes; generally, good job understanding my code! I know its a bit of a mess

insertjokehere · 2019-02-07T04:05:04Z

src/homemate_bridge/cli.py

-        # Close the connection if the switch doesn't send anything in 30 minutes
-        # See !1
-        self.request.settimeout(60 * 30)
-


Why remove this block?

I wish I had a good reason.. Adding it back in.

insertjokehere · 2019-02-07T04:07:22Z

src/homemate_bridge/cli.py

-            if 'name' not in self.settings:
-                self.settings['name'] = "Homemate Switch " + localip
-
-            logger.debug("Device settings: {}".format(self.settings))


Why remove? This is important for my use-case; as I run my bridge in a Kubernetes cluster, so the connections to the bridge are NATed, and appear to all come from the same IP. I use the IP that the device itself reports as an ID so I can tell them apart

insertjokehere · 2019-02-07T04:07:44Z

src/homemate_bridge/cli.py

    def format_response(self, packet, response_payload):
        response_payload['cmd'] = packet.json_payload['cmd']
        response_payload['serial'] = packet.json_payload['serial']
        response_payload['status'] = 0

+        # if 'energy' in packet.json_payload:        
+        #response_payload['energy'] = packet.json_payload['energy']


Remove this

insertjokehere · 2019-02-07T04:09:09Z

src/homemate_bridge/cli.py

@@ -300,16 +305,19 @@ def handle(self):
                self._mqtt_switch = HomemateSwitch(
                    self,
                    name=self.settings['name'],
-                    entity_id=self.entity_id
+                    entity_id=self.client_address[0].replace('.', '_')


Revert this

insertjokehere · 2019-02-07T04:09:24Z

src/homemate_bridge/cli.py

+            if self._mqtt_sensor is None:
+                self._mqtt_sensor = HomematePowerSensor(self,
+                    name=self.settings['name'],
+                    entity_id=self.client_address[0].replace('.', '_')


Use self.entity_id

insertjokehere · 2019-02-07T04:10:30Z

src/homemate_bridge/cli.py

    @property
    def cmd_handlers(self):
        return {
            0: self.handle_hello,
            32: self.handle_heartbeat,
            42: self.handle_state_update,
-            6: self.handle_handshake
-        }


Device handshakes need an ACK at the minimum otherwise they disconnect after awhile

insertjokehere · 2019-02-07T04:11:05Z

src/homemate_bridge/cli.py


        return self.handle_default(packet)

+    def handle_energy_update(self, packet):
+        if 'energy' in packet.json_payload:
+            self.energy = packet.json_payload['energy']


Why track the current energy reading as an instance variable?

I just thought it was a bit cleaner... any reason not too?

boojew · 2019-02-10T13:19:31Z

Thanks! I will clean this all up and try again soon!

boojew · 2019-02-11T02:56:46Z

For the key, I get b'khggd54865.....' w/o a new line at the end... I have tried it in that format and without the b''.. No luck. W/o the b'' it is 16 alphanumerics.

Oh and to get the key, I'm doing
python3 find_key.py kepler.apk > orvibo.key

boojew · 2019-02-16T23:45:07Z

@insertjokehere - any idea about the key?

insertjokehere · 2019-02-17T01:22:37Z

@boojew I've updated stream_decode.py to accept a keys file in the same format as the main application; give that a go?

boojew · 2019-02-17T19:04:44Z

No love...

root@skywarp:/tmp/homemate-bridge/research# python3 stream_decode.py stream.yaml
Traceback (most recent call last):
  File "stream_decode.py", line 14, in <module>
    int(k): base64.b64decode(v) for k, v in json.load(f)
  File "stream_decode.py", line 14, in <dictcomp>
    int(k): base64.b64decode(v) for k, v in json.load(f)
ValueError: too many values to unpack (expected 2)

Keys.json looks like this: {"112": "a2hnZ2Q1NDg2N<redactedbits>"}

I should also mention, stream.yaml is your example file - not one I generated. In case you have 5 minutes, I'm also including my pcap in case you could decode and put in back here - just so I can continue testing the energy capture. Thanks!

s31.txt

insertjokehere · 2019-02-18T21:13:39Z

I've updated stream_decode.py again (missed .items()) - it should work now. The decoded version of you capture is attached

s31_decoded.txt

mssmison · 2019-02-18T22:17:06Z

Looks like it's cmd 128 that tells the switch to respond with the power related stuff.
Is there a way to send that command as the heartbeat I guess?

Get power output

boojew · 2019-03-12T02:53:44Z

I was able to get this to work. I have commited some code in https://github.com/boojew/homemate-bridge/blob/master/src/homemate_bridge/cli.py and I will tune it over the next few days.

If anyone wants to try it, check out https://hub.docker.com/r/boojew/homemate-bridge. Be sure to pass the pass the keyfile as a volume or env and pass the host as the env variable MQTT_HOST

mkormendy · 2019-05-27T23:38:06Z

@boojew hows the tuning going?

mkormendy · 2019-05-28T02:40:48Z

@boojew I'm getting this error when I attempt to use your fork of this plugin:

Traceback (most recent call last):
  File "/usr/local/bin/homemate-bridge", line 11, in <module>
    load_entry_point('homemate-bridge', 'console_scripts', 'homemate-bridge')()
  File "/usr/local/lib/python3.7/site-packages/pkg_resources/__init__.py", line 489, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "/usr/local/lib/python3.7/site-packages/pkg_resources/__init__.py", line 2793, in load_entry_point
    return ep.load()
  File "/usr/local/lib/python3.7/site-packages/pkg_resources/__init__.py", line 2411, in load
    return self.resolve()
  File "/usr/local/lib/python3.7/site-packages/pkg_resources/__init__.py", line 2417, in resolve
    module = __import__(self.module_name, fromlist=['__name__'], level=0)
  File "/██████████/homemate-bridge/src/homemate_bridge/cli.py", line 18, in <module>
    from hassdevice.devices import Switch, Sensor
ImportError: cannot import name 'Sensor' from 'hassdevice.devices'

mike391 · 2021-09-30T21:12:28Z

what units is the energy variable in? Kwh?

Eamourinho · 2024-06-13T18:40:07Z

I know this is ancient, but I just picked up a bunch of S31 switches and was hoping to get 'em integrated into my home assistant instance. Got my MQTT broker running in home assistant, and am able to connect to it from other devices on the network. Got my "PK" encryption key from the kepler.apk. Set up a simple docker-compose in my portainer instance:

version: "3"
services:
  ###########################
  # Homemate to MQTT bridge for S31 Orvibo Switches
  # Fork of https://github.com/insertjokehere/homemate-bridge
  ###########################
  homemate-bridge:
    image: boojew/homemate-bridge
    volumes:
      - /docker/mountpoints/homematebridge/keys.json:/config/keys.json
    environment:
      - MQTT_HOST="192.168.0.115"

But unfortunately I'm getting this error:
socket.gaierror: [Errno -2] Name or service not known

Any ideas what might be going awry here? ':D

I'm able to ping the MQTT broker from other containers within my portainer instance so it should be able to see the 0.115 IP... are there other environment variables I'm missing here? I've got an account configured in home assistant to access the MQTT broker, how would I go about configuring that for this bridge?

insertjokehere · 2024-06-26T03:34:38Z

@Eamourinho - wow, I'm glad that people are still finding this useful.

I don't really remember how any of this works, but two guesses:

Paho (the library that we use to connect to MQTT servers) is treating the IP address as a host name and trying to look it up for some reason - if the stack trace points you towards paho.mqtt.client then its probably something like that; not sure how you'd approach solving it
Something to do with your container environment not allowing the script to bind to 0.0.0.0 to listen for connections from the switches. I'd suggest adding network_mode: "host" to your compose file and seeing if that does something

While I'm here, @boojew sorry you got such a terse code review back in the day, thanks for putting in the effort to put your changes up for others to use.

boojew added 2 commits February 3, 2019 17:00

Update cli.py

889d3ac

Merge pull request #1 from boojew/dev

4d515bf

Add support for S31 Sensor

insertjokehere reviewed Feb 7, 2019

View reviewed changes

Update cli.py

67a2f2e

Get power output

boojew added 4 commits March 11, 2019 23:02

Update requirements.txt

a5ef4e2

Update cli.py

c3572b5

Update cli.py

4ba79a0

Update cli.py

cb466e6

mkormendy mentioned this pull request May 28, 2019

Works with the S31! #3

Open

boojew added 5 commits June 9, 2019 23:18

Update cli.py

459d6e4

Update requirements.txt

b947303

Update cli.py

8a8fbc0

Update cli.py

67adced

Update cli.py

2aaed2d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for energy sensor on S31 #4

Add support for energy sensor on S31 #4

boojew commented Feb 3, 2019

boojew commented Feb 4, 2019

boojew commented Feb 6, 2019

insertjokehere commented Feb 7, 2019

insertjokehere left a comment

insertjokehere Feb 7, 2019

boojew Feb 19, 2019

insertjokehere Feb 7, 2019

boojew Feb 19, 2019

insertjokehere Feb 7, 2019

boojew Feb 19, 2019

insertjokehere Feb 7, 2019

boojew Feb 19, 2019

insertjokehere Feb 7, 2019

insertjokehere Feb 7, 2019

boojew Feb 19, 2019

insertjokehere Feb 7, 2019

boojew Feb 19, 2019

boojew commented Feb 10, 2019

boojew commented Feb 11, 2019 •

edited

Loading

boojew commented Feb 16, 2019

insertjokehere commented Feb 17, 2019

boojew commented Feb 17, 2019 •

edited

Loading

insertjokehere commented Feb 18, 2019

mssmison commented Feb 18, 2019

boojew commented Mar 12, 2019 •

edited

Loading

mkormendy commented May 27, 2019

mkormendy commented May 28, 2019 •

edited

Loading

mike391 commented Sep 30, 2021

Eamourinho commented Jun 13, 2024

insertjokehere commented Jun 26, 2024

Add support for energy sensor on S31 #4

Are you sure you want to change the base?

Add support for energy sensor on S31 #4

Conversation

boojew commented Feb 3, 2019

boojew commented Feb 4, 2019

boojew commented Feb 6, 2019

insertjokehere commented Feb 7, 2019

insertjokehere left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boojew commented Feb 10, 2019

boojew commented Feb 11, 2019 • edited Loading

boojew commented Feb 16, 2019

insertjokehere commented Feb 17, 2019

boojew commented Feb 17, 2019 • edited Loading

insertjokehere commented Feb 18, 2019

mssmison commented Feb 18, 2019

boojew commented Mar 12, 2019 • edited Loading

mkormendy commented May 27, 2019

mkormendy commented May 28, 2019 • edited Loading

mike391 commented Sep 30, 2021

Eamourinho commented Jun 13, 2024

insertjokehere commented Jun 26, 2024

boojew commented Feb 11, 2019 •

edited

Loading

boojew commented Feb 17, 2019 •

edited

Loading

boojew commented Mar 12, 2019 •

edited

Loading

mkormendy commented May 28, 2019 •

edited

Loading