Skip to content

Getting Started: Installation

Jump to bottom
ccpk1 edited this page Feb 27, 2026 · 4 revisions

Get ChoreOps up and running in your Home Assistant instance. This guide covers fresh installations for v0.5.0+.

Tip

Upgrading from KidsChores? See Migration from KidsChores.

Prerequisites

Before installing ChoreOps, ensure you have:

  • Home Assistant: Version 2025.06 or higher
  • HACS (recommended): Installed and configured (HACS installation guide)
  • Storage: ~5MB for integration files
  • Network: Internet access for installation (runs locally after install)

Installation Methods

Method 1: HACS (Recommended)

HACS provides automatic updates and easier management of custom integrations.

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Prefer to add it manually in HACS? Follow the steps below.

  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".
  4. Enter the repository URL: https://github.com/ccpk1/choreops
  5. Select "Integration" from the Category dropdown and click "ADD".
  6. Search for "ChoreOps" in HACS and install the integration.
  7. Restart Home Assistant to apply the changes.

Method 2: Manual Installation

For users who prefer manual installation or don't use HACS.

  1. Download Latest Release Visit the ChoreOps GitHub releases page and download the latest version.

  2. Extract Files Unzip the downloaded file to access the choreops directory.

  3. Copy to Custom Components Copy the entire choreops directory to your Home Assistant custom_components folder:

    <config>/custom_components/choreops/

    Your directory structure should look like:

    config/
└── custom_components/
   └── choreops/
        ├── __init__.py
        ├── manifest.json
        ├── config_flow.py
        └── ...

  4. Restart Home Assistant Settings → System → Restart (required to recognize the new integration)

Initial Configuration

After installation and restart, configure ChoreOps through the Home Assistant UI.

Add the Integration

  1. Navigate to Integrations Settings → Devices & Services → Integrations

  2. Add Integration Click "+ Add Integration" in the bottom-right corner

  3. Search for ChoreOps Type "ChoreOps" in the search box and select it

    [!NOTE] You can also use this direct link: Add ChoreOps Integration

Configuration Wizard

Data Recovery Options (First Screen)

When you first add the ChoreOps integration, the Data Recovery Options dialog appears before anything else.

For brand new installations, select "Start fresh (creates backup of existing data)". This is the most common choice for first-time users.

Other options (for advanced scenarios):

Tip

Keep it simple. The configuration wizard only requires setting up your Points System. We strongly recommend starting there, then reviewing the guides before adding users and chores. Adding 20 chores during initial setup usually wastes time—add them one at a time as you learn the system.

After selecting your data recovery option, the setup wizard guides you through initial configuration:

Step 1: Points System (Required)

  • Points Label: Choose your family's points name (e.g., "Stars", "Bucks", "Coins", "Points")
  • Icon (optional): Select an icon to represent points

This name appears throughout the integration (sensors, notifications, dashboards).

Step 2-4: Users, and Chores (Optional - Recommended to Skip)

You can add users and chores during setup, but we recommend new users skip these steps or add minimal items initially:

  • Review the Quick Start Guide first
  • Understand the workflow before creating entities
  • Add them one at a time through Options Flow after reviewing relevant guides:

To skip: Simply click "Submit" without filling in optional fields, or close the wizard after completing Points setup.

Verification

After completing setup, verify the integration loaded successfully:

Settings → Devices & Services → Integrations

You should see ChoreOps listed with a checkmark.

Note

To view specific sensors and entities created, see the Entities Overview guide.

Next Steps

Start here: Quick Start Guide - Walk through creating your first users and chore with a complete workflow demonstration.

After completing the Quick Start, explore:

Managing Your Installation

Adding More Users or Chores

Settings → Devices & Services → Integrations → ChoreOps → Configure

The configuration settings allow you to manage all aspects of the integration:

  • Add/edit/remove users
  • Add/edit/remove chores
  • Add/edit/remove rewards
  • Add/edit/remove badges
  • Configure bonuses and penalties
  • Set up achievements and challenges
  • General options / backup and recovery

Backup Your Configuration

See Backup and Restore Reference for:

  • Backing up your ChoreOps data
  • Migrating between Home Assistant instances
  • Version upgrade procedures
  • Disaster recovery

Troubleshooting

Integration Not Appearing

Problem: ChoreOps doesn't show up in Add Integration list

Solutions:

  1. Verify files copied correctly to custom_components/choreops/
  2. Check Home Assistant logs: Settings → System → Logs
  3. Restart Home Assistant again
  4. Clear browser cache (Ctrl+Shift+R or Cmd+Shift+R)

Entities Not Created

Problem: Entities missing after setup

Solutions:

  1. Check integration status in Settings → Devices & Services
  2. Verify users and chores created in Options Flow
  3. Check logs for errors: Settings → System → Logs, search "choreops"
  4. Reload integration: Settings → Devices & Services → ChoreOps → ⋮ → Reload

Configuration Changes Not Applying

Problem: Changes made in Options Flow don't take effect

Solutions:

  1. Wait 30-60 seconds for entity updates
  2. Refresh browser page
  3. Check Developer Tools → States for updated values
  4. Reload integration if necessary

Getting Help

Important: Please report any installation issues via GitHub Issues so we can improve this guide.

ChoreOps

🚀 Getting Started

⚙️ Configuration

🔧 Services

💡 Tips & Tricks

📖 Advanced Topics

📚 Technical Reference

👩‍🔧 Troubleshooting

Clone this wiki locally