Home

Welcome to the ChoreOps Wiki

🚀 Getting Started

New to ChoreOps? Start here.

• Installation and Setup - HACS or manual installation
• Migration from KidsChores - Legacy migration path and cleanup guidance
• Quick Start Guide - Your first users, chore, and approval workflow
• Quick Start Scenarios - Creative family setup ideas
• Dashboard Generation - Use a pre-built auto-populating dashboard
• Backup and Restore Reference - Protect your data

⚙️ Configuration

Core setup: users, chores, rewards, points, badges, and notifications.

• General Options - System-wide settings, retention, kiosk mode, and backup actions
• Points System - Customize your points currency
• Users - Create profiles and assign user capabilities
• Chores - Configure chores with scheduling and approval
• Rewards - Set up rewards users can claim
• Badges - Overview - Choose the right badge model before setup
• Badges - Cumulative - Progressive achievement badges
• Badges - Periodic - Daily/weekly maintenance badges
• Achievements - Configure long-term personal milestones
• Challenges - Configure time-bound goals and campaigns
• Notifications - Mobile notifications and smart alerts

🔧 Services & Automation

Integrate with Home Assistant: Services, examples, and workflows.

• Services Reference - Complete service documentation
• Weekly Activity Reports - Generate 7-day summaries and automate email delivery

💡 Tips & Tricks

• Template Cookbook for Chores, Rewards, and Approvals
• Configure Automatic Approval of Chores - Approval automation patterns
• Use Calendar Events to Set Chore Due Dates - Calendar-triggered scheduling tactics
• Use NFC Tags to Mark Chores Claimed - Fast claim flow patterns
• Apply Penalties for Overdue Chores - Accountability automation
• Critical Chore Overdue Alerts - Escalating alert design

📖 Advanced Topics

Power user features: Dashboard, access control, and advanced badge design.

• Dashboard Integration - Auto-populating UI dashboard
• Advanced Access Control - Shared-device and kiosk mode strategy
• Chores - Advanced Features - Per-user customization and complex scheduling
• Badge Cumulative - Advanced - Advanced cumulative badge patterns
• Badge Periodic - Advanced - Advanced periodic badge patterns

📚 Technical Reference

For developers and advanced users: Entity details and implementation behavior.

• Points - Point entities, attributes, and transaction behavior
• Users - Role-based user entities, buttons, and attributes
• Entities & States - Complete entity documentation
• Chores - Entity mapping and state behavior
• Badges - Badge sensor details
• Configuration Detail - Config/Options flow deep dive
• Dashboard Generation - Generated dashboard contracts and behavior
• Notifications - Notification internals and behavior

👩‍🔧 Troubleshooting

• Troubleshooting Guide - Common problems and solutions
• Frequently asked questions (FAQ) - Common setup and usage questions