Skip to content

Commit 03acb5a

Browse files
committed
Update the README.md with the new automatic workflow
1 parent 132624c commit 03acb5a

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

README.md

+25-20
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,19 @@ Unlike traditional Arduino implementations, where the final output is a standalo
8080

8181
The `loader` is responsible for managing the interaction between your sketches and the underlying Zephyr system. After the initial bootloader installation, the `loader` takes over the sketch loading process automatically.
8282

83-
To ensure flexibility, the `loader` project is designed to be generic. Any necessary modifications for specific boards should be made in the corresponding `DTS overlay` or a special `fixup` file, using appropriate guards to maintain stability.
83+
To ensure flexibility, the `loader` project is designed to be generic. Any necessary modifications for specific boards should be made in the corresponding "DTS overlay" or a special "fixup" file, using appropriate guards to maintain compatibility.
8484

85-
The behavior of the `loader` can be adjusted through the `Mode` menu:
85+
The behavior of the `loader` can be adjusted through the `Mode` menu of the IDE:
8686
- `Standard`: The sketch is loaded automatically.
8787
- `Debug`: The user must type `sketch` in Zephyr's shell, which is accessible via the default Serial.
8888

8989
The most important components of this project are:
9090

9191
* [Zephyr based loader](/loader)
9292
* [LLEXT](https://docs.zephyrproject.org/latest/services/llext/index.html)
93-
* [Actual core](/cores/arduino) with [variants](/variants) and the usual `{platform,boards}.txt`
93+
* [Actual core](/cores/arduino) with [variants](/variants) and the usual [platform](/platform.txt) and [boards](/boards) files
9494
* [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API)
95-
* [post_build_tool](/extra/post_build_tool)
95+
* [zephyr-sketch-tool](/extra/zephyr-sketch-tool)
9696

9797
## 🛠️ Setup the environment
9898

@@ -105,6 +105,11 @@ Shell scripts are available to simplify the installation process (Windows is not
105105
mkdir my_new_zephyr_folder && cd my_new_zephyr_folder
106106
git clone https://github.com/arduino/ArduinoCore-zephyr
107107
```
108+
### Shortcut: using the Core in Arduino IDE/CLI without installing Zephyr
109+
110+
To help core developers who might not be interested at all in setting up a full Zephyr build system, we are providing [sync-zephyr-artifacts](/extra/sync-zephyr-artifacts) utility. After compiling it via `go build`, run as `sync-zephyr-artifacts .` to retrieve the files needed to compile sketches and flash the loader.
111+
Next, follow the instructions in [Using the Core in Arduino IDE/CLI](#using-the-core-in-arduino-ide-cli) to finish the set-up.
112+
108113
### Pre-requirements
109114
Before running the installation script, ensure that Python, `pip` and `venv` are installed on your system. The script will automatically install `west` and manage the necessary dependencies.
110115

@@ -124,7 +129,9 @@ download all packages required for a Zephyr build in addition to the toolchains
124129
in the Zephyr SDK.
125130

126131
> [!NOTE]
127-
> This core is validated with version v0.17.0. Compatibility with later versions has not been tested yet.
132+
> This core is validated with version v0.17.0 of the SDK. Compatibility with later versions has not been tested yet.
133+
134+
## 🛠️ Regenerate the core from Zephyr sources
128135

129136
### Build the Loader
130137

@@ -154,29 +161,27 @@ If the board is fully supported by Zephyr, you can flash the firmware directly o
154161
```bash
155162
west flash
156163
```
164+
This can also be performed via the "Burn bootloader" action in the IDE if the core is properly installed, as detailed below.
157165

158166
### Using the Core in Arduino IDE/CLI
159167

160-
After running the `bootstrap` script, you can symlink the core to `$sketchbook/hardware/arduino-git/zephyr`. Once linked, it will appear in the IDE/CLI, and the board's Fully Qualified Board Name (FQBN) will be formatted as `arduino-git:zephyr:name_from_boards_txt`.
161-
162-
### Using the Core in Arduino IDE/CLI (without installing Zephyr toolchain)
163-
164-
To help core developers (who might not be interested at all in setting up a full Zephyr build system) we are providing [sync-zephyr-artifacts](/extra/sync-zephyr-artifacts) utility. After compiling it via `go build`, run as `sync-zephyr-artifacts .` to retrieve the files needed to compile sketches and flash the loader.
168+
After running the `bootstrap.sh` script, you can symlink the core to `$sketchbook/hardware/arduino-git/zephyr`. Once linked, it will appear in the IDE/CLI, and the board's Fully Qualified Board Name (FQBN) will be formatted as `arduino-git:zephyr:name_from_boards_txt`.
165169

166-
## 🚀 Adding a new target
170+
### 🚀 Adding a new target
167171

168-
To add a new board that is already supported by mainline Zephyr, follow these steps:
172+
To add a new board that is already supported by mainline Zephyr with the target `$your_board`, follow these steps:
169173

170-
* Create the `DTS overlay` and `.conf` files in the [loader](/loader/boards) directory.
174+
* Get the variant name from your board by running `extra/get_variant_name.sh $your_board`.
175+
* Create a folder in the [`variants/`](/variants) directory with the same name as the variant for your new board.
176+
* Create the DTS `<variant>.overlay` and Kconfig `<variant>.conf` files in that directory.
171177
The overlay must include:
172178
* A flash partition called `user_sketch`, tipically located near the end of the flash.
173179
* A `zephyr,user` section containing the description for GPIOs, Analog, UART, SPI and I2C devices. Feel free to leave some fields empty in case Zephyr support is missing. This will result in some APIs not being available at runtime (eg. `analogWrite` if PWM section is empty).
174-
* Build the Loader: run `./extra.build.sh $your_board $your_board` and start debugging the errors. :grin:
180+
The Kconfig file must include any board-specific options required by this target.
181+
* Build the Loader: run `./extra/build.sh $your_board` (with any additional arguments as required) and start debugging the errors. :grin:
175182
* Update the `boards.txt`: add an entry for your board, manually filling the required fields.
176-
* Implement touch support: if your board supports the `1200bps touch` method, implement `_on_1200_bps` in a file located inside the `variant/your_board` folder.
177-
* ⏳ Temporary steps
178-
* Create `includes.txt` based on `llext-edk/Makefile.cflags`, taking inspiration for other variants.
179-
* Amend `your_board.compiler.zephyr.*` with information from `llext-edk/Makefile.cflags`.
183+
In particular, set `build.zephyr_target` and `build.zephyr_args` to the arguments used in the `build.sh` call, and `build.variant` to the variant name identified above.
184+
* Implement touch support: if your board supports the "1200bps touch" method, implement `_on_1200_bps` in a file located inside the variant folder of your board.
180185

181186
## 🐛 Bug Reporting
182187

@@ -194,10 +199,10 @@ Contributions are always welcome. The preferred way to receive code contribution
194199
- [x] Unify overlay in [loader](/loader/boards) with the one provided in [variant](/variant) for interoperability with GSoC project
195200
- [x] Autogenerate `defines.txt`, `includes.txt`, `cflags.txt` from `llext-edk` output
196201
- [x] Network: support UDP and TLS
197-
- [ ] USB: switch to USB_DEVICE_STACK_NEXT to support PluggableUSB
202+
- [ ] USB: switch to `USB_DEVICE_STACK_NEXT` to support PluggableUSB
198203
- [ ] Relocate RODATA in flash to accomodate sketches with large assets
199204
- [ ] Provide better error reporting for failed llext operations
200-
- [ ] Replace [llext_exports.c](/loader/llext_exports.c) with proper symbols generation (via includes)
205+
- [ ] Replace [`llext_exports.c`](/loader/llext_exports.c) with proper symbols generation (via includes)
201206
- [x] Provide better usability for `Debug` builds (eg. shell over USB)
202207
- [ ] Fix corner cases with `std::` includes (like `<iterator>`)
203208
- [ ] Get rid of all warnings

0 commit comments

Comments
 (0)