Skip to content

Commit 04d12cb

Browse files
committed
update docs for zephyr
1 parent 8de85e2 commit 04d12cb

File tree

4 files changed

+40
-13
lines changed

4 files changed

+40
-13
lines changed

documentation/Moddable SDK - Getting Started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,3 +463,4 @@ The table below links to some of the documents in the `devices` folder to help y
463463
| QCA4020 | [Using the Moddable SDK with QCA4020](./devices/qca4020/README.md)
464464
| Raspberry Pi Pico | [Using the Moddable SDK with Pico](./devices/pico.md) |
465465
| Nordic nRF52 | [Using the Moddable SDK with nRF52](./devices/nrf52.md) |
466+
| Zephyr | [Using the Moddable SDK with Zephyr](./devices/zephyr.md) |

documentation/devices/zephyr.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Using the Moddable SDK with Zephyr
22

3-
Copyright 2025 Moddable Tech, Inc.<BR>
4-
Updated: October 2, 2025
3+
Copyright 2026 Moddable Tech, Inc.<BR>
4+
Updated: January 12, 2026
55

66
This document is a guide to building apps with the Zephyr SDK.
77

@@ -162,6 +162,14 @@ The Moddable SDK build uses Zephyr SDK v4.2.0-rc1 (commit `ffb28eed`).
162162
<a id="mac-troubleshooting"></a>
163163
### Troubleshooting
164164

165+
#### Serial / USB Port
166+
Different silicon families have conenct in different ways. For many ST board, for example, the Moddable SDK build can automatically detect the correct port. For ESP boards, you specify the serial port by setting the `UPLOAD_PORT` environment variable:
167+
168+
```sh
169+
UPLOAD_PORT=/dev/tty.usbserial-1410 mcconfig -d -m -p zephyr/esp32_ethernet_kit
170+
```
171+
172+
Other silicon families may have different requirements.
165173

166174
<a id="win"></a>
167175
## Windows
@@ -324,22 +332,22 @@ mcconfig -d -m -p zephyr/nucleo_f413zh -t debug
324332
<a id="new-board"></a>
325333
## Adding a new board
326334
327-
Zephyr supports hundreds of development boards.
335+
Zephyr supports hundreds of development boards. The Moddable SDK includes support for some of them.
328336
329337
To add new board to Moddable:
330338
331339
1. Select a similar board from `$MODDABLE/build/devices/zephyr/targets` and duplicate its directory.
332340
333341
```sh
334342
cd $MODDABLE/build/devices/zephyr/targets
335-
cp -r nucleo_f413zh newboard
343+
cp -r nucleo_f413zh new_board
336344
```
337345
338-
2. Edit the `manifest.json` file and change the `ZEPHYR_BOARD` specifier to match the Zephyr board name (same as "newboard" above).).
346+
2. Edit the `manifest.json` file and change the `ZEPHYR_BOARD` specifier to match the Zephyr board name (same as "new_board" above). The `ZEPHYR_BOARD` must match the name used in the Zephyr SDK for your board.
339347
340348
3. Use the new target:
341349
342350
```sh
343351
cd $MODDABLE/examples/helloworld
344-
mcconfig -d -m -p zephyr/newboard
352+
mcconfig -d -m -p zephyr/new_board
345353
```

documentation/readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Moddable SDK – Documentation Overview
2-
Copyright 2019-2023 Moddable Tech, Inc.<BR>
3-
Revised: April 6, 2023
2+
Copyright 2019-2026 Moddable Tech, Inc.<BR>
3+
Revised: January 12, 2026
44

55
This directory contains documentation for the Moddable SDK.
66

@@ -16,6 +16,7 @@ Guides for working with specific microcontrollers supported by the Moddable SDK
1616
- [QCA4020](./devices/qca4020/README.md) by Qualcomm
1717
- [Pico](./devices/pico.md) by Raspberry Pi
1818
- [nRF52](./devices/nrf52.md) by Nordic Semiconductor
19+
- [Zephyr](./devices/zephyr.md) by Zephyr Project
1920

2021
### API Documentation for Modules
2122

readme.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Moddable SDK
22

3-
Copyright 2017-2025 Moddable Tech, Inc.<BR>
4-
Revised: June 11, 2025
3+
Copyright 2017-2026 Moddable Tech, Inc.<BR>
4+
Revised: January 12, 2026
55

66
## Modern software development for microcontrollers
77

@@ -105,11 +105,11 @@ The Moddable SDK supports [many devices](./documentation/devices/esp32.md#platfo
105105

106106
| | | |
107107
| :---: | :---: | :---: |
108-
| <a href="./documentation/devices/moddable-two.md"><img src="./documentation/assets/devices/moddable-two.png" width=125></a><BR>Moddable Two<sup>[[8](#footnotes3)]</sup> | <a href="./documentation/devices/esp32.md">![ESP32](./documentation/assets/devices/esp32.png)</a><BR>Node MCU ESP32<sup>[[9](#footnotes3)]</sup> | <a href="./documentation/devices/esp32.md#platforms">![M5Stack](./documentation/assets/devices/m5stack.png)</a><BR>M5Stack
108+
| <a href="./documentation/devices/moddable-six.md"><img src="./documentation/assets/devices/moddable-six.png" width=125></a><BR>Moddable Six<sup>[[8](#footnotes3)]</sup> | <a href="./documentation/devices/esp32.md">![ESP32](./documentation/assets/devices/esp32.png)</a><BR>Node MCU ESP32<sup>[[9](#footnotes3)]</sup> | <a href="./documentation/devices/esp32.md#platforms">![M5Stack](./documentation/assets/devices/m5stack.png)</a><BR>M5Stack
109109
| <a href="./documentation/devices/esp32.md#platforms">![M5Stack Fire](./documentation/assets/devices/m5stack-fire.png)</a><BR>M5Stack Fire | <a href="./documentation/devices/esp32.md#platforms">![M5Stick C](./documentation/assets/devices/m5stick-c.png)</a><BR>M5Stick C | <a href="./documentation/devices/esp32.md#platforms">![M5Atom](./documentation/assets/devices/m5atom.png)</a><BR>M5Atom Matrix
110110

111111
<a id="footnotes3"></a>
112-
> <sup>[8]</sup> *See also: [Moddable Two Developer Guide](./documentation/devices/moddable-two.md), Moddable [product page](https://www.moddable.com/product)*<BR>
112+
> <sup>[8]</sup> *See also: [Moddable Six Developer Guide](./documentation/devices/moddable-six.md), Moddable [product page](https://www.moddable.com/product)*<BR>
113113
<sup>[9]</sup> *See also: [Using the Moddable SDK with ESP32](./documentation/devices/esp32.md)*<BR>
114114
115115
### Pico by Raspberry Pi
@@ -179,6 +179,21 @@ The following developer resources are also available:
179179
- [QCA4020 Getting Started with the Moddable SDK](https://developer.qualcomm.com/project/qca4020-getting-started-moddable-sdk) blog post on the Qualcomm Developer Network
180180
- [QCA4020 Modern UI Application Development with the Moddable SDK](https://developer.qualcomm.com/project/qca4020-modern-ui-application-development-moddable-sdk) blog post on the Qualcomm Developer Network
181181

182+
### Zephyr RTOS
183+
184+
To use the Moddable SDK with Zephyr-based devices, you need to:
185+
186+
1. Install the [Moddable SDK](./documentation/Moddable%20SDK%20-%20Getting%20Started.md)
187+
2. Install [Zephyr tools](./documentation/devices/zephyr.md)
188+
189+
The Moddable SDK supports [many devices](./documentation/devices/zephyr.md#platforms) built on Zephyr RTOS. To see a full list, run:
190+
191+
```sh
192+
ls $MODDABLE/devices/zephyr/targets
193+
```
194+
195+
You can also add your own Zephyr devices by following the instructions in the [Zephyr documentation](./documentation/devices/zephyr.md#new-board).
196+
182197
### WebAssembly (Wasm)
183198

184199
<a href="./documentation/devices/wasm.md">![](./documentation/assets/devices/wasm.gif)</a>
@@ -196,6 +211,8 @@ To use the Moddable SDK with WebAssembly, you need to:
196211

197212
We have tested a variety of SPI displays with the ESP8266 and ESP32. Video demonstrations of these displays are [on our website](http://www.moddable.com/display). Wiring guides are available in the [documentation/displays](./documentation/displays) directory. The source code for the corresponding display and touch drivers is available in the [modules/drivers](./modules/drivers) directory.
198213

214+
On the Zephyr RTOS, there is a single Moddable SDK [display driver](modules/io/display/zephyr/display.c) for all displays supported by Zephyr. The driver has been tested with displays that have 16-bit pixels. It may need to be modified to work with displays that use other pixel formats.
215+
199216
## Source tree
200217

201218
The Moddable SDK repository contains the following top level directories:
@@ -246,6 +263,6 @@ To learn more about Moddable, see [our website](http://www.moddable.com).
246263

247264
For companies interested in the benefits of using JavaScript and the Moddable SDK to power your products, Moddable provides consulting services to help you get started. We're available to help with design, implementation, training, and support.
248265

249-
You can also reach out to us on Twitter ([@moddabletech](https://twitter.com/moddabletech)). Following us on Twitter is the best way to keep up with what we’re doing—we post announcements about new blog posts there, along with other Moddable news.
266+
You can also reach out to us on X (aka Twitter) ([@moddabletech](https://twitter.com/moddabletech)). Following us is the best way to keep up with what we’re doing—we post announcements about new blog posts there, along with other Moddable news.
250267

251268
You can contact us directly by e-mail at [info@moddable.com](mailto:info@moddable.com).

0 commit comments

Comments
 (0)