ISY Portal Node Server Occupancy & Locative app Instructions

From Universal Devices, Inc. Wiki
Jump to: navigation, search

Prerequisites

1) The user must be subscribed to the UDI Portal service, and approve the portal in ISY's Admin console.

2) The user must have configured the node server in the UDI Portal.

ISY Portal Node Server Occupancy Instructions

1) Log into the ISY Portal using valid login credentials at "https://my.isy.io/".

2) Select "Occupancy" by selecting "Select tool..." then "Node Server" then "Occupancy".

Portal Node Server SS 8.jpg


3) Select "Add a geofence", please enter a name for this geofence, such as "iPhone" and select "Save".

Portal Node Server SS 9.jpg

Portal Node Server SS 10.jpg


4) The user may also enter a location or locations if the user so desires. To add a location, select the "+" button to the right of the "Location" dropdown. Please enter a location name, such as "Home" and select "Save". A location represents the global status, which means that the location is considered occupied (true) if any of the location members are occupied (true).

  • Note: if the user plans on only having one location for geofences you may skip this step. Locations may be added later, and devices may be assigned or reassigned to locations anytime.

Portal Node Server SS 11.png

Portal Node Server SS 12.jpg


5) Once locations and geofences are saved, your "Occupancy" window should look like this:

Portal Node Server SS 13.jpg


6) Location nodes and geofence nodes should now be present in the admin console UI for consumption in programs.

Portal Node Server SS 14.jpg


7) In order to change the status of these nodes, the user must implement a mechanism for sending "GET" requests. The Mobile application "Locative" supports this functionality. Before Locative is configured, the user must obtain two unique URLs from the portal for each device/geofence they wish to change the status of. (one URL for IN, and one URL for OUT) These URLs can be obtained by selecting the blue arrow to the left of the device name in the "Occupancy" window.

Portal Node Server SS 15.jpg

Portal Node Server SS 16.jpg

Troubleshooting

  • If a geofence has accidentally been deleted in the admin console, or if there is an extra geofence that does not exist on the portal (such as restoring ISY to a backup that has more geofences) the user may select "Synchronize", then "Yes" to the dialog box, then "OK" to the dialog box to synchronize geofences between ISY and the portal.


Portal Node Server SS 22.jpg

Locative Application Instructions

1) Download and install "Locative" by Marcus Kida

Portal Node Server SS 17.jpg


2) Launch the application and select "+" to add a geofence.

3) Enter in a location, set the radius to the maximum, and select "POST / GET" to "GET". "Trigger on Arrival" and "Trigger on Departure" should be enabled. The User may enter a custom location ID such as "Home".

  • Note: setting geofence to maximum avoids issues with Locative trying to send GET requests over weak but connected Wi-Fi.

Portal Node Server SS 18.jpg


4) Log into the portal on the mobile device's browser, navigate to the "Occupancy" window by selecting "Select tool..." then "Node Server" then "Occupancy". Select the blue arrow to the left of the device name and copy both URLs presented in the dialog box one at a time. (one URL for IN, one URL for out)

  • Note: For this step, it is recommended that user access the portal via the mobile device they are setting up, so the user may copy and paste the URLs into Locative.

Portal Node Server SS 19.jpg


5) Paste the "IN" URL obtained in the previous step into the field "Trigger on Arrival".

Portal Node Server SS 20.jpg


6) Paste the "OUT" URL into the field "Trigger on Departure"

Portal Node Server SS 21.jpg


Locative is now configured with a geofence and able to send GET requests which change the status of device nodes in ISY.

  • Note: the user can test this functionality by leaving the geofence or by sending a test request in Locative's settings page.