Advanced: Dashboard - ad-ha/kidschores-ha GitHub Wiki
Target Audience: Users wanting auto-populating dashboards Prerequisites: KidsChores integration installed and configured Related: Quick Start Guide
KidsChores supports companion dashboard system that automatically populates with your chores, rewards, badges, and kid profiles. No manual card configuration neededโthe dashboard reads from your entities and displays everything in an organized, mobile-friendly interface.
Why a separate repository?
- Dashboard is optional (KidsChores works without it)
- Different update cycle (dashboard UI vs integration logic)
- Easier customization for advanced users
- Keeps integration lightweight
Every kid gets a Dashboard Helper Sensor that powers the auto-populating UI:
sensor.kc_<kid>_ui_dashboard_helperThe dashboard helper pre-processes data for efficient template rendering:
Pre-Sorted Lists:
-
chores- All chores sorted by status and due date -
rewards- Available rewards sorted by cost -
badges- Badge progress and maintenance status -
bonuses- Recent bonus point adjustments -
penalties- Recent penalty adjustments -
achievements- Achievement progress (legacy) -
challenges- Active challenges (legacy)
Aggregated Metrics:
- Badge maintenance countdown
- Achievement progress percentages
- Reward claim counts
- Point statistics
Localized Strings:
-
ui_translations- All UI labels in user's language - Eliminates need for language-specific YAML variants
{% set dashboard_helper = 'sensor.sarah_kidschores_ui_dashboard_helper' %}
{% set ui = state_attr(dashboard_helper, 'ui_translations') or {} %}
{% set chore_list = state_attr(dashboard_helper, 'chores') | default([], true) %}
# Pre-sorted by backend - just iterate
{% for chore in chore_list %}
{{ chore.name }}: {{ chore.status }}
{% endfor %}Performance benefit: Backend does expensive sorting/filtering once; frontend just renders.
Dashboard Repository: kidschores-ha-dashboard
-
Download Dashboard YAML:
- Visit the dashboard repository
- Download
kc_dashboard_all.yaml
-
Create Dashboard in Home Assistant:
- Navigate to Settings โ Dashboards
- Click + Add Dashboard
- Choose New dashboard from scratch
- Enter name: "KidsChores - [Kid Name]"
-
Paste YAML Content:
- Open dashboard
- Click โฎ (three dots) โ Edit Dashboard
- Click โฎ again โ Raw configuration editor
- Paste content from
kc_dashboard_all.yaml - Replace
Kidnamewith your kid's actual name (case-sensitive) - Save
-
Verify:
- Dashboard should populate with all chores, rewards, badges
- Check that sensors exist:
sensor.kc_<kid>_ui_dashboard_helper
Create one dashboard per kid:
- Duplicate YAML file
- Change all instances of kid name
- Create separate dashboard for each child
Chore Cards:
- Today's chores (AM/PM groups)
- This week's chores
- Overdue chores
- Pending approvals (parent view)
Reward Showcase:
- Available rewards sorted by cost
- Claim buttons
- Point balance display
Badge Display:
- Progress bars for active badges
- Maintenance countdown
- Badge history
Stats & Metrics:
- Points earned (today, week, month, all-time)
- Chore completion streaks
- Approval rates
Dashboard is designed for:
- โ Phone screens (primary use case)
- โ Tablets
- โ Smartwatches (action buttons work on watches)
User Preferences (in YAML):
-
pref_column_count- Number of columns -
pref_use_overdue- Show/hide overdue section -
pref_use_labels- Filter by specific labels
Colors:
-
green= approved -
orange= claimed/pending -
red= overdue -
blue= multi-approved (shared chores) -
purple= partial approval
All KidsChores entities follow this pattern:
<platform>.kc_<kid_slug>_<purpose>
Example (kid named "Sarah"):
sensor.sarah_kidschores_points # Total points
sensor.sarah_kidschores_ui_dashboard_helper # Dashboard data
button.kc_sarah_feed_dog_claim # Claim button
button.kc_sarah_feed_dog_approve # Approve button
sensor.kc_sarah_feed_dog # Chore statusButton Entities:
-
button.kc_<kid>_<chore>_claim- Kid presses to claim -
button.kc_<kid>_<chore>_approve- Parent presses to approve
Sensor Entities:
-
sensor.kc_<kid>_points- Point balance -
sensor.kc_<kid>_<chore>- Individual chore status/attributes -
sensor.kc_<kid>_ui_dashboard_helper- Pre-processed dashboard data
Actions Triggered:
- Press claim/approve buttons directly from dashboard
- No need for automation or script layers
- Instant feedback (entity state updates)
Edit YAML to add custom groupings:
# Add morning routine group
- type: heading
heading: "๐
Morning Routine"
- type: custom:auto-entities
filter:
include:
- entity_id: sensor.kc_sarah_*
attributes:
labels: morningShow sections based on conditions:
# Only show rewards if kid has points
card_mod:
style: |
{% if states('sensor.sarah_kidschores_points')|int > 0 %}
ha-card { display: block; }
{% else %}
ha-card { display: none; }
{% endif %}Focus on specific chore types:
# Show only pet care chores
pref_label_filter: "pets"Cause: Dashboard helper sensor not found or missing attributes
Fix:
- Verify sensor exists:
sensor.kc_<kid>_ui_dashboard_helper - Check entity state in Developer Tools โ States
- Verify
ui_translationsattribute is populated - Reload integration if needed
Cause: Entity naming mismatch
Fix:
- Check kid name slug: Developer Tools โ States โ search
kc_<name> - Home Assistant slugifies names (removes accents, lowercases, replaces spaces)
- Update YAML to match exact slug
Cause: Button entities don't exist or wrong entity IDs
Fix:
- Verify button entities exist:
button.kc_<kid>_<chore>_claim - Check Developer Tools โ States for exact entity IDs
- Update dashboard YAML with correct entity IDs
Dashboard Repository (Recommended):
- โ Pre-built, tested layouts
- โ Auto-populating (no manual config)
- โ Mobile-optimized
- โ Regular updates from community
Custom Cards (DIY):
- โ Full control over layout
- โ Integrate with other dashboards
- โ More complex setup
- โ Manual entity configuration
Both approaches workโchoose based on your comfort level with YAML and dashboard design.
- Quick Start Guide - Basic entity overview
- Technical Reference: Entities & States - Complete entity documentation
- Services Reference - Service calls from dashboard buttons
Full documentation, examples, and updates: ๐ kidschores-ha-dashboard GitHub Repository
Includes:
- Complete dashboard YAML files
- Customization examples
- Troubleshooting guides
- Community contributions
- Update changelogs
Last Updated: v0.5.0 (January 2026)