Exergie/NeoECU-Env-Docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tweaks and Fixes

Browse Source
This commit is contained in:
Hector van der Aa
2026-03-21 23:11:08 +01:00
parent 75a26e3280
commit 694239a431
2 changed files with 25 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
main.pdf
View File

Binary file not shown.

32
main.qmd
View File

@@ -170,7 +170,7 @@ Install west:
uv pip install west uv pip install west
``` ```
Initialise workspace: Initialize workspace:
```bash ```bash
west init ~/zephyrproject west init ~/zephyrproject
@@ -191,16 +191,32 @@ uv pip install -r zephyr/scripts/requirements.txt
If errors occur, install missing packages and re-run until successful. If errors occur, install missing packages and re-run until successful.
```{=typst}
#pagebreak()
```
Install SDK: Install SDK:
```bash ```bash
cd ~/zephyrproject/zephyr cd ~/zephyrproject/zephyr
west sdk install west sdk install
``` ```
Add the ZEPHYR_BASE variable to your .bashrc: Add the ZEPHYR_BASE variable to your .bashrc (or equivalent):
```bash ```bash
export ZEPHYR_BASE=$HOME/zephyrproject/zephyr export ZEPHYR_BASE=$HOME/zephyrproject/zephyr
``` ```
Check your .bashrc for a line along these lines:
```bash
export ZEPHYR_SDK_INSTALL_DIR=...
```
If is doesn't exist, firstly check the SDK version installed:
```bash
cd && ls | grep "zephyr-sdk"
```
Then take this and add the following to your .bashrc (or equivalent):
```bash
export ZEPHYR_SDK_INSTALL_DIR=$HOME/zephyr-sdk-1.0.0
```
Making sure that the x.x.x matches the version you have installed.
```{=typst} ```{=typst}
#pagebreak() #pagebreak()
@@ -220,13 +236,13 @@ Run the setup binary:
```bash ```bash
./SetupSTM32CubeMX-* ./SetupSTM32CubeMX-*
``` ```
Add the install directory to your path, ie for bash add the following to `.bashrc`: Add the install directory to your path, add this line to your .bashrc (or equivalent):
```bash ```bash
export PATH=$PATH:$HOME/STM32CubeMX export PATH=$PATH:$HOME/STM32CubeMX
``` ```
It can take a few minutes for the application to start for the first time. It can take a few minutes for the application to start for the first time.
Then open the 'Install or remove embedded software pacakges' window: Then open the 'Install or remove embedded software packages' window:
![STM32CubeMX Home Screen](img/cubemx_home.png){width=95%} ![STM32CubeMX Home Screen](img/cubemx_home.png){width=95%}
@@ -302,6 +318,8 @@ Start by checking dependencies:
```bash ```bash
neoecu envcheck neoecu envcheck
``` ```
It is normal for west to fail at this stage.
Then init the tooling system: Then init the tooling system:
```bash ```bash
neoecu init neoecu init
@@ -310,14 +328,14 @@ You can now test build the demo project:
```bash ```bash
neoecu build --debug --clean neoecu build --debug --clean
``` ```
If this succeeds then your build environement is set up correctly! If this succeeds then your build environment is set up correctly!
```{=typst} ```{=typst}
#pagebreak() #pagebreak()
``` ```
# NeoECU Tooling Overview # NeoECU Tooling Overview
The NeoECU tooling harmonizes the STM32 and Zephyr environements into one set of easy to use commands. It currently supports the following commands: The NeoECU tooling harmonizes the STM32 and Zephyr environments into one set of easy to use commands. It currently supports the following commands:
```bash ```bash
neoecu envcheck neoecu envcheck
neoecu init neoecu init
@@ -325,7 +343,7 @@ neoecu build
neoecu clean neoecu clean
``` ```
## envcheck ## envcheck
The environement checker is a simple tool that checks that all the required tools and dependencies are installed and accessible from your path. The environment checker is a simple tool that checks that all the required tools and dependencies are installed and accessible from your path.
## init ## init
The init command installs all the required python dependencies for west and initializes the cmake build environment for the STM32 side of the project. The init command installs all the required python dependencies for west and initializes the cmake build environment for the STM32 side of the project.