homeassistant.components.system_bridge.entity.SystemBridgeEntity Class Reference

Inheritance diagram for homeassistant.components.system_bridge.entity.SystemBridgeEntity:

Collaboration diagram for homeassistant.components.system_bridge.entity.SystemBridgeEntity:

Public Member Functions
None	__init__ (self, SystemBridgeDataUpdateCoordinator coordinator, int api_port, str key)
DeviceInfo	device_info (self)
str	unique_id (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
bool	available (self)
Public Member Functions inherited from homeassistant.components.system_bridge.coordinator.SystemBridgeDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger LOGGER, *ConfigEntry entry)
ModulesData	async_get_data (self, list[Module] modules)
None	async_handle_module (self, str module_name, Any module)
None	check_websocket_connected (self)
None	clean_disconnect (self)
None	close_websocket (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Private Attributes
	_configuration_url
	_hostname
	_key
	_mac_address
	_uuid
	_version

Static Private Attributes
bool	_attr_has_entity_name = True

Additional Inherited Members
Public Attributes inherited from homeassistant.components.system_bridge.coordinator.SystemBridgeDataUpdateCoordinator
	data
	last_update_success
	listen_task
	title
	unsub
	websocket_client
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method
Static Public Attributes inherited from homeassistant.components.system_bridge.data.SystemBridgeData
	Battery
	CPU
	default_factory
	Disks
	Media
	Memory
	System

Detailed Description

Defines a base System Bridge entity.

Definition at line 11 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.system_bridge.entity.SystemBridgeEntity.__init__	(		self,
		SystemBridgeDataUpdateCoordinator	coordinator,
		int	api_port,
		str	key
	)

Initialize the System Bridge entity.

Definition at line 16 of file entity.py.

Member Function Documentation

device_info()

DeviceInfo homeassistant.components.system_bridge.entity.SystemBridgeEntity.device_info

(

self

)

Return device information about this System Bridge instance.

Definition at line 40 of file entity.py.

unique_id()

str homeassistant.components.system_bridge.entity.SystemBridgeEntity.unique_id

(

self

)

Return the unique ID for this entity.

Definition at line 35 of file entity.py.

Member Data Documentation

_attr_has_entity_name

bool homeassistant.components.system_bridge.entity.SystemBridgeEntity._attr_has_entity_name = True

staticprivate

Definition at line 14 of file entity.py.

_configuration_url

homeassistant.components.system_bridge.entity.SystemBridgeEntity._configuration_url

private

Definition at line 27 of file entity.py.

_hostname

homeassistant.components.system_bridge.entity.SystemBridgeEntity._hostname

private

Definition at line 25 of file entity.py.

_key

homeassistant.components.system_bridge.entity.SystemBridgeEntity._key

private

Definition at line 26 of file entity.py.

_mac_address

homeassistant.components.system_bridge.entity.SystemBridgeEntity._mac_address

private

Definition at line 30 of file entity.py.

_uuid

homeassistant.components.system_bridge.entity.SystemBridgeEntity._uuid

private

Definition at line 31 of file entity.py.

_version

homeassistant.components.system_bridge.entity.SystemBridgeEntity._version

private

Definition at line 32 of file entity.py.

---

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

• core/homeassistant/components/system_bridge/entity.py