Skip to content
play

GitHub Action

Wokwi IoT and Embedded System Simulator

v1.2.0 Latest version

Wokwi IoT and Embedded System Simulator

play

Wokwi IoT and Embedded System Simulator

This action tests your firmware builds with the Wokwi Simulator

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Wokwi IoT and Embedded System Simulator

              
  uses: wokwi/[email protected]
Learn more about this action in wokwi/wokwi-ci-action

Choose a version

wokwi-ci-action

GitHub action for using Wokwi Embedded Systems Simulator in your CI workflow.

Usage

Add the following step to your workflow:

- name: Test with Wokwi
  uses: wokwi/wokwi-ci-action@v1
  with:
    token: ${{ secrets.WOKWI_CLI_TOKEN }}
    path: / # directory with wokwi.toml, relative to repo's root
    timeout: 10000
    expect_text: 'Hello, world!'
    fail_text: 'Error'
    scenario: 'test-hello-world.yaml' # optional
    serial_log_file: 'log-hello-world.txt' # optional

You need to set the WOKWI_CLI_TOKEN secret in your repository settings. You can get the token from the Wokwi CI Dashboard.

Your repository needs to contain a wokwi.toml file that describes the simulation to run, and a diagram.json file that describes the components in the simulation and their connections. For more information, see the project config documentation.

Inputs

Name Description Default
token Wokwi CLI token
path Path to the project directory (where wokwi.toml is) /
timeout Timeout in milliseconds 10000
expect_text Text to expect in the serial output
fail_text Text that indicates a test failure
scenario Path to scenario yaml file (relative to project directory)
serial_log_file Serial log file to be written (relative to project directory) /
diagram_file Path to diagram.json file (relative to project directory) diagram.json
elf Path to the ELF file to load into the simulation (relative to project directory) wokwi.toml *

* If not specified, the action will look for the firmware or elf keys in the wokwi.toml file.