Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lupyuen/bl602-simulator
BL602 / BL604 Simulator in WebAssembly
https://github.com/lupyuen/bl602-simulator
bl602 embedded riscv rust webassembly
Last synced: about 1 month ago
JSON representation
BL602 / BL604 Simulator in WebAssembly
- Host: GitHub
- URL: https://github.com/lupyuen/bl602-simulator
- Owner: lupyuen
- License: apache-2.0
- Created: 2021-08-05T05:04:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-08T12:28:45.000Z (about 3 years ago)
- Last Synced: 2024-05-01T12:44:09.630Z (8 months ago)
- Topics: bl602, embedded, riscv, rust, webassembly
- Language: Shell
- Homepage: https://lupyuen.github.io/articles/rustsim
- Size: 113 MB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# BL602 / BL604 Simulator in WebAssembly
Try it here: https://lupyuen.github.io/bl602-simulator/
Read the article...
- [__"Rust on RISC-V BL602: Simulated with WebAssembly"__](https://lupyuen.github.io/articles/rustsim)
Follow the updates on Twitter: https://twitter.com/MisterTechBlog/status/1423169766080933891
Let's __Simulate BL602 / BL604 Rust Firmware__ in a Web Browser with __WebAssembly__...
1. We take this BL602 / BL604 __Blinky Firmware in Rust__...
- [__Rust Blinky Firmware for BL602__](sdk_app_rust_gpio/rust/src/lib.rs)
1. Which calls the __Rust Wrapper for BL602 IoT SDK__...
- [__Rust Wrapper for BL602 IoT SDK__](https://crates.io/crates/bl602-sdk)
1. We __compile to WebAssembly__ the Rust Firmware and Rust Wrapper
1. In WebAssembly we __intercept calls to BL602 IoT SDK__ with __Shim Functions__
(Like for the BL602 GPIO HAL)
- [__Rust Shim Functions for BL602 Simulator__](bl602-simulator/src/lib.rs)
1. Add a __Simulator UI (HTML + JavaScript)__ to simulate a __PineCone BL602__ or __PineDio Stack BL604__...
- [__“Simulate RISC-V BL602 with WebAssembly, uLisp and Blockly”__](https://lupyuen.github.io/articles/wasm)
(Without the Blockly part, since we can't compile Rust in a Web Browser)
Why do this in __Rust__?
- Because we have already __parsed the BL602 IoT SDK interfaces__ with `bindgen`
(While creating the BL602 Rust Wrapper)
- Which lets us __manipulate the BL602 SDK interfaces__ with Rust in interesting ways
(Like our `safe_wrap` Procedural Macro in Rust)
- More about __BL602 Rust Wrapper__...
- [__"Rust on RISC-V BL602: Is It Sunny?"__](https://lupyuen.github.io/articles/adc)
# Why Simulate BL602 / BL604 Firmware?
Why are we doing this? What __problem are we solving__?
1. Shorten the __Code - Build - Flash - Test Cycle__ for BL602 and BL604
(Because flashing BL602 via UART is kinda cumbersome)
1. We could potentially catch __BL602 SDK Calling Errors__ for new devs and __explain the errors in a friendly way__
(Invalid parameters or usage, like reading a GPIO Pin configured for output)
1. Make it easier to __Learn Embedded Programming__
(Even without any Embedded Hardware)
1. __Automated Testing__ of BL602 Firmware
1. __Trace Calls to BL602 IoT SDK__ for debugging
We might be able to __Simulate C Firmware__ too, if we...
- Tweak the BL602 C Firmware to __build with Emscripten__
- And call the __Shim Functions__
# Build BL602 / BL604 Rust Firmware for WebAssembly
To compile BL602 Rust Firmware into WebAssembly...
```bash
# Configure emscripten. See https://emscripten.org/docs/getting_started/downloads.html
# For Windows: emsdk\emsdk_env.bat
. ~/emsdk/emsdk_env.sh
# Download source code
git clone --recursive https://github.com/lupyuen/bl602-simulator
cd bl602-simulator
# Compile the Rust Firmware, Rust Simulator Library and link with Emscripten
make
# Produces outputs in the `docs` folder: wasm.js, wasm.wasm
```
# Run BL602 / BL604 Simulator with WebAssembly
To run the BL602 Simulator...
1. Start a __Local Web Server__
[(Like Web Server for Chrome)](https://chrome.google.com/webstore/detail/web-server-for-chrome/ofhbbkphhbklhfoeikjpcbhemlocgigb/overview)
1. Browse to __`docs/wasm.html`__
1. Click __`Run`__
# Build Log
```text
# Build the Rust Firmware and Rust Simulator Library
cargo build --target wasm32-unknown-emscripten
Compiling proc-macro2 v1.0.28
Compiling unicode-xid v0.2.2
Compiling syn v1.0.74
Compiling memchr v2.4.0
Compiling serde_derive v1.0.127
Compiling cty v0.2.1
Compiling serde v1.0.127
Compiling ryu v1.0.5
Compiling heapless v0.7.4
Compiling rustc-serialize v0.3.24
Compiling lazy_static v1.4.0
Compiling serde_json v1.0.66
Compiling cstr_core v0.2.4
Compiling quote v1.0.9
Compiling bl602-macros v0.0.2
Compiling bl602-sdk v0.0.6
Compiling app v0.0.1 (/mnt/c/pinecone/bl602-simulator/sdk_app_rust_gpio/rust)
Compiling bl602-simulator v0.0.1 (/mnt/c/pinecone/bl602-simulator/bl602-simulator)
Finished dev [unoptimized + debuginfo] target(s) in 1m 43s
# Link the Rust Firmware and Rust Simulator Library with Emscripten
emcc -o wasm/wasm.html \
target/wasm32-unknown-emscripten/debug/libapp.a \
target/wasm32-unknown-emscripten/debug/libbl602_simulator.a \
wasm/wasm.o \
-g \
-s WASM=1 \
-s DISABLE_EXCEPTION_CATCHING=0 \
-s "EXPORTED_FUNCTIONS=[ '_rust_main', '_clear_simulation_events', '_get_simulation_events' ]" \
-s "EXTRA_EXPORTED_RUNTIME_METHODS=[ 'cwrap', 'allocate', 'intArrayFromString', 'UTF8ToString' ]"
# Copy the WebAssembly outputs to the docs folder for GitHub Pages
cp wasm/wasm.js docs
cp wasm/wasm.wasm docs
```