Simulate CircuitPython using Zephyr simulator
Project description
simulate-circuitpython-nativesim
Simulate CircuitPython using Zephyr simulator
prepare-system
Prepare the runner for the simulator (and possible build process)
Inputs
None
Outputs
None
build-firmware
Build the nativesim firmware (or use a cached version if available)
Inputs
| Argument Name | Description | Default | Notes |
|---|---|---|---|
version |
Version of CircuitPython to simulate | latest |
Must be a version that supports the Zephyr OS native sim |
circuitpython-folder |
Folder name to use for the CircuitPython checkout | cpysim |
Change this if it conflicts with another file/folder |
firmware-filepath |
Filepath for the built firmware | ./firmware.exe |
Outputs
| Argument Name | Description | Notes |
|---|---|---|
restored |
Whether the firmware was restored from cache |
download-firmware
Download the Zephyer simulator firmware
Inputs
| Argument Name | Description | Default | Notes |
|---|---|---|---|
version |
Version of CircuitPython to simulate | latest |
Must be a version that supports the Zephyr OS native sim |
firmware-filepath |
Filepath for the downloaded firmware | ./firmware.exe |
Outputs
| Argument Name | Description | Notes |
|---|---|---|
version |
The firmware version downloaded |
prepare-circuitpy
Prepare the CIRCUITPY folder
Inputs
| Argument Name | Description | Default | Notes |
|---|---|---|---|
code-py |
Filepath for the desired code.py file | '' |
|
dependencies-file |
Filepath for a dependency file for circup | '' |
|
version |
The version of CircuitPython to use (if dependencies given) | latest |
|
circuitpyn |
Filepath to the CIRCUITPY folder to be created | CIRCUITPY |
Outputs
None
prepare-flash
Prepare the flash space for the simulator
Inputs
| Argument Name | Description | Default | Notes |
|---|---|---|---|
flash-filepath |
Filepath for the desired flash binary file | ./flash.bin |
|
circuitpy |
Filepath to file or folder of files to add to the simualted CIRCUITPY | N/A (required) |
Outputs
None
simulate
Run the simulator
Inputs
| Argument Name | Description | Default | Notes |
|---|---|---|---|
firmware-filepath |
Filepath for the built firmware | ./firmware.exe |
|
flash-filepath |
Filepath for the desired flash binary file | ./flash.bin |
Outputs
| Argument Name | Description | Notes |
|---|---|---|
output-text |
The text output from the simulator |
License
This library is available under an MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file simulate_circuitpython_nativesim-3.2.0.tar.gz.
File metadata
- Download URL: simulate_circuitpython_nativesim-3.2.0.tar.gz
- Upload date:
- Size: 8.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
120453e88a032d2b19386d89894cb77af9f4b3ebeddf71b322a983eb09a6f661
|
|
| MD5 |
5b32d27f677602e70611bf4d3714b207
|
|
| BLAKE2b-256 |
da409f8a624b114a2b0386bd87dfb4c159f5d55824ae42e177be61ab7a3a1307
|
Provenance
The following attestation bundles were made for simulate_circuitpython_nativesim-3.2.0.tar.gz:
Publisher:
publish.yml on tekktrik/simulate-circuitpython-nativesim
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
simulate_circuitpython_nativesim-3.2.0.tar.gz -
Subject digest:
120453e88a032d2b19386d89894cb77af9f4b3ebeddf71b322a983eb09a6f661 - Sigstore transparency entry: 1439009176
- Sigstore integration time:
-
Permalink:
tekktrik/simulate-circuitpython-nativesim@0bd045fa73a6d9196d6ca66a03bc2b351cf449f8 -
Branch / Tag:
refs/tags/v3.2.0 - Owner: https://github.com/tekktrik
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0bd045fa73a6d9196d6ca66a03bc2b351cf449f8 -
Trigger Event:
release
-
Statement type:
File details
Details for the file simulate_circuitpython_nativesim-3.2.0-py3-none-any.whl.
File metadata
- Download URL: simulate_circuitpython_nativesim-3.2.0-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
88cd5f79975cdb1aed0009247d2afe0896d020cd18c5a14caa07f4e92fe1211a
|
|
| MD5 |
57233fe3d2ace97606cfff62ca68d08e
|
|
| BLAKE2b-256 |
e140e7a18a6d36d0af76bdba4078cedea0aedfd6867184b5a8ff1d06d40745b9
|
Provenance
The following attestation bundles were made for simulate_circuitpython_nativesim-3.2.0-py3-none-any.whl:
Publisher:
publish.yml on tekktrik/simulate-circuitpython-nativesim
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
simulate_circuitpython_nativesim-3.2.0-py3-none-any.whl -
Subject digest:
88cd5f79975cdb1aed0009247d2afe0896d020cd18c5a14caa07f4e92fe1211a - Sigstore transparency entry: 1439009195
- Sigstore integration time:
-
Permalink:
tekktrik/simulate-circuitpython-nativesim@0bd045fa73a6d9196d6ca66a03bc2b351cf449f8 -
Branch / Tag:
refs/tags/v3.2.0 - Owner: https://github.com/tekktrik
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0bd045fa73a6d9196d6ca66a03bc2b351cf449f8 -
Trigger Event:
release
-
Statement type:
