2024.11.0
Home ▸ Integrations ▸

Apple iCloud

The icloud integration 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 integration 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.

  • Go to Settings > Devices & Services.

  • 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.

Warning

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

Important

You need to use an app-specific password to set up this integration.

In case of troubleshooting

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.

Actions

4 actions are available:

Action icloud.update

This action 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 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 has been opened.

Action icloud.play_sound

This action will play the Lost iPhone sound on your iDevice. It will still ring if you are on “Mute” or “Do not disturb” mode.

Data attribute Optional Description
account no Email address of the iCloud account
device_name no Human Friendly device name like Bob’s iPhone

Action icloud.display_message

This action will display a message on your iDevice. It can also ring your device.

Action icloud.lost_device

This action will put your iDevice on “lost” mode (compatible devices only). You have to provide a phone number with a suffixed country code and a message.