Apple iCloud
The Apple iCloud integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to detect presence using the iCloud service. iCloud allows users to track their location on iOS devices.
There is currently support for the following platforms within Home Assistant:
It does require that your devices are registered with the Find My service.
Configuration
To add the Apple iCloud hub to your Home Assistant instance, use this My button:
Manual configuration steps
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Apple iCloud.
-
Follow the instructions on screen to complete the setup.
You may receive recurring emails and notifications from Apple stating that someone has logged into your account if the integration is improperly configured. If this occurs, select Don't Allow on your iOS device and reconfigure the Integration Credentials when prompted.
For the notification, press “Allow”, then “OK”.
To prevent excessive battery drainage, a dynamic interval is used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device.
Two-factor authentication
Use your regular Apple Account password when setting up the integration. If Apple requires two-factor authentication, Home Assistant asks you to enter the six-digit verification code displayed on one of your trusted Apple devices or sent to your trusted phone number.
If you do not receive a verification code, select Request a new verification code in the verification step to ask Apple to send another code.
In case of troubleshooting
Delete the integration’s configuration (most likely in /config/.storage/icloud), then retry.
Platforms
Calendar
The iCloud integration adds a calendar entity for each of your iCloud calendars, showing the event in progress or the next one due. Calendars are read-only, so events cannot be created or edited from Home Assistant.
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.
To-do list
The iCloud integration adds a to-do list entity for each of your Apple Reminders lists. You can add, edit, complete, and delete reminders, including their due date and notes. Changes sync back to your Apple devices.
Reminder groups hold other lists rather than reminders, so they do not appear as to-do lists. Home Assistant to-do lists are flat, so subtasks appear as regular items rather than nested under a parent. They are listed directly below the reminder they belong to, the way you see them in Reminders on your Apple devices.
If you have Advanced Data Protection turned on, your reminders are end-to-end encrypted and Home Assistant cannot read them yet. Those reminders are left out of the to-do list, so a list can look shorter in Home Assistant than it does on your Apple devices.
List of actions
The Apple iCloud integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following actions. Each link below opens a dedicated page with examples, parameters, and a step-by-step UI walkthrough.
-
Display message (
icloud.display_message) Displays a message on an Apple device. -
Lost device (
icloud.lost_device) Puts an Apple device into Lost Mode. -
Play sound (
icloud.play_sound) Plays the Lost device sound on an Apple device. -
Update (
icloud.update) Requests a location and state update for the devices on an Apple Account.
For an overview of every action across all integrations, see the actions reference.
Media source
iCloud photo albums and shared streams are displayed in the media browser, “Media” > “iCloud”. This will display a list of configured iCloud accounts, selecting the account will give a choice of “Albums” and “Shared Streams”. Selection of these will give a list of available photo albums, and selecting these will display the current contents of the album.