Skip to main content

Dashboard card

Home Keeper supports a dashboard card, Home Keeper Tasks (custom:home-keeper-card), that lists tasks and completes them with a Done button. This is useful for a task list on a dashboard or a wall tablet. The card resource is registered automatically. To add the card, select Home Keeper Tasks in the dashboard Add card picker. The picker shows at most 3 tasks in its preview, so it opens fast in a home with many tasks. The card on your dashboard shows all its tasks.

From the card, a user can:

  • complete a task with Done
  • add a task with the + button in the header, with photos
  • open the cover photo of a task
  • open the document links that a task shows
  • read a task's note with the Note chip

Editing and deletion of a task are supported only in the panel.

The card editor has these options:

  • Filter by status, area, device, label, recurrence type, a "due within N days" window, or a saved Profile.
  • Sort and group the tasks, and limit the number of rows.
  • When the card uses a Profile, the Profile sets the status, areas, devices and labels of the tasks. Limit to labels also removes the tasks that do not match the labels you select.
  • Select what each row shows.
  • Hide card when empty removes the card from the dashboard when the filter matches no task. Without it the card shows "No tasks match this filter."

The Due soon filter shows the tasks that are due in the next 7 days. This includes a task that is due later today, the same as the Due soon filter in the panel.

The card shows a completion made in the panel or on another surface immediately. This applies to an admin user only, because Home Assistant does not send this event to a non-admin user. For a non-admin user, the card updates when a Home Keeper entity changes its state.

Home Keeper task card grouped into status sections

Choose what each row shows​

Each row shows the task name. Below the name, the row shows the schedule and the number of completions. Use these card editor options to control each row:

OptionDefaultShows
Show scheduleOnThe schedule, such as "Every month after completion"
Show completion countOnThe number of completions, such as "2 completions"
Show notesOffThe task note
Show area / deviceOnThe device chip, else the area chip
Show labelsOffThe label chips

A row shows 1 chip for the place. If the task has a device, the row shows the device chip. Else the row shows the area chip.

The device chip is a link. It opens the appliance page in Home Keeper if an appliance has the device. Else it opens the device page in Home Assistant. That page is only for an admin, so for other users that chip is not a link.

Home Keeper card rows with device chips and 1 area chip

In YAML, the keys are show_schedule, show_history_count, show_notes, show_area and show_labels. If you turn off both Show schedule and Show completion count, the row shows the chips directly below the name. The status chip still shows the due date.

Home Keeper task card with the schedule and completion count turned off

Start groups closed​

A card that groups its tasks shows every group open at first. On an overview dashboard, you can start the groups closed. The group header and its count stay in view. Select a header to open the group. Use these card options:

OptionDefaultEffect
Start groups closed (collapsed)OffEvery group starts closed.
Start these groups closed (collapsed_groups)NoneOnly the groups in the list start closed.
Start a group closed above (collapse_above)0 (off)A group that shows more tasks than this number starts closed.

If you set more than 1 option, a group starts closed when any option applies to it. The count for collapse_above is after the Max tasks shown limit. In collapsed_groups, write a status group as overdue, shopping, counted, today, soon, later, monitored, none or disabled. Write an area group or a device group as the area ID or the device ID. The name none is the group with no area or no device.

type: custom:home-keeper-card
group_by: status
collapsed_groups:
- overdue
- today

The options set only the first state. A group that you open or close keeps that state until you reload the page, unless you change a card option. Then the groups start over from the options. These options do nothing on a card without group_by.

Home Keeper task card with every status group closed

Home Keeper task card with every status group closed, at phone width

Task photos on the card​

A task with photos shows its cover at the start of its row. Select the cover to open the full image. In the New task form, select Add photo to add photos. Any user can do this, also a user who is not an admin.

Read a task's note from the card​

A task with a note shows a Note chip on its row. The chip has the same tinted, outlined style as a document link, because it does the same kind of thing.

Home Keeper task card row with a tinted Note chip beside the area and document chips

Select the chip to open the note in a dialog. The note is rendered as Markdown. The chip appears even when the Select what each row shows setting hides notes from the row, so the row stays short and the note stays one tap away.

The dialog is read-only. Edit a note in the panel task editor.

The note dialog open over the card, with the full note rendered as Markdown and a Close button

Show a task's appliance documents on the card​

A task that is attached to an appliance can show the appliance's documents on its row. This includes document links and uploaded files and metadata links. Nothing is shown by default.

  1. Open the task in the panel editor.
  2. In Links to show on card, select the documents. The field is shown only if the appliance has at least 1 document.

The card_links field of the home_keeper.add_task and home_keeper.update_task services sets the same list. Each selected document is shown as a chip on the task row and opens in a new tab. An uploaded file opens through a short-lived signed URL. If a document is renamed or removed on the appliance, the chip is updated or removed.

Home Keeper task card showing a row with "Owner's manual", "Reorder filter" and an "Installation guide (PDF)" file chip

Filter by label: one card per subject​

A card can be limited to tasks with a Home Assistant label. This is useful for one card per subject, such as the car or the dog. A task matches a label if the task has the label or if its attached device or area has the label.

  1. Open the task and select the labels in the Labels field. The home_keeper.add_task and home_keeper.update_task services also set labels.
  2. Optional. Apply the same labels to devices or appliances in Settings → Devices to include all their tasks.
  3. In the card editor, set Limit to labels. With more than 1 label, set the Any/All match mode.
  4. Optional. Enable Show labels to show each task's labels on its row.

Home Keeper card filtered to the "dog" label, showing label chips on each row