iCloud3 v3.1.4.1 (12/24/2024)

Release Notes - v3.1.4.1 (12/24/2024)

1. CONFIGURE > ADD DEVICE (Fixed) - Fixed an error encountered adding a new iCloud3 device.
2. CONFIGURE > UPDATE DEVICE - The Picture Selection list is refreshed when the Directory Filter on the Other Tracking Parameters screen is updated.
3. ICONS - Added icons for iPhone, iPad and AirPods devices selected on the Update Device Configure screen.
4. ICLOUD3 LOG FILES - The file name was changed from icloud3-0.log to icloud3.log in v3.1.4. The old files will be deleted.

Release Notes - v3.1.4 (12/22/2024)

1. APPLE ACCOUNT PASSWORD AUTHENTICATION:
   • Reverted back to the old password authentication protocol before the Secure Remote Password (SRP) protocol was implemented
   • The Password SRP protocol will be tried if the old password authentication protocol fails.
2. ADD ICLOUD3 DEVICE SCREEN (Redesign) - Redesigned the screen so the basic tracking parameters (iCloud & Mobile App devices and picture) are selected on this screen instead of the Update Device screen.
3. UPDATE DEVICE SCREEN (Redesign) - The rarely used fields (inZone & Fixed Interval, Track from Zone, etc) are not displayed if they are using the default values. A check box is enabled to display these fields.
4. TOOLS SCREEN (New Feature) - A Tools screen replaces the Actions screen on the Configure Menu screen. This is used for configuration file maintenance to reset all Devices Apple Account fields, Delete all Apple Accounts and Devices, Delete all iCloud3 and Apple Account cookie files, etc.
5. STARTUP (Improved) - Error and warning messages have been improved when setting up Apple Accounts and the Mobile App devices. When errors are encountered (devices can not be found, invalid Apple Account information, etc), an attempt will be made to correct the error using known device names and identification codes. Sometimes it works, sometimes it doesn't and the configuration will need to be updated.
6. ERROR & WARNING MESSAGES (Improved) - Changed various messages to improve readability and simplify the text.
7. MISCELLANEOUS CHANGES - A lot of internal code changes to make messages consistant, alerts all the same format with the samt highlight icons, improve code maintenance and to remove dead code and more.

iCloud3 v3.1.4 (12/23/2024)

Change Log - v3.1.4 (12/23/2024)

1. APPLE ACCOUNT PASSWORD AUTHENTICATION:
   • Reverted back to the old password authentication protocol before the Secure Remote Password (SRP) protocol was implemented
   • The Password SRP protocol will be tried if the old password authentication protocol fails.
2. ADD ICLOUD3 DEVICE SCREEN (Redesign) - Redesigned the screen so the basic tracking parameters (iCloud & Mobile App devices and picture) are selected on this screen instead of the Update Device screen.
3. UPDATE DEVICE SCREEN (Redesign) - The rarely used fields (inZone & Fixed Interval, Track from Zone, etc) are not displayed if they are using the default values. A check box is enabled to display these fields.
4. TOOLS SCREEN (New Feature) - A Tools screen replaces the Actions screen on the Configure Menu screen. This is used for configuration file maintenance to reset all Devices Apple Account fields, Delete all Apple Accounts and Devices, Delete all iCloud3 and Apple Account cookie files, etc.
5. STARTUP (Improved) - Error and warning messages have been improved when setting up Apple Accounts and the Mobile App devices. When errors are encountered (devices can not be found, invalid Apple Account information, etc), an attempt will be made to correct the error using known device names and identification codes. Sometimes it works, sometimes it doesn't and the configuration will need to be updated.
6. ERROR & WARNING MESSAGES (Improved) - Changed various messages to improve readability and simplify the text.
7. A lot of internal code changes to improve code maintenance and to remove dead code.

What's Next:

1. YubiKey support.
2. Implementation of the Password SRP protocol as the primary method of authentication passwords. It works but asks for the 6-digit verification code constantly. I have things to try but it will need long-term testing to insure the verification code request is minimized.
3. There are times when HA adds a _2 extension to the device_tracker and sensor entity name when HA is reloaded and the iCloud3 integration is still running. A new Tool will be developed to easily reset these entity names to their correct name without the _2.
4. Update the iCloud3 User Guide with all the new stuff and to make it easier to find what you are looking for.

Important Links:

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
Migrating from v2.4.7_ - See here for instructions on migrating from from an older version.

iCloud3 v3.1.3 - 11/9/2024

Change Log - v3.1.3 - 11/9/2024

1. UPDATE DEVICES SCREEN (Fixed) - Fixed a problem where an orphaned Mobile App device would prevent the Update Screen loading.

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.1.2 - 11/8/2024

Change Log - v3.1.2

1. INITIAL SETUP (Fixed) - This fixed some issues related an initial install where there are no apple accounts or where the iCloud3 Apple account's first configuration file entry was blank.. This fixes the error message:

   File "/config/custom_components/icloud3/config_flow.py", line 1974, 
       in async_step_update_apple_acct
   self._update_conf_apple_accounts(self.aa_idx, user_input)
   File "/config/custom_components/icloud3/config_flow.py", line 2055, 
       in _update_conf_apple_accounts
   if Gb.conf_apple_accounts[0][CONF_USERNAME] == '':
   ~~~~~~~~~~~~~~~~~~~~~~^^^
   IndexError: list index out of range
   

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.1.1 - 11/07/2024

Change Log - v3.1.1

1. LOCATING DEVICES:
   • Added additional checks to insure the Apple Account location data was refreshed during startup and while configuing iCloud3 settings. Fixed a problem where the location information data from Apple was not being initialized properly.
   • Fixed the location refresh not being done that caused the '0 of 0' to be displayed in the Configure Setting screens, leading to the Apple Account selection lists to not be populated.
   • Fixed some problems where 'Locate All Devices = False' would still locate all the devices in the Apple account
   • Added error checking to make sure the Locate All Devices can not be disabled if there were Family devices that
     were assigned to that Apple account. If it was disabled, they would never be located.
2. UPDATE DEVICE SCREEN - Added (and fixed) the TOOLS - RESET DATA SOURCE(S), DELETE DEVICE(S) option where you can reset the device's Apple Account and Mobile App to default values (None) and fixed a problem deleting devices. Reworked the Apple Account selection list to provide more information and identify setup errors.
3. UPDATE APPLE ACCOUNT USERNAME/PASSWORD SCREEN - Added checks to insure Locating All Devices can not be disabled if there are tracked devices assigned to this account that are in the Family list.
4. OTHER THINGS - Changed several things under the covers.

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.1 - 11/4/2023

Change Log - v3.1

1. APPLE ACCOUNT LOGIN (Fixed) - Apple changed the method of logging into the Apple Account to use Secure Remote Password verification where a hash-key is calculated from the password by both iCloud3 and Apple. The hash-key, instead of the password, is sent over the internet. Apple then compares the hash-key sent by iCloud3 to it's hash-key to determine the validity of the password. Note: In a few cases, the hash-key algorithm used by iCloud3 may not be the same as Apple for a valid password and you will need to change your password.
2. MULTIPLE APPLE ACCOUNTS (New) - iCloud3 now supports tracking devices from more than one Apple Account. The accounts are setup on the 'Configuration > Data Sources' screen and devices can be tracked from any apple account and the d if the device is set up as an account owners deviceThe Primary account belongs to the person with the main Family Sharing list as it always has. Secondary accounts can also be configured and devices from those accounts can be tracked. The Apple Account for the specific iCloud3 device is selected on the Update Devices screen as it always has.
3. FAMSHR - Everything called FamShr has been changed to iCloud.
4. THE APPLE ACCOUNT (Improved) - Logging into the Apple Account is now started before the beginning the HA process that creates the device_tracker and sensor entities. Both processes now run concurrently, eliminating (or reducing) any delays waiting for the Apple Account device data to be returned. The result is iCloud3 starts up faster.
5. APPLE ACCOUNT & MOBILE APP DEVICE ASSIGNMENT (Improved) - The results of matching the Apple Account iCloud devices and the Mobile App devices during startup are displayed in the Event Log. This has been simplified and is easier to read.
6. CONFIGURATION SCREENS (Improved) -
   • Saving changes is faster.
   • The iCloud3 Devices screen indicates if there is a problem with the iCloud or Mobile App device selection.
   • Update Devices screen - Impoved selection of Apple Account and Mobile App devices.
7. MISSING APPLE ACCOUNT DEVICES (Improved) - Sometimes, an iCloud device's information is not returned from iCloud when iCloud3 starts. The error recovery and data request retry routines have been rewritten to only retry setting up devices with the error. This greatly simplifies and reduces the steps needed to retrieve the data from iCloud.
8. WAZE & WAZE HISTORY (Improved) - Improved the error checking, added retry on error conditions and updated the History database recalculation routines to better support concurrent operations.
9. APPLE ACCOUNT DEVICE STARTUP ERRORS (Enhanced) - Improved the handling and reporting duplicate and missing Apple Account devices.
   8 STARTING/RESTARTING ICLOUD3 -
   • Device Sensors (Fixed) - They were being reinitialized when Restarting iCloud3 when they shouldn't have been.
   • Mobile App entities (Fixed) - They are no longer being reinitialized when iCloud3 is restarted on a configuration change or Event Log restart request. This includes the device_tracker, battery, trigger and notify entities..
   • Improved messaging and fixed miscellaneous bugs

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.5.9 (9/9/2024)

Change Log - v3.0.5.9 (9/9/2024)

1. DEVICE_TRACKER ATTRIBUTES (Fix) -Corrected a spelling error on one of the attribute names created in v3.0.5.8.

Change Log - v3.0.5.8 (9/8/2024)

1. CONFIGURATION - UPDATE DEVICES (Fixed) - An error would occur on the Configure > Update Devices screen if the Mobile App Integration had not been set up or if the name had not been set up on one of the Mobile App devices was missing. This occrured predominately when adding the first device to iCloud3.
2. DEVICE_TRACKER ATTRIBUTES (Update) - There are 3 sections on the device attribute's list to group similar attributes together. A title has been added to the section's dividing lines to prevent problems with other AddOns that use the attribute's name.

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.5.8 (9/8/2024)

Change Log - v3.0.5.8 (9/8/2024)

1. CONFIGURATION - UPDATE DEVICES (Fixed) - An error would occur on the Configure > Update Devices screen if the Mobile App Integration had not been set up or if the name had not been set up on one of the Mobile App devices was missing. This occurred predominately when adding the first device to iCloud3.
2. DEVICE_TRACKER ATTRIBUTES (Update) - There are 3 sections on the device attribute's list to group similar attributes together. A title has been added to the section's dividing lines to prevent problems with other AddOns that use the attribute's name.

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.5.7 (7/31/2024)

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

iCloud3 v3.0.5.6 (7/29/2024)

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