6 Commits

Author SHA1 Message Date
1a27520353 Release v0.2.2: merge dev into main 2026-05-03 18:58:40 +02:00
6e7eeca437 Fixed typo to v0.2.2 2026-05-03 18:58:12 +02:00
15ff6ceb0a Docs v0.2.2 2026-05-03 18:56:56 +02:00
5ab8ddae6d Release v0.2.1: merge dev into main 2026-05-03 17:42:10 +02:00
3477af7a5a Docs v0.2.1 2026-05-03 17:40:25 +02:00
7c90d8c2ef Added .gitignore 2026-05-03 17:40:08 +02:00
3 changed files with 46 additions and 11 deletions

1
.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
.quarto/

BIN
main.pdf

Binary file not shown.

View File

@@ -3,6 +3,7 @@ title: "NeoECU Development Environment"
author: author:
- name: Hector van der Aa - name: Hector van der Aa
email: hector@h3cx.dev email: hector@h3cx.dev
affiliation: Version 0.2.2
date: today date: today
date-format: long date-format: long
format: format:
@@ -10,12 +11,15 @@ format:
mainfont: Inter mainfont: Inter
codefont: "JetBrains Mono" codefont: "JetBrains Mono"
papersize: a4 papersize: a4
margin:
x: 2cm
y: 2cm
toc: true toc: true
--- ---
```{=typst} ```{=typst}
#set page( #set page(
header: align(right)[ header: align(right)[
Version 0.2.0 Version 0.2.2
], ],
numbering: "1", numbering: "1",
) )
@@ -214,7 +218,7 @@ cd && ls | grep "zephyr-sdk"
``` ```
Then take this and add the following to your .bashrc (or equivalent): Then take this and add the following to your .bashrc (or equivalent):
```bash ```bash
export ZEPHYR_SDK_INSTALL_DIR=$HOME/zephyr-sdk-1.0.0 export ZEPHYR_SDK_INSTALL_DIR=$HOME/zephyr-sdk-x.x.x
``` ```
Making sure that the x.x.x matches the version you have installed. Making sure that the x.x.x matches the version you have installed.
@@ -261,8 +265,8 @@ Download the '*J-Link Software and Documentation Package*' from
From your downloads, install the package: From your downloads, install the package:
```bash ```bash
# Arch # Arch
sudo mkdir /opt/SEGGER/JLink sudo mkdir -p /opt/SEGGER/JLink
sudo tar -xvzf JLink_Linux_*_x86_64.tgz -C target --strip-components=1 sudo tar -xvzf JLink_Linux_*_x86_64.tgz -C /opt/SEGGER/JLink --strip-components=1
# Debian # Debian
sudo apt install ./JLink_Linux_*_x86_64.deb sudo apt install ./JLink_Linux_*_x86_64.deb
@@ -306,9 +310,10 @@ source .venv/bin/activate
This step must be repeated for each new terminal session. This step must be repeated for each new terminal session.
## NeoECU Tooling Setup ## NeoECU Tooling Setup
Install the neoecu cli tooling: Install the neoecu cli tooling and west for Zephyr:
```bash ```bash
uv pip install "git+https://git.h3cx.dev/h3cx/NeoECU-Tooling.git" uv pip install "git+https://git.h3cx.dev/h3cx/NeoECU-Tooling.git"
uv pip install west
``` ```
Help can be found by running: Help can be found by running:
```bash ```bash
@@ -349,6 +354,12 @@ If this succeeds then your build environment is set up correctly! You should see
# NeoECU Tooling Overview # NeoECU Tooling Overview
The NeoECU tooling harmonizes the STM32 and Zephyr environments 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:
::: {.callout-important}
For complete, up-to-date documentation, please refer to the official git repo:
[https://git.h3cx.dev/Exergie/NeoECU-Tooling](https://git.h3cx.dev/Exergie/NeoECU-Tooling)
:::
```bash ```bash
neoecu envcheck neoecu envcheck
neoecu init neoecu init
@@ -363,23 +374,46 @@ The environment checker is a simple tool that checks that all the required tools
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.
## build ## build
The build command builds both sides of the project, STM32 and Zephyr. It defaults to release mode when run without arguments. The build command builds both sides of the project (if configured), STM32 and Zephyr. It defaults to release mode and both cores when run without arguments.
Multiple arguments can be passed as follows: Multiple arguments can be passed as follows:
```bash ```bash
--release --release
# or
--debug --debug
```
```bash
--clean --clean
--CM7
--CM4
``` ```
For example to build clean in debug mode: For example to build clean in debug mode:
```bash ```bash
neoecu build --debug --clean neoecu build --debug --clean
``` ```
## flash ## flash
The flash command will flash the built binaries onto a board connected over JLink. It currently doesn't support per core flashing to it will flash both binaries at once. The flash command will flash the built binaries onto a board connected over JLink. Single core flashing is done using the same arguments as build:
```bash
--CM7
--CM4
```
If no arguments are provided it defaults to flashing whatever is configured in `neoecu.toml`
## clean ## clean
The clean command cleans up all build directories in the project The clean command cleans up all build directories in the project
```{=typst}
#pagebreak()
```
# Updates
## Version 0.2.0
Complete instructions with completely neoecu tooling
## Version 0.2.1
Fixed errors:
- Incoherent instructions in export line for Zephyr SDK with x.x.x not appearing
- Incorrect mkdir command to create the `/opt/SEGGER/Jlink` directory, updated with -p flag
- Incorrect command for extracting JLink tarball, updated target to correct directory
## Version 0.2.2
Updated neoecu documentation to match neoeco v2.1.0