mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 07:46:49 +00:00
54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "17track.net"
|
|
description: "Instructions on how to use 17track.net data within Home Assistant"
|
|
date: 2018-10-31 10:42
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: 17track.png
|
|
ha_category: Postal Service
|
|
ha_release: 0.83
|
|
ha_iot_class: "Cloud Polling"
|
|
---
|
|
|
|
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.
|
|
|
|
<p class='note warning'>
|
|
Although the 17track.net website states that account passwords cannot be longer than 16 characters, users can technically set long-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.
|
|
</p>
|
|
|
|
## {% linkable_title 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 %}
|