Giter VIP home page Giter VIP logo

ha-battery-notes's Introduction

Battery Notes for Home Assistant

GitHub Release GitHub Activity Downloads License hacs

Integration to add battery notes to a device, with automatic discovery via a growing battery library for devices.
Track the battery type, when the battery was replaced and also when a battery is low based on device or global thresholds.
A battery+ sensor provides useful attributes for easy use in dashboards, the standard battery can optionally be hidden.

Please โญ this repo if you find it useful
If you want to show your support please

"Buy Me A Coffee"

Battery Notes

Discovery

Installation

HACS

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Or Search for Battery Notes in HACS and install it under the "Integrations" category.

Important

Add the following entry to your configuration.yaml

battery_notes:

Restart Home Assistant
In the HA UI go to Settings -> Integrations click "+" and search for "Battery Notes"

Manual Installation

More Details
  • You should take the latest published release.
  • To install, place the contents of custom_components into the <config directory>/custom_components folder of your Home Assistant installation.
  • Add the following entry to your configuration.yaml
battery_notes:
  • Restart Home Assistant
  • In the HA UI go to Settings -> Integrations click "+" and search for "Battery Notes"

Docs

To get full use of the integration, please visit the docs.

Contributing to the Battery Library

"New Device Request"

To add a device definition to the battery library so that it will be automatically configured fill out the above form or see the docs for adding via pull request.

Translations

To add a new language translation to Battery Notes see here

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines.

Acknowledgements

A lot of the inspiration for this integration came from the excellent PowerCalc by bramstroker, without adapting code from PowerCalc I'd never have worked out how to add additional sensors to a device.

Huge thanks to @bmos for creating the issue form & automations for adding new devices.

Thanks to everyone who has submitted devices to the library.

ha-battery-notes's People

Contributors

andrew-codechimp avatar github-actions[bot] avatar dependabot[bot] avatar bmos avatar danielrheinbay avatar kaosmagix avatar p-v-d avatar dankarization avatar tplas avatar edouardkleinhans avatar tntdruid avatar bartkummel avatar misa1515 avatar jangelgon avatar deosrc avatar dantapps avatar bekesizl avatar wendelfelius avatar mightea avatar timoainali avatar dakael avatar allanjamesvestal avatar cgallred avatar christophcaina avatar djbac avatar ff0205 avatar cermakjn avatar nechry avatar pjanssen avatar ak1de avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.