mirror of
https://github.com/zyphlar/doorlock.git
synced 2024-04-03 21:36:03 +00:00
Add some notes to readme
This commit is contained in:
parent
bd6b19f874
commit
b1b52ac671
16
readme.md
16
readme.md
|
@ -1,9 +1,16 @@
|
|||
# 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
|
||||
|
@ -37,6 +44,15 @@ vi .env
|
|||
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
|
||||
|
||||
Place this at the bottom of your `~/.bashrc` file:
|
||||
|
|
Loading…
Reference in New Issue
Block a user