Browse Source

Improve documentation

master
Mike C 6 years ago
parent
commit
2120cd0a02
  1. 10
      README.md

10
README.md

@ -2,12 +2,22 @@ Overview
=
This project is a basic lighting system that can be used with smaller SentrySafe products such as the X125 model.
The project uses Adafruit NeoPixels as a lighting source, Arduino for control, and has support for different sensors to check if the safe door is open. The build also is setup to allow the color of the NeoPixels to be changed, brightness to be changed as well as an "always on" switch.
Build
=
There is a Fritzing schematic of the project in the main folder (look for the fzz file) that outlines how all of the parts need to be put together.
There is a bill of materials (OpenOffice Calc format) in the main folder listing all parts that were used in the build.
Customization
-
The build can be customized in the following ways
* Use an Adafruit Trinket Pro or Arduino Micro
* Use a SparkFun LiPo fuel gauge to track battery level and flash the lights when the battery reaches a critical level
* Use a magnetic door sensor or PIR distance sensor to check if the safe door has been opened
Config
=
In the code you'll find the following variables which may need tweaking

Loading…
Cancel
Save