diff options
Diffstat (limited to 'client/cmd.h')
| -rw-r--r-- | client/cmd.h | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/client/cmd.h b/client/cmd.h index eac9834..7fee700 100644 --- a/client/cmd.h +++ b/client/cmd.h @@ -61,6 +61,9 @@ cmd_handle_t cmd_exit; /** * \brief \c test command * + * \note This command is only available in builds of \c pbc compiled with the + * \c DEBUG flag + * * ``` * (pbc) test * ``` @@ -96,6 +99,9 @@ cmd_handle_t cmd_reset; /** * \brief \c send command * + * \note This command is only available in builds of \c pbc compiled with the + * \c DEBUG flag + * * ``` * (pbc) send <addr> <data> * ``` @@ -178,6 +184,15 @@ cmd_handle_t cmd_send; cmd_handle_t cmd_skip; /** * \brief \c dump command + * + * \note This command is only available in builds of \c pbc compiled with the + * \c DEBUG flag + * + * ``` + * (pbc) dump <none|send|recv|both> + * ``` + * + * Show raw I2C messages being sent to/from the main controller. */ cmd_handle_t cmd_dump; |