From 34cf6d4b72de1d3af2340ff710b438dcedc093a6 Mon Sep 17 00:00:00 2001 From: finity69x2 <32221243+finity69x2@users.noreply.github.com> Date: Thu, 25 Jul 2024 10:22:43 -0400 Subject: [PATCH] Update README.md --- README.md | 45 +-------------------------------------------- 1 file changed, 1 insertion(+), 44 deletions(-) diff --git a/README.md b/README.md index 6525312..9594778 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,6 @@ After installing the integration you can then configure it using the instruction NOTE: As of HA versoin 2024.5.x the yaml configuration option is broken. I don't know if it will ever be fixed so the only viable config option is via the UI -There are two ways to configure this integration. - 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. @@ -56,45 +54,4 @@ https://github.com/finity69x2/nws_alerts/blob/master/lookup_options.md If you select the "Using a device tracker" option under the "GPS Location" option then HA will use the GPS coordinates provided by that tracker to query for alerts so you should follow the same recommendations for using GPS coordinates when using that option. -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: - -``` -- platform: nws_alerts - zone_id: 'PAC049' -``` - -or enter comma separated values for multiple zones: - -``` -- platform: nws_alerts - zone_id: 'PAC049,WVC031' -``` - -or by entering in specific GPS coordinates: - -``` -- platform: nws_alerts - gps_loc: 39.52, -119.81 -``` - -or, finally, by adding a device_tracker entity: - -``` -- platform: nws_alerts - tracker: 'device_tracker.your_tracker_entity' -``` - - -After you restart Home Assistant then you should have a new sensor called "sensor.nws_alerts" in your system. - -You can overide the sensor default name ("sensor.nws_alerts") to one of your choosing by setting the "name:" option: - -``` -- platform: nws_alerts - zone_id: 'INZ009,INC033' - name: My NWS Alerts Sensor -``` - -Using the configuration example above the sensor will then be called "sensor.my_nws_alerts_sensor". +After you restart Home Assistant then you should have a new sensor (by default) called "sensor.nws_alerts" in your system.