Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
finity69x2 authored Jul 25, 2024
1 parent fe09fc1 commit 34cf6d4
Showing 1 changed file with 1 addition and 44 deletions.
45 changes: 1 addition & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ After installing the integration you can then configure it using the instruction

<b>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</b>

<s>There are two ways to configure this integration.</s>

<b>You can configure the integration via the "Configuration->Integrations" section of the Home Assistant UI:</b>

Click on "+ Add Integration" buuton in the bottom right corner.
Expand All @@ -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.

<s><b>Or manually via an entry in your configuration.yaml file:</b>

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'
```
</s>

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.

0 comments on commit 34cf6d4

Please sign in to comment.