From e15388f93aa113385b80ba24aad6b91055527c44 Mon Sep 17 00:00:00 2001 From: happyleavesaoc Date: Thu, 22 Feb 2018 11:45:45 -0500 Subject: [PATCH] update usps doc (#4729) * Update usps.markdown * Update usps.markdown note Chrome preference --- source/_components/usps.markdown | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown index 6f92cc8e779..3971db4ec66 100644 --- a/source/_components/usps.markdown +++ b/source/_components/usps.markdown @@ -16,6 +16,35 @@ 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 for packages 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. +## Prerequisites + +This component requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated. + +

+ If you are using a Raspberry Pi, you must use PhantomJS. +

+ +### PhantomJS + +Install the latest version of [PhantomJS]( http://phantomjs.org/download.html). Ensure the executable is on your `PATH`. `phantomjs --version` should work and report the correct version. This is the default option and requires no further configuration. + +

+ Don't use apt-get to install PhantomJS. This version is not compatible. +

+ + +### Chrome + +Install Chrome 59 or greater (preferably the most recent). Install the latest [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads). Ensure both executables are on your `PATH`. `google-chrome --version` and `chromedriver --version` should work and report the correct version. + +OS-specific instructions: +- [Ubuntu 16](https://gist.github.com/ziadoz/3e8ab7e944d02fe872c3454d17af31a5) (Selenium server portion *not* necessary) +- [RHEL/Centos 7](https://stackoverflow.com/a/46686621) + +If you use the Chrome option, specify `driver: chrome` in your `usps` configuration. + +## Configuration + To enable this component, add the following lines to your `configuration.yaml`: ```yaml