diff --git a/docs/docs/developer/Compile_firmware.mdx b/docs/docs/developer/Compile_firmware.mdx index 699233d8ec..79fc2039d6 100644 --- a/docs/docs/developer/Compile_firmware.mdx +++ b/docs/docs/developer/Compile_firmware.mdx @@ -1,62 +1,80 @@ --- title: Compiling the Device Firmware -description: 'Step-by-step guide to compile and install firmware for your OMI device.' +description: "Step-by-step guide to compile and install firmware for your OMI device." --- -# Compile Firmware +# Compile Firmware +### Prefer a Pre-Built Firmware? -### Prefer a Pre-Built Firmware? Navigate to [Flash Device](https://docs.omi.me/get_started/Flash_device/) to install a pre-built firmware version. --- -## Build Your Own Firmware +## Build Your Own Firmware -### Step 1: Set Up nRF Connect +### Step 1: Set Up nRF Connect Follow the tutorial in this video: [How to Set Up nRF Connect](https://youtu.be/EAJdOqsL9m8) +You must use **nRF Connect** SDK and toolchain version `2.7.0` to compile the firmware. +Note that this is not the `latest` version of the NRF Connect toolchain or SDK. + --- -### Step 2: Open the Firmware Application +### Step 2: Open the Firmware Application 1. Open **nRF Connect Extension** inside VS Code. -2. Click "Open an existing application" and navigate to the `firmware` folder in the root of this repository. +2. Click "Open an existing application" and navigate to the `firmware/firmware_v1.0` folder in the root of this repository. - install_firmware_screenshot_1 + install_firmware_screenshot_1 ---- + install_firmware_screenshot_2 -### Step 3: Add a Build Configuration +--- -1. In the application panel of the extension, click the **Add Build Configuration** icon. +### Step 3: Add a Build Configuration - Add Build Configuration +1. In the application panel of the extension, click the **Add Build Configuration** icon. Choose a `CMake Preset` that matches your hardware. -2. Choose: - - **Board:** `xiao_ble_sense` - - **Configuration:** `prj.conf` + Build Configuration -3. Click "Build Configuration." +2. Scroll to the bottom and click "Build Configuration." This will start the nRFConnect SDK building your firmware file. + A VSCode notification popup will notify you of the progress of your build. - Build Settings + Build Configuration --- -### Step 4: Locate the Compiled Firmware +### Step 4: Locate the Compiled Firmware -Once the build succeeds, you will find the `zephyr.uf2` file in the `firmware/build/zephyr` directory. +Once the build succeeds, you will find the `zephyr.uf2` file in the directory corresponding to the CMake preset you chose, for example `firmware/firmware_v1.0/build/build_xiao_ble_sense_devkitv2-adafruit/zephyr/`. --- -### Step 5: Flash the Firmware +### Step 5: Flash the Firmware -Follow the steps as described [here](https://docs.omi.me/get_started/Flash_device#flashing-the-firmware) using the generated file +Follow the steps as described [here](docs/get_started/Flash_device.mdx) using the generated file --- -## Congratulations! +## Congratulations! -You have successfully compiled and installed the firmware on your OMI device. +You have successfully compiled and installed the firmware on your OMI device. diff --git a/docs/docs/get_started/Flash_device.mdx b/docs/docs/get_started/Flash_device.mdx index 03016b45b2..c9a0182324 100644 --- a/docs/docs/get_started/Flash_device.mdx +++ b/docs/docs/get_started/Flash_device.mdx @@ -1,6 +1,6 @@ --- title: Update OMI Firmware -description: 'This document outlines the process of updating the OMI firmware.' +description: "This document outlines the process of updating the OMI firmware." --- To update the firmware of your OMI device, navigate to the OMI App: @@ -12,10 +12,15 @@ To update the firmware of your OMI device, navigate to the OMI App: ### Video Tutorial -
+
@@ -34,14 +39,24 @@ To update the firmware of your OMI device, navigate to the OMI App: ### Putting OMI into DFU Mode -1. **Locate the DFU Button:** - - For Developer Kit 2, remove the lid to access the button. - - For Developer Kit 1, see the image below for button location: - -2. **Prepare a Pin:** Use a small pin or similar tool to press the tiny button. -3. **Press the DFU Button Twice:** Quickly press the button twice in succession using the pin. -4. **Check for Recognition:** After pressing the button, your computer should recognize a new drive. -5. **Verify the Drive Name:** Look for a drive named `/Volumes/XIAO-SENSE` on your computer. This confirms the device is in DFU mode. +1. Plug the OMI device into your computer using a USB cable. +2. **Locate the DFU Button:** + - For Developer Kit 2, remove the lid to access the button which is labeled "RST" + - + - For Developer Kit 1, see the image below for button location: + - +3. **Prepare a Pin:** Use a small pin or similar tool to press the tiny button. +4. **Press the DFU Button Twice:** Quickly press the button twice in succession using the pin. +5. **Check for Recognition:** After pressing the button, your computer should recognize a new drive. +6. **Verify the Drive Name:** Look for a drive named `/Volumes/XIAO-SENSE` on your computer. This confirms the device is in DFU mode. --- diff --git a/docs/static/images/build_configuration.png b/docs/static/images/build_configuration.png new file mode 100644 index 0000000000..beb1f58046 Binary files /dev/null and b/docs/static/images/build_configuration.png differ diff --git a/docs/static/images/build_configuration_button.png b/docs/static/images/build_configuration_button.png new file mode 100644 index 0000000000..6812e3ee6c Binary files /dev/null and b/docs/static/images/build_configuration_button.png differ diff --git a/docs/static/images/dk2_rst_button.jpeg b/docs/static/images/dk2_rst_button.jpeg new file mode 100644 index 0000000000..5ff83b3c81 Binary files /dev/null and b/docs/static/images/dk2_rst_button.jpeg differ diff --git a/docs/static/images/install_firmware_screenshot_1.png b/docs/static/images/install_firmware_screenshot_1.png index 1cdcd331c7..5d09cb889e 100644 Binary files a/docs/static/images/install_firmware_screenshot_1.png and b/docs/static/images/install_firmware_screenshot_1.png differ diff --git a/docs/static/images/install_firmware_screenshot_2.png b/docs/static/images/install_firmware_screenshot_2.png new file mode 100644 index 0000000000..9dfdd4d57c Binary files /dev/null and b/docs/static/images/install_firmware_screenshot_2.png differ