Added readme

This commit is contained in:
Will Bradley 2011-12-11 04:14:44 -07:00
parent 5462099c20
commit 04c99c804e
4 changed files with 22 additions and 0 deletions

20
README.txt Normal file
View File

@ -0,0 +1,20 @@
Arduino Nagios Display
For creating an WiFi-enabled, Arduino-powered 8x5 LED matrix that displays Nagios status information
Intentionally kept hackable, with lots of commented-out sections and debugging information available, because everyone's environment is slightly different.
Included in distribution:
- ArduinoNagiosDisplay.pde, based on Arduino SimpleClient and shiftOutCode Hello World examples
- nag.php, based on GPL-licensed code by Jason Antman
- ShiftOutExample images, copyright Arduino
This program connects to a matching script on your Nagios server
(it must return a string like $00001000200002100000 -- see included php script.)
To assemble the hardware, I recommend an Arduino Diamondback, which is essentially an Arduino + WiShield.
Look at the included ShiftOutExample images which are taken from the Shift Out Arduino tutorial at http://arduino.cc/en/Tutorial/ShiftOut
The only difference is that the Diamondback/WiShield uses pins 14, 11, and 12 so I'm using pins 5,7, and 8 instead.
To get the microcontroller software working, look at the ArduinoNagiosDisplay.pde comments.
Also, put the nag.php script on your Nagios server outside of any authentication requirements. I put it at /var/www/nag.php . See the comment in the file and modify settings as needed.

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

View File

@ -35,6 +35,8 @@
// change the statusFile to the location of status.dat on your Nagios system
$statusFile = "/var/cache/nagios3/status.dat";
// ------------- end config
$nag_version = getFileVersion($statusFile); // returns integer 2 or 3
$created_ts = 0;