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

Functions

list[PyViCareHeatingDeviceComponent] get_burners (PyViCareDevice device)
 
list[PyViCareHeatingDeviceComponent] get_circuits (PyViCareDevice device)
 
list[PyViCareHeatingDeviceComponent] get_compressors (PyViCareDevice device)
 
PyViCareDevice get_device (ConfigEntry entry, PyViCareDeviceConfig device_config)
 
str|None get_device_serial (PyViCareDevice device)
 
bool is_supported (str name, ViCareRequiredKeysMixin entity_description, vicare_device)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

ViCare helpers functions.

Function Documentation

◆ get_burners()

list[PyViCareHeatingDeviceComponent] homeassistant.components.vicare.utils.get_burners ( PyViCareDevice  device)
Return the list of burners.

Definition at line 70 of file utils.py.

◆ get_circuits()

list[PyViCareHeatingDeviceComponent] homeassistant.components.vicare.utils.get_circuits ( PyViCareDevice  device)
Return the list of circuits.

Definition at line 81 of file utils.py.

◆ get_compressors()

list[PyViCareHeatingDeviceComponent] homeassistant.components.vicare.utils.get_compressors ( PyViCareDevice  device)
Return the list of compressors.

Definition at line 92 of file utils.py.

◆ get_device()

PyViCareDevice homeassistant.components.vicare.utils.get_device ( ConfigEntry  entry,
PyViCareDeviceConfig   device_config 
)
Get device for device config.

Definition at line 25 of file utils.py.

◆ get_device_serial()

str | None homeassistant.components.vicare.utils.get_device_serial ( PyViCareDevice  device)
Get device serial for device if supported.

Definition at line 35 of file utils.py.

◆ is_supported()

bool homeassistant.components.vicare.utils.is_supported ( str  name,
ViCareRequiredKeysMixin  entity_description,
  vicare_device 
)
Check if the PyViCare device supports the requested sensor.

Definition at line 52 of file utils.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 22 of file utils.py.