Classes
class	LinuxBatterySensor

Functions
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType\|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_ALARM = "alarm"

string	ATTR_CAPACITY = "capacity"

string	ATTR_CAPACITY_LEVEL = "capacity_level"

string	ATTR_CYCLE_COUNT = "cycle_count"

string	ATTR_ENERGY_FULL = "energy_full"

string	ATTR_ENERGY_FULL_DESIGN = "energy_full_design"

string	ATTR_ENERGY_NOW = "energy_now"

string	ATTR_HEALTH = "health"

string	ATTR_MANUFACTURER = "manufacturer"

string	ATTR_MODEL_NAME = "model_name"

string	ATTR_PATH = "path"

string	ATTR_POWER_NOW = "power_now"

string	ATTR_STATUS = "status"

string	ATTR_VOLTAGE_MIN_DESIGN = "voltage_min_design"

string	ATTR_VOLTAGE_NOW = "voltage_now"

string	CONF_BATTERY = "battery"

string	CONF_SYSTEM = "system"

int	DEFAULT_BATTERY = 1

string	DEFAULT_NAME = "Battery"

string	DEFAULT_PATH = "/sys/class/power_supply"

string	DEFAULT_SYSTEM = "linux"

	PLATFORM_SCHEMA

list	SYSTEMS = ["android", "linux"]

Detailed Description

Details about the built-in battery.

Function Documentation

◆ setup_platform()

None homeassistant.components.linux_battery.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType \| None	discovery_info = `None`
	)

Set up the Linux Battery sensor.

Definition at line 61 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.linux_battery.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 22 of file sensor.py.

◆ ATTR_ALARM

string homeassistant.components.linux_battery.sensor.ATTR_ALARM = "alarm"

Definition at line 25 of file sensor.py.

◆ ATTR_CAPACITY

string homeassistant.components.linux_battery.sensor.ATTR_CAPACITY = "capacity"

Definition at line 26 of file sensor.py.

◆ ATTR_CAPACITY_LEVEL

string homeassistant.components.linux_battery.sensor.ATTR_CAPACITY_LEVEL = "capacity_level"

Definition at line 27 of file sensor.py.

◆ ATTR_CYCLE_COUNT

string homeassistant.components.linux_battery.sensor.ATTR_CYCLE_COUNT = "cycle_count"

Definition at line 28 of file sensor.py.

◆ ATTR_ENERGY_FULL

string homeassistant.components.linux_battery.sensor.ATTR_ENERGY_FULL = "energy_full"

Definition at line 29 of file sensor.py.

◆ ATTR_ENERGY_FULL_DESIGN

string homeassistant.components.linux_battery.sensor.ATTR_ENERGY_FULL_DESIGN = "energy_full_design"

Definition at line 30 of file sensor.py.

◆ ATTR_ENERGY_NOW

string homeassistant.components.linux_battery.sensor.ATTR_ENERGY_NOW = "energy_now"

Definition at line 31 of file sensor.py.

◆ ATTR_HEALTH

string homeassistant.components.linux_battery.sensor.ATTR_HEALTH = "health"

Definition at line 39 of file sensor.py.

◆ ATTR_MANUFACTURER

string homeassistant.components.linux_battery.sensor.ATTR_MANUFACTURER = "manufacturer"

Definition at line 32 of file sensor.py.

◆ ATTR_MODEL_NAME

string homeassistant.components.linux_battery.sensor.ATTR_MODEL_NAME = "model_name"

Definition at line 33 of file sensor.py.

◆ ATTR_PATH

string homeassistant.components.linux_battery.sensor.ATTR_PATH = "path"

Definition at line 24 of file sensor.py.

◆ ATTR_POWER_NOW

string homeassistant.components.linux_battery.sensor.ATTR_POWER_NOW = "power_now"

Definition at line 34 of file sensor.py.

◆ ATTR_STATUS

string homeassistant.components.linux_battery.sensor.ATTR_STATUS = "status"

Definition at line 35 of file sensor.py.

◆ ATTR_VOLTAGE_MIN_DESIGN

string homeassistant.components.linux_battery.sensor.ATTR_VOLTAGE_MIN_DESIGN = "voltage_min_design"

Definition at line 36 of file sensor.py.

◆ ATTR_VOLTAGE_NOW

string homeassistant.components.linux_battery.sensor.ATTR_VOLTAGE_NOW = "voltage_now"

Definition at line 37 of file sensor.py.

◆ CONF_BATTERY

string homeassistant.components.linux_battery.sensor.CONF_BATTERY = "battery"

Definition at line 42 of file sensor.py.

◆ CONF_SYSTEM

string homeassistant.components.linux_battery.sensor.CONF_SYSTEM = "system"

Definition at line 43 of file sensor.py.

◆ DEFAULT_BATTERY

int homeassistant.components.linux_battery.sensor.DEFAULT_BATTERY = 1

Definition at line 45 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.linux_battery.sensor.DEFAULT_NAME = "Battery"

Definition at line 46 of file sensor.py.

◆ DEFAULT_PATH

string homeassistant.components.linux_battery.sensor.DEFAULT_PATH = "/sys/class/power_supply"

Definition at line 47 of file sensor.py.

◆ DEFAULT_SYSTEM

string homeassistant.components.linux_battery.sensor.DEFAULT_SYSTEM = "linux"

Definition at line 48 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.linux_battery.sensor.PLATFORM_SCHEMA

Initial value:

 =  SENSOR_PLATFORM_SCHEMA.extend(
     {
         vol.Optional(CONF_BATTERY, default=DEFAULT_BATTERY): cv.positive_int,
         vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
         vol.Optional(CONF_SYSTEM, default=DEFAULT_SYSTEM): vol.In(SYSTEMS),
     }
 )

Definition at line 52 of file sensor.py.

◆ SYSTEMS

list homeassistant.components.linux_battery.sensor.SYSTEMS = ["android", "linux"]

Definition at line 50 of file sensor.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables