141 lines
4.5 KiB
Python
141 lines
4.5 KiB
Python
"""
|
|
Details about the built-in battery.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.linux_battery/
|
|
"""
|
|
import logging
|
|
import os
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import ATTR_NAME, CONF_NAME, DEVICE_CLASS_BATTERY
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
REQUIREMENTS = ['batinfo==0.4.2']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_PATH = 'path'
|
|
ATTR_ALARM = 'alarm'
|
|
ATTR_CAPACITY = 'capacity'
|
|
ATTR_CAPACITY_LEVEL = 'capacity_level'
|
|
ATTR_CYCLE_COUNT = 'cycle_count'
|
|
ATTR_ENERGY_FULL = 'energy_full'
|
|
ATTR_ENERGY_FULL_DESIGN = 'energy_full_design'
|
|
ATTR_ENERGY_NOW = 'energy_now'
|
|
ATTR_MANUFACTURER = 'manufacturer'
|
|
ATTR_MODEL_NAME = 'model_name'
|
|
ATTR_POWER_NOW = 'power_now'
|
|
ATTR_SERIAL_NUMBER = 'serial_number'
|
|
ATTR_STATUS = 'status'
|
|
ATTR_VOLTAGE_MIN_DESIGN = 'voltage_min_design'
|
|
ATTR_VOLTAGE_NOW = 'voltage_now'
|
|
|
|
ATTR_HEALTH = 'health'
|
|
ATTR_STATUS = 'status'
|
|
|
|
CONF_BATTERY = 'battery'
|
|
CONF_SYSTEM = 'system'
|
|
|
|
DEFAULT_BATTERY = 1
|
|
DEFAULT_NAME = 'Battery'
|
|
DEFAULT_PATH = '/sys/class/power_supply'
|
|
DEFAULT_SYSTEM = 'linux'
|
|
|
|
SYSTEMS = ['android', 'linux']
|
|
|
|
PLATFORM_SCHEMA = 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),
|
|
})
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the Linux Battery sensor."""
|
|
name = config.get(CONF_NAME)
|
|
battery_id = config.get(CONF_BATTERY)
|
|
system = config.get(CONF_SYSTEM)
|
|
|
|
try:
|
|
if system == 'android':
|
|
os.listdir(os.path.join(DEFAULT_PATH, 'battery'))
|
|
else:
|
|
os.listdir(os.path.join(DEFAULT_PATH, 'BAT{}'.format(battery_id)))
|
|
except FileNotFoundError:
|
|
_LOGGER.error("No battery found")
|
|
return False
|
|
|
|
add_entities([LinuxBatterySensor(name, battery_id, system)], True)
|
|
|
|
|
|
class LinuxBatterySensor(Entity):
|
|
"""Representation of a Linux Battery sensor."""
|
|
|
|
def __init__(self, name, battery_id, system):
|
|
"""Initialize the battery sensor."""
|
|
import batinfo
|
|
self._battery = batinfo.Batteries()
|
|
|
|
self._name = name
|
|
self._battery_stat = None
|
|
self._battery_id = battery_id - 1
|
|
self._system = system
|
|
self._unit_of_measurement = '%'
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the device class of the sensor."""
|
|
return DEVICE_CLASS_BATTERY
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._battery_stat.capacity
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit the value is expressed in."""
|
|
return self._unit_of_measurement
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes of the sensor."""
|
|
if self._system == 'android':
|
|
return {
|
|
ATTR_NAME: self._battery_stat.name,
|
|
ATTR_PATH: self._battery_stat.path,
|
|
ATTR_HEALTH: self._battery_stat.health,
|
|
ATTR_STATUS: self._battery_stat.status,
|
|
}
|
|
return {
|
|
ATTR_NAME: self._battery_stat.name,
|
|
ATTR_PATH: self._battery_stat.path,
|
|
ATTR_ALARM: self._battery_stat.alarm,
|
|
ATTR_CAPACITY_LEVEL: self._battery_stat.capacity_level,
|
|
ATTR_CYCLE_COUNT: self._battery_stat.cycle_count,
|
|
ATTR_ENERGY_FULL: self._battery_stat.energy_full,
|
|
ATTR_ENERGY_FULL_DESIGN: self._battery_stat.energy_full_design,
|
|
ATTR_ENERGY_NOW: self._battery_stat.energy_now,
|
|
ATTR_MANUFACTURER: self._battery_stat.manufacturer,
|
|
ATTR_MODEL_NAME: self._battery_stat.model_name,
|
|
ATTR_POWER_NOW: self._battery_stat.power_now,
|
|
ATTR_SERIAL_NUMBER: self._battery_stat.serial_number,
|
|
ATTR_STATUS: self._battery_stat.status,
|
|
ATTR_VOLTAGE_MIN_DESIGN: self._battery_stat.voltage_min_design,
|
|
ATTR_VOLTAGE_NOW: self._battery_stat.voltage_now,
|
|
}
|
|
|
|
def update(self):
|
|
"""Get the latest data and updates the states."""
|
|
self._battery.update()
|
|
self._battery_stat = self._battery.stat[self._battery_id]
|