From cad704ebecceb5f258fe3ac851bcd4dddc638296 Mon Sep 17 00:00:00 2001 From: Quentin POLLET Date: Wed, 11 Dec 2019 23:44:57 +0100 Subject: [PATCH 1/2] Add battery sensor to iCloud --- source/_integrations/icloud.markdown | 46 +++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/source/_integrations/icloud.markdown b/source/_integrations/icloud.markdown index 609c633bdea6..f815098bf20a 100644 --- a/source/_integrations/icloud.markdown +++ b/source/_integrations/icloud.markdown @@ -3,12 +3,27 @@ title: "iCloud" description: "Instructions on how to use iCloud to track devices in Home Assistant." logo: icloud.png ha_category: + - Hub - Presence Detection -ha_release: "0.10" + - Sensor +ha_iot_class: Cloud Polling +ha_release: 0.10 --- The `icloud` integration allows you to detect presence using the [iCloud](https://www.icloud.com/) service. iCloud allows users to track their location on iOS devices. +There is currently support for the following services and platforms within Home Assistant: + +- [Platforms](#platforms) + - [Device Tracker](#device-tracker) + - [Sensor](#sensor) +- [Services](#services) + - [Service `icloud.update`](#service-icloudupdate) + - [Service `icloud.play_sound`](#service-icloudplay_sound) + - [Service `icloud.display_message`](#service-iclouddisplay_message) + - [Service `icloud.lost_device`](#service-icloudlost_device) + + It does require that your device is registered with "Find My iPhone". ## Setup the integration @@ -84,11 +99,32 @@ If 2 Step Authentication is enabled for your iCloud account. The integration wil Go into your Home Assistant configuration `.storage` folder and delete the "icloud" folder, then retry. +## Platforms + +### Device Tracker + +The iCloud integration will track available devices on your iCloud account. + +### Sensor + +The iCloud integration will add a battery sensor for each iCloud devices available on your iCloud account. + ## Services 4 services are available: -- **update**: This service can be used to ask an update of a certain iDevice or all devices linked to an iCloud account. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iPhone location. Can be used in automations when manual location update is needed, e.g., to check if anyone is home when door's been opened. -- **play_sound**: This service will play the Lost iPhone sound on your iDevice. It will still ring if you are on "Mute" or "Do not disturb" mode. -- **display_message**: This service will display a message on your iDevice. It can also ring your device. -- **lost_device**: This service will put your iDevice on "lost" mode (compatible devices only). You have to provide a phone number with a suffixed [country code](https://en.wikipedia.org/wiki/List_of_country_calling_codes) and a message. +### Service `icloud.update` + +This service can be used to ask an update of a certain iDevice or all devices linked to an iCloud account. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iPhone location. Can be used in automations when manual location update is needed, e.g., to check if anyone is home when door's been opened. + +### Service `icloud.play_sound` + +This service will play the Lost iPhone sound on your iDevice. It will still ring if you are on "Mute" or "Do not disturb" mode. + +### Service `icloud.display_message` + +This service will display a message on your iDevice. It can also ring your device. + +### Service `icloud.lost_device` + +This service will put your iDevice on "lost" mode (compatible devices only). You have to provide a phone number with a suffixed [country code](https://en.wikipedia.org/wiki/List_of_country_calling_codes) and a message. From 90968b0ca8a4d5fdf306ba51154d0baf239b5429 Mon Sep 17 00:00:00 2001 From: Quentin POLLET Date: Thu, 12 Dec 2019 13:36:35 +0100 Subject: [PATCH 2/2] Review --- source/_integrations/icloud.markdown | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/source/_integrations/icloud.markdown b/source/_integrations/icloud.markdown index f815098bf20a..1c42db3b4dc7 100644 --- a/source/_integrations/icloud.markdown +++ b/source/_integrations/icloud.markdown @@ -3,26 +3,18 @@ title: "iCloud" description: "Instructions on how to use iCloud to track devices in Home Assistant." logo: icloud.png ha_category: - - Hub - Presence Detection - Sensor ha_iot_class: Cloud Polling -ha_release: 0.10 +ha_release: "0.10" --- The `icloud` integration allows you to detect presence using the [iCloud](https://www.icloud.com/) service. iCloud allows users to track their location on iOS devices. -There is currently support for the following services and platforms within Home Assistant: - -- [Platforms](#platforms) - - [Device Tracker](#device-tracker) - - [Sensor](#sensor) -- [Services](#services) - - [Service `icloud.update`](#service-icloudupdate) - - [Service `icloud.play_sound`](#service-icloudplay_sound) - - [Service `icloud.display_message`](#service-iclouddisplay_message) - - [Service `icloud.lost_device`](#service-icloudlost_device) +There is currently support for the following platforms within Home Assistant: +- [Device Tracker](#device-tracker) +- [Sensor](#sensor) It does require that your device is registered with "Find My iPhone". @@ -115,7 +107,7 @@ The iCloud integration will add a battery sensor for each iCloud devices availab ### Service `icloud.update` -This service can be used to ask an update of a certain iDevice or all devices linked to an iCloud account. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iPhone location. Can be used in automations when manual location update is needed, e.g., to check if anyone is home when door's been opened. +This service can be used to ask an update of a certain iDevice or all devices linked to an iCloud account. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iPhone location. It can be used in automations when a manual location update is needed, e.g., to check if anyone is home when a door been opened. ### Service `icloud.play_sound`