Skip to main content

Python library for controlling the AquaIllumination range of aquarium lights

Project description

Build Status Coverage Status

A module for working with the AquaIllumination range of aquarium lights. The following functions are currently supported

  • Support for the HD range of lights, including single lights, paired lights (of the same model) and paired lights (with mixed models)

  • Enabling/Disabling the schedule

  • Querying the current brightness of the lights

  • Setting the brightness of the lights

This library has been primarily tested with Prime HD and Hydra 26HD lights, as that is what the author owns. Hydra 52 HDs should work but haven’t been validated. Also the non-HD range of lights are not currently supported, although it should be possible to add that support. If you would like to help fix either of these cases, please contact me via GitHub or by email.

This module is in no way endorsed by AquaIllumination and you use it at your own risk. It could, and probably does, invalidate your warranty.

Generated documentation can be found here

Quickstart

Install aquaipy using pip: $ pip install aquaipy. Once that is complete you can import the AquaIPy class and connect to your lights.

In this guide synchronous calls are shown but v2.0.0 of AquaIPy was a we-write, to provide async support. Synchronous functions are still supported but they are just wrappers of the async functions.

>>> from aquaipy import AquaIPy
>>> ai = AquaIPy()
>>> ai.connect("192.168.1.100")

Once the class is initialised and connected, you can query and update your light.

>> ai.get_colors_brightness()
{'blue': 18.7,
 'cool_white': 4.4,
 'deep_red': 1.0,
 'green': 1.3,
 'royal': 18.4,
 'uv': 46.3,
 'violet': 46.8}
>>> ai.update_color_brightness('cool_white', 33.333)
<Response.Success: 0>
>>> ai.update_color_brightness('deep_red', -15.2)
<Response.Success: 0>

Issues & Questions

If you have any issues, or questions, please feel free to contact me, or open an issue on GitHub

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

aquaipy-2.0.1.tar.gz (8.7 kB view details)

Uploaded Source

File details

Details for the file aquaipy-2.0.1.tar.gz.

File metadata

  • Download URL: aquaipy-2.0.1.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.5.3

File hashes

Hashes for aquaipy-2.0.1.tar.gz
Algorithm Hash digest
SHA256 522c9d93549300c370fc59bd80b084ecb307842b3ce2d5283e5c76e4f59ce7fd
MD5 c2b34a13b5874f8087c36ad8e43369bb
BLAKE2b-256 4eb2be4b5eed68b787df635114f859cc61c913198565048f246dcf537bfae7e8

See more details on using hashes here.

Supported by

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