Installation & Setup - ad-ha/kidschores-ha GitHub Wiki

[!WARNING] Legacy Documentation (v0.4.x)

This page contains outdated pre-v0.5.0 documentation. Please use the updated guide:

→ Getting Started: Installation ←

This legacy page is kept for reference only.

Installation & Setup

Important Notes:

  • Please report any issues via GitHub Issues.
  • Setup: The integration must be configured through the Home Assistant wizard. Follow the installation steps carefully.

- HACS (Home Assistant Community Store)

  1. Ensure HACS is installed. If you haven't yet installed HACS, follow the HACS installation guide.
  2. In Home Assistant, navigate to HACS.
  3. Click the three-dot menu in the top-right corner and select "Custom repositories". Add Repository
  4. Enter the repository URL: https://github.com/ad-ha/kidschores-ha
  5. Select "Integration" from the Category dropdown and click "ADD". Select Category
  6. Search for "KidsChores" in HACS and install the integration.
  7. Restart Home Assistant to apply the changes.

- Manual Installation

  1. Download the latest release from the KidsChores GitHub repository.
  2. Unzip the downloaded file and copy the kidschores directory to the custom_components folder in your Home Assistant configuration directory.
  3. Restart Home Assistant to recognize the new integration.

Installation Instructions

CONFIGURATION

  1. Go to Configuration > Integrations in Home Assistant.
  2. Click "+ Add Integration" and search for "KidsChores".
  3. Follow the setup wizard:
  • Define Points Label: Choose your points name (e.g., Stars, Bucks, Coins).
  • Add Kids & Parents: Create profiles for your kids and assign parents.
  • Define Chores, Badges, Rewards, Penalties, Achievements, and Challenges: Provide detailed settings such as names, descriptions, points, icons, due dates, and recurring schedules.
  1. Finish the setup to start managing your kids’ chores and rewards directly from Home Assistant.
  2. Use the Options Flow to edit, add, or delete any entities as needed.