Skip to content

scinos/lovelace-weather-icons

Repository files navigation

Lovelace Weather Icons

hacs_badge GitHub release (latest by date)

Official weather icons from Home Assistant

Installation

While this plugin doesn't require HACS, the instructions are provided for HACS. If you are used to install plugins without HACS, then you probably don't need instructions anyway.

  1. In Home Assistant, navigate to HACS
  2. Select the 3 dots icon in the top right and choose Custom repositories
  3. Add this repository https://github.com/scinos/lovelace-weather-icons/, type 'Dashboard'
  4. Lovelace Weather Icons should be shown as a new repository available to install. Install it.
  5. Reload the UI

Usage

This plugin provides weather icons that are part of Home Assitant, but in a format that can be used in cards, badges, etc.

The list of icons is:

Name Icon
wi:clear-night Icon wi:clear-night
wi:cloudy Icon wi:cloudy
wi:fog Icon wi:fog
wi:hail Icon wi:hail
wi:lightning-rainy Icon wi:lightning-rainy
wi:lightning Icon wi:lightning
wi:partlycloudy-night Icon wi:partlycloudy-night
wi:partlycloudy Icon wi:partlycloudy
wi:pouring Icon wi:pouring
wi:rainy Icon wi:rainy
wi:snowy-rainy Icon wi:snowy-rainy
wi:snowy Icon wi:snowy
wi:sunny Icon wi:sunny
wi:windy-variant Icon wi:windy-variant
wi:windy Icon wi:windy

Contribute

Development

To start the proyect in dev mode, run yarn dev. This will compile the proyect every time there are changes, and serve it on port 10001. Then, go to a Home Assistant instance and add a new resource to the dashboard, with the URL http://<your-ip>:10001/weather-icons.js

To contribute, create a fork of the repository and create PRs with your changes.

Production

Run yarn build. This will generate the bundled file in dist. Copy it over to your Home Assistant instance (or serve it via HTTP), add it as a script resource to a dashboard and reload the dashboard.

Release

After a successful merge to main, create a release in GitHub. Fill the release notes and version as appropiate. Once the release is created, a GitHub Workflow will compile the proyect and attach the bundle to the release as a downloadable file.