Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microbit-foundation/micropython-microbit-v2-simulator

Wasm-based MicroPython micro:bit v2 simulator
https://github.com/microbit-foundation/micropython-microbit-v2-simulator

microbit micropython

Last synced: about 2 months ago
JSON representation

Wasm-based MicroPython micro:bit v2 simulator

Host: GitHub
URL: https://github.com/microbit-foundation/micropython-microbit-v2-simulator
Owner: microbit-foundation
License: mit
Created: 2022-03-14T12:18:51.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-04-15T11:07:42.000Z (9 months ago)
Last Synced: 2024-04-22T20:22:26.163Z (9 months ago)
Topics: microbit, micropython
Language: JavaScript
Homepage: https://python-simulator.usermbit.org/v/0.1/demo.html
Size: 386 KB
Stars: 12
Watchers: 8
Forks: 9
Open Issues: 11
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# MicroPython-micro:bit simulator

## Try it out

To try the simulator use the [micro:bit Python Editor](https://python.microbit.org).

The rest of this page explains how to embed the simulator in an application
and develop the simulator software.

## License

This software is under the MIT open source license.

[SPDX-License-Identifier: MIT](LICENSE)

## Embedding

The simulator is designed to be embedded into other web applications
as an iframe. The embedding API and URLs are not yet stable and are
subject to change. If you are interested in embedding the simulator
in your application please [get in touch](mailto:[email protected]).

The URL to embed is https://python-simulator.usermbit.org/v/0.1/simulator.html.
You can embed this in your application directly. We would love to hear about
your use of the simulator so please open an issue to get in touch.

The iframe provides the micro:bit board user interface and some limited
interactions. It does not provide a terminal for serial/the REPL or any UI to change the board sensor state.

A value for a brand color can be passed to the simulator via a query
string and is used to style the play button. E.g., https://python-simulator.usermbit.org/v/0.1/simulator.html?color=blue

[demo.html](./src/demo.html) is an example of embedding the simulator.
It connects the iframe to a terminal and provides a simple interface for
sensors.

The following sections document the messages supported by the iframe embed
via postMessage.

### Messages sent to parent window from iframe

These messages are sent as the result of user interactions or actions taken
by the running program. The simulator starts stopped with no program flashed.

Kind
Example
Description

ready

```javascript
{
"kind": "ready",
"state": {
"lightLevel": {
"id": "lightLevel",
"type": "range",
"min": 0,
"max": 255
},
"soundLevel": {
"id": "soundLevel",
"type": "range",
"min": 0,
"max": 255
// Microphone sensor only:
"lowThreshold": 50,
"highThreshold": 150
}
// Full state continues here.
}
}
```

Sent when the simulator is ready for input. Includes a description of the available sensors.

sensor_change

```javascript
{
"kind": "state_change",
"change": {
"soundLevel": {
"id": "soundLevel",
"type": "range",
"min": 0,
"max": 255
// Microphone sensor only:
"lowThreshold": 50,
"highThreshold": 150
}
// Optionally, further keys here.
}
]
}
```

Sent when the simulator state changes. The keys are a subset of the original state. The values are always sent in full.

request_flash

```javascript
{
"kind": "request_flash",
}
```

Sent when the user requests the simulator starts. The embedder should flash the latest code via the flash message.

serial_output

```javascript
{
"kind": "serial_output",
"data": "text"
}
```

Serial output suitable for a terminal or other use.

radio_output

```javascript
{
"kind": "radio_output",
"data": new Uint8Array([])
}
```

Radio output (sent from the user's program) as bytes.
If you send string data from the program then it will be prepended with the three bytes 0x01, 0x00, 0x01.

internal_error

```javascript
{
"kind": "internal_error",
"error": new Error()
}
```

A debug message sent for internal (unexpected) errors thrown by the simulator. Suitable for application-level logging. Please raise issues in this project as these indicate a bug in the simulator.

### Messages you can send to the iframe from the embedding app

Kind
Example
Description

flash

```javascript
{
"kind": "flash",
"filesystem": {
"main.py":
new TextEncoder()
.encode("# your program here")
}
}
```

Update the micro:bit filesystem and restart the program. You must send this in response to the request_flash message.

stop

```javascript
{
"kind": "stop"
}
```

Stop the program.

reset

```javascript
{
"kind": "reset"
}
```

Reset the program.

mute

```javascript
{
"kind": "mute"
}
```

Mute the simulator.

unmute

```javascript
{
"kind": "unmute"
}
```

Unmute the simulator.

serial_input

```javascript
{
"kind": "serial_input",
"data": "text"
}
```

Serial input. If the REPL is active it will echo this text via serial_write.

sensor_set

```javascript
{
"kind": "set_value",
"id": "lightLevel",
"value": 255
}
```

Set a sensor, button or pin value. The sensor, button or pin is identified by the top-level key in the state. Buttons and pins (touch state) have 0 and 1 values. In future, analog values will be supported for pins.

radio_input

```javascript
{
"kind": "radio_input",
"data": new Uint8Array([])
}
```

Radio input (received by the user's program as if sent from another micro:bit) as bytes.
If you want to send string data then prepend the byte array with the three bytes 0x01, 0x00, 0x01.
Otherwise, the user will need to use radio.receive_bytes or radio.receive_full. The input is assumed to be sent to the currently configured radio group.

## Developing the simulator

### Build steps

The simulator is a variant of the MicroPython codal_port which is compiled with
Emscripten. It provides a simulated micro:bit (including REPL) in the browser.

To build, first fetch the submodules (don't use recursive fetch):

$ git submodule update --init lib/micropython-microbit-v2
$ git -C lib/micropython-microbit-v2 submodule update --init lib/micropython

Then run (from this top-level directory):

$ make

Once it is built the pages in build/ need to be served, e.g. via:

$ npx serve build

View at http://localhost:3000/demo.html

$ (cd build && python -m http.server)

View at http://localhost:8000/demo.html

### Branch deployments

There is a CloudFlare pages based build for development purposes only. Do not
embed the simulator via this URL as it may be removed at any time. CloudFlare's
GitHub integration will comment on PRs with deployment details.

Branches in this repository are also deployed via CircleCI to https://review-python-simulator.usermbit.org/{branchName}/. This requires the user pushing code to have
permissions for the relevant Micro:bit Educational Foundation infrastructure.

Similarly, the main branch is deployed to https://python-simulator.usermbit.org/staging/.

Tagged releases with a `v` prefix are deployed to https://python-simulator.usermbit.org/v/{number}/

### Upgrading micropython-microbit-v2

1. Update the lib/micropython-microbit-v2 to the relevant hash. Make sure that its lib/micropython submodule is updated (see checkout instructions above).
2. Review the full diff for micropython-microbit-v2. In particular, note changes to:
1. main.c, src/Makefile and mpconfigport.h all which have simulator versions that may need updates
2. the HAL, which may require implementing in the simulator
3. the filesystem, which has a JavaScript implementation.

### Web Assembly debugging

Steps for WASM debugging in Chrome:

- Add the source folder in dev tools
- Install the C/C++ debug extension: https://helpgoo.gle/wasm-debugging-extension
- Enable "WebAssembly Debugging: Enable DWARF support" in DevTools Experiments
- DEBUG=1 make

## Code of Conduct

Trust, partnership, simplicity and passion are our core values we live and
breathe in our daily work life and within our projects. Our open-source
projects are no exception. We have an active community which spans the globe
and we welcome and encourage participation and contributions to our projects
by everyone. We work to foster a positive, open, inclusive and supportive
environment and trust that our community respects the micro:bit code of
conduct. Please see our [code of conduct](https://microbit.org/safeguarding/)
which outlines our expectations for all those that participate in our
community and details on how to report any concerns and what would happen
should breaches occur.