mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-28 13:57:04 +00:00
e1cf7a99ab
* Update sensor.usps.markdown Added more information on Opting In to MY USPS. * Update sensor.usps.markdown
34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
---
|
|
layout: page
|
|
title: USPS Sensor
|
|
description: "Instructions on how to set up USPS sensors within Home Assistant."
|
|
date: 2017-01-06 08:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: usps.png
|
|
ha_category: Sensor
|
|
ha_release: 0.36
|
|
---
|
|
|
|
The `usps` platform allows one to track deliveries by the [US Postal Service (USPS)](https://www.usps.com/).
|
|
In addition to having a USPS account, you will need to complete the "Opt-In" process by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). Currently, you also will need to have a package listed in the "Package Dashboard" in order for the component to complete set-up.
|
|
|
|
To enable this sensor, add the following lines to your `configuration.yaml`:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: usps
|
|
username: YOUR_USERNAME
|
|
password: YOUR_PASSWORD
|
|
```
|
|
|
|
Configuration options for the USPS Sensor:
|
|
|
|
- **username** (*Required*): The username to access the USPS service.
|
|
- **password** (*Required*): The password for the given username.
|
|
- **update_interval** (*Optional*): Interval in minutes for the updates.
|
|
|