Skip to content

Commit

Permalink
Device docs (#2026)
Browse files Browse the repository at this point in the history
* Details of device summary

* Docs
  • Loading branch information
andrew-codechimp authored Aug 29, 2024
1 parent 389dfcd commit 6edb73c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
8 changes: 5 additions & 3 deletions .github/ISSUE_TEMPLATE/new_device_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ body:
value: |
The battery library is a JSON document at [custom_components/battery_notes/data/library.json](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/custom_components/battery_notes/data/library.json)
To contribute, submit your device details via this form and the relevant code changes will be proposed on your behalf.
If you add a device manually in Battery Notes you will be able to see the details required at the top of the battery details panel, which is also available in the configure panel once you have added it.
To see your devices, click here:
Note: The title above is not used and can be just a friendly description of the device. Manufacturer and model should be exactly what is displayed on the Device screen within Home Assistant.
If your device has a Model ID or HW Version then these must be included.
To see your devices, click here:
If your device has a Model ID or HW Version then these must be included.
[![Open your Home Assistant instance and show your devices.](https://my.home-assistant.io/badges/devices.svg)](https://my.home-assistant.io/redirect/devices/)
Expand All @@ -36,7 +38,7 @@ body:
id: model_id
attributes:
label: Model ID
description: If the device has a Model ID (on a separate line) in the Devices screen within Home Assistant it must be included.
description: If the device has a Model ID in the Devices screen within Home Assistant it must be included.
placeholder: ex. 324131092621
validations:
required: false
Expand Down
1 change: 1 addition & 0 deletions docs/library.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Upon submission using the form above GitHub will attempt to make the required co

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) as this will mess with the pull request and are unnecessary for a library submission.

* The easiest way to get the correct device information is to add the device manually, on the battery type panel you will see a summary at the top of the details required to add to the library. This is also available if you go into configure of the device in battery notes.
* The manufacturer and model should be exactly what is displayed on the Device screen within Home Assistant. If the Device screen has a Model ID or Hardware Version then this should be included.
* In some rare cases models could contain unique identifiers and you want the battery type to apply to all models that match a pattern, in these instances you can use the optional model_match_method attribute. For example Apple iPhone's have a model of iPhoneXX.X but all have a rechargeable battery, here you could use the "model_match_method": "startswith" and just specify iPhone as the model.
* The manufacturer & 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.
Expand Down

0 comments on commit 6edb73c

Please sign in to comment.