Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 5.17 KB

README.md

File metadata and controls

80 lines (59 loc) · 5.17 KB
Raw

Notice about the future of this repository

As you may know, this repo was duplicated from AitorDB/home-assistant-sun-card which was archived on 2023-03-10, and just like this one, multiple other forks have been created in a rush to preserve this nice card in Home Assistant. And since then our fork have received some pull requests from users who wanted to contribute to this card.

However, one of the other forks, named rejuvenate/lovelace-horizon-card, has received more development and is now the recommended card to use for your Home Assistant installation. Therefore, we encourage you to switch to that repository for any future updates or contributions.

We understand that it may take some time for everyone to switch to the new repository, so we will keep this repository available for a while to give users a chance to migrate. However, we will not be actively developing or maintaining this repository going forward.

If you have contributed to this repository in the past, we appreciate your efforts and would like to kindly ask you to consider contributing to the rejuvenate/lovelace-horizon-card repository as well. Your help is greatly appreciated, and we hope to see you there!

hacs_badge

Home Assistant Sun card

Home Assistant Sun card based on Google Weather design

Preview

Light mode preview Dark mode preview

Requirements

Install

HACS (recommended)

Home Assistant Sun card is available as a custom repository on HACS. In order to install it, please follow these steps:

  1. Ooen HACS in your Home Assistant
  2. Click on the 3-dots menu in the top right and select "Custom repositories"
  3. Use the following information:
  4. Click "Add"
  5. Search for "Sun card" on HACS directory and select the entry related to this card
  6. Click "Download"
  7. Follow the instructions from HACS and reload the page at the end

Note: I'm working on publishing this back into HACS default directory and will update the status here.

Manually

  1. Download the home-assistant-sun-card.js file from the latest release available and save it in your config/www/community/home-assistant-sun-card/ folder.
  2. Go to Settings > Dashboard in Home Assistant
    1. Click on the 3-dots menu in the top right and select Resources.
    2. Click on the button + Add resource.
    3. Add /local/community/home-assistant-sun-card/home-assistant-sun-card.js to the URL.
    4. Choose Javascript Module as Resource type.

Set up

Using UI

  1. Go to your dashboard, enter in edit mode and click on Add card, you should be able to find Custom: Sun card in the list.
  2. Once in the UI editor you can modify the card behavior by adding some of the config that you will find below

Note: If Custom: Sun card doesn't appear you will have to reload cleaning the cache.

Using YAML

  1. You just need to add a new card with type: 'custom:sun-card' to your cards list and any of the config that you will find below if you want to customize more your card.

Note: If you get an error similar to this Custom element doesn't exist you will have to reload cleaning the cache.

Config

Name Accepted values Description Default
darkMode boolean Changes card colors to dark or light Home assistant dark mode state
language string1 Changes card language Home assistant language or english if not supported
showAzimuth boolean Displays azimuth in the footer false
showElevation boolean Displays elevation in the footer false
timeFormat '12h'/'24h' Displayed time format Locale based on Home assistant language
title string Card title Doesn't display a title by default

(1) Supported languages: da, de, en, es, et, fi, fr, hu, it, nl, pl, pt-BR, ru, sl, sv

Known issues

  • Home assistant seems to provide next events instead today's one

References

=> This repo was duplicated from AitorDB/home-assistant-sun-card which was archived on 2023-03-10.