-
Notifications
You must be signed in to change notification settings - Fork 0
Sensor Reference
TaskMate creates the following entities in Home Assistant.
The main data sensor. All 13 Lovelace cards read from this entity.
| Property | Value |
|---|---|
| State | Number of children |
| State class | measurement |
| Icon | mdi:home-heart |
| Attribute | Type | Description |
|---|---|---|
total_children |
int | Number of children |
total_points |
int | Sum of all children's current points |
total_chores_completed |
int | Sum of all-time chore completions across all children |
pending_approvals |
int | Total pending items (chore completions + reward claims) |
points_name |
string | Currency name (e.g. "Stars") |
points_icon |
string | Currency MDI icon (e.g. "mdi:star") |
today_day_of_week |
string | Current day in HA timezone (e.g. "monday") |
weekend_multiplier |
float | Current weekend multiplier setting |
streak_reset_mode |
string | "reset" or "pause" |
streak_milestones_enabled |
bool | Whether streak milestone bonuses are on |
streak_milestones |
string | Current milestone configuration string |
perfect_week_enabled |
bool | Whether perfect week bonus is on |
perfect_week_bonus |
int | Perfect week bonus points value |
Each entry in the children array:
| Field | Type | Description |
|---|---|---|
id |
string | Child's unique ID |
name |
string | Child's display name |
avatar |
string | MDI icon |
points |
int | Current spendable points balance |
total_points_earned |
int | All-time points earned |
total_chores_completed |
int | All-time completions |
current_streak |
int | Current consecutive day streak |
best_streak |
int | Best streak ever |
pending_points |
int | Points held by pending approvals |
committed_points |
int | Points reserved by pending reward claims |
chore_order |
list | Custom chore display order |
last_completion_date |
string | ISO date of last completion |
streak_paused |
bool | Whether streak is paused |
streak_milestones_achieved |
list | Milestone day counts already awarded this streak |
awarded_perfect_weeks |
list | Monday ISO dates of awarded perfect weeks |
Each entry in the chores array:
| Field | Type | Description |
|---|---|---|
id |
string | Chore's unique ID |
name |
string | Display name |
description |
string | Optional description |
points |
int | Points awarded on completion |
time_category |
string | morning / afternoon / evening / night / anytime |
daily_limit |
int | Max completions per day |
assigned_to |
list | List of child IDs (empty = all children) |
completion_sound |
string | Sound name |
due_days |
list | Scheduled days (empty = any day) |
requires_approval |
bool | Whether parent approval is needed |
Each entry in the rewards array:
| Field | Type | Description |
|---|---|---|
id |
string | Reward's unique ID |
name |
string | Display name |
description |
string | Optional description |
cost |
int | Fixed point cost set by the parent |
icon |
string | MDI icon |
assigned_to |
list | Child IDs (empty = all children) |
is_jackpot |
bool | Whether this is a pooled jackpot reward |
calculated_costs |
dict | Per-child dynamic cost {child_id: cost} |
child_daily_points |
dict | Per-child expected daily points (jackpot meters) |
Completions from today (both approved and pending):
| Field | Type | Description |
|---|---|---|
completion_id |
string | Unique completion ID |
chore_id |
string | Chore ID |
child_id |
string | Child ID |
child_name |
string | Child display name |
chore_name |
string | Chore display name |
points |
int | Points value |
approved |
bool | Whether approved |
completed_at |
string | ISO datetime |
Up to 200 most recent completions across all time.
Same fields as todays_completions.
Unapproved chore completions waiting for parent action:
| Field | Type | Description |
|---|---|---|
completion_id |
string | Unique completion ID |
chore_id |
string | Chore ID |
child_id |
string | Child ID |
child_name |
string | Child display name |
chore_name |
string | Chore display name |
points |
int | Points value |
time_category |
string | Time of day |
completed_at |
string | ISO datetime |
Unapproved reward claims waiting for parent action:
| Field | Type | Description |
|---|---|---|
claim_id |
string | Unique claim ID |
reward_id |
string | Reward ID |
child_id |
string | Child ID |
child_name |
string | Child display name |
reward_name |
string | Reward display name |
cost |
int | Points cost at time of claim |
claimed_at |
string | ISO datetime |
Up to 200 most recent points transactions (manual add/remove + bonus events):
| Field | Type | Description |
|---|---|---|
id |
string | Transaction ID |
child_id |
string | Child ID |
points |
int | Points value (positive = add, negative = remove) |
reason |
string | Reason description |
created_at |
string | ISO datetime |
Numeric count of total pending items.
| Property | Value |
|---|---|
| State | Integer — total pending items |
| State class | measurement |
| Icon | mdi:clipboard-clock |
| Attribute | Type | Description |
|---|---|---|
pending_chore_completions |
int | Count of chores awaiting approval |
pending_reward_claims |
int | Count of reward claims awaiting approval |
chore_completions |
list | Full details of pending chore completions |
reward_claims |
list | Full details of pending reward claims |
chore_completions entries:
| Field | Description |
|---|---|
completion_id |
Completion ID (use with approve_chore / reject_chore) |
type |
Always "chore"
|
child_name |
Child display name |
child_id |
Child ID |
chore_name |
Chore display name |
chore_id |
Chore ID |
points |
Points value |
time_category |
Time of day |
completed_at |
ISO datetime |
reward_claims entries:
| Field | Description |
|---|---|
claim_id |
Claim ID (use with approve_reward / reject_reward) |
type |
Always "reward"
|
child_name |
Child display name |
child_id |
Child ID |
reward_name |
Reward display name |
reward_id |
Reward ID |
cost |
Points cost |
claimed_at |
ISO datetime |
Simple on/off sensor for use in automations and notifications.
| Property | Value |
|---|---|
on |
There are pending chore completions or reward claims |
off |
Nothing pending |
| Icon (on) | mdi:bell-alert |
| Icon (off) | mdi:bell-check |
| Device class | None |
| Attribute | Type | Description |
|---|---|---|
pending_chore_completions |
int | Count of chores pending |
pending_reward_claims |
int | Count of reward claims pending |
total_pending |
int | Combined total |
One button entity per child/chore combination and per child/reward combination:
| Entity | Action |
|---|---|
button.{child}_complete_{chore} |
Complete the chore for the child |
button.{child}_claim_{reward} |
Claim the reward for the child |
The reward claim button is only available (not greyed out) when the child has enough points.
The coordinator polls every 30 seconds. All entities update together. Completions, approvals, and point changes trigger an immediate refresh.