Releases: gcobb321/icloud3_v3
iCloud3 v3.1.5.2b2 (2/17/2025)
Release Notes - v3.1.5.2
🎉 Improvements and New Features
- When the password is used to authenticate the Apple Account, Apple sends an email to the account owner that a login/authentication was done. An entry has been added to the Event Log when iCloud3 doe this. The authentication date/time (PST) in the Event Log message is, hopefully, the same as on the email.
🐛 Bug Fixes
- When iCloud3 started and was setting up the tracked devices, if the Mobile App device parameter was set to 'ScanFor' a device and that device was not found in the list of Mobile App devices, an error was aborting the setup process. This resulted in no Apple account or Mobile App devices being set up correctly. This has been fixed.
- Fixed several problems handling the Mobile App device when 'ScanFor:' was selected for a device on the Update iCloud3 Device screen.
- Fixed issues dealing with authenticating Apple Accounts in China where the '.cn' url suffix was not being set properly in all cases.
v3.1.5.1
Release Notes - v3.1.5.1 (2/11/2025)
This is a rerelease of v3.1.5 which was missing several updated files and was shown as v3.1.5b3'.
🎉 Improvements and New Features
- Improved - Internet connections errors are now detected and monitored. iCloud3 will pause all tracking until the Internet is back up. A status message is displayed in the Event log and a message will be sent to an iCloud3 device using the Mobile App that Home Assistant is Offline.
- Improved - Renamed and reorganized the Configure > Tracking Parameters screen and Field Formats & Event Log Parmaeters screens.
- New - The Picture Directory Filter can now be updated from the Update Device screen Picture Selection List.
- New - If no picture is selected for the Device (=None), the Device's icon that will be displayed can now be selected from Home Assistant's 'mdi:' icon image list (default=mdi:account).
🐛 Bug Fixes
- A location request was sent incorrectly to Apple when logging into or adding a new Apple Account. This caused an incorrect Invalid Username/Password message to be displayed and communication with the Apple account stopped.
- The Enter/Request Verification Code screen was not displaying correctly if there were no Apple accounts that needed to be verified or the Apple account was deleted.
- Waze History time/distance recalculation will no longer run again at midnight if it was run immediately. An update that is running can now be terminated.
- Fixed a problem creating a 'Server Error 500' loading the iCloud3 integration for the first time.
- Fixed a problem with the 'Away Time Zone' where the times displayed in the Event Log were were off by 12-hours. A Clock was also added to the device's name at the top of the Event Log when it is in an Away Time Zone.
iCloud3 v3.1.5 (2/11/2025)
Disregard this Release. Download v3.1.5.1 instead. It contains a correction to the version number.
iCloud3 v3.1.4.4 (1/19/2025)
Release Notes - v3.1.4.4
Note: v3.1.4.4 corrects an error introduced in v3.1.4.3 when logging into a new Apple account with the 'improved' Log File handler.
General Updates
- Log File (Improved) - Updated the methods used to filter email addresses and passwords from being displayed in the iCloud3 log files.
Configuration Screen Changes
- Update Apple Account Username Password screen (Fixed) - Adding a new Apple account or changing it's password would create an HA error when initializing the location of all devices in the account. This then caused a connection error message leading to tracking being paused and the the original login to be terminated.
- Tools (Fixed) - Fixed a problem where the `MENU > Return to the Menu screen' was not selected when the screen was displayed.
iCloud3 v3.1.4.3 (1/18/2025)
Release Notes - v3.1.4.3
General Updates
- Log File (Improved) - Updated the methods used to filter email addresses and passwords from being displayed in the iCloud3 log files
Configuration Screen Changes
- Update Apple Account Username Password screen (Fixed) - Adding a new Apple account or changing it's password would create an HA error when initializing the location of all devices in the account. This then caused a connection error message leading to tracking being paused and the the original login to be terminated.
- Tools (Fixed) - Fixed a problem where the `MENU > Return to the Menu screen' was not selected when the screen was displayed.
iCloud3 v3.1.4.2 (1/12/2025)
Release Notes - v3.1.4.2 (1/12/2025)
General Updates
- HACS (Updated) - Changed the method of launching the routine that checks HACS to see if there is an iCloud3 Update so HA won't complain.
- Internet Connection Error (Updated) - Improved the handling of problems when the Internet is not available. If an error occurs when iCloud3 is starting, tasks related to connecting to Apple servers are bypassed. All device tracking will be Paused for 20-minutes. iCloud3 will resume tracking to see if an internet connection can be established. If the internet is still down, tracking will be paused for another 20-minutes. The 'Home Assistant is Offline' message will be displayed in the HA Error Logs and as an alert on the Event Log screen.
- Waze History Nightly Maintenance (Update) - The Waze History Database end-of-day process includes updating the Waze Map Tracking sensor and other activities to tune the data base. Various activity messages were displayed on the first devices 'info' sensor. HA could not keep up with adding these update to the History Database. This was fixed by only displaying a progress counter to the Event Log instead.
- Other - Various message formatting improvements and other stuff I can not remember.
Configuration Screen Changes
- Apple Account Login (Fixed)
- Fixed a problem verifying the password before logging into the Apple account when iCloud3 was starting.
- Fixed a problem where a valid password may fail the initial verification test and an invalid password may pass the validation test.
- Fixed a problem where a password that failed the initial verification test could not be corrected on Configure > Data Sources ... > Apple Username/Password screen.
- Update iCloud3 Device (Fixed) - Fixed a problem where changing the Apple account and/or Mobile App device selection would be saved in the configuration file but not used when iCloud3 was restarted after the Configure update.
- Sensors (Updated) - Added an Action option to reset the sensor selection values to their initial configuration.
- Other Tracking Parameters (Fix) - Fixed an error when saving changes on this screen.
- Tools (New Items) - Added HA Restart/Reload iCloud3 and _Correct 2 Sensor Name Error correction tools.
iCloud3 v3 Documentation - iCloud3 User Guide can be found here
iCloud3 v3.1.4.1 (12/24/2024)
Release Notes - v3.1.4.1 (12/24/2024)
- CONFIGURE > ADD DEVICE (Fixed) - Fixed an error encountered adding a new iCloud3 device.
- CONFIGURE > UPDATE DEVICE - The Picture Selection list is refreshed when the Directory Filter on the Other Tracking Parameters screen is updated.
- ICONS - Added icons for iPhone, iPad and AirPods devices selected on the Update Device Configure screen.
- 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)
- 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.
- 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.
- 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.
- TOOLS SCREEN (New Feature) - A
Tools
screen replaces theActions
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. - 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.
- ERROR & WARNING MESSAGES (Improved) - Changed various messages to improve readability and simplify the text.
- 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)
- 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.
- 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.
- 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.
- TOOLS SCREEN (New Feature) - A
Tools
screen replaces theActions
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. - 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.
- ERROR & WARNING MESSAGES (Improved) - Changed various messages to improve readability and simplify the text.
- A lot of internal code changes to improve code maintenance and to remove dead code.
What's Next:
- YubiKey support.
- 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.
- 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
. - 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
- 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
- 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