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-08 09:56:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update NWS to config flow (#13005)

Browse Source 
* Update NWS to config flow

* Remove configuration section
This commit is contained in:
MatthewFlamm 2020-04-17 08:19:45 -04:00 committed by GitHub
parent b97d0422c5
commit 70800bad78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
source/_integrations/nws.markdown
View File

@ -13,62 +13,12 @@ The `nws` platform uses the [National Weather Service](https://www.weather.gov)
## Configuration
To add `nws` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **National Weather Service (NWS)**. Multiple entries can be configured, but a unique set of latitude and longitude must be supplied for each.
According to the [API documentation](https://www.weather.gov/documentation/services-web-api/), a string is required for the API key, and an email address is suggested to be included within the string.
To add NWS to your installation using the closest station, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
nws:
api_key: YOUR_API_KEY
```
To specify a station, for example, KADW (Andrews Air Force Base), use the following:
```yaml
# Example configuration.yaml entry
nws:
api_key: YOUR_API_KEY
station: KADW
```
A list of nearby stations is printed to the log with level `DEBUG` if no station is supplied. Stations can also be found on the [NOAA website](https://www.cnrfc.noaa.gov/metar.php). Codes with only three characters, for example, `ADW` should be prefixed with the letter K, `KADW`.
Multiple entries can be configured, but a unique set of latitude and longitude must be supplied for each:
```yaml
# Example configuration.yaml entry
nws:
- api_key: YOUR_API_KEY
latitude: 38.5
longitude: -76.5
- api_key: YOUR_API_KEY
latitude: 39
longitude: -76.5
```
Providing a METAR station code is optional, and if not supplied, the closest station to the latitude and longitude will be chosen. A list of nearby stations is printed to the log with level `DEBUG` if no station is supplied. Stations can also be found on the [NOAA website](https://www.cnrfc.noaa.gov/metar.php). Codes with only three characters, for example, `ADW` should be prefixed with the letter K, `KADW`.
Two weather entities are created for each entry in the configuration: one for hourly forecasts and one for day and night forecasts. The time supplied for each forecast is the start time for the forecast.
{% configuration %}
api_key:
description: "Your API key. Any string, but an email address is suggested to be included."
required: true
type: string
latitude:
description: "Manually specify latitude. By default, the value will be taken from the Home Assistant configuration."
required: false
type: float
default: "Provided by Home Assistant configuration."
longitude:
description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration.
required: false
type: float
default: "Provided by Home Assistant configuration."
station:
description: "METAR station code."
required: false
type: string
default: "Closest station to `latitude` and `longitude` as returned by NWS API."
{% endconfiguration %}
Details about the API are available in the [NWS API documentation](https://www.weather.gov/documentation/services-web-api). The [pynws](https://github.com/MatthewFlamm/pynws) library is used to retrieve data.