aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-06-26 14:44:04 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-06-26 14:44:04 +0200
commitcdd1034144da2f606d8f2a57061f694cdaa96cc1 (patch)
treea28a208f6a359a199b239ceb441b477db66dddb4 /lib/pbdrv
parentc1473020106d36b20cde090ac417c253b0059336 (diff)
more important documentation
Diffstat (limited to 'lib/pbdrv')
-rw-r--r--lib/pbdrv/pb.h21
1 files changed, 9 insertions, 12 deletions
diff --git a/lib/pbdrv/pb.h b/lib/pbdrv/pb.h
index e9c803d..6f84d10 100644
--- a/lib/pbdrv/pb.h
+++ b/lib/pbdrv/pb.h
@@ -15,34 +15,31 @@
//! I2C bus timeout delay in microseconds
#define PB_TIMEOUT_US (1e3 * PB_TIMEOUT_MS)
-//! Null address (used by client)
-#define PB_ADDR_NULL 0x00
-
-//! Adafruit NeoTrellis module 1 I2C address
+//! Adafruit NeoTrellis module 1 I2C address \ingroup puz_neo
#define PB_ADDR_ADA_NEO_1 0x2E
-//! Adafruit NeoTrellis module 2 I2C address
+//! Adafruit NeoTrellis module 2 I2C address \ingroup puz_neo
#define PB_ADDR_ADA_NEO_2 0x2F
-//! Adafruit NeoTrellis module 3 I2C address
+//! Adafruit NeoTrellis module 3 I2C address \ingroup puz_neo
#define PB_ADDR_ADA_NEO_3 0x30
-//! Adafruit NeoTrellis module 4 I2C address
+//! Adafruit NeoTrellis module 4 I2C address \ingroup puz_neo
#define PB_ADDR_ADA_NEO_4 0x32
-//! Main controller I2C address
+//! Main controller I2C address \ingroup main
#define PB_ADDR_MOD_MAIN 0x08
-//! NeoTrellis puzzle module I2C address
+//! NeoTrellis puzzle module I2C address \ingroup puz_neo
#define PB_ADDR_MOD_NEOTRELLIS 0x21
//! Software puzzle module I2C address
#define PB_ADDR_MOD_SOFTWARE 0x22
//! Hardware puzzle module I2C address
#define PB_ADDR_MOD_HARDWARE 0x23
-//! Vault puzzle module I2C address
+//! Vault puzzle module I2C address \ingroup puz_vault
#define PB_ADDR_MOD_VAULT 0x24
//! Automation puzzle module I2C address
#define BUSADDR_MOD_AUTOMATION 0x25
-//! Smoketest puzzle module I2C address
+//! Smoketest puzzle module I2C address \ingroup puz_smoketest
#define PB_ADDR_MOD_SMOKETEST 0x26
-//! Dummy puzzle module I2C address
+//! Dummy puzzle module I2C address \ingroup puz_dummy
#define PB_ADDR_MOD_DUMMY 0x69
/// \}