mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 08:16:53 +00:00
Add APRS device tracker documentation (#9056)
* Add APRS device tracker documentation
* Clarify timeout config
* Update release
* Update release
Hopefully this one is it.
* ✏️ Tweak
This commit is contained in:
parent
6c2dc151cf
commit
a19971a152
59
source/_components/device_tracker.aprs.markdown
Normal file
59
source/_components/device_tracker.aprs.markdown
Normal file
@ -0,0 +1,59 @@
|
||||
---
|
||||
layout: page
|
||||
title: "APRS"
|
||||
description: "Instructions on how to use APRS to track devices in Home Assistant."
|
||||
date: 2018-11-04 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: aprs.png
|
||||
ha_release: 0.95
|
||||
ha_category: Presence Detection
|
||||
ha_iot_class: Cloud Push
|
||||
---
|
||||
|
||||
The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker component connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable APRS tracking in Home Assistant, add the following section to `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: aprs
|
||||
username: FO0BAR
|
||||
callsigns:
|
||||
- 'XX0FOO*'
|
||||
- 'YY0BAR-1'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Your callsign. This is used to connect to the host.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Your APRS password. This will verify the connection.
|
||||
required: false
|
||||
type: string
|
||||
default: -1
|
||||
callsigns:
|
||||
description: A list of callsigns you wish to track. Wildcard `*` is allowed. Any callsigns that match will be added as devices.
|
||||
required: true
|
||||
type: list
|
||||
host:
|
||||
description: The APRS server to connect to.
|
||||
required: false
|
||||
type: string
|
||||
default: rotate.aprs2.net
|
||||
timeout:
|
||||
description: The number of seconds to wait to connect to the APRS-IS network before giving up.
|
||||
required: false
|
||||
type: float
|
||||
default: 30.0
|
||||
{% endconfiguration %}
|
||||
|
||||
Verified connections are only required to send data to the APRS-IS network, which the `aprs` platform does not yet do.
|
||||
However, you are free to verify your connection if you know your APRS password.
|
BIN
source/images/supported_brands/aprs.png
Normal file
BIN
source/images/supported_brands/aprs.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
Loading…
x
Reference in New Issue
Block a user