Asynchronous Python client for Aquatlantis Ori Smart Controller
Project description
Python Aquatlantis Ori
An asynchronous Python client for the Aquatlantis Ori Smart Controller
[!CAUTION] This project is a personal, unofficial effort and is not affiliated with Aquatlantis. It was created to learn and experiment with controlling my own aquarium. The Ori API was reverse-engineered for this purpose, and functionality may break at any time if Aquatlantis changes their API. I'm not responsible for any damage or issues that may arise from using this client. Use at your own risk!
Installation
You can install this package using your preferred package manager. For example, using pip:
pip install aquatlantis-ori
Usage
To use the Aquatlantis Ori client, you can import it in your Python scripts and start interacting with your Ori controller. Here is a simple example:
import asyncio
import logging
from aquatlantis_ori import AquatlantisOriClient, LightOptions, PowerType
logging.basicConfig(level=logging.WARNING)
logging.getLogger("aquatlantis_ori").setLevel(logging.INFO)
async def main() -> None:
async with AquatlantisOriClient("email", "password") as client:
await client.connect()
device = client.get_devices()[0]
scenarios: list[dict] = [
{"power": PowerType.ON, "options": LightOptions(intensity=100, red=100, green=0, blue=0, white=0)},
{"power": PowerType.ON, "options": LightOptions(intensity=100, red=0, green=100, blue=0, white=0)},
{"power": PowerType.ON, "options": LightOptions(intensity=100, red=0, green=0, blue=100, white=0)},
{"power": PowerType.ON, "options": LightOptions(intensity=100, red=0, green=0, blue=0, white=100)},
{"power": PowerType.ON, "options": LightOptions(intensity=100, red=100, green=100, blue=100, white=100)},
{"power": PowerType.OFF},
{"power": PowerType.ON, "options": LightOptions(intensity=80, red=0, green=0, blue=0, white=100)},
{"power": PowerType.ON, "options": LightOptions(intensity=60, red=0, green=0, blue=0, white=100)},
{"power": PowerType.ON, "options": LightOptions(intensity=40, red=0, green=0, blue=0, white=100)},
{"power": PowerType.ON, "options": LightOptions(intensity=20, red=0, green=0, blue=0, white=100)},
{"power": PowerType.ON, "options": LightOptions(intensity=1, red=0, green=0, blue=0, white=100)},
{"power": PowerType.OFF},
]
for scenario in scenarios:
device.set_light(
power=scenario.get("power"),
options=scenario.get("options"),
)
await asyncio.sleep(2)
if __name__ == "__main__":
asyncio.run(main())
Contributing
Contributions are welcome! Please familiarize yourself with the contribution guidelines. This document will also help you set up your development environment.
Thank you for your interest in the Python Aquatlantis Ori client! If you have any questions or need further assistance, feel free to open an issue or submit a pull request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aquatlantis_ori-0.0.13.tar.gz.
File metadata
- Download URL: aquatlantis_ori-0.0.13.tar.gz
- Upload date:
- Size: 77.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f493e63eab8b13e6d8a6f60a4463376702df9473a026d7f1fa83a77d97b35d3
|
|
| MD5 |
f71efa7a0a5befe80c767a87f4049c33
|
|
| BLAKE2b-256 |
357ceda4068c0370fb4efdfb3cce1876e6f0c89b79559341925191e8132fb4d6
|
Provenance
The following attestation bundles were made for aquatlantis_ori-0.0.13.tar.gz:
Publisher:
release.yaml on golles/python-aquatlantis-ori
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aquatlantis_ori-0.0.13.tar.gz -
Subject digest:
6f493e63eab8b13e6d8a6f60a4463376702df9473a026d7f1fa83a77d97b35d3 - Sigstore transparency entry: 584339380
- Sigstore integration time:
-
Permalink:
golles/python-aquatlantis-ori@4df11c2646672feab736d789bc2d575203da4ce6 -
Branch / Tag:
refs/tags/v0.0.13 - Owner: https://github.com/golles
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@4df11c2646672feab736d789bc2d575203da4ce6 -
Trigger Event:
release
-
Statement type:
File details
Details for the file aquatlantis_ori-0.0.13-py3-none-any.whl.
File metadata
- Download URL: aquatlantis_ori-0.0.13-py3-none-any.whl
- Upload date:
- Size: 19.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a0adf4c403a59fee2712ae143c5930adc0ba42e9e41ab13cbc4c59df9bb4270
|
|
| MD5 |
9142c7d48f05c49761d8f74c3279bfc4
|
|
| BLAKE2b-256 |
175100d65ab18c6f3b10560dccff5c813c58619759169e3416e6bf1065ed60b9
|
Provenance
The following attestation bundles were made for aquatlantis_ori-0.0.13-py3-none-any.whl:
Publisher:
release.yaml on golles/python-aquatlantis-ori
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aquatlantis_ori-0.0.13-py3-none-any.whl -
Subject digest:
8a0adf4c403a59fee2712ae143c5930adc0ba42e9e41ab13cbc4c59df9bb4270 - Sigstore transparency entry: 584339381
- Sigstore integration time:
-
Permalink:
golles/python-aquatlantis-ori@4df11c2646672feab736d789bc2d575203da4ce6 -
Branch / Tag:
refs/tags/v0.0.13 - Owner: https://github.com/golles
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@4df11c2646672feab736d789bc2d575203da4ce6 -
Trigger Event:
release
-
Statement type: