home-assistant.io/source/_components/linux_battery.markdown
Franck Nijhof 1833c32a2c Cleans up front matter (#9835)
* Sets front matter defaults

* Removes default front matter from section templates/pages

* Removes default front matter from addon pages

* Removes default front matter from integration pages

* Removes default front matter from posts

* Removes default front matter from docs pages

* Removes default front matter from other pages

* Fixes blog category pages
2019-07-11 14:35:08 -07:00

40 lines
1.0 KiB
Markdown

---
title: "Linux Battery"
description: "Instructions on how to integrate Linux Battery information into Home Assistant."
logo: linux_battery.png
ha_category:
- System Monitor
ha_release: 0.28
ha_iot_class: Local Polling
redirect_from:
- /components/sensor.linux_battery/
---
The `linux_battery` sensor platform is using the information stored in `/sys/class/power_supply/` on your local Linux system to display details about the current state of your battery.
To setup a battery sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: linux_battery
```
{% configuration %}
name:
description: Friendly name to use for the frontend.
required: false
default: Battery
type: string
battery:
description: Number of the battery.
required: false
default: 1
type: integer
system:
description: "The local system type. Support `linux` and `android`."
required: false
default: linux
type: string
{% endconfiguration %}