{"id":13585959,"url":"https://github.com/custom-components/weatheralerts","last_synced_at":"2026-05-07T01:02:00.366Z","repository":{"id":39969845,"uuid":"139894340","full_name":"custom-components/weatheralerts","owner":"custom-components","description":"A sensor that gives you weather alerts from alerts.weather.gov.","archived":false,"fork":false,"pushed_at":"2024-05-18T05:11:41.000Z","size":302,"stargazers_count":121,"open_issues_count":16,"forks_count":15,"subscribers_count":22,"default_branch":"master","last_synced_at":"2024-05-19T04:28:36.639Z","etag":null,"topics":["custom-components","home-assistant","homeassistant","weatheralerts"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/custom-components.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-05T19:56:25.000Z","updated_at":"2024-08-01T16:31:51.528Z","dependencies_parsed_at":"2024-05-18T04:27:33.916Z","dependency_job_id":"bfc6e395-7718-4d1f-8b53-46f07cb89294","html_url":"https://github.com/custom-components/weatheralerts","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fweatheralerts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fweatheralerts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fweatheralerts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fweatheralerts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/custom-components","download_url":"https://codeload.github.com/custom-components/weatheralerts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247670232,"owners_count":20976532,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["custom-components","home-assistant","homeassistant","weatheralerts"],"created_at":"2024-08-01T15:05:14.820Z","updated_at":"2026-05-07T01:02:00.340Z","avatar_url":"https://github.com/custom-components.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# An integration to get weather alerts from weather.gov\r\n\r\n[![GitHub release (latest by date)][release-badge]][release-link]  [![GitHub][license-badge]][license-link]  [![hacs_badge][hacs-badge]][hacs-link]\r\n\r\n[![GitHub stars][stars-badge]][stars-link]  ![GitHub][maintained-badge]  [![GitHub issues][issues-badge]][issues-link]  [![GitHub commits since latest release (by SemVer)][commits-badge]][commits-link]\r\n\r\n\u003e This documentation applies to Weather Alerts version 2026.5.0 and newer. Some migration notes also apply to 2026.1.0.\r\n\u003e  \r\n\u003e Behavior and configuration may differ in earlier versions.\r\n\r\n# Breaking changes\r\n\r\n### v2026.5.0\r\n * No breaking changes\r\n\r\n### v2026.1.0\r\n * This new version will migrate your YAML integration platform config to the new config flow automatically and create a new sensor. It will NOT migrate or re-use your old sensor (i.e. sensor.weatheralerts_1 or sensor.zone_name) and it will generate a new sensor named using data from your zone name and zone/county/marine codes. If you want to continue using the YAML package (not recommended) for its template sensors and automations, it should still be compatible; but you will need to delete the old sensor.weatheralerts_1 sensor entity and rename the new weatheralerts integration sensor entity to sensor.weatheralerts_1. This renaming is not required if you plan to use the new automation and dashboard examples. I highly recommend using the new automation and dashboard examples and to stop using the old YAML package due to the possibility of missed alert notifications.\r\n\r\n\r\n# Upgrading from v2026.1.0\r\n\r\nIf you are upgrading from v2026.1.0, this new version will show up as an update in your `Settings` dashboard. Simply click `WeatherAlerts` in the update list and then click the `Update` button to update to this new version. This upgrade does not contain any breaking changes, so all dashboard cards and automations that worked for v2026.1.0 will still work.\r\n\r\n# Upgrading from v0.1.5 or earlier\r\n\r\nIf you are upgrading from a previous version (v0.1.5 or earlier), installing this new version will migrate your YAML weatheralerts platform configuration(s) to the newer config entry system and will be found in the **Home Assistant → Settings → Devices \u0026 Services → Integrations → Weather Alerts** menu. If you are using the YAML Package files which provides several template sensors and automations to work in conjunction with the weatheralerts sensor, the migration will not migrate the sensor.weatheralerts_1 sensor to the new integration. A new sensor will be created and the old sensor will become abandoned. To continue using the YAML Package files (not recommended due to potential failure to get notifications for new alerts) or to continue using your custom automations and dashboard configuration using sensor.weatheralerts_1, you will have to delete the abandoned sensor.weatheralerts_1 sensor and rename the new sensor entity to sensor.weatheralerts_1. My recommendation is to use the new automation blueprint (or automation examples) and the updated dashboard examples.\r\n\r\nTo fully upgrade and stop using the YAML config and YAML packages, these are the recommended steps:\r\n * Install this new version of Weather Alerts\r\n * Restart Home Assistant \r\n * Check to ensure Weather Alerts shows in **Home Assistant → Settings → Devices \u0026 Services → Integrations**\r\n * Check **Home Assistant → Settings → Devices \u0026 Services → Integrations → Weather Alerts** menu to ensure your configuration was migrated to a config entry (config entry should be named with your zone/county name and the zone/county codes for your location)\r\n * Delete your old YAML weatheralerts platform configuration and the YAML package files\r\n * Restart Home Assistant again\r\n * Delete any abandoned weatheralerts sensors (the new automations and dashboard examples should not need these extra sensors)\r\n * Grab the Weather Alerts Persistent Automation blueprint or check the Automation Examples link to see how the blueprint works and for other example automations\r\n * Check the Dashboard Examples link for examples of how to use the weatheralerts sensor arrays (with no need for YAML Package template sensors)\r\n\r\nTo fully upgrade and continue using the deprecated YAML Package files, these are the unrecommended steps:\r\n * Install this new version of Weather Alerts\r\n * Restart Home Assistant \r\n * Check to ensure Weather Alerts shows in **Home Assistant → Settings → Devices \u0026 Services → Integrations**\r\n * Check **Home Assistant → Settings → Devices \u0026 Services → Integrations → Weather Alerts** menu to ensure your configuration was migrated to a config entry (config entry should be named with your zone/county name and the zone/county codes for your location)\r\n * Delete your old YAML weatheralerts platform configuration but leave the rest of the YAML Package files\r\n * Delete the abandoned sensor.weatheralerts_1 (and sensor.weatheralerts_2, etc. if you had more than one weatheralerts platform configured)\r\n * Rename the new weatheralerts sensor entity for each config entry to the appropriate name (sensor.weatheralerts_1, sensor.weatheralerts_2, etc)\r\n\r\n\r\n# Installing and Using Weather Alerts Integration\r\n\r\n## Manual Installation\r\n\r\nCheck the [Installation](https://github.com/custom-components/weatheralerts/blob/master/documentation/installation.md) documentation for full manual installation instructions.\r\n\r\n## New Installation Quickstart (via HACS \u0026 Home Assistant UI)\r\n\r\n### 1. Install via HACS\r\n\r\n- In Home Assistant, go to **HACS → Integrations**\r\n- Search for **Weather Alerts** and click **Install**\r\n- **Restart Home Assistant** after installation\r\n\r\n### 2. Add the Integration\r\n\r\n- In Home Assistant, go to **Settings → Devices \u0026 Services → Integrations**\r\n- Click **+ Add Integration**, search for **Weather Alerts**, and select it\r\n\r\n### 3. Initial Setup via Config Flow\r\n\r\n1. **Location**  \r\n   - Enter your latitude and longitude (or use the prepopulated suggested values from your `zone.home`). The lat/lon should be entered as numbers only (no degree symbol or cardinal direction appended); in the United States the latitude will be a positive number and longitude will be a negative number. This lat/lon will be used to automatically fetch your zone and county code and prepopulate those fields in the next config step. If you leave the lat/lon fields blank, you will need to find your codes; just ask Google search:\r\n     - what is the nws zone and county code for _city_, _state_\r\n\r\n   In the Google search, just replace _city_ and _state_ with your city and state. Google should reply with a NWS zone Code that is 3 letters (State abbreviation + Z) + 3 numbers (xxZ###) and you should also see a 3 letter (State abbreviation + C) + 3 numbers (xxC###) county code listed under FIPS County Code.\r\n\r\n2. **Zone and County Selection**\r\n   - **Zone Code:** Required. \r\n     - Example: `WIZ038`\r\n   - **County Code:** *(Optional)*\r\n     - Example: `WIC087`\r\n   - **Marine Zones:** *(Optional, comma-separated)*\r\n     - Marine zone lookup here: https://www.weather.gov/marine/wrdoffmz   \r\n     - Example: `LMZ043,LMZ080`\r\n\r\n3. **Sensor Update Settings**\r\n   - **Sensor Update Interval:** Default: `90` seconds (range: `30 - 600`)\r\n   - **API Request Timeout:** Default: `20` seconds (range: `10 - 60`, must be at least 5 seconds less than the update interval)\r\n\r\n\u003e Once setup is complete, the integration will create a sensor (e.g., `sensor.weatheralerts_outagamie_wiz038` with friendly name like `Outagamie (WIZ038)`) and automatically fetch current NWS weather alerts for your configured area. If you don't want land-based alerts with marine alerts, you can create a config entry for just a marine zone by entering the marine zone code in the Zone Code field and leaving the other fields blank or one marine zone code in the Zone Code field and additional marine zone codes in the Marine Zones field. \r\n\r\n\u003e Be sure to check out the new [WeatherAlerts Alert Card](https://github.com/custom-components/weatheralerts/blob/master/documentation/alert_card.md) inspired by [AlertTicker-Card](https://github.com/djdevil/AlertTicker-Card).\r\n\r\n---\r\n\r\n## Usage \u0026 Configuration Guide (Options Flow)\r\n\r\nYou can change any settings after installation using the integration's options flow:\r\n\r\n1. Go to **Settings → Devices \u0026 Services → Integrations**\r\n2. Click the Weather Alerts integration\r\n3. Click the gear icon for the config entry you want to configure\r\n\r\n### Editable Options\r\n\r\n- **Zone Code:** Your main NWS zone (e.g., `WIZ038`)\r\n- **County Code:** *(Optional)* More specific NWS county (e.g., `WIC087`)\r\n- **Marine Zones:** *(Optional)* Comma-separated NWS marine or public zone codes (e.g., `LMZ043,LMZ080`)\r\n\r\n#### Sensor Update Settings\r\n\r\n- **Sensor Update Interval:** How often to fetch new alerts (30 - 600 seconds)\r\n- **API Request Timeout:** How long to wait for NWS API response (10 - 60 seconds, at least 5 seconds less than update interval)\r\n\r\n#### Configure Alert Icons\r\n\r\n- Alert icons can be customized via the integration options menu. See [Alert Icon Configuration](https://github.com/custom-components/weatheralerts/blob/master/documentation/icons.md) for more details.\r\n\r\n\r\nFor advanced configuration, automation and dashboard examples, and troubleshooting, see the full documentation linked below.\r\n\r\n---\r\n\r\n## Additional Notes\r\n\r\n- **No YAML configuration needed:** All setup and changes are handled through the Home Assistant UI.\r\n- **No YAML package(s) needed:** Sensor contains everything needed for automations and dashboard usage.\r\n- **Live validation:** All codes are validated during entry.\r\n- **Monitor multiple sources:** You can track land and marine zones together or seperately with multiple config entries.\r\n- **Error Handling:** User-friendly error messages are shown if you enter invalid codes or encounter API issues.\r\n\r\n---\r\n\r\n## Need Help?\r\n\r\nFor troubleshooting steps and debug logging instructions, see the [Troubleshooting](https://github.com/custom-components/weatheralerts/blob/master/documentation/troubleshooting.md) documentation.\r\n\r\n- [Support Forum](https://github.com/custom-components/weatheralerts/discussions)\r\n- [GitHub Repository Home](https://github.com/custom-components/weatheralerts)\r\n- [View Issues/Feature Requests](https://github.com/custom-components/weatheralerts/issues)\r\n- [Report an Issue/Feature Request](https://github.com/custom-components/weatheralerts/issues/new/choose)\r\n- Check the **Links** below for more detailed instructions, troubleshooting, and for automation and dashboard examples.\r\n\r\n\r\n# Updating via HACS\r\n\r\nCheck the **Breaking Changes** section of this README to see if any special attention is needed before or after updating the integration. Simply use the **Update** button for the *weatheralerts* integration within *HACS* if there are no breaking changes and then restart Home Assistant. If there are significant breaking changes, take a backup, check the breaking changes and plan your update accordingly, and then use the **Update** button for the *weatheralerts* integration within *HACS* to start the update process.\r\n\r\n\r\n# Links\r\n\r\nFull documentation for the Weather Alerts integration is available in the repository:\r\n\r\n- [Overview](https://github.com/custom-components/weatheralerts/blob/master/documentation/overview.md)\r\n- [Installation](https://github.com/custom-components/weatheralerts/blob/master/documentation/installation.md)\r\n- [Configuration](https://github.com/custom-components/weatheralerts/blob/master/documentation/configuration.md)\r\n- [Sensor Behavior](https://github.com/custom-components/weatheralerts/blob/master/documentation/sensor.md)\r\n- [Alert Tracking](https://github.com/custom-components/weatheralerts/blob/master/documentation/alert_tracking.md)\r\n- [Alert Deduplication](https://github.com/custom-components/weatheralerts/blob/master/documentation/deduplication.md)\r\n- [Alert Icon Configuration](https://github.com/custom-components/weatheralerts/blob/master/documentation/icons.md)\r\n- [Error Handling](https://github.com/custom-components/weatheralerts/blob/master/documentation/error_handling.md)\r\n- [Automation Examples](https://github.com/custom-components/weatheralerts/blob/master/documentation/examples_automations.md)\r\n- [Dashboard Examples](https://github.com/custom-components/weatheralerts/blob/master/documentation/examples_dashboard.md)\r\n- [Alert Card](https://github.com/custom-components/weatheralerts/blob/master/documentation/alert_card.md)\r\n- [Troubleshooting](https://github.com/custom-components/weatheralerts/blob/master/documentation/troubleshooting.md)\r\n- [Migration from YAML](https://github.com/custom-components/weatheralerts/blob/master/documentation/migration.md)\r\n- [Documentation Versioning Policy](https://github.com/custom-components/weatheralerts/blob/master/documentation/versioning.md)\r\n\r\n\u003eDeprecated:\r\n\u003e  * [YAML Package Info](https://github.com/custom-components/weatheralerts/blob/master/documentation/YAML_PACKAGES_DOCS.md)\r\n\r\n\r\n\r\n# Todo list\r\n- [x] Add more documentation\r\n- [x] Add config flow to allow UI-based configuration (eliminate yaml-based platform configuration)\r\n- [x] Create alternative (possibly simpler) YAML package or move some template sensors into the integration\r\n- [ ] Add backup weather alert source for occasions when weather.gov alerts api is experiencing an outage\r\n- [ ] Add Canadian weather alerts\r\n\r\n\r\n[release-badge]: https://img.shields.io/github/v/release/custom-components/weatheralerts?style=plastic\r\n[release-link]: https://github.com/custom-components/weatheralerts/releases\r\n[license-badge]: https://img.shields.io/github/license/custom-components/weatheralerts?style=plastic\r\n[license-link]: https://github.com/custom-components/weatheralerts/blob/master/LICENSE\r\n[hacs-badge]: https://img.shields.io/badge/HACS-Default-orange.svg?style=plastic\r\n[hacs-link]: https://github.com/hacs/integration\r\n[stars-badge]: https://img.shields.io/github/stars/custom-components/weatheralerts?style=plastic\r\n[stars-link]: https://github.com/custom-components/weatheralerts/stargazers\r\n[maintained-badge]: https://img.shields.io/maintenance/yes/2026.svg?style=plastic\r\n[issues-badge]: https://img.shields.io/github/issues/custom-components/weatheralerts?style=plastic\r\n[issues-link]: https://github.com/custom-components/weatheralerts/issues\r\n[commits-badge]: https://img.shields.io/github/commits-since/custom-components/weatheralerts/latest?style=plastic\r\n[commits-link]: https://github.com/custom-components/weatheralerts/commits/master\r\n\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustom-components%2Fweatheralerts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcustom-components%2Fweatheralerts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustom-components%2Fweatheralerts/lists"}