AirzoneCloud 1.0.0

Python3 library for Airzone Cloud API

Airzone Cloud

• Airzone Cloud
  • Presentation
    • Abstract
    • Module classes
  • Usage
    • Install
    • Start API
    • Get installations
    • Get devices from installations
    • Get all devices shortcut
    • Control a device
    • HVAC mode
      • Available modes
      • Set HVAC mode on a system (and its sub-zones)
  • API doc
    • Constructor

Presentation

Abstract

Allow to communicate easily with Airzone Cloud to retrieve information or to send commands (on/off, temperature, HVAC mode, ...)

This library manage the main Airzone Cloud API (try to connect to www.airzonecloud.com to be sure).

Official API documentation is available here : https://developers.airzonecloud.com/docs/web-api/

Module classes

• AirzoneCloud : represent your AirzoneCloud account. Contains a list of your installations :
  • Installation: represent one of your installation (like your home, an office, ...). Contains a list of its groups :
    • Group : represent a group of devices in the installation
      • Device : represent your thermostat to control

Usage

Install

pip3 install AirzoneCloud

Start API

from AirzoneCloud import AirzoneCloud
api = AirzoneCloud("[e-mail]", "password")

Get installations

for installation in api.installations:
    print(
        "Installation(name={}, type={}, scenary={}, id={})".format(
            installation.name, installation.type, installation.scenary, installation.id
        )
    )

Output :

Installation(name=My home, type=home, scenary=occupied, id=5d592c14646b6d798ccc2aaa)

Get devices from installations

for installation in api.installations:
    for device in installation.devices:
        print(
            "Device(name={}, is_on={}, mode={}, current_temp={}, target_temp={}, id={}, mac={})".format(
                device.name,
                device.is_on,
                device.mode,
                device.current_temperature,
                device.target_temperature,
                device.id,
                device.mac,
            )
        )

Output :

Device(name=Dknwserver, is_on=False, mode=cool, current_temp=25.0, target_temp=26.0, id=5ab1875a651241708814575681, mac=AA:BB:CC:DD:EE:FF)

Get all devices shortcut

for device in api.all_devices:
    print(
        "Device(name={}, is_on={}, mode={}, current_temp={}, target_temp={}, id={}, mac={})".format(
            device.name,
            device.is_on,
            device.mode,
            device.current_temperature,
            device.target_temperature,
            device.id,
            device.mac,
        )
    )

Output :

Device(name=Dknwserver, is_on=False, mode=cool, current_temp=25.0, target_temp=26.0, id=5ab1875a651241708814575681, mac=AA:BB:CC:DD:EE:FF)

Control a device

device = api.all_devices[0]
print(device)

# start device
device.turn_on()

# set temperature
device.set_temperature(26)

print(device)

# stopping device
device.turn_off()

print(device)

Output :

Device(name=Dknwserver, is_on=False, mode=cool, current_temp=25.0, target_temp=30.0)
Device(name=Dknwserver, is_on=True, mode=cool, current_temp=25.0, target_temp=26.0)
Device(name=Dknwserver, is_on=False, mode=cool, current_temp=25.0, target_temp=26.0)

HVAC mode

Available modes

• cool : Cooling mode
• heat : Heating mode
• ventilate : Ventilation
• dehumidify : Dry
• heat-cold-auto : Auto heat/cold mode

Set HVAC mode on a system (and its sub-zones)

device = api.all_devices[0]
print(device)

# set mode to heat
device.set_mode("heat")

print(device)

Output :

Device(name=Dknwserver, is_on=False, mode=cool, current_temp=25.0, target_temp=26.0)
Device(name=Dknwserver, is_on=False, mode=heat, current_temp=25.0, target_temp=23.0)

:warning: climate equipment has 2 consigns : one for heat & one of cold. Its visible in the previous example, the target temperature has change from 26 to 23 just by changing the mode from cool to heat. So don't forget to do your set_temperature() AFTER the set_mode() and not before

API doc

API full doc

Constructor

AirzoneCloud(email, password, user_agent=None

• email : you're email used to connect on Airzone Cloud website or app
• password : you're password used to connect on Airzone Cloud website or app
• user_agent : allow to change default user agent if set