https://github.com/alump/fridgecop
Fridge Cop is simple node.js service to be called from IFTTT when IOT door sensor fires.
https://github.com/alump/fridgecop
iot nodejs rest-api
Last synced: 2 months ago
JSON representation
Fridge Cop is simple node.js service to be called from IFTTT when IOT door sensor fires.
- Host: GitHub
- URL: https://github.com/alump/fridgecop
- Owner: alump
- Created: 2019-08-11T23:36:59.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-12T21:23:13.000Z (almost 7 years ago)
- Last Synced: 2025-04-13T21:14:23.212Z (about 1 year ago)
- Topics: iot, nodejs, rest-api
- Language: JavaScript
- Size: 157 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fridge Cop
## What Is It?
Me just trying to do simple REST service to call via IFTTT when it receives on/off signals from my IOT door open sensor. Idea is to use this to trigger alarm if fridge door is left open for more than N minutes. This is just fastly written PoC, free free to steal and adapt if useful.
## Usage
### Pull code and dependencies
To run app you need to have git, node and npm available on your machine.
> git clone https://github.com/alump/fridgecop.git
> cd fridgecop
> npm install
### Configuration
To define configuration, make actual config file from example file.
> cp config/fridgecop-config-example.json config/fridgecop-config.json
In file there are values `` and ``, generate those values with command:
>`./node_modules/.bin/web-push generate-vapid-keys`
After you have updated `config/fridgecop-config.json`, you can simply start application with:
### Run
> node app.js
After this you should see "Service started" message.
### Calling Service
#### REST/JSON Calls
To get current status call (GET): http://localhost:3000/status
To send "open" update call (GET): http://localhost:3000/open?secretKey=XXX
To send "closed" update call (GET): http://localhost:3000/closed?secretKey=XXX
To read the latest events (GET): http://localhost:3000/history
#### Browser
There is also page for browser: http://localhost:3000
### Configuration
You can get initial configuration copying example file to your config:
> cp config/fridgecop-config-example.json config/fridgecop-config.json
#### Configuration Values in config/fridgecop-config.json
| Key | Example Value | Description |
|---|---|---|
| "alarmMinutes" | 3 | How long door has to be open to cause alarm |
| "dbPath" | "./data" | Path were app's db files are stored |
| "deviceName" | "Fridge Door" | Name of your device |
| "email" | "john.doe@example.com" | Your email address |
| "historySize" | 10 | Amount of latest history events given by API |
| "httpPort" | 3000 | Which TCP port app will listen |
| "secretKey" | "password" | Secret key needed in open and closed calls |
| "serviceWorkerScope" | "/" | Replace if your app's path if not in domain "root" |
| "timeZone" | "America/Los_Angeles" | Time zone used with times |
| "vapidPublicKey" | | Generate value with `./node_modules/.bin/web-push generate-vapid-keys` |
| "vapidPrivateKey" | | Generate value with `./node_modules/.bin/web-push generate-vapid-keys` |
## Version History
### 0.0.1 Initialial Release (TBD)
- Still under development
## Dependencies
| Library | Used for |
|---|---|
| express | To offer HTTP services outside |
| express-handlebars | To template browser pages |
| express-ws | To push updates to browser |
| moment-timezone | To modify and present dates and times |
| nedb | To store information over restarts |
| uuid | To generate unique IDs |
| web-push | To push notifications to users |