Skip to content

Latest commit

 

History

History
275 lines (234 loc) · 6.94 KB

README.md

File metadata and controls

275 lines (234 loc) · 6.94 KB
Raw

HA Reminder

hacs_badge

Please ⭐ this repo if you find it useful


PayPal

A python script for Home Assistant that counts down the days to a reminder. On the day of the reminder, the reminder state will be changed to 'on' state.

See it on YouTube

Installation

Install via HACS (recommended) or download the set_reminder.py file from inside the python_scripts directory here to your local python_scripts directory, then reload python_scripts in Home Assistant.

Enable Python Scripts in Home Assistant

Add to configuration.yaml

python_script:

Create folder

<config>/python_scripts

Script arguments

key required type description
name True string Name of the date (eg. John Birthday)
icon_on False string Icon when reminder has on state (default mdi:calendar-alert)
icon_off False string Icon when reminder has off state (default mdi:calendar-star)
date True date Date, in format YYYY-MM-DD-MM HH:MM (time is optional)
title False string Reminder title (will be used as the friendly name, default 'Reminder')
recurrence False string yearly, montly, daily, does not repeat (default 'yearly')
duration False number Reminder duration ('on' state) in minutes (default 0)
every False number Multiple of the recurrence period
tag False string Tag
notifier False string Notifer to call when reminder occurs
script False string Script to execute when reminder occurs
message False string Notifier / script message (default reminder title)

Usage

examples:

name: John Birthday
date: "1985-10-05"
title: John birthday
tag: birthday

or

name: Replace brita filter
date: "2020-11-06 08:00"
recurrence: monthly
notifier: telegram_bot

or

name: Buy new running shoes
date: "2020-10-01 08:00"
recurrence: monthly
every: 6
notifier: telegram_bot

Generated sensors

Each sensor is given the following automatically:

entity_id: sensor.<name>
icon: <sensor icon>
friendly_name: <title>
next: <next occurence date time>
remaining: <remaining days or remaining hours:minutes (time left dependend)>
days: <total remaining days>
seconds: <total remaining seconds>
enable: <enable state>
tag: <tag>

Example configuration.yaml entry

An example automation to create and refresh the above three sensors daily would be:

automation:
  - alias: Reminder refresh
    trigger:
      - platform: time_pattern
        minutes: /30
      - platform: homeassistant
        event: start
    action:
      - service: python_script.set_reminder
        data:
          name: John birthday
          date: "1985-10-05"
          title: John birthday
          tag: birthday

Example Lovelace representation

type: entities
show_header_toggle: false
title: Reminders
entities:
  - entity: sensor.john_birthday

Advance Example

The following configuration can be used to have UI configurable reminder. For lovelace, you need to install the following:

Reminders

input_select:
  reminder1_recurrence:
    name: Recurrence
    options:
      - Does not repeat
      - Daily
      - Weekly
      - Monthly
      - Yearly
input_number:
  reminder1_every:
    name: Every
    icon: mdi:counter
    min: 1
    max: 100
    step: 1
    mode: box
input_datetime:
  reminder1_date:
    name: Date
    has_date: true
    has_time: true
    icon: mdi:calendar-month-outline
input_boolean:
  reminder1_enable:
    name: Enable
    icon: mdi:calendar-blank
input_text:
  reminder1_title:
    name: Title
    max: 32
automation:
  - alias: Reminder refresh
    trigger:
      - platform: time_pattern
        minutes: /30
      - platform: homeassistant
        event: start
    action:
      - service: script.reminder_refresh
script:
  reminder_refresh:
    sequence:
      - service: python_script.set_reminder
        data:
          name: reminder1
          recurrence: "{{ states('input_select.reminder1_recurrence') }}"
          every: "{{ states('input_number.reminder1_every') | int }}"
          title: "{{ states('input_text.reminder1_title') }}"
          date: "{{ as_timestamp(states('input_datetime.reminder1_date')) | timestamp_local }}"
          enable: "{{ states('input_boolean.reminder1_enable') }}"
decluttering_templates:
  template_reminder_card:
    card:
      type: entity-filter
      state_filter:
        - "on"
      entities:
        - entity: input_boolean.[[name]]_enable
      show_empty: false
      card:
        type: vertical-stack
        cards:
          - type: custom:multiple-entity-row
            entity: sensor.[[name]]
            secondary_info:
              attribute: next
            entities:
              - attribute: remaining
                name: Remaining
              - entity: input_boolean.[[name]]_enable
                toggle: true
                name: false
          - type: custom:fold-entity-row
            head:
              type: divider
              label: padding
              style:
                background-color: var(--background-card-color)
            padding: 20
            entities:
              - entity: input_text.[[name]]_title
              - entity: input_datetime.[[name]]_date
              - entity: input_number.[[name]]_every
              - entity: input_select.[[name]]_recurrence
.
. (cards)
.
      - type: vertical-stack
        cards:
          - type: entities
            entities:
              - sensor.date_time
          - type: entities
            entities:
              - type: custom:decluttering-card
                template: template_reminder_card
                variables:
                  - name: reminder1
      - type: entity-filter
        state_filter:
          - "off"
        show_empty: false
        entities:
          - entity: input_boolean.reminder1_enable
        card:
          show_header_toggle: false

Todo

  • Add weekly support (not implemented yet)

I put a lot of work into making this repo and component available and updated to inspire and help others! I will be glad to receive thanks from you — it will give me new strength and add enthusiasm:


PayPal