homeassistant.components.icloud.account.IcloudDevice Class Reference

Collaboration diagram for homeassistant.components.icloud.account.IcloudDevice:

Public Member Functions
None	__init__ (self, IcloudAccount account, AppleDevice device, status)
int|None	battery_level (self)
str|None	battery_status (self)
AppleDevice	device (self)
str	device_class (self)
str	device_model (self)
None	display_message (self, str message, bool sound=False)
dict[str, Any]	extra_state_attributes (self)
dict[str, Any]|None	location (self)
None	lost_device (self, str number, str message)
str	name (self)
None	play_sound (self)
str	unique_id (self)
None	update (self, status)

Private Attributes
	_account
	_attrs
	_battery_level
	_battery_status
	_device
	_device_class
	_device_id
	_device_model
	_location
	_name
	_status

Static Private Attributes
string	_attr_attribution = "Data provided by Apple iCloud"

Detailed Description

Representation of a iCloud device.

Definition at line 369 of file account.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.icloud.account.IcloudDevice.__init__	(		self,
		IcloudAccount	account,
		AppleDevice	device,
			status
	)

Initialize the iCloud device.

Definition at line 374 of file account.py.

Member Function Documentation

battery_level()

int | None homeassistant.components.icloud.account.IcloudDevice.battery_level

(

self

)

Return the Apple device battery level.

Definition at line 484 of file account.py.

battery_status()

str | None homeassistant.components.icloud.account.IcloudDevice.battery_status

(

self

)

Return the Apple device battery status.

Definition at line 489 of file account.py.

device()

AppleDevice homeassistant.components.icloud.account.IcloudDevice.device

(

self

)

Return the Apple device.

Definition at line 469 of file account.py.

device_class()

str homeassistant.components.icloud.account.IcloudDevice.device_class

(

self

)

Return the Apple device class.

Definition at line 474 of file account.py.

device_model()

str homeassistant.components.icloud.account.IcloudDevice.device_model

(

self

)

Return the Apple device model.

Definition at line 479 of file account.py.

display_message()

None homeassistant.components.icloud.account.IcloudDevice.display_message	(		self,
		str	message,
		bool	sound = False
	)

Display a message on the device.

Definition at line 437 of file account.py.

extra_state_attributes()

dict[str, Any] homeassistant.components.icloud.account.IcloudDevice.extra_state_attributes

(

self

)

Return the attributes.

Definition at line 499 of file account.py.

location()

dict[str, Any] | None homeassistant.components.icloud.account.IcloudDevice.location

(

self

)

Return the Apple device location.

Definition at line 494 of file account.py.

lost_device()

None homeassistant.components.icloud.account.IcloudDevice.lost_device	(		self,
		str	number,
		str	message
	)

Make the device in lost state.

Definition at line 446 of file account.py.

name()

str homeassistant.components.icloud.account.IcloudDevice.name

(

self

)

Return the Apple device name.

Definition at line 464 of file account.py.

play_sound()

None homeassistant.components.icloud.account.IcloudDevice.play_sound

(

self

)

Play sound on the device.

Definition at line 428 of file account.py.

unique_id()

str homeassistant.components.icloud.account.IcloudDevice.unique_id

(

self

)

Return a unique ID.

Definition at line 459 of file account.py.

update()

None homeassistant.components.icloud.account.IcloudDevice.update	(		self,
			status
	)

Update the iCloud device.

Definition at line 402 of file account.py.

Member Data Documentation

_account

homeassistant.components.icloud.account.IcloudDevice._account

private

Definition at line 376 of file account.py.

_attr_attribution

string homeassistant.components.icloud.account.IcloudDevice._attr_attribution = "Data provided by Apple iCloud"

staticprivate

Definition at line 372 of file account.py.

_attrs

homeassistant.components.icloud.account.IcloudDevice._attrs

private

Definition at line 390 of file account.py.

_battery_level

homeassistant.components.icloud.account.IcloudDevice._battery_level

private

Definition at line 415 of file account.py.

_battery_status

homeassistant.components.icloud.account.IcloudDevice._battery_status

private

Definition at line 387 of file account.py.

_device

homeassistant.components.icloud.account.IcloudDevice._device

private

Definition at line 378 of file account.py.

_device_class

homeassistant.components.icloud.account.IcloudDevice._device_class

private

Definition at line 383 of file account.py.

_device_id

homeassistant.components.icloud.account.IcloudDevice._device_id

private

Definition at line 382 of file account.py.

_device_model

homeassistant.components.icloud.account.IcloudDevice._device_model

private

Definition at line 384 of file account.py.

_location

homeassistant.components.icloud.account.IcloudDevice._location

private

Definition at line 388 of file account.py.

_name

homeassistant.components.icloud.account.IcloudDevice._name

private

Definition at line 381 of file account.py.

_status

homeassistant.components.icloud.account.IcloudDevice._status

private

Definition at line 379 of file account.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/icloud/account.py