Skip to content

Install ​

Spatial Context installs as a custom integration, from HACS or by copying one folder from GitHub.

Requirements:

  • Home Assistant 2024.10 or newer.
  • Floors defined under Settings → Areas → Floors.
  • An administrator account. The panel and its commands are for administrators only, and other users do not see Spatial Context in the sidebar.

Each Connectivity Map layer and the Property map background have their own requirements. See Requirements by Feature.

Install with HACS ​

HACS is the easier route: it downloads the integration into custom_components and reports updates. Spatial Context is not yet in the HACS default repository, so it is added as a custom repository. A submission to HACS is planned, and the steps below will get shorter once it is listed.

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Or add it by hand:

  1. In HACS, select ⋮ → Custom Repositories.
  2. Enter https://github.com/Greminn/ha-spatial-context as the Repository.
  3. Set Type to Integration, then select Add.
  4. Select Spatial Context, then Download.
  5. Restart Home Assistant.

Install from GitHub ​

A manual copy has no update notifications, so each update is another copy. There is no build step: the built panel is committed to the repository.

  1. Download the repository from GitHub, or clone it:

    sh
    git clone https://github.com/Greminn/ha-spatial-context.git
  2. Copy custom_components/spatial_context into the custom_components folder of the Home Assistant configuration directory:

    config/
    └── custom_components/
        └── spatial_context/
            ├── __init__.py
            ├── manifest.json
            ├── www/
            └── ...
  3. Restart Home Assistant.

Add the Integration ​

  1. Go to Settings → Devices & Services.
  2. Select Add Integration, then Spatial Context.

Spatial Context appears in the sidebar. Carry on with Your First Floor Plan.

Requirements by Feature ​

The floor plan editor has no requirements beyond Home Assistant itself. The Connectivity Map layers need a data source each.

FeatureRequires
Zigbee MeshZigbee2MQTT connected over MQTT, or ZHA. Zigbee2MQTT is used when both are present.
Wi-Fi NetworkAn integration that reports each client's access point: UniFi Network, TP-Link Omada, or the custom TP-Link Deco integration.
Matter NetworkThe Matter integration.
BluetoothHome Assistant 2025.2 or newer, an administrator account, and Bluetooth devices registered by an integration (BTHome, Xiaomi BLE, SwitchBot and similar). ESPHome Bluetooth proxies are supported.
Property Map BackgroundHome Assistant 2026.10 or newer (its map tile service), a home location set in Home Assistant, and a browser with WebGL2.

Update ​

  • HACS: select Update on Spatial Context, then restart Home Assistant.
  • GitHub: copy the new spatial_context folder over the old one, then restart Home Assistant.

Layouts are stored separately from the integration files and are kept. See Stored Data.

The panel compares itself with the installed version each time it opens and whenever its tab regains focus. A banner appears when they differ:

BannerMeaning
Restart Home AssistantHome Assistant has not restarted since the update. Some changes cannot be saved until it does.
Reload the pageThe browser is running an older copy of the panel.

Troubleshooting ​

SymptomFix
Spatial Context is missing from Add IntegrationCheck the folder is exactly config/custom_components/spatial_context, not nested one level deeper, then restart Home Assistant.
No Spatial Context in the sidebarAdd the integration under Settings → Devices & Services.
Spatial Context is missing for one user onlyThe panel is for administrators. Sign in with an administrator account.
"No floors found"Add floors under Settings → Areas → Floors, then reopen the panel.

Need help?

Open an issue on GitHub. See Reporting a Problem for what to attach.