homeassistant.util.unit_system Namespace Reference

Classes
class	UnitSystem

Functions
str	_deprecated_unit_system (str value)
bool	_is_valid_unit (str unit, str unit_type)
UnitSystem	get_unit_system (str key)

Variables
	AREA_UNITS = AreaConverter.VALID_UNITS
	Final
	IMPERIAL_SYSTEM = US_CUSTOMARY_SYSTEM
	LENGTH_UNITS = DistanceConverter.VALID_UNITS
	METRIC_SYSTEM
	PRESSURE_UNITS = PressureConverter.VALID_UNITS
	US_CUSTOMARY_SYSTEM
	validate_unit_system
	VOLUME_UNITS = VolumeConverter.VALID_UNITS
	WIND_SPEED_UNITS = SpeedConverter.VALID_UNITS

Detailed Description

Unit system helper class and methods.

Function Documentation

_deprecated_unit_system()

str homeassistant.util.unit_system._deprecated_unit_system ( str  value )

private

Convert deprecated unit system.

Definition at line 232 of file unit_system.py.

_is_valid_unit()

bool homeassistant.util.unit_system._is_valid_unit ( str  unit, str  unit_type  )

private

Check if the unit is valid for it's type.

Definition at line 78 of file unit_system.py.

get_unit_system()

UnitSystem homeassistant.util.unit_system.get_unit_system

(

str

key

)

Get unit system based on key.

Definition at line 223 of file unit_system.py.

Variable Documentation

AREA_UNITS

homeassistant.util.unit_system.AREA_UNITS = AreaConverter.VALID_UNITS

Definition at line 47 of file unit_system.py.

Final

homeassistant.util.unit_system.Final

Definition at line 43 of file unit_system.py.

IMPERIAL_SYSTEM

homeassistant.util.unit_system.IMPERIAL_SYSTEM = US_CUSTOMARY_SYSTEM

Definition at line 401 of file unit_system.py.

LENGTH_UNITS

homeassistant.util.unit_system.LENGTH_UNITS = DistanceConverter.VALID_UNITS

Definition at line 49 of file unit_system.py.

METRIC_SYSTEM

homeassistant.util.unit_system.METRIC_SYSTEM

Definition at line 247 of file unit_system.py.

PRESSURE_UNITS

homeassistant.util.unit_system.PRESSURE_UNITS = PressureConverter.VALID_UNITS

Definition at line 58 of file unit_system.py.

US_CUSTOMARY_SYSTEM

homeassistant.util.unit_system.US_CUSTOMARY_SYSTEM

Definition at line 323 of file unit_system.py.

validate_unit_system

homeassistant.util.unit_system.validate_unit_system

Initial value:

=  vol.All(
    vol.Lower,
    _deprecated_unit_system,
    vol.Any(_CONF_UNIT_SYSTEM_METRIC, _CONF_UNIT_SYSTEM_US_CUSTOMARY),
)

Definition at line 241 of file unit_system.py.

VOLUME_UNITS

homeassistant.util.unit_system.VOLUME_UNITS = VolumeConverter.VALID_UNITS

Definition at line 60 of file unit_system.py.

WIND_SPEED_UNITS

homeassistant.util.unit_system.WIND_SPEED_UNITS = SpeedConverter.VALID_UNITS

Definition at line 62 of file unit_system.py.