What is it?

This device type allows the plug-in to process geofence and beacon data received via an http POST or GET request. See below for the correct URL formatting and accepted parameters.

This type of device can be used when the user has control over the formatting of the request data.



Add a new Custom Geofence User/Device Type

From the User / Devices configuration page, select Custom GeoFence (F)


Device Enabled

Enable / Disable this device.


Device Id

By default the plug-in will assign the HS3 device ref as the DeviceId. This can be changed but should be a unique value amongst Geofence device types within the plug-in.


Rebuild Child Devices Button

If a child device has been deleted or new features are added in a future plug-in release that require additional child devices, then this function will rebuild any missing child devices and add them to the group.



Base URL

For direct connection to HS3's web server: http://yourhomeseerserver/phl2api?dtype=CD&type=F

NOTE: https is supported if your HS3 web server is configured for https access.

For connection via MyHS: https://connected2.homeseer.com/phl2api?dtype=CD&type=F


NOTE: Both connection methods require the request to be authenticated. If using the MyHS method then use your MyHS credentials. For a direct connection use a valid HS3 user/pass combination.


A typical complete URL to send a geofence status might look like:

https://connected2.homeseer.com/phl2api?dtype=CD&type=F&device=1234&name=Geofence1&entry=1

This example would look for custom geofence device type with a DeviceId of 1234. If found it would then set the status of the geofence child device named "Geofence 1" to Inside.


Supported parameters are:

Parameter Name

Description

Accepted Values

device

DeviceId of the custom geofence device created above.

Any text

name

Name of the Geofence and should be unique within a single DeviceId.

Any text

entry

If the device has entered or exited the geofence.

0=Exit 1=Entry

beaconuuid

Unique beacon Id. If present the plug-in will treat as a beacon type.

Any text




Created with the Personal Edition of HelpNDoc: Free EBook and documentation generator