Add documentation for x52d

reverse-scroll
nirenjan 2021-08-01 23:47:24 -07:00
parent 78e4f3334f
commit 38917ed6e5
6 changed files with 49 additions and 4 deletions

View File

@ -909,21 +909,21 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# command).
EXAMPLE_PATH =
EXAMPLE_PATH = @abs_top_srcdir@
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all
# files are included.
EXAMPLE_PATTERNS = *
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude commands
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.
EXAMPLE_RECURSIVE = NO
EXAMPLE_RECURSIVE = YES
# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the

View File

@ -121,7 +121,9 @@ and \b time commands instead to manually configure the date and time.
\note The device does not have an internal clock; as a result, the MFD
display will not advance automatically. You must call the \b clock or \b date
and \b time commands periodically to update the time on the device.
and \b time commands periodically to update the time on the device. However, if
you are running \b x52d and the clock manager is enabled, then \b x52d will
manage and automatically update the clock on the X52 MFD display.
# PERMISSIONS

43
daemon/daemon.dox 100644
View File

@ -0,0 +1,43 @@
/**
@page x52d X52 driver daemon
\b x52d is a daemon program that manages the X52 device in a similar fashion to
the Windows X52 driver. It currently manages the following:
- LED state
- LED brightness
- MFD brightness
- Clock display on MFD
# Command line arguments
- \c -f - Run daemon in foreground (default: no)
- \c -v - Increase logging verbosity (default: log warnings)
- \c -q - Reduce logging verbosity to minimum (default: no)
- \c -l - Path to log file
- \c -c - Path to configuration file
- \c -o - Configuration override - only applied during startup
# Configuration file
\b x52d can be controlled by means of a configuration file. The configuration
file is an INI style file, and the default configuration is as listed below:
\include x52d.conf
## Configuration overrides
Configuration overrides are a means of testing a configuration parameter for a
single instance of \b x52d, or to override the default configuration. The syntax
for an override is \c section.key=value, where \c section, \c key and \c value
correspond to the configuration \b section, \b key and \b value respectively.
For example, to override the secondary clock timezone to US Eastern Time, use
the following syntax. Note that while the section and key are case-insensitive,
the value may be case-sensitive, depending on which parameter is being
overridden.
@code{.unparsed}
-o clock.secondary=America/New_York
@endcode
*/