Skip to content

Commit 650de32

Browse files
committed
Updated instructions to use zephyr 3.17
1 parent e794622 commit 650de32

2 files changed

Lines changed: 17 additions & 29 deletions

File tree

docs/quickstart/firmware/hardware.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ Please refer to the board-specific documentation in our [Board Support](../../..
1515

1616
## Steps
1717

18-
### **1. Install Dependencies and the Zephyr SDK**
18+
### **1. Install Dependencies and Zephyr SDK**
1919

20-
Complete the [Install dependencies](https://docs.zephyrproject.org/latest/develop/getting_started/index.html#install-dependencies) section from the Zephyr [Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html#getting-started-guide).
20+
Complete the [Install dependencies](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-dependencies) and the [Install the Zephyr SDK](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-the-zephyr-sdk) sections for your host operating system from the Zephyr (v3.7.0) [Getting Started Guide](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#getting-started-guide).
2121

2222
{: .note}
23-
For the following steps we recommend using a Python virtual environment like [venv](https://docs.python.org/3/library/venv.html).
23+
Currently the Ocre runtime is built on Zephyr `3.7.0`. As a result, the links in the above section reference `v3.7.0` documentation and not the *latest* documentation. It is advised to follow the links in this guide to ensure compability with your device.
2424

2525
### **2. Install WEST**
2626

@@ -30,6 +30,9 @@ Install the [west](https://docs.zephyrproject.org/latest/develop/west/index.html
3030
pip install west
3131
```
3232

33+
{: .note}
34+
We recommend using a Python virtual environment like [venv](https://docs.python.org/3/library/venv.html) to help manage pip dependencies for this project.
35+
3336
### **3. Initialize the workspace**
3437

3538
Next, we will prepare the Zephyr workspace and checkout the project code.
@@ -63,14 +66,6 @@ In order to build the Ocre runtime properly, you'll need to install a few remain
6366
pip install -r zephyr/scripts/requirements.txt
6467
```
6568

66-
### **5. Install the Zephyr SDK**
67-
For the last Zephyr requirement, we must install the SDK.
68-
69-
```
70-
cd zephyr/
71-
west sdk install
72-
```
73-
7469
### **5. Build the Ocre Runtime**
7570

7671
To build and flash for a physical device, follow these steps:
@@ -79,12 +74,11 @@ To build and flash for a physical device, follow these steps:
7974

8075
2. Build the application for your specific board. Replace `BOARD_NAME` with your board's name:
8176
```
82-
cd ..
8377
west build -b BOARD_NAME ./application -d build -- -DMODULE_EXT_ROOT=`pwd`/application
8478
```
8579

8680
{: .note}
87-
See the list of [supported boards](https://docs.zephyrproject.org/latest/boards/index.html) from Zephyr to gather your board name. Or, simply run `west boards` from the terminal.
81+
See the list of [supported boards](https://docs.zephyrproject.org/3.7.0/boards/index.html) from Zephyr to gather your board name. Or, simply run `west boards` from the terminal.
8882

8983

9084
### **6. Flash the Ocre Runtime to Your Device**
@@ -93,7 +87,7 @@ See the list of [supported boards](https://docs.zephyrproject.org/latest/boards/
9387
west flash
9488
```
9589

96-
2. After flashing, restart/reset your board to run the application.
90+
After flashing, restart/reset your board to run the application.
9791

9892
---
9993

docs/quickstart/firmware/simulated.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 0
1010
This guide covers building and running the Ocre runtime using Zephyr's `native_sim` target - a simulated environment that allows you to test Ocre applications without physical hardware. This approach is particularly useful for initial development and testing.
1111

1212

13-
{: .note}
13+
{: .important}
1414
> There are *two* key limitations when building the native simulator:
1515
> 1. Building on ARM architectures is not currently supported due to a lack of 32-bit support.
1616
> 2. The POSIX architecture does not work on macOS due to fundamental differences between macOS and other Unix-like operating systems.
@@ -24,12 +24,12 @@ This guide covers building and running the Ocre runtime using Zephyr's `native_s
2424

2525
## Steps
2626

27-
### **1. Install Dependencies and the Zephyr SDK**
27+
### **1. Install Dependencies and Zephyr SDK**
2828

29-
Complete the [Install dependencies](https://docs.zephyrproject.org/latest/develop/getting_started/index.html#install-dependencies) section from the Zephyr [Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html#getting-started-guide).
29+
Complete the [Install dependencies](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-dependencies) and the [Install the Zephyr SDK](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-the-zephyr-sdk) sections for your host operating system from the Zephyr (v3.7.0) [Getting Started Guide](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#getting-started-guide).
3030

3131
{: .note}
32-
For the following steps we recommend using a Python virtual environment like [venv](https://docs.python.org/3/library/venv.html).
32+
Currently the Ocre runtime is built on Zephyr `3.7.0`. As a result, the links in the above section reference `v3.7.0` documentation and not the *latest* documentation. It is advised to follow the links in this guide to ensure compability with your device.
3333

3434
### **2. Install WEST**
3535

@@ -39,6 +39,9 @@ Install the [west](https://docs.zephyrproject.org/latest/develop/west/index.html
3939
pip install west
4040
```
4141

42+
{: .note}
43+
We recommend using a Python virtual environment like [venv](https://docs.python.org/3/library/venv.html) to help manage pip dependencies for this project.
44+
4245
### **3. Initialize the workspace**
4346

4447
Next, we will prepare the Zephyr workspace and checkout the project code.
@@ -72,23 +75,14 @@ In order to build the Ocre runtime properly, you'll need to install a few remain
7275
pip install -r zephyr/scripts/requirements.txt
7376
```
7477

75-
### **5. Install the Zephyr SDK**
76-
For the last Zephyr requirement, we must install the SDK.
77-
78-
```
79-
cd zephyr/
80-
west sdk install
81-
```
82-
83-
### **6. Build the application**
78+
### **5. Build the application**
8479

8580
The following will build the firmware for the *virtual*, `native_sim` target which will allow you to run the Ocre runtime on a simulated device, rather than a physical board.
8681
```
87-
cd ..
8882
west build -b native_sim ./application -d build -- -DMODULE_EXT_ROOT=`pwd`/application
8983
```
9084

91-
### **7. Run the application**
85+
### **6. Run the application**
9286

9387
To run the application, simply run the following command:
9488
```

0 commit comments

Comments
 (0)