Skip to main content

Calibrate your LEDs using an external light probe.

Project description

Pioreactor LED calibration plugin

CI tests

The LED automations available on the Pioreactor are limited: light intensity percentages are based on the power supplied to the LED wires. For specific research and for comparing results between Pioreactors, this plugin can be used to determine the exact LED intensity values.

This plugin offers the ability to calibrate your LEDs using an external light probe. It functions in two parts:

  1. a command line calibration that creates a line-of-best-fit and
  2. a calibrated light/dark cycle automation available on the Pioreactor web interface.

Installation instructions

Install from the command line.

pio install-plugin led-calibration-plugin  ## to install on a single Pioreactor

## OR, on the command line of the leader Pioreactor

pios install-plugin led-calibration-plugin ## to install on all Pioreactors in a cluster

This plugin is also available on the Pioreactor web interface, in the Plugins tab. Downloading from the web interface will install on all Pioreactors in a cluster.

Run your calibration

Type into your command line:

pio run led_calibration

To perform this calibration, insert your vial containing media into the Pioreactor and submerge your light probe. Follow the prompts on the command line. The plugin will increase the light intensity, and prompt you to record the readings from your light probe. A calibration line of best fit will be generated based on your light probe readings.

Use the calibration on the UI

An automation will become available on the web interface. To use this automation, use two LED cables in each of channels C and D, and insert the bulbs into the X2 and X3 pockets on the Pioreactor vial holder. Calibrations for LEDs in channels "C" and "D" must exist.

In the Pioreactors tab, under Manage, you can Start an LED automation. A new option becomes available in the drop-down menu called "Calibrated Light/Dark Cycle". Input your desired light intensity in AU (ex. 1000 AU). The automation will set the percent light intensity such that an output of 1000 AU occurs on both LEDs.

Subcommands

Run a subcommand by typing the following into the command line:

pio run led_calibration <SUBCOMMAND>

The following subcommands are available:

list

Prints a table with all existing calibrations stored on the leader. Headings include unique names, timestamps, and channels.

Name Timestamp Channel Currently in use?
Algae_C_2022 2022-08-29T20:12:00.400000Z C
Algae_B_2022 2022-08-29T20:13:00.400000Z B
Algae_B_2021 2021-08-29T20:15:00.400000Z B

display

Displays the graph and data for the current calibration for each channel A, B, C, and D, if it exists. For example, for the data above, the current calibrations for Algae_C_2022 and Algae_B_2022 will be displayed.

change_current

If you would like to change a current calibration to a previous one, use change_current "<UNIQUE NAME>". These changes are based on the channel assigned to the calibration.

For example: pio run led_calibration change_current "Algae_B_2021" would replace Algae_B_2022, since only one calibation is active per channel.

When to perform an LED calibration

Calibrations should be performed on a case-by-case basis. A new calibration must be performed per channel, and/or for new LED cables, and with any change in media that can alter the light intensity within the vial.

Plugin documentation

Documentation for plugins can be found on the Pioreactor wiki.

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

led_calibration_plugin-1.3.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

led_calibration_plugin-1.3.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file led_calibration_plugin-1.3.0.tar.gz.

File metadata

  • Download URL: led_calibration_plugin-1.3.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0rc2

File hashes

Hashes for led_calibration_plugin-1.3.0.tar.gz
Algorithm Hash digest
SHA256 32cdc420db4dd2e45cba5eda2d461cc7028e5ec781287399b8cbe1b4360a4208
MD5 02fac13311072d81c10784f8dc1bbe13
BLAKE2b-256 b837698dc9d5caedd70445c51e1a26119b1fd29b1904cb75bdc789909a6b134b

See more details on using hashes here.

Provenance

File details

Details for the file led_calibration_plugin-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for led_calibration_plugin-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ea3d557a658d1af07947e59739eb759c7112dc02f1456999040af7384e29761
MD5 bf74821b510f87e9e5025e54ef638c9d
BLAKE2b-256 dbe76f2b2062a65ba8cf3bfbdca022df350132698d7c3958f95a3256c0f8e42a

See more details on using hashes here.

Provenance

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