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.10.tar.gz (76.4 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.10-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aquatlantis_ori-0.0.10.tar.gz
Algorithm Hash digest
SHA256 e3d6c818d790d33dff14396aae584dba4184207976dd1facc052895cff94ecec
MD5 d7ca70093cee596a4509d8da61e1c716
BLAKE2b-256 a538b4911d07610495dc2ef38f8ae53f3904a02d4afbebec2cf2186e5577b58b

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquatlantis_ori-0.0.10.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.10-py3-none-any.whl.

File metadata

File hashes

Hashes for aquatlantis_ori-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 81cf3a80419275a647b23581d9073e4f3d9f9a1d2b24f24052477c273a48c354
MD5 d29fc28d46a01cd5403cc23b049883ad
BLAKE2b-256 19d036d4a9f3de5913c8df32b83a85da39191fdc55fed36ab33bc7a7c72e7fd2

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquatlantis_ori-0.0.10-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