Add some notes to readme

This commit is contained in:
Dana Woodman 2018-08-12 14:19:50 -07:00
parent bd6b19f874
commit b1b52ac671

View File

@ -1,9 +1,16 @@
# Chimera Doorlock # 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 ## TODO
- [ ] Update list of cards every few minutes - [ ] Update list of cards every few minutes
- [ ] Push up logs/checkins to management app - [ ] Push up logs/checkins to management app
- [ ] Get working with Nexedus
- [ ] Handle error message - [ ] Handle error message
## Configuring Raspberry Pi ## Configuring Raspberry Pi
@ -37,6 +44,15 @@ vi .env
forever start src/server.js 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
sudo 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 You should now be able to view the app at
Place this at the bottom of your `~/.bashrc` file: Place this at the bottom of your `~/.bashrc` file: