-
Notifications
You must be signed in to change notification settings - Fork 607
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve the docs for firmware build/compile
- Loading branch information
Showing
7 changed files
with
68 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
<img src="/images/install_firmware_screenshot_1.png" alt="install_firmware_screenshot_1" width="100%"/> | ||
<img | ||
src="/images/install_firmware_screenshot_1.png" | ||
alt="install_firmware_screenshot_1" | ||
width="75%" | ||
/> | ||
|
||
--- | ||
<img | ||
src="/images/install_firmware_screenshot_2.png" | ||
alt="install_firmware_screenshot_2" | ||
width="75%" | ||
/> | ||
|
||
### 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 | ||
|
||
<img src="/images/addbuild.png" alt="Add Build Configuration" width="200"/> | ||
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` | ||
<img | ||
src="/images/build_configuration.png" | ||
alt="Build Configuration" | ||
width="75%" | ||
/> | ||
|
||
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. | ||
|
||
<img src="/images/build_settings.png" alt="Build Settings" width="400"/> | ||
<img | ||
src="/images/build_configuration_button.png" | ||
alt="Build Configuration" | ||
width="75%" | ||
/> | ||
|
||
--- | ||
|
||
### 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.