You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart/firmware/hardware.md
+8-14Lines changed: 8 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,12 +15,12 @@ Please refer to the board-specific documentation in our [Board Support](../../..
15
15
16
16
## Steps
17
17
18
-
### **1. Install Dependencies and the Zephyr SDK**
18
+
### **1. Install Dependencies and Zephyr SDK**
19
19
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).
21
21
22
22
{: .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.
24
24
25
25
### **2. Install WEST**
26
26
@@ -30,6 +30,9 @@ Install the [west](https://docs.zephyrproject.org/latest/develop/west/index.html
30
30
pip install west
31
31
```
32
32
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
+
33
36
### **3. Initialize the workspace**
34
37
35
38
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
63
66
pip install -r zephyr/scripts/requirements.txt
64
67
```
65
68
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
-
74
69
### **5. Build the Ocre Runtime**
75
70
76
71
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:
79
74
80
75
2. Build the application for your specific board. Replace `BOARD_NAME` with your board's name:
81
76
```
82
-
cd ..
83
77
west build -b BOARD_NAME ./application -d build -- -DMODULE_EXT_ROOT=`pwd`/application
84
78
```
85
79
86
80
{: .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.
88
82
89
83
90
84
### **6. Flash the Ocre Runtime to Your Device**
@@ -93,7 +87,7 @@ See the list of [supported boards](https://docs.zephyrproject.org/latest/boards/
93
87
west flash
94
88
```
95
89
96
-
2.After flashing, restart/reset your board to run the application.
90
+
After flashing, restart/reset your board to run the application.
Copy file name to clipboardExpand all lines: docs/quickstart/firmware/simulated.md
+9-15Lines changed: 9 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ nav_order: 0
10
10
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.
11
11
12
12
13
-
{: .note}
13
+
{: .important}
14
14
> There are *two* key limitations when building the native simulator:
15
15
> 1. Building on ARM architectures is not currently supported due to a lack of 32-bit support.
16
16
> 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
24
24
25
25
## Steps
26
26
27
-
### **1. Install Dependencies and the Zephyr SDK**
27
+
### **1. Install Dependencies and Zephyr SDK**
28
28
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).
30
30
31
31
{: .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.
33
33
34
34
### **2. Install WEST**
35
35
@@ -39,6 +39,9 @@ Install the [west](https://docs.zephyrproject.org/latest/develop/west/index.html
39
39
pip install west
40
40
```
41
41
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
+
42
45
### **3. Initialize the workspace**
43
46
44
47
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
72
75
pip install -r zephyr/scripts/requirements.txt
73
76
```
74
77
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**
84
79
85
80
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.
86
81
```
87
-
cd ..
88
82
west build -b native_sim ./application -d build -- -DMODULE_EXT_ROOT=`pwd`/application
89
83
```
90
84
91
-
### **7. Run the application**
85
+
### **6. Run the application**
92
86
93
87
To run the application, simply run the following command:
0 commit comments