Mercurial > brewboard / file diff

--- a/components/esp32-owb/include/owb_gpio.h	Mon Feb 19 15:07:28 2024 +0100
+++ b/components/esp32-owb/include/owb_gpio.h	Mon Jun 24 17:05:20 2024 +0200
@@ -23,6 +23,16 @@
  * SOFTWARE.
  */
 
+/**
+ * @file
+ * @brief Interface definitions for the ESP32 GPIO driver used to communicate with devices
+ *        on the One Wire Bus.
+ *
+ * @deprecated
+ * This driver is deprecated and may be removed at some stage. It is not recommended for use
+ * due to issues with imprecise timing.
+ */
+
 #pragma once
 #ifndef OWB_GPIO_H
 #define OWB_GPIO_H
@@ -34,7 +44,7 @@
 #endif
 
 /**
- * @brief 1-wire bus connection on the gpio.
+ * @brief GPIO driver information
  */
 typedef struct
 {