iCloud3 v3, beta 16c (5/13/2023)

Not much in this update. Just a few things for first time installers and to clean up a few other items.

Important Links

Download - Select Assets, then select icloud3.zip (or icloud3-beta-#.zip). Download the zip file and unzip it into the /config/custom_components/icloud3 directory. Then restart HA.
iCloud3 v3 Documentation - It is still in process, does not include the latest updates to iCloud3 and can be found here
Change Logs - They can be found below.

Beta 16c Change Log

1. Apple iCloud Web Service Interface - The Error Status code for the FmF web url providing location data is now checked (Error Code 501). An error message is displayed when the Service is Not Available and iCloud3 will finish loading. The offending service (FamShr or FmF) will be turned off.
2. Zone Friendly Name - Changed the name from ZoneFriendlyName to ZoneFname.
3. Add iCloud3 Integration for the first time - Added a test for adding the iCloud3 Integration for the first time and migrate the v2-v3 configuration parameters if needed.
4. Configuration Wizard - Changed some text on the menus. Also relabled the Next Page headings for clarity.
5. Integration Selection - 'iCloud3 v3' is now displayed instead of just 'iCloud3'.

Edit: 5/14/2023
6. Configuration Wizard - Fixed a problem displaying error messages on the Update Devices screen.

iCloud3 v3, beta 16b (5/10/2023)

This fixes a few things in beta 16.

Important Links

Download - Go to the iCloud3 Releases page here. Scroll down past the notes, select Assets, then select icloud3.zip. Download the zip file and unzip it into the /config/custom_components/icloud3 directory. Then restart HA.
iCloud3 v3 Documentation - It is still in process, does not include the latest updates to iCloud3 and can be found here
Change Logs - They can be found here or on the GitHub Issues page that announces this Release.

Beta 16b - 5/10/2023

1. Enter Zone - Fixed a problem where an iOS App Enter Zone trigger was being not being processed. There was a test for entering a track_from_zone (Home) that was was being delayed. The next time the trigger was checked, the update was not being processed since the data had not changed when it should have been processed on the initial trigger.

2. Stationary Zone - Added another check to make sure the Stationary Zone will not be created when it is close to another zone. The gps accuracy + 25m is now also used in the minimum distance calculation.

3. Stationary Zone Friendly Name - The stationary Zone sequence number will only be inserted into the zones name if the '#' is specified. Otherwise, the value Friendly Name will be displayed and assigned to all zones for all devices.

4. Configuration Wizard - Fixed an issue displaying page 2 of the Update Devices or Display Text As screens.

iCloud3 v3, beta 16a (5/7/2023)

Important Links:
Download - Go to the iCloud3 Releases page here. Select Assets, then select icloud3-beta-#.zip. Download the zip file and unzip it into the /config/icloud3 directory. Then restart HA.
iCloud3 v3 Documentation - It is still in process, does not include the latest updates to iCloud3 and can be found here
Change Logs - They can be found here

Update Notes

This beta is probably the last one, I hope. It includes a lot of small items dealing with Event Log messages, changes to the icons
based on the state of the sensor entity, changes to sensor updates, enter zone delay handling, a new icloud3_update service call to activate the lost device alert, enhancements to Watch zone exits and updates, better handling of near by devices and some bug fixes.

These are important ones:

• The Stationary Zone has been redesigned so it is no longer associated with a device. It is created when a device has not
  moved like it always has been. Now, any other nearby device will also use that zone instead of creating another one for the
  same location. It's name can still assigned on the Special Zones >Stationary Zone screen but it now takes the form of
  a zone name followed by a number (default is StatZon#). The iOS App device_tracker and person entities now will show the
  same zone name as iCloud3 instead of the device being in it's stationary zone and the other entities displaying another zone.

• The Configuration Wizard menus have changed. The Enter/Request Apple ID Verificatin and Change Device Order screens
  are now on the first menu page so it now displays all iCloud and device related screens. All other screens are displayed on
  the second menu page.

• HACS - I had requested that iCloud3_v3 be added to HACS so those using v2 would still have their HACS entry and v3 users
  would have another. This was turned down by those responsible for HACS. They said that it is in beta and has not be officially
  released. When it is officially released, it should be merged into the main iCloud3 listing so it will be available to all users. HACS
  will support it with 2 methods, (1) Adding the iCloud3_v3 repository to HACS as a special repository and (2) by treating it as a
  pre-release that makes it available to anyone that has the HACS Show pre-release updates checked.

  I added instructions to the iCloud3 docs on setting up v3 betas as a custom repository. After beta 16 has been downloaded
  by a significant number of users (beta 15 has been downloaded over 300 times), and after I have completed the documentation,
  I will create a release candidate and update the current iCloud3 HACS version.

Gary

Change Log - Details

Beta 16a - 5/7/2023

1. Configuration Wizard - Fixed a problem where Page #2 of the Devices List and Display Text As screens would not display.

Beta 16 - 5/7/2023

1. Event Log - Fixed a problem where the 'event-log-card.js file would not be installed if the 'www' directory
   did not exist. Now, the 'www' directory is checked and will be created if it didn't exist.

2. inZone and Old Location - If a device not using the iOS App or a Watch, was in a zone and the location data was
   old but newer than the last update, the device was not being updated with newer location data and would be
   stuck retring the update on a larger and larger interval, resulting in the device never being updated. This
   has been fixed so the device will always be updated with newer location data, even if that location is old.

3. Event Log - Made some minor changes to device location status messages for consistancy.

4. Configuration Wizard -

   1. Reorganized the menus so all the screens dealing with the iCloud account, devices and sensors are on the
      first page and parameter configuration are on the second page,
   2. Apple Verification Code - Added it to the menu. Added an option to request a new code.
   3. Change Device Order screen - Added it to the menu.

5. Stationary Zone:

   1. The Stationary Zone handling has been completely rewritten. Now, the Stationary Zone is no longer assigned
      to a device when iCloud3 starts but is a general zone that is created when it is needed. If several devices
      are near each other, they are will all move into the same Stationary Zone. Devices can exit the zone just
      like they exit a normal zone. When all of the devices have left, it is hidden and moved back to it's base
      location like before. This eliminates the problem of having iCloud3 move a device into it's own zone while HA
      moves it into another nearby device's zone.

      The Stationary Zone assigned by iCloud3 and the zone assigned HA for the person, the device_tracker state
      value and the iOS App are now all the same zone.

      The zone's friendly name defaults to 'StatZon#' where '#' is a number assigned to the zone. It is still
      specified on the Special Zones > Stationary Zone setup screen, where you can assign it's name another value.
      Using a 7-letter name ('StatZon#') insures it will not be truncated on the Lovelace screen when the
      device_tracker state value is displayed. The zone's full entity name is 'zone.ic3_statzone_#'.

6. iOS App Zone Handling - The device's zone is assigned by iCloud3 from the location data from iCloud (FamShr and FmF)
   and when it is moved into a Stationary Zone. The iOS App device_tracker state value may lag behind this zone change
   and, in many cases, is not changed at all. iCloud3 will now issue an iOS App location request if the iOS App and
   iCloud3 zones are not the same after 2-minutes has elapsed. The iOS App will/should then recognize the zone change.

7 . Exit Zone - When a device leaves a zone based on an iOS App Exit Zone trigger, it will schedule an immediate
FamShr location update if there are other devices in the same zone. This should help trigger an exit zone update
immediately for the other devices that are not using the iOS App (Watch). Previously, those devices would exit
the zone on their next scheduled location update.

8. 'lost_device_alert' service call - With this service, a phone can be locked and placed in a 'Lost Mode'. A
   message and phone number can be sent to a device, indicating it has been lost, asking the person that found
   it to call the number. For more information about this service, review the Apple iCloud User Guide/Use Lost Mode
   in iCloud.com. It also explains how to turn Lost Mode on or of using the Dind My app. The documentation can
   be found here - https://support.apple.com/guide/icloud/use-lost-mode-mmfc0f0165/icloud

   Example Service Call for an automation or script:
   service: icloud3.lost_device_alert
   data:
   device_name: 'gary_iphone'
   number: '123-456-7890'
   message: 'This Phone has been lost. Please call this number to report it found.'

9. Sensor Updates:

   1. Last Zone sensors - Fixed several problems where they would not display or would display the wrong value.
   2. Battery Level - Fixed a problem where an older iOS App battery level would overwrite a newer FamShr battery
      level. Also added the update time to the Battery.
   3. Direction of Travel - The value will now display Towards or AwayFrom when tracking from the Home Zone. It
      will display zone name when tracking from another zone. The waze travel time has been added to list of items
      that are checked to determine the travel direction.
   4. Icons - The icons for the Zone, Last Zone and Direction of Travel sensors have been changed to better
      indicate if you are at or going towards or away from Home or another zone, or if the device is in it's
      Stationary Zone.
   5. Next Update time - When tracking from more than one zone, the 1st letter of Track-from-Zone that is causing the update
      is displayed as an icon.

10. Enter Zone Delay - Changed 'PassThru' zone delay to 'Enter Zone' Delay in the Configuration Wizard and on some
    Event Log messages. Also fixed several issues triggering it.

11. Device Offline - Fixed some problems dealing with 'Location Old (#xx)' Event Log messages and setting the retry
    interval when a device went offline.

12. NearBy Devices - If one device is a Watch and the other is an iPhone, the devices are paired and within 15m of
    each other, the Watch's location will not be used for the iPhone. Apple used the location of the paired iPhone
    with the Watch prior to Watch v7 to conserve the battery so it does not make sense to use the location data.

13. Apple Watch - If the Watch, which is not using the iOS APP to trigger zone exits, is close to another device
    when the other device leaves a zone, a Zone Exit Trigger will be generated for the Watch. This causes the
    Watch to exit the zone when it happens instead of waiting for it's next update time to be reached.

14. Did a lot of code cleanup.

iCloud3 v3, Beta 15 (3/19/2023)

Download

1. You are on the Releases page. Select Assets at the bottom of the page
2. Then select icloud3.zip, icloud3_v3.zip or icloud3-beta-#.zip (it all depends on how I uploaded the file)..
3. Download the zip file and unzip it into the /config/custom_components/icloud3 directory.
4. Restart HA.

First Time Installation

1. Go to the HA Devices & Settings > Integration screen/
2. Select + Add, type iCloud3. Go to the iCloud3 User Manual and take a quick look at the introduction here in the search field at the top and select iCloud3. Click Continue a few times.
3. Click Configure in the iCloud3 Integrations window. The Configuration Wizard Setting screen will open.
4. Go to the iCloud3 User Manual and take a quick look at the introduction here.
5. Scroll down a little and follow the instructions in the Installation Guide here. You have already done Steps #1 & #3. Step #4 is a good place to continue but be sure to review information about the iOS App (HA Companion App) in Step #2.

iCloud3 v3 Documentation - It is still in process, does not include the latest updates to iCloud3 and can be found here

Change Logs - They can be found here

---

1. Adding/Deleting Devices - Fixd a problem initializing the _interval sensors when adding a new device on the
   Update_iCloud3 Devices Configuration Wizard screen. Also added some additional error checking when creating
   sensors for new devices.
2. Configuration Wizard -
   1. Added Alert messages to some screens when there are Inactive devices that will not be located or tracked.
   2. Added a Untracked (Inactive) Devices screen that can be displayed when exiting the Wizard and an iCloud3
      restart is needed.
   3. Added a 'cancel' option to the Restart iCloud3 screen to return to the Main Menu.
3. Debug Logging - Now, the 'Log Level' is automatically set to 'debug' if a beta version is being used or
   if a non-beta version (released version) was installed less than 5-days ago.
4. Configuration File - The configuration file is now reloaded when iCloud3 is restarted from the Event Log.
5. HACS - Prepared iCloud3_v3 for HACS. It has been submitted and awaiting approval from HA.
6. Debug Code - Removed debug trace code from beta15p2.

iCloud3 v3, Beta 14b (3/12/2023)

Download

1. You are on the Releases page. Select Assets at the bottom of the page
2. Then select icloud3.zip, icloud3_v3.zip or icloud3-beta-#.zip (it all depends on how I uploaded the file)..
3. Download the zip file and unzip it into the /config/custom_components/icloud3 directory.
4. Restart HA.

First Time Installation

1. Go to the HA Devices & Settings > Integration screen/
2. Select + Add, type iCloud3. Go to the iCloud3 User Manual and take a quick look at the introduction here in the search field at the top and select iCloud3. Click Continue a few times.
3. Click Configure in the iCloud3 Integrations window. The Configuration Wizard Setting screen will open.
4. Go to the iCloud3 User Manual and take a quick look at the introduction here.
5. Scroll down a little and follow the instructions in the Installation Guide here. You have already done Steps #1 & #3. Step #4 is a good place to continue but be sure to review information about the iOS App (HA Companion App) in Step #2.

iCloud3 v3 Documentation - It is still in process, does not include the latest updates to iCloud3 and can be found here

Change Logs - They can be found here

---

beta 14b (3/12/2023)

1. Update to fix a HACS valication error. No change to iCloud3 v3 beta 14 code
2. Fixed an error caused by a missing distance variable (AttributeError: 'iCloud3_DeviceFmZone' object has no attribute 'zone_dist_m'). This was caused when an old location error message was being displayed and the results of the last location were going to be reused

beta 14 (3/9/2023)

1. iCloud Account Authentication:
   • When the iCloud Account is verified using a password, a session access token is created and stored
     as a cookie. The password login also generates an email saying someone has logged into your iCloud
     account. This beta changes the method of authenticating the account to using the token first and
     then using the password if it has expired. This should eliminate or greatly reduce the login emails
     generated by Apple.
   • Did a lot of code cleanup in the account authentication routines to insure the 2fa-code is requested
     when needed, to be able to reauthenticate and log into the current account with a new password and to
     be able to log into a different account in the Configuration Wizard.
2. Configuration Wizard > iCloud Account Credentials screen - Updated it to improve readability and make
   it easier to set up the account information. Several rare problems were also fixed where (1) logging
   into an iCloud Account with an incorrect password would still allow access when there was a valid token
   and (2) logging into an iCloud Account with a changed password would not work if the token has expired.
   Now, logging in with a new password causes a new 2fa request to be made.
3. Zone enter/leave event for an iCloud3 device_tracker entity - This can now be used as an automation
   trigger.
4. Latitude/longitude values - They are now stored as numeric fields in the device_tracker attributes instead
   of a string field. They are now displayed with 2-decimal places on a Lovelace device_tracker/attributes
   window (an HA limitation). A new gps attribute has been added to display the latitude/longitude with it's
   full precision.
5. Passive Zones - Fixed a problem where passive zones could be selected. Also found out that the iOS App
   will generate enter/exit triggers for passive zones. These will now be ignored by iCloud3.
6. Configuration Wizard > Sensors screen - Changed it for readability and to list the important sensors
   first.
7. Event Log - Made some minor formatting changes. Also added a new icon to the top-right of the Event Log
   so you can become an iCloud3 Stargazer. Click it to go to the iCloud3_v2 GitHub repository. Then click
   the star in the top-right corner.
8. Distance Sensors:
   (1) Changed the distance precision so the distance value is within 6-inches/1-millimeter of the
   measurement between the device and the zone center - (4-decimal places for miles, 5 for meters)
   (2) Changed the moved_distance sensor to display in feet/meters when less than 1mi/1km
   (3) Changed the _moved_distance to display the distance from one poll to the next when in a zone
   (4) Added attribute to _moved_distance sensors:
   _moved_from shows the from location time
   _moved_to shows current location time
   (5) Added attribute to all zone_distance sensors:
   _meters_distance shows the distance in meters to the zone with 5-decimal place accuracy,
   _meters_distance_to_zone_edge shows the distance in meters to the edge of the zone
   (6) Added attribute to all zone_distance sensors:
   _miles_distance shows the distance in miles to the zone with 4-decimal place accuracy if the
   unit_of_measure is miles.

iCloud3 v3, Beta 14a (3/12/2023)

Download

1. You are on the Releases page. Select Assets at the bottom of the page
2. Then select icloud3.zip, icloud3_v3.zip or icloud3-beta-#.zip (it all depends on how I uploaded the file)..
3. Download the zip file and unzip it into the /config/custom_components/icloud3 directory.
4. Restart HA.

First Time Installation

1. Go to the HA Devices & Settings > Integration screen/
2. Select + Add, type iCloud3. Go to the iCloud3 User Manual and take a quick look at the introduction here in the search field at the top and select iCloud3. Click Continue a few times.
3. Click Configure in the iCloud3 Integrations window. The Configuration Wizard Setting screen will open.
4. Go to the iCloud3 User Manual and take a quick look at the introduction here.
5. Scroll down a little and follow the instructions in the Installation Guide here. You have already done Steps #1 & #3. Step #4 is a good place to continue but be sure to review information about the iOS App (HA Companion App) in Step #2.

iCloud3 v3 Documentation - It is still in process, does not include the latest updates to iCloud3 and can be found here

Change Logs - They can be found here

---

beta 14a (3/10/2023)

1. Fixed an error caused by a missing distance variable (AttributeError: 'iCloud3_DeviceFmZone' object has no attribute 'zone_dist_m'). This was caused when an old location error message was being displayed and the results of the last location were going to be reused

beta 14 (3/9/2023)

1. iCloud Account Authentication:
   • When the iCloud Account is verified using a password, a session access token is created and stored
     as a cookie. The password login also generates an email saying someone has logged into your iCloud
     account. This beta changes the method of authenticating the account to using the token first and
     then using the password if it has expired. This should eliminate or greatly reduce the login emails
     generated by Apple.
   • Did a lot of code cleanup in the account authentication routines to insure the 2fa-code is requested
     when needed, to be able to reauthenticate and log into the current account with a new password and to
     be able to log into a different account in the Configuration Wizard.
2. Configuration Wizard > iCloud Account Credentials screen - Updated it to improve readability and make
   it easier to set up the account information. Several rare problems were also fixed where (1) logging
   into an iCloud Account with an incorrect password would still allow access when there was a valid token
   and (2) logging into an iCloud Account with a changed password would not work if the token has expired.
   Now, logging in with a new password causes a new 2fa request to be made.
3. Zone enter/leave event for an iCloud3 device_tracker entity - This can now be used as an automation
   trigger.
4. Latitude/longitude values - They are now stored as numeric fields in the device_tracker attributes instead
   of a string field. They are now displayed with 2-decimal places on a Lovelace device_tracker/attributes
   window (an HA limitation). A new gps attribute has been added to display the latitude/longitude with it's
   full precision.
5. Passive Zones - Fixed a problem where passive zones could be selected. Also found out that the iOS App
   will generate enter/exit triggers for passive zones. These will now be ignored by iCloud3.
6. Configuration Wizard > Sensors screen - Changed it for readability and to list the important sensors
   first.
7. Event Log - Made some minor formatting changes. Also added a new icon to the top-right of the Event Log
   so you can become an iCloud3 Stargazer. Click it to go to the iCloud3_v2 GitHub repository. Then click
   the star in the top-right corner.
8. Distance Sensors:
   (1) Changed the distance precision so the distance value is within 6-inches/1-millimeter of the
   measurement between the device and the zone center - (4-decimal places for miles, 5 for meters)
   (2) Changed the moved_distance sensor to display in feet/meters when less than 1mi/1km
   (3) Changed the _moved_distance to display the distance from one poll to the next when in a zone
   (4) Added attribute to _moved_distance sensors:
   _moved_from shows the from location time
   _moved_to shows current location time
   (5) Added attribute to all zone_distance sensors:
   _meters_distance shows the distance in meters to the zone with 5-decimal place accuracy,
   _meters_distance_to_zone_edge shows the distance in meters to the edge of the zone
   (6) Added attribute to all zone_distance sensors:
   _miles_distance shows the distance in miles to the zone with 4-decimal place accuracy if the
   unit_of_measure is miles.

iCloud3 v3, beta 13a (2/25/2023), Required for HA 2023.3.0

Beta 13a (2/25/2023)

Beta 13a: Changed the way the device_tracker state value is set for home & not_home to mirror the iOS App when the Friendly Name option is selected on the Configurator > Format Settings. Now, home and not_home will always be displayed instead of Home and Away. All other zones use the Friendly Name from the zone setup.

VERY IMPORTANT - HA CHANGED THE WAY SENSORS AND DEVICE_TRACKERS ARE SETUP -
THIS UPDATE MUST BE INSTALLED FOR THE 2023.3.0 HA RELEASE

General Updates:

1. The battery sensors are not created if the device only uses the FmF tracking method since battery info is not available.
2. The PassThru Zone Delay has been completely rewritten and now works quite well. It depends on the iOS App issuing zone enter triggers and starts the delay when one is received. Configure it on the Configurator > Special Zones screen. The times are 0-5min in 30-second increments.
3. Added when the device arrived and left a zone to the device's info sensor. Also changed the direction of travel sensor and it's icon to show when traveling towards or away from a zone.
4. The device tracker state can now be set to the zone entity_id, the zone friendly name or the reformatted entity_id in the Configurator.
5. Fixed a problem with overlapping zones or zones where a smaller one is inside a bigger one. When a device is in several zones, the smaller one is picked. The one closer to the device was being picked, which was actually preventing the smaller one from ever being picked.
6. Renamed the Configurator Event Log Parameters to Format Settings since that it was really doing.
7. Tweaked the display of kilometers so a distance of less than 1km is now displayed in meters.
8. Tweaked the Event Log.
9. Fixed a problem where a passive one could be selected for a device.

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: Beta 13 (2/24/2023)

---

VERY IMPORTANT - HA CHANGED THE WAY SENSORS AND DEVICE_TRACKERS ARE SETUP -
THIS UPDATE MUST BE INSTALLED FOR THE 2023.3.1 HA RELEASE

1. Updated the initilization routines to use the new device_tracker and sensor entity creation methods required
   by HA for the 2023.3.0 release.

---

2. Battery entity - The battery sensors are not created if the device only uses the FmF tracking method (FamShr and
   iOSApp are not used). The FmF tracking method does not report battery information.
3. iCloud Interface - There are 4-steps to set up the iCloud Account interface - Setup, Authentication, FamShr, and FmF.
   Made some changes to this process to better report the steps (in the Event Log) that had not been completed, what
   was in process and what still needed to be done when finalizing the set up process in Stage 4.
4. Changed the device's Info sensor to add details showing when the device left the Last Zone and arrived at the
   Current Zones:
   At-Home-10:23:00a (2 hrs ago),
   Left-School-3:45:50p (10 mins ago).
   Changed the dir_of_travel sensor for Towards, AwayFrom and InZone to show the zone's name. Examples:
   Towards: ᗒ Home, ᗒ School,
   AwayFrom: Home ᗒ, 'School ᗒ',
   InZone: @Home, @School
5. Added options to the way the Device_Tracker state value is set on the Format Settings. It now includes the zone
   entity name, the zone's friendly name, and the iCloud3 reformatted names based on the entity id.
6. There are some issues with the source of the zone's friendly name. It is stored in the zone definition file
   (.storage/zone) and in the entity registry for the zone. These two areas are sometimes not in sync, particulary when
   the name has been changed. iCloud3 not gets the friendly name from the zone file, not the entity registry.
7. Fixed a problem with overlaping zones. When a device is in two zones, the smaller one will now be picked.
8. Changed the Configurator screen on menu page 1 from Event Log Parameters to Format Settings since that is
   what it really is. Also moved the Event Log directory which never gets changed to the Other Parameters screen.
   THIS WILL REQUIRE A BROWSER REFRESH when using the configuration screen.
9. Adjusted the distance values when using metric values. The distance is now displayed in meters when it is less
   than 1 km.
10. Fixed a problem when the device could be put into a passive zone. They are still displayed in the Zone's list when
    starting. Now, an indicator shows it is not used.
11. The display option and the device_tracker state values for each zone are displayed in the Event Log during Stage 2
    when starting.
12. Tweaked sone setting in the Event Log card and bumped the version to 3.0.5.
    THIS WILL REQUIRE A BROWSER REFRESH.

iCloud3 v3, Beta 12a (2/16/2023)

Beta 12a (2/16/2023)

Beta 12a only updates the v2-v3 migration and does not need to be downloaded if you are already using v3.

Edit 2/16/2023 - On a new install and the v2 parameters were being migrated to v3, the time fields were still using the beta 11 format instead of new time field format introduced in beta 12. This has been corrected.

Edit: 2/12/2023 - If beta10 was never installed, the config parameter for the Device Tracker State Format parameter was never added to the configuration file, causing an error when trying to update the Event Log Parameters in beta 12. This has been corrected. A range check was also added to make sure the parameters are all within the min/max ranges for the new method of entering numeric fields.

This update fixes some problems, adds a few new features and makes some minor changes, The highlights are:

• iCloud3 Configurator - The time parameters fields are not visible in the HA 2023.2.2 release. This may be an HA bug or by design, but has been fixed and they are back, better than before.
  

• Added a FamShr/FmF locate service call and Event Log Action

• Passthru Zone - There was a bug causing devices without the iOS App (Watches) to stop being tracked when it went into a zone and the passthru 1-minute timer was set. That time was never reset so the device stopped being tracked. It has been disabled until the next beta.

To Do:

• Fix the Passthru zone issue
• Add it to HACS so it will coexist with iCloud3 v2
• Do not create battery sensors for devices only using the FmF tracking method
• Some internal stuff needed by HA before the March HA release

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: Beta 12 (2/11/2023)

1.  iCloud3 Configurator - The HA 2023.2.2 seems to have disabled the time entry fields (hh:mm:ss) used
    to enter a lot of parameters (inZone Interval, Stationary Still Time, Old Location adjustment, etc).
    The screens display but none of thse fields are showing. This may be a HA bug that needs fixing or
    they are removing it from HA. In any case, all of the configuration parameter entry screens have
    been modified to use another method of entering the parameters. It actually works better, is easier
    to use and takes up less screen real estate. The fields can be entered using the keyboard or through
    a numeric slider.
    THIS WILL REQUIRE A BROWSER REFRESH AFTER DISPLAYING ONE OF THE CONFIGURATOR SCREENS

2. New 'locate' Service call - Added the 'locate' Action to the icloud3.action Service Call. This action
    lets you locate a device (or all devices) immediately or in after a specific time has elapsed.
    This replaces the set_interval service call in v2.
    The following examples explains how it can be used:
        Calling method:
            service: icloud3.action
            data: {action: locate xx min, device_name: xxx}

        Examples:
            - Locate gary_iphone in 4 minutes: {action: locate 4 min, device_name: gary_iphone}
            - Locate gary_iphone immediately:  {action: locate, device_name: gary_iphone}
            - Locate all phones in 4 minutes:  {action: locate 4 min}
            - Locate all phones immediately:   {action: locate}
            
3. Event Log > Action - Added the above 'locate' to the Action command manu to locate a specific device or
    all devices using the FamShr or FmF methods. Also tweaked the debug/rawdata logging text color on the
    heading lines displayed when an update is started or completed. It is now black.
    YOU WILL GET A NOTIFICATION TO REFRESH YOUR BROWSER

4. Passthru Zone - Tried to fix the problem with the passthru zone enter delay. A device that was
    not using the iOS App (Watch) would set up the passthru zone enter delay when entering a zone but
    the next update time was never getting triggered so the zone enter delay was never be cleared.
    This stopped the device from being tracked and updated. On a trial run, the passthrou zone delay did
    not work but the Watch was tracking without any issues. It is disabled in this beta until I get it
    working and have given it a comprehensive test. It should be available in beta 13 next weekend.

iCloud3 v3, Beta 11, 2/5/2023

Beta 11 (2/5/2023)

This update fixes some problems, adds a few new features and makes some minor changes, The highlights are:

• Each device can customize it's Stationary Zone name.
• Changed the way inprocess device updates are handled to be able to break out of potential iC3 hang up it a device never indicated that it's update has been completed. Everything is now reset after a 3-minute wait.
• The way the NextUpdateTime was going to break in the 2023.03 version of HA. Now it won't.
• Added a screen that lets you change the order the devices are processed and listed on the Event Log.
• Fixed a problem with the latitude/longitude and battery going to 0 momentarily during startup.
• And other stuff.

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: Beta 11 - 2/5/2023

1. Added a Stationary Zone name parameter on the Update iCloud3 Devices parameter screen - Each device
   can now have it's own Stationary Zone friendly name. This overrides the generic friendly name on the
   Special Zones screen for the Stationary Zone.
   NOTE: A BROWSER REFRESH WILL/MAY BE NEEDED IF THE FIELD DOES NOT DISPLAY

   The default name is 'Stationary'. It can be customized on the Special Zones screen to [name]StatZone
   (GarStatZone, LilStatZone). It can now be set by device (GaryZone, LillianZone).

2. Fixed a problem where 'Stationary' was always used for the device_tracker state for a Stationary Zone
   instead of the friendly name that was set up on the Special Zones/Stationary Zone screen. Also set the
   Stationary Zone state to 0 when it was created so the person counter would work (maybe).

3. Because of the way iCloud location data is processed, Device updates are handled serially. Only one
   Device can be updated at a time, the next in line must wait until the previous one is complete. The
   method used to control this process was changed to ensure iCloud3 tracking would not hang in up waiting
   for one device update to finish when an unknown error occurred or it was taking a very long time to
   get location data from the iCloud account. Now, everything is reset if one device has been in an
   update process for more than 3-minutes.
   [LET ME KNOW IF YOU HAVE ANY PROBLEMS WHERE TRACKING STOPS FOR ALL DEVICES OR ICLOUD3 SEEMS TO BE HUNG UP]

4. Changed the way the Next Update Time is displayed when the update will be done in 90-secs. For example,
   the time was formatted as '9:35:15a -45s' indicating the update would be done in 45-secs. This will
   break in a future HA release. Now, only the time until the next update will be displayed (45 secs)
   when the update will be done within 90-seconds.

5. Added a new configuration screen to change the order the devices are tracked and displayed on the
   Event Log. They are processed in the order they were first added to iCloud3 and listed on the iCloud3
   Devices List screen. This new screen lets you change this order. Select Change Device Order on the
   iCloud3 Devices List or the Event Log Parameters screens.

6. If there is an error reading the configuration file when iCloud3 starts, the backup configuration file
   is read and the configuration file with the error is overwritten. The configuration file with the
   error is now saved with a timestamp before it is overwritten.

7. Fixed a problem where the latitude/longitude values for the Device were not being restored when iCloud3
   was starting. The latitude/longitude was set to 0/0 rather than the last known position, putting it in
   Atlantic Ocean on the equator off the coast of Africa on the HA map until the device's location was
   updated

8. Fixed the problem where the battery would go from a valye to 0 and back to the value during startup.
   Again. Really, I think I have it this time, no battery = 0 in my debug logs.

iCloud3 v3, Beta 10a - 1/29/2023

Beta 10a (1/29/2023)

• Fixed a problem when entering a zone that was generating the error message "local variable
  'zone_display_as" referenced before assignment'. This was generated when creating the zone enter
  trigger reason message.

Beta 10 (1/28/2023)

This update fixes some problems, adds a few new features and makes some minor changes, The highlights are:

• Added some FamShr & FmF checking to see if data for all configured devices was received from iCloud when starting up. If not, the data request will now be retried up to 2 times instead of giving an error that a device will not be tracked.

• Added an option on the Event Log Parameter screen to display the device's device_tracker zone using the actual zone name or the zone's display_as formatted name.

• Fixed a problem where the Battery and other text based sensors were displaying as numeric fields on the HA History screen.

• The NearBy zone will now only uses location results from tracked devices, monitored devices are no longer used.

• Fixed some problems when 2-devices in the Family Sharing list had the same name.

• And some other minor fixes and tweeks.

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:

1. Updated the sensor and device_tracker attributes. Added 'sensor_updated' time to all sensors
   to be able to see when a sensor was updated in the Developer Tools > States screen. Removed
   the '_date/time' text from the attribute name for clarity.
2. Fixed a problem displaying the HA History for sensors showing text values (zone, battery status, etc).
3. Fixed a problem with more than one device in the Family Sharing List having the same name.
4. Sometimes, iCloud does not download all of the devices in the Family Sharing account when iCloud3 is
   starting. This leads to a device not found error and requires a restart of iCloud3 and a new request
   to iCloud for the Family Sharing devices. Now, iCloud3 checks to see if all of the configured Family
   Sharing devices and Find-my-Friends devices have been received from iCloud when starting up. If not,
   a retry request is made to iCloud (up to 2 times) before the untrackable devices error message is
   displayed.
5. The HA standard is to display the device_tracker entity state value/zone name in lower case with
   underscores like entity names ('pizza_hut'). An option has been added to the Event log Parameters configuration
   screen to override this and display the device_tracker state value in the same format as used for
   the Event Log (Pizza Hut, PizzaHut).
6. Fixed the 'Find my Phone' alert error.
7. The option to turn off the Passthru Zone and Stationary Zones has been made easier and a message
   is displayed in the Event Log during startup if they are disabled.
8. Changed the way a NearBy zone is determined to only che
   icloud3-beta-10.zip
   ck tracked devices. It was checking both
   tracked and monitored devices).
9. The current results of all devices are written to the icloud3-debug.log file every 15-minutes.
   This will help determine the cause of any 'tracking stopped' errors.
   icloud3-beta-10.zip