HomeGenie
MINI 1.2 — Documentation

Device setup

If you did not configure Wi-Fi during the initial firmware upload, or if you need to update the device's current Wi-Fi credentials, you can quickly make these changes by returning to the firmware upload page.

Simply enter the new network details in the form, check the Initialize only box, and click "Create device." The device configuration will update immediately without reinstalling the firmware.

If you cannot use the Web Installer, or if you require advanced configuration, you can use one of the following methods to configure and control your HomeGenie Mini device:

  1. WPS Pairing: The quickest method using your router's WPS button.
  2. HomeGenie Panel App: The recommended method for most users (via Bluetooth), providing a guided graphical setup.
  3. Terminal Interface: An advanced option for power users who prefer command-line setup (via USB Serial).

This guide walks you through each configuration workflow.

Connecting to Wi-Fi

In the latest firmware versions, fresh or unconfigured devices remain quietly in offline mode without automatic rapid blinking, allowing immediate standalone or off-grid operation.

To connect the device to your local network, you must explicitly activate Setup Mode using the device's "BOOT" button (labeled "BOOT", "B", or "IO0" on most ESP boards) or via the serial terminal.

Option 1: WPS setup (Quickest)

  1. Press and hold the "BOOT" button for 4 seconds, then release it.
  2. The status LED will begin a continuous slow pulse, indicating that the device is actively in WPS pairing mode. Saved Wi-Fi credentials (if any) are preserved.
  3. Press the WPS button on your Wi-Fi router (refer to your router's manual if needed).
  4. Once paired, the device will save the router's credentials, automatically restart, and connect to your Wi-Fi network.

If WPS pairing fails or times out, the device will automatically retry until the connection succeeds or power is cycled.

Option 2: Bluetooth setup via HomeGenie Panel

If your router lacks WPS, or if you prefer manual configuration via smartphone:

  1. Put the device into WPS mode (press and hold the "BOOT" button for 4 seconds and release).
  2. Press and hold the "BOOT" button again for 4 seconds, then release it.
  3. The device will clear its previous Wi-Fi credentials and reboot into Bluetooth discovery mode. The status LED will now show two quick flashes, repeated.
  4. Ensure Bluetooth is enabled on your mobile device.
  5. Open the HomeGenie Panel app and navigate to the device discovery screen.
  6. Select the detected HomeGenie Mini device and follow the on-screen wizard to assign a device name and enter your Wi-Fi SSID and password.
  7. After confirming, the device will save the configuration, reboot, and connect to your local network.
Tip – Leaving setup without changes: Disconnect and reconnect the power supply at any time to exit Setup Mode and restore the previously saved configuration (unless credentials were explicitly cleared in Option 2).

Note: In current firmware releases, the initial rapid flashing shown in the video no longer occurs automatically on first boot, ensuring full offline capability out of the box. The WPS button-press sequence remains identical.

Understanding the status LED

The onboard status LED provides real-time diagnostic feedback:

LED IndicatorMeaning
Brief flash every 2 secondsConnected to Wi-Fi. (On Smart Light, stops after 20 seconds).
Continuous slow flashIn WPS Setup Mode (ready to pair with router).
Two quick flashes (repeating)In Bluetooth Setup Mode (ready to pair with HomeGenie Panel).
Fast continuous flashAttempting to connect or reconnect to saved Wi-Fi network.

Alternative: USB Web Installer

You can also apply network credentials directly over USB without pressing physical buttons:

  1. Connect the ESP board to your computer via USB.
  2. Open the HomeGenie Mini Web Installer in a supported browser (Chrome, Edge, Opera).
  3. Select your device model and configure your target Wi-Fi SSID and Password.
  4. Check the Initialize only checkbox.
  5. Click Create device and confirm the serial port.

This writes the configuration directly to the non-volatile memory without re-flashing the firmware binary.


Controlling your device with HomeGenie Panel

Once connected to your network, the device will appear in the discovery list within the HomeGenie Panel app. Simply select it and tap "Done" to add it to your dashboard.

HomeGenie Panel - Discovery: select device

The modules and controls available on your dashboard will depend on the specific firmware version installed. For example, the smart-sensor-d1-mini firmware provides access to temperature and light sensors, along with 2 configurable GPIO switches.

HomeGenie Panel - Dashboard


Connecting to HomeGenie Server

HomeGenie Mini devices integrate natively into a HomeGenie Server instance in just a few steps. The video below demonstrates connecting a HomeGenie Mini Smart Camera, but the procedure is identical for all HG-Mini device types and firmware flavors:

Connecting your HG-Mini to a HomeGenie Server unlocks powerful capabilities:

HomeGenie Server - Dashboard


Advanced configuration via terminal interface

For advanced users, HomeGenie Mini can be configured directly through a serial terminal over USB. The command-line interface accepts two types of instructions:

Connect to the virtual COM port using any serial terminal emulator (PuTTY, screen, minicom, or Arduino Serial Monitor) set to 115200 baud.

Quick Wi-Fi setup via terminal

To trigger the non-destructive Wi-Fi Setup Mode without using the physical button:

#CONFIG:wifi-setup

To assign credentials directly in a single step, send:

#CONFIG:wifi-ssid MyHomeNetwork
#CONFIG:wifi-password MySecretPassword
#RESET

System commands (#)

Basic operations

System CommandDescription
#RESETRestarts the microcontroller. Required to apply certain parameters.
#CONFIG:wifi-setupEnters temporary Wi-Fi Setup Mode (non-destructive; preserves saved settings).
#WPSLegacy WPS trigger: clears saved Wi-Fi credentials and initiates pairing.
#UPTIMEDisplays device uptime since last boot.
#VERSIONReturns the active firmware build version and compilation details.

Core configuration (#CONFIG)

Device identity

#CONFIG:device-name <name>

Sets the friendly name used for HomeGenie Panel discovery and network hostname. Spaces are supported without quotes. Example:

#CONFIG:device-name Living Room Gateway

Network configuration

#CONFIG:wifi-ssid <ssid>

Sets the target Wi-Fi network SSID (case-sensitive). Spaces inside the SSID are supported without quotation marks. Example:

#CONFIG:wifi-ssid My Home Wi-Fi
#CONFIG:wifi-password <passwd>

Sets the WPA/WPA2/WPA3 network password. All characters following the space after the command are treated as part of the secret. Example:

#CONFIG:wifi-password My_S3cur3/P@ssw0rd!
#CONFIG:system-ntp-server <server_address>

Configures a custom NTP server hostname or IP address for network time synchronization. Example:

#CONFIG:system-ntp-server pool.ntp.org

Time and timezone configuration

#CONFIG:system-time <epoch_milliseconds>

Sets the internal real-time clock manually using a 64-bit Unix timestamp in milliseconds (UTC). Example (2026-01-01 00:00:00 UTC):

#CONFIG:system-time 1767225600000
#CONFIG:system-zone-id <zone_id>

Sets the timezone using a standard IANA/Olson identifier. This enables automatic Daylight Saving Time (DST) calculations. Example:

#CONFIG:system-zone-id Europe/Rome
#CONFIG:system-zone-offset <tz_offset_minutes>

Sets a static UTC time offset in minutes (e.g., 60 for UTC+1, 120 for UTC+2, -300 for UTC-5). Note: Static offsets do not adjust for daylight saving time. Example:

#CONFIG:system-zone-offset 60

Parameter management (#GET / #SET)

Parameters list

Parameter NameDescriptionDefault Value
sys-rb-nGPIO pin number assigned to the "BOOT" / Setup button.-1 (not used)
sys-sl-nGPIO pin number assigned to the system status LED.-1 (not used)
io-typ01Channel 1 Type (Switch, Light, or Dimmer).(empty)
io-pin01Channel 1 GPIO pin assignment.-1 (not used)
io-typ02Channel 2 Type.(empty)
io-pin02Channel 2 GPIO pin assignment.-1 (not used)
...(Channels 3 through 8 follow the identical pattern)...

Examples

More topics

Setup

Create!

Programming

📖

🕵🏻 Explore Mini DeepWiki

Technical Docs & Interactive Wiki

Ask the AI 🧠
menu_open Browse Content