Skip to main content

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.

PyPi

Ayla References

This device is integrated by/with Ayla Networks and (generally) uses their documentation.

These can be used as starting references:

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 a username and password (typically a smart device's app login credentials) 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()

License

MIT

Metadata

Release files for ayla-iot-unofficial-crevetor 1.3.2

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

Source distribution (sdist)

Source distribution for ayla-iot-unofficial-crevetor 1.3.2
File Size Uploaded Provenance Actions
ayla_iot_unofficial_crevetor-1.3.2.tar.gz 20.0 kB Without provenance Details for ayla_iot_unofficial_crevetor-1.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ayla-iot-unofficial-crevetor 1.3.2
File Interpreter ABI Platform Actions
ayla_iot_unofficial_crevetor-1.3.2-py3-none-any.whl Python 3 none any Details for ayla_iot_unofficial_crevetor-1.3.2-py3-none-any.whl

Total release size: 40.3 kB

Release files / ayla_iot_unofficial_crevetor-1.3.2.tar.gz

Download URL ayla_iot_unofficial_crevetor-1.3.2.tar.gz
Size 20.0 kB
Tags Source
SHA-256 checksum
How to use checksums
96a7f1a65477b306c8b8d4521b39398985e540d4e59dd76d0bead11067c8fbc1
BLAKE2b-256 checksum
How to use checksums
ca1656d405b8fa6f8f5d8f17abdbe140620cd9eeb81a613324a0f7d978041dcc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.9

Release files / ayla_iot_unofficial_crevetor-1.3.2-py3-none-any.whl

Download URL ayla_iot_unofficial_crevetor-1.3.2-py3-none-any.whl
Size 20.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
585af9a77d141126d242b63a80655c9ee808a4d9bfe8155855ddd4a0ae896065
BLAKE2b-256 checksum
How to use checksums
4ae670183934857bb52013ac39dd931c571ecbc437287e4b68839bf484250bc8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.9

Security for ayla-iot-unofficial-crevetor 1.3.2

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

1.3.2 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