Skip to content

Commit 46e9d0f

Browse files
committed
feat: Remove web Wokwi simulations
1 parent c7325fa commit 46e9d0f

File tree

7 files changed

+15
-160
lines changed

7 files changed

+15
-160
lines changed

.github/workflows/wokwi_projects.yml

Lines changed: 0 additions & 91 deletions
This file was deleted.

book/src/02_0_preparations.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,23 @@ Anchor comments can be ignored, they are only used to introduce those parts of c
3333
3434
## Simulating Projects
3535

36-
Certain projects can be simulated with [Wokwi][wokwi]. Look for indications in the book to identify projects available for simulation. Simulation can be accomplished through two methods:
37-
- Using wokwi.com: Conduct the build process and code editing directly through the browser.
38-
- Using [Wokwi VS Code extension][wokwi-vscode]: Leverage VS Code to edit projects and perform builds. Utilize the Wokwi VS Code extension to simulate the resulting binaries.
39-
- This approach requires some [installation][wokwi-installation]
40-
- This approach assumes that the project is built in debug mode
41-
- This approach allows [debugging the project][wokwi-debug]
36+
Certain projects can be simulated, or at least partially simulated, with [Wokwi][wokwi]. Here is the list of projects that support Wokwi simulation:
37+
- `intro/hello-world`
38+
- `intro/http-client`
39+
- `advanced/i2c-sensor-reading`
40+
- `advanced/i2c-driver`
41+
- `advanced/button-interrupt`
42+
43+
Before jumping into any simulation project, you need to [setup the extension][wokwi-installation]. To simulate one project:
44+
45+
1. Press F1, select `Wokwi: Select Config File`, and choose the `wokwi.toml` of the project you want to simulate.
46+
1. Edit the corresponding `wokwi.toml` file to simulate the exercise or the solution project.
47+
2. Build your project in `debug` mode.
48+
3. Press F1 again and select `Wokwi: Start Simulator`.
49+
50+
You can also [debug the project][wokwi-debug].
4251

4352
[wokwi]: https://wokwi.com/
44-
[wokwi-vscode]: https://docs.wokwi.com/vscode/getting-started
4553
[wokwi-installation]: https://docs.wokwi.com/vscode/getting-started#installation
4654
[wokwi-debug]: https://docs.wokwi.com/vscode/debugging
4755

book/src/02_4_hello_board.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,6 @@ You can also monitor the device without flashing it with the following command:
7676
espflash monitor
7777
```
7878

79-
## Simulation
80-
81-
This project is available for simulation through two methods:
82-
- [Wokwi project](https://wokwi.com/projects/360342886675214337?build-cache=disable)
83-
- Wokwi VS Code extension:
84-
1. Press F1, select `Wokwi: Select Config File`, and choose `intro/hardware-check/wokwi.toml`.
85-
2. Build your project.
86-
3. Press F1 again and select `Wokwi: Start Simulator`.
87-
8879
## Troubleshooting
8980

9081
### Build Errors

book/src/03_3_2_http_client.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,6 @@ The status error can be returned with the [Anyhow](https://docs.rs/anyhow/latest
6969

7070
✅ Write a custom `Error` enum to represent these errors. Implement the `std::error::Error` trait for your error.
7171

72-
73-
## Simulation
74-
75-
This project is available for simulation through two methods:
76-
- Wokwi projects:
77-
- [Exercise](https://wokwi.com/projects/360722140931768321?build-cache=disable)
78-
- [Solution](https://wokwi.com/projects/333372159510446675?build-cache=disable)
79-
- Wokwi files are also present in the project folder to simulate it with Wokwi VS Code extension:
80-
1. Press F1, select `Wokwi: Select Config File` and choose `intro/http-client/wokwi.toml`
81-
- Edit the `wokwi.toml` file to select between exercise and solution simulation
82-
2. Build you project
83-
3. Press F1 again and select `Wokwi: Start Simulator`
84-
8572
## Troubleshooting
8673

8774
- `missing WiFi name/password`: ensure that you've configured `cfg.toml` according to `cfg.toml.example` - a common problem is that the package name and config section name don't match.

book/src/04_3_1_i2c.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -125,17 +125,3 @@ GYRO: X: 0.00 Y: 0.00 Z: 0:00
125125
TEMP: [local temperature] °C
126126
HUM: [local humidity] %
127127
```
128-
129-
## Simulation
130-
131-
This project is available for simulation through two methods:
132-
- Wokwi projects
133-
- [Exercise](https://wokwi.com/projects/360623713943950337?build-cache=disable)
134-
- [Solution Part 2](https://wokwi.com/projects/360344742047853569?build-cache=disable)
135-
- Wokwi files are also present in the project folder to simulate it with Wokwi VS Code extension:
136-
1. Press F1, select `Wokwi: Select Config File` and choose `advanced/i2c-sensor-reading/wokwi.toml`
137-
- Edit the `wokwi.toml` file to select between exercise and solutions simulation
138-
2. Build you project
139-
3. Press F1 again and select `Wokwi: Start Simulator`
140-
141-
When simulating this project, expect the following hardcoded values: `TEMP: 24.61 °C | HUM: 36.65 % | GYRO: X= 0.00 Y= 0.00 Z= 0.00`

book/src/04_3_2_i2c.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,3 @@ Registers can have different meanings, in essence, they are **a location that ca
6868
In this specific context, we are using an external device (since it is a sensor, even if it is on the same PCB). It is addressable by I2C, and we are reading and writing to its register addresses. The addresses each identify a unique location that contains some information. In this case, we want the address for the location that contains the current temperature, as read by the sensor.
6969

7070
You can find the register map of the ICM-42670 in [section 14](https://invensense.tdk.com/wp-content/uploads/2021/07/DS-000451-ICM-42670-P-v1.0.pdf) should you want to try to get other interesting data from this sensor.
71-
72-
73-
74-
## Simulation
75-
76-
This project is available for simulation through two methods:
77-
- Wokwi projects
78-
- [Exercise](https://wokwi.com/projects/360728357589094401?build-cache=disable)
79-
- [Solution](https://wokwi.com/projects/333375074521317970?build-cache=disable)
80-
- Wokwi files are also present in the project folder to simulate it with Wokwi VS Code extension:
81-
1. Press F1, select `Wokwi: Select Config File` and choose `advanced/i2c-driver/wokwi.toml`
82-
2. Build you project
83-
3. Press F1 again and select `Wokwi: Start Simulator`

book/src/04_4_1_interrupts.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,3 @@ cargo run --example solution
3030
🔎 In this exercise we are using notifications, which only give the latest value, so if the interrupt is triggered
3131
multiple times before the value of the notification is read, you will only be able to read the latest one. Queues,
3232
on the other hand, allow receiving multiple values. See `esp_idf_hal::task::queue::Queue` for more details.
33-
34-
## Simulation
35-
36-
This project is available for simulation through two methods:
37-
- Wokwi projects
38-
- [Exercise](https://wokwi.com/projects/360623288920412161?build-cache=disable)
39-
- [Solution](https://wokwi.com/projects/333374799393849940?build-cache=disable)
40-
- The Solution project contains solution for [Random LED Color on pushinig a Button](./04_4_2_interrupts.md)
41-
- Wokwi files are also present in the project folder to simulate it with Wokwi VS Code extension:
42-
1. Press F1, select `Wokwi: Select Config File` and choose `advanced/button-interrupt/wokwi.toml`
43-
- Edit the `wokwi.toml` file to select between exercise and solution simulation
44-
2. Build you project
45-
3. Press F1 again and select `Wokwi: Start Simulator`

0 commit comments

Comments
 (0)