iCloud3 v3.0.5.1 (5/25/2024)

Change Log - v3.0.5.1 (5/25/2024)

1. MOBILE APP (Fix) - Fixed a problem where the device's Mobile App data source would be disabled (reset to NotUsed) if the HA Mobile App Integration was set up after the Mobile App's initial locate had been completed.
2. TRANSLATION FILE (new) - Added Chinese (Simplified) translation (@MagicStarTrace)

Important Links:

Migrating from v2.4.7_ - See here for instructions on migrating from from an older version.
Installing for the first time_ - See here for instructions on installing as a New Installation
iCloud3 v3 Documentation - iCloud3 User Guide can be found here

iCloud3 v3.0.5a (5/19/2024)

Note: This replaces the v3.0.5 previously updated.

Change Log - v3.0.5 (5/19/2024)

1. HACS UPUDATE ALERT (New) - The HACS Integration information will be check on a regular basis to see if a newer version of iCloud3 is available.
2. ICLOUD ACCOUNT AUTHENTICATION/FAMSHR DEVICES LIST (Fixed) - During startup ("Stage 4), the iCloud Account access is set up and the devices in the Family Sharing List is read. If a problem occurred, iCloud3 would retry this 10-times to see if the error was corrected. However, the FamShr data was not being reread and the old data was being used. The FamShr data is now reread correctly when trying to recover from this error.
3. UPDATE DEVICES SCREEN (Fixed) - When upgrading a device (iPhone, iPad, Watch) and both the old and new devices are still in the Family Sharing List, the new device was being set back to the old device the next time iCloud3 was started.
4. LOCKED ICLOUD ACCOUNT (New) - An error message is displayed in the HA logs and on the Event Log if the iCloud account is locked.
5. EVENT LOG (Fix) - An 'Unbound event_recd' error would display when the length of the the event text > 2000 characters (@ehendrix23).

Important Links:

• Migrating from v2.4.7_ - See here for instructions on migrating from from an older version.
• Installing for the first time_ - See here for instructions on installing as a New Installation
• iCloud3 v3 Documentation - iCloud3 User Guide can be found here

iCloud3 v3.0.4 (5/7/2024)

Important Links:

Migrating from v2.4.7_ - See here for instructions on migrating from from an older version.
Installing for the first time_ - See here for instructions on installing as a New Installation
iCloud3 v3 Documentation - iCloud3 User Guide can be found here

Change Log - v3.0.4 (5/7/2024)

1. ADD DEVICE (Fixed) - An 'Out of Range' error message was encountered adding the first device.
2. DIRECTION OF TRAVEL (Improvement) - Tweaked the AwayFrom direction override when approaching Home after the previous directions were Towards.
3. Event Type DEPRECIATED EOORO MESSAGE (Fixed) - This was a warning about the removal of the EventType from HA next year. It has been removed.
4. RAWDATA LOGGING - Changed some formatting of the log to better filter device messages.

iCloud3 v3.0.3 (5/1/2024)

Important Links:

Migrating from v2.4.7 - See here for instructions on migrating from from an older version.
Installing for the first time - See here for instructions on installing as a New Installation
iCloud3 v3 Documentation - iCloud3 User Guide can be found here

Change Log

1. ALERTS (New) - An alert message is displayed on the Event Log and in the alert attribute on the device's device_tracker and badge entities until it has been resolved. Examples of alerts are a startup error, no gps data, the device is offline, the battery below 20%, and tracking is paused. The alert attribute can be used in an automation to trigger sending a message to any device using the Mobile App. See the Reference > Devices and Other Alerts chapter in the iCloud3 docs here for more information and example automations.
2. BATTERY (Improvement) - The battery information attribute has been added to the device's device_tracker and badge entity. It shows the battery level, charging state, when the information was updated and the source of the data. The charging status text has been changed to 'Charged', 'Charging', 'NotCharging', 'Low' and 'Unknown'.
3. UPDATE SENSOR (Fixed) - An 'AttributeError' message has been fixed. It was caused by trying to update the sensor before the sensor had been set up.
4. CONFIGURE SETTINGS > ICLOUD ACCOUNT AND MOBILE APP screen (Fixed) - Changing iCloud account information (Username or password) was not being saved correctly so restarting iCloud3 would still use the old account. A Log Off option was added to initialize the iCloud Account username/password fields.
5. DIRECTION OF TRAVEL (Improvement) - When Driving towards Home, the calculated straight line distance is used to determine the travel direction ('Towards'). The direction would momentarily change to 'AwayFrom' if the distance from Home increased due to a curve in the road or you were stopped at an intersection. It would then change back to 'Towards' on the next update. In this case, the direction will not be changed and will remain 'Towards'.
6. Other minor code changes, tuning and code cleanup.

iCloud3 v3.0.2a (3/30/2024)

Important Links:

• iCloud3 Documentation is here
• The Installing iCloud3 chapter describes migrating from iCloud3 v2 and installing iCloud3 for the first time

Change Log

1. ICLOUD SERVER ERROR MESSAGE (Fixed) - When the iCloud servers did not respond with location information, the 'no response from iCloud servers' error was displayed correctly. This was followed by another unrelated error which should have not been displayed.
2. ALERTS, STARTUP ERRORS, WARNING MESSAGES (New) - Unusual errors or warning events for iPhones, iPads, and Watches are displayed in a green bar on the first line of the Event Log whenthe event occurs. The message will continue displaying until the event is corrected. This includes (1) startup errors, (2) no data received from iCloud Location Servers, (3) when a device is offline and (4) when a device's location is over 5-hours old and (5) when tracking is paused. The messages from AirPods and iPods are only displayed when their Event Log screen is displayed.
3. OTHER - Minor code corrections and cleanup.

iCloud3 v3.0.2 - No longer available

No Longer Available. Download Release iCloud3 v3.0.2a (3/30/2024).

iCloud3 v3.0.1.1 (3/24/2024)

1. Fixed a problem writing log info to the icloud3-0.log log file when HA did not have the logger: statement in the configuration.yaml file.

iCloud3 v3.0.1 (3/20/2024)

v3.0.1 - 3/20/2024

1. UPDATE SENSOR & DEVICE TRACKER ENTITIES (Improvement) - Changed the method of updating these items at the request of @balloob (Paulus Schousten, HA Founder) to prevent a potential Home Assistant lockup when doing an update.
2. LOG FILE (Improvement) - Changed the method of updating the iCloud3 log files. Also changed some of the record formatting to improve readability.
3. WAZE & CALC DISTANCE SENSORS (Fixed) - They were not being created.
4. UPDATE DEVICES CONFIGURE SCREEN (Fixed) - The Picture parameter was listing every image file in the all of the www/ sub-directories. A filter was added to limit the search to specific directories. The filter is defined on the Tracking and Other Parameters screen. Only the first 25 image files in a directory will be displayed to prevent overloading the HA dropdown list handler.
5. FIXED INTERVAL (Improvement) - The lowest interval was reduced from 5-minutes to 3-minutes.
6. DIRECTION OF TRAVEL (Improvement) - Changed the way this is being updated. If the distance from Home is more than 400m/250mi, it will be set to FarAway.
7. STATIONARY ZONE (Fixed) - The second device to enter an existing Stationary Zone was not saving the Stationary Zone info correctly.

iCloud3 v3.0 (2/26/2024) ⛔ See v3.0 (3/4/2024) release below

iCloud3 v3.0 is now available for general use.

This is the final version. There are no more release candidates.

Thanks for all the help while I worked through getting the new version of iCloud3 up and running.

It was a rewrite of iCloud3 v2 to bring it up to date, add a lot of new features, support the latest version of Home Assistant, become an Integration with on-line configuration and provide a path for adding new features..

For those that are interested, iCloud3 contains 33,002 lines of code, which is a lot of code. For comparison, the HA iCloud Integration is 1445 lines. It took over 2-years to write and was in beta/release candidate state for another 1-year.

It was a fun project but I am glad to wrap it up. Hopefully, you will find it useful.

Thanks again for the help.

Gary

iCloud3 v3.0 (3/4/2024)

iCloud3 v3.0 is now available for general use.

This is the final version. There are no more release candidates.

Thanks for all the help while I worked through getting the new version of iCloud3 up and running.

It was a rewrite of iCloud3 v2 to bring it up to date, add a lot of new features, support the latest version of Home Assistant, become an Integration with on-line configuration and provide a path for adding new features..

For those that are interested, iCloud3 contains 33,002 lines of code, which is a lot of code. For comparison, the HA iCloud Integration is 1445 lines. It took over 2-years to write and was in beta/release candidate state for another 1-year.

It was a fun project but I am glad to wrap it up. Hopefully, you will find it useful.

Thanks again for the help.

Gary

Change Log (3/4/2024) - The version number is still v3.0 since this does not effect any current v3.0 installations.

1. WAZE & CALC DISTANCE SENSORS - Fixed problem where they were not being created.
2. UPDATE DEVICES CONFIGURE SCREEN - The Picture parameter was listing every image file in the all of the www/ sub-directories. A filter was added to limit the search to specific directories. The filter is defined on the Tracking and Other Parameters screen. Only the first 25 image files in a directory will be displayed to prevent overloading the HA dropdown list handler.
3. FIXED INTERVAL - The lowest interval was reduced from 5-minutes to 3-minutes.