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 hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page