Skip to main content

CodeQL Upload Python Package

python-ariston-api

A Python module for controlling Ariston devices with cloud polling. The following devices are currently supported:

  • Ariston Alteas One 24
  • Ariston Velis Evo
  • Ariston Velis Lux
  • Ariston Lydos Hybrid
  • Ariston Genus One
  • Ariston Nuos Split
  • Ariston Thision S
  • Chaffoteaux INOA S 24

Installation

Use pip3 to install the latest version of this module.

pip3 install ariston

Tests

Run the unit test suite with Python 3.11 or newer:

python -m unittest discover --start-directory tests --verbose

First, open Python 3 and import ariston module.

python3
import ariston

Syncronous

Discover devices if you dont know your gateway id. You can skip this step.

raw_devices = ariston.discover("username", "password")

For example the gateway id for your first device.

 raw_devices[0]['gw']

Get your device

device = ariston.hello("username", "password", "gateway", is_metric, "location")

Go use your device section

Asyncronous

raw_devices = await ariston.async_discover("username", "password")
device = await ariston.async_hello("username", "password", "gateway", is_metric, "location")

Go use your device section

First, open Python 3 and import Ariston class from this module.

python3
from ariston import Ariston

Create a new Ariston instance

ariston = Ariston()

Now let's try some functions

Connect

The cloud requests are asynchronous, so if you call them from a synchronous function or not even from function, you should use asyncio.

import asyncio

Sync

asyncio.run(ariston.async_connect("username", "password"))

Async

await ariston.async_connect("username", "password")
  • username: Your ariston cloud username.
  • password: Your ariston cloud password.

Discovery

Use this function to discover devices. You can skip this step if you already know the gateway id.

Sync

devices = asyncio.run(ariston.async_discover())

Async

devices = await ariston.async_discover()

Say hello

Use this function to create the device object.

Sync

device = asyncio.run(ariston.async_hello("gateway", is_metric, "location"))

Async

device = await ariston.async_hello("gateway", is_metric, "location")
  • gateway: You can find the value in the returned discover dictionary name 'gw'
  • is_metric: Optional. True or False. True means metric, False means imperial. Only works with Galevo (Alteas One, Genus One, etc) system. Default is True.
  • language_tag: Optional. Check https://en.wikipedia.org/wiki/IETF_language_tag Only works with Galevo (Alteas One, Genus One, etc) system. Default is "en-US".

Use your device

Get device features

Sync

device.get_features()

Async

await device.async_get_features()

Get device data

Sync

device.update_state()

Async

await device.async_update_state()

Get device energy

Sync

device.update_energy()

Async

await device.async_update_energy()

Metadata

Release files for ariston 0.19.15

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

Source distribution (sdist)

Source distribution for ariston 0.19.15
File Size Uploaded Provenance Actions
ariston-0.19.15.tar.gz 35.1 kB Without provenance Details for ariston-0.19.15.tar.gz

Built distribution (wheel)

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

Total release size: 77.3 kB

Release files / ariston-0.19.15.tar.gz

Download URL ariston-0.19.15.tar.gz
Size 35.1 kB
Tags Source
SHA-256 checksum
How to use checksums
033fa759a6975abf4457aa381090e2c138f582a2c93042173e9a53fc2fdcbb49
BLAKE2b-256 checksum
How to use checksums
372ed5b10f78a89bbd23b54891e380dfec53aeaf2c5ab552d6f99cc664080f2c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / ariston-0.19.15-py3-none-any.whl

Download URL ariston-0.19.15-py3-none-any.whl
Size 42.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
af204f54e28b489a17127c84276dc81c446a40a8203732c948052af306837d52
BLAKE2b-256 checksum
How to use checksums
d18e104c0971c6aaba8d875819446e199e0efd1513db486c18aa72d8aed42a57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for ariston 0.19.15

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