Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.97 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.97 KB

EARLY RELEASE

This was designed to solve a personal need and I'm now trying to prepare it for others to use. That means several things can break between releases.

activity-manager

Manager recurring tasks from within Home Assistant

Use the companion Activity Manager Card for the best experience.

The core idea is that an activity happens on a recurring basis, which is stored in the frequency field when adding an activity. By default, the activity is last completed when you first add the activity and then the timer can be reset.

Installation

Manually

Clone or download this repository and copy the "nfl" directory to your "custom_components" directory in your config directory

<config directory>/custom_components/activity-manager/...

HACS

  1. Open the HACS section of Home Assistant.
  2. Click the "..." button in the top right corner and select "Custom Repositories."
  3. In the window that opens paste this Github URL.
  4. Select "Integration"
  5. In the window that opens when you select it click om "Install This Repository in HACS"

Usage

Once installed, you can use the link below to add the integration from the UI.

Open your Home Assistant instance and start setting up a new integration.

More information

  • Activities are stored in .activities_list.json in your <config> folder
  • An entity is created for each activity (e.g. activity_manager.<category>_<activity>). The state of the activity is when the activity is due. You can use this entity to build notifications or your own custom cards.
  • Three services are exposed: activity_manager.add_activity, activity_manager.update_activity, activity_manager.remove_activity. The update activity can be used to reset the timer.