* security(deps): remove vulnerable xmas-elf dependency via embuild * chore(deps): update dependencies and improve ESP-IDF compatibility - Updated `bindgen`, `embassy-sync`, `embedded-svc`, and `embuild` versions in `Cargo.lock`. - Added patch section in `Cargo.toml` to use latest esp-rs crates for better compatibility with ESP-IDF 5.x. - Enhanced README with updated prerequisites and build instructions for Python and Rust tools. - Introduced `rust-toolchain.toml` to pin nightly Rust and added necessary components. - Modified GPIO handling in `main.rs` to improve pin management and added support for 64-bit time_t in ESP-IDF. - Updated `.cargo/config.toml` for new linker and runner configurations. * docs: add detailed setup guide for ESP32 firmware and link in README - Introduced a new `SETUP.md` file with comprehensive step-by-step instructions for building and flashing the ZeroClaw ESP32 firmware. - Updated `README.md` to include a link to the new setup guide for easier access to installation and troubleshooting information. * chore: update .gitignore and refactor main.rs for improved readability - Added .embuild/ to .gitignore to exclude ESP32 build cache. - Refactored code in main.rs for better readability by adjusting the formatting of the handle_request function call. * docs: add newline for better readability in README.md - Added a newline in the protocol section of README.md to enhance clarity and formatting. * chore: configure workspace settings in Cargo.toml - Added workspace configuration to `Cargo.toml` with members and resolver settings for improved project management. --------- Co-authored-by: ehushubhamshaw <eshaw1@wpi.edu> Co-authored-by: Will Sarg <12886992+willsarg@users.noreply.github.com>
163 lines
4.9 KiB
Rust
163 lines
4.9 KiB
Rust
//! ZeroClaw ESP32 firmware — JSON-over-serial peripheral.
|
|
//!
|
|
//! Listens for newline-delimited JSON commands on UART0, executes gpio_read/gpio_write,
|
|
//! responds with JSON. Compatible with host ZeroClaw SerialPeripheral protocol.
|
|
//!
|
|
//! Protocol: same as STM32 — see docs/hardware-peripherals-design.md
|
|
|
|
use esp_idf_svc::hal::gpio::PinDriver;
|
|
use esp_idf_svc::hal::peripherals::Peripherals;
|
|
use esp_idf_svc::hal::uart::{UartConfig, UartDriver};
|
|
use esp_idf_svc::hal::units::Hertz;
|
|
use log::info;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// Incoming command from host.
|
|
#[derive(Debug, Deserialize)]
|
|
struct Request {
|
|
id: String,
|
|
cmd: String,
|
|
args: serde_json::Value,
|
|
}
|
|
|
|
/// Outgoing response to host.
|
|
#[derive(Debug, Serialize)]
|
|
struct Response {
|
|
id: String,
|
|
ok: bool,
|
|
result: String,
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
error: Option<String>,
|
|
}
|
|
|
|
fn main() -> anyhow::Result<()> {
|
|
esp_idf_svc::sys::link_patches();
|
|
esp_idf_svc::log::EspLogger::initialize_default();
|
|
|
|
let peripherals = Peripherals::take()?;
|
|
let pins = peripherals.pins;
|
|
|
|
// Create GPIO output drivers first (they take ownership of pins)
|
|
let mut gpio2 = PinDriver::output(pins.gpio2)?;
|
|
let mut gpio13 = PinDriver::output(pins.gpio13)?;
|
|
|
|
// UART0: TX=21, RX=20 (ESP32) — ESP32-C3 may use different pins; adjust for your board
|
|
let config = UartConfig::new().baudrate(Hertz(115_200));
|
|
let uart = UartDriver::new(
|
|
peripherals.uart0,
|
|
pins.gpio21,
|
|
pins.gpio20,
|
|
Option::<esp_idf_svc::hal::gpio::Gpio0>::None,
|
|
Option::<esp_idf_svc::hal::gpio::Gpio1>::None,
|
|
&config,
|
|
)?;
|
|
|
|
info!("ZeroClaw ESP32 firmware ready on UART0 (115200)");
|
|
|
|
let mut buf = [0u8; 512];
|
|
let mut line = Vec::new();
|
|
|
|
loop {
|
|
match uart.read(&mut buf, 100) {
|
|
Ok(0) => continue,
|
|
Ok(n) => {
|
|
for &b in &buf[..n] {
|
|
if b == b'\n' {
|
|
if !line.is_empty() {
|
|
if let Ok(line_str) = std::str::from_utf8(&line) {
|
|
if let Ok(resp) = handle_request(line_str, &mut gpio2, &mut gpio13)
|
|
{
|
|
let out = serde_json::to_string(&resp).unwrap_or_default();
|
|
let _ = uart.write(format!("{}\n", out).as_bytes());
|
|
}
|
|
}
|
|
line.clear();
|
|
}
|
|
} else {
|
|
line.push(b);
|
|
if line.len() > 400 {
|
|
line.clear();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
Err(_) => {}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn handle_request<G2, G13>(
|
|
line: &str,
|
|
gpio2: &mut PinDriver<'_, G2>,
|
|
gpio13: &mut PinDriver<'_, G13>,
|
|
) -> anyhow::Result<Response>
|
|
where
|
|
G2: esp_idf_svc::hal::gpio::OutputMode,
|
|
G13: esp_idf_svc::hal::gpio::OutputMode,
|
|
{
|
|
let req: Request = serde_json::from_str(line.trim())?;
|
|
let id = req.id.clone();
|
|
|
|
let result = match req.cmd.as_str() {
|
|
"capabilities" => {
|
|
// Phase C: report GPIO pins and LED pin (matches Arduino protocol)
|
|
let caps = serde_json::json!({
|
|
"gpio": [0, 1, 2, 3, 4, 5, 12, 13, 14, 15, 16, 17, 18, 19],
|
|
"led_pin": 2
|
|
});
|
|
Ok(caps.to_string())
|
|
}
|
|
"gpio_read" => {
|
|
let pin_num = req.args.get("pin").and_then(|v| v.as_u64()).unwrap_or(0) as i32;
|
|
let value = gpio_read(pin_num)?;
|
|
Ok(value.to_string())
|
|
}
|
|
"gpio_write" => {
|
|
let pin_num = req.args.get("pin").and_then(|v| v.as_u64()).unwrap_or(0) as i32;
|
|
let value = req.args.get("value").and_then(|v| v.as_u64()).unwrap_or(0);
|
|
gpio_write(gpio2, gpio13, pin_num, value)?;
|
|
Ok("done".into())
|
|
}
|
|
_ => Err(anyhow::anyhow!("Unknown command: {}", req.cmd)),
|
|
};
|
|
|
|
match result {
|
|
Ok(r) => Ok(Response {
|
|
id,
|
|
ok: true,
|
|
result: r,
|
|
error: None,
|
|
}),
|
|
Err(e) => Ok(Response {
|
|
id,
|
|
ok: false,
|
|
result: String::new(),
|
|
error: Some(e.to_string()),
|
|
}),
|
|
}
|
|
}
|
|
|
|
fn gpio_read(_pin: i32) -> anyhow::Result<u8> {
|
|
// TODO: implement input pin read — requires storing InputPin drivers per pin
|
|
Ok(0)
|
|
}
|
|
|
|
fn gpio_write<G2, G13>(
|
|
gpio2: &mut PinDriver<'_, G2>,
|
|
gpio13: &mut PinDriver<'_, G13>,
|
|
pin: i32,
|
|
value: u64,
|
|
) -> anyhow::Result<()>
|
|
where
|
|
G2: esp_idf_svc::hal::gpio::OutputMode,
|
|
G13: esp_idf_svc::hal::gpio::OutputMode,
|
|
{
|
|
let level = esp_idf_svc::hal::gpio::Level::from(value != 0);
|
|
|
|
match pin {
|
|
2 => gpio2.set_level(level)?,
|
|
13 => gpio13.set_level(level)?,
|
|
_ => anyhow::bail!("Pin {} not configured (add to gpio_write)", pin),
|
|
}
|
|
Ok(())
|
|
}
|