Skip to main content

aiovantage

Documentation PyPI - Version Discord

Python library for interacting with and controlling Vantage InFusion home automation controllers.

This open-source, non-commercial library is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Vantage, and is provided for interoperability purposes only.

Example

from aiovantage import Vantage

async with Vantage("192.168.1.2", "username", "password") as vantage:
    async for load in vantage.loads:
        print(f"{load.name} is at {load.level}%")

See the examples folder for more examples.

Features

  • Fetch object configuration from your Vantage system.
  • Fetch object state and subscribe to state changes (e.g. load levels, sensor readings).
  • Control devices (turn on lights, set thermostats, etc).
  • Uses asyncio for non-blocking I/O.
  • Uses SSL connections by default, with automatic reconnection.
  • Supports both lazy and eager object fetching.

Installation

Add aiovantage as a dependency to your project, or install it directly:

pip install aiovantage

Supported objects

The following interfaces/controllers are currently supported.

Type Description Controller
AnemoSensor Wind speed sensors vantage.anemo_sensors
Area Rooms, etc vantage.areas
BackBox Backboxes vantage.back_boxes
Blind Shades, blinds vantage.blinds
BlindGroups Groups of blinds vantage.blind_groups
Buttons Keypad buttons vantage.buttons
DryContacts Motion sensors, etc vantage.dry_contacts
GMem Vantage variables vantage.gmem
LightSensor Light sensors vantage.light_sensors
Load Lights, relays, etc vantage.loads
LoadGroup Groups of loads vantage.load_groups
Master Vantage controllers vantage.masters
Module Dimmer modules vantage.modules
OmniSensor Power, current, etc vantage.omni_sensors
PortDevice Port devices (hubs) vantage.port_devices
PowerProfile Load power profiles vantage.power_profiles
RGBLoad RGB lights vantage.rgb_loads
Stations Keypads, etc vantage.stations
Tasks Vantage tasks vantage.tasks
Temperature Temperature sensors vantage.temperatures
Thermostat Thermostats vantage.thermostats

If you have an object that you expect to show up in one of these controllers but is missing, please create an issue or submit a pull request.

Usage

Creating a client

Begin by importing the Vantage class:

from aiovantage import Vantage

The most convenient way to create a client is by using the async context manager:

async with Vantage("hostname", "username", "password") as vantage:
    # ...use the vantage client

Alternatively, you can manage the lifecycle of the client yourself:

from aiovantage import Vantage

vantage = Vantage("hostname", "username", "password")
# ...use the vantage client
vantage.close()

Querying objects

The Vantage class exposes a number of controllers, which can be used to query objects. Controllers can either be populated lazily (by using async for), or eagerly (by using controller.initialize()).

For example, to get a list of all loads:

async with Vantage("hostname", "username", "password") as vantage:
    async for load in vantage.loads:
        print(f"{load.name} is at {load.level}%")

Alternatively, you can use controller.initialize() to eagerly fetch all objects:

async with Vantage("hostname", "username", "password") as vantage:
    await vantage.loads.initialize()
    for load in vantage.loads:
        print(f"{load.name} is at {load.level}%")

If you aren't interested in the state of the objects, you can call controller.initialize(fetch_state=False) to slightly speed up the initialization:

async with Vantage("hostname", "username", "password") as vantage:
    await vantage.loads.initialize(fetch_state=False)
    for load in vantage.loads:
        print(f"{load.name}")

All controllers implement a django-like query interface, which can be used to filter objects. You can either query by matching attributes:

async with Vantage("hostname", "username", "password") as vantage:
    async for load in vantage.loads.filter(name="Kitchen"):
        print(f"{load.name} is at {load.level}%")

Or by using a filter predicate:

async with Vantage("hostname", "username", "password") as vantage:
    async for load in vantage.loads.filter(lambda load: load.level > 50):
        print(f"{load.name} is at {load.level}%")

Fetching a single object

You can fetch a single object by id, by calling controller.aget() or controller.get():

async with Vantage("hostname", "username", "password") as vantage:
    load = await vantage.loads.aget(118)
    print(f"{load.name} is at {load.level}%")

These functions also implement the same query interface as controller.filter() for querying by attributes or filter predicate:

async with Vantage("hostname", "username", "password") as vantage:
    load = await vantage.loads.aget(name="Kitchen")
    print(f"{load.name} is at {load.level}%")

Controlling objects

Objects also expose various methods for controlling state. For example, to turn on a load:

async with Vantage("hostname", "username", "password") as vantage:
    load = vantage.loads.aget(name="Study Lights")
    await load.turn_on()

Subscribing to state changes

You can subscribe to state changes by using the controller.subscribe() method. The callback receives a typed event, with the updated object available as event.obj:

from aiovantage.events import ObjectUpdated


def on_load_state_change(event: ObjectUpdated):
    print(f"{event.obj.name} is at {event.obj.level}%")


async with Vantage("hostname", "username", "password") as vantage:
    await vantage.loads.initialize()
    vantage.loads.subscribe(ObjectUpdated, on_load_state_change)

Note that a subscription will only receive state changes for objects that have populated into the controller.

Metadata

Release files for aiovantage 0.23.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiovantage 0.23.5
File Size Uploaded Provenance Actions
aiovantage-0.23.5.tar.gz 82.3 kB Without provenance Details for aiovantage-0.23.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aiovantage 0.23.5
File Interpreter ABI Platform Actions
aiovantage-0.23.5-py3-none-any.whl Python 3 none any Details for aiovantage-0.23.5-py3-none-any.whl

Total release size: 186.9 kB

Release files / aiovantage-0.23.5.tar.gz

Download URL aiovantage-0.23.5.tar.gz
Size 82.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6879b91ca5ce01b6a3f1f646ab80c4411dc7eaad9b8144546e6618f670a1f1ae
BLAKE2b-256 checksum
How to use checksums
637ba9b068341257e80c6a2a2a3aa754bc10ed7a52dc4221658170132c9f8e4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / aiovantage-0.23.5-py3-none-any.whl

Download URL aiovantage-0.23.5-py3-none-any.whl
Size 104.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ca9338c76897f9f9b40c1a0750af65c6494ea4d7903996c011ece601aa5eab45
BLAKE2b-256 checksum
How to use checksums
570be987b2143d2a3936de3ba14bf2df1d3677076b046a45d639333d5d756ee5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for aiovantage 0.23.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.23.5 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page