iLocatorBridge

Bridge between iCloud location and OpenHAB

Install:

1. Download and install (Needed for connecting to iCloud) https://github.com/picklepete/pyicloud

2. Edit configuration.ini to provide:

   • iCloud credentials & device(s), under the [iCloud] section
   • Geofence settings, under the [Geofencexxx] section
   • OpenHAB credentials & item(s), under the [OpenHAB] section
   • (Optional) Additional OpenHAB items under the [LocationItemsxxx] section

3. Run python iLocator.py

Notes regarding configuration.ini:

1. Support has been added for additional units of measure. You may now choose between m (meters), km (Kilometers), ft (feet), mi (miles) or nm (nautical miles).

2. Dynamic/Adaptive polling has been added for each Geofence. You provide a polling map that defines the polling rate within set distances from the POI. As your location changes, the poll time will adjust. The map is a comma-seperated key-value pair in the format "distance1=interval1,distance2=interval2, etc", beginning with the shortest distance first. An example polling map would be 100=300,1000=10,1001=60 which translates to (within 100 ft poll @ 300 sec, else within 1000ft poll @ 10 sec, else poll at 60 sec). See configuration.ini for additional examples.

   • If you do NOT want to take advantage of adaptive polling, you can simply enter 0=60 to poll every 60 seconds, or 0=300 to poll every 5 minutes, etc.
   • Polling maps are provided at the Geofence level so if you have more than one Geofence configured, the bridge will compare the polling maps for the current distance and use the lesser of all the polling intervals. This ensures that the shortest interval is enforced.

3. In addition to updating a "Presence" item in OpenHAB, the bridge now provides functionality for posting additional information back to OpenHAB including Current Distance, Current Polling Rate, Next Poll Time, Status, Coordinates & Accuracy. All six of these are optional and do not need to be configured if you choose not to use them.

   • OHItem & OHItem_Presence are configured inside the Geofence settings as these are specific to each Geofence.
   • OHItem_PollingRate, OHItem_NextPollTime & OHItem_Status are configured inside the OpenHAB settings as these are global and apply to all Geofences.
   • OHItem_Coordinates & OHItem_Accuracy are configured inside the LocationItems settings and allow you to store the coordinates (and accuracy) of each polled device in seperate OpenHAB items. Configure as needed.
   • OHItem_Status is designed to be an indicator that the bridge is unable to locate your phone. If it fails to get device coordinates, it will pass the error message to the Status item. If no error occurs, the string "Active" is passed to the Status item.

4. Some errors on the iCloud side can cause the API to return no usable JSON object. The only apparent way to fix this is via a restart of the script, which forces re-authentication with the iCloud server. The script now has the ability to restart itself. Two things are required for this to work:

   • Define your number of 'RetriesBeforeRestart' in the config file. A value of 0 will never attempt a restart.
   • Ensure that your script is executable. On a unix based system, you would use chmod like: chmod a+x /usr/sbin/iLocator.py