jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

seventeentrack update docs with config flow (#31579)

Browse Source 
* seventeentrack update docs with config flow

* seventeentrack update docs with config flow

removed too much

* Update source/_integrations/seventeentrack.markdown

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>

---------

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
This commit is contained in:
Shai Ungar 2024-03-11 13:47:56 +02:00 committed by GitHub
parent 32c8559334
commit 0066706497
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_integrations/seventeentrack.markdown
View File

@ -4,14 +4,17 @@ description: Instructions on how to use 17track.net data within Home Assistant
ha_category:
- Postal Service
ha_release: 0.83
ha_config_flow: true
ha_iot_class: Cloud Polling
ha_codeowners:
- '@shaiu'
ha_domain: seventeentrack
ha_platforms:
- sensor
ha_integration_type: integration
---
The `seventeentrack` sensor platform allows users to get package data tied to their [17track.net](https://www.17track.net/) 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.
The seventeentrack {% term integration %} allows users to get package data tied to their [17track.net](https://www.17track.net) account. The integration 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'>
@ -19,38 +22,7 @@ Although the 17track.net website states that account passwords cannot be longer
</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 %}
{% include integrations/config_flow.md %}
## Package statuses