wokwi / wokwi-boards

Custom board definitions for wokwi.com

wokwi-boards

Definition for the boards supported on wokwi.com.

See boards/esp32-devkit-v1/board.json for an example.

Board contribution guidelines

Please review the contribution guidelines before submitting a new board definition.

Testing a custom board

1. Create a new project on wokwi
2. Click inside the code editor, press "F1" and choose "Load custom board file..."
3. Select the directory that contains the board definition files (board.json and board.svg)
4. The board should load into Wokwi. Check the browser JavaScript console for any error messages.
5. Paste the following code into the diagram.json file:

{
  "version": 1,
  "author": "Ambitious maker",
  "editor": "wokwi",
  "parts": [{ "type": "wokwi-custom-board", "id": "board" }],
  "connections": []
}

Your custom board should appear in the diagram editor. You can test the pin out, connect external components to it, and even start the simulation.

wokwi-boards's Issues

esp32-s3 micropython fail

How can I use the ESP32-S3 development board and a custom MicroPython image without encountering startup errors?

error msg

mode:DIO, clock div:1
load:0x3fce3810,len:0xf8c
load:0x403c9700,len:0xb3c
load:0x403cc700,len:0x2dd4
SHA-256 comparison failed:
Calculated: 2aa7a6e666276c5e883d1857335d26b255b8084d17eb005758125e5a09cccfe0
Expected: 8a44d662a8bf8b449e4fed0ba7de4e2f4b89af831d9e77d09a76c993bbbf1a37
Attempting to boot anyway...
entry 0x403c989c
�[0;31mE (9722) flash_parts: partition 3 invalid - offset 0x200000 size 0x600000 exceeds flash chip size 0x400000�[0m
�[0;31mE (9724) boot: Failed to verify partition table�[0m
�[0;31mE (9727) boot: load partition table error!�[0m
ESP-ROM:esp32s3-20210327
Build:Mar 27 2021
rst:0x1 (POWERON),boot:0x8 (SPI_FAST_FLASH_BOOT)
SPIWP:0xee

fireware:https://micropython.org/resources/firmware/ESP32_GENERIC_S3-20231227-v1.22.0.bin

Not an issue / feature request - I would update the guidelines for PR to add custom boards

I would love to see a specific guideline with these fields that must be added when doing a custom board PR.

Requirements for PR:

1. Title Name, could be saved as a simple txt file named "title.txt" so it can be read easily by other systems, like auto generated page
   Example: AITEWIN ROBOT ESP32-C3 SuperMini
2. Unique name, is the folder name, could be constructed like this: manufacturer_name-board_name-revision_or_model_name
   Would be: aitewin_robot-esp32_c3-supermini
3. board.svg
4. board.json
5. diagram.png / jpeg / gif / webp (Pinout Overview Image)
6. purchase.csv (List with "Site Name" and "Link to buy")
   Example:
   Aliexpress,https://www.aliexpress.com/item/1005005757810089.html
Ebay,https://www.ebay.com/itm/276300462231
Temu,https://www.temu.com/dk/esp32-c3-development-board-esp32-supermini-wifi-wireless-g-601099534456789.html

Feature request:
Add the option to add a "diagram.png / jpeg / gif / webp", then add the "?" above the board like some other components have in Wokwi interface and when clicking it, it will show a new page auto generated from the content of the custom board folder so it will show the Title Name as the page title, below that the board.svg, then the diagram.png (or one of the other file types) and then the board.json, and finally a list where to buy, read from the CSV.

This way if a board gets updated on GitHub, the website is automatically updated with the latest info as the PR gets approved. This way you can have more people helping maintaining information without actually doing any work except making sure no sneaky website have been added by a nefarious player before approving PR.

Licence

As of current, this repository has no licence file. This means that any submitted code or svgs are still technically the property of the original creator, rather than open source files. Should a licence be added to this repository?

Nucleo 64 E5V, GND markings are off

They should be moved one grid unit below:

Custom board in VScode

Is it possible to display a custom board in the VScode extension?

Graphically I was thinking of connecting lines directly to the chip legs (and maybe just having my custom board outline around it).

This way it would be easier to visually correlate mcu pins with the datasheet.

u-blox nina W106

Sir
Can you add in you list the U-BLOX NINA W106?
Here the files
Today is to the BASIC ANNEX ENVIRONMENT...please modify it to be able to use with all other environments of WOKWI
esp32-nina-w10x.zip

Thanks
Miguel Alexandre Wisintainer

USER_BTN on the NUCLEO C031C6 ?

On the NUCLEO C031C6 board, the USER_BTN ( blue one on PC13 ) does not seem to work and, as far as I can tell from the board svg/json, is seems not implemented.
Is there a way to make it work ?

adding a custom board, 404 error

I have made a custom .svg and .json file for the wemos s2 mini board (it's not functionally different from the s2 devkit but I like the form factor). when upload it to the wokwi editor following the instructions, I get a 404 not found error on the console, and the view is stuck at "Loading wemos-d2-mini".

looking at the console, the error is: https://wokwi.github.io/wokwi-boards/boards/wemos-s2-mini/board.json?v=8 404, which looks like it's trying to find the file in the wokwi github, and not "locally" in the browser.

I put my custom "board.json" and "board.svg" files in a folder named "wemos-s2-mini", and in the diagram.json I wrote "type": "board-wemos-s2-mini"