From 3ebaef2102e605fe3bb3de56527d5c956902bf41 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 7 Sep 2016 16:32:55 +0200 Subject: [PATCH] Add batinfo sensor docs (#903) * Add batinfo sensor docs * Fix typo * Rename to linux_battery * Add new configuration variable and update description --- .../_components/sensor.linux_battery.markdown | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 source/_components/sensor.linux_battery.markdown diff --git a/source/_components/sensor.linux_battery.markdown b/source/_components/sensor.linux_battery.markdown new file mode 100644 index 00000000000..f0ab5a44008 --- /dev/null +++ b/source/_components/sensor.linux_battery.markdown @@ -0,0 +1,31 @@ +--- +layout: page +title: "Linux Battery" +description: "Instructions how to integrate Linux Battery information into Home Assistant." +date: 2016-09-06 07:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: System Monitor +ha_release: 0.28 +ha_iot_class: "Local Polling" +--- + +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 + name: Laptop + battery: 1 +``` + +Configuration variables: + +- **name** (*Optional*): Friendly name to use for the frontend. Default to "Battery". +- **battery** (*Optional*): Number of the battery. Default to `1`. +