From 7912024f8479cccc170b962f462cdbcd3dfceede Mon Sep 17 00:00:00 2001 From: finity69x2 <32221243+finity69x2@users.noreply.github.com> Date: Sat, 22 Apr 2023 01:34:34 -0400 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 89e8df5..f5b4a97 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ An updated version of the nws_alerts custom integration for Home Assistant origi This integration retrieves updated weather alerts every minute from the US NWS API (by default but it can be changed in the config options). +You can configure the integration to use your NWS Zone, your precise location via GPS coordinates or you can get dynamic location alerts by configuring the integration to use a device_tracker entity from HA as long as that device tracker provides GPS coordinates. + The integration presents the number of currently active alerts as the state of the sensor and lists many alert details as a list in the attributes of the sensor. The sensor that is created is used in my "NWS Alerts" package: https://github.com/finity69x2/nws_alerts/blob/master/packages/nws_alerts_package.yaml @@ -36,10 +38,23 @@ After installing the integration you can then configure it using the instruction There are two ways to configure this integration. -Manually via an entry in your configuration.yaml file: +You can configure the integration via the "Configuration->Integrations" section of the Home Assistant UI: + +Click on "+ Add Integration" buuton in the bottom right corner. + +Search for "NWS Alerts" in the list of integrations and follow the UI prompts to configure the sensor. You can find your Zone or County ID by going to https://alerts.weather.gov/, scroll down to your state and click on the “zone list” and/or "county list" then look for the entry for your county. +There are a few configuration method options to select from. + +Please see the following link to help you decide which option to use: + +https://github.com/finity69x2/nws_alerts/blob/master/lookup_options.md + + +Or manually via an entry in your configuration.yaml file: + To create a sensor instance add the following configuration to your sensor definitions using the zone_id found above: ``` @@ -66,14 +81,4 @@ You can overide the sensor default name ("sensor.nws_alerts") to one of your cho Using the configuration example above the sensor will then be called "sensor.my_nws_alerts_sensor" -Or you can configure the integration via the "Configuration->Integrations" section of the Home Assistant UI. - -Click on "+ Add Integration" buuton in the bottom right corner. - -Search for "NWS Alerts" in the list of integrations and follow the UI prompts to configure the sensor. - -There are a few configuration method options to select from. -Please see the followimg link to help you decide which option to use: - -https://github.com/finity69x2/nws_alerts/blob/master/lookup_options.md