homeassistant.util.unit_conversion.BaseUnitConverter Class Reference

Inheritance diagram for homeassistant.util.unit_conversion.BaseUnitConverter:

Public Member Functions
float	convert (cls, float value, str|None from_unit, str|None to_unit)
Callable[[float], float]	converter_factory (cls, str|None from_unit, str|None to_unit)
Callable[[float|None], float|None]	converter_factory_allow_none (cls, str|None from_unit, str|None to_unit)
float	get_unit_ratio (cls, str|None from_unit, str|None to_unit)

Private Member Functions
tuple[float, float]	_get_from_to_ratio (cls, str|None from_unit, str|None to_unit)

Detailed Description

Define the format of a conversion utility.

Definition at line 86 of file unit_conversion.py.

Member Function Documentation

_get_from_to_ratio()

tuple[float, float] homeassistant.util.unit_conversion.BaseUnitConverter._get_from_to_ratio (   cls, str | None  from_unit, str | None   to_unit  )

private

Get unit ratio between units of measurement.

Definition at line 111 of file unit_conversion.py.

convert()

float homeassistant.util.unit_conversion.BaseUnitConverter.convert	(		cls,
		float	value,
		str | None	from_unit,
		str | None	to_unit
	)

Convert one unit of measurement to another.

Definition at line 95 of file unit_conversion.py.

converter_factory()

Callable[[float], float] homeassistant.util.unit_conversion.BaseUnitConverter.converter_factory	(		cls,
		str | None	from_unit,
		str | None	to_unit
	)

Return a function to convert one unit of measurement to another.

Reimplemented in homeassistant.util.unit_conversion.TemperatureConverter, and homeassistant.util.unit_conversion.SpeedConverter.

Definition at line 101 of file unit_conversion.py.

converter_factory_allow_none()

Callable[[float | None], float | None] homeassistant.util.unit_conversion.BaseUnitConverter.converter_factory_allow_none	(		cls,
		str | None	from_unit,
		str | None	to_unit
	)

Return a function to convert one unit of measurement to another which allows None.

Reimplemented in homeassistant.util.unit_conversion.TemperatureConverter, and homeassistant.util.unit_conversion.SpeedConverter.

Definition at line 125 of file unit_conversion.py.

get_unit_ratio()

float homeassistant.util.unit_conversion.BaseUnitConverter.get_unit_ratio	(		cls,
		str | None	from_unit,
		str | None	to_unit
	)

Get unit ratio between units of measurement.

Definition at line 136 of file unit_conversion.py.

---

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

• core/homeassistant/util/unit_conversion.py