Skip to main content

Asynchronous Python client for Aquatlantis Ori Smart Controller

Project description

Python Aquatlantis Ori

PyPI version License Codecov Sonar quality gate GitHub repo stars Buy me a coffee

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aquatlantis_ori-0.0.12.tar.gz (76.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aquatlantis_ori-0.0.12-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file aquatlantis_ori-0.0.12.tar.gz.

File metadata

  • Download URL: aquatlantis_ori-0.0.12.tar.gz
  • Upload date:
  • Size: 76.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aquatlantis_ori-0.0.12.tar.gz
Algorithm Hash digest
SHA256 12fb42fc709de483899b38a7e1408b7b4564d2c2e898447dc490f189d229081b
MD5 21604778ce00622ae06dd52e831eb028
BLAKE2b-256 f0c40ecba9c5d6957e1012da0a71e7b547315cdb04c18a76976aaf46b3d39131

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquatlantis_ori-0.0.12.tar.gz:

Publisher: release.yaml on golles/python-aquatlantis-ori

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aquatlantis_ori-0.0.12-py3-none-any.whl.

File metadata

File hashes

Hashes for aquatlantis_ori-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 772b140aecf0ff86b654e96da719bbbfa8c8e550a08dd77b6a8976f5e9a82758
MD5 c918f468ec659c96ca2f9c9687ab0a5d
BLAKE2b-256 34d0086e2ee233705b10f7d420c41dcd5e39d150010217b715ccb47317e2adae

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquatlantis_ori-0.0.12-py3-none-any.whl:

Publisher: release.yaml on golles/python-aquatlantis-ori

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page