Skip to content

Kids Chores is a custom integration for Home Assistant. This is a dynamic dashboard that can provide a simple full featured interface into the capabilities of that integration without building individual chores and dashboards.

License

Notifications You must be signed in to change notification settings

ccpk1/kidschores-ha-dashboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

๐Ÿก Kids Chores and Rewards Dashboard

A fully automated UI dashboard built specifically for the KidsChores Integration, seamlessly integrating with Home Assistant. Designed to provide a complete front-end experience, this dashboard makes it easy to interact with the KidsChores systemโ€”allowing kids to claim chores, track progress, and redeem rewards while giving parents full control over approvals and management.

No custom buttons or manual dashboard setup requiredโ€”just install, configure, and enjoy a fully featured, ready-to-use interface in minutes!

image

Buy Me A Coffee


๐ŸŒŸ Why Use the KidsChores Dashboard?

โœ… A fully automated, mobile-friendly interface for kids to view and claim tasks.
โœ… Comprehensive parent control panel for reviewing and approving chores & rewards.
โœ… Built-in gamification โ€“ Badges, streaks, rewards, penalities, bonuses, challenges, and achievement tracking.
โœ… Multi-Language Support โ€“ Now available in 5 languages, and it only takes 30 minutes to add a new one! ๐ŸŒ
โœ… Automatic chore categorization based on due dates and statuses or custom grouping by label.
โœ… Real-time updates on chore approvals, penalties, and rewards.
โœ… Optimized for all devices โ€“ Works seamlessly on mobile, desktop, and tablets.

What is the KidsChores Integration by @ad-ha (VaReTaS)?:

The KidsChores Integration handles all chore tracking, point management, and automation in the background, while the KidsChores Dashboard provides a user-friendly front-end UI for kids and parents to interact with those features.

๐Ÿ”น Chore state management (e.g., overdue, claimed, completed).
๐Ÿ”น Point calculations and balances.
๐Ÿ”น Badge, challenge, and reward logic.
๐Ÿ”น Approvals and penalties tracking.


๐Ÿ“Œ Features at a Glance

๐Ÿง’ For Kids

โœ… Chores organized by category or custom label: Overdue, Morning, Daily, Upcoming, or Custom.
โœ… Track progress with badges earned, streak counts, and points.
โœ… Redeem rewards quickly with an interactive button system.
โœ… View bonuses, penalties, achievements and challenges with clear progress indicators and rewards.

๐Ÿ‘ฉโ€๐Ÿ‘ฆ For Parents

โœ… Chore Approvals: Instantly approve or deny completed chores with a simple hold action.
โœ… Reward Approvals: Quickly review and approve claimed rewards.
โœ… Overdue Chore Management: Reset all overdue chores or individual chore statuses with one tap.
โœ… Due Date Adjustments: Change the due date of any chore, including adding or clearing dates.
โœ… Bonuses & Penalties: Apply Bonuses to reward good behaviors or deductions for accountability.
โœ… Manual Points Adjustments: Add or remove points for corrections or bonuses.
โœ… 7-Day Activity Log: View a complete history of chore claims, approvals, penalties, and rewards.


๐ŸŽจ Kids Dashboard

๐Ÿ  Overview

The Kids Dashboard is designed to give kids a simple, fun, and engaging way to track their progress, earn rewards, and celebrate their achievements. Built automatically from the KidsChores Integration, it encourages responsibility and consistency without any manual setup or customization.

โญ Easy and Fun: Simple, one-click actions for chores and rewards.
๐Ÿš€ Motivating: See progress on achievements, challenges, and badges in real-time.
๐ŸŽฏ Clear Goals: Automatically updates with current points, streaks, and upcoming tasks.


๐Ÿ“Œ Example Kids Dashboard UI:


๐Ÿ”น Dashboard Sections Overview

1๏ธโƒฃ Points & Progress Tracking

  • Displays the child's current points and highest earned badge, with icons for easy recognition.
  • Shows progress for:
    • ๐Ÿ“… Weekly completed chores
    • โ˜€๏ธ Todayโ€™s completed tasks
    • ๐Ÿ† Achievements and challenge goals with clear status indicators.
  • Points labels and icons are automatically sourced from the integration.

2๏ธโƒฃ Chores Section

  • Chores are automatically categorized into:

    • ๐Ÿ›‘ Overdue โ€” Chores past their due date
    • โ˜€๏ธ Due this Morning โ€” Chores due before noon
    • ๐ŸŒž Due Today โ€” Chores due between noon and midnight
    • ๐Ÿ—“๏ธ Upcoming & Bonus โ€” Future chores or those without a set date
    • ๐Ÿท๏ธ Custom Labels โ€” Create and assign labels in the integration to group, filter, or exclude chores based on category, difficulty, or any custom criteria.
  • Each chore card displays:

    • ๐Ÿ’Ž Points earned
    • ๐Ÿ”ฅ Streak count
    • ๐Ÿ“… Due date and time
    • ๐Ÿ“Œ Status: Pending, Approved, or Claimed
  • Shared chores are clearly marked with โ€œ(S)โ€ for easy identification. When one child claims a shared chore, the dashboard visually updates for the other assigned kids by displaying a purple icon and a multi-person symbol, indicating that someone else has already completed it. However, this is purely for awarenessโ€”each child's chore responsibility remains independently handled in the backend system. Their task can still become overdue if unclaimed, and they can still claim and get approval for completing it. While single-completion shared chores aren't currently supported, this visual indicator can serve as a helpful workaround for families managing shared tasks.

image

  • Multi-claim chores now display in blue after their first approval. These chores also show an "(M)" after their status, indicating they can be claimed again.

image

  • All chores are claimed with a single clickโ€”no extra actions needed.
  • Completion is indicated by icon color and a badge overlay (no separate โ€œCompletedโ€ category).


3๏ธโƒฃ Rewards Section

  • Allows kids to redeem rewards instantly using their earned points.
  • Displays reward details, including:
    • ๐Ÿ’ฐ Cost in points
    • ๐Ÿ“ฅ Claims made
    • โœ… Approval status (if needed)
    • ๐ŸŸข Can be redeemed now โ€” clearly indicates if the child has enough points
  • Rewards are automatically listed from the integrationโ€”no manual setup required.
  • Simple one-click redemption makes rewards easy to claim and enjoy.
  • Reward Categories โ€” Organize rewards into custom groups, by using labels in the integration making it easier manage or filter different types of incentives.

4๏ธโƒฃ Kids Showcase โ€“ Celebrate Progress and Achievements

The Kids Showcase section is a dedicated dashboard celebrating the childโ€™s progress, milestones, and goals. This section highlights achievements and badges earned while providing detailed progress tracking for ongoing challenges.

Showcase Highlights:

  • ๐Ÿ… Badges Earned: Displays all collected badges with icons and descriptions.
  • ๐ŸŒŸ Highest Badge and Multiplier: Shows the childโ€™s highest badge and its impact on their points earnings.
  • โญ Bonuses: Tracks extra points awarded for exceptional effort.
  • โŒ Penalties: Displays applied point deductions for missed chores or rule-breaking.
  • ๐Ÿ† Achievements: Lists completed and in-progress achievement goals, including total points earned from each.
  • ๐Ÿ”ฅ Challenges: Provides detailed tracking of current challenges, progress percentages, and remaining goals.
  • ๐Ÿ’Ž Point Multipliers: Highlights how badges increase points earned for completing chores.

The Kids Showcase offers a fun and motivational way for kids to see their hard work pay off, track their goals, and stay excited about their progress. ๐Ÿš€


๐Ÿ“Œ Example Kids Showcase Dashboard UI:


๐Ÿ… Badge Cards: Track & Celebrate Progress

The Badge Cards provide a visual way to track earned badges, upcoming milestones, and point multipliers. These cards make it easy for kids to see their progress and stay motivated.

๐Ÿ“Œ What Badge Cards Show:

โœ… Earned Badges โ€“ Displays all badges the child has unlocked.
โœ… Next Badge Progress โ€“ Shows how many more points or completed chores are needed for the next badge.
โœ… Point Multipliers โ€“ Indicates if a badge boosts future points for completing chores.


๐Ÿ† Achievements & Challenges: Long-Term Goals

The Achievements & Challenges Cards provide a structured way to set long-term goals beyond daily chores. These cards help reinforce positive habits, encourage consistency, and introduce friendly competition.

๐Ÿ“Œ What These Cards Show:

โœ… Achievements โ€“ Earned when kids reach specific milestones (e.g., 100 chores completed).
โœ… Challenges โ€“ Time-based tasks that must be completed within a set period (e.g., 50 chores in one month).
โœ… Progress Tracking โ€“ Real-time updates on achievement completion and challenge goals.




๐Ÿ‘ฉโ€๐Ÿ‘ฆ Parent Chore Dashboard

๐Ÿ  Overview

The Parent Dashboard is a fully automated control panel for managing chore approvals, point adjustments, and penalties. It is designed to minimize space by dynamically showing sections only when actions are neededโ€”such as pending approvals or overdue chore resets. Built on the KidsChores Integration, it offers intuitive, space-efficient cards for full parental control.

๐Ÿ“Œ Smart Display: Sections like approvals and overdue chore resets only appear when required.
๐Ÿ’ฅ Quick Actions: All actions use โ€œSingle click to applyโ€ for quick and easy interactions.
๐Ÿ“Š Full Visibility: Activity logs provide a complete history of points and approvals.


๐Ÿ”น Features Overview

  • โœ… Parent Dashboard Overview Card โ€” Displays key stats such as points, progress, and penalties.
  • โœ… Approve or deny chores and rewards with a simple hold action.
  • โœ… Reset overdue chores individually or all at once.
  • โœ… Adjust individual chore due dates quickly.
  • โœ… Manage points, bonuses, and penalties under โ€œPluses & Minuses.โ€
  • โœ… Monitor all activity with a 7-day activity log.

๐Ÿ“Œ Example Parents Dashboard UI:


๐Ÿ“Œ Parent Dashboard Sections

1๏ธโƒฃ Parent Dashboard Overview Card

The Parent Dashboard Overview Card provides a quick snapshot of the child's progress and current status:

  • ๐Ÿ“Š Current Points Total with point label and icon.
  • ๐Ÿ“… Chores Completed: Today, This Week, and This Month.
  • ๐Ÿšจ Number of Overdue Chores, if any.

2๏ธโƒฃ Approvals Section

  • Appears only when approvals are pendingโ€”fully hidden otherwise.
  • Allows parents to approve or deny:
    • ๐Ÿ“ Pending Chores
    • ๐ŸŽ Pending Rewards
  • Displays important details like points earned and completion status.


3๏ธโƒฃ Overdue Chores Management

  • Appears only when chores are overdue.
  • Provides two options:
    • ๐Ÿ›‘ Reset All Overdue Chores for the child.
    • ๐Ÿ“Œ Reset Individual Chores with due date and status shown.


5๏ธโƒฃ Chore Due Date Adjustments

  • Displays a chore selector to quickly find and update due dates.

  • Provides options for adjusting due dates:

    • ๐Ÿ“… +Next Due
    • ๐Ÿ“… +1 Day
    • ๐Ÿ“… +1 Week
    • โŒ Clear Date
    • ๐Ÿ“† Set Custom Date and Time with a date picker.
  • Before selecting a chore:

  • Options appear after chore is selected:


4๏ธโƒฃ Pluses & Minuses

The Pluses & Minuses section combines Bonuses, Manual Points Adjustments, and Penalties, providing an all-in-one interface for point management.

โž• Manual Points Adjustment

  • Displays easy-access buttons to:
    • โž• Add points (e.g., for extra chores or positive behavior).
    • โž– Remove points (e.g., corrections or adjustments).
  • Shows the child's current point total and updates immediately.

โญ Bonus Management

  • Allows parents to apply custom bonuses as extra rewards.
  • Each bonus button shows:
    • โญ Bonus name & point value
    • ๐Ÿ“Š Times the bonus has been applied
  • Applied bonuses are reflected in the Showcase Overview and Point Totals.

๐Ÿ’ฅ Penalties Management

  • Displays penalty options to deduct points for missed chores or behavior issues.
  • Each penalty button shows:
    • ๐Ÿ’ฅ Points deducted
    • ๐Ÿ“Š Times penalty was applied
  • Applied penalties are reflected in the Showcase Overview and Point Totals.

6๏ธโƒฃ Activity Log (7-Day History)

  • Logs all chore-related activity, including:
    • ๐Ÿ“ Chore claims
    • โœ… Chore and reward approvals
    • ๐Ÿ’ฅ Penalties applied
    • ๐Ÿ’ฐ Reward redemptions
  • Provides a clear timeline of events for easy tracking.

The Parent Chore Dashboard is designed to be efficient and intuitive, showing only necessary options and grouping key actions under โ€œPluses & Minusesโ€ for simplicity. All functionality is powered by the KidsChores Integration, ensuring automatic updates and zero manual setup. ๐Ÿš€


๐Ÿ”ง How to Implement This Dashboard

Follow these steps to quickly set up the KidsChores Dashboard in Home Assistant, including both the Kids and Parent sections.

This approach creates a complete dashboard in one step. Once itโ€™s set up, you can:

  • ๐Ÿ“Œ Move individual cards to different positions or dashboards.
  • ๐Ÿ› ๏ธ Customize the layout to suit your needs.
  • ๐Ÿ“ Extract specific sections from the dashboard YAML if you prefer to use them individually or in other dashboards.

If youโ€™re comfortable working with YAML, you can review the dashboard code to select and reuse any individual cards or sections that fit your needs.

๐Ÿ“Œ Step 1: Install Custom Cards

This dashboard requires custom frontend cards to function correctly.

  1. Open Home Assistant
  2. Go to HACS โ†’ Frontend
  3. Search and install the following cards:
    • ๐ŸŸข Mushroom Cards (custom:mushroom-template-card)
    • ๐ŸŸข Auto-Entities (custom:auto-entities)
    • ๐ŸŸข Mini Graph Card (custom:mini-graph-card)
  4. Restart Home Assistant to apply the changes.

๐Ÿ“Œ Step 2: Create a New Section Dashboard

To keep the dashboard organized, create a separate section for chore tracking. You can skip this step if you have an existing location you want to use.

  1. Go to Home Assistant โ†’ Settings โ†’ Dashboards
  2. Click "Create Dashboard"
  3. Enter a name (e.g., "Kids Chores")
  4. Click "Save"

๐Ÿ“Œ Step 3: Add the Dashboard YAML

  1. Open your new dashboard.
  2. Click "Edit Dashboard" โ†’ "Manage Dashboard"
  3. Click the "Edit Pencil" next to the view name and select "Edit YAML"
  4. Copy and paste the correct Kids Chores Dashboard YAML file into the view.

๐ŸŒ Selecting dashboard with the correct language

The dashboard files are available in multiple languages. Choose the correct file based on the 2-letter ISO language code at the end of the filename:

Language File Name
๐Ÿ‡ฉ๐Ÿ‡ฐ Danish kc_dashboard_da.yaml
๐Ÿ‡ฉ๐Ÿ‡ช German kc_dashboard_de.yaml
๐Ÿ‡ฌ๐Ÿ‡ง English kc_dashboard_en.yaml
๐Ÿ‡ซ๐Ÿ‡ฎ Finnish kc_dashboard_fi.yaml
๐Ÿ‡ณ๐Ÿ‡ฑ Dutch kc_dashboard_nl.yaml
๐Ÿ‡ซ๐Ÿ‡ท French kc_dashboard_fr.yaml

๐Ÿ“Œ Find the latest files here:
๐Ÿ”— KidsChores Dashboard YAML Files

๐Ÿ“Œ Step 4: Find and Replace "Kidname"

Since this YAML uses a placeholder name, update it to match your child's name.

  1. Find and replace all instances of:
    • Kidname โ†’ (e.g., "Payton")
  2. After you paste the YAML file in, Press <CTRL> F to bring up Find/Replace
  3. Ensure case-sensitive replacement to avoid errors.
  4. Click "Save" to apply changes.

Note - No longer required to change the "points" text, the new dashboard dynamically grabs the point label from the integration.


๐Ÿ“Œ Step 5: Add Required Helpers (UI Support)

Currently, the KidsChores Dashboard requires a single datetime helper to support interactive features in the UI.

You will need to add:

  • ๐Ÿ—“๏ธ input_datetime.kc_ui_set_date_helper โ€” For setting custom due dates from the dashboard. The name of the entity is critical, so enter it carefully. To add a helper, go to Settings \ Devices & Services \ Helpers then select "+ CREATE HELPER" and choose "Date and/or time"

An optional automation can be added to continuously set the date of the date of that helper to tomorrow at 11PM. Without this automation, the datetime will remain at whatever was last selected, which is not an issue.

  • โš™๏ธ Automation: kc_ui_set_date_on_hold โ€” .

๐Ÿ“„ kc-dashboard-uihelpers.yaml


๐ŸŽฏ Finalizing the Dashboard

  • ๐Ÿš€ Exit edit mode and test the new chore tracking system!
  • โœ… Ensure buttons update chore statuses correctly.
  • ๐Ÿ›  If any entities are missing, check sensor and button names in Developer Tools โ†’ States.

Your Kids Chore & Reward Dashboard is now fully functional in Home Assistant! ๐ŸŽ‰

If you haven't already done so, take a few minutes to look through the KidsChores integration Wiki which is loaded with helpful information as you get started. ๐Ÿ‘‰ Integration Wiki


๐ŸŽจ Want Even More Customization?

The KidsChores Dashboard is designed to be fully dynamic, offering a rich feature set that works right out of the box. For most users, the default layout will be more than enough, but if you want to tailor it further, anythings possible:

โœ… Move Cards to Other Dashboard Pages โ€“ Reorganize components to fit your layout preferences.
โœ… Remove Cards You Donโ€™t Need โ€“ Keep only whatโ€™s relevant to your family.
โœ… Use Built-in Card Logic โ€“ Customize individual elements while leveraging existing automation.

The flexibility is built-in, allowing you to make it as custom as you want without breaking core functionality! ๐Ÿš€


๐Ÿ–ฅ๏ธ Built-in Easily Adjust Column Width for Chores, Rewards, and Approvals

The column layout for chores, rewards, and approvals can now be adjusted in the preferences, allowing for a customizable display. Whether you're using a phone, tablet, or larger screen, you can configure it to show a single column for compact views or multiple columns for a broader layout.

๐Ÿ“Œ Note: Column width settings may require adjustments to UI layout settings to ensure proper display on wider screens.


โš™๏ธ Built-in Configuration Options (pref_)

Easily customize how chores, rewards, and approvals are displayed by changing preference settings in the dashboard YAML.

Chore Card

  • pref_column_count โ†’ Adjusts the number of columns.
  • pref_use_today_grouping โ†’ Groups chores by due morning & due today.
  • pref_use_overdue_grouping โ†’ Groups overdue chores separately.
  • pref_exclude_approved โ†’ Excludes approved chores from showing.
  • pref_use_label_grouping โ†’ Groups chores by category.
  • pref_exclude_label_list โ†’ Allows excluding specific chore categories.

Reward Card

  • pref_column_count โ†’ Adjusts the number of columns.
  • pref_use_label_grouping โ†’ Groups rewards by category.
  • pref_exclude_label_list โ†’ Allows excluding specific reward categories.

Approval Card

  • pref_column_count โ†’ Adjusts the number of columns.

Showcase Card

  • pref_show_penalties โ†’ Toggles penalty visibility.


๐Ÿšจ Known Issues & Workarounds

๐Ÿ”น Renaming Chores and Rewards

While renaming chores and rewards works correctly within the KidsChores integration, it does not update the entity names, which the dashboard relies on to match the friendly_name.

Recommended Workaround:

โœ” Best Option: Delete the chore or reward and recreate it with the new name.

โœ” Manual Fix: If you prefer to keep the existing entity, you can manually rename all associated button and sensor entities to match the new friendly name.

  • However, you must account for Home Assistant's special character handling.
  • Accent characters are automatically normalized (e.g., "ล tฤ›pรกn" โ†’ "stepan").
  • Spaces and special characters are replaced with underscores (_).
  • Duplicate and trailing underscores are removed.
  • Example:
    • "Brush Teeth (Morning)" becomes "_brush_teeth_morning".
    • "ล imonโ€™s Dishes!" becomes "_simons_dishes".

If you experience issues after renaming a chore or reward, verify that the entity names match the expected format based on Home Assistantโ€™s naming conventions.


๐ŸŒ How to Contribute Translations

Want to help expand KidsChores to more languages? Follow these steps to submit a new translation:

1๏ธโƒฃ Only Modify the Translated Section & Update Headings Where Needed

  • Get a copy of the "Translation-friendly" dashboard from kc_dashboard_en.yaml.
  • The translatable text is stored in a dedicated section within the dashboard configuration.
  • Additionally, update any heading values in the heading cards that are currently displayed in English.
  • โš ๏ธ Do not modify any logic, formatting, or structureโ€”only update the text values inside the designated translation section.

2๏ธโƒฃ Complete All Translatable Text Entries

  • Ensure that all translation text variables have been updated with the correct translations.
  • Search through the full dashboard to find all the translation sections.
  • Leave formatting, icons, and any surrounding Markdown or HTML unchanged.

3๏ธโƒฃ Submit a Pull Request

  • Once all translation sections have been updated, save your file as:
    kc_dashboard_xx.yaml (where xx is the two-letter ISO 639-1 language code).

โœ… Example Language Codes:

  • ๐Ÿ‡ฌ๐Ÿ‡ง en โ†’ English

  • ๐Ÿ‡ฉ๐Ÿ‡ช de โ†’ German

  • ๐Ÿ‡ซ๐Ÿ‡ท fr โ†’ French

  • ๐Ÿ‡ช๐Ÿ‡ธ es โ†’ Spanish

  • ๐Ÿ‡ต๐Ÿ‡น pt โ†’ Portuguese

  • ๐Ÿ‡ฎ๐Ÿ‡น it โ†’ Italian

  • ๐Ÿ‡ณ๐Ÿ‡ฑ nl โ†’ Dutch

  • Test the dashboard to ensure everything looks and functions as expected.

  • Submit a pull request to add the translated file to the translations folder in the repository on GitHub.


๐Ÿ“Œ Example Translatable Section

Below is an example of a small translatable section using the new structure:

{#-- ************* Set Translatable Text ************* --#}  

{%- set ns.PARENT_DASHBOARD_LABEL = "Parent Dashboard for" -%}  
{%- set ns.CHORES_COMPLETED_LABEL = "Chores Completed" -%}  
{%- set ns.TODAY_LABEL = "Today" -%}  
{%- set ns.WEEK_LABEL = "Week" -%}  
{%- set ns.MONTH_LABEL = "Month" -%}  
{%- set ns.OVERDUE_CHORES_LABEL = "Overdue Chores" -%}  
{%- set ns.REWARDS_LABEL = "Rewards" -%}  
{%- set ns.PENALTIES_APPLIED_LABEL = "Penalties Applied" -%}  
{%- set ns.TOTAL_PENALTY_LABEL = "Total Penalty" -%}  
{%- set ns.NONE_LABEL = "None" -%}  

{#-- ************* End Translatable Text ************* --#}

๐Ÿ“Œ Need help? Log and issue here or visit the thread on the Home Assistant Forum Introducing the KidsChores and Rewards Dashboard ! ๐Ÿš€

About

Kids Chores is a custom integration for Home Assistant. This is a dynamic dashboard that can provide a simple full featured interface into the capabilities of that integration without building individual chores and dashboards.

Resources

License

Stars

Watchers

Forks

Packages

No packages published