This project was inspired by the rusty-clock project
The initial goal of the project was just to implement clocks with brand new ESP32-C3-RUST-BOARD, but over time, new ideas and more use cases began to appear.
Generally, project is created to demonstrate the capabilities of the new board in the Rust language, but now I've taken the direction to create a monitoring system based on the RUST-BOARD, so ch so you have two possibilites how to run this project:
- On the RUST-BOARD itself, enabling the
esp32c3_rust_board_ili9341
feature, inCargo.toml
file. On-board sensors will be used. - Using another chip (list of availible configurations somewhere below), activating the corresponding feature in
Cargo.toml
file.
You can learn more about RUST-BOARD here
Important : every configuration other than
esp32c3_rust_board_ili9341
requires Wi-Fi connection and uses MQTT messaging to revceive data from RUST-BOARD, which is measuring temperature and humidityMQTT measurements sender is implemented here also by myself and of course it's also for RUST-BOARD since this project is dedicated to it
The basic use case for this project involves the use of a RUST-BOARD and ILI9341 display.
ILI9341 | ESP-RUST-BOARD |
---|---|
RST | GPIO3 |
CLK | GPIO6 |
D_C | GPIO21 |
CS | GPIO20 |
MOSI | GPIO7 |
- Enable
esp32c3_rust_board_ili9341
feature if you want to use RUST-BOARD and it's on-board sensors withili9341
display - Enable
esp32c3_ili9341
if you're usingESP32-C3
board andili9341
display OR if you want to use RUST-BOARD with MQTT-messaging to receive temperature and humidity from another RUST-BOARD - Enable
esp32s3_ili9341
if you're usingESP32-S3
board andili9341
display - Enable
esp32s2_ili9341
if you're usingESP32-S2
board andili9341
display - Enable
esp32s3_usb_otg
if you're usingESP32-S3-USB-OTG
board andili9341
display
Warning
Not optimized yet.
- Enable
esp32s2_usb_otg
if you're usingESP32-S2-USB-OTG
board andili9341
display
Warning
Not optimized yet.
Important : If you using any configuration with Wi-Fi, it will set time automatically. Also, if you're using
esp32c3_rust_board_ili9341
configuration and you want to enable Wi-Fi time setting - just add--features wifi
to execution command. Otherwise, you will need to set the time manually at THESE lines of code
- Model a box โฐ
- Make some kind of a monitoring system with the ability to place several sensors(RUST-BOARDS) over the room/building/whatever
- Optimize project for other targets (
ESP32-S3-BOX
,ESP32-S2-Kaluga-1
,ESP32-S2-HMI-DevKit-1
) - Grafana integration ๐
- Slint integration ๐
This repository offers Dev Containers supports for:
Note
In order to use Gitpod the project needs to be published in a GitLab, GitHub, or Bitbucket repository.
In order to use GitHub Codespaces the project needs to be published in a GitHub repository and the user needs to be part of the Codespaces beta or have the project under an organization.
If using VS Code or GitHub Codespaces, you can pull the image instead of building it
from the Dockerfile by selecting the image
property instead of build
in
.devcontainer/devcontainer.json
. Further customization of the Dev Container can
be achived, see .devcontainer.json reference.
When using Dev Containers, some tooling to facilitate building, flashing and simulating in Wokwi is also added.
-
Terminal approach:
scripts/build.sh [debug | release]
If no argument is passed,
release
will be used as default -
UI approach:
The default build task is already set to build the project, and it can be used in VS Code and Gitpod:
- From the Command Palette (
Ctrl-Shift-P
orCmd-Shift-P
) run theTasks: Run Build Task
command. Terminal
->Run Build Task
in the menu.- With
Ctrl-Shift-B
orCmd-Shift-B
. - From the Command Palette (
Ctrl-Shift-P
orCmd-Shift-P
) run theTasks: Run Task
command and selectBuild
. - From UI: Press
Build
on the left side of the Status Bar.
- From the Command Palette (
Note
When using GitHub Codespaces, we need to make the ports public, see instructions.
-
Terminal approach:
-
Using
flash.sh
script:scripts/flash.sh [debug | release]
If no argument is passed,
release
will be used as default
-
-
UI approach:
- From the Command Palette (
Ctrl-Shift-P
orCmd-Shift-P
) run theTasks: Run Task
command and selectBuild & Flash
. - From UI: Press
Build & Flash
on the left side of the Status Bar.
- From the Command Palette (
-
Any alternative flashing method from host machine.
When using a custom Wokwi project, please change the WOKWI_PROJECT_ID
in
run-wokwi.sh
. If no project id is specified, a DevKit for esp32c3 will be
used.
Warning
ESP32-S3 is not available in Wokwi
-
Terminal approach:
scripts/run-wokwi.sh [debug | release]
If no argument is passed,
release
will be used as default -
UI approach:
The default test task is already set to build the project, and it can be used in VS Code and Gitpod:
- From the Command Palette (
Ctrl-Shift-P
orCmd-Shift-P
) run theTasks: Run Test Task
command - With
Ctrl-Shift-,
orCmd-Shift-,
Note
This Shortcut is not available in Gitpod by default.
- From the Command Palette (
Ctrl-Shift-P
orCmd-Shift-P
) run theTasks: Run Task
command and selectBuild & Run Wokwi
. - From UI: Press
Build & Run Wokwi
on the left side of the Status Bar.
- From the Command Palette (
Warning
The simulation will pause if the browser tab is in the background.This may affect the execution, specially when debuging.
Wokwi offers debugging with GDB.
-
Terminal approach:
$HOME/.espressif/tools/riscv32-esp-elf/esp-2021r2-patch3-8.4.0/riscv32-esp-elf/bin/riscv32-esp-elf-gdb target/riscv32imc-esp-espidf/debug/esp_clock -ex "target remote localhost:9333"
-
UI approach:
- Run the Wokwi Simulation in
debug
profile - Go to
Run and Debug
section of the IDE (Ctrl-Shift-D or Cmd-Shift-D
) - Start Debugging by pressing the Play Button or pressing
F5
- Choose the proper user:
esp
when using VS Code or GitHub Codespacesgitpod
when using Gitpod
- Run the Wokwi Simulation in