Getting started
Install the hub with one command, set up your home in the browser wizard and open the web UI.
Install on Linux (Docker)
Install Oikos-os on a Linux host from a git clone with one Docker Compose command, then set it up in the browser, upgrade and run it.
Move an existing broker and database into the stack
Replace a hand-run Mosquitto and TimescaleDB with the ones in Oikos-os's compose stack, keeping their data, with a backup and a rollback.
Zigbee2MQTT
Point Zigbee2MQTT's Home Assistant discovery at the hub and publish the devices it does not cover.
The web UI
The screens of the browser app the hub serves, from dashboards and energy to security, devices, settings, alerts and flows.
Flows (automations)
Automations as small graphs of triggers, checks, waits and actions, how a run walks the graph, and how to edit them in the web UI.
Groups and virtual entities
Control several devices as one with a group, and create switches, numbers, buttons and selects the hub owns for your flows.
Talking to the house (MCP)
Connect an AI assistant to the hub over MCP and ask it, in plain words, to inspect or change the house.
Push notifications
How the hub sends alerts to the Android app through Firebase Cloud Messaging, the topics it uses, its settings and how to switch over from OikosPush.
Cameras (Frigate)
Serve Frigate snapshots and clips to the browser through the hub, and turn Frigate detections into camera alerts.
Climate
How the climate engine decides each zone's heating or cooling, what it learns from history, and how eco, proposals, overrides and hand changes work.
History
Record every entity state change in TimescaleDB, connect it in the setup wizard or Settings, query it and back it up with pg_dump.
Watchdogs
Two opt-in watchdogs that raise system alerts when the encryption gateway changes state or the broker denies an MQTT action.
Security
What the hub does not protect in v1, what that means for your LAN and how to keep it off the internet.
Weather
Outdoor weather from Open-Meteo as entities and a REST document, how to turn it on, what each entity means, and how it behaves when the network is down.
Ambiances
One-tap house states made of actions, the four action types, how categories pick their devices, and how to read the report after a run.
Solar forecast
The Solcast solar forecast as entities and a REST document, how to get a key and a rooftop site, how to share an account, when the hub calls Solcast, and how the forecast behaves when it is stale or unreachable.
Alarm
The optional native alarm: modes, sensors, entry delays, open windows, sirens, remotes, presence, the push with Disarm, and moving off another controller.