GitHunt
PI

pibooth/pibooth-extra-lights

Pibooth plugin to manage extra lights (startup, preview, flash...)

====================
pibooth-extra-lights

|PythonVersions| |PypiPackage| |Downloads|

pibooth-extra-lights is a plugin for the pibooth_ application.

It adds 3 extra lights:

  • startup : light on at pibooth startup
  • sequence : light on during the entire capture sequence
  • flash : light on when the capture is taken

Install

::

$ pip3 install pibooth-extra-lights

Configuration

Here below the new configuration options available in the pibooth_ configuration.
The keys and their default values are automatically added to your configuration after first pibooth_ restart.

The physical pin numbering <https://pinout.xyz>_ is used.

.. code-block:: ini

[CONTROLS]

# Physical GPIO OUT pin to light a LED at pibooth startup (list of pins accepted)
startup_led_pin = 29

# If True, startup LED is lighting by setting pin(s) to HIGH else by setting to LOW
startup_led_active_high = True

# Physical GPIO OUT pin to light a LED during the entire capture sequence (list of pins accepted)
preview_led_pin = 31

# If True, preview LED is lighting by setting pin(s) to HIGH else by setting to LOW
preview_led_active_high = True

# Physical GPIO OUT pin to light a LED when the capture is taken (list of pins accepted)
flash_led_pin = 33

# If True, flash LED is lighting by setting pin(s) to HIGH else by setting to LOW
flash_led_active_high = True

.. note:: Edit the configuration by running the command pibooth --config.

States description

Here is the pibooth state sequence <https://pibooth.readthedocs.io/en/latest/sources/plugins/plugins.html#influencing-states>_
updated with the lights activated by this plugin:

.. image:: https://raw.githubusercontent.com/pibooth/pibooth-extra-lights/master/docs/images/state_sequence.png
:align: center
:alt: State sequence

Circuit diagram

Here is the diagram for hardware connections.

.. image:: https://raw.githubusercontent.com/pibooth/pibooth-extra-lights/master/docs/images/sketch.png
:align: center
:alt: Electronic sketch

.. --- Links ------------------------------------------------------------------

.. _pibooth: https://pypi.org/project/pibooth

.. |PythonVersions| image:: https://img.shields.io/badge/python-3.6+-red.svg
:target: https://www.python.org/downloads
:alt: Python 3.6+

.. |PypiPackage| image:: https://badge.fury.io/py/pibooth-extra-lights.svg
:target: https://pypi.org/project/pibooth-extra-lights
:alt: PyPi package

.. |Downloads| image:: https://img.shields.io/pypi/dm/pibooth-extra-lights?color=purple
:target: https://pypi.org/project/pibooth-extra-lights
:alt: PyPi downloads

Languages

Python100.0%

Contributors

GNU General Public License v3.0
Created May 7, 2020
Updated August 31, 2025
pibooth/pibooth-extra-lights | GitHunt