Skip to content

Commit

Permalink
Updated readme and additions to library
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-codechimp committed Dec 22, 2023
1 parent 1ea38ed commit 82bafc8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](LICENSE)

[![hacs][hacsbadge]][hacs]

[![Community Forum][forum-shield]][forum]

[![BuyMeACoffee](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee&style=for-the-badge)](https://www.buymeacoffee.com/codechimp)


Integration to add battery notes to a device, with automatic discovery via a growing battery library for devices

*Please :star: this repo if you find it useful*
Expand Down Expand Up @@ -39,7 +40,7 @@ Add the following entry to your `configuration.yaml`
battery_notes:
```
Restart Home Assistant a final time
In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Battery Notes"
In the HA UI go to Settings -> Integrations click "+" and search for "Battery Notes"

### Manual Installation

Expand All @@ -54,7 +55,7 @@ Add the following entry to your `configuration.yaml`
battery_notes:
```
Restart Home Assistant a final time
In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Battery Notes"
In the HA UI go to Settings -> Integrations click "+" and search for "Battery Notes"


## Configuration is done in the UI
Expand All @@ -64,6 +65,12 @@ The battery type will then be displayed as a diagnostic sensor on the device.

## FAQ's

* Does a device have to be in the library?
No, you can always add a device manually by going to Settings -> Integrations -> Battery Notes screen add a new device where you can enter the battery details manually.

* Why is my device not being discovered?
It could be missing from the library or does not exactly match the name that your integration has. ZHA and Z2M for example have different manufacturers/models for the same device, you can still add it manually or contribute to the library.

* When is the library updated?
It updates when Home Assistant is restarted and approximately every 24 hours after that.
It will pull the latest devices that have been merged into the main branch, if you have recently submitted a pull request for a new device it will not appear until it has been manually reviewed and merged.
Expand All @@ -77,6 +84,10 @@ Unfortunately where there are multiple integrations associated with a device Hom
* Can I edit a battery note?
Go into Settings -> Integrations -> Battery Notes and click Configure on the device you want to edit.

* How can I show my support?
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)


## Automatic discovery

Battery Notes will automatically discover devices (as long as you have followed the installation instructions above) that it has in its library and create a notification to add a battery note.
Expand Down
12 changes: 12 additions & 0 deletions custom_components/battery_notes/data/library.json
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,18 @@
"battery_type": "AAA",
"battery_quantity": 4
},
{
"manufacturer": "Netatmo",
"model": "Smart Indoor Module",
"battery_type": "AAA",
"battery_quantity": 2
},
{
"manufacturer": "Netatmo",
"model": "Smart Outdoor Module",
"battery_type": "AAA",
"battery_quantity": 2
},
{
"manufacturer": "Netatmo",
"model": "Netatmo Valve",
Expand Down

0 comments on commit 82bafc8

Please sign in to comment.