Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vshymanskyy/wasm2mpy
Compile WebAssembly to native MicroPython modules
https://github.com/vshymanskyy/wasm2mpy
armv7 esp32 micropython nrf52 raspberry-pi rp2040 rp2350 wasm webassembly webassembly-runtime
Last synced: 29 days ago
JSON representation
Compile WebAssembly to native MicroPython modules
- Host: GitHub
- URL: https://github.com/vshymanskyy/wasm2mpy
- Owner: vshymanskyy
- License: mit
- Created: 2024-08-24T00:41:06.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-25T07:53:54.000Z (about 1 month ago)
- Last Synced: 2024-09-29T15:04:48.860Z (about 1 month ago)
- Topics: armv7, esp32, micropython, nrf52, raspberry-pi, rp2040, rp2350, wasm, webassembly, webassembly-runtime
- Language: C
- Homepage:
- Size: 315 KB
- Stars: 105
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-micropython - wasm2mpy - Compile WebAssembly to native MicroPython `.mpy` files. Allows writing code in various statically compiled languages, and translating them to C for near-native performance. (Development / Code Generation)
README
# 
wasm2mpy
[](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
[](https://github.com/vshymanskyy/wasm2mpy/actions)
[](https://github.com/vshymanskyy/wasm2mpy)
[](https://quicknote.io/da0a7d50-bb49-11ec-936a-6d7fd5a2de08)
`wasm2mpy` enables developers to write code in statically compiled languages and run it on MicroPython-based embedded systems (such as ESP32, Raspberry Pi Pico, STM32, and nRF52) with near-native performance. Since MicroPython is relatively slow for computationally intensive applications, `wasm2mpy` provides the tools necessary to run demanding software, such as AI models and signal processing algorithms, more efficiently.
## Status
| App \ Target | x86/x64 | armv6m | armv7m/+s/+d | esp8266[^2] | esp32 | rv32imc |
|-------------------|-----------|----------|---------|----------|------------|----------|
| 🚀 TypeScript[^1] | ✅✅ | ✅ | ✅✅✅ | ⚠️[^4] | ✅ | ✅ |
| 🤩 C++ | ✅✅ | ✅ | ✅✅✅ | 🟡 | ✅ | ✅ |
| 🦀 Rust | ✅✅ | ✅ | 🟡🟡✅ | ⚠️[^4] | ✅ | ✅ |
| 🤖 TinyGo | ✅✅ | ✅ | 🟡🟡✅ | ⚠️[^4] | ✅ | ✅ |
| ⚡ Zig | ✅✅ | ✅ | ✅✅✅ | ⚠️[^4] | ✅ | ✅ |
| ✨ Virgil | ✅✅ | ✅ | ✅✅✅ | 🟡 | ✅ | ✅ |
| ⚙ WAT | ✅✅ | ✅ | ✅✅✅ | 🟡 | ✅ | ✅ |
| 🇨 Coremark | ✅✅ | 🚧 | ✅✅✅ | 🟡 | ✅ | ✅ |
✅ builds and runs OK
🟡 builds OK, doesn't run
🚧 work in progress
[^1]: [AssemblyScript](https://www.assemblyscript.org)
[^2]: `esp8266` requires the use of [`esp.set_native_code_location`](https://github.com/micropython/micropython/issues/14430#issuecomment-2332648018), and setting `WASM_PAGE_SIZE` to `8192` (or need to wait for [`WASM Custom Page Sizes`][1])
[^4]: not enough memory to run, need to wait for [`WASM Custom Page Sizes`][1]
## CoreMark results
- **ESP32-C3** 160MHz: `179.791`
- **STM32F405** 168MHz: `233.918`
- **ESP32** 240MHz: `228.363`
- **ESP32-S3** 240MHz: `271.573`
- **BL616** 320MHz: `344.293`
- **iMXRT1062** 600MHz: `1911.437`
- **i5-8250U** 1.6GHz: `18696.248`
## Upload and Run
Follow the [build instructions](BUILDING.md)
```sh
mpremote cp zig.mpy :lib/
mpremote exec "import zig; zig.setup()"
⚡ Zig is running!
```
## Run any exported function
> [!NOTE]
> This requires adding some glue code to the runtime.
> Glue code can be auto-generated, but for now it's a manual process.
For example, `test/simple.wasm` just adds 2 numbers:
```wat
(module
(func (export "add") (param i32 i32) (result i32)
(i32.add (local.get 0) (local.get 1))
)
)
```
```log
MicroPython v1.24.0-preview.224.g6c3dc0c0b on 2024-08-22; Raspberry Pi Pico W with RP2040
Type "help()" for more information.
>>> import simple
>>> simple.add(3, 4)
7
>>> simple.add(10, 6)
16
```
## Access WASM module memory
```py
>>> import cpp
>>> cpp.setup()
🤩 C++ is running!
>>> cpp._memory[4096:4096+32]
bytearray(b' Blink\x00\xf0\x9f\xa4\xa9 C++ is running!\x00\n\x00\x00\x00')
>>> new_data = b"Hello C++ world"
>>> cpp._memory[4096+12:4096+12+len(new_data)] = new_data
>>> cpp.setup()
🤩 Hello C++ world
```
## How It Works?
The idea is very similar to [embedded-wasm-apps](https://github.com/wasm3/embedded-wasm-apps):
## TODO
- [x] Support exports
- [ ] Auto-generate exports bindings
- [x] Support imports
- [x] Support memory
- [x] [Support `.a` inputs for `mpy_ld`](https://github.com/micropython/micropython/pull/15838)
- [ ] [XIP for native modules](https://github.com/micropython/micropython/pull/8381#issuecomment-2363022985)
- [ ] TBD: Support globals
- [x] Add RISC-V support: https://github.com/micropython/micropython/pull/15603
- [ ] Optimize codegen
- [ ] Use `u32` instead of `u64` for mem addresses
- [ ] Use a directly addressable `.bss` section as memory (skip indirection)
- [ ] Implement [WASM Custom Page Sizes][1]
- [ ] Implement WASM Exceptions
- [ ] Implement [WASM Stack Switching](https://github.com/WebAssembly/stack-switching/blob/main/proposals/stack-switching/Explainer.md)
## Further reading
- Discussions: [GitHub](https://github.com/orgs/micropython/discussions/15702), [Hacker News](https://news.ycombinator.com/item?id=41599579)
- [wasm2c](https://github.com/WebAssembly/wabt/blob/main/wasm2c/README.md), [w2c2](https://github.com/turbolent/w2c2)
- MicroPython [Native Modules](https://docs.micropython.org/en/latest/develop/natmod.html)
- [Feasibility of WASM for MicroPython](https://github.com/micropython/micropython/issues/15270#issuecomment-2280942885)
[1]: https://github.com/WebAssembly/custom-page-sizes/blob/main/proposals/custom-page-sizes/Overview.md