> For the complete documentation index, see [llms.txt](https://docs.kinwall.family/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kinwall.family/integrations/home-assistant.md). # Home Assistant The [Home Assistant](https://www.home-assistant.io) integration and add-on live in their own repository: [JohnDuprey/kinwall-homeassistant](https://github.com/JohnDuprey/kinwall-homeassistant). Entities, services and install steps are documented there. ## What the integration gives you Install it from Home Assistant's Marketplace (**Settings → Marketplace → Add from link**, then `JohnDuprey/kinwall-homeassistant`; before Home Assistant 2026.11, through [HACS](https://hacs.xyz)), then add it under **Settings → Devices & Services** with your Kinwall URL and an admin API key. You get a device for each family member plus a **Family** device: * **Calendars**: one per member, plus a read-only family calendar. * **To-do lists**: each member's chores for today (tick one off to complete it), the **Anyone** chores, and every Kinwall list, so voice assistants and the to-do card work with your lists. * **Sensors**: points today, points this week and chores left today, per member. * **A binary sensor per chore**: on once it's done today. It also reports the chore's checklist progress, so an automation can wait for "the after-school checklist is done". * **Events**: every Kinwall webhook also fires as `kinwall_` on the Home Assistant event bus (for example `kinwall_chore_completed`). * **Actions**: `kinwall.import_recipe` and `kinwall.plan_meal` put recipes and meals on the meal plan from a script or automation. `kinwall.night_screen` starts or ends the [Night screen](/using-kinwall/night.md#start-it-from-home-assistant) on wall screens. They need the integration's key to be an admin key. * **Night screen switches**: one for **All wall screens** and one per paired display. They start the Night screen at any time, apart from the family's [night hours](/using-kinwall/night.md) (once called quiet hours), which still read as `quietFrom` / `quietTo` in the settings. There's a blueprint that starts the Night screen when nobody's home and wakes the walls when someone arrives. The integration registers a Kinwall webhook for itself, so changes show up in Home Assistant right away. It also polls `GET /api/rev` as a backstop (every 30 seconds by default). Its options include **Points for chores created from Home Assistant** (default 5): a chore added from a Home Assistant to-do list or automation gets that many points. This page covers the Kinwall side, for when you wire things up yourself. ## Running Kinwall inside Home Assistant See [Home Assistant add-on](/getting-started/home-assistant-add-on.md): ingress, the options that map to environment variables, and where data lives. ## Talking to Kinwall from Home Assistant The integration uses the same public interfaces anything else can use: * [**REST API**](/integrations/rest-api.md) with an API key. A **display** key is enough for reading the calendar and working with chores and lists. Use an **admin** key only if you need members or push messages (`POST /api/notify`, which needs **Family messages** on in [Settings → General → Features](/settings-reference/general.md#features)). * **`GET /api/rev`** for cheap polling. It changes on every write; its `revs` say whether lists, chores or events changed, so the integration refetches only that part. * [**Webhooks**](/integrations/webhooks.md) into a Home Assistant webhook trigger, for instant automations on `chore.completed`, `list.item.changed` and so on. Webhooks go to public addresses only, unless the server runs with `ALLOW_PRIVATE_WEBHOOK_URLS=1`. The add-on turns that on for you. If Kinwall runs elsewhere and Home Assistant is on your home network, set it yourself (see [Configuration](/self-hosting-reference/configuration.md)). Example ideas: * Mark "Feed the cat" done when a smart feeder runs: `POST /api/chores/{id}/complete`. * Flash a light when `chore.completed` fires for the last chore of the day. * Add "Dishwasher tablets" to the groceries when a sensor runs low: `POST /api/lists/{id}/items`. * Move a Nintendo Switch bedtime later for the day when a kid gets a "Nintendo Switch" [reward](/using-kinwall/rewards.md), and put it back at midnight. There's a ready-made blueprint for this in the [Home Assistant integration repo](https://github.com/JohnDuprey/kinwall-homeassistant#blueprints), triggered by `reward.redeemed` and `reward.approved`. ## Meal kits The **Meal kit deliveries** blueprint keeps each HelloFresh delivery on a Kinwall calendar as "📦 HelloFresh delivery" through `kinwall.sync_events`. Deliveries go on as [free](/using-kinwall/events.md#free-or-busy) by default (its **Show deliveries as free** input), so an all-day delivery window shows on the calendar without sitting in Now / Next as "Now" all day. `kinwall.sync_events` takes `busy: false` on any event for the same. Needs integration 1.7.0 or later. The integration repo has a **Weekly meal kit import** blueprint for HelloFresh, through the [HelloFresh integration](https://github.com/kedube/ha-hellofresh) for Home Assistant by Katherine Dubé. Once a week (Sunday 10:00 by default, or when you run it) it reads the next delivery, fetches each meal you picked with its ingredients scaled to your servings, and imports it with `kinwall.import_recipe`. The meals are planned as dinners from delivery day on, one a night, skipping nights that already have a dinner. Ingredients that come in the box stay off your grocery list; the pantry items you supply yourself go on it. Its **Add dinners to calendar** input takes a calendar ID (Settings → Calendars, tap the calendar) to put each planned meal on that calendar too; `kinwall.import_recipe` has the same as `plan_calendar_id`. See [Importing recipes](/using-kinwall/nooks/meals.md#importing-recipes) and the blueprint's [README section](https://github.com/JohnDuprey/kinwall-homeassistant#blueprints). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.kinwall.family/integrations/home-assistant.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.