Use with Airzone Localapi

[Mike-de-bike]

Hello,

I have got a AIRZONE AZX6WEBSCLOUDC (ethernet version) installed, airzone-Cloud working fine.
On a server runs homeassistant (HA) inside docker container.
Airzone Azx6... is reachable via tcp 3000, not via 5020.
Question:
Do I have to place a computer as a gateway with a usb to ethnernet cable for modbus connection in front of it, so that HA is able to connect to the airzone device? HA -> i.e. raspi -> airzone device.

Regards
Stefan

[gpulido]

Hello Stefan,
Currently this module works with the python-airzone library that uses the modbus connection through a serial->usb cable.
You can use a raspi zero connected to the airzone device through modbus and use a "bridge" to expose to modbus-tcp using something like https://gist.github.com/gpulido/e3518ff90396ae6d4cd186fd41c9a2d1
However, if you have any integration document to use the tcp 3000 port I can take a look and try to adapt the module.
Also at this moment the AZ6 version is not compatible with the python-airzone, it is a work in progress at this moment:
gpulido/python-airzone#2

[Mike-de-bike]

Hello Gabriel,

Please have a look at these documents.

MI_AZ6_WSCLAPI_A4_EN.pdf
MI_AZ6_WSCLAPI_A4_ES.pdf

[gpulido]

Hello Mike,
The good news are that with that integration, you don't need the modbus interface, the local api can be used to retrieve the information.
The bad news are that modifications with the "python-airzone" library has to be done to be able to read from the api instead from modbus.
It can be done, and it is not hard, but needs time.

[Mike-de-bike]

Gabriel,
Thanks for reviewing it.
I would appreciate it with open arms, if you can handle that integration as a feature request.
😀 👍
Regards
Stefan

[hopsor]

Hi, I've been following this repo for some time. I wanted to add wifi control to my Daikin with Aidoo and manage it through homeassistant, however the modbus thingy was too much for me. Recently I discovered this twitter thread which basically confirms local API is available for Aidoo so I decided to get one. However, after successfully installing it I wasn't able to make any requests to the local API.

This morning I got a call from the airzone customer support and they confirmed me the Aidoo device doesn't have the local API feature, the tweet was wrong. However, they told me they are about to release an Aidoo Pro version which will definitely have it. I've been told I'll get a pro replacement as soon as they have them available.

Once I have it and I will be able to live test. So in case no one else has already done it I could contribute to the python-airzone library with the local api integration.

[gpulido]

Hello @hopsor,
Any help is welcome!, at this moment I'm the only developer without a lot of free time (looking for a job at this moment :( ) but I'm a believer in Open Source, and if we can expand and improve the ha component and the python-airzone library to cover more kinds of integrations it would be awesome.

Just a comment regarding the aido and local API, I don't know how much does it cost to have it, but the modbus integration is really really cheap and easy to made: one raspberrypi Zero W (10€) one microsd (smallest posible) 5€, usb-rs485 (5€) and a mobile charger: Total 25€ tops. And the code that has to run on it is very easy: https://gist.github.com/gpulido/e3518ff90396ae6d4cd186fd41c9a2d1

If I had time I would create a sd image with it running using balenaos or something similar, but really it is just install a raspbian lite, and set a couple of files and thats it...
I would try to create a manual..
BTW: I have been working with another Aidoo owner to make it work in its installation so it is become more stable...
Let me know if you need more info.

[hopsor]

Hi @gpulido,

Thank you very much for offering your help with Aidoo modbus setup. The reason I was hesitating doing it this way was to keep it as simple as possible. Right now I have too many powered devices at home and I have 2 air conditioner machines. So following this approach will mean using 2x Aidoo + 2x RPi Zero W. With Aidoo + Local API it's just 2 devices connected to each x35a port of the HVAC without the need of connecting anything to a regular power socket.

In any case, I appreciate a lot your help and I will definitely consider it if in 2-3 months I'm not able to get my Aidoo Pro with the Local API. They told me they will send this replacement without incurring any costs so I'll keep my fingers crossed :-D

Regarding helping with Local API integration in python-airzone, I'm looking forward to it. One of the reasons to get the Aidoo was to contribute with something to this community. From time to time (when I can find it) I like to do open source and this was a good opportunity to do so. Also if I can help with officially releasing this integration let me know. I'm totally new to HA development but I enjoy learning new things.

I'll keep you posted if I get any news of the Aidoo pro

[Mike-de-bike]

Hello Gabriel,
the API is working fine on version 3.3.4 of webserver.
I will try to create an appropriate class for querying the local api. Do you have remarks and hints for me in implementing it in your python-airzone lib?

Regards
Stefan

[gpulido]

That's great!
Although I will need to make modifications to the Python airzone to be able to select between modbus and local API and use the same wrapper so it can be used directly on HA, the first step for you couk be just create a python module (file) that accepts the host configuration and retrieves the state as a python dictionary. Probably using the request library. With that part it would be very easy for me to adapt the python-airzone to use it.
But that only solve the airzone-> ha.
Then you can play yo be able to change things like the HVAC mode or the target tempertature using the local API. Again probably with a request and a post. You need to manage conversions and errors.
What.do you think?
If you can do it as a python module it would be amazing.
Please open an issue in python-airzone "integrate local API" for tracking an make a fork so we can track the changes.
This weekend I'm not going to be able to code. It on Monday I will help.
Thank you!!!

[Mike-de-bike]

Hello Gabriel,

Good plan! Next days I will start working on it, when the time allows me to code. Python is my favorite programming language, so I am happy to be part of your amazing project. 👍
First of all I will start with the POST request like you have written.
Greetings
Stefan

[jd1900]

Very interested in this, as I have the same version as @Mike-de-bike

[gpulido]

Now the python-airzone localapi implementation is done (version 0.8.0) the next step is to use it in this component.

[gpulido]

@Mike-de-bike A new localapi branch has been created. It is ready for being tested as component.
Would you mind give it a try?

[Mike-de-bike]

@gpulido
Hello Gabriel!
I have installed python-airzone 0.8, here is my test result:

stefan@klapperkiste:~$ airzone_cli.py --help
usage: airzone [-h] [-v] [--machine MACHINE]
[--system {innobus,aido,localapi}] [--state {str,raw}]
address port

positional arguments:
address serial device or ip address for localapi
port serial tcp port or http port for localapi

optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
--machine MACHINE Machine number where connect
--system {innobus,aido,localapi}
Type of Airzone System
--state {str,raw} Get the formatted state, or the raw machine state
stefan@klapperkiste:$ airzone_cli.py -v
airzone 0.8.0
stefan@klapperkiste:$ airzone_cli.py --system localapi --machine 1 192.168.90.9 3000
Traceback (most recent call last):
File "/usr/local/bin/airzone_cli.py", line 34, in
args.func(args)
File "/usr/local/bin/airzone_cli.py", line 16, in action
m = airzone.airzone_factory(args.address, args.port, args.machine, args.system)
File "/usr/local/lib/python3.7/dist-packages/airzone/init.py", line 8, in airzone_factory
m = Machine(address, port, machineId)
File "/usr/local/lib/python3.7/dist-packages/airzone/localapi.py", line 51, in init
self._retrieve_system_data()
File "/usr/local/lib/python3.7/dist-packages/airzone/localapi.py", line 88, in _retrieve_system_data
self.handle_response(response)
AttributeError: 'Machine' object has no attribute 'handle_response'

Regards

Stefan