InstallationAndUsage.md

Installation

These instructions assume a fresh installation of Raspberry Pi OS Buster.

Install dependencies

sudo apt update
sudo apt upgrade
sudo apt install build-essential git libboost-program-options-dev libcurl4-openssl-dev libcurlpp-dev libgif-dev scons

Clone and build

cd ~
git clone --recursive https://github.com/SeanCline/build-indicator.git
cd build-indicator
make dependencies && make

Usage

Example usage

If you wanted to report the build status of the Apache Tomcat project on a UnicornHat, you would run:

sudo ./build-indicator --reporter=UnicornHat --status-uri="https://builds.apache.org/job/Tomcat/job/tomcat-taglibs/job/tomcat-taglibs-standard/job/main/api/json"

For more advanced usage, consult the command line parameters.

Command Line Parameters

General Parameters

--reporter <arg>     The module that will be used to report build status. (e.g. PWM, UnicornHat)
--status-uri <arg>   The Jenkins '/api/json' url to periodically extract build status from.
-t [ --polling-period ] <arg> (Default: 30) Seconds between status updates from the Jenkins server.

UnicornHat Reporter Parameters

--brightness <arg>   (Default: 0.2)            Unicorn Hat brightness (0 to 1)
--boot-gif <arg>     (Default: boot.gif)       GIF to show when starting up.
--success-gif <arg>  (Default: successful.gif) GIF to show when build succeeded.
--failed-gif <arg>   (Default: failed.gif)     GIF to show when build failed.
--building-gif <arg> (Default: building.gif)   GIF to show when currently building.
--unknown-gif <arg>  (Default: unknown.gif)    GIF to show when build status is unknown.