/obsidian

Displays Jenkins build status with a string of RGB LED

Primary LanguagePythonApache License 2.0Apache-2.0

obsidian Tek-OSS CodeFactor Total alerts

Displays Jenkins build status with a string of RGB LED

Maintainer

BOM

  1. A Raspberry Pi with Raspbian OS

    • CanaKit Raspberry Pi 3 B+ (B Plus) with Premium Clear Case and 2.5A Power Supply
    • A microSD card for the Raspberry Pi to run the Raspbian OS

  2. WS2812B addressable RGB LED strip

    • 2x WS2812B RGB 144 LED Strip Light 5V White PCB Waterproof IP67)
    • 1x 5V 10A power supply to drive the LEDs

Dependencies

sudo pip install rpi_ws281x (https://github.com/rpi-ws281x/rpi-ws281x-python)

How to setup the light

  1. Connect the WS2812b data pin (the middle wire) to GPIO 18 (or GPIO 13 for channel 2).
  2. Supply power with enough current to the WS2812b LED strip (refers to the LED's spec for exact detail).
  3. Connect the R-Pi to a network (use wired connection if on a Corp network).
  4. Power up the Raspberry Pi.
  5. Access the Jenkins server from the R-Pi to verify network connection.
  6. Clone this repository then cd obsidian.
  7. sudo jenkins_status.py --check to check the light strip.
  8. Verify the light strip show some light patterns to confirm it is connected correctly.
  9. sudo jenkins_status.py --help for a list of arguments to pass to this function (recommended running it with screen -dmS obsidian for easy resume from any remote session).

Contributing

Contributor License Agreement Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.