-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
84 changed files
with
30,723 additions
and
27,923 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| name: Validate with hassfest | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
| workflow_dispatch: | ||
| schedule: | ||
| - cron: '0 0 * * *' | ||
|
|
||
| jobs: | ||
| validate: | ||
| runs-on: "ubuntu-latest" | ||
| steps: | ||
| - uses: "actions/[email protected]" | ||
| - uses: "home-assistant/actions/hassfest@master" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| name: HACS Action | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
| schedule: | ||
| - cron: "0 0 * * *" | ||
|
|
||
| jobs: | ||
| hacs: | ||
| name: HACS Action | ||
| runs-on: "ubuntu-latest" | ||
| steps: | ||
| - name: HACS Action | ||
| uses: "hacs/action@main" | ||
| with: | ||
| category: "integration" |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,74 @@ | ||
| # Welcome to iCloud3 v2.4! | ||
| # iCloud3 v3 Device Tracker Custom Component | ||
|
|
||
| [](https://github.com/gcobb321/icloud3) | ||
| [](https://github.com/gcobb321/icloud3) | ||
| [](https://github.com/gcobb321/icloud3) | ||
| [](https://github.com/gcobb321/icloud3) | ||
| [](https://github.com/gcobb321/icloud3) | ||
| ------ | ||
|
|
||
| iCloud3 is a device_tracker custom_component for iPhones, iPads and Apple Watches. It is tightly integrated with the Home Assistant IOS App, uses the Waze Route Tracker for distance and time information, creates a Stationary Zone when you are stationary, lets you monitor distance and time information for the home zone and other zones (work, school, etc.), minimizes battery usage, and much more. | ||
| ### Prerelease Version | ||
|
|
||
| iCloud3 is a Home Assistant device tracker custom component that greatly expands the capabilities of the iCloud HA component. It exposes many new attributes, provides many new features, is based on enhanced route tracking methods, is much more accurate, and includes additional service calls | ||
| ------ | ||
|
|
||
| [](https://github.com/gcobb321/icloud3_v3) [](https://github.com/gcobb321/icloud3_v3) [](https://github.com/gcobb321/icloud3_v3) | ||
|
|
||
| [](https://github/gcobb321/icloud3_v3) [](https://github.com/gcobb321/icloud3_v3) | ||
|
|
||
| <div align="center"><a href="https://gcobb321.github.io/icloud3/#/"><img src="https://github.com/gcobb321/icloud3/raw/master/docs/images/button_documentation.jpg"></a><a href="https://github.com/gcobb321/icloud3/releases"><img src="https://github.com/gcobb321/icloud3/raw/master/docs/images/button_download_long.jpg"></a></div> | ||
|
|
||
| ------ | ||
|
|
||
| ### Features | ||
|
|
||
| * Supports the Apple iCloud 2-factor-authentication Verification you are familiar with. | ||
| * Supports iCloud Location Services and the HA iOS App tracking methods. The most efficient method is automatically assigned to the devices you are tracking on a per device basis. | ||
| * Family Sharing locates and tracks your family members that are in your iCloud Account's Family Sharing List. | ||
| * Find-my-Friends locates and tracks the people who are sharing their location in the *FindMy App*. | ||
| * Home Assistant iOS App is responsible for zone enter and exit notifications and location update triggers. It is also used if the others are not available, you do not want to use your iCloud account or there are problems with authentication or verifying trusted device access to your account. | ||
| * A variable polling interval that is based on the Waze Route Mapping Service (drive time and distance) rather than just a calculated straight line distance. | ||
| * Monitors the IOS App device_tracker and sensors to immediately capture zone enter, exit and location change notifications. | ||
| * Sensor templates are created that can be used in automations, in scripts and on Lovelace cards. The sensors that are created can be customized to suit your needs. | ||
| * Calculate distance and travel time for more than one zone. | ||
| * The iCloud3 Event Log Lovelace card lets you review tracking history, update transactions that have been discarded because of old locations or poor GPS, operational errors and the ability to restart iCloud3 without restarting Home Assistant. | ||
| * GPS wandering that randomly changes the device's state from home to not_home is eliminated. | ||
| * Short 15-second polling interval when you are less than 1 mi/km from home lets you reliably trigger automations based on an accurate distance. | ||
| * A Stationary Zone is created when you are in the same location for while (doctors office, mall, school, restaurant, etc.) to reduce device polling and conserve battery life. | ||
| * Old location data and GPS inaccuracy locations are automatically discarded. | ||
| * Additional service call commands (setting intervals, pausing and resuming polling, zone assignment, etc.) | ||
| * No other tracking program (other than the HA iOS app) are needed to handle device tracking and presence detection. You will not need Nmap, OwnTracks, router based tracking components. | ||
| * New Configuration variables and Attributes let you customize how you want to use iCloud3. | ||
| * The iCloud3 configuration file (config_ic3.yaml) can be used for most of the configuration parameters. Change the iCloud3 parameters, restart iCloud3 on the iCloud3 Event Log card and they take effect immediately. Without restarting Home Assistant. | ||
| * Extensive documentation on how to use iCloud3, how to set it up and how to customize it to meet your needs. It includes many sample automations and scripts that you can use to set your own device tracking and presence detection. | ||
|
|
||
| And much more ... | ||
|
|
||
| ### iCloud3 Information Card & Event Log Custom Card | ||
|
|
||
|  | ||
| iCloud3 is a device tracker custom component that tracks your iPhones, iPads, Apple Watches, AirPods and other Apple devices. It requests location data from Apple's iCloud Location Services and monitors various triggers sent from the Home Assistant Companion App (iOS App) to Home Assistant. Sensors are updated with the device's location, distance from zones, travel time to zones, etc. | ||
|
|
||
| ### iCloud3 v3 Highlights | ||
|
|
||
| Although Home Assistant has it's own official iCloud component, iCloud3 goes far beyond it's capabilities. The important highlights include: | ||
|
|
||
| - **HA Integration** - iCloud3 is a Home Assistant custom integration that is set up and configured from the *HA Settings > Devices & Services > Integrations* screen. | ||
| - **Configuration Settings** - All of the parameters are updated on configuration screens selected from the *iCloud3 Integrations* entry. | ||
| - **Track devices from several sources** - Family members on the iCloud Account Family Sharing list, those who are sharing their location on FindMy App and devices that have installed the HA Companion App (iOS App) can be tracked. | ||
| - **Actively track a device** - The device will request it's location on a regular interval. | ||
| - **Passively monitor a device** - The device does not request it's location but is tracked when another tracked device requests theirs. | ||
| - **Waze Route Service** - The travel time and route distance to a tracked zone (Home) is provided by Waze. | ||
| - **Waze Route Service History Database** - The travel time and route distance received from Waze is saved to a local database to improve performance and eliminate the response delay due to poor cell service and slow internet speed. | ||
| - **Track from Multiple Zones** - The device is always tracked from the Home Zone. Now it can also be tracked from another zone (office, second home, parents, etc.). Travel time and distance to the other zone is reported just like the Home zone. Additionally, another zone can act as the primary 'Home' zone (vacation home, parents home, etc). This can be configured by device or globally. | ||
| - **Improved GPS Accuracy** - GPS wandering errors leading to incorrect zone exits are eliminated. | ||
| - **Passthru Zone** - Delay processing an Enter Zone trigger in case you are just driving through it. | ||
| - **Stationary Zone** - A dynamic *Stationary Zone* is created when the device has not moved for a while (doctors office, store, friend's house). This helps conserve battery life. | ||
| - **Sensors and more sensors** - Many sensors are created and updated with distance, travel time, polling data, battery status, zone attributes, etc. The sensors that are created is customizable. | ||
| - **Event Log** - The current status and event history of every tracked and monitored device is displayed on the iCloud3 Event Log custom Lovelace card. It shows information about devices that can be tracked, errors and alerts, nearby devices, tracking results, debug information and location request results. | ||
| - **Detailed debugging information** - Several levels location history transactions can be displayed in the Event Log or in the Home Assistant Log File. These include general information, debug data and the raw device location data received from iCloud Location Services. | ||
| - **Updating and Restarting** - iCloud3 can be restarted without restarting Home Assistant. The current device_tracker and sensor entity states are restored on a restart. It can also be reloaded from the *Configure Settings > Action* screen without restarting Home Assistant. | ||
| - **Device_tracker and sensor entities** - iCloud3 devices and sensors are true Home Assistant entities. They are added, deleted and updated using *Configuration Settings > Sensors* selection screens. | ||
| - **Nearby Devices** - The location of all devices is monitored and the distance between devices is determined. Information from devices close to each other is shared. | ||
| - **Zone Exits for devices not using the iOS App** - Devices that do not or can not (Apple Watch) use the iOS App respond to a zone exit when it detects another nearby device has left a zone. | ||
| - **And More** - Review the following documentation to see if it will help you track and monitor the locations of your family members and friends. | ||
|
|
||
| ### Tracking Information Screen with Event Log | ||
|
|
||
| The screens below are an example of how the many tracking sensors can be displayed. The screen on the left shows the current tracking formation for Gary while the Event Log on the right shows a history of important tracking events. | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
| ### iCloud3 Documentation | ||
|
|
||
| - Introduces the many features and components of iCloud3 | ||
| - Describes how to migration from v2.4.7 to v3.0 | ||
| - Provides step-by-step to install and configure iCloud3, it's components and it's supporting components (iCloud Account and the iOS App) | ||
| - Highlights the configuration screens and parameters | ||
| - Provides example screens, automations and scripts | ||
| - The [User Guide is here](https://gcobb321.github.io/icloud3_v3/#/). | ||
|
|
||
| ### Installing or Upgrading to iCloud3 v3 | ||
|
|
||
| - iCloud3 v3 is now available on the iCloud3 HACS base as a prerelease version. Instructions are in the [*iCloud3 User Guide > Migrating iCloud3 from v2.4.x to v3* here](./docs/chapters/0.1-migrating-v2.4-to-v3.0.md). There are also instructions on doing a manual download. | ||
|
|
||
| ### Important Links | ||
|
|
||
| - **iCloud3 GitHub Repository (Prerelease Version)** - The [GitHub Repository is here.](https://github.com/gcobb321/icloud3_v3) | ||
| - **Install using HACS ** - iCloud3 v3 is now available on the HACS base as a prerelease version. Instructions are in the [*iCloud3 User Guide > Migrating iCloud3 from v2.4.x to v3* here](./docs/chapters/0.1-migrating-v2.4-to-v3.0.md). | ||
| - **Download and Install Manually** - This is also described in the iCloud3 User Guide. Select the above link. | ||
| - **Migrating from v2.4._** - See [here](https://gcobb321.github.io/icloud3_v3/#/chapters/0.1-migrating-v2.4-to-v3.0?id=migrating-icloud3-from-v24x-to-v30) for instructions on migrating from from an older version. | ||
| - **iCloud3 v3 User Guide** -The User Guide is quite extensive and can be found [here](https://gcobb321.github.io/icloud3_v3/#/). | ||
|
|
||
|
|
||
|
|
||
| ----- | ||
| *Gary Cobb, aka GeeksterGary* | ||
|
|
Oops, something went wrong.