Skip to main content

​
Overview

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

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:
Using the wrong SDK version will cause build failures. Double-check the version before proceeding.

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.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

Follow the Flash Device guide to install the compiled firmware on your device.

Flash Device

Install pre-built or custom firmware

Hardware Docs

Omi consumer hardware specs