mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Fix comments and squash commits (#6863)
This commit is contained in:
parent
df9218479c
commit
c171d83b0f
@ -21,22 +21,38 @@ To integrate Owntracks tracking via HTTP in Home Assistant, add the following se
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: owntracks_http
|
||||
webhook_id: long-random-webhook-url
|
||||
```
|
||||
|
||||
For configuration options and usage instructions, read the documentation for the [OwnTracks platform](/components/device_tracker.owntracks/).
|
||||
The value for `webhook_id` should be sufficiently long and random, as it is the only form of "authentication" that is used. For this reason, it is highly advisable to be randomly generated.
|
||||
|
||||
To generate a `webhook_id` you can use the following command on your Raspberry Pi:
|
||||
|
||||
```bash
|
||||
python3 -c "import binascii;import os;print(binascii.hexlify(os.urandom(32)).decode('ascii'))"
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
webhook_id:
|
||||
description: Set the URL suffix used in the webhook component
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
For further configuration options and usage instructions, read the documentation for the [OwnTracks platform](/components/device_tracker.owntracks/).
|
||||
|
||||
## {% linkable_title Configuring OwnTracks to submit data via HTTP %}
|
||||
|
||||
Open OwnTracks and go to Connection preferences:
|
||||
|
||||
- Mode: Select **Private HTTP**
|
||||
- Host: [Home Assistant URL]:[port]/api/owntracks/[your name]/[device name]
|
||||
- Identification: Turn **Authentication** on, username `homeassistant` and password is your API password that you use to login to Home Assistant.
|
||||
- Host: [Home Assistant URL]:[port]/api/webhook/[your-random-webhook-url]?u=[your name]&d=[device name]
|
||||
|
||||
Host example: If I host my Home Assistant at `https://example.duckdns.org`, my name is Paulus and my phone is a Pixel I would set the host to be `https://example.duckdns.org/api/owntracks/paulus/pixel`. This will result in an entity with an ID of `device_tracker.paulus_pixel`. You can pick any name for the user and the device.
|
||||
Host example: If I host my Home Assistant at `https://example.duckdns.org`, my name is Paulus, my phone is a Pixel and I configured the value for `webhook_id` to be `long-random-webhook-url` I would set the host to be `https://example.duckdns.org/api/webhook/long-random-webhook-url?u=paulus&d=pixel`. This will result in an entity with an ID of `device_tracker.paulus_pixel`. You can pick any name for the user and the device.
|
||||
|
||||
Since the battery data is available as an attribute of the device tracker entity, it can be tracked with a [`template` sensor](/components/sensor.template/).
|
||||
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -50,3 +66,17 @@ sensor:
|
||||
device_class: battery
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
||||
## {% linkable_title Setting up on Android %}
|
||||
|
||||
The Android OwnTracks app sends more data than its iOS counterpart and it is possible to configure it using the `Identification` tab in `Preferences`, setting **Username** to your name, and **Device ID** to your device's name. Password field may be left blank.
|
||||
|
||||
Elaborating on the general example above:
|
||||
|
||||
1. Identification: Turn **Authentication** on,
|
||||
2. Set **Username** to `paulus` and leave the password blank or put any string in it.
|
||||
3. Set Device ID to `pixel`
|
||||
4. In the Host tab enter simply `https://example.duckdns.org/api/webhook/long-random-webhook-url`
|
||||
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user