v3 docs

gcobb321 · May 24, 2023 · cf949af · cf949af
1 parent 5cdf6e5
commit cf949af
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 35 deletions.
diff --git a/docs/chapters/0.0-change-log-v3.0.md b/docs/chapters/0.0-change-log-v3.0.md
@@ -1,4 +1,4 @@
-# iCloud3 Version 3.0 Change Log v3
+# iCloud3 Version 3.0 Change Log
 
 
 

diff --git a/docs/chapters/3.1-other-topics.md b/docs/chapters/3.1-other-topics.md
@@ -138,21 +138,20 @@ Three services are available for the iCloud3 device tracker component that can b
 
 | Service           | Description                                                  |
 | ----------------- | ------------------------------------------------------------ |
-| iaction           | Send commands to iCloud3 that change the way it is running (pause, resume, restart, etc.) |
+| action           | Send commands to iCloud3 that change the way it is running (pause, resume, restart, etc.) |
 | find_iphone_alert | Display the *Find My iPhone Alert* notification and play an alert sound on the specified phone. |
 | restart           | Restart iCloud3.                                             |
 
 
 
-#### icloud3.action
+#### *icloud3.action* Service
 
 This service allows you to change the way iCloud3 operates. The following parameters are used:
 
 | Parameter | Description |
 |-----------|-------------|
 | device_name | Name of the device to be updated. All devices will be updated if this parameter is not specified.  All instances of the device_name are updated if it is in several groups. update *(Optional)* |
-| command | The action to be performed (see below). *(Required)* |
-| parameter | Additional parameters for the command. |
+| command/parameter | The action to be performed (see below). *(Required)* |
 
 
 
@@ -162,10 +161,8 @@ The following describe the commands that are available.
 |-----------------|-------------|
 | pause |  Stop updating/locating a device (or all devices). Note: You may want to pause location updates for a device if you are a long way from home or out of the country and it doesn't make sense to continue locating your device. |
 | resume |  Start updating/locating a device (or all devices) after it has been paused. |
-| location | Send a 'location update' request to the iOS App. This is done using the iOS App's notify service call. |
-| zone zonename | Update the device interval and location data. |
-| log_level | Display iCloud3 debug information in the HA Log file and, optionally, on the iCloud3 Event Log Card. <br>The following parameters are available:<br>- `eventlog` = Display additional details about the iCloud3 events and operations that are in the iCloud3 Event Log Card.<br>- `debug` =  Add entries related to iCloud3 location operations to the HA log file <br>- `rawdata` = Add the actual raw data records returned from iCloud Web/Location Services to the HA Log file when devices are located. |
 | restart | Restart the iCloud3 custom component. |
+| locate interval | Locate the device or all devices based on the following *locate interval* parameters:<br><br>`- no interval parameter` - Locate the device using the iCloud Location Services immediately<br>`- iosapp` - Send a location request to the iOS App associated with the device.<br>`- interval time` - Set the *Next Location Time* to the *current time + the interval time*<br><br>Examples:<br>`- locate`<br>`- locate iosapp`<br>`- locate 30 secs`<br>`- locate 15 mins`<br>`- locate 2 hrs` |
 
 #### Example Automations or Scripts  {docsify-ignore}
 
@@ -200,52 +197,53 @@ icloud3_command_pause_polling_gary:
       data:
         device_name: gary_iphone
         command: pause
+```
+
+```yaml
+# Commands to Locate devices:
 
-icloud3_command_garyiphone_zone_home:
-  alias: 'Gary - Zone Home'
+icloud3_command_locate_gary_iosapp:
+  alias: 'iCloud3 Locate (Gary) - iOS APP'
   sequence:
     - service: icloud3.action
       data:
         device_name: gary_iphone
-        command: zone home      
+        command: locate iosapp      
 
-icloud3_command_garyiphone_zone_not_home:
-  alias: 'Gary - Zone not_home'
+icloud3_command_locate_gary_immediately:
+  alias: 'iCloud3 Locate (Gary) - Immediately'
   sequence:
     - service: icloud3.action
       data:
         device_name: gary_iphone
-        command: zone not_home
-```
+        command: locate
 
-```yaml
-#Commands that change the log_level options that write debug information to the HA Log File and the iCloud3 Event Log
-
-icloud3_command_loglevel_debug:
-  alias: 'LogLevel-Debug Info to HA Log (Toggle)'
+icloud3_command_locate_all_immediately:
+  alias: 'iCloud3 Locate (All) - Immediately'
   sequence:
     - service: icloud3.action
       data:
-        command: log_level debug
-                
-icloud3_command_loglevel_eventlog:
-  alias: 'LogLevel-Event Log (Toggle)'
+        command: locate
+
+icloud3_command_locate_all_15_secs:
+  alias: 'iCloud3 Locate (All) - 15-secs'
   sequence:
     - service: icloud3.action
       data:
-        command: log_level eventlog
-
-icloud3_command_loglevel_info:
-  alias: 'LogLevel-Display Flags'
+        command: locate 15 secs
+        
+icloud3_command_locate_gary_30_mins:
+  alias: 'iCloud3 Locate (Gary) - 30-mins'
   sequence:
     - service: icloud3.action
       data:
-        command: log_level debug+rawdata
+        device_name: gary_iphone
+        command: locate 30 mins
+
 ```
 
 
-
-#### icloud3.find_iphone_alert 
+#### *icloud3.find_iphone_alert* Service
 
 This service will display a notification and play on the specified device based on the tracking method:
 
@@ -256,7 +254,7 @@ This service will display a notification and play on the specified device based
 |-----------|-------------|
 | device_name | Name of the device *(Required)* |
 
-```
+``` yaml
 #Send the Find My iPhone Alert message
 
 icloud3_find_phone_alert_gary:
@@ -269,12 +267,42 @@ icloud3_find_phone_alert_gary:
     - service: script.notify_gary_iphone
       data_template:
         title: 'Find iPhone Alert'
-        message: 'Find iPhone Alert was triggered for Gary (gary_icloud/gary_iphone)'
+        message: 'Find iPhone Alert was triggered for Gary (gary_iphone)'
 ```
+#### *icloud3.lost_device_alert* Service
 
+This service will sendy a notification to the specified device that the device has been lost and to call the phone number in the message.:
 
+- Family Sharing - Display the alert using the Find My iPhone Alert process build into iOS.
+- Find-my-Friends, iOS App - Send a notification with sound to the iOS App on the specified device .
 
-#### icloud3.restart
+| Parameter | Description |
+|-----------|-------------|
+| device_name | Name of the device *(Required)* |
+| number | Phone number to call *(Required)* |
+| message | A message that will be displayed on the locked screen *(Required)* |
+
+``` yaml
+#Send the Lost Device Alert message
+
+icloud3_lost_device_alert_gary:
+  alias: 'Lost Device Alert (Gary)'
+  sequence:
+    - 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.'
+
+    - service: script.notify_gary_iphone
+      data_template:
+        title: 'Lost Device Alert'
+        message: 'The Lost Device Alert message has been sent to Gary (gary_iphone)'
+```
+
+
+
+#### *icloud3.restart* Service
 
 This service will restart iCloud3 and refresh all of the devices being handled by iCloud3. It does the same action as the `icloud3_command` with the `restart` option described above. You will have to restart Home Assist if you have made changes to the configuration parameters (new device type, new device name, etc.) 
 
@@ -309,4 +337,3 @@ The sections on the report are:
 ![](../images/evlog-export-2.png)
 ![](../images/evlog-export-3.png)
 
-