Getting Started

This guide walks you through setting up TaskMate for the first time after installation.

---

Step 1 — Add the Integration

1. Go to Settings → Devices & Services
2. Click + Add Integration
3. Search for TaskMate and select it
4. You will be asked to choose:
   • Points Currency Name — what you want to call the points (Stars, Coins, Bucks, Tokens, etc.)
   • Points Icon — the MDI icon used throughout the UI (default: mdi:star)
5. Click Submit

You can change the currency name and icon later in Settings.

---

Step 2 — Open the Configuration Menu

Click Configure on the TaskMate card in Settings → Devices & Services.

You will see the main menu:

Option	Purpose
Manage Children	Add, edit, or remove children
Manage Chores	Create and configure chores
Manage Rewards	Create rewards children can earn
Settings	Bonus points, streak mode, history, currency

---

Step 3 — Add Your Children

1. Click Manage Children → Add New Child
2. Enter the child's name
3. Choose an avatar icon (there are many fun options — animals, robots, characters)
4. Click Submit

Repeat for each child. Each child gets their own:

• Points balance
• Streak counter
• Chore completion history
• Custom chore order

---

Step 4 — Create Some Chores

1. Click Manage Chores → Add Single Chore (or Add Multiple Chores for bulk entry)
2. Fill in the fields:
   • Name — e.g. "Make Bed"
   • Points — how many points completing this chore earns
   • Time of Day — Morning, Afternoon, Evening, Night, or Anytime
   • Scheduling Mode — Specific Days (choose which days it appears) or Recurring (set a repeating interval)
   • Requires Approval — whether a parent must approve before points are awarded
3. Click Submit — if you selected a scheduling mode, a second page appears to configure the days or recurrence interval

Tip: Start with 3–5 chores. You can add more any time.

See Chores for a full explanation of every field.

---

Step 5 — Create a Reward

1. Click Manage Rewards → Add New Reward
2. Enter a name, description, and choose an icon
3. Set Points Cost — how many points the reward costs to claim
4. Optionally enable Is Jackpot to pool all assigned children's points together toward a shared goal
5. Click Submit

See Rewards for full details on jackpot rewards and the claim approval flow.

---

Step 6 — Add Cards to Your Dashboard

1. Edit your Lovelace dashboard
2. Click + Add Card
3. Search for "taskmate" — you'll see all 13 cards listed
4. Add the Child Card for your child's view — configure it with:
   • Entity: sensor.taskmate_overview
   • Child: select the child
5. Add the Parent Dashboard Card for the parent view

Tip: Create two separate dashboards — one for kids (Child Card + Rewards Card) and one for parents (Parent Dashboard Card).

See Dashboard Cards for full configuration options for all 13 cards.

---

Step 7 — Test It

1. Open the child card on your dashboard
2. Tap a chore to complete it
3. If the chore requires approval, go to the parent dashboard and approve it
4. Watch the points balance update

---

Finding IDs

Many card options and service calls require a child_id or reward_id. The easiest way to find these:

1. Go to Developer Tools → States
2. Find sensor.taskmate_overview
3. Expand the entity attributes
4. Look in the children array for id values
5. Look in the rewards array for reward IDs

IDs are 8-character alphanumeric strings, e.g. a8c8376a.

---

Recommended Dashboard Layout

Kids' Dashboard (Sections View)

Section	Cards
Chores	Child Card (Morning), Child Card (Afternoon), Child Card (Evening)
Rewards & Progress	Rewards Card, Streak Card

Parents' Dashboard (Sections View)

Section	Cards
At a Glance	Overview Card, Parent Dashboard Card
Points Management	Points Card, Approvals Card
History & Stats	Activity Card, Weekly Card, Leaderboard Card

Tip: Use Section view for both dashboards — it groups related cards visually and handles responsive layout automatically.