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.
Metadata
Release files for simulate-circuitpython-nativesim 3.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| simulate_circuitpython_nativesim-3.2.3.tar.gz | 8.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simulate_circuitpython_nativesim-3.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.4 kB
Release files / simulate_circuitpython_nativesim-3.2.3.tar.gz
| Download URL | simulate_circuitpython_nativesim-3.2.3.tar.gz |
|---|---|
| Size | 8.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c42e859ab0906dad01995699afa28785ff42936346088c1322c15fefa9480dd8
|
|
BLAKE2b-256 checksum How to use checksums |
01c6c59783b6e1294c0476c18079e90c40d1004d8d2b3a2b543c4609329f1729
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 5, 2026.
Transparency logRelease files / simulate_circuitpython_nativesim-3.2.3-py3-none-any.whl
| Download URL | simulate_circuitpython_nativesim-3.2.3-py3-none-any.whl |
|---|---|
| Size | 4.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
44e58ae71d98236ffcf306c24d8b00feaca38d37bf336f4509aa41f5bbcef6ab
|
|
BLAKE2b-256 checksum How to use checksums |
c455dd010fd5b5e785ecf0ca16cd6f4b6231a7148189595f26de5c8cf268f5df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 5, 2026.
Transparency log