aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/drv/arduino/index.dox
diff options
context:
space:
mode:
authorElwin Hammer <elwinhammer@gmail.com>2024-06-22 22:32:30 +0200
committerGitHub <noreply@github.com>2024-06-22 22:32:30 +0200
commita9eb2013e6b7297cfce4116179f4ab2d58d1c8d6 (patch)
tree0f16b75795d9926c5ea4a8ef52a695365837a8e4 /lib/pbdrv/drv/arduino/index.dox
parentf121de7c7e3ca8f0dc526973a5ee2586485aad22 (diff)
parentd6440954806d381dae5b3df65b43192f897018c6 (diff)
Merge pull request #21 from lonkaars/master
Updating branch
Diffstat (limited to 'lib/pbdrv/drv/arduino/index.dox')
-rw-r--r--lib/pbdrv/drv/arduino/index.dox19
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/pbdrv/drv/arduino/index.dox b/lib/pbdrv/drv/arduino/index.dox
new file mode 100644
index 0000000..4c74222
--- /dev/null
+++ b/lib/pbdrv/drv/arduino/index.dox
@@ -0,0 +1,19 @@
+// vim:ft=doxygen
+/**
+\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.
+
+This driver is known to work with the following MCUs:
+- ATmega328P (Arduino Uno)
+- ATmega2560 (Arduino Mega)
+
+*/
+