Skip to content
/ rust-esp-homekit-sdk-smart-outlet Public
forked from ivmarkov/rust-esp32-std-demo

Rust on ESP32 "Hello World" app. A demo binary crate for the ESP32[XX] and ESP-IDF, which connects to WiFi, drives a small HTTP server and draws on a LED screen.

License

MIT and 2 other licenses found

Licenses found

MIT
LICENSE
Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
10 stars 105 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

schphil/rust-esp-homekit-sdk-smart-outlet

BranchesTags
 
 

Repository files navigation

Rust on ESP32 "Hello, World" app

A demo binary crate for the ESP32[XX] and ESP-IDF, which connects to WiFi, drives a small HTTP server and draws on a LED screen.

Highlights:

  • Pure Rust and pure Cargo build! No CMake, no PlatformIO, no C helpers
  • Support for Rust STD (threads, console, TCP/IP) safe APIs
  • Rust Safe APIs for various ESP-IDF services like WiFi, Ping, Httpd and logging
  • NAPT support (Router from the SoftAP to the STA interface). NOTE: In production, do NOT leave the SoftAP interface open (without password)!
  • Driving a LED screen with the embedded-graphics Rust crate
  • (ESP32-S2 only) Blink a LED by loading a pure Rust program onto the RiscV Ultra Low Power CPU

Build

  • Install the nightly toolchain of Rust (necessary, because we utilize a few unstable Cargo features): rustup toolchain install nightly
  • Make sure the toolchains are up to date, as one of the utilized unstable Cargo features landed just a few months ago: rustup update
  • Switch to nightly (as per above, necessary for Cargo): rustup default nightly
  • Download and install the prebuilt binaries of the Rust Espressif compiler fork and the Espressif LLVM clang fork or follow the Rust Espressif compiler fork & Espressif LLVM clang fork build instructions;
  • The build is using the ldproxy linker wrapper from embuild, so install ldproxy:
    • cargo install ldproxy
  • Clone this repo: git clone https://github.com/ivmarkov/rust-esp32-std-hello
  • Enter it: cd rust-esp32-std-hello
  • Change lines 50 and 51 in rust-esp32-std-hello/src/main.rs to contain the SSID & password of your wireless network
  • To configure the demo for your particular board, please uncomment the relevant Rust target for your board and comment the others
  • (Only if you happen to have a TTGO T-Display board): Uncomment line 51 to be greeted with a Hello Rust! message on the board's LED screen
  • (Only if you happen to have an ESP32-S2-Kaluga-1 board): Uncomment line 55 to be greeted with a Hello Rust! message on the board's LED screen
  • (Only if you happen to have a Heltec LoRa 32 board): Uncomment line 59 to be greeted with a Hello Rust! message on the board's LED screen
  • (Only if you happen to have an ESP32-S2 board and can connect a LED to GPIO Pin 04 and GND): Execute cp sdkconfig.s.esp32s2-ulp-example sdkconfig.defaults to enable the ESP32-S2 ULP RiscV LED demo
  • Build: cargo build or cargo build --release

Flash (ESP32 only)

  • cargo install espflash (NOTE: espflash supports ONLY plain ESP32. No support for ESP32S2 and ESP32C3)
  • espflash /dev/ttyUSB0 target/xtensa-esp32-espidf/debug/rust-esp32-std-hello
  • Replace dev/tttyUSB0 above with the USB port where you've connected the board
  • If espflash complains with Error: IO error while using serial port: Operation timed out or with error Error: Failed to connect to the device, just retry the flash operation

NOTE: The above commands do use espflash and NOT cargo espflash, even though both can be installed via Cargo. cargo espflash is essentially espflash but it also builds the project prior to attempting to flash the resulting ELF binary.

Faster flashing

  • You can also flash with the esptool.py utility which is part of the Espressif toolset
  • Use the instructions below only if you have flashed successfully with espflash at least once, or else you might not have a valid bootloader and partition table!
  • The instructions below only (re)flash the application image, as the (one and only) factory image starting from 0x10000 in the partition table!
  • Install esptool: pip install esptool
  • (After each cargo build) Convert the elf image to binary: esptool.py --chip esp32 elf2image target/xtensa-esp32-espidf/debug/rust-esp32-std-hello
  • (After each cargo build) Flash the resulting binary: esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 4MB 0x10000 target/xtensa-esp32-espidf/debug/rust-esp32-std-hello.bin

Flashing for ESP32-S2 & ESP32-C3

espflash currently supports only ESP32. For ESP32-S2 and ESP32-C3 you have to use the alternative flashing method from above, passing as argument --chip esp32s2 or --chip esp32c3 respectively

NOTE / ESP32-C3: Be EXTRA careful when picking the flash address when flashing on ESP32-C3:

  • These boards seem to have non-standard partition tables in that the factory image does NOT necessarily start at address 0x10000 (if there is a factory image configured at all)!
  • The partition table is usually printed during chip boot time

Here are two sample partition tables:

ESP32-C3-DevKitM-1

## Label            Usage          Type ST Offset   Length
 0 sec_cert         unknown          3f 00 0000d000 00003000
 1 nvs              WiFi data        01 02 00010000 00006000
 2 otadata          OTA data         01 00 00016000 00002000
 3 phy_init         RF data          01 01 00018000 00001000
 4 ota_0            OTA app          00 10 00020000 00190000 <- Flashing, Option 1: 0x20000, 1.6MB size
 5 ota_1            OTA app          00 11 001b0000 00190000 <- Flashing, Option 2: 0x1b0000, 1.6MB size
 6 fctry            WiFi data        01 02 00340000 00006000
 7 coredump         Unknown data     01 03 00350000 00010000

NodeMCU ESP32-C3M-Kit

## Label            Usage          Type ST Offset   Length
 0 phy_init         RF data          01 01 0000f000 00001000
 1 otadata          OTA data         01 00 00010000 00002000
 2 nvs              WiFi data        01 02 00012000 0000e000
 3 at_customize     unknown          40 00 00020000 000e0000
 4 ota_0            OTA app          00 10 00100000 00180000 <- Flashing, Option 1: 0x100000, 1.57MB size
 5 ota_1            OTA app          00 11 00280000 00180000 <- Flashing, Option 2: 0x280000, 1.57MB size

Monitor

  • Once flashed, the board can be connected with any suitable serial monitor, e.g.:

    • NEW: Cargo PIO (this one decodes stack traces!): cargo pio espidf monitor /dev/ttyUSB0
      • To use it, issue cargo install cargo-pio first
      • Please run it from within the rust-esp32-std-hello project directory, or else the built ELF file will not be detected, and the stack traces will not be decoded!
    • Built-in Linux/MacOS screen: screen /dev/ttyUSB0 115200 (use Ctrl+A and then type :quit to stop it)
    • Miniterm: miniterm --raw /dev/ttyUSB0 115200
    • ESPMonitor: cargo espmonitor --speed 115200 /dev/ttyUSB0 (you need to cargo install espmonitor first)

  • You should see more or less the following:

Hello, world from Rust!
More complex print [foo, bar]
Rust main thread: ...
This is thread number 0 ...
This is thread number 1 ...
This is thread number 2 ...
This is thread number 3 ...
This is thread number 4 ...
About to join the threads. If ESP-IDF was patched successfully, joining will NOT crash
Joins were successful.
I (4761) wifi:wifi driver task: 3ffc1d80, prio:23, stack:6656, core=0
I (4761) system_api: Base MAC address is not set, read default base MAC address from BLK0 of EFUSE
I (4761) system_api: Base MAC address is not set, read default base MAC address from BLK0 of EFUSE
I (4771) wifi:wifi firmware version: 3ea4c76
I (4771) wifi:config NVS flash: disabled
I (4781) wifi:config nano formating: disabled
I (4781) wifi:Init dynamic tx buffer num: 32
I (4791) wifi:Init data frame dynamic rx buffer num: 32
I (4791) wifi:Init management frame dynamic rx buffer num: 32
I (4801) wifi:Init management short buffer num: 32
I (4801) wifi:Init static rx buffer size: 1600
I (4811) wifi:Init static rx buffer num: 10
I (4811) wifi:Init dynamic rx buffer num: 32
I (4811) esp_idf_svc::wifi: Driver initialized
I (4821) esp_idf_svc::wifi: Event handlers registered
I (4821) esp_idf_svc::wifi: Initialization complete
I (4831) rust_esp32_std_hello: Wifi created
I (4831) esp_idf_svc::wifi: Setting configuration: Client(ClientConfiguration { ssid: "<your-ssid>", bssid: None, auth_method: WPA2Personal, password: "<your-pass>", ip_conf: Some(DHCP) })
I (4851) esp_idf_svc::wifi: Stopping
I (4861) esp_idf_svc::wifi: Disconnect requested
I (4861) esp_idf_svc::wifi: Stop requested
I (4871) esp_idf_svc::wifi: About to wait for status
I (4871) esp_idf_svc::wifi: Providing status: Status(Stopped, Stopped)
I (4881) esp_idf_svc::wifi: Waiting for status done - success
I (4881) esp_idf_svc::wifi: Stopped
I (4891) esp_idf_svc::wifi: Wifi mode STA set
I (4891) esp_idf_svc::wifi: Setting STA configuration: ClientConfiguration { ssid: "<your-ssid>", bssid: None, auth_method: WPA2Personal, password: "<your-pass>", ip_conf: Some(DHCP) }
I (4911) esp_idf_svc::wifi: Setting STA IP configuration: DHCP
I (4921) esp_idf_svc::wifi: STA netif allocated: 0x3ffc685c
I (4921) esp_idf_svc::wifi: STA IP configuration done
I (4931) esp_idf_svc::wifi: STA configuration done
I (4931) esp_idf_svc::wifi: Starting with status: Status(Starting, Stopped)
I (4941) esp_idf_svc::wifi: Status is of operating type, starting
I (5041) phy: phy_version: 4180, cb3948e, Sep 12 2019, 16:39:13, 0, 0
I (5041) wifi:mode : sta (f0:08:d1:77:68:f0)
I (5041) esp_idf_svc::wifi: Got wifi event: 2
I (5051) esp_idf_svc::wifi: Recconecting
I (5051) esp_idf_svc::wifi: Start requested
I (5051) esp_idf_svc::wifi: Set status: Status(Started(Connecting), Stopped)
I (5061) esp_idf_svc::wifi: About to wait for status with timeout 10s
I (5071) esp_idf_svc::wifi: Wifi event 2 handled
I (5091) esp_idf_svc::wifi: Providing status: Status(Started(Connecting), Stopped)
I (5171) wifi:new:<1,1>, old:<1,0>, ap:<255,255>, sta:<1,1>, prof:1
I (5941) wifi:state: init -> auth (b0)
I (5951) esp_idf_svc::wifi: Providing status: Status(Started(Connecting), Stopped)
I (5951) wifi:state: auth -> assoc (0)
I (5961) wifi:state: assoc -> run (10)
I (5981) wifi:connected with muci, aid = 1, channel 1, 40U, bssid = 08:55:31:2e:c3:cf
I (5981) wifi:security: WPA2-PSK, phy: bgn, rssi: -54
I (5981) wifi:pm start, type: 1

I (5991) esp_idf_svc::wifi: Got wifi event: 4
I (5991) esp_idf_svc::wifi: Set status: Status(Started(Connected(Waiting)), Stopped)
I (6001) esp_idf_svc::wifi: Wifi event 4 handled
I (6011) wifi:AP's beacon interval = 102400 us, DTIM period = 1
I (6451) esp_idf_svc::wifi: Providing status: Status(Started(Connected(Waiting)), Stopped)
I (6951) esp_idf_svc::wifi: Providing status: Status(Started(Connected(Waiting)), Stopped)
I (7451) esp_idf_svc::wifi: Providing status: Status(Started(Connected(Waiting)), Stopped)
I (7951) esp_idf_svc::wifi: Providing status: Status(Started(Connected(Waiting)), Stopped)
I (8221) esp_idf_svc::wifi: Got IP event: 0
I (8221) esp_idf_svc::wifi: Set status: Status(Started(Connected(Done(ClientSettings { ip: 192.168.10.155, subnet: Subnet { gateway: 192.168.10.1, mask: Mask(24) }, dns: None, secondary_dns: None }))), Stopped)
I (8231) esp_idf_svc::wifi: IP event 0 handled
I (8241) esp_netif_handlers: staSTA netif allocated:  ip: 192.168.10.155, mask: 255.255.255.0, gw: 192.168.10.1
I (8451) esp_idf_svc::wifi: Providing status: Status(Started(Connected(Done(ClientSettings { ip: 192.168.10.155, subnet: Subnet { gateway: 192.168.10.1, mask: Mask(24) }, dns: None, secondary_dns: None }))), Stopped)
I (8461) esp_idf_svc::wifi: Waiting for status done - success
I (8461) esp_idf_svc::wifi: Started
I (8471) esp_idf_svc::wifi: Configuration set
I (8471) rust_esp32_std_hello: Wifi configuration set, about to get status
I (8481) esp_idf_svc::wifi: Providing status: Status(Started(Connected(Done(ClientSettings { ip: 192.168.10.155, subnet: Subnet { gateway: 192.168.10.1, mask: Mask(24) }, dns: None, secondary_dns: None }))), Stopped)
I (8501) rust_esp32_std_hello: Wifi connected, about to do some pings
I (8511) esp_idf_svc::ping: About to run a summary ping 192.168.10.1 with configuration Configuration { count: 5, interval: 1s, timeout: 1s, data_size: 56, tos: 0 }
I (8521) esp_idf_svc::ping: Ping session established, got handle 0x3ffc767c
I (8531) esp_idf_svc::ping: Ping session started
I (8531) esp_idf_svc::ping: Waiting for the ping session to complete
I (8541) esp_idf_svc::ping: Ping success callback invoked
I (8551) esp_idf_svc::ping: From 192.168.10.1 icmp_seq=1 ttl=64 time=14ms bytes=64
I (9531) esp_idf_svc::ping: Ping success callback invoked
I (9531) esp_idf_svc::ping: From 192.168.10.1 icmp_seq=2 ttl=64 time=1ms bytes=64
I (10531) esp_idf_svc::ping: Ping success callback invoked
I (10531) esp_idf_svc::ping: From 192.168.10.1 icmp_seq=3 ttl=64 time=2ms bytes=64
I (11531) esp_idf_svc::ping: Ping success callback invoked
I (11531) esp_idf_svc::ping: From 192.168.10.1 icmp_seq=4 ttl=64 time=0ms bytes=64
I (12531) esp_idf_svc::ping: Ping success callback invoked
I (12531) esp_idf_svc::ping: From 192.168.10.1 icmp_seq=5 ttl=64 time=1ms bytes=64
I (13531) esp_idf_svc::ping: Ping end callback invoked
I (13531) esp_idf_svc::ping: 5 packets transmitted, 5 received, time 18ms
I (13531) esp_idf_svc::ping: Ping session stopped
I (13531) esp_idf_svc::ping: Ping session 0x3ffc767c removed
I (13541) rust_esp32_std_hello: Pinging done
I (13551) esp_idf_svc::httpd: Started Httpd IDF server with config Configuration { http_port: 80, https_port: 443 }
I (13561) esp_idf_svc::httpd: Registered Httpd IDF server handler Get for URI "/"
I (13561) esp_idf_svc::httpd: Registered Httpd IDF server handler Get for URI "/foo"
I (13571) esp_idf_svc::httpd: Registered Httpd IDF server handler Get for URI "/bar"
  • If the app starts successfully, it should be listening on the printed IP address from the WiFi connection logs, port 80.
  • Open a browser, and navigate to one of these:
  • http://<printed-ip-address>
  • http://<printed-ip-address>/foo?key=value
  • http://<printed-ip-address>/bar
  • http://<printed-ip-address>/ulp (ESP32-S2 only)

About

Rust on ESP32 "Hello World" app. A demo binary crate for the ESP32[XX] and ESP-IDF, which connects to WiFi, drives a small HTTP server and draws on a LED screen.

Resources

Readme

License

MIT and 2 other licenses found

Licenses found

MIT
LICENSE
Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Activity

Stars

10 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Rust 100.0%