Simple modular presence tracker.
npm install -g presence-tracker
Note: Requires Node version 4+ LTS.
curl -o config.json https://raw.githubusercontent.com/matjaz/presence-tracker/master/config.example.json
# edit providers & paths to json files (should be writeable)
vi config.json
See config options for detailed explanation.
presence-tracker -c config.json
Providers are mechanism how to detect device presence. Built-in providers are ARP scan, ping and TCP connect. Additional providers such as arping or even iBeacon can be added.
List active providers
GET /providers
Each provider can be dynamically configured. Including listing, adding & removing tracked devices.
GET /providers/:id - list all devices
GET /providers/:id/:deviceId - show device details
POST /providers/:id - Add a device
DELETE /providers/:id/:deviceId - Remove a device
Add new device to check
curl -v -X POST -H 'Content-Type:application/json' 'http://localhost:3000/providers/ping' -d '{"id":"192.168.1.1"}'
Note: You need ping binary on system to use ping provider.
Example: Add check if router is accessible
curl -v -X POST -H 'Content-Type:application/json' 'http://localhost:3000/providers/tcp-connect' -d '{"id":"router","host":"192.168.1.1","port":80}'
ARP scan config options are passed to arpscan package.
Note: You need arp-scan binary on system to use ARP scan provider.
Mark device as present
curl -v -X POST http://localhost:3000/providers/http/mydevice/present
Mark device as absent
curl -v -X DELETE http://localhost:3000/providers/http/mydevice
Tracker supports plugins to extend its functionality. Built-in plugins are REST Server, Webhooks & Storage.
All presence data is available through REST API.
GET /.meta - get metadata
GET / - returns all present devices
GET /:id - get device
GET /:id/data - get custom device data
PATCH /:id/data - add custom device data
Add custom data with
curl -v -X PATCH -H 'Content-Type:application/json' 'http://localhost:3000/192.168.1.2/data' -d '{"name":"My phone"}'
To remove data set property to null
curl -v -X PATCH -H 'Content-Type:application/json' 'http://localhost:3000/192.168.1.2/data' -d '{"name":null}'
Tracker supports dynamic hooks for present and absent events. It also supports REST interface managment.
GET /hooks - return current webhooks
POST /hooks - dynamically add new webhook
GET /hooks/:id - return webhook
DELETE /hooks/:id - remove webhook
Add new present webhook
curl -v -X POST -H 'Content-Type:application/json' 'http://localhost:3000/hooks' -d '{"event":"present","options":"http://localhost:1337/hooks/present"}'
Note: options can be URL string or http.request options.
Storage persists custom device data, when app is restarted.
If you like the app, buy me a beer!
Bitcoin address 1CsnykfypeoemhhUXcr28EbHjv5DViAZfm
]