aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/drv/arduino/index.dox
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-06-23 13:31:49 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-06-23 13:31:49 +0200
commit648d87ea98ec39d5745d36a0b5c5078cd9491211 (patch)
treed57d3cd5fb736012d6ac81a2e96e5244e56b9a77 /lib/pbdrv/drv/arduino/index.dox
parent381c80d765628f5d85b58b3b97e5a6bf3a0d1eb7 (diff)
place rp2040 back in pbdrv
Diffstat (limited to 'lib/pbdrv/drv/arduino/index.dox')
-rw-r--r--lib/pbdrv/drv/arduino/index.dox20
1 files changed, 12 insertions, 8 deletions
diff --git a/lib/pbdrv/drv/arduino/index.dox b/lib/pbdrv/drv/arduino/index.dox
index 4c74222..1856918 100644
--- a/lib/pbdrv/drv/arduino/index.dox
+++ b/lib/pbdrv/drv/arduino/index.dox
@@ -2,18 +2,22 @@
/**
\ingroup pb_drv
\defgroup pb_drv_arduino Arduino
-\brief Arduino (Arduino-CMake-Toolchain) driver
-
-This driver is automatically enabled if the variable \c ARDUINO is defined in
-your CMakeLists.txt (it is by default when using Arduino-CMake-Toolchain).
-
-\note This driver automatically includes the
-\ref pb_ext_freertos "FreeRTOS extension" for deferring calls to \c
-pb_i2c_recv() from the I2C ISR.
+\brief Arduino ATmega (w/ Arduino-CMake-Toolchain) driver
This driver is known to work with the following MCUs:
- ATmega328P (Arduino Uno)
- ATmega2560 (Arduino Mega)
+\par Usage
+- Link the \c pbdrv-mod library with your main executable
+- Load an \ref pb_ext "extension"
+
+\note This driver is automatically enabled if the variable \c ARDUINO is
+defined in your CMakeLists.txt (it is by default when using
+Arduino-CMake-Toolchain).
+
+A complete example for this driver is available in the \ref puzzle/dummy
+folder.
+
*/