homeassistant.components.icloud Namespace Reference

Namespaces
	account
	config_flow
	const
	device_tracker
	sensor

Functions
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
string	ATTR_ACCOUNT = "account"
string	ATTR_ACCOUNT_FETCH_INTERVAL = "account_fetch_interval"
string	ATTR_BATTERY = "battery"
string	ATTR_BATTERY_STATUS = "battery_status"
string	ATTR_DEVICE_NAME = "device_name"
string	ATTR_DEVICE_STATUS = "device_status"
string	ATTR_LOST_DEVICE_MESSAGE = "message"
string	ATTR_LOST_DEVICE_NUMBER = "number"
string	ATTR_LOST_DEVICE_SOUND = "sound"
string	ATTR_LOW_POWER_MODE = "low_power_mode"
string	ATTR_OWNER_NAME = "owner_fullname"
string	ATTRIBUTION = "Data provided by Apple iCloud"
string	SERVICE_ICLOUD_DISPLAY_MESSAGE = "display_message"
string	SERVICE_ICLOUD_LOST_DEVICE = "lost_device"
string	SERVICE_ICLOUD_PLAY_SOUND = "play_sound"
string	SERVICE_ICLOUD_UPDATE = "update"
	SERVICE_SCHEMA = vol.Schema({vol.Optional(ATTR_ACCOUNT): cv.string})
	SERVICE_SCHEMA_DISPLAY_MESSAGE
	SERVICE_SCHEMA_LOST_DEVICE
	SERVICE_SCHEMA_PLAY_SOUND

Detailed Description

The iCloud component.

Function Documentation

async_setup_entry()

bool homeassistant.components.icloud.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up an iCloud account from a config entry.

Definition at line 73 of file __init__.py.

async_unload_entry()

bool homeassistant.components.icloud.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 186 of file __init__.py.

Variable Documentation

ATTR_ACCOUNT

string homeassistant.components.icloud.ATTR_ACCOUNT = "account"

Definition at line 43 of file __init__.py.

ATTR_ACCOUNT_FETCH_INTERVAL

string homeassistant.components.icloud.ATTR_ACCOUNT_FETCH_INTERVAL = "account_fetch_interval"

Definition at line 30 of file __init__.py.

ATTR_BATTERY

string homeassistant.components.icloud.ATTR_BATTERY = "battery"

Definition at line 31 of file __init__.py.

ATTR_BATTERY_STATUS

string homeassistant.components.icloud.ATTR_BATTERY_STATUS = "battery_status"

Definition at line 32 of file __init__.py.

ATTR_DEVICE_NAME

string homeassistant.components.icloud.ATTR_DEVICE_NAME = "device_name"

Definition at line 33 of file __init__.py.

ATTR_DEVICE_STATUS

string homeassistant.components.icloud.ATTR_DEVICE_STATUS = "device_status"

Definition at line 34 of file __init__.py.

ATTR_LOST_DEVICE_MESSAGE

string homeassistant.components.icloud.ATTR_LOST_DEVICE_MESSAGE = "message"

Definition at line 44 of file __init__.py.

ATTR_LOST_DEVICE_NUMBER

string homeassistant.components.icloud.ATTR_LOST_DEVICE_NUMBER = "number"

Definition at line 45 of file __init__.py.

ATTR_LOST_DEVICE_SOUND

string homeassistant.components.icloud.ATTR_LOST_DEVICE_SOUND = "sound"

Definition at line 46 of file __init__.py.

ATTR_LOW_POWER_MODE

string homeassistant.components.icloud.ATTR_LOW_POWER_MODE = "low_power_mode"

Definition at line 35 of file __init__.py.

ATTR_OWNER_NAME

string homeassistant.components.icloud.ATTR_OWNER_NAME = "owner_fullname"

Definition at line 36 of file __init__.py.

ATTRIBUTION

string homeassistant.components.icloud.ATTRIBUTION = "Data provided by Apple iCloud"

Definition at line 27 of file __init__.py.

SERVICE_ICLOUD_DISPLAY_MESSAGE

string homeassistant.components.icloud.SERVICE_ICLOUD_DISPLAY_MESSAGE = "display_message"

Definition at line 40 of file __init__.py.

SERVICE_ICLOUD_LOST_DEVICE

string homeassistant.components.icloud.SERVICE_ICLOUD_LOST_DEVICE = "lost_device"

Definition at line 41 of file __init__.py.

SERVICE_ICLOUD_PLAY_SOUND

string homeassistant.components.icloud.SERVICE_ICLOUD_PLAY_SOUND = "play_sound"

Definition at line 39 of file __init__.py.

SERVICE_ICLOUD_UPDATE

string homeassistant.components.icloud.SERVICE_ICLOUD_UPDATE = "update"

Definition at line 42 of file __init__.py.

SERVICE_SCHEMA

homeassistant.components.icloud.SERVICE_SCHEMA = vol.Schema({vol.Optional(ATTR_ACCOUNT): cv.string})

Definition at line 48 of file __init__.py.

SERVICE_SCHEMA_DISPLAY_MESSAGE

homeassistant.components.icloud.SERVICE_SCHEMA_DISPLAY_MESSAGE

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_ACCOUNT): cv.string,
        vol.Required(ATTR_DEVICE_NAME): cv.string,
        vol.Required(ATTR_LOST_DEVICE_MESSAGE): cv.string,
        vol.Optional(ATTR_LOST_DEVICE_SOUND): cv.boolean,
    }
)

Definition at line 54 of file __init__.py.

SERVICE_SCHEMA_LOST_DEVICE

homeassistant.components.icloud.SERVICE_SCHEMA_LOST_DEVICE

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_ACCOUNT): cv.string,
        vol.Required(ATTR_DEVICE_NAME): cv.string,
        vol.Required(ATTR_LOST_DEVICE_NUMBER): cv.string,
        vol.Required(ATTR_LOST_DEVICE_MESSAGE): cv.string,
    }
)

Definition at line 63 of file __init__.py.

SERVICE_SCHEMA_PLAY_SOUND

homeassistant.components.icloud.SERVICE_SCHEMA_PLAY_SOUND

Initial value:

=  vol.Schema(
    {vol.Required(ATTR_ACCOUNT): cv.string, vol.Required(ATTR_DEVICE_NAME): cv.string}
)

Definition at line 50 of file __init__.py.