77 lines
2.0 KiB
Markdown
77 lines
2.0 KiB
Markdown
---
|
|
title: 17TRACK
|
|
description: Instructions on how to use 17track.net data within Home Assistant
|
|
ha_category:
|
|
- Postal Service
|
|
ha_release: 0.83
|
|
ha_iot_class: Cloud Polling
|
|
ha_domain: seventeentrack
|
|
ha_platforms:
|
|
- sensor
|
|
---
|
|
|
|
The `seventeentrack` sensor platform allows users to get package data tied to their [17track.net](https://www.17track.net/en) account. The platform creates both summary sensors, which show the number of packages in a current state (e.g., "In Transit"), as well as individual sensors for each package within the account.
|
|
|
|
<div class='note warning'>
|
|
|
|
Although the 17track.net website states that account passwords cannot be longer than 16 characters, users can technically set longer-than-16-character passwords. These passwords **will not** work with the used API. Therefore, please ensure that your 17track.net password does not exceed 16 characters.
|
|
|
|
</div>
|
|
|
|
## Configuration
|
|
|
|
To enable the platform, add the following lines to your `configuration.yaml`
|
|
file:
|
|
|
|
```yaml
|
|
sensor:
|
|
- platform: seventeentrack
|
|
username: EMAIL_ADDRESS
|
|
password: YOUR_PASSWORD
|
|
```
|
|
|
|
{% configuration %}
|
|
username:
|
|
description: The email address associated with your 17track.net account.
|
|
required: true
|
|
type: string
|
|
password:
|
|
description: The password associated with your 17track.net account.
|
|
required: true
|
|
type: string
|
|
show_archived:
|
|
description: Whether sensors should be created for archived packages.
|
|
required: false
|
|
type: boolean
|
|
default: false
|
|
show_delivered:
|
|
description: Whether sensors should be created for delivered packages.
|
|
required: false
|
|
type: boolean
|
|
default: false
|
|
{% endconfiguration %}
|
|
|
|
## Examples
|
|
|
|
### Lovelace summary card
|
|
|
|
Use the following templated Markdown card to list all packages in transit along with their status:
|
|
|
|
{% raw %}
|
|
|
|
```yaml
|
|
type: markdown
|
|
title: Packages in transit
|
|
content: >
|
|
{% for package in
|
|
states.sensor.seventeentrack_packages_in_transit.attributes.packages %}
|
|
|
|
>- **{{ package.friendly_name }} ({{ package.tracking_number }}):** {{
|
|
package.info_text }}
|
|
|
|
{% endfor %}
|
|
|
|
```
|
|
|
|
{% endraw %}
|