mirror of
https://github.com/zyphlar/doorlock.git
synced 2024-04-03 21:36:03 +00:00
92 lines
2.2 KiB
Markdown
92 lines
2.2 KiB
Markdown
# Chimera Doorlock
|
|
|
|
## Overview
|
|
|
|
- Cards are synced with Cobot
|
|
- Cards are stored in `cards.json` in the root of the project (should be `~/doorlock/cards.json` on the RaspberryPi)
|
|
- Logs are stored in `logs.json` in the root of the project (should be `~/doorlock/logs.json` on the RaspberryPi)
|
|
|
|
## TODO
|
|
|
|
- [ ] Update list of cards every few minutes
|
|
- [ ] Push up logs/checkins to management app
|
|
- [ ] Get working with Nexedus
|
|
- [ ] Handle error message
|
|
|
|
## Configuring Raspberry Pi
|
|
|
|
On the RPI:
|
|
|
|
```bash
|
|
# Change to "sudo" user
|
|
sudo su
|
|
|
|
# Install nvm
|
|
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
|
|
|
|
# Install forever
|
|
npm i -g forever
|
|
|
|
# Clone the project and install dependencies
|
|
cd ~
|
|
git clone https://github.com/chimera/doorlock.git
|
|
cd doorlock
|
|
nvm install
|
|
nvm use
|
|
npm install
|
|
|
|
# Setup environment variables
|
|
cp .env.example .env
|
|
vi .env
|
|
# Add missing environment variables
|
|
|
|
# Start app
|
|
forever start src/server.js
|
|
```
|
|
|
|
Follow the [install from source guide for node-hid](https://github.com/node-hid/node-hid#compiling-from-source) becuase there is no pre-built binary for RaspberryPi
|
|
|
|
```
|
|
npm install -g node-gyp
|
|
apt install build-essential git libudev-dev gcc-4.8 g++-4.8 libusb-1.0-0 libusb-1.0-0-dev
|
|
export CXX=g++-4.8
|
|
npm install node-hid --build-from-source
|
|
```
|
|
|
|
You should now be able to view the app at http://localhost:3000
|
|
|
|
# Autostart
|
|
|
|
On a RasPi, copy the contents of the autostart file into: `~/.config/lxsession/LXDE-pi/autostart`
|
|
|
|
Optionally, to help users with debugging, run `ln -s /home/pi/doorlock/start.sh ~/Desktop/start-doorlock.sh` to give them a link on the desktop.
|
|
|
|
Or generally, find some way to run `./start.sh` in this folder
|
|
|
|
## Further reading
|
|
|
|
- [USB Relay library](https://github.com/darrylb123/usbrelay)
|
|
- https://obrienlabs.net/setup-raspberry-pi-kiosk-chromium/
|
|
|
|
## Contributing
|
|
|
|
Contributions welcome!
|
|
|
|
Want to contribute? Submit a Pull Request with your changes!
|
|
|
|
Using this in your own project? Let us know by creating an issue in Github!
|
|
|
|
## Credits
|
|
|
|
Developed by [Dana Woodman][dana] © 2018.
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
[cobot]: https://www.cobot.me/
|
|
[dana]: http://danawoodman.com
|
|
[jest]: https://facebook.github.io/jest
|
|
[latch]: https://www.amazon.com/gp/product/B00V45GWTI
|
|
[relay]: http://a.co/d/hbuockB
|