> Blinds, heat pumps, radiators, cameras and energy on one page, on a server you run. A few integrations done properly instead of thousands done loosely.
> Source: https://orochibraru.com/localassistant/docs · Site index: https://orochibraru.com/llms.txt

# LocalAssistant documentation

Blinds, heat pumps, radiators, cameras and energy on one page, on a server you run. A few integrations done properly instead of thousands done loosely.

The Markdown in [the project repo](https://github.com/orochibraru/localassistant/tree/v1.0.6/docs) is the source of truth;
these pages are generated from it.

- [LocalAssistant](https://orochibraru.com/localassistant/docs/readme.md): Your blinds, heat pumps, radiators, cameras and energy on one page, on a server you run. A small, self-hosted alternative to Home Assistant that installs on…
- [Contributing](https://orochibraru.com/localassistant/docs/contributing.md): The long-form documentation lives in docs/. This file is the short version: what you need to get a change landed.
- [Introduction](https://orochibraru.com/localassistant/docs/introduction.md): LocalAssistant controls a household's blinds and heat pumps from one page, on a server you run. It does a few integrations properly instead of thousands…
- [Install](https://orochibraru.com/localassistant/docs/install.md): LocalAssistant is one container. Its /data volume holds the SQLite database: accounts, devices, their encrypted keys and installed plugins. Back it up with…
- [Configuration](https://orochibraru.com/localassistant/docs/configuration.md): Environment variables cover what the server needs at boot. Everything else (devices, invites, sign-in methods, email) is set in the app's admin area.
- [First run](https://orochibraru.com/localassistant/docs/first-run.md): A fresh instance sends every page to the setup screen. It asks for a six-digit code only the server's log shows, valid 15 minutes:
- [Health and updates](https://orochibraru.com/localassistant/docs/maintenance.md): Back up LocalAssistant from the server, not the app: the /data volume holds everything (the SQLite database, installed integrations and camera recordings)…
- [Integrations](https://orochibraru.com/localassistant/docs/integrations.md): Every kind of device LocalAssistant talks to comes from an integration: a small plugin hosted on GitHub, GitLab, Gitea or Forgejo, or kept in a folder. The…
- [Tuya blinds](https://orochibraru.com/localassistant/docs/tuya-blinds.md): LocalAssistant talks to each blind directly on your network with the Tuya local protocol, encrypted with the blind's own local key. The Tuya cloud is only…
- [Mitsubishi heat pumps](https://orochibraru.com/localassistant/docs/mitsubishi.md): Mitsubishi Electric units with a Wi-Fi adapter (MAC-567IF and friends) are driven through MELCloud, with the account the MELCloud app uses. The password is…
- [Bambu Lab printers](https://orochibraru.com/localassistant/docs/bambu.md): LocalAssistant talks to a Bambu Lab printer (P1P, P1S and the other models with the same LAN protocol) over its local MQTT broker, with the printer's access…
- [Zigbee and Shelly](https://orochibraru.com/localassistant/docs/zigbee.md): Door and window sensors, radiator valves, relays, metering plugs and the ZLinky reader come in through Zigbee2MQTT, and Shelly meters through the same MQTT…
- [Cameras](https://orochibraru.com/localassistant/docs/cameras.md): Any camera with a local RTSP stream: a Tapo with a camera account set in its app, a Reolink, most ONVIF cameras. Devices, Add a device, Cameras (RTSP), Add the…
- [More devices](https://orochibraru.com/localassistant/docs/more-devices.md): Devices, Add a device, Dreame robot vacuums, sign in with the Dreamehome app's email, password and region. The robots on the account come in with their state…
- [AI apps](https://orochibraru.com/localassistant/docs/ai-apps.md): Claude, ChatGPT and Gemini can see your house and drive its devices through LocalAssistant's MCP server at /mcp. Each person connects their own app; it acts as…
- [Mobile app](https://orochibraru.com/localassistant/docs/mobile-app.md): LocalAssistant has a native app for Android and iPhone, built with Kotlin Multiplatform. It shows the house, drives devices, watches cameras, makes and sets…
- [Weather](https://orochibraru.com/localassistant/docs/weather.md): Home opens on the time and the weather: the temperature, what it feels like, today's low and high, sunrise and sunset. The weather comes from Open-Meteo, free…
- [Routines](https://orochibraru.com/localassistant/docs/automations.md): The server runs every routine, whether or not anyone has the app open: the worker checks the clock-driven ones once a minute, and device routines the moment a…
- [Notifications](https://orochibraru.com/localassistant/docs/notifications.md): LocalAssistant sends push notifications to the phones, tablets and computers each person turned them on for: Account, Notifications, Turn on for this device. On…
- [Dashboards](https://orochibraru.com/localassistant/docs/dashboards.md): A dashboard is a page of your own: the devices, scenes and graphs you use together, in the order you want. Only you see yours; everyone makes their own.
- [History and logbook](https://orochibraru.com/localassistant/docs/history.md): The worker keeps 30 days of what the devices did, without anyone having the app open.
- [Energy](https://orochibraru.com/localassistant/docs/energy.md): Energy charts what the house and each appliance used, per day over the last 30 days and per month over the last 12. The worker snapshots every meter's counter…
- [Wall panel](https://orochibraru.com/localassistant/docs/wall-panel.md): A screen for a tablet on the wall or a Shelly Wall Display: the clock, the weather, the doors and windows left open, big open and close buttons for each room's…
- [Development](https://orochibraru.com/localassistant/docs/development.md): The dev server migrates ./data/localassistant.sqlite and starts the worker under watch. Delete the file to start over; the setup code is in the dev server's…
- [Writing an integration](https://orochibraru.com/localassistant/docs/plugins.md): An integration is a GitHub repository (or a folder in one) with a localassistant-plugin.json manifest and the code it names. LocalAssistant builds the setup…