mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Updated docs for USPS component camera addition (#3074)
* Updated docs for USPS component camera addition * Bump to 0.51 release * Bump release to 0.52 * Sync docs with final PR * Fix typo
This commit is contained in:
John Mihalic
Fredrik Lindqvist
parent
c0fa3e6d1e
commit
0aebbe3fcf
31
source/_components/camera.usps.markdown
Normal file
31
source/_components/camera.usps.markdown
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: USPS Camera
|
||||||
|
description: "Instructions on how to set up USPS camera within Home Assistant."
|
||||||
|
date: 2017-07-28 20:00
|
||||||
|
sidebar: true
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
logo: usps.png
|
||||||
|
ha_category: Camera
|
||||||
|
ha_release: 0.52
|
||||||
|
ha_iot_class: "Cloud Polling"
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](/components/sensor.usps).
|
||||||
|
|
||||||
|
<p class='note'>
|
||||||
|
You must have the [USPS component](/components/usps/) configured to use this camera. The camera will be setup if the `usps` component is configured and the required configuration is set.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
To customize the interval that mail images are rotated in the mail camera you can edit your `configuration.yaml` file with the following settings:
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
camera:
|
||||||
|
- platform: usps
|
||||||
|
scan_interval: 5
|
||||||
|
```
|
||||||
|
|
||||||
|
To enable this camera in your installation, set up the [USPS component](/components/usps) with your username and password.
|
||||||
@ -13,27 +13,6 @@ ha_release: 0.36
|
|||||||
ha_iot_class: "Cloud Polling"
|
ha_iot_class: "Cloud Polling"
|
||||||
---
|
---
|
||||||
|
|
||||||
The `usps` platform allows one to track deliveries and inbound mail from the [US Postal Service (USPS)](https://www.usps.com/).
|
The `usps` sensor component allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](/components/camera.usps).
|
||||||
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). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail.
|
|
||||||
|
|
||||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
To enable this sensor in your installation, set up the [USPS component](/components/usps) with your username and password.
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: usps
|
|
||||||
username: YOUR_USERNAME
|
|
||||||
password: YOUR_PASSWORD
|
|
||||||
```
|
|
||||||
|
|
||||||
You will see two new sensors, one for packages and one for mail.
|
|
||||||
|
|
||||||
Configuration options for the USPS Sensor:
|
|
||||||
|
|
||||||
- **username** (*Required*): The username to access the MyUSPS service.
|
|
||||||
- **password** (*Required*): The password for the given username.
|
|
||||||
- **name** (*Optional*): Prefix for sensor names (defaults to "USPS")
|
|
||||||
|
|
||||||
<p class='note warning'>
|
|
||||||
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
|
|
||||||
</p>
|
|
||||||
|
|||||||
38
source/_components/usps.markdown
Normal file
38
source/_components/usps.markdown
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: USPS
|
||||||
|
description: "Interface USPS mail and package information to Home Assistant."
|
||||||
|
date: 2017-07-28 20:00
|
||||||
|
sidebar: true
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
logo: usps.png
|
||||||
|
ha_category: Hub
|
||||||
|
ha_release: 0.52
|
||||||
|
ha_iot_class: "Cloud Polling"
|
||||||
|
---
|
||||||
|
|
||||||
|
The `usps` platform allows one to track deliveries and inbound mail from 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). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail.
|
||||||
|
|
||||||
|
To enable this component, add the following lines to your `configuration.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
usps:
|
||||||
|
username: YOUR_USERNAME
|
||||||
|
password: YOUR_PASSWORD
|
||||||
|
```
|
||||||
|
|
||||||
|
You will see two new sensors, one for packages and one for mail and a camera to rotate through images of incoming mail for the current day.
|
||||||
|
|
||||||
|
Configuration options for the USPS component:
|
||||||
|
|
||||||
|
- **username** (*Required*): The username to access the MyUSPS service.
|
||||||
|
- **password** (*Required*): The password for the given username.
|
||||||
|
- **name** (*Optional*): Prefix for sensor names (defaults to "USPS")
|
||||||
|
|
||||||
|
<p class='note warning'>
|
||||||
|
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
|
||||||
|
</p>
|
||||||
Loading…
x
Reference in New Issue
Block a user