Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.08 KB

README.md

File metadata and controls

57 lines (43 loc) · 2.08 KB

Occasions

hacs_badge

Setup entities for occasions like birthdays, aniversarys and holidays. Occasions is a lovelace card to show the countdown to these events.

occasions mov

For installation instructions, see this guide.

Installation

HACS

The easiest way to add this to your Homeassistant installation is using [HACS].

It's recommended to restart Homeassistent directly after the installation without any change to the Configuration. Homeassistent will install the dependencies during the next reboot. After that you can add and check the configuration without error messages. This is nothing special to this Integration but the same for all custom components.

Configuration

To use this card, you can add it via the Lovelace UI or manually in YAML:

type: 'custom:occasions-card'
title: Occasions
occasions:
  - name: "John's Birthday"
    date: "2024-05-20"
    icon: "mdi:cake"
  - name: "Anniversary"
    date: "2024-06-15"
    icon: "mdi:heart"
  - name: "Christmas Day"
    date: "1900-12-25"
    icon: "mdi:pine-tree"
    count: false

Options

Card

Name Type Default Description
type string custom:occasions-card
title string Occasions Title of the card
numberofdays int 365 Number of days to display
occasions list List of occasions to display

Occasion

Name Type Default Description
name string Jimmy Riddle Name of the person or the event
date date Date of the event
icon string mdi:calendar Icon
count bool true Show the number of years