8000 icloud-location/docs at master · timpihl/icloud-location · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
< 726E script type="application/json" data-target="react-app.embeddedData">{"payload":{"allShortcutsEnabled":false,"path":"docs","repo":{"id":422637460,"defaultBranch":"master","name":"icloud-location","ownerLogin":"timpihl","currentUserCanPush":false,"isFork":true,"isEmpty":false,"createdAt":"2021-10-29T16:07:36.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/9110619?v=4","public":true,"private":false,"isOrgOwned":false},"currentUser":null,"refInfo":{"name":"master","listCacheKey":"v0:1635523663.159967","canEdit":false,"refType":"branch","currentOid":"8e130afb1daeca249bf3212f6e5a071b94f86113"},"tree":{"items":[{"name":"chapters","path":"docs/chapters","contentType":"directory"},{"name":"images","path":"docs/images","contentType":"directory"},{"name":".nojekyll","path":"docs/.nojekyll","contentType":"file"},{"name":"CHANGELOG-v2.4.md","path":"docs/CHANGELOG-v2.4.md","contentType":"file"},{"name":"README.md","path":"docs/README.md","contentType":"file"},{"name":"_sidebar.md","path":"docs/_sidebar.md","contentType":"file"},{"name":"docsify-copy-code.js","path":"docs/docsify-copy-code.js","contentType":"file"},{"name":"docsify-main-code.js","path":"docs/docsify-main-code.js","contentType":"file"},{"name":"docsify-toc.js","path":"docs/docsify-toc.js","contentType":"file"},{"name":"icloud3-links.md","path":"docs/icloud3-links.md","contentType":"file"},{"name":"index.html","path":"docs/index.html","contentType":"file"},{"name":"theme-mods.css","path":"docs/theme-mods.css","contentType":"file"},{"name":"theme-toc.css","path":"docs/theme-toc.css","contentType":"file"},{"name":"theme-vue-min.css","path":"docs/theme-vue-min.css","contentType":"file"},{"name":"theme-vue-readable.css","path":"docs/theme-vue-readable.css","contentType":"file"},{"name":"theme-w3.css","path":"docs/theme-w3.css","contentType":"file"}],"templateDirectorySuggestionUrl":null,"readme":{"displayName":"README.md","richText":"\u003carticle class=\"markdown-body entry-content container-lg\" itemprop=\"text\"\u003e\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch1 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eiCloud3 Device Tracker Custom Component\u003c/h1\u003e\u003ca id=\"user-content-icloud3--device-tracker-custom-component\" class=\"anchor\" aria-label=\"Permalink: iCloud3 Device Tracker Custom Component\" href=\"#icloud3--device-tracker-custom-component\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003e\u003ca href=\"https://github.com/gcobb321/icloud3\"\u003e\u003cimg src=\"https://camo.githubusercontent.com/62fce8e16d9055e30fb949353bb9a41fed3120f20ea8a0545e7abb7e26cea971/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f43757272656e745f56657273696f6e2d76322e342e372d626c75652e737667\" alt=\"CurrentVersion\" data-canonical-src=\"https://img.shields.io/badge/Current_Version-v2.4.7-blue.svg\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/gcobb321/icloud3\"\u003e\u003cimg src=\"https://camo.githubusercontent.com/1cc456981c2e9d1285200c25b0a860bbc5060d87b5bf9ed505b9803aafbe0346/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f52656c65617365642d446563656d6265722c5f323032312d626c75652e737667\" alt=\"Released\" data-canonical-src=\"https://img.shields.io/badge/Released-December,_2021-blue.svg\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/gcobb321/icloud3\"\u003e\u003cimg src=\"https://camo.githubusercontent.com/19cc4bc646cb51dfe2fc732a9f4e8da831292258c6e39c8ae3c039d37b4784cc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f50726f6a6563745f53746167652d47656e6572616c5f417661696c6162696c6974792d7265642e737667\" alt=\"ProjectStage\" data-canonical-src=\"https://img.shields.io/badge/Project_Stage-General_Availability-red.svg\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/gcobb321/icloud3\"\u003e\u003cimg src=\"https://camo.githubusercontent.com/986d7ad62e2edb2c30f7e722f702f6a9840ca5b4eaaef14a401b8905ea4bf369/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f547970652d437573746f6d5f436f6d706f6e656e742d6f72616e67652e737667\" alt=\"Type\" data-canonical-src=\"https://img.shields.io/badge/Type-Custom_Component-orange.svg\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/gcobb321/icloud3\"\u003e\u003cimg src=\"https://camo.githubusercontent.com/8f3b4deb8f6c11b8f563e6549a91e5af94b6241364792bc23d2d30578839ab0c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f484143532d44656661756c742d6f72616e67652e737667\" alt=\"HACS\" data-canonical-src=\"https://img.shields.io/badge/HACS-Default-orange.svg\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\u003c/p\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch3 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eIntroduction\u003c/h3\u003e\u003ca id=\"user-content-introduction\" class=\"anchor\" aria-label=\"Permalink: Introduction\" href=\"#introduction\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eiCloud3 is an improved version of the \u003cem\u003eiCloud device_tracker integration\u003c/em\u003e installed with Home Assistant. It is designed to:\u003c/p\u003e\n\u003cul dir=\"auto\"\u003e\n\u003cli\u003eConnect with the iCloud Location Services using Find-my-Friends and Find-my-Phone tracking methods.\u003c/li\u003e\n\u003cli\u003eProvide easy-to-use presence detection that does not rely on any other program, other than Home Assistant and the Home Assistant IOS app.\u003c/li\u003e\n\u003cli\u003eReport accurate information, i.e. current zone, location, distance from a zone and travel time on a timely basis that can be used reliably in automations and scripts.\u003c/li\u003e\n\u003cli\u003eUse the Home zone and other zones for location based calculations and tracking.\u003c/li\u003e\n\u003cli\u003eConserve the devices battery.\u003c/li\u003e\n\u003cli\u003eCorrect GPS wandering errors leading to incorrect triggering of automations.\u003c/li\u003e\n\u003cli\u003eProvide more distance, travel time, and zone attributes than the base iCloud component and to create sensors for many of the attributes that easily display device information on Lovelace cards.\u003c/li\u003e\n\u003cli\u003eMonitor the iOS App for zone and location changes.\u003c/li\u003e\n\u003cli\u003eDisplay activity on the iCloud3 Event Log custom Lovelace card.\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp dir=\"auto\"\u003eBelow are some sample Lovelace screenshots showing how iCloud3 information can be displayed (see \u003cem\u003eui-lovelace-icloud3.yaml\u003c/em\u003e in the \u003cem\u003esample_automations_scripts\u003c/em\u003e directory of the iCloud3 repository). Example configuration files for sensors, switches, badges, automations and scripts are also found in the \u003cem\u003esample_automations_scripts\u003c/em\u003e directory that report location information and device status, along with running automations (opening a garage door) when arriving home. Other uses (security, lighting, heating \u0026amp; cooling control, etc.) can be added to the automations to meet your needs.\u003c/p\u003e\n\u003cp dir=\"auto\"\u003e\u003cem\u003eGary Cobb, aka GeeksterGary\u003c/em\u003e\u003c/p\u003e\n\u003cp dir=\"auto\"\u003e\u003ca target=\"_blank\" rel=\"noopener noreferrer\" href=\"/timpihl/icloud-location/blob/master/docs/images/readme.jpg\"\u003e\u003cimg src=\"/timpihl/icloud-location/raw/master/docs/images/readme.jpg\" alt=\"readme intro\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\u003c/p\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch3 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eWhat's different\u003c/h3\u003e\u003ca id=\"user-content-whats-different\" class=\"anchor\" aria-label=\"Permalink: What's different\" href=\"#whats-different\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eiCloud3 has many features not in the base iCloud device_tracker that is part of Home Assistant. 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. Lets look at the differences.\u003c/p\u003e\n\u003cmarkdown-accessiblity-table\u003e\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eFeature\u003c/th\u003e\n\u003cth\u003eOriginal iCloud\u003c/th\u003e\n\u003cth\u003eiCloud3\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eIntegration with the HA IOS App\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes, Geographic Zone Enter/Exit, Background Fetch, Significant Location Update \u0026amp; Manual transactions are detected and processed immediately after they are issued.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDevice Selection\u003c/td\u003e\n\u003ctd\u003eNone\u003c/td\u003e\n\u003ctd\u003eSpecify devices to be tracked by their devicename, i.e., \u003cem\u003egary_iphone\u003c/em\u003e or \u003cem\u003elillian_iphone\u003c/em\u003e using the \u003cem\u003etracked_devices\u003c/em\u003e parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eLocate device using Family Sharing List\u003c/td\u003e\n\u003ctd\u003eYes\u003c/td\u003e\n\u003ctd\u003eYes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eLocate device using Find-my-Friends\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eLocate device using HA IOS App without iCloud Services\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eMinimum Poll Interval\u003c/td\u003e\n\u003ctd\u003e1 minute\u003c/td\u003e\n\u003ctd\u003e15 second\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eZone used to calculate distance and travel time\u003c/td\u003e\n\u003ctd\u003e'Home' zone only\u003c/td\u003e\n\u003ctd\u003e'Home' zone and any other HA zone(s)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDistance Accuracy\u003c/td\u003e\n\u003ctd\u003e1 km/mile\u003c/td\u003e\n\u003ctd\u003e.01 km/mile\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eVariable Polling\u003c/td\u003e\n\u003ctd\u003eYes - Based on distance from home, battery level, GPS Accuracy\u003c/td\u003e\n\u003ctd\u003eYes, based on distance and Waze travel time to the 'home' or another zone, direction of travel, if the device is in a zone, battery level, GPS Accuracy and 'old location' status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDetects zone changes\u003c/td\u003e\n\u003ctd\u003eNo - Also requires other device_trackers (OwnTracks, Nmap, ping, etc.\u003c/td\u003e\n\u003ctd\u003eYes, no other programs are needed other than the HA IOS App.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDetects when leaving Home Zone (or another \u003cem\u003ebase_zone\u003c/em\u003e zone)\u003c/td\u003e\n\u003ctd\u003eDelayed to next polling cycle (default of 30-minutes)\u003c/td\u003e\n\u003ctd\u003eDetects when the Home Assistant IOS app issues a Zone Enter/Exit notification\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDiscards old transactions\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes, if older than 2-minutes or with poor gps accuracy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eFixes 'Not Home' issue when in Sleep Mode\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes, by discarding all transactions that are closer than 1-km when the device is in a zone and by providing zone template sensors that are used to trigger automations rather than device_tracker state changes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eIntegrates with Waze route/map tracker\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes, the Waze travel time is used to determine the 'polling interval'. Waze can be disabled if not available using configuration parameters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDevice Polling Interval when close to the 'home' or another zone\u003c/td\u003e\n\u003ctd\u003e1+ minutes (?)\u003c/td\u003e\n\u003ctd\u003e15-seconds\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDynamic Stationary Zone\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes, a Stationary Zone is created if no movement has been detected in 8-minutes (configurable). The polling interval is set to 30-minutes (default) until zone exit notification is received.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eService call commands\u003c/td\u003e\n\u003ctd\u003eSet polling interval, reset devices\u003c/td\u003e\n\u003ctd\u003eSet polling interval, reset devices, pause/restart polling, change zone, enable/disable Waze Route information usage, information logging (some commands can be for all devices or for a specific device)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eTrack device from more than one location\u003c/td\u003e\n\u003ctd\u003eNo, can only track from the 'home' zone\u003c/td\u003e\n\u003ctd\u003eYes, can track from the Home zone and another \u003cem\u003ebase_zone\u003c/em\u003e zone (office, second home, etc.).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEvent Log Lovelace Card\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes. Displays significant events as iCloud3 starts up and locates devices.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eCreate Sensors for device attributes\u003c/td\u003e\n\u003ctd\u003eNo\u003c/td\u003e\n\u003ctd\u003eYes. Sensors created for many of the device_tracker attributes. You can also customize the list of sensors to only create the ones you are interested in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\u003c/markdown-accessiblity-table\u003e\n\u003c/article\u003e","errorMessage":null,"headerInfo":{"toc":[{"level":1,"text":"iCloud3 Device Tracker Custom Component","anchor":"icloud3--device-tracker-custom-component","htmlText":"iCloud3 Device Tracker Custom Component"},{"level":3,"text":"Introduction","anchor":"introduction","htmlText":"Introduction"},{"level":3,"text":"What's different","anchor":"whats-different","htmlText":"What's different"}],"siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Ftimpihl%2Ficloud-location%2Ftree%2Fmaster%2Fdocs"}},"totalCount":16,"showBranchInfobar":true},"fileTree":{"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":"custom_components","path":"custom_components","contentType":"directory"},{"name":"docs","path":"docs","contentType":"directory"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"docs-dir-is-v2.4.txt","path":"docs-dir-is-v2.4.txt","contentType":"file"},{"name":"hacs.json","path":"hacs.json","contentType":"file"},{"name":"info.md","path":"info.md","contentType":"file"}],"totalCount":8}},"fileTreeProcessingTime":7.648638999999999,"foldersToFetch":[],"treeExpanded":true,"symbolsExpanded":false,"csrf_tokens":{"/timpihl/icloud-location/branches":{"post":"J97EWyfeCH91pns0nifnR68iqdAheAzYoYanx3rPEGjsDS_cgrkNjS0_2EO1AcqKbSWCph8rC4LoKmWsj7t_IQ"},"/timpihl/icloud-location/branches/fetch_and_merge/master":{"post":"0iMXiUcOE19cjAOo27rVBxWHTmuFoIE9YZ0PouzbXJy0bvnP-Ijy5jAS5AbmAhsTAUuSgZGs-UxpsAivuR1Vvw"},"/timpihl/icloud-location/branches/fetch_and_merge/master?discard_changes=true":{"post":"AQtvZzmacTSAry0JKp1lU63TA92JFNSNoHublJqVHFNnRoEhhhyQjewxyqcXJatHuR_fN50YrPyoVpyZz1MVcA"}}},"title":"icloud-location/docs at master · timpihl/icloud-location","appPayload":{"helpUrl":"https://docs.github.com","findFileWorkerPath":"/assets-cdn/worker/find-file-worker-7d7eb7c71814.js","findInFileWorkerPath":"/assets-cdn/worker/find-in-file-worker-1ae9fa256942.js","githubDevUrl":null,"enabled_features":{"code_nav_ui_events":false,"react_blob_overlay":false,"accessible_code_button":true,"github_models_repo_integration":false}}}
0