Skip to content

Commit f3aa2e6

Browse files
authored
Improve HACS support (#35)
1 parent 14bce1e commit f3aa2e6

4 files changed

Lines changed: 31 additions & 10 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Composite Device Tracker
22

3-
This platform creates a composite device tracker from one or more other device trackers and/or binary sensors. It will update whenever one of the watched entities updates, taking the last_seen/last_updated (and possibly GPS and battery) data from the changing entity. The result can be a more accurate and up-to-date device tracker if the "input" device tracker's update irregularly.
3+
This integration creates a composite `device_tracker` entity from one or more other device trackers and/or binary sensors. It will update whenever one of the watched entities updates, taking the `last_seen`/`last_updated` (and possibly GPS and battery) data from the changing entity. The result can be a more accurate and up-to-date device tracker if the "input" entities update irregularly.
44

5-
Currently device_tracker's with a source_type of bluetooth, bluetooth_le, gps or router are supported, as well as binary_sensor's.
5+
Currently `device_tracker` entities with a `source_type` of `bluetooth`, `bluetooth_le`, `gps` or `router` are supported, as well as `binary_sensor` entities.
66

7-
Follow the installation instructions below.
8-
Then add the desired configuration. Here is an example of a typical configuration:
7+
Follow the [installation](#installation) instructions below.
8+
Then, after restarting Home Assistant, add the desired configuration and restart Home Assistant once more. Here is an example of a typical configuration:
99

1010
```yaml
1111
composite:
@@ -42,9 +42,18 @@ has changed and suggest how to edit your configuration accordingly.
4242
At some point (i.e., in an upcoming 3.0.0 release) legacy support will be removed.
4343

4444
## Installation
45-
### Versions
45+
### With HACS
46+
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://hacs.xyz/)
4647

47-
This custom integration supports HomeAssistant versions 2021.12 or newer, using Python 3.9 or newer.
48+
You can use HACS to manage the installation and provide update notifications.
49+
50+
1. Add this repo as a [custom repository](https://hacs.xyz/docs/faq/custom_repositories/):
51+
52+
```text
53+
https://github.com/pnbruckner/ha-composite-tracker
54+
```
55+
56+
2. Install the integration using the appropriate button on the HACS Integrations page. Search for "composite".
4857

4958
### Manual
5059

@@ -60,8 +69,9 @@ where `<config>` is your Home Assistant configuration directory.
6069

6170
>__NOTE__: Do not download the file by using the link above directly. Rather, click on it, then on the page that comes up use the `Raw` button.
6271

63-
### With HACS
64-
You can use [HACS](https://hacs.xyz/) to manage installation and updates by adding this repo as a [custom repository](https://hacs.xyz/docs/faq/custom_repositories/).
72+
### Versions
73+
74+
This custom integration supports HomeAssistant versions 2021.12 or newer, using Python 3.9 or newer.
6575

6676
### numpy on Raspberry Pi
6777

custom_components/composite/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"domain": "composite",
33
"name": "Composite",
4-
"version": "2.4.0",
5-
"documentation": "https://github.com/pnbruckner/ha-composite-tracker/blob/master/README.md",
4+
"version": "2.5.0b2",
5+
"documentation": "https://github.com/pnbruckner/ha-composite-tracker/blob/hacs/README.md",
66
"issue_tracker": "https://github.com/pnbruckner/ha-composite-tracker/issues",
77
"requirements": [],
88
"dependencies": [],

hacs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"name": "Composite Device Tracker",
3+
"homeassistant": "2021.12.0b0"
4+
}

info.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Composite Device Tracker
2+
3+
This integration creates a composite `device_tracker` entity from one or more other device trackers and/or binary sensors. It will update whenever one of the watched entities updates, taking the `last_seen`/`last_updated` (and possibly GPS and battery) data from the changing entity. The result can be a more accurate and up-to-date device tracker if the "input" entities update irregularly.
4+
5+
Currently `device_tracker` entities with a `source_type` of `bluetooth`, `bluetooth_le`, `gps` or `router` are supported, as well as `binary_sensor` entities.
6+
7+
For now configuration is done strictly in YAML and will be imported into the Integrations and Entities pages in the UI.

0 commit comments

Comments
 (0)