Change Log - v3.0.5.7 (7/31/2024)

1. ICLOUD3 PROBLEMS WITH HA 2024.7.4 - Fixed
2. ADD/UPDATE DEVICE CONFIGURATION (Fixed) - This was probably caused by HA 2024.7.4 Loading issues.
3. MOBILE APP NOTIFY MESSAGE (Fixed) - A warning message about not being able to send a notification to a device was displayed in the Event Log when the device was not using the Mobile App.

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.5.6 (7/29/2024)

1. ICLOUD3 BUG FIXES - Fixes the following errors:
   AttributeError: 'NoneType' object has no attribute 'init_step_complete'
AttributeError: module 'custom_components.icloud3.sensor' has no attribute _setup_recorder_exclude_sensor_filter'
2. HA ERROR/WARNING MESSAGES - Fixed a problem where some I/O getting directory and filename lists for the Update Devices configuration screen was being done outside of the HA Event Loop.

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.5.5 (7/16/2024)

1. ICLOUD3 FAILED TO LOAD (Fix) - iCloud3 injected special code into the HA history recorder to exclude various sensor entities with large text fields from being added to the history recorder. This caused problems with HA in the 2024.7 release. The HA 2024.7.2 included special code that blocked iCloud3 from loading. A temporary patch was posted on the iCloud3 GitHub repository to disable the recorder injection. This update is the real fix for this problem.

   All sensor attributes not related to the battery, distance and timer sensors are being added to the HA recorder history database. Text base sensor attributes are not being added (info sensors, Event Log sensor, badge, tracking update, zone, etc.)..

   SPECIAL NOTE: If you get an HA error that a sensor attribute is not available, create an issue on the iCloud3 GitHub repository. Let me know the sensor name and attribute name that is causing the error. I will remove it from the exclusion list in the next update.

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.5.2 (6/8/2024)

1. HA I/O ERROR FROM EVENT LOOP (Fixed) - HA was complaining about doing I/O (HACS file) outside of the Event Loop. Changed the method of doing I/O to use HA routines for the configuration file, restore state file and HACS file.
2. FROM_ZONE ERROR (Fixed) - Normally the TrackFrom Zone and NextUpdate Zone is the Home zone. Added a check to set it to Home if it had never been set.

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

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.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)

Change Log - v3.0.5 (5/18/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

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 ERROR 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.

Change Log - v3.0.3 (5/1/2024)

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.

Important Links:

• iCloud3 v3 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 when the 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, (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. See the Event Log chapter in iCloud3 documentation for more information.
3. OTHER - Minor code corrections and cleanup.

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 was updated to an official release on the iCloud3 v3 Development GitHub Repo on 3/5/2024. This is a minor update to that version.. It will be released for General Availability in April, 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.

This release fixes a few bugs with the Fixed Interval parameter introduced in rc10.1. It also simplifies access to NearBy device distance attributes and cleans up some code.

Gary

Important Links

Installing using HACS - iCloud3 is not available on HACS unless you have set it up as a custom repository. See here for instructions on how to do that and then install it. If you just go to HACS and do the installation, you will be installing v2.4.7, not v3.
Manual Download and Install - Go to the iCloud3 Releases page here. Scroll down past the notes, then select Assets, then select icloud3.zip. Download the zip file and unzip it into the /config/custom_components/icloud3 directory. Then restart HA.
Migrating from v2.4._ - See here for instructions on migrating from from an older version.
iCloud3 v3 Documentation - It is still in process, does not include the latest updates to iCloud3 and can be found here

Change Log

1. FIXED INTERVAL -

   1. Normally, when a device is getting close to Home, the location interval changes to 15-secs to be able to update the Home distance very quickly. This lets automations fire when approaching Home in addition to when entering the Home zone. When a Fixed Interval was being used, the Fixed Interval was overriding the short interval time iCloud3 calculated based on distance from Home so iCloud/FamShr locates were never being done. Additionally, a locate request would not be done if the Old Location Threshold was greater or the same as the Fixed Interval value and old locations were being accepted.

      Now, iCloud3 will calculate the interval using the distance from Home as it normally does. If that value is less than 5-minutes, it will be used. Otherwise, the Fixed Interval will be used if it is set.

   2. Fixed a problem where the results from one device with a Fixed Interval was being used for another nearby device that was not using a Fixed Interval.

   3. The minimum Fixed Interval is still 5-minutes.

2. TRAVEL TIME INTERVAL AND NEXT LOCATION UPDATE MULTIPLIER - (Configure Settings > Tracking Parameters screen) - This value (.1 to .8) is used to determine the Interval and when the Next Location Update should be made using the travel time to Home. For example, if the travel time is 8-mins and the multiplier is .5, the next update will be done in 4-mins. This has been changed from entering a decimal value (.1 to .8) to a drop down list that goes from Shortest Interval Time, to Shorter Interval Time, to Average, Longer and Longest. It defaults to Average (.5*TravelTime) and you will probably never change it.

3. HOME_DISTANCE & ZONE_DISTANCE SENSOR - Changed the way the zone and devices distances are displayed to provide better accuracy and make it easier to display them on a dashboard screen entity card. The iCloud3 documentation > Sensor Attribute chapter was updated to provide screenshots and example code that will help explain how to do this.

4. OTHER STUFF - Fixed a few other bugs. Cleaned up some code.