Wifi thermostat (Beok, Floureon, Beca Energy) component

Emmanuel · March 28, 2018, 4:03pm

Hello,

I have started programming a custom component for the wifi thermostats above (heating only).

I am struggling to get the component to work (the standalone python code works although it could probably be improved!).

In a nutshell, I add the component in custom_components/climate/ and add the following in configuration.yaml

climate:
platform: wifithermostat
api_key: product_id_key_goes_here

I do not see any error messages or any debug messages in the log. Home Assistant does not seem to load the component and blocks the loading of all the other climate components (e.g. Nest), which makes me think there is something broken in the code :-/

Any help would be appreciated, this is my first component!

github.com

EmmanuelLM/WifiThermostat/blob/master/wifithermostat.py

"""
Support for Chinese wifi thermostats (Floureon, Beok, Beca Energy)

configuration.yaml
climate:
  - platform: wifithermostat
    api_key: xxxxx
"""

import socket, logging, binascii


_LOGGER = logging.getLogger(__name__)


from homeassistant.components.climate import (ClimateDevice, SUPPORT_TARGET_TEMPERATURE, SUPPORT_ON_OFF)
from homeassistant.const import TEMP_CELSIUS, ATTR_TEMPERATURE
from homeassistant.helpers.discovery import load_platform

DOMAIN = 'wifithermostat'

This file has been truncated. show original

Emmanuel · March 29, 2018, 1:13pm

Right, after a bit of tweaking and tinkering, the component now works!
Latest version is at the GitHub location.

infinitecool · April 11, 2018, 6:02am

awesome, does home assistant find the device automatically?
why is this ip address hardcoded in your code? “self.HOST = ‘59.110.30.249’” or do you need to change this in the code to the actual ip address of the thermostat in a network?

Emmanuel · April 11, 2018, 7:11am

Hello,

The module communicates with the bestbeca.cn (ip: 59.110.30.249) where your thermostat is registered i.e. it does not communicate with the thermostat directly.

You need to register the thermostat first using the official app.

Once the module is in custom_components/climate/ just update your configuration.yaml to include:

climate:

platform: wifithermostat
name: name_goes_here
api_key: xxxxx [<— this is the product id you will find on the label on the thermostat]

Finally, please make sure you use the latest code from github!

Michal_Ciemiega · April 11, 2018, 3:16pm

Hi

thanks for the component. I wanted to test it but im not sure from where should I get api_key. I don’t see any numbers on the device.

Emmanuel · April 11, 2018, 4:22pm

Hi, not sure I can be of help, but this is what mine looked like (the ‘api_key’ is under the blackened area):

Michal_Ciemiega · April 11, 2018, 4:53pm

I’ve got BEOK and looks very similar, its missing that ID sticker. I guess I need to extract it somehow. I can try to take a look at wifi communication to find it. Now Im wondering, if authentication is based only on ID, that means bruteforcing ID ( how long is it and what format ? ) we could control someones thermostat ?

typeonegative · April 11, 2018, 4:58pm

i have Floureon and no sticker

Emmanuel · April 11, 2018, 6:08pm

Yes, using a TCP sniffer, it is quite easy to snif the encrypted ID and reverse it.

Also agree with you on your second point, not the most secure…

Michal_Ciemiega · April 11, 2018, 6:29pm

Can you post format of that key ? I’m not sure what to look for, how long it is and is it only digits / hex or … ? I’ve dumped data from app and deserialized it. I got field called key with some md5 data and field called password with 6 digits but doesn’t seem to work when I test it with your component.

File “/config/custom_components/climate/wifithermostat.py”, line 196, in current_temperature
self._device.read_status()
File “/config/custom_components/climate/wifithermostat.py”, line 128, in read_status
data = bytearray.fromhex(hex(self.id_effect)[2:])
ValueError: non-hexadecimal number found in fromhex() arg at position 9

Emmanuel · April 11, 2018, 7:14pm

Hi, for me it is a 5 digit integer i.e. 00000 - I understand that’s the common format.

infinitecool · April 13, 2018, 3:13am

I also got one yesterday, and don’t have a sticker with ID on it perhaps it is easy for you to sniff the encrypted id and reverse it, for me it isn’t lol, I’m using currently this method to integrate it in hass: https://community.openhab.org/t/electronic-heating-thermostat-reverse-engineering-beok-floureon-decdeal/39251/6
because without the ID, your method is not working unfortunately, I would rather use your method.
since the method on the openhab forum is also written in python, can’t the method without needing the ID not be integrated into your code, they are both written in python

Emmanuel · April 13, 2018, 1:21pm

Hi, I did see this as well but the python involved there is beyond my capabilities I’m afraid…
To sniff the packets, I am using the “Packet Capture” app.

Once your thermostat is installed and configured with your app, you can use “Packet Capture” to see the traffic from the app.

You should see one of the packets being repeated often, which is your encrypted key in hex. You can then use the windows calculator to convert into decimal and the formula in the python code to reverse your product id.

Sounds simple

typeonegative · April 13, 2018, 5:32pm

this sounds like real nasa science i think i have packet, but how can i get id from there? “windows calculator” - what is this? sorry for stupid questions…

Emmanuel · April 13, 2018, 5:47pm

Right, if you have the packet in hexadecimal, you can google “hexadecimal to decimal” and you will find a free calculator to convert your packet into decimal.

Next, use this formula:
(encrypted ID - 65535) / 65535 - 1 = Product ID

clementTal · July 21, 2018, 12:33am

I’ve made a platforme for this thermostat: https://github.com/home-assistant/home-assistant/pull/15363
The PR is still pending, but it work for me

This platform do not require any ID, and is not based on the thermostat internet connexion (works localy).

Hope you’ll like it

Emmanuel · July 21, 2018, 1:03pm

Exciting!!! Much better than my version as I like the non-dependence on the remote servers!

I saw you have an issue with Google assistant, which I managed to solve with mine (see here: Custom components integration with Google Assistant). If I manage to make it work with your code, I’ll send a commit.

typeonegative · July 23, 2018, 11:35pm

sorry, but how can i use this?

Emmanuel · July 24, 2018, 5:11pm

I gave this a spin last night and connections to the thermostat timed out… not too sure what the problem is… I do however wonder whether the model I have is different and the API doc is wrong. That would also explain why @typeonegative cannot get my module to work.

clementTal · July 25, 2018, 7:11am

@Emmanuel: Have you tried to use the broadlink.discover() function, using the broadlink API ? (not in HA, on a python terminal) ? I think I’ll update my code using this methode, but I’m running out of time this summer
And I fixed the google assistant issue yesterday !

@typeonegative: You have to create a custom_components/climate folder, on the HA config folder, and put the broadlink thermostat code on it, then add this to your configuration file:
climate:
- platform: broadlink
name: Thermostat
mac: “xx:xx:xx:xx:xx”
host: “xxx.xxx.xxx.xxx”
Finaly restart your HA instance, and you’ll be done