airtouch3 0.9

API for the monitoring and control of a HVAC unit branded Polyaire Airtouch 3 over a local network

Airtouch 3 Python API

Api for the monitoring and control of a HVAC unit branded Polyaire Airtouch 3. https://www.polyaire.com.au/about-us/news/airtouch-version-3-now-available/

API Definition

General Usage

To initialise:
at3 = AirTouch3("192.168.1.1")

To read status from unit, return true if succesful, otherwise false:
at3.UpdateStatus();

Air Touch Object

at3.name
at3.id
at3.comms_status
at3.comms_error
at3.groups
at3.ac_units
at3.sensors
at3.update_status()
at3.print_status()

Group Functions (aka Zones in most other systems)

at3.toggle_group(group_id)
at3.toggle_position_group(group_id, direction)

Group Objects

at3.groups[group_id].number
at3.groups[group_id].name
at3.groups[group_id].is_on
at3.groups[group_id].mode
at3.groups[group_id].open_percent
at3.groups[group_id].temperature
at3.groups[group_id].tempeature_sp
at3.groups[group_id].toggle()
at3.groups[group_id].position_dec()
at3.groups[group_id].position_inc()

AC Unit Functions

at3.toogle_ac_unit(unit_id)
at3.toggle_temperature_ac_unit(unit_id, direction:AT3Command) at3.set_fan_speed_ac_unit(unit_id, speed:AT3AcFanSpeed) at3.set_mode_ac_unit(unit_id, mode:AT3AcMode)

AC Unit Objects

at3.acUnits[unit_id].number
at3.acUnits[unit_id].is_on
at3.acUnits[unit_id].has_error
at3.acUnits[unit_id].mode
at3.acUnits[unit_id].brand
at3.acUnits[unit_id].fan_speed
at3.acUnits[unit_id].temperature
at3.acUnits[unit_id].temperature_sp
at3.acUnits[unit_id].toggle()
at3.acUnits[unit_id].temperature_inc()
at3.acUnits[unit_id].temperature_dec()
at3.acUnits[unit_id].set_fan_speed(speed:AT3AcFanSpeed)
at3.acUnits[unit_id].set_mode(mode:AT3AcMode)

AC Sensor Objects

at3.sensors[sensor_name].name
at3.sensors[sensor_name].temperature
at3.sensors[sensor_name].low_battery

Simple Example

from airtouch3 import AT3CommsStatus
from airtouch3 import AT3Command
from airtouch3.airtouch3 import AT3AcFanSpeed

at3 = AirTouch3('192.168.1.72')
at3.update_status()

if at3.comms_status != AT3CommsStatus.OK:
    print("Connection failed "+at3.comms_error)
    exit()
at3.print_status()

print(f"Fan Speed for AC0 {at3.set_fan_speed_ac_unit(1, AT3AcFanSpeed.HIGH)}")
exit()

# Toggle a zone on/off
#print(f"Toogle Group 7 {at3.groups[7].toggle()}")
print(f"Toogle Group 7 {at3.toggle_group(7)}")
at3.print_status()
g = at3.groups[7]
print(f"Group {g.name}: {g.is_on}; Mode is {g.mode}; {g.open_percent}%; "
     f"Temp: {g.temperature}degC Target: {g.temperature_sp}degC")

# Increase a group position
#print(f"Increase zone 0: {at3.toggle_position_group(0, AT3Command.INCREMENT)}")
print(f"Increase zone 0: {at3.groups[0].position_inc()}")
g = at3.groups[0]
print(f"Group {g.name}: {g.is_on}; Mode is {g.mode}; {g.open_percent}%; "
      f"Temp: {g.temperature}degC Target: {g.temperature_sp}degC")

# Decrease a group position
print(f"Decrease zone 6: {at3.toggle_position_group(6, AT3Command.DECREMENT)}")
#print(f"Decrease zone 6: {at3.groups[6].position_dec()}")
g = at3.groups[6]
print(f"Group {g.name}: {g.is_on}; Mode is {g.mode}; {g.open_percent}%; "
      f"Temp: {g.temperature}degC Target: {g.temperature_sp}degC")

# Toogle AC Unit 1 on/off
#print(f"Toogle AC Unit 1 {at3.toggle_ac_unit(1)}")
print(f"Toogle AC Unit 1 {at3.ac_units[1].toggle()}")

# Toogle AC Unit 1 Temp Setpoint Up
#print(f"Toogle AC Unit 1 {at3.toggle_temperature_ac_unit(1, AT3Command.INCREMENT)}")
print(f"Toogle AC Unit 1 {at3.ac_units[1].temperature_inc()}")

# Toogle AC Unit 0 Temp Setpoint Down
#print(f"Toogle AC Unit 0 {at3.toggle_temperature_ac_unit(0, AT3Command.DECREMENT)}")
print(f"Toogle AC Unit 0 {at3.ac_units[0].temperature_dec()}")

Warning

This was code developed by testing with my Airtouch 3 system. I noted during development, if the unit received unexpected data, it would stop all communication (which includes to your mobile app) for a couple of minutes. There should be no issues with your Airtouch 3 system continuing to work with your mobile app while using this API, buts that your risk if you try it and you have problems.

Thanks

With thanks to the following projects which provided inspiration:
https://github.com/ozczecho/vzduch-dotek
https://github.com/L0rdCha0s/homebridge-airtouch3-airconditioner
https://github.com/LonePurpleWolf/airtouch4pyapi