Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.vicare Namespace Reference

Namespaces

 binary_sensor
 
 button
 
 climate
 
 config_flow
 
 const
 
 diagnostics
 
 entity
 
 fan
 
 number
 
 sensor
 
 types
 
 utils
 
 water_heater
 

Functions

None async_migrate_devices_and_entities (HomeAssistant hass, ConfigEntry entry, ViCareDevice device)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
list[PyViCareDeviceConfig] get_supported_devices (list[PyViCareDeviceConfig] devices)
 
None setup_vicare_api (HomeAssistant hass, ConfigEntry entry)
 
PyViCare vicare_login (HomeAssistant hass, Mapping[str, Any] entry_data, cache_duration=DEFAULT_CACHE_DURATION)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string _TOKEN_FILENAME = "vicare_token.save"
 

Detailed Description

The ViCare integration.

Function Documentation

◆ async_migrate_devices_and_entities()

None homeassistant.components.vicare.async_migrate_devices_and_entities ( HomeAssistant  hass,
ConfigEntry  entry,
ViCareDevice   device 
)
Migrate old entry.

Definition at line 118 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.vicare.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up from config entry.

Definition at line 40 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.vicare.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload ViCare config entry.

Definition at line 104 of file __init__.py.

◆ get_supported_devices()

list[PyViCareDeviceConfig] homeassistant.components.vicare.get_supported_devices ( list[PyViCareDeviceConfig]  devices)
Remove unsupported devices from the list.

Definition at line 186 of file __init__.py.

◆ setup_vicare_api()

None homeassistant.components.vicare.setup_vicare_api ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up PyVicare API.

Definition at line 78 of file __init__.py.

◆ vicare_login()

PyViCare homeassistant.components.vicare.vicare_login ( HomeAssistant  hass,
Mapping[str, Any]  entry_data,
  cache_duration = DEFAULT_CACHE_DURATION 
)
Login via PyVicare API.

Definition at line 61 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.vicare._LOGGER = logging.getLogger(__name__)
private

Definition at line 36 of file __init__.py.

◆ _TOKEN_FILENAME

string homeassistant.components.vicare._TOKEN_FILENAME = "vicare_token.save"
private

Definition at line 37 of file __init__.py.