esp_rs

Starter Rust no_std dla plytki ESP32-C3-DevKit-RUST-1 v1.2a.

Projekt bazuje na aktualnym generatorze esp-generate i stosie esp-hal. Domyslny program steruje dioda RGB z akcelerometru, a dane z SHTC3 wysyla do monitora szeregowego co 5 sekund.

• src/bin/main.rs - aplikacja glowna: IMU steruje jasnoscia RGB, SHTC3 loguje temperature i wilgotnosc.
• src/bin/hello.rs - drugi program: logowanie komunikatu co sekunde.
• src/bin/rgb_test.rs - bezpieczny test samej RGB: bardzo slabe R/G/B/off.
• src/bin/safe_off.rs - awaryjny program trzymajacy GPIO2 i GPIO7 w stanie niskim.
• .cargo/config.toml - target riscv32imc-unknown-none-elf i runner przez espflash.
• .vscode/ - ustawienia, rekomendowane rozszerzenia i zadania VS Code.
• docs/plytka/ - zdjecia i opis konkretnej wersji plytki.
• docs/obudowa/ - gotowe pliki obudowy.
• docs/skrypty_obudowy/ - skrypty generujace obudowe.

Na tym komputerze zostalo zainstalowane:

• Rust 1.96.1
• target riscv32imc-unknown-none-elf
• espflash 4.4.0
• esp-generate 1.3.0
• rustfmt - formatowanie Rust, odpowiednik Prettiera dla kodu Rust.
• clippy - linter Rust uruchamiany tez przez rust-analyzer w VS Code.
• taplo - formatowanie i kontrola plikow TOML.
• cargo-audit - sprawdzanie znanych podatnosci w zaleznosciach.
• cargo-deny - polityka zaleznosci: licencje, zrodla, duplikaty, advisories.
• cargo-machete - wykrywanie nieuzywanych zaleznosci w Cargo.toml.

Po otwarciu nowego terminala upewnij sie, ze Cargo jest w PATH:

source "$HOME/.cargo/env"

Na nowym komputerze uruchom:

./scripts/setup_macos.sh

cargo build

Pelniejsza kontrola:

./scripts/check.sh

Szersza kontrola jakosci i zaleznosci:

./scripts/quality.sh

check.sh uruchamia szybki, codzienny zestaw: cargo fmt --all --check, cargo clippy --all-targets -- -D warnings i release build wszystkich binarek. quality.sh dodaje do tego taplo, cargo-machete, cargo-audit oraz cargo-deny dla licencji, zrodel i polityki zaleznosci.

Podlacz plytke przez USB-C i sprawdz porty:

espflash list-ports

Wgraj domyslna aplikacje RGB + czujniki:

cargo run

Wgraj przyklad hello:

cargo run --bin hello

Wgraj bardzo przygaszony test RGB bez czujnikow:

cargo run --bin rgb_test

Awaryjnie zgas RGB i mala czerwona LED:

cargo run --bin safe_off

Runner w .cargo/config.toml uzywa:

espflash flash --monitor --chip esp32c3

Dlatego po cargo run program zostanie wgrany i od razu otworzy sie monitor szeregowy.

Sam monitor bez ponownego flashowania:

espflash monitor --chip esp32c3

Jesli system widzi kilka portow:

espflash list-ports
espflash monitor --chip esp32c3 --port /dev/cu.usbmodemXXXX

W monitorze Ctrl+C konczy podglad, a Ctrl+R resetuje plytke.

Zainstaluj rekomendowane rozszerzenia z .vscode/extensions.json.

Najwazniejsze rozszerzenia:

• rust-lang.rust-analyzer - analiza kodu Rust, podpowiedzi, formatowanie przez rustfmt, uruchamianie clippy.
• tamasfe.even-better-toml - obsluga i formatowanie TOML.
• fill-labs.dependi - podglad wersji zaleznosci.
• ms-vscode.vscode-serial-monitor - opcjonalny monitor portu szeregowego w VS Code. Do tego repo nadal najprostszy jest espflash monitor.

Najwazniejsze zadania w VS Code:

• cargo: build
• cargo: clippy
• cargo: fmt
• project: check
• project: quality
• espflash: list ports
• espflash: monitor
• esp32c3: flash sensors-rgb
• esp32c3: flash hello
• esp32c3: flash rgb-test
• esp32c3: flash safe-off

• Ta plytka to ESP32-C3-DevKit-RUST-1 v1.2a 04/2022.
• Dioda uzytkownika RUST-1 jest na GPIO7.
• Aktualna aplikacja trzyma GPIO7 w stanie niskim, wiec mala czerwona LED nie miga.
• RGB WS2812/SK6812 jest na GPIO2.
• Magistrala I2C: SDA GPIO10, SCL GPIO8.
• IMU ICM42670-P jest pod adresem 0x68.
• Czujnik temperatury i wilgotnosci SHTC3 jest pod adresem 0x70.
• W RUST-2 dioda zostala przeniesiona na GPIO10, wiec nie kopiuj pinoutu z RUST-2 bez sprawdzenia rewizji.
• ESP32-C3 jest RISC-V, dlatego podstawowy target Rust to riscv32imc-unknown-none-elf.

• Rust on ESP Book: https://docs.espressif.com/projects/rust/book/
• esp-generate: https://github.com/esp-rs/esp-generate
• esp-hal: https://github.com/esp-rs/esp-hal
• oficjalny przyklad RGB dla esp-hal-smartled: https://github.com/esp-rs/esp-hal-community/blob/main/esp-hal-smartled/examples/hello_rgb.rs
• espflash: https://github.com/esp-rs/espflash
• ESP32-C3-DevKit-RUST board: https://github.com/esp-rs/esp-rust-board
• Dokumentacja RUST-2 z informacja o zmianie GPIO LED: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c3/esp32-c3-devkit-rust-2/user_guide.html