RMT Onewire Peripheral

.cargo/config.toml

@@ -1,6 +1,6 @@
 [build]
-target = "riscv32imc-esp-espidf"
-#target = "xtensa-esp32-espidf"
+# target = "riscv32imc-esp-espidf"
+target = "xtensa-esp32-espidf"
 
 [target.xtensa-esp32-espidf]
 linker = "ldproxy"

.devcontainer/devcontainer.json

@@ -0,0 +1,42 @@
+{
+    "name": "rmt_onewire",
+    // Select between image and build propieties to pull or build the image.
+    "image": "docker.io/espressif/idf-rust:esp32_latest",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "rust-lang.rust-analyzer",
+                "tamasfe.even-better-toml",
+                "serayuzgur.crates",
+                "mutantdino.resourcemonitor",
+                "yzhang.markdown-all-in-one",
+                "ms-vscode.cpptools",
+                "actboy168.tasks",
+                "Wokwi.wokwi-vscode",
+                "ms-azuretools.vscode-docker",
+                "ms-python.python"
+            ],
+            "settings": {
+                "editor.formatOnPaste": true,
+                "editor.formatOnSave": true,
+                "editor.formatOnSaveMode": "file",
+                "editor.formatOnType": true,
+                "lldb.executable": "/usr/bin/lldb",
+                "files.watcherExclude": {
+                    "**/target/**": true
+                },
+                "rust-analyzer.checkOnSave.command": "clippy",
+                "rust-analyzer.checkOnSave.allTargets": false,
+                "[rust]": {
+                    "editor.defaultFormatter": "rust-lang.rust-analyzer"
+                }
+            }
+        }
+    },
+    "forwardPorts": [
+        3333,
+        8000
+    ],
+    "workspaceMount": "source=${localWorkspaceFolder},target=/home/esp/rmt_onewire,type=bind,consistency=cached",
+    "workspaceFolder": "/home/esp/rmt_onewire"
+}

Cargo.toml

@@ -24,7 +24,8 @@ std = ["alloc", "esp-idf-sys/std"]
 alloc = []
 nightly = []
 wake-from-isr = [] # Only enable if you plan to use the `edge-executor` crate
-embassy-sync = [] # For now, the dependecy on the `embassy-sync` crate is non-optional, but this might change in future
+embassy-sync = [
+] # For now, the dependecy on the `embassy-sync` crate is non-optional, but this might change in future
 # Temporary, until (https://github.com/espressif/esp-idf/issues/13938) is addressed
 # - When enabled, the code for the legacy ADC oneshot driver will be compiled;
 # - When not enabled (default) the code for the new ADC oneshot driver will be compiled;
@@ -42,13 +43,17 @@ libstart = ["esp-idf-sys/libstart"]
 nb = "1"
 embedded-can = "0.4.1"
 embedded-hal = "1"
-embedded-hal-0-2 = { package = "embedded-hal", version = "0.2.7", features = ["unproven"] }
+embedded-hal-0-2 = { package = "embedded-hal", version = "0.2.7", features = [
+    "unproven",
+] }
 embedded-hal-nb = "1"
 embedded-hal-async = "1"
 embedded-io = "0.6"
 embedded-io-async = "0.6"
 esp-idf-sys = { version = "0.35", default-features = false }
-critical-section = { version = "1.1.1", optional = true, features = ["restore-state-none"] }
+critical-section = { version = "1.1.1", optional = true, features = [
+    "restore-state-none",
+] }
 heapless = "0.8"
 num_enum = { version = "0.7", default-features = false }
 enumset = { version = "1.1", default-features = false }
@@ -65,3 +70,8 @@ esp-idf-sys = { version = "0.35", features = ["binstart"] }
 mipidsi = "0.5.0"
 display-interface-spi = "0.4.1"
 embedded-graphics = "0.7.1"
+
+[[package.metadata.esp-idf-sys.extra_components]]
+remote_component = { name = "ds18b20", version = "^0.1.0" }
+bindings_header = "bindings.h"
+bindings_module = "onewire"

bindings.h

@@ -0,0 +1,2 @@
+#include "ds18b20.h"
+#include "onewire_bus.h"

components_esp32.lock

@@ -0,0 +1,21 @@
+dependencies:
+  espressif/ds18b20:
+    component_hash: d676429d9f1f686b65ed895e418eb4b331477bcd5d63c27f43dc3d6a2de8f13b
+    source:
+      service_url: https://api.components.espressif.com/
+      type: service
+    version: 0.1.1
+  espressif/onewire_bus:
+    component_hash: c4c781940d8bd988432b47ac3ee68479c69e14e01fdfba0b61365b233a3ba5d6
+    source:
+      service_url: https://api.components.espressif.com/
+      type: service
+    version: 1.0.2
+  idf:
+    component_hash: null
+    source:
+      type: idf
+    version: 5.1.2
+manifest_hash: f4c4d8dc4f9e0e9422ee45c389b14c8d3db5ce6258eaec379ea8d50430151679
+target: esp32
+version: 1.0.0

examples/rmt_onewire.rs

@@ -0,0 +1,26 @@
+use esp_idf_hal::delay::FreeRtos;
+use esp_idf_hal::onewire::BusDriver;
+use esp_idf_hal::peripherals::Peripherals;
+use esp_idf_hal::rmt::{
+    FixedLengthSignal, PinState, Pulse, PulseTicks, Receive, RmtReceiveConfig, RmtTransmitConfig,
+    RxRmtDriver, TxRmtDriver,
+};
+
+fn main() -> anyhow::Result<()> {
+    println!("Starting APP!");
+
+    let peripherals = Peripherals::take()?;
+
+    let onewire_pin = peripherals.pins.gpio16;
+
+    let mut rmt_onewire = BusDriver::new(onewire_pin)?;
+
+    let mut search = rmt_onewire.search()?;
+
+    let search_device = search.next_device()?;
+
+    println!("Found Device: {}", search_device.address());
+    loop {
+        FreeRtos::delay_ms(3000);
+    }
+}

src/lib.rs

@@ -46,7 +46,11 @@ pub mod peripheral;
 pub mod peripherals;
 pub mod prelude;
 pub mod reset;
+#[cfg(feature = "legacy_rmt")]
 pub mod rmt;
+//
+// #[cfg(not(feature = "legacy_rmt"))]
+pub mod onewire;
 pub mod rom;
 pub mod spi;
 pub mod sys;

src/onewire.rs

@@ -0,0 +1,102 @@
+use core::marker::PhantomData;
+use core::ptr;
+
+use esp_idf_sys::*;
+
+use crate::peripheral::Peripheral;
+
+#[derive(Debug)]
+pub struct Device<'b> {
+    _device: onewire::onewire_device_t,
+    // _bus: &'b BusDriver<'b>, // not sure how I would hold a reference to this aside from the handle
+    _p: PhantomData<&'b ()>, // holds the lifetime since the device is linked to the lifetime of the bus
+}
+
+impl<'a> Device<'a> {
+    fn new(device_handle: onewire::onewire_device_t) -> Self {
+        Self {
+            _device: device_handle,
+            _p: PhantomData,
+        }
+    }
+
+    /// get the handle of the bus the device is attached to
+    pub fn bus(&self) -> onewire::onewire_bus_handle_t {
+        self._device.bus
+    }
+
+    /// get the device address
+    pub fn address(&self) -> u64 {
+        self._device.address
+    }
+}
+
+/// wrapper around the device iterator to search for available devices on the bus
+pub struct DeviceSearch {
+    _search: onewire::onewire_device_iter_handle_t,
+}
+
+impl DeviceSearch {
+    fn new(bus: &mut BusDriver) -> Result<Self, EspError> {
+        let mut my_iter: onewire::onewire_device_iter_handle_t = ptr::null_mut();
+
+        esp!(unsafe { onewire::onewire_new_device_iter(bus._bus, &mut my_iter) })?;
+
+        Ok(Self { _search: my_iter })
+    }
+
+    pub fn next_device(&mut self) -> Result<Device, EspError> {
+        let mut next_onewire_device = onewire::onewire_device_t::default();
+        esp!(unsafe {
+            onewire::onewire_device_iter_get_next(self._search, &mut next_onewire_device)
+        })?;
+
+        Ok(Device::new(next_onewire_device))
+    }
+}
+
+impl Drop for DeviceSearch {
+    fn drop(&mut self) {
+        esp!(unsafe { onewire::onewire_del_device_iter(self._search) }).unwrap();
+    }
+}
+
+/// beep beep
+pub struct BusDriver<'d> {
+    _bus: onewire::onewire_bus_handle_t,
+    _p: PhantomData<&'d ()>,
+}
+
+impl<'d> BusDriver<'d> {
+    pub fn new(
+        pin: impl Peripheral<P = impl crate::gpio::InputPin + crate::gpio::OutputPin> + 'd,
+    ) -> Result<Self, EspError> {
+        let mut bus: onewire::onewire_bus_handle_t = ptr::null_mut();
+
+        let pin = pin.into_ref().pin();
+        let bus_config = esp_idf_sys::onewire::onewire_bus_config_t { bus_gpio_num: pin };
+
+        let rmt_config = esp_idf_sys::onewire::onewire_bus_rmt_config_t { max_rx_bytes: 10 };
+
+        esp!(unsafe { onewire::onewire_new_bus_rmt(&bus_config, &rmt_config, &mut bus as _) })?;
+
+        Ok(Self {
+            _bus: bus,
+            _p: PhantomData,
+        })
+    }
+    /// send reset pulse to the bus
+    pub fn reset_bus(&mut self) -> Result<(), EspError> {
+        esp!(unsafe { onewire::onewire_bus_reset(self._bus) })
+    }
+
+    pub fn search(&mut self) -> Result<DeviceSearch, EspError> {
+        DeviceSearch::new(self)
+    }
+}
+
+impl<'d> Drop for BusDriver<'d> {
+    fn drop(&mut self) {
+        esp!(unsafe { onewire::onewire_bus_del(self._bus) }).unwrap();
+    }
+}

src/peripherals.rs

@@ -10,6 +10,7 @@ use crate::mac;
 use crate::modem;
 #[cfg(any(esp32, esp32s2, esp32s3, esp32c6))]
 use crate::pcnt;
+#[cfg(feature = "legacy_rmt")]
 use crate::rmt;
 use crate::spi;
 #[cfg(any(
@@ -71,6 +72,7 @@ pub struct Peripherals {
     pub ledc: ledc::LEDC,
     #[cfg(esp32)]
     pub hledc: ledc::HLEDC,
+    #[cfg(feature = "legacy_rmt")]
     pub rmt: rmt::RMT,
     #[cfg(all(
         any(esp32, esp32s2, esp32s3, esp32c6, esp32p4),
@@ -168,6 +170,7 @@ impl Peripherals {
             ledc: ledc::LEDC::new(),
             #[cfg(esp32)]
             hledc: ledc::HLEDC::new(),
+            #[cfg(feature = "legacy_rmt")]
             rmt: rmt::RMT::new(),
             #[cfg(all(
                 any(esp32, esp32s2, esp32s3, esp32c6, esp32p4),

src/rmt.rs

@@ -11,7 +11,7 @@
 //!
 //! Not supported:
 //! * Interrupts.
-//! * Receiving.
+//! * ~Receiving.~
 //! * Change of config after initialisation.
 //!
 //! # Example