Releases · gcobb321/icloud3_v3

22 Jan 18:39

gcobb321

v3.0.0-beta-9

d90d0f7

iCloud3 v3, Beta 9, 1/22/2023 Pre-release

Pre-release

Beta 9

This update fixes some problems, adds a new feature dealing with sensors and makes some minor changes, The highlights are:

Fixed a problem with the zone's HA name was not being used for zone sensors, leading to problems with the HA person entity,
Fixed some problems with the battery level and status not being reported correctly or updated in a timely manner.
Fixed a problem where nearby devices could loop back to themselves, causing iCloud3 to hang and stop tracking devices.
Fixed several problems calling the iCloud3 update service.
Alert messages are not summarized at the end of the startup process to make them less likely to be missed.
Cleaned up some code and simplified messages in the Event Log (Requires a browser refresh on all devices).
Added a screen on the Sensor configuration (Exclude Sensor) to select specific sensor entities that should not be created. This lets you override the normal sensor entity creation process. For example, you normally create a battery level/status sensor for all devices. You can now not create the battery sensor for a device that only uses FmF for tracking that does not report battery information.

Download from the Release page here. Select Assets, then select icloud3-beta-#.zip.
iCloud3 v3 Documentation can be found here
All of the Change Logs can be found here

Change Log:

Fixed a problem selecting several of the Actions from the Configurator.
Fixed a problem where the zone was not being displayed in the _badge sensor and the zone's
friendly name was not being displayed on the Event Log (and other places) correctly.
Added the Battery Level to the Info sensor for the device. Also fixed a problem getting the
battery level from the iOS App when the iOS App was reporting a 'not_set' value and reworked the
reporting of changes to the battery status (charging, not charging, etc).
Fixed a problem with the v2 --> v3 configuration migration with a message ha_country_code not
found.
Fixed another problem determing if a near by device's tracking results can be used that was causing
iCloud3 to hang and stop tracking all devices. The problem was caused by a circular loop where
A > B > C > D > B > C > D etc. The A, B, C and D are devices that are scanned in sequence to see
if they are near by and could be used. A check is made, following the path of devices that are
already being used, trying to find the end. In this case, the end did not exist and iCloud3 died.
An additional timer check was added to stop liiking after 5-secs.
Added a code to the Near By devices that are not eligible to explain the reason it is not eligible.
(a-GPS Accuracy, lb-Would Loop Back to itself, sz-Stationary Zone)
Fixed a problem calling the iCloud3 update service with the 'device_name' parameter,
Added the ability to exclude a specific device sensor from being created when iCloud3 started.
Select Exclude Sensors from the Configurator > Sensors screen, then select the actual sensor to
be excluded. A Filter can be used to limit the sensors displayed and the Excluded Devices are
displayed on the Sensors and Exclude Sensors screen. An HA restart is required to complete
the process.
Fixed a couple of problems with the iCloud Account interface (pyicloud_ic3).
The Alert messages generated when iCloud3 is starting are redisplayed in the Event Log when
the startup process has completed. This summarizes all alerts in one place to help prevent
then from being missed.
Event Log:
1. Changed the Event Log to better indicate when Debug & Rawdata logging are on. The Debug
level is now displayed in the tracking results header area in the time field. This also
shows when it was turned on and off.
2. Reordered some of the Action items.
3. Changed some Event Log messages for clarity.
4. Cleaned up some code.
REQUIRES A BROWSER REFRESH ON ALL DEVICES

Assets 3

14 Jan 18:26

gcobb321

v3,0,0-beta-8

8c98f04

iCloud3 v3 Beta 8b Pre-release

Pre-release

Beta 8b, Beta 8b, Beta 8b
Edit: Beta 8b fixes a problem with the conversion throwing an 'ha_country_code' not found error message.

_Edit: Beta 8a Fixed a problem where the Configurator update in Beta 8 was actually code from Beta 7. It didn't work too good. I did not create a new release, just updated the zip file.

Fixed the problem accessing the iCloud3 Devices screen. Again. The problem is a timing issue and an issue between HA and requesting data from the iCloud Account. I tried a completely new approach and hope it works this time.
The Waze server selection method was changed so it is in line with how Waze does it. (US/Canada, Israel, Rest of the World).
The battery and battery status updates have been fixed so the battery level is reported every 15-seconds like it was suppose to have been.
Fixed an when 3 or more devices where sharing their location and iCloud3 would stop updating everyone's location.
And a few more issues..

See the change list below for the details.

Download from the Release page here. Select Assets, then select icloud3-beta-#.zip. or,
Download directly from the GitHub Code page here. Click download on the right side of the screen.
All of the Change Logs can be found here

Change Log:

Fixed the bug accessing the iCloud3 Devices screen. Again. I hope. It is a timing issue and an
issue with accessing the iCloud Account through HA. I could make it fail yesterday but not today
when trying to verify that the new approach fixed it. For those that are having this problem,
please let me know if you are still having a problem and I'll take another crack at it.
The Waze Route Service is handled by 3-servers around the world - United States/Canada, Israel,
and the Rest of the World. The HA Country Code is now used to determine that
the appropriate server is used. It is still shown on the Waze configuration screen for
information only. It is verified and corrected when HA starts if the wrong server is selected.
Combined the configuration screens for the Waze Route Server and Waze History Database into one
screen. THIS MAY REQUIRE A BROWSER CACHE REFRESH
Added the 'iCloud3 Theme' that tweeks the field labels in the Configurator so the descriptive
text is a little more readable (at least for me with my old
icloud3-beta-8.zip
eyes). It has both a light and dark
mode and only a few entries. You can find the it in config/custom_components/icloud3/theme.

Move the 'iCloud3 Theme' from the 'icloud3/theme' folder to the 'config/themes' folder.
(1) If you are already using a theme, copy the 'icloud3_theme.yaml' file statements (both the
light and dark mode) into the appropriate location in your theme's yaml file. Then restart HA.
(2) If you are not using a theme, restart HA, open your Profile screen, then select 'iCloud3 Theme'
on the Themes list.

I used it when capturing screenshots for the iCloud3 documentation.
Fixed a number of problems with the battery and battery status sensors. (1) It was being updated
by the iOS App every 15-minutes instead of every 5-seconds. (2) The value was resetting to 0 when
HA or iCloud3 restarted instead of restoring it's value from the last update. (3) It was not being
updated when iCloud3 restarted until the next poll, which may be 2-hours if you are in a zone.
(4) It was only being saved to the restore_state file on the next poll, not the value when it
changed in the iOS App. Again, if you are in a zone, the value might be 2-hours old from the last
iCloud update, leading to drops and spikes in the battery sensor in the HA history.
Fixed a problem that might cause iCloud3 to hang when you are tracking 2 or more devices and they
are all close to eack other. The problem occured when device A was using device B tracking results
(distance, travel time, next update time, etc), B was using C, and C was using A. This created a
circular loop so every device used the same data and a new update was never done.
Addressed a problem building the picture file list for the iCloud3 Devices screen. I can not
reproduce the error but changed some code so the error being encountered would not occur.

Assets 3

08 Jan 20:10

gcobb321

v3.0.0-beta-7

95f4afc

iCloud3 v3.0.0 Beta 7 Pre-release

Pre-release

Beta 7, Beta 7, Beta 7 - This beta changed the way the iCloud Account is first logged into to (hopefully) prevent errors caused by slow internet speeds and show servers. Normally, the connection is requested before iCloud3 actually starts so the Family Share and Find-my-Friends data is available when it is needed in Stage 4. If it wasn't available, bad things were happening. I also added sensor attributes showing the distance between all tracked devices that is updated when any device is updated so the distance is almost real-time. Naturally, there were also a few bug fixes dealing with the debug log and iCloud3 hanging when there was a problem connecting to the Waze Location Server. Details are below.

Change Log:

Fixed a problem connecting to the iCloud Account when there was a delay establishing the
initial connection. This was causing authentication delays and eventually creating an HA
error about I/O being done outside of the Event Loop. Also added a configuration item to
delay setting up the iCloud connection until later in the iCloud start up process.
Removed the unit of measure (mi, km) from the distance sensor distance related attributes.
They are now numeric values, making it much simpler to use in automation triggers and conditions.
Fixed a problem where the Max Distance attribute in the distance sensors was being set when the
location was old or the gps accuracy was poor. An additional check was added to only set the
max_distance when the interval is >= 1-minute
Added the distance to other devices to zone_distance sensor and home_distance sensors. It
displays the distance in meters and miles or kilometers. Each device has it's own attribute
that is available in automations and scripts. Since the underscore ('') can not be displayed
in an attribute (HA limitation), the underscores (''s) have been converted to dashes ('-'s).
Modified the way nearby device information is reported and used to make it more reliable and
easier to display in the Event Log.
Fixed a problem where iCloud3 would hang if the Waze Region code was not appropriate for your
location. Also, the HA location country code is used to determine the correct Waze Region when
the conversion is done or iCloud3 is being installed for the first time.
Fixed a few problems with the icloud3-debug.log where debug logging would be stopped when it
shouldn't have and where the file would not always be created when iCloud3 started. Also reduced
time ensuring records are written to the file from 15-minutes to 1-minute

Assets 3

30 Dec 20:36

gcobb321

v3.0.0-beta-6

eea9cbd

iCloud3 v3.0.0 Beta 6 Pre-release

Pre-release

Download the icloud3-beta-#.zip file. It contains the custom__components/icloud3 directory and should be unzipped into the icloud3 custom_components directory. It will over right the iCloud3 v2 files.

The Change Log is at the bottom of this note

Intro: iCloud3 is now a true HA Integration that is added and configured on the HA Devices & Settings > Integrations screen. It has been completely rewritten, provides the function and features of v2 and adds many new ones. When you add iCloud3 on the integrations screen, your current configuration will be migrated. See the Installation and Migration link below for a description of what happens and instructions.

THIS IS A BETA RELEASE. ANY BUGS, PROBLEMS AND QUESTIONS SHOULD BE ADDED TO THE ISSUES PAGE OF THIS REPOSITORY, NOT THE ICLOUD3 FORUM. THERE IS A LINK TO THE GITHUB ISSUES ON THE EVENT LOG CUSTOM CARD (THE BUG IN THE UPPER RIGHT-HAND CORNER). THANKS.

ALSO, I HAVE OPEN AN ISSUE TITLED "BETA USERS". PLEASE POST YOUR USER NAME HERE SO I CAN EASILY LET YOU KNOW WHEN AN UPDATE IS AVAILABLE. YOU CAN ALSO SUBSCRIBE TO THIS REPOSITORY.

The following links are helpful:

Change Log
Installation and Migration
Documentation
issues

Beta 6 - 12/30/2022

Corrected a mispelled directory name used for installing sample device images (ipad.png, watch.png).
The image directory nane was 'event_log_cad'. It should be 'event_log_card'.
A new icloud3-debug.log file will now be created when restarting iCloud3 from the Event Log or when
HA was started and the log level is debug. New records will be added to the existing log file when
debug is started from Event Log > Actions and the log file is less than 20-hours old.
Fixed a problem where location data from iCloud FamShr/FmF was not always being rejected due to poor
gps_accuracy. This could lead to location & zone errors until the next locate was processed.
Improved the performance displaying the results of the Initial Device Locate results in the Event Log.
The Event Log for the selected devices is automatically refreshed when new information is added. The
number of items was increased from 15 to 50 so more events are displayed without refreshing.
Added a prefilter to the rawdata debug log to make sure usernames & passwords are not displayed.
Some internal code cleanup and minor tweaking.

Assets 3

28 Dec 20:51

gcobb321

v3.0.0-beta-5

6654c80

iCloud3 v3.0.0 Beta 5 Pre-release

Pre-release

Beta 5 Change Log is at the bottom of this note

iCloud3 is now a true HA Integration that is added and configured on the HA Devices & Settings > Integrations screen. It has been completely rewritten, provides the function and features of v2 and adds many new ones.

When you add iCloud3 on the integrations screen, your current configuration will be migrated. See the Installation and Migration link below for a description of what happens and instructions.

Download the icloud3-beta-#.zip file. It contains the custom__components/icloud3 directory and should be unzipped into the icloud3 custom_components directory. It will over right the iCloud3 v2 files.

ALSO, I HAVE OPEN AN ISSUE TITLED "BETA USERS". PLEASE POST YOUR USER NAME HERE SO I CAN EASILY LET YOU KNOW WHEN AN UPDATE IS AVAILABLE. YOU CAN ALSO SUBSCRIBE TO THIS REPOSITORY.

The following links are helpful:

Change Log
Installation and Migration
Documentation
issues

Beta 5 - 12/28/2022

Fixed a 'log_info_msg' not defined error message in the routine that identifies the notify
service used for a device. This is just an informative message indicating HA has not set it
up yet.
Periodically, the events currently displayed for a device is reduced from all events to less
than a screen. This number was increased from 1/2-screen to about 2-screens.
When the displayed events for a device were reduced (#2 above), the screen was never refreshed
so you would always see the old events and had to do a refresh to see the latest events. Now,
the device's events are automatically refreshed when they are updated.
Updated the Event Log Lovelace card to v3.0.1. This fixes a problem when the date/time should not
be displayed if there was an alert message was displayed.

Assets 3

27 Dec 22:51

gcobb321

v3.0.0-beta-4

9aa4249

iCloud3 v3.0.0 Beta 4 Pre-release

Pre-release

Oops. I forgot to change the iCloud3 beta version number from b3 to b4 on the update. I fixed that but have not created a new release. Just download it again.

Beta 4 Change Log is at the bottom of this note

When you add iCloud3 on the integrations screen, your current configuration will be migrated. See the Installation and Migration link below for a description of what happens and instructions.

ALSO, I HAVE OPEN AN ISSUE TITLED "BETA USERS". PLEASE POST YOUR USER NAME HERE SO I CAN EASILY LET YOU KNOW WHEN AN UPDATE IS AVAILABLE. YOU CAN ALSO SUBSCRIBE TO THIS REPOSITORY.

The following links are helpful:

Change Log
Installation and Migration
Documentation
issues

Beta 4 - 12/27/2022 - Change Log

Inactive/Untracked devices are listed at the end of the Startup Event Log messages.
Fixed some problems displaying the EVent Log when there were no devices to track.
Fixed problem dealing with Gb.ic3_debug_log_write_secs variable not found.
Fixed problem where the Event Log records were not displayed in a timely manner when starting.
The tracking results written to the Log file now include the zone, distance and time values.
Reworked the icloud3-debug.log file:
- A new file is created when:
- HA/iCloud3 starts and the Log Level is debug or rawdata or
- Starting Debug Logging from Event Log > Actions or
- At midnight when debug logging is on and the file is more thn 20-hours old.
- Otherwise debug records are added to the existing Debug Log file.
- If the Log Level is debug or rawdata in the Configurator > Event Log parameters and
Stop Debug Logging was selected on Event Log > Actions, the configuration will be changed
to 'info' (no debug logging).
- If the configuration is set to 'info' (no debug logging) and it is started on Event Log > Actions,
the configuration is not updated and the debug logging will remain on until midnight, the next
iCloud3 restart or when it is turned off.

QUESTION: Currently the Exported Event Log file contains the date/time indicating when it was created.
This creates a new file for every export.
Example: 'icloud3-event-log_2022-12-26 18:00:00.log'
Another option is to not have the date/time in the file name so a new Export overrites the last one.
Example: 'icloud3-event-log.log'

      Does anyone have an opinion on this.

Assets 3

24 Dec 21:23

gcobb321

v3.0.0-beta-3

dc38c66

iCloud3 v3.0.0 Beta 3 Pre-release

Pre-release

Beta 3 Change Log is at the bottom of this note

When you add iCloud3 on the integrations screen, your current configuration will be migrated. See the Installation and Migration link below for a description of what happens and instructions.

Download the icloud3.zip file. It contains the custom/components/icloud3 directory and should be unzipped into the icloud3 custom_components directory. It will over right the iCloud3 v2 files.

ALSO, I HAVE OPEN AN ISSUE TITLED "BETA USERS". PLEASE POST YOUR USER NAME HERE SO I CAN EASILY LET YOU KNOW WHEN AN UPDATE IS AVAILABLE. YOU CAN ALSO SUBSCRIBE TO THIS REPOSITORY.

The following links are helpful:

Change Log
Installation and Migration
Documentation
issues

Beta 3 - 12/24/2022

Fixed a problem where the Configurator > Sensors would generate an 'Unknown Error Ocurred'
error message. This was caused by an invalid sensor field name ('tracking_from_zones')
in the configuration file.
Fixed a problem on the Configurator > Sensors screen dealing with an invalid 'battery_status'
error message.
Fixed a problem where error messages were displayed getting device info from the HA device
registry when the device was not in the registry.
Fixed a problem displaying the obscured email address if there was more than one @-sign
in the address.
Added 'Reinitialize All Devices' to the Configurator > iCloud3 Devices screen. With it,
you can remove all devices from iCloud3 or reset the selections for the iCloud FamShr & FmF
and the iOS App parameters to None. This will clear any errors due to device migration errors.
Setting up the log_level (info, debug, rawdata) a lot earlier. It is now setup when HA loads iCloud3
instead of later. Debug and RawData information should now be written to the HA Log file
(home-assistant.log) when the iCloud Account connection is first established.
Moved Event Log Configuration option to Menu Page 1 and moved Display Text As option to Menu
Page 2. Also added the Log Level parameter to the Event Log Configuration screen. This
will reduce the steps needed to change the Log Level parameter when debug/rawdata logging
is desired. ---> YOU MAY NEED TO REFRESH YOUR BROWSER WITH THE CONFIGURATOR OPEN <---
Fixed problem changing the devices Friendly Name that would generate an error message deleting
tracking_from_zone sensors when they had not been created.
The device_tracker state value is now lower-case.
Log level debug and rawdata records are now written to the '/config/icloud3_debug.log' file
instead of the HA log file. A new file is created every time HA starts.
The file extension for the Event Log file was changed from '.txt' to '.log'. The file name is now
'icloud3-event-log_[time].log'.

Assets 3

18 Dec 22:15

gcobb321

v3.0.0-beta-2

1534161

iCloud3 v3.0.0 Beta 2 Pre-release

Pre-release

Beta 2 Change Log is at the bottom of this note

When you add iCloud3 on the integrations screen, your current configuration will be migrated. See the Installation and Migration link below for a description of what happens and instructions.

Download the icloud3.zip file. It contains the custom/components/icloud3 directory and should be unzipped into the icloud3 custom_components directory. It will over right the iCloud3 v2 files.

ALSO, I HAVE OPEN AN ISSUE TITLED "BETA USERS". PLEASE POST YOUR USER NAME HERE SO I CAN EASILY LET YOU KNOW WHEN AN UPDATE IS AVAILABLE. YOU CAN ALSO SUBSCRIBE TO THIS REPOSITORY.

The following links are helpful:

Change Log
Installation and Migration
Documentation
issues

Beta 2 Change Log:

Do not display an error message when trying to get the model of a device if t is
not in the HA device registry. (entity_io:137)
Fix a problem checking if info for all of configured devices that had been set
up had been returned from iCloud account during startup. If not, the FmF devices
were being refreshed when it should be refreshing the FamShr devices. (start_ic3:1315)
Fixed an error copying the Event Log image sample files to the custom cards directory.
It was copyingthe files from 'event_log' instead of 'event_log_card'. (start_ic3:722)
Added 'Erase All Devices' to the Configuration > Action menu that will reinitialize the
iCloud3 Devices List.
The Time Format (12/24-hour) was converted incorrectly. It was creating '12/24-hour-hour'
This has been fixed and the invalid parameter in the configuration file was corrected.
Fixed a problem where a check was being made to see if 2fa authentication was needed when
the connection to the iCloud Location Services had not been completed, causing a problem
with the parameter migration (icloud_main:732).
Reformatted the items written to the icloud3_migration.log file for clarity.
Fixed a problem shrinking the Event Log (event_log:538 recursion error).
Fixed a problem when Family Sharing info from iCloud Location Services had not completely
loaded during initialization and was generating an error during the retry operation (start_ic3:1113).
Fixed a problem, hopefully, that was generating the HA Blocking error when starting up the iCloud
Location Services interface. This was also occurring (sometimes) when logging into a new the iCloud
account from the Configurator.

Assets 3

17 Dec 20:42

gcobb321

v3.0.0-beta.1

0f6222d

v3.0.0 Beta 1 Pre-release

Pre-release

I’m working on a few issues right now to fix a few reported problems. Hold off downloading until Beta 2 later today.

When you add iCloud3 on the integrations screen, your current configuration will be migrated. See the Installation and Migration link below for a description of what happens and instructions.

Download the icloud3.zip file. It contains the custom/components/icloud3 directory and should be unzipped into the icloud3 custom_components directory. It will over right the iCloud3 v2 files.

ALSO, I HAVE OPEN AN ISSUE TITLED "BETA USERS". PLEASE POST YOUR USER NAME HERE SO I CAN EASILY LET YOU KNOW WHEN AN UPDATE IS AVAILABLE. YOU CAN ALSO SUBSCRIBE TO THIS REPOSITORY.

The following links are helpful:

Assets 3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Beta 9

Beta 2 Change Log:

Releases: gcobb321/icloud3_v3

iCloud3 v3, Beta 9, 1/22/2023

Beta 9

iCloud3 v3 Beta 8b

iCloud3 v3.0.0 Beta 7

iCloud3 v3.0.0 Beta 6

iCloud3 v3.0.0 Beta 5

iCloud3 v3.0.0 Beta 4

iCloud3 v3.0.0 Beta 3

iCloud3 v3.0.0 Beta 2

Beta 2 Change Log:

v3.0.0 Beta 1