/platinum-weather-card

This is the beta version of a HA weather card that is actively being developed.

Primary LanguageTypeScriptMIT LicenseMIT

Platinum Weather Card by @makin-things

A highly configurable weather card with a graphical configuration.

hacs_badge GitHub Release License Maintenance

Support

Hey dude! Help me out for a couple of 🍻 or a ☕!

coffee

Current Status

Currently this is in a beta stage, but feedback is welcome. Feel free to raise github issues. I am particularly keen to get feedback from people that are not from Australian or the USA (we have those covered pretty well in a private chat group, but still log issues). If anyone wants to help with documentation (expecially if it's a how to set things up using different weather integration please raise an issue so we can talk about how to include it).


TODO [The above will be removed from the readme before the first release (or at least updated).]

Overview

This is a fully customisble weather card with a graphical configuration. It has been patterned after the original Dark-Sky animated weather card (https://github.com/iammexx/home-assistant-config/tree/master/ui/darksky), and a forked variant, the BOM Weather Card (https://github.com/DavidFW1960/bom-weather-card). The aim is that this card is usable by people everywhere and be able to deal with your sensors no matter what integration(s) provides them. To get the most from the card you may need to look at what various weather integrations provide in addition to the standard weather entity.

Platinum Weather card

The design goals for the card are:

  • Totally configurable with a gui editor (no more yaml)
  • Provide an upgrade path from @DavidFW1960 custom-weather-card (we are working very closely to ensure this works)
  • A ridiculous amount of flexibilty, as we can not possibbly guess everyone's use case

There has been a lot of code reused, but this card has effectively been rewritten from the ground up to make it more flexible.

Installation

This plugin is now part of the default HACS store. Install card from HACS (note that it requires HACS 1.26.0 or greater) the same way you do for other plugins. After installing the card you can add as many instances of the card the the dashboard as you desire. Due to the complexities of the card (icons/split code for performance) it is not recommended you do a manual install (also you don't get automatic updates offered, please use HACS!).

Concepts

The card has sections, any of these sections can be enabled/disabled and reordered to suit your individual needs. Each section has its own configuration pages for the selection of entities and to control display and styling.

Platinum Weather card

It is understood that everyone's use case may be different (and you may have limited data depending on the weather integration you are using), the default settings are aimed at maintaining compatibiltiy with the old bom/custom/darksky weather card that we are aiming to deprecate. There is no reason that all of your weather data needs to be shown on a single card. This card allows you to have multiple instances with different configurations to achieve what you want.

Rather than putting everything in one gigantic card it is possible to create a few smaller cards, with each having a lot of options of disabled. For example, you could choose to put observations on one card and forecast information on another.

Sections

As mentioned above this new card allows you to enable/disable/reorder the sections. These are the sections currently available (we are thinking about adding more).

On the cards main configuration dialog, use the switch to completely remove a section if it is not required. This will result in that section taking up absolutely no space on the card. Use the up/down buttons to reorder the sections as desired. The Global Options contains settings that have an effect on multiple sections.

TODO [All of these bits will need better expanations re: details] TODO [In all of these sections add and explanation of individual settings]

Title Section

This section as the name suggests, adds a title section to the card that provides a name and a timestamp.

Platinum Weather card

Option name Type Description
Card Title String The Text that should be displayed as the cards title
Entity Update Time Entity Defines the entity to use for the timestamp. The entities state MUST provide a valid timestamp in RFC 3339 format (ie. yyyy-mm-ddThh:mm:ss+offset)
Update Time Preix String Optional text to include as a prefix to the timestamp

Overview Section

This section shows the main large section that was previously at the top of the card. TODO [rewite this].

TODO [include image of section]

Extended Section

A section that shows todays detailed forecast

TODO [include image of section]

Slots Section

A section to show a bunch of data in 2 colums (up to 8 rows).

TODO [include image of section]

Daily Forecast Section

Shows the next x days of forecast info in either a horizontal or vertical layout

TODO [include image of section]

Global options

A page for things that don't neatly fit in other places (ie. they have an effect on multiple sections).

TODO [include image of section]

Migration from the old card

TODO [need to write this]

YAML Editor Options

I think we need to make it clear that this should not be used, but just added for reference.

TODO [Detail the options when in yaml mode]

Shows an illustrated sun in light color mode and a moon with stars in dark color mode.