This repository has been archived by the owner on Dec 19, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Documentation for config flow (#9)
* update readme * Update info.md * remove short range description
- Loading branch information
1 parent
fe89d56
commit e69acf2
Showing
2 changed files
with
28 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,112 +1,43 @@ | ||
| # nwsradar | ||
|
|
||
| Custom integration for short range NWS radar loops for Home Assistant. | ||
| Radar stations can be found by clicking on this [map](https://radar.weather.gov/Conus/index_lite.php). | ||
| Custom integration for NWS radar loops for Home Assistant. | ||
| Radar stations can be found by clicking on this [map](https://radar.weather.gov/). | ||
|
|
||
| [](https://github.com/custom-components/hacs) | ||
|
|
||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| * This custom integration can be installed and managed using HACS. | ||
| * If you want to manually install, place files in the `custom_components/nwsradar/` folder into `path/to/haconfig/custom_components/nwsradar/` | ||
|
|
||
| ### :warning: Required Dependencies for Installation | ||
| There are system image library dependencies for the python Pillow package that may be required. Here are some reported by users: | ||
| * A jpeg library dependency, `libjpeg-dev`, `libjpeg-turbo` or similar, that needs to be separately installed via `sudo apt-get install libjpeg-turbo`. See [here](https://community.home-assistant.io/t/nws-radar-images/118203/2) for report. You will get an error message like this otherwise: `ImportError: libopenjp2.so.7: cannot open shared object file: No such file or directory`. | ||
| * A tiff library dependency, `libtiff5` or similar, that needs to be separately installed via `sudo apt-get install libtiff5`. See [here](https://github.com/MatthewFlamm/nwsradar/issues/1) for report. You will get an error message like this otherwise: `ImportError: libtiff.so.5: cannot open shared object file: No such file or directory`. | ||
| ## Configuration | ||
|
|
||
| Use UI to configure: **Configuration** -> **Integrations** -> **National Weather Service (NWS) Radar** | ||
|
|
||
| * The `Standard` radar style offers a simple white background. | ||
| * The `Enhanced` radar style offers a topographical background. | ||
| * The `Mosaic` radar style offers a longer range radar view of regions or the entire US. | ||
|
|
||
| Works with picture-entity card: | ||
|
|
||
| ## Sample configuration | ||
| ``` | ||
| camera: | ||
| - platform: nwsradar | ||
| station: VWX | ||
| - type: picture-entity | ||
| entity: camera.vwx # use your entity name | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Change log | ||
| * 0.5.0 | ||
| * Use UI configuration | ||
| * DEPRECATION: YAML configuration to be removed in 0.6.0 | ||
| * 0.4.0 | ||
| * Add Mosaic style option | ||
| * 0.3.0 | ||
| * Add Standard style option | ||
| * BREAKING CHANGE: Default is now Standard style | ||
|
|
||
| ## Detailed Configuration | ||
|
|
||
| Different radar types can be displayed (Note all 0s are zeros): | ||
| * NCR - Composite Reflectivity (default) | ||
| * N0R - Base Reflectivity (out to 124 nm) | ||
| * N0Z - Base Reflectivity (out to 248 nm) | ||
| * N0S - Storm Relative Motion | ||
| * N1P - One-Hour Precipitation | ||
| * NTP - Storm Total Precipitation | ||
|
|
||
| ``` | ||
| camera: | ||
| - platform: nwsradar | ||
| station: VWX | ||
| type: N0R | ||
| ``` | ||
|
|
||
| The `Standard` radar style (the default) offers a simple white background and either a still picture (`frames: 1`) or a loop (any number larger than 1). Looping is the default. | ||
|
|
||
| The 'Enhanced' radar style offers a topographical background and a configurable loop length. | ||
|
|
||
| The `Mosaic` radar style offers a longer range radar view of regions or the entire US. Supported stations are: | ||
|
|
||
| * NATAK | ||
| * NATPR | ||
| * NAT | ||
| * CENTGRTLAKES | ||
| * GREATLAKES | ||
| * HAWAII | ||
| * NORTHEAST | ||
| * NORTHROCKIES | ||
| * PACNORTHWEST | ||
| * PACSOUTHWEST | ||
| * SOUTHEAST | ||
| * SOUTHMISSVLY | ||
| * SOUTHPLAINS | ||
| * SOUTHROCKIES | ||
| * UPPERMISSVLY | ||
|
|
||
| ``` | ||
| camera: | ||
| - platform: nwsradar | ||
| station: VWX | ||
| style: Standard | ||
| ``` | ||
|
|
||
|
|
||
| Different length animations can be produced (default is 6) for `Enhanced` style: | ||
| ``` | ||
| camera: | ||
| - platform: nwsradar | ||
| station: VWX | ||
| style: Enhanced | ||
| frames: 8 # Optional | ||
| ``` | ||
|
|
||
| Mosaic radar loops can be produced with configurable frame number, but radar type isnt supported: | ||
| ``` | ||
| camera: | ||
| - platform: nwsradar | ||
| station: NAT | ||
| style: Mosaic | ||
| frames: 8 # Optional | ||
| ``` | ||
|
|
||
| Entity name can be specified: | ||
| ``` | ||
| camera: | ||
| - platform: nwsradar | ||
| station: VWX | ||
| name: radarname | ||
| ``` | ||
|
|
||
| Works with picture-entity card: | ||
|
|
||
| ``` | ||
| - type: picture-entity | ||
| entity: camera.vwx | ||
| ``` | ||
| ## :warning: Required Dependencies for Installation | ||
| There are system image library dependencies for the python Pillow package that may be required. Here are some reported by users: | ||
| * A jpeg library dependency, `libjpeg-dev`, `libjpeg-turbo` or similar, that needs to be separately installed via `sudo apt-get install libjpeg-turbo`. See [here](https://community.home-assistant.io/t/nws-radar-images/118203/2) for report. You will get an error message like this otherwise: `ImportError: libopenjp2.so.7: cannot open shared object file: No such file or directory`. | ||
| * A tiff library dependency, `libtiff5` or similar, that needs to be separately installed via `sudo apt-get install libtiff5`. See [here](https://github.com/MatthewFlamm/nwsradar/issues/1) for report. You will get an error message like this otherwise: `ImportError: libtiff.so.5: cannot open shared object file: No such file or directory`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,17 @@ | ||
| # nwsradar | ||
|
|
||
| Custom component for short range NWS radar loops for Home Assistant. | ||
| Custom component for NWS radar loops for Home Assistant. | ||
|
|
||
| ### :warning: Required Dependencies | ||
| There are system image library dependencies for the python Pillow package that may be required. Here are some reported by users: | ||
| * A jpeg library dependency, `libjpeg-dev`, `libjpeg-turbo` or similar, that needs to be separately installed via `sudo apt-get install libjpeg-turbo`. See [here](https://community.home-assistant.io/t/nws-radar-images/118203/2) for report. You will get an error message like this otherwise: `ImportError: libopenjp2.so.7: cannot open shared object file: No such file or directory`. | ||
| * A tiff library dependency, `libtiff5` or similar, that needs to be separately installed via `sudo apt-get install libtiff5`. See [here](https://github.com/MatthewFlamm/nwsradar/issues/1) for report. You will get an error message like this otherwise: `ImportError: libtiff.so.5: cannot open shared object file: No such file or directory`. | ||
|
|
||
| ## Sample configuration | ||
| ``` | ||
| camera: | ||
| - platform: nwsradar | ||
| station: VWX | ||
| ``` | ||
| <img src="https://github.com/MatthewFlamm/nws_radar/blob/master/images/radar.gif?raw=True" width="400px"> | ||
|
|
||
| See [README](README.md) for more info on configuration. | ||
| See [README](README.md) for more info on configuration and usage. | ||
|
|
||
| ## Change log | ||
| * 0.5.0 | ||
| * Use UI configuration | ||
| * DEPRECATION: YAML configuration to be removed in 0.6.0 | ||
| * 0.4.0 | ||
| * Add Mosaic style option | ||
| * 0.3.0 | ||
| * Add Standard style option | ||
| * BREAKING CHANGE: Default is now Standard style | ||
|
|
||
| ## Detailed configuration | ||
|
|
||
| Different radar types can be displayed (Note all 0s are zeros). Mosaic style does not support this. | ||
| * NCR - Composite Reflectivity (default) | ||
| * N0R - Base Reflectivity (out to 124 nm) | ||
| * N0Z - Base Reflectivity (out to 248 nm) | ||
| * N0S - Storm Relative Motion | ||
| * N1P - One-Hour Precipitation | ||
| * NTP - Storm Total Precipitation | ||
|
|
||
| Works with picture-entity card: | ||
| ``` | ||
| - type: picture-entity | ||
| entity: camera.vwx | ||
| ``` | ||
|
|
||
| <img src="https://github.com/MatthewFlamm/nws_radar/blob/master/images/radar.gif?raw=True" width="400px"> | ||
|
|