Browse Source

Update readme to be more clear and informative

master
Mike C 6 years ago
parent
commit
635d26198c
  1. 8
      README.md

8
README.md

@ -2,11 +2,11 @@ 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, Adafruit Trinket Pro for control, and has a sensor 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.
The project uses Adafruit NeoPixels as a light source, Adafruit Trinket Pro for control, and has a sensor to check if the safe door is open. The build allows users to change brightness and the color of the pixels using a pair of potentiometers. The build includes an on/off switch, always on switch and color/white switch for further control.
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. The "Fritzing" directory has all custom parts used so you can import them into the program and use the fzz file.
There is a Fritzing schematic of the project in the main folder (look for the fzz file) that outlines the parts and connections. The Fritzing document also includes a complete breadboard view for easier prototyping setup. The "Fritzing" directory has all custom parts used so you can import them into the program and use the fzz file.
There is a bill of materials (OpenOffice Calc format) in the main folder listing all parts that were used in the build.
@ -28,8 +28,8 @@ In the code you'll find the following variables which may need tweaking
* INTERACTIVE_DEBUG : Turn on a wait at start and longer timeouts so the output is easier to debug
* SLEEP_INTERVAL : The amount of time (in miliseconds) that the device sleeps for between checks
* ALERT_LEVEL : The battery level that generates an alert. This must be set between 1 and 32%, inclusive
* NEO_PIX_NUM : Set this to the number of NeoPixels in your build. I setup mine for 5 pixels but it can be more/less depending on need.
* USE_PIR : Turn on to enable the PIR distance sensor code
* NEO_PIX_NUM : Set this to the number of NeoPixels in your build. I setup mine for 5 pixels but it can be more/less depending on need and available power. NeoPixels consumer a lot of power and can easily use a full 500mA of power, overtaxing most power sources.
* USE_PIR : Turn on to enable the PIR distance sensor code. The existing code is only minimally tested and unreliable. You'll want to verify things work properly and/or update code as necessary
Known Issues
=

Loading…
Cancel
Save