ayla-iot-unofficial
An unofficial python library for interacting with the Ayla IoT API. Intended to be generic for multi-device use.
Designed primarily to be a support package for Home Assistant integrations.
This library is heavily based off of sharkiq by @JeffResc.
Ayla References
This device is integrated by/with Ayla Networks and (generally) uses their documentation.
These can be used as starting references:
- https://developer.aylanetworks.com/apibrowser
- https://docs.aylanetworks.com/reference/getting_started
- https://connection.aylanetworks.com/s/article/2080270
Installation
From PyPi
pip install ayla-iot-unofficial
Build from source
pip install build
pip build
pip install ayla-iot-unofficial
Library Requirements
Requires typical http interaction and datatype packages like requests, aiohttp, ujson
User Requirements
Reqiures either a username and password (typically a smart device's app login credentials) or a token (retrieved from device manufacturer's login flow) Requires an app_id and app_secret (granted by Ayla to the smart device's app for operation/integration)
The app_id and app_secret may need to be obtained from proxy traffic or other method.
Usage
Class Object
Instantiate a new class object through new_ayla_api() or Ayla() directly.
For devices that may be region specific, the new_ayla_api() function will create an Ayla() object based on the europe boolean.
Ayla Access_Token
Standard use should call sign_in() on the Ayla object after creation. This will perform the POST login request to obtain an access_token.
Some devices communicate with a different IoT domain but still expose the Ayla access_token. This access token can be passed into the Ayla object using _set_credentials() and the proper arguments.
Devices
By default, calling get_devices() will return a list of class specific device objects with updated properties for use.
See device.py for implemented device classes.
Typical Operation
python3 -m pip install ayla-iot-unofficial
import ayla_iot_unofficial
USERNAME = 'me@email.com'
PASSWORD = '$7r0nkP@s$w0rD'
ayla_api = new_ayla_api(USERNAME, PASSWORD, APP_ID, APP_SECRET)
ayla_api.sign_in()
devices = ayla_api.get_devices()
# Example Vacuum Devices
shark = devices[0]
shark.set_operating_mode(OperatingModes.START)
shark.return_to_base()
# Example Water Softener Devices
softener = devices[1]
softener.capacity_remaining_gallons
softener.set_vacation_mode()
Login via token
Some devices like the De'Longhi DDSX Dehumidifier are accessed by logging into the manufacturer's app which then generates an SSO token for logging into Ayla Networks.
SSO_TOKEN = 'st2...'
ayla_api = new_ayla_api_sso(SSO_TOKEN, APP_ID, APP_SECRET)
ayla_api.sign_in()
License
1 maintainer
Release files for ayla-iot-unofficial 1.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ayla_iot_unofficial-1.5.1.tar.gz | 20.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ayla_iot_unofficial-1.5.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.7 kB
Release files / ayla_iot_unofficial-1.5.1.tar.gz
| Download URL | ayla_iot_unofficial-1.5.1.tar.gz |
|---|---|
| Size | 20.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
502b4a2f5317071e10064d679861242a30ed7618e1f9a77ab50ea4821432d8ba
|
|
BLAKE2b-256 checksum How to use checksums |
7a2bffbe9be7c60ff7424115a85356a978d83016bed10490d143c7a96975845c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.
Transparency logRelease files / ayla_iot_unofficial-1.5.1-py3-none-any.whl
| Download URL | ayla_iot_unofficial-1.5.1-py3-none-any.whl |
|---|---|
| Size | 20.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
83eb7f0f5bea60b84e48a0236ffec1b406be7008ad38c992f99b721ec99a24f3
|
|
BLAKE2b-256 checksum How to use checksums |
856afd29b7868520289ff6210493095b9310bf8ae18b03278669484ddc0bd7f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 20, 2026.
Transparency log
