Merge pull request #710 from Narukara/feat/onewire_bus_uart

feat(1wire): add UART as onewire bus backend

Author: suda-morris

onewire_bus/.build-test-rules.yml

@@ -1,4 +1,6 @@
 onewire_bus/test_apps:
   disable:
-    - if: SOC_RMT_SUPPORTED != 1
-      reason: Only RMT backend is implemented
+    - if: CONFIG_NAME == "rmt" and SOC_RMT_SUPPORTED != 1
+      reason: RMT backend variant requires SOC RMT support
+    - if: CONFIG_NAME == "uart" and SOC_UART_SUPPORTED != 1
+      reason: UART backend variant requires SOC UART support

onewire_bus/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.0
+
+- Add UART backend support for 1-Wire bus (`onewire_new_bus_uart`) alongside the existing RMT backend.
+
 ## 1.0.4
 
 - Support `en_pull_up` config option in `onewire_bus_config_t`, which can enable the internal pull-up resistor on the GPIO pin used for the one-wire bus. This is useful when using a GPIO pin that does not have a pull-up resistor connected externally.

onewire_bus/CMakeLists.txt

@@ -6,10 +6,14 @@ if(CONFIG_SOC_RMT_SUPPORTED)
      list(APPEND srcs "src/onewire_bus_impl_rmt.c")
 endif()
 
+if(CONFIG_SOC_UART_SUPPORTED)
+     list(APPEND srcs "src/onewire_bus_impl_uart.c")
+endif()
+
 set(priv_requires)
-# Starting from esp-idf v5.3, the RMT drivers are moved to separate components
+# Starting from esp-idf v5.3, the peripheral drivers are in separate components
 if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_GREATER_EQUAL "5.3")
-    list(APPEND priv_requires "esp_driver_rmt" "esp_driver_gpio")
+    list(APPEND priv_requires "esp_driver_rmt" "esp_driver_uart" "esp_driver_gpio")
 else()
     list(APPEND priv_requires "driver")
 endif()

onewire_bus/README.md

@@ -2,7 +2,11 @@
 
 [![Component Registry](https://components.espressif.com/components/espressif/onewire_bus/badge.svg)](https://components.espressif.com/components/espressif/onewire_bus)
 
-This directory contains an implementation for Dallas 1-Wire bus by different peripherals. Currently only RMT is supported as the backend.
+This directory contains an implementation for Dallas 1-Wire bus by different peripherals.
+The following low-level backends are currently supported:
+
+- RMT backend (`onewire_new_bus_rmt`)
+- UART backend (`onewire_new_bus_uart`)
 
 ## Appendix
 

onewire_bus/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.0.4"
+version: "1.1.0"
 description: Driver for Dallas 1-Wire bus
 url: https://github.com/espressif/idf-extra-components/tree/master/onewire_bus
 issues: "https://github.com/espressif/idf-extra-components/issues"

onewire_bus/include/onewire_bus.h

@@ -7,8 +7,14 @@
 
 #include <stdint.h>
 #include "esp_err.h"
+#include "soc/soc_caps.h"
 #include "onewire_types.h"
+#if SOC_RMT_SUPPORTED
 #include "onewire_bus_impl_rmt.h"
+#endif
+#if SOC_UART_SUPPORTED
+#include "onewire_bus_impl_uart.h"
+#endif
 
 #ifdef __cplusplus
 extern "C" {

onewire_bus/include/onewire_bus_impl_uart.h

@@ -0,0 +1,42 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#pragma once
+
+#include <stdint.h>
+#include "esp_err.h"
+#include "onewire_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief 1-Wire bus UART specific configuration
+ */
+typedef struct {
+    int uart_port_num; /*!< UART port number, e.g. UART_NUM_1 */
+} onewire_bus_uart_config_t;
+
+/**
+ * @brief Create 1-Wire bus with UART backend
+ *
+ * @note TX and RX will both be configured to bus_config->bus_gpio_num.
+ *       And this GPIO will be configured as open-drain mode.
+ *
+ * @param[in] bus_config 1-Wire bus configuration
+ * @param[in] uart_config UART specific configuration
+ * @param[out] ret_bus Returned 1-Wire bus handle
+ * @return
+ *      - ESP_OK: create 1-Wire bus handle successfully
+ *      - ESP_ERR_INVALID_ARG: create 1-Wire bus handle failed because of invalid argument
+ *      - ESP_ERR_NO_MEM: create 1-Wire bus handle failed because of out of memory
+ *      - ESP_FAIL: create 1-Wire bus handle failed because some other error
+ */
+esp_err_t onewire_new_bus_uart(const onewire_bus_config_t *bus_config, const onewire_bus_uart_config_t *uart_config, onewire_bus_handle_t *ret_bus);
+
+#ifdef __cplusplus
+}
+#endif