Files
drunkendotfiles/vendor/breakout-garden/examples/nightlight/README.md
dissimulo 030172f523 Initial backup of LTP-305G matrix clock setup on matrixpi
Captures everything needed to redeploy the two-display clock (hour on I2C
0x61, minute on I2C 0x63) on a fresh Pi:

- Both systemd units (matrix0x61.service, matrix0x63.service)
- Deployed Pimoroni script tree, including the local %I (12-hour) clock
  customization
- Vendored upstream sources (ltp305-python, breakout-garden) so restore is
  fully offline-capable
- Boot config snippet enabling I2C
- install.sh that wires it all back up idempotently
- Inventory doc cross-referencing every live-system path

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-06 01:32:39 -07:00

35 lines
1.3 KiB
Markdown

# Nightlight example
A simple little example of how to make a nightlight with the LTR-559 and 5x5
RGB matrix breakouts. It can be toggled on or off by tapping the sensor, or
triggered automatically when it gets dark.
## Pre-requisites
This example requires:
- A Pimoroni [Breakout Garden](https://shop.pimoroni.com/products/breakout-garden-hat-i2c-spi)
- A Pimoroni [LTR-559 Light & Proximity Sensor Breakout](https://shop.pimoroni.com/products/ltr-559-light-proximity-sensor-breakout)
- A Pimoroni [5x5 RGB Matrix Breakout](https://shop.pimoroni.com/products/5x5-rgb-matrix-breakout)
## Installation
Pop the breakouts into your Breakout Garden, and then run the `install.sh`
script in the root of this repository with `sudo ./install.sh` to automagically
install all of the required libraries.
## Running this example
To run this example, type `./nightlight.py` in the terminal.
You can change the RGB values of the `colour` variable to change the colour
of the light to whatever you wish. If you want the light and proximity
thresholds to be more or less sensitive, then you can change the values of
the `light_threshold` and `prox_threshold` variables.
## Notes
It's probably best to have the sensor and matrix breakouts on either side
of your Breakout Garden HAT, so that they're spaced apart and the LTR-559
won't be affected by the light from the matrix.