Code Monkey home page Code Monkey logo

simple-weather-card's Introduction

Simple Weather Card

A minimalistic weather card for Home Assistant Lovelace UI, inspired by Google Material Design.

Preview

Install

Simple install

This card is available in HACS (Home Assistant Community Store)

  1. Download and copy simple-weather-card-bundle.js from the latest release into your config/www directory.

  2. Add a reference to simple-weather-card-bundle.js inside your ui-lovelace.yaml or through the raw config editor interface.

    resources:
      - url: /local/simple-weather-card-bundle.js?v=0.4.0
        type: module

CLI install

  1. Move into your config/www directory

  2. Download simple-weather-card-bundle.js

    $ wget https://github.com/kalkih/simple-weather-card/releases/download/v0.4.0/simple-weather-card-bundle.js
  3. Add a reference to simple-weather-card-bundle.js inside your ui-lovelace.yaml or through the raw config editor gui.

    resources:
      - url: /local/simple-weather-card-bundle.js?v=0.4.0
        type: module

(Optional) Add to custom updater

  1. Make sure you've the custom_updater component installed and working.

  2. Add a new reference under card_urls in your custom_updater configuration in configuration.yaml.

    custom_updater:
      card_urls:
        - https://raw.githubusercontent.com/kalkih/simple-weather-card/master/tracker.json

Updating

  1. Find your simple-weather-card-bundle.js file in config/www or wherever you ended up storing it.

  2. Replace the local file with the one found in the latest release.

  3. Add the new version number to the end of the card reference url in your ui-lovelace.yaml. This will prevent the browser from loading the old version from cache.

    resources:
      - url: /local/simple-weather-card-bundle.js?v=0.4.0
        type: module

Using the card

Options

Card options

Name Type Default Since Description
type string required v0.1.0 custom:simple-weather-card
entity string required v0.1.0 The entity_id from an entity within the weather domain.
name string optional v0.1.0 Set a custom name.
secondary_info string precipitation v0.2.0 Secondary info displayed, precipitation, humidity, wind_speed.
backdrop boolean/object false v0.1.0 Colored background, accepts true/false or a Backdrop object.
custom array optional` v0.4.0 Override weather information with custom sensors, see Custom option

Backdrop object options

See Backdrop example for example usage.

Name Type Default Description
fade boolean false Faded background.
day string '#45aaf2' Background color (Day).
night string '#a55eea' Background color (Night).
text string 'var(--text-dark-color)' Text color.

Custom option array

See Custom example for example usage. Possible entries are: temp, high, low, state, precipitation, humidity and wind_speed.

custom:
  - temp: sensor.home_temp
  - high: sensor.home_high_temp
  - low: sensor.home_low_temp

Example usage

Standard card

Standard card example

- type: custom:simple-weather-card
  entity: weather.smhi
  name: in current location

Backdrop example

Backdrop example

- type: custom:simple-weather-card
  entity: weather.smhi
  name: " "
  backdrop: true

Custom backdrop example

Custom backdrop example

- type: custom:simple-weather-card
  entity: weather.smhi
  name: at home
  backdrop:
    day: "var(--primary-color)"
    night: "#40445a"

Custom sensors example

- type: custom:simple-weather-card
  entity: weather.smhi
  name: Home
  custom:
    - temp: sensor.home_temp
    - high: sensor.home_high_temp
    - low: sensor.home_low_temp

Problems?

Make sure you have javascript_version: latest set in your configuration.yaml under frontend:.

Make sure you got the latest version of simple-weather-card-bundle.js.

If you have issues after updating the card, try clearing the browser cache manually.

If you are getting "Custom element doesn't exist: simple-weather-card", or are running an older browser try replacing type: module with type: js in the resource reference in ui-lovelace.yaml or in the raw config editor.

License

This project is under the MIT license.

simple-weather-card's People

Contributors

kalkih avatar royto avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.