====================
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
Raw data
{
"_id": null,
"home_page": "https://github.com/pibooth/pibooth-extra-lights",
"name": "pibooth-extra-lights",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Raspberry Pi,camera,photobooth",
"author": "Vincent Verdeil, Antoine Rousseaux",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/91/7c/1ef5c4473bfcbc236eadb45611b567d752a38478ab9a4e532db8dfc5692c/pibooth_extra_lights-1.0.2.tar.gz",
"platform": "unix",
"description": "\n====================\npibooth-extra-lights\n====================\n\n|PythonVersions| |PypiPackage| |Downloads|\n\n``pibooth-extra-lights`` is a plugin for the `pibooth`_ application.\n\nIt adds 3 extra lights:\n\n- **startup** : light on at ``pibooth`` startup\n- **sequence** : light on during the entire capture sequence\n- **flash** : light on when the capture is taken\n\nInstall\n-------\n\n::\n\n $ pip3 install pibooth-extra-lights\n\nConfiguration\n-------------\n\nHere below the new configuration options available in the `pibooth`_ configuration.\n**The keys and their default values are automatically added to your configuration after first** `pibooth`_ **restart.**\n\nThe `physical pin numbering <https://pinout.xyz>`_ is used.\n\n.. code-block:: ini\n\n [CONTROLS]\n\n # Physical GPIO OUT pin to light a LED at pibooth startup (list of pins accepted)\n startup_led_pin = 29\n\n # If True, startup LED is lighting by setting pin(s) to HIGH else by setting to LOW\n startup_led_active_high = True\n\n # Physical GPIO OUT pin to light a LED during the entire capture sequence (list of pins accepted)\n preview_led_pin = 31\n\n # If True, preview LED is lighting by setting pin(s) to HIGH else by setting to LOW\n preview_led_active_high = True\n\n # Physical GPIO OUT pin to light a LED when the capture is taken (list of pins accepted)\n flash_led_pin = 33\n\n # If True, flash LED is lighting by setting pin(s) to HIGH else by setting to LOW\n flash_led_active_high = True\n\n.. note:: Edit the configuration by running the command ``pibooth --config``.\n\nStates description\n------------------\n\nHere is the `pibooth state sequence <https://pibooth.readthedocs.io/en/latest/sources/plugins/plugins.html#influencing-states>`_\nupdated with the lights activated by this plugin:\n\n.. image:: https://raw.githubusercontent.com/pibooth/pibooth-extra-lights/master/docs/images/state_sequence.png\n :align: center\n :alt: State sequence\n\nCircuit diagram\n---------------\n\nHere is the diagram for hardware connections.\n\n.. image:: https://raw.githubusercontent.com/pibooth/pibooth-extra-lights/master/docs/images/sketch.png\n :align: center\n :alt: Electronic sketch\n\n.. --- Links ------------------------------------------------------------------\n\n.. _`pibooth`: https://pypi.org/project/pibooth\n\n.. |PythonVersions| image:: https://img.shields.io/badge/python-3.6+-red.svg\n :target: https://www.python.org/downloads\n :alt: Python 3.6+\n\n.. |PypiPackage| image:: https://badge.fury.io/py/pibooth-extra-lights.svg\n :target: https://pypi.org/project/pibooth-extra-lights\n :alt: PyPi package\n\n.. |Downloads| image:: https://img.shields.io/pypi/dm/pibooth-extra-lights?color=purple\n :target: https://pypi.org/project/pibooth-extra-lights\n :alt: PyPi downloads\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Pibooth plugin for extra lights management.",
"version": "1.0.2",
"project_urls": {
"Download": "https://github.com/pibooth/pibooth-extra-lights/archive/1.0.2.tar.gz",
"Homepage": "https://github.com/pibooth/pibooth-extra-lights"
},
"split_keywords": [
"raspberry pi",
"camera",
"photobooth"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "073ace5d4412a4f33e3898eed459c1200ea1a353ad4206c7fcd8f2e34c0863c9",
"md5": "c6752ee6625e3cc93de5d210a1eeece4",
"sha256": "b248adfd1486c331601348b152db490832da0e400846e4202f6856b72d135465"
},
"downloads": -1,
"filename": "pibooth_extra_lights-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c6752ee6625e3cc93de5d210a1eeece4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 15866,
"upload_time": "2023-05-17T05:15:31",
"upload_time_iso_8601": "2023-05-17T05:15:31.022578Z",
"url": "https://files.pythonhosted.org/packages/07/3a/ce5d4412a4f33e3898eed459c1200ea1a353ad4206c7fcd8f2e34c0863c9/pibooth_extra_lights-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "917c1ef5c4473bfcbc236eadb45611b567d752a38478ab9a4e532db8dfc5692c",
"md5": "55b3cbf790631e87f1337e8eb48008e4",
"sha256": "6466c725f8448cf620dfb7216ab452112b91c4566b771aa5e7ede1bf5eda34d7"
},
"downloads": -1,
"filename": "pibooth_extra_lights-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "55b3cbf790631e87f1337e8eb48008e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 15643,
"upload_time": "2023-05-17T05:15:32",
"upload_time_iso_8601": "2023-05-17T05:15:32.653236Z",
"url": "https://files.pythonhosted.org/packages/91/7c/1ef5c4473bfcbc236eadb45611b567d752a38478ab9a4e532db8dfc5692c/pibooth_extra_lights-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-17 05:15:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pibooth",
"github_project": "pibooth-extra-lights",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pibooth-extra-lights"
}
JSON
