Skip to main content

Python3 library for Airzone Cloud API

Project description

Airzone Cloud

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).

If you are looking for the specific Airzone Cloud API for Daikin (try to connect to dkn.airzonecloud.com), you should use this package : AirzoneCloudDaikin

Module classes

  • AirzoneCloud : represent your AirzoneCloud account. Contains a list of your devices :
    • Device : represent one of your Airzone webserver registered. Contains a list of its systems :
      • System : represent your climate equipment (Mitsubishi, Daikin, ...). Contains a list of its zones :
        • Zone : represent a zone to control

Usage

Install

pip3 install AirzoneCloud

Start API

from AirzoneCloud import AirzoneCloud
api = AirzoneCloud("email@domain.com", "password")

Get device status

for device in api.devices:
    print(
        "Device name={}, status={}, id={}, mac={}, pin={}".format(
            device.name, device.status, device.id, device.mac, device.pin
        )
    )

Output :

Device name=Home, status=activated, id=5bc8ae0c4149526af90c0000, mac=AA:BB:CC:DD:EE:FF, pin=1234

Get system status

for system in api.devices[0].systems:
    print(
        "System name={}, mode={}, eco={}, velocity={}, airflow={}".format(
            system.name,
            system.mode,
            system.eco,
            system.velocity,
            system.airflow,
        )
    )

Output :

System name=Home, mode=heat-both, eco=eco-a, velocity=None, airflow=None

Get all zones status (on all devices / systems)

for zone in api.all_zones:
    print(
        "Zone name={}, is_on={}, mode={}, current_temperature={}, target_temperature={}".format(
            zone.name,
            zone.is_on,
            zone.mode,
            zone.current_temperature,
            zone.target_temperature,
        )
    )

Output :

Zone name=Baby bedroom, is_on=False, mode=heat-both, current_temperature=20.4, target_temperature=19.5
Zone name=Parents bedroom, is_on=False, mode=heat-both, current_temperature=21.1, target_temperature=17.0
Zone name=Living room, is_on=True, mode=heat-both, current_temperature=21.4, target_temperature=21.5
Zone name=Kitchen, is_on=False, mode=heat-both, current_temperature=21.2, target_temperature=19.0

Control a specific zone

zone = api.all_zones[2]
print(zone)

# start zone
zone.turn_on()

# set temperature
zone.set_temperature(18.5)

print(zone)

Output :

Zone(name=Living room, is_on=False, mode=heat-both, current_temp=21.6, target_temp=21.0)
Zone(name=Living room, is_on=True, mode=heat-both, current_temp=21.6, target_temp=18.5)

HVAC mode

Available modes

  • stop : Stop
  • ventilate : Ventilate
  • dehumidify : Dry
  • heat-air : Air heating
  • heat-radiant : Radiant heating
  • heat-both : Combined heating
  • cool-air : Air cooling
  • cool-radiant : Radiant cooling
  • cool-both : Combined cooling

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

system = api.devices[0].systems[0]
print(system)

# set mode to heat-both
system.set_mode("heat-both")

print(system)

Output :

System(name=Home, mode=stop, eco=eco-a, velocity=None, airflow=None)
System(name=Home, mode=heat-both, eco=eco-a, velocity=None, airflow=None)

API doc

API full doc

Constructor

AirzoneCloud(username, password, user_agent=None, base_url=None)
  • username : you're username 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
  • base_url : allow to change base url of the Airzone Cloud API if set

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

AirzoneCloud-0.5.0.tar.gz (10.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page