Skip to content

Commit 906d780

Browse files
committed
hardware wokwi documentation
1 parent bea1e11 commit 906d780

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Wokwi - Online embedded systems emulator
2+
3+
[Wokwi](https://wokwi.com/) allows you to create circuits and test them online. It has compatibility with arduinos, esp32s, stm32s, and pi picos. It is useful to test code when you do not have the hardware at hand.
4+
5+
## How It Works
6+
7+
1. Log in with an account
8+
2. Input code into sketch.ino. If you have multiple files that you used, you can press the downward-facing triangle (▼) next to the file tabs and add a new file there.
9+
3. You can edit the diagram on the right, visual, panel and add components using the blue plus. You can then draw connections/wires by clicking between pads.
10+
4. This will edit diagram.json, you can save this and push it to the repo if you want to share it with the rest of the team.
11+
5. Press the play button, your program will compile and then automatically run.
12+
6. You can interact with the components during the simulation (eg. press buttons, slide pots).
13+
7. If the microcontroller prints something to serial, the serial monitor will appear and you can send it messages using the textbox at the bottom.
14+
15+
## Potential Pain Points
16+
17+
- I don't have all the components I need!
18+
- You are best off just approximating what the rest of the circuit does through some other form of visualisation, such as LEDs.
19+
- I can't use custom libraries!
20+
- Contact Tommy Byrne on the slack for access to an account that is on the paid hobby plan (that allows custom libraries)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ nav: # This is the structure of the sidebar
102102
- Libraries:
103103
- FTSerial: departments/hardware/electronics/code/libraries/ftserial.md
104104
- Steering: departments/hardware/electronics/code/steering.md
105+
- Wokwi: departments/hardware/electronics/code/wokwi.md
105106
- Jetson Nano: departments/hardware/electronics/jetson_nano.md
106107
- Microcontrollers: departments/hardware/electronics/microcontrollers.md
107108
- Mechanical:

0 commit comments

Comments
 (0)