Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oriionn/ha-battery-level

Get your battery level on Home Assistant
https://github.com/oriionn/ha-battery-level

battery home-assistant homeassistant

Last synced: about 1 month ago
JSON representation

Get your battery level on Home Assistant

Host: GitHub
URL: https://github.com/oriionn/ha-battery-level
Owner: oriionn
License: mit
Created: 2024-04-20T12:34:55.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-04-21T20:55:32.000Z (9 months ago)
Last Synced: 2024-05-01T13:57:36.748Z (9 months ago)
Topics: battery, home-assistant, homeassistant
Language: Go
Homepage:
Size: 1.25 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![Home Assistant Battery Level](docs/banner.png)

# Home Assistant Battery Level

This is a simple software that will check the battery level of your computer et send it to Home Assistant.

## Compatibility

| OS      | Normally | Tested |

|---------|----------|--------|

| Linux   | ✅        | ❌      |

| Windows | ✅        | ✅      |

| MacOS   | ✅        | ❌      |

## Installation

Simply download the [latest release](https://github.com/oriionn/ha-battery-level/releases/latest) and run the executable.

## Configuration

1. Create a new sensor in Home Assistant (template type)

![Settings then services](docs/1_1.png)

![then sensors](docs/1_2.png)

![then create a new sensor](docs/1_3.png)

![then choose template type](docs/1_4.png)

![then choose non binary template](docs/1_5.png)

![then create it](docs/1_6.png)

2. Create a access token in Home Assistant

![User profile then security](docs/2_1.png)

![then create a new token](docs/2_2.png)

![then create it](docs/2_3.png)

3. Run the software, a error will appear

![Error](docs/3_1.png)

4. Open the file path that is in the error message ([Listed here](#config-paths))

![Open the file path](docs/4_1.png)

5. Edit the file with your Home Assistant informations and save it

   (Interval is in seconds)

![Edit the file](docs/5_1.png)

6. Run the software again, it should work

7. Add the sensor to your dashboard (Entity Card)

## Config paths

- Windows: `C:\Users\%USERNAME%\AppData\Roaming\ha-battery-level\settings.toml`

- Linux: `~/.config/ha-battery-level/settings.toml`

- MacOS: `~/Library/Application Support/ha-battery-level/settings.toml`

## Development

### Prerequisites

- [Go](https://golang.org/dl/)

#### Linux

Building apps requires gcc as well as the `gtk3` and `libayatana-appindicator3` development headers to be installed. For Debian or Ubuntu, you may install these using:

```bash

sudo apt-get install gcc libgtk-3-dev libayatana-appindicator3-dev

```

(Source: [getlantern/systray](https://github.com/getlantern/systray/?tab=readme-ov-file#linux))

### Building

1. Clone the repository

```bash

git clone https://github.com/oriionn/ha-battery-level.git

```

2. Change directory

```bash

cd ha-battery-level

```

#### Windows

```bash

go build -ldflags -H=windowsgui

```

#### Linux and MacOS

```bash

go build

```

## Credits

- [Johan Stickman](https://github.com/johan-perso) - For the idea and the help with the Home Assistant

- [getlantern/systray](https://github.com/getlantern/systray) - For the tray icon

- [pelletier/go-toml](https://github.com/pelletier/go-toml) - For the TOML parser

- [sqweek/dialog](https://github.com/sqweek/dialog) - For the dialog box

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.