diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
index 24af78bce..40e3f4538 100644
--- a/.github/ISSUE_TEMPLATE/bug.yml
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@@ -18,7 +18,7 @@ body:
options:
- label: I have added `battery_notes:` to my configuration.yaml and restarted.
required: true
- - label: I have read the [FAQ's](https://github.com/andrew-codechimp/HA-Battery-Notes#faqs).
+ - label: I have read the [FAQ's](https://andrew-codechimp.github.io/HA-Battery-Notes/faq).
required: true
- label: I have enabled debug logging for my installation.
required: true
@@ -56,4 +56,4 @@ body:
- type: textarea
attributes:
label: "Diagnostics dump"
- description: "Drag the diagnostics dump file here. (see https://www.home-assistant.io/integrations/diagnostics/ for info)"
\ No newline at end of file
+ description: "Drag the diagnostics dump file here. (see https://www.home-assistant.io/integrations/diagnostics/ for info)"
diff --git a/README.md b/README.md
index 739df1ecb..5c60a4bd0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Home Assistant Battery Notes
+# Battery Notes for Home Assistant
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
@@ -6,26 +6,17 @@
[![License][license-shield]](LICENSE)
[![hacs][hacsbadge]][hacs]
-[](https://www.buymeacoffee.com/codechimp)
-
-
Integration to add battery notes to a device, with automatic discovery via a growing [battery library](library.md) for devices.
Track both the battery type and also when the battery was replaced.
-*Please :star: this repo if you find it useful*
-
-
+*Please :star: this repo if you find it useful*
+*If you want to show your support please*
-
+[](https://www.buymeacoffee.com/codechimp)
-**This integration will set up the following platforms.**
+
-Platform | Name | Description
--- | -- | --
-`sensor` | Battery Type | Show battery type with attributes for separation of type & quantity.
-`sensor` | Battery last replaced | Date & Time the battery was last replaced.
-`button` | Battery replaced | Update Battery last replaced to now.
-`service` | Set battery replaced | Update Battery last replaced, optionally set a date other than now.
+
## Installation
@@ -49,11 +40,8 @@ In the HA UI go to Settings -> Integrations click "+" and search for "Battery No
More Details
-* Using your tool of choice open the folder for your HA configuration (where you find `configuration.yaml`).
-* If you do not have a `custom_components` folder there, you need to create it.
-* In the `custom_components` folder create a new folder called `battery_notes`.
-* Download _all_ the files from the `custom_components/battery_notes/` folder in this repository.
-* Place the files you downloaded in the new folder you created.
+* You should take the latest [published release](https://github.com/andrew-codechimp/ha-battery-notes/releases).
+* To install, place the contents of `custom_components` into the `/custom_components` folder of your Home Assistant installation.
* Add the following entry to your `configuration.yaml`
```
battery_notes:
@@ -62,94 +50,13 @@ battery_notes:
* In the HA UI go to Settings -> Integrations click "+" and search for "Battery Notes"
-## Configuration is done in the UI
-
-On the "Configuration" -> "Integrations" -> "Battery Notes" screen add a new device, pick your device with a battery and add the battery type.
-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](library.md) 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.
-
-* How do I remove a battery note on a device?
-Go into the Settings -> Integrations -> Battery Notes, use the menu on the right of a device and select Delete, this will only delete the battery note, not the whole device.
-
-* Why does the device icon change?
-Unfortunately where there are multiple integrations associated with a device Home Assistant seems to choose an icon at random, I have no control over this.
-
-* Can I edit a battery note?
-Go into Settings -> Integrations -> Battery Notes and click Configure on the device you want to edit.
-
-* Why am I only able to see some of my devices when adding manually?
-By default Battery Notes filters the device list to only devices with a battery, if you want to add a battery note to a random device then you can disable this filtering by adding the following configuration to your `configuration.yaml` and restart Home Assistant to see all devices.
-```
-battery_notes:
- show_all_devices: True
-```
-
-* I only want to add notes to a few devices, can I disable auto discovery?
-If you want to disable this functionality you can add the following to your `configuration.yaml`, after a restart of Home Assistant you will not see discovered battery notes.
-```
-battery_notes:
- enable_autodiscovery: False
-```
-
-* I don't want to track battery replacement, can I disable this?
-Yes, you can add the following to your `configuration.yaml`, after a restart of Home Assistant *new* devices added to battery notes will have the battery replaced sensor and button disabled. Any devices you have previously added to Battery Notes you will have to disable/enable these sensors manually, which also means you can just enable specific sensors of important ones you want to track.
-```
-battery_notes:
- enable_replaced: False
-```
+## Docs
-* How can I show my support?
-[](https://www.buymeacoffee.com/codechimp)
+To get full use of the integration, please visit the [docs](https://andrew-codechimp.github.io/HA-Battery-Notes/).
## Contributing to the Battery Library
-To add a device definition to the battery library so that it will be automatically configured there are two options:
-
-### Submit Definition via GitHub Issues Form
-
-To add a new device via GitHub Issues, fill out [this form](https://github.com/andrew-codechimp/HA-Battery-Notes/issues/new?template=new_device_request.yml&title=[Device]%3A+).
-Upon submission of the issue, GitHub will attempt to make the required code changes automatically.
-
-### Submit Definition via Pull Request
-
-More Details
-If you have issues with the form, or if you feel more comfortable editing JSON data, you can directly add definitions to [the library.json file](custom_components/battery_notes/data/library.json).
-Fork the repository, add your device details to the JSON document `custom_components/battery_notes/data/library.json`, and then submit a pull request.
-Do not enable GitHub Actions (disabled by default) on your fork as this will mess with the pull request and they are unnecessary for a library submission.
-
-* The manufacturer and model should be exactly what is displayed on the Device screen within Home Assistant.
-* The make & model names may be different between integrations such as Zigbee2MQTT and ZHA, if you see a similar device please duplicate the entry rather than changing it.
-* The `battery_quantity` data is numeric (no quotes) and optional. If a device only requires a single battery, it should be omitted.
-* The `battery_type` data should follow the most common naming for general batteries (ex. AAA, D) and the IEC naming for battery cells (ex. CR2032, 18650) according to [Wikipedia](https://en.wikipedia.org/wiki/List_of_battery_sizes)
-* If a device has a bespoke rechargeable battery you can use `"battery_type": "Rechargeable"`
-* For devices like smoke alarms where the battery is not replaceable you can use `"battery_type": "Irreplaceable"`
-* If a device shouldn't be discovered because there are multiple revisions with the same model number but different battery types it can be added to the library with a `"battery_type": "MANUAL"` to note it is a device that shouldn't have a battery definition added to the library to save removal/re-add because people don't realise there are variants.
-
-For the example image below, your JSON entry will look like this:
-
-```
-{
- "manufacturer": "Philips",
- "model": "Hue motion sensor (9290012607)",
- "battery_type": "AAA",
- "battery_quantity": 2
-},
-```
-
-
-
-
+To add a device definition to the battery library so that it will be automatically configured fill out [this form](https://github.com/andrew-codechimp/HA-Battery-Notes/issues/new?template=new_device_request.yml&title=[Device]%3A+) or see the [docs](https://andrew-codechimp.github.io/HA-Battery-Notes/library) for adding via pull request.
## Contributions are welcome!
diff --git a/images/screenshot-device-info.png b/images/screenshot-device-info.png
deleted file mode 100644
index 9c8089447..000000000
Binary files a/images/screenshot-device-info.png and /dev/null differ
diff --git a/images/screenshot-device.png b/images/screenshot-device.png
deleted file mode 100644
index 5650ea654..000000000
Binary files a/images/screenshot-device.png and /dev/null differ
diff --git a/images/screenshot-discovery.png b/images/screenshot-discovery.png
deleted file mode 100644
index 015ebf728..000000000
Binary files a/images/screenshot-discovery.png and /dev/null differ
diff --git a/mkdocs.yml b/mkdocs.yml
index fbc94d7e8..1f4f412b7 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,6 +1,6 @@
site_name: Battery Notes for Home Assistant
-site_url: https://andrew-codechimp.github.io/ha-battery-notes
-repo_url: https://github.com/andrew-codechimp/ha-battery-notes
+site_url: https://andrew-codechimp.github.io/HA-Battery-Notes
+repo_url: https://github.com/andrew-codechimp/HA-Battery-Notes
docs_dir: docs
nav: