diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-26 14:16:51 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-06-26 14:16:51 +0200 |
| commit | c1473020106d36b20cde090ac417c253b0059336 (patch) | |
| tree | c26a922dd3aad35fb11088534c055ad79683541c /client | |
| parent | ad3e4f50ab83036ab974b4f30295c873dac3c7f0 (diff) | |
fix up documentation some more
Diffstat (limited to 'client')
| -rw-r--r-- | client/cmd.h | 15 | ||||
| -rw-r--r-- | client/readme.md | 20 |
2 files changed, 27 insertions, 8 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; diff --git a/client/readme.md b/client/readme.md index d99991f..375e8c1 100644 --- a/client/readme.md +++ b/client/readme.md @@ -10,20 +10,24 @@ game operator to control and monitor the state of a puzzle box, but is also a useful debugging tool when developing puzzle modules, as it allows you to send arbitrary data over the puzzle bus. +> [!NOTE] +> The client depends on the [GNU readline][readline] library, which is not +> included as a submodule because it is installed on most Linux distributions +> by default. Please ensure you have the readline development headers installed +> for your distribution of choice. + ## Features -- List detected puzzle modules -- Reset puzzle modules (individually or all to reset the box) -- Skip puzzle modules (individually or all) -- Request puzzle box state +- Individually reset puzzle modules +- Individually skip puzzle modules - Debug: send arbitrary messages ## Usage -See \ref pbc_cmd_usage "command usage" for individual command usage. +See [command usage](#pbc_cmd_usage) -## WIP TODO +## Bugs -- add enum to string functions in CLIENT ONLY -- bug: tab completion for `dump` seems to print garbage sometimes +- tab completion for the `dump` command seems to print garbage (sometimes) +[readline]: https://www.gnu.org/software/readline |