0.2.0 • Published 8 years ago

homebridge-openpaths v0.2.0

Weekly downloads
2
License
ISC
Repository
github
Last release
8 years ago

homebridge-openpaths npm version

Presence Detection (OpenPaths) Plugin for HomeBridge

Basics of how this plugin works: 1. Retrieve the latest location record from OpenPaths server periodicly. 2. Calculate distance between the latest location and the reference location. 3. Determine if the distance is greater than the geofence setting. 4. Update occupancy sensor state if there's a change.

Installation

  1. Register in OpenPaths.
  2. Login and locate your Access Key and Secret Key in OpenPaths.
  3. Install the OpenPaths app (iOS/Android).
  4. Login and start collecting location data using your phone.
  5. Install homebridge using npm install -g homebridge.
  6. Install this plugin using npm install -g homebridge-openpaths.
  7. Update your configuration file. See configuration sample below.

Configuration

Edit your config.json accordingly. Configuration sample:

"accessories": [{
   "accessory": "OpenPaths",
   "name" : "OpenPaths",
   "people": [{
       "name": "Person 1",
       "access": "Access Key for Person 1",
       "secret": "Secret Key for Person 1"
   }, {
       "name": "Person 2",
       "access": "Access Key for Person 2",
       "secret": "Secret Key for Person 2"
   }],
   "latitude": "37.2972061",
   "longitude": "-121.957494",

   "geofence": "500",
   "refresh": "10",
   "manufacturer": "Manufacturer",
   "model": "Model",
   "serial": "Serial Number"
}]
FieldsDescriptionRequired
accessoryMust always be OpenPaths.Yes
nameThe name of your device.Yes
peopleArray of OpenPaths accounts for presence detection.Yes
latitudeLatitude of reference location for presence detection.Yes
longitudeLongitude of reference location for presence detection.Yes
geofenceSize of reference location geofence in ft (Default 500ft).No
refreshInterval to poll for user location in s (Default 10s).No
manufacturerThe manufacturer of your device.No
modelThe model of your device.No
serialThe serial number of your device.No
0.2.0

8 years ago

0.1.9

8 years ago

0.1.8

8 years ago

0.1.7

8 years ago

0.1.6

8 years ago

0.1.5

8 years ago

0.1.4

8 years ago

0.1.3

8 years ago

0.1.2

8 years ago

0.1.1

8 years ago

0.1.0

8 years ago