Documentation

Quick start

The short way, from nothing to a dashboard on the wall. Each step links to the full page.

1. Install the integration

With HACS, add our repository, download Nucleum Hub, restart Home Assistant, then go to Settings › Devices & services › Add integration › Nucleum Hub. Without HACS, unzip the package into your configuration folder, then restart and add the integration the same way. Install, step by step

2. The trial starts

Adding the integration starts your 60-minute trial: every feature, by the clock, no card, no e-mail. Bought a licence already? Paste the key in Settings › Devices & services › Nucleum Hub › Configure. Licence and activation

3. Run the setup assistant

Open Nucleum Hub from the sidebar, on an administrator account. The assistant takes three steps:

  1. your language, and a name for the greeting if you like;
  2. the pages you want: Energy, Security, Car, Media and the others;
  3. what it found in your home: solar, grid, battery, weather, alarm and more. Change what is wrong, or say there is none.

Press Create dashboard. Your setup is saved in Home Assistant, so every screen shows the same.

4. Open it on your screens

  • Phones and tablets with the Home Assistant app: open Nucleum Hub from the sidebar.
  • A wall tablet: Fully Kiosk Browser or the Home Assistant app. Companion app and Fully Kiosk
  • A screen of its own: in edit mode, choose “Only this device” to give that screen its own dashboard.

5. Make it yours

Press the pencil to edit: add cards from the catalogue, drag a corner to resize, rename, hide, pick the colours. Undo, History, Backup and Restore are on the edit bar. Every change reaches the other screens that show the same dashboard.