Skip to main content

Overview

Build firmware from source to customize your Omi device. To install the latest release instead, use the Flash Device page.

Consumer firmware

omi/firmware/omi, SDK v2.9.0

DevKit firmware

omi/firmware/devkit, SDK v2.7.0

Build steps

Install nRF Connect

Install the nRF Connect for VS Code extension.
Follow this walkthrough: How to Set Up nRF Connect

Install the SDK toolchain

In the nRF Connect extension, install the correct SDK + toolchain version:
A wrong SDK version causes build failures. Check the version before you continue.

Open the application

  1. Open the nRF Connect Extension panel in VS Code
  2. Click Open an existing application
  3. Navigate to omi/firmware/omi (consumer) or omi/firmware/devkit (DevKit)

Add build configuration

  1. In the application panel, click Add Build Configuration
  2. Set the board target:
These targets are not interchangeable. The consumer CV1 is an nRF5340 image built from omi/firmware/omi with sysbuild (MCUboot-signed dfu_application.zip plus merged.hex and merged_CPUNET.hex, not a UF2). The DevKit UF2 is built only from omi/firmware/devkit.CV1 sysbuild selects Omi’s custom MCUboot main, which initializes SD before reading the shared NOR bus. Never flash stock MCUboot, raw merged.hex, or all sysbuild domains to a pendant. Use validated release app-core packaging with the qualified bootloader and the bootloader procedure.In nRF Connect, use the OMI preset in omi/firmware/omi/CMakePresets.json and turn sysbuild on. The preset sets the board and CONF_FILE=omi.conf; it does not enable sysbuild.Or, from the west workspace omi/firmware/v2.9.0, after cp ../omi/omi.conf ../omi/prj.conf:
The DevKit presets use the legacy spelling xiao_ble_sense. NCS 2.7.0 maps it to xiao_ble/nrf52840/sense, the spelling used by omi/firmware/scripts/build-firmware-in-docker.sh; both select the same board.
  1. Click Build Configuration to start the build
  2. A VS Code notification will show build progress

Locate the firmware file

After a successful build, find the outputs:

Flash the device

For CV1, prefer the OTA package. For authorized wired recovery, use the validated release app-core image with its qualified bootloader; back up first and verify readback. Do not use the IDE’s all-domain Flash command. For DevKit, use the UF2 output. Follow the Flash Device guide for your device.

Flash device

Install pre-built or custom firmware

Hardware docs

Omi consumer hardware specs