thermotec-aeroflow-flexismart

Python Library to communicate with the Thermotec AeroFlow® FlexiSmart Gateway

Note

This project does not run standalone, just provides an API to interact with the Flexismart Gateway.

• If you just want to control your Heaters, please visit my other Project (HASSIO Addon): thermotec_aeroflow
• If you want to build a new Integration and need a library to control the heaters, this is the Project you could work with
• If you want to fix communication issues or exted the featureset, this is the Project you could work with

Disclaimer:

This is completely a private / community project and is NOT related to the Company Thermotec AG in any way!
Use this Library / Client on your own risk. I am NOT responsible for any damage, data loss, error or malfunction!

Why this Project

When I got my Thermotec AeroFlow® heater, I was quite pleased by the product, but I figured out that the FlexiSmart Gateway module was not quite "smart" (at least not in the way I would think of "smart").

Why do I think it's not smart? There are only 2 ways of communication with the Gateway:

• The APP for the SmartPhone (Android / iOS)
• Alexa Skill

There are some nice features already build into the Heater itself. Like automatic window open detection.

BUT I have Door / Window sensors at every Door / Window, so I would like to directly control the heater and stop heating as long as the window(s) are open.

Or I want to go automatically in the anti freeze mode if I'm not in the area of my house.

There are many many many reasons why I want an API / Client / Direct way to communicate with the Gateway / Heater directly from my own network.

My Setup is based on HASS (Home Assistant), so I created this library / client project as a dependency for the hassio-integration.

Features

• All* functions which are available in the APP

  • Programming is currently not implemented

• Temperature

  • Read Current Temperature
  • Read Target Temperature
  • Set Target Temperature

• Window Open Detection

  • Read current Status
  • Enable / Disable

• Anti-Freeze

  • Read current value
  • Set target Temperature

• Smart-Start

  • Read current status
  • Enable / Disable

• Temperature Offset

  • Read current value
  • Set value

• Holiday Mode

  • Read Current setting
  • Enable / Disable

• Boost

  • Read if Boost is active
  • Set Boost

• Restart

  • Restart the Heater

• Register Heater

• Zone

  • List Zones
  • With Heater Count
  • Add Zone
  • Delete Zone (delete heaters in zone)

• Get Heater Firmware information

• Gateway Information

  • Read Network settings
  • Date / Time
  • Read
  • Update
  • Read Firmware
  • Read Installation Information
  • Read external Severer endpoints

• Ping

  • Custom implementation to see if the Gateway is available

Most Features are available for the whole Zone or for a specific Heater independently

Special features (which are not available in the APP)

• Control each Heater independently or the whole Zone
  • specific Heater works even if in a zone with multiple Heaters
• Enable Boost

How to use

You need the IP address of your Gateway

• Use the APP (If you have the APP and you are in your local Network)
  • Open the APP -> Click on Configuration / Information
  • There you have your IP
• Use your Router / DHCP Server to find the IP

Require this Repository in your Project and use the Commands defined in the commands class

Provide the IP to the function If your Port is different from the default (6653), you can specify the port next to the ip in the function parameter

How does it work / Restrictions

• Communication via UDP
• Direct communication in the Local Network
• Internet is not necessary
  • I personally have blocked the Gateway from accessing the Internet
• Complete Async approach
• Commands are build as functions to make it easy to use
• APP etc. still works
  • no side effects of using this project beside the official App
  • there might be more "sync" requests in the app, e.g. if you change zones

ToDo

• add command for Programing
• add some more DTOs for some objects
• add limits to some commands
  • max temperature, etc.

Known issues

• FlexiSmart Gateway: Subnet is always 255.255.255.0. It does NOT respect the DHCP information
  • This is unrelated to this Project, but maybe interesting to know

Note

This Project is Licenced under the GPL v3. This decision was made to keep this Project and any improvements Open Source.

Any Trademark, Name or Product is only referenced, but this project does not hold any of these.

• AeroFlow® is the Registered Trademark by Thermotec AG
• Thermotec AG is the Name of the Company behind the Heater and the Gateway
• FlexiSmart is the Product Type / Line of the Gateway / Heater