Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.yale.sensor Namespace Reference

Classes

class  YaleBatterySensor
 
class  YaleOperatorSensor
 
class  YaleSensorEntityDescription
 

Functions

int _retrieve_device_battery_state (LockDetail detail)
 
int|None _retrieve_linked_keypad_battery_state (KeypadDetail detail)
 
None _update_from_data (self)
 
None async_setup_entry (HomeAssistant hass, YaleConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

 _attr_available
 
 _attr_device_class = SensorDeviceClass.BATTERY
 
 _attr_native_unit_of_measurement = PERCENTAGE
 
 _attr_native_value
 
 SENSOR_TYPE_DEVICE_BATTERY
 
 SENSOR_TYPE_KEYPAD_BATTERY
 

Detailed Description

Support for Yale sensors.

Function Documentation

◆ _retrieve_device_battery_state()

int homeassistant.components.yale.sensor._retrieve_device_battery_state ( LockDetail  detail)
private
Get the latest state of the sensor.

Definition at line 48 of file sensor.py.

◆ _retrieve_linked_keypad_battery_state()

int | None homeassistant.components.yale.sensor._retrieve_linked_keypad_battery_state ( KeypadDetail  detail)
private
Get the latest state of the sensor.

Definition at line 53 of file sensor.py.

◆ _update_from_data()

None homeassistant.components.yale.sensor._update_from_data (   self)
private
Get the latest state of the sensor.

Definition at line 208 of file sensor.py.

◆ async_setup_entry()

None homeassistant.components.yale.sensor.async_setup_entry ( HomeAssistant  hass,
YaleConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up the Yale sensors.

Definition at line 82 of file sensor.py.

Variable Documentation

◆ _attr_available

homeassistant.components.yale.sensor._attr_available
private

Definition at line 211 of file sensor.py.

◆ _attr_device_class

homeassistant.components.yale.sensor._attr_device_class = SensorDeviceClass.BATTERY
private
Representation of an Yale sensor.

Definition at line 204 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.yale.sensor._attr_native_unit_of_measurement = PERCENTAGE
private

Definition at line 205 of file sensor.py.

◆ _attr_native_value

homeassistant.components.yale.sensor._attr_native_value
private

Definition at line 210 of file sensor.py.

◆ SENSOR_TYPE_DEVICE_BATTERY

homeassistant.components.yale.sensor.SENSOR_TYPE_DEVICE_BATTERY
Initial value:
1 = YaleSensorEntityDescription[LockDetail](
2  key="device_battery",
3  entity_category=EntityCategory.DIAGNOSTIC,
4  state_class=SensorStateClass.MEASUREMENT,
5  value_fn=_retrieve_device_battery_state,
6 )
Mixin for required keys.

Definition at line 67 of file sensor.py.

◆ SENSOR_TYPE_KEYPAD_BATTERY

homeassistant.components.yale.sensor.SENSOR_TYPE_KEYPAD_BATTERY
Initial value:
1 = YaleSensorEntityDescription[KeypadDetail](
2  key="linked_keypad_battery",
3  entity_category=EntityCategory.DIAGNOSTIC,
4  state_class=SensorStateClass.MEASUREMENT,
5  value_fn=_retrieve_linked_keypad_battery_state,
6 )

Definition at line 74 of file sensor.py.