Update daemon protocol documentation

This change ensures that the documentation is in sync with the code.

[skip ci]
fix-multiple-scroll-events
nirenjan 2023-01-04 10:07:20 -08:00
parent ebca9566d7
commit d3973a0abf
1 changed files with 5 additions and 20 deletions

View File

@ -193,10 +193,9 @@ A side effect of this is that the client could request a set for any arbitrary
section and key pair, and if that pair was not recognized, it would be ignored, section and key pair, and if that pair was not recognized, it would be ignored,
but the daemon would still send an `OK` response. but the daemon would still send an `OK` response.
Finally, this will only set the value within the configuration memory This will set the value within the configuration memory structures, and will
structures, and will not invoke any callback to update the rest of the threads immediately invoke the relevant callback to update the rest of the threads or
or device state. The client will need to call the `apply` subcommand to actually device state.
invoke the necessary callbacks.
\b Arguments \b Arguments
@ -221,22 +220,6 @@ invoke the necessary callbacks.
ERR\0Error 22 setting 'led.fire'='none': Invalid argument\0 ERR\0Error 22 setting 'led.fire'='none': Invalid argument\0
``` ```
# Apply configuration
The `config apply` command will invoke all the callbacks and ensure that the
configuration is applied to the running state.
\b Arguments
- `config`
- `apply`
\b Returns
- `OK`
- `config`
- `apply`
*/ */
/** /**
@ -259,12 +242,14 @@ user to fine tune the logging while the daemon is running.
of modules is below: of modules is below:
- \c Config - \c Config
- \c Cllient
- \c Clock - \c Clock
- \c Command - \c Command
- \c Device - \c Device
- \c IO - \c IO
- \c LED - \c LED
- \c Mouse - \c Mouse
- \c Notify
# Logging levels # Logging levels