Indicate Job status using a Lava Lamp
The lamp which I used was a "USB Glitter Light" available at low cost from your favourite online auction site, local market or pound store.
Unfortunately programmatic control of this type of lamp is not possible in the as-purchased state, when plugged in it is always on.
Therefore I designed a simple circuit around an FTDI MM232R module and some MOSFET drivers to accomplish this, also adding a piezo-beeper to alert developers when a build fails. The prototype was simply built on old-fashioned stripboard (0.1" pitch).
I used a self-drive piezo-electric beeper to provide an audible alert.
It would have been nice to fit the board inside the base of the lamp, but my prototype was too large, so the completed board was fitted in to a small plastic box with a DC power socket for the lamp. I cut the USB plug off the the lamp cable and replaced it with a matching DC power plug. An LED in parallel with the socket provides an additional on/off indication.
All of the documentation (including full resolution .svg diagrams) is contained within the Jenkins plugin LavaLampNotifier.hpi as LavaLampElectronics.zip.
You will need to use your favourite .zip tool, jar or unzip to extract it.
Since the Jenkins server is back in the server room, the lava lamp module is attached to USB on a desktop machine and a simple socket server runs to listen for build results.
FTDI provide free USB drivers for a number of operating systems. Higher level code still has to interface with the driver - a SourceForge project, FTD2XXj, has already done this, so writing a Java program to control it becomes very straightforward.
The lamp control software is also zipped up inside the released Jenkins plugin as LavaLampController.zip. Extract it from LavaLampNotifier.hpi , then unpack it to a directory on your Windows or Linux machine. An example Windows batch file lavalamp.cmd is provided which should get you up and running.
LavaLampServer arguments used within the script are:
LavaLampServer TCPPort UDPPort MCAddr MCPort TCPPort - Port to listen for TCP connections (or 0 to disaable TCP) (default:1999) UDPPort - Port to listen for UDP connections (or 0 to disable UDP) (default: same as TCPPort) MCAddr - Multicast Address to listen on (default: multicast disabled) MCPort - Port to listen for Multicast (default: same as UDPPort if multicast enabled)
TODO: Make the lamp controller work with the more generic Notification plugin as an alternative to the one below.
The notifier plug-in talks to this server across the network. (I could have used an existing RSS notifier, but didn't want the lamp to be polling Jenkins constantly, I rather preferred the immediacy of the result being "pushed" to a known listener.) It consists of a "global" module which allows configuration of any number of different LavaLamp host/port combinations (to support different jobs or projects).
A "per-job" module then allows selection of the lamp you want to notify with the status of each job.
Theoretically alternate "lamp server" modules could be developed which might not necessarily use a hardware lamp at all - listening on an IP-multicast address to pop up an icon in everybody's windows tray is one idea.