v3 Docs

gcobb321 · Dec 30, 2023 · e831074 · e831074
1 parent a2cd879
commit e831074
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 29 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -14,8 +14,8 @@
 
 ------
 - **Getting Started**
-- [Introducing iCloud3](chapters/0.1-introduction.md)
-- [v3 Changes and New Features](chapters/0.2-change-log-v3.md)
+- [ Introducing iCloud3](chapters/0.1-introduction.md)
+- [ v3 Changes and New Features](chapters/0.2-change-log-v3.md)
 
 ------
 - [**User Guide Index**](chapters/0.3-index.md)
@@ -28,28 +28,28 @@
 
 ------
 - **Location Data Sources**
-- [iCloud Account Family Sharing Devices](chapters/2.1-icloud-account.md)
-- [Mobile App Integration, iOS App Entities](chapters/2.3-ios-app.md)
-- [iCloud Account Authentication](chapters/2.2-apple-id-verification.md)
+- [ iCloud Account Family Sharing Devices](chapters/2.1-icloud-account.md)
+- [ iCloud Account Authentication](chapters/2.2-apple-id-verification.md)
+- [ Mobile App Integration, iOS App Entities](chapters/2.3-ios-app.md)
 
 ------
 - **Installing iCloud3**
-- [Migrating from v2 to v3](chapters/3.1-migrating-v2-to-v3.md)
-- [As a New Installation](chapters/3.2-installing-and-configuring.md)
+- [ Migrating from v2 to v3](chapters/3.1-migrating-v2-to-v3.md)
+- [ As a New Installation](chapters/3.2-installing-and-configuring.md)
 
 ------
 - **Reference**
-- [Configuration Screens & Parameters](chapters/7.1-config-parms.md)
-- [Other iCloud3 Features](chapters/7.2-other-topics.md)
-- [Sensor Attributes](chapters/7.3-attributes.md)
-- [Service Calls](chapters/7.4-service-calls.md)
-- [Sample Automation & Scripts](chapters/7.5-sample-automation-scripts.md)
+- [ Configuration Screens & Parameters](chapters/7.1-config-parms.md)
+- [ Other iCloud3 Features](chapters/7.2-other-topics.md)
+- [ Sensor Attributes](chapters/7.3-attributes.md)
+- [ Service Calls](chapters/7.4-service-calls.md)
+- [ Sample Automation & Scripts](chapters/7.5-sample-automation-scripts.md)
 
 ------
 - **Questions and Problems**
-- [Fixing Tracking Problems](chapters/8.1-device-tracking-problems.md)
-- [Frequently Asked Questions](chapters/8.2-frequently-asked-questions.md)
-- [Troubleshooting Problems](chapters/8.3-troubleshooting-problems.md)
+- [ Fixing Tracking Problems](chapters/8.1-device-tracking-problems.md)
+- [ Frequently Asked Questions](chapters/8.2-frequently-asked-questions.md)
+- [ Troubleshooting Problems](chapters/8.3-troubleshooting-problems.md)
 
 ------
 - **Other Topics**

diff --git a/docs/chapters/2.1-icloud-account.md b/docs/chapters/2.1-icloud-account.md
@@ -43,7 +43,7 @@ If you want to change to a new iCloud Account, change the username or change pas
 ### Assigning the Family Sharing Device
 
 The Family Share device is assigned to an iCloud3 device on the *Update Tracked iCloud3 Devices* screen. 
-1. Select the device to update on the *Devices List* screen, select *Update Device* and click *Submit*.
+1. On the *Devices List* screen, select the **Device** to update, select **Update** and click **Submit**.
 2. Select the Family Sharing device to be assigned from the Family Sharing Devices list.
 3. Make any other changes to the device's parameters.
 
@@ -81,7 +81,7 @@ When iCloud3 starts, the Event Log shows:
 
 This information will help solve device or tracking problems, especially when a device has been upgraded or a new device is tracked.
 
-![](../images/evlog-stage-4-5.png)
+![](../images/evlog-stage-4-5-famshr.png)
 
 
 ------

diff --git a/docs/chapters/2.2-apple-id-verification.md b/docs/chapters/2.2-apple-id-verification.md
@@ -1,8 +1,8 @@
-# Authenticating Apple iCloud Account Access
+## Authenticating Apple iCloud Account Access <!-- {docsify-ignore} -->
 
 ------
 
-### 3.1 Apple Notification windows
+### Apple Notification windows
 
 iCloud3 will log into your Apple iCloud account to retrieve information related to the devices in your Family Sharing list to include:
 
@@ -21,7 +21,7 @@ The *Event Log* screen also displays an alert that the Verification Code has bee
 
 
 
-### 3.2 Apple ID Verification Code
+### Apple ID Verification Code
 
 When you receive this notification, the 6-digit Apple ID Verification Code is entered on the *Configure Settings > Enter/Request Apple ID Verification Code* screen. 
 
@@ -33,7 +33,7 @@ The 6-digit verification code you get on your iPhone or iPad is only valid for a
 
 If you think the code is correct, reenter it and try again. If not request a new verification code and use the new code.
 
-#### 3.2.1 Requesting a New Verification Code
+### Requesting a New Verification Code
 
 Select **Request a New Apple ID Verification Code** and select **Submit**. The iCloud interface is reset and Apple will send the Apple ID Sign In screen and a new 6-digit Verification Code to your trusted devices.
 
@@ -54,15 +54,15 @@ There are several ways to display this screen:
 
 
 
-### 3.3 Access tokens, password and security
+### Access tokens, password and security
 
 iCloud3 is always logged into your Apple account. When iCloud3 starts and logs into your iCloud account, Apple returns an *access token* indicating iCloud3 is authorized to use data from the iCloud account. These tokens expire after about 30-minutes and the login process using the access token is done again. After a while (determined by Apple), the token is invalidated and the Apple requests the password. A new access token is sent and the process starts over.
 
 Note: The access token is stored as cookie files in the *config/.storage/icloud* and *config/.storage/icloud/session* directory. The file name is derived from the Apple ID (email address) of the iCloud account.
 
 
 
-### 3.4 Login email Notification from Apple
+### Login email Notification from Apple
 
 An email is sent from Apple when you log into your your iCloud account using your password. You will receive this email:
 
@@ -73,7 +73,7 @@ An email is sent from Apple when you log into your your iCloud account using you
 
 ![](../images/auth-apple-email.png)
 
-#### 3.4.1 What can you do to minimize these emails from clogging up your inbox
+####  What can you do to minimize these emails from clogging up your inbox
 
 The short answer is not much. 
 

diff --git a/docs/chapters/2.3-ios-app.md b/docs/chapters/2.3-ios-app.md
@@ -2,7 +2,11 @@
 
 iCloud3 monitors the iOS App device_tracker entity and several sensors for zone enter/exit triggers, location changes and battery level updates. The sensors are monitored for changed data every 5-seconds. iCloud3 also sends messages to the iOS App when an error occurs and when a location update from the iOS App is needed.
 
-iCloud3 does not require the iOS App to be installed on the iPhone or iPad. Additionally, the HA Complication for the Apple Watch does not provide location information. See below for more information about this.
+*Notes*:
+
+- iCloud3 does not require the iOS App to be installed on the iPhone or iPad. 
+
+- The HA Complication for the Apple Watch does not provide location information. See below for more information about this.
 
 
 ------
@@ -11,11 +15,11 @@ iCloud3 does not require the iOS App to be installed on the iPhone or iPad. Addi
 
 The HA entities that iCloud3 are monitors are:
 
-- device_tracker.[device_name] - Location changes
+- **device_tracker.[device_name]** - Location changes
 
-- sensor.[device_name]_last_update_trigger - Triggers indicating what caused the location change to include zone enter/exit, background refresh, manual, significant location change and others. This is described in more detail in the HA Companion App documentation.
+- **sensor.[device_name]_last_update_trigge**r - Triggers indicating what caused the location change to include zone enter/exit, background refresh, manual, significant location change and others. This is described in more detail in the HA Companion App documentation.
 
-- sensor.[device_name]_battery_level - The battery level for the device and if the device is charging or not charging. The battery level icon is used to identify it's charging status.
+- **sensor.[device_name]_battery_level** - The battery level for the device and if the device is charging or not charging. The battery level icon is used to identify it's charging status.
 
   ![](../images/cf-data-sources.png)
 
@@ -30,7 +34,7 @@ To enable HA iOS Companion App data usage:
 
 The iOS App device is assigned to an iCloud3 device on the *Update Tracked iCloud3 Devices* screen. 
 
-1. Select the device to update on the *Devices List* screen.
+1. On the *Devices List* screen, select the **Device** to update, select **Update** and click **Submit**.
 
 2. Select the iOS App device to be monitored from the iOS App Devices list.
 
@@ -41,8 +45,13 @@ The iOS App device is assigned to an iCloud3 device on the *Update Tracked iClou
 Notes:
 
 - Select *None* if the iOS App is not installed on this device.
+
 - If the *Scan for mobile_app ...* is selected, the HA Registry will be scanned for iOS App device starting with the device name indicated. This is provided for v2-to-v3 migration purposes and is not generally recommended. 
 
+
+
+#### If the iOS App is not Installed  <!-- {docsify-ignore} -->
+
 iCloud3 does not require the iOS App to be installed on an iPhone or iPad. However, if it is not installed, the following happens:
 
 - iCloud3 will not react to a Zone Enter or Exit events until the phone's *Next Update Event* time. This will delay the device entering a zone or exiting from it.
@@ -60,6 +69,19 @@ iCloud3 does not require the iOS App to be installed on an iPhone or iPad. Howev
 Only iPhones and iPads with the iOS App installed are monitored. Although there is an HA Complication that can be installed on the Apple Watch, it does not provide location information so it is not monitored. iCloud3 attempts to trigger zone exits by requesting a FamShr location update when a nearby iPhone or iPad received a zone exit trigger.
 
 
+------
+
+### Event Log Family Share Information When iCloud3 Starts
+
+When iCloud3 starts, the Event Log shows:
+- The steps, results and errors when logging into the iCloud Account (Stage 4).
+- The Family Sharing Devices that have been returned from the iCloud Account (Stage 4).
+- The Family Sharing device assigned to the iCloud3 tracked device (Stage 5).
+
+This information will help solve device or tracking problems, especially when a device has been upgraded or a new device is tracked.
+
+![](../images/evlog-stage-4-5-iosapp.png)
+
 
 ------
 
@@ -77,6 +99,7 @@ The iOS App must be configured to provide location and zone activity to Home Ass
 
 ------
 
+
 ### Clearing the iOS App Cache
 
 The cache needs to be cleared when a new version of the Event Log is installed. A message, with instructions, is displayed when this is needed. It will need to be cleared on every device (iPhones, iPads) that is using the iOS App.