aboutsummaryrefslogtreecommitdiff
path: root/main
diff options
context:
space:
mode:
Diffstat (limited to 'main')
-rw-r--r--main/i2c.c11
-rw-r--r--main/i2c.h1
-rw-r--r--main/index.dox7
3 files changed, 19 insertions, 0 deletions
diff --git a/main/i2c.c b/main/i2c.c
index 93b64db..87c8161 100644
--- a/main/i2c.c
+++ b/main/i2c.c
@@ -48,6 +48,17 @@ void bus_task() {
}
}
+/**
+ * \ingroup main_pb_override
+ * \anchor main_route_cmd_magic_res
+ *
+ * This function registers the I2C address of the puzzle module that replied to
+ * the \c MAGIC \c REQ command into a list of "known puzzle modules", which are
+ * then periodically updated during gameplay.
+ *
+ * \note Up to \ref CFG_PB_MOD_MAX puzzle modules can be registered
+ * simultaniously.
+ */
void pb_route_cmd_magic_res(pb_msg_t * msg) {
if (modules_size == CFG_PB_MOD_MAX) return;
modules[modules_size++] = msg->sender;
diff --git a/main/i2c.h b/main/i2c.h
index 107a04d..27c0b02 100644
--- a/main/i2c.h
+++ b/main/i2c.h
@@ -15,3 +15,4 @@
void bus_task();
/// \}
+
diff --git a/main/index.dox b/main/index.dox
index aa2d07a..0fee58a 100644
--- a/main/index.dox
+++ b/main/index.dox
@@ -4,3 +4,10 @@
\defgroup main_tasks tasks
\brief Tasks
*/
+
+/**
+\ingroup main
+\defgroup main_pb_override overrides
+\brief Override functions from \ref pbdrv-mod
+*/
+