31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
Overview
|
|
=
|
|
This project is a basic lighting system that can be used with smaller SentrySafe products such as the X125 model.
|
|
|
|
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.
|
|
|
|
Config
|
|
=
|
|
In the code you'll find the following variables which may need tweaking
|
|
|
|
* 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
|
|
|
|
Code License
|
|
=
|
|
All code is licensed under the Apache 2 License (http://www.apache.org/licenses/LICENSE-2.0) unless otherwise specified.
|
|
|
|
The following external libraries are included and may not be licensed under the Apache 2 License
|
|
|
|
* Adafruit NeoPixel Library
|
|
* SparkFun Lipo Fuel Gauge Library / Example code
|
|
* "Sleepy" class from https://github.com/jcw/jeelib/
|
|
* Metro timing lib from https://github.com/thomasfredericks/Metro-Arduino-Wiring
|
|
|
|
Non-Code License
|
|
=
|
|
All non-code Assets, documentation, etc is licensed under the Creative Commons Attribution-ShareAlike 3.0 license (https://creativecommons.org/licenses/by-sa/3.0/us/)
|
|
|