homeassistant.components.home_connect Namespace Reference

Namespaces
	api
	application_credentials
	binary_sensor
	config_flow
	const
	diagnostics
	entity
	light
	number
	select
	sensor
	switch
	time

Functions
api.HomeConnectAppliance	_get_appliance (HomeAssistant hass, str|None device_id=None, dr.DeviceEntry|None device_entry=None, HomeConnectConfigEntry|None entry=None)
bool	async_migrate_entry (HomeAssistant hass, HomeConnectConfigEntry entry)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, HomeConnectConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, HomeConnectConfigEntry entry)
str	bsh_key_to_translation_key (str bsh_key)
dict[str, Any]	get_dict_from_home_connect_error (api.HomeConnectError err)
None	update_all_devices (HomeAssistant hass, HomeConnectConfigEntry entry)

Variables
	_LOGGER = logging.getLogger(__name__)
	CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
	HomeConnectConfigEntry
list	PLATFORMS
	RE_CAMEL_CASE = re.compile(r"(?<!^)(?=[A-Z])|(?=\d)(?<=\D)")
	SCAN_INTERVAL = timedelta(minutes=1)
	SERVICE_COMMAND_SCHEMA = vol.Schema({vol.Required(ATTR_DEVICE_ID): str})
	SERVICE_OPTION_SCHEMA
	SERVICE_PROGRAM_SCHEMA
	SERVICE_SETTING_SCHEMA

Detailed Description

Support for BSH Home Connect appliances.

Function Documentation

_get_appliance()

api.HomeConnectAppliance homeassistant.components.home_connect._get_appliance ( HomeAssistant  hass, str | None   device_id = None, dr.DeviceEntry | None   device_entry = None, HomeConnectConfigEntry | None   entry = None  )

private

Return a Home Connect appliance instance given a device id or a device entry.

Definition at line 98 of file __init__.py.

async_migrate_entry()

bool homeassistant.components.home_connect.async_migrate_entry	(	HomeAssistant	hass,
		HomeConnectConfigEntry	entry
	)

Migrate old entry.

Definition at line 304 of file __init__.py.

async_setup()

bool homeassistant.components.home_connect.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up Home Connect component.

Definition at line 142 of file __init__.py.

async_setup_entry()

bool homeassistant.components.home_connect.async_setup_entry	(	HomeAssistant	hass,
		HomeConnectConfigEntry	entry
	)

Set up Home Connect from a config entry.

Definition at line 265 of file __init__.py.

async_unload_entry()

bool homeassistant.components.home_connect.async_unload_entry	(	HomeAssistant	hass,
		HomeConnectConfigEntry	entry
	)

Unload a config entry.

Definition at line 282 of file __init__.py.

bsh_key_to_translation_key()

str homeassistant.components.home_connect.bsh_key_to_translation_key

(

str

bsh_key

)

Convert a BSH key to a translation key format.

This function takes a BSH key, such as `Dishcare.Dishwasher.Program.Eco50`,
and converts it to a translation key format, such as `dishcare_dishwasher_bsh_key_eco50`.

Definition at line 345 of file __init__.py.

get_dict_from_home_connect_error()

dict[str, Any] homeassistant.components.home_connect.get_dict_from_home_connect_error

(

api.HomeConnectError

err

)

Return a dict from a Home Connect error.

Definition at line 334 of file __init__.py.

update_all_devices()

None homeassistant.components.home_connect.update_all_devices	(	HomeAssistant	hass,
		HomeConnectConfigEntry	entry
	)

Update all the devices.

Definition at line 290 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.home_connect._LOGGER = logging.getLogger(__name__)

private

Definition at line 46 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.home_connect.CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

Definition at line 52 of file __init__.py.

HomeConnectConfigEntry

homeassistant.components.home_connect.HomeConnectConfigEntry

Definition at line 44 of file __init__.py.

PLATFORMS

list homeassistant.components.home_connect.PLATFORMS

Initial value:

=  [
    Platform.BINARY_SENSOR,
    Platform.LIGHT,
    Platform.NUMBER,
    Platform.SELECT,
    Platform.SENSOR,
    Platform.SWITCH,
    Platform.TIME,
]

Definition at line 87 of file __init__.py.

RE_CAMEL_CASE

homeassistant.components.home_connect.RE_CAMEL_CASE = re.compile(r"(?<!^)(?=[A-Z])|(?=\d)(?<=\D)")

Definition at line 48 of file __init__.py.

SCAN_INTERVAL

homeassistant.components.home_connect.SCAN_INTERVAL = timedelta(minutes=1)

Definition at line 50 of file __init__.py.

SERVICE_COMMAND_SCHEMA

homeassistant.components.home_connect.SERVICE_COMMAND_SCHEMA = vol.Schema({vol.Required(ATTR_DEVICE_ID): str})

Definition at line 85 of file __init__.py.

SERVICE_OPTION_SCHEMA

homeassistant.components.home_connect.SERVICE_OPTION_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_DEVICE_ID): str,
        vol.Required(ATTR_KEY): str,
        vol.Required(ATTR_VALUE): vol.Any(str, int, bool),
        vol.Optional(ATTR_UNIT): str,
    }
)

Definition at line 62 of file __init__.py.

SERVICE_PROGRAM_SCHEMA

homeassistant.components.home_connect.SERVICE_PROGRAM_SCHEMA

Initial value:

=  vol.Any(
    {
        vol.Required(ATTR_DEVICE_ID): str,
        vol.Required(ATTR_PROGRAM): str,
        vol.Required(ATTR_KEY): str,
        vol.Required(ATTR_VALUE): vol.Any(int, str),
        vol.Optional(ATTR_UNIT): str,
    },
    {
        vol.Required(ATTR_DEVICE_ID): str,
        vol.Required(ATTR_PROGRAM): str,
    },
)

Definition at line 71 of file __init__.py.

SERVICE_SETTING_SCHEMA

homeassistant.components.home_connect.SERVICE_SETTING_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(ATTR_DEVICE_ID): str,
        vol.Required(ATTR_KEY): str,
        vol.Required(ATTR_VALUE): vol.Any(str, int, bool),
    }
)

Definition at line 54 of file __init__.py.