/*
* Saitek X52 Pro MFD & LED driver
*
* Copyright (C) 2015 Nirenjan Krishnan (nirenjan@nirenjan.org)
*
* SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
*/
/**
@page x52cli Command Line Interface to libx52
\htmlonly
x52cli - Command line interface to libx52
\endhtmlonly
# SYNOPSIS
\b x52cli \a commands [\a command-options]
# DESCRIPTION
\b x52cli is a command line interface to the X52 library that allows you to set
the LEDs and different parameters on the multifunction display (MFD).
Running \b x52cli without any arguments will display a brief help message.
# COMMANDS
Commands are not case sensitive.
- \b bri { \b mfd | \b led } < \a brightness >
\n \manonly \fR \endmanonly
Set the brightness of the \b MFD or LEDs. \a brightness can be any
numeric value between 0 and 128. Higher values are accepted, but may not have
the desired effect.
- \b mfd < \a line > < \a text > \n \manonly \fR \endmanonly
Set the text on the MFD \a line. \a line can be \c 0, \c 1 or \c 2, and refers
to the first, second or third line of the multifunction display respectively.
\a text cannot have embedded NUL characters (0x00) and must correspond with
the character map fo the MFD. \a text should be quoted in order to preserve
embedded whitespace. To pass raw hex values, use \b printf(1) as shown in the
\ref x52cli_examples section. Note that \a text is limited to a length of 16
characters. While you can pass in longer strings, they will be silenty
truncated.
- \b led < \a led-id > < \a state > \n \manonly \fR \endmanonly
Set the LED \a led-id to \a state. See \ref x52cli_leds for a list of
supported values.
- \b blink { \b on | \b off } \n \manonly \fR \endmanonly
Turn the \b blink state \b on or \b off.
- \b shift { \b on | \b off } \n \manonly \fR \endmanonly
Turn the \b shift indicator in the MFD \b on or \b off.
- \b clock { \b local | \b gmt } { \b 12hr | \b 24hr }
{ \b ddmmyy | \b mmddyy | \b yymmdd }\n \manonly \fR \endmanonly
Set the clock 1 display to the current \b local or \b GMT time and date.
Clock can be configured to display in either \b 12hr or \b 24hr mode. Date
can be displayed in one of the following formats: \b DD-MM-YY, \b MM-DD-YY,
or \b YY-MM-DD.
- \b offset { \b 2 | \b 3 } < \a offset-val >
{ \b 12hr | \b 24hr }\n \manonly \fR \endmanonly
Set the offset for clock \b 2 or \b 3 and configure them to display in either
\b 12hr or \b 24hr mode. \a offset-val is in minutes east of \b UTC and can
range from \a -1440 to \a +1440.
- \b time < \a hour > < \a minute >
{ \b 12hr | \b 24hr }\n \manonly \fR \endmanonly
Set the time for clock 1 to hour:minute and configure it to display
in \b 12hr or \b 24hr mode.
- \b date <\a dd > <\a mm > <\a yy>
{ \b ddmmyy | \b mmddyy | \b yymmdd }\n \manonly \fR \endmanonly
Set the date on the MFD to the values represented by \a dd, \a mm and \a yy in
the requested format.
- \b raw < \a wIndex > < \a wValue >\n \manonly \fR \endmanonly
Send a raw vendor control request to the connected joystick.\n
\warning You should only use the raw command if you know what you are doing.
Sending an invalid control sequence can potentially damage or destroy your
device.
@section x52cli_leds LEDs
This is the list of LED IDs and corresponding states supported by the X52 Pro.
Note that the \b on state is only allowed for the \b fire and \b throttle LEDs,
and they do not support the \b red, \b amber and \b green states. The remaining
LEDs do not support the \b on state, but support all the other states.
\note The \b led command is only supported on the X52 Pro, not on the X52.
## LED IDs
- \b fire
- \b a
- \b b
- \b d
- \b e
- \b t1
- \b t2
- \b t3
- \b pov
- \b clutch
- \b throttle
## States
- \b off
- \b on
- \b red
- \b amber
- \b green
# LIMITATIONS
\b x52cli does not maintain any state between invocations. As a result the
\b clock command will reset the relative offsets for clocks 2 and 3 back to 0
and configure them to be in 12 hour mode. To work around this, use the \b date
and \b time commands instead to manually configure the date and time.
# PERMISSIONS
You must have write permissions to the USB device in order to use the \b libx52
library, and by extension, \b x52cli.
The simplest method to obtain such permissions is to run \b x52cli as root,
possibly through \b sudo(8)
@section x52cli_examples EXAMPLES
- Turn off the T1 LED.
> \b x52cli led t1 off
- Turn the B LED to Amber.
> \b x52cli led B amber
- Set line 1 of the MFD to display "Hello World"
> \b x52cli mfd 0 "Hello World"
- Set line 2 of the MFD to display "¿Cómo Estás?"
> \b x52cli mfd 1 "$(printf '\\x9FC\\xE2mo Est\\xE0s?')"
*/
#define _GNU_SOURCE
#include "config.h"
#include
#include
#include
#include
#include
#include
#include "libx52.h"
struct string_map {
const char *key;
union {
libx52_clock_id clock_id;
libx52_clock_format clock_format;
libx52_date_format date_format;
libx52_led_id led_id;
libx52_led_state led_state;
int int_val;
intptr_t ptr_val;
} value;
};
// Max 4 arguments for now
#define MAX_ARGS 4
typedef int (*handler_cb)(libx52_device *x52, void *args[]);
struct command_handler {
handler_cb handler;
int num_args;
const struct string_map *maps[MAX_ARGS];
const char *help;
};
#define SAVE_ARGUMENT(type, name, arg) type name = (type)(uintptr_t)(arg)
#define PARSE_ARGUMENT(type, arg) ((type)(uintptr_t)(arg))
#define MAP(name) name##_map
#define DEFINE_MAP(name) static const struct string_map MAP(name)[]
#define MAP_CLOCK_ID(id) {.key = #id, .value.clock_id = LIBX52_CLOCK_ ## id}
#define MAP_CLOCK_FORMAT(fmt) {.key = #fmt, .value.clock_format = LIBX52_CLOCK_FORMAT_ ## fmt}
#define MAP_DATE_FORMAT(fmt) {.key = #fmt, .value.date_format = LIBX52_DATE_FORMAT_ ## fmt}
#define MAP_LED_ID(id) {.key = #id, .value.led_id = LIBX52_LED_ ## id}
#define MAP_LED_STATE(state) {.key = #state, .value.led_state = LIBX52_LED_STATE_ ## state}
#define MAP_INT(str, val) {.key = str, .value.int_val = val}
#define MAP_TERMINATOR MAP_INT(NULL, -1)
/**
* Parse a string and match it with a corresponding value
* Maps are arrays which contain a terminating entry with a NULL key.
*
* Return 0 if no match
*/
static int map_lookup(const struct string_map *map, const char *str, struct string_map *result)
{
const struct string_map *map_index = map;
/* Search through the map for a matching key */
while (map_index->key) {
if (!strcasecmp(str, map_index->key)) {
result->value = map_index->value;
return 1;
}
map_index++;
}
return 0;
}
/* Map for LED state */
DEFINE_MAP(led_state) = {
MAP_LED_STATE(OFF),
MAP_LED_STATE(ON),
MAP_LED_STATE(RED),
MAP_LED_STATE(AMBER),
MAP_LED_STATE(GREEN),
MAP_TERMINATOR
};
/* Map for LED identifier */
DEFINE_MAP(led_id) = {
MAP_LED_ID(FIRE),
MAP_LED_ID(A),
MAP_LED_ID(B),
MAP_LED_ID(D),
MAP_LED_ID(E),
MAP_LED_ID(T1),
MAP_LED_ID(T2),
MAP_LED_ID(T3),
MAP_LED_ID(POV),
MAP_LED_ID(CLUTCH),
MAP_LED_ID(THROTTLE),
MAP_TERMINATOR
};
/* Map for date format */
DEFINE_MAP(date_format) = {
MAP_DATE_FORMAT(DDMMYY),
MAP_DATE_FORMAT(MMDDYY),
MAP_DATE_FORMAT(YYMMDD),
MAP_TERMINATOR
};
/* Map for brightness setting */
DEFINE_MAP(brightness_targets) = {
MAP_INT( "mfd", 1 ),
MAP_INT( "led", 0 ),
MAP_TERMINATOR
};
/* Map for blink/shift on/off */
DEFINE_MAP(on_off) = {
MAP_INT( "off", 0 ),
MAP_INT( "on", 1 ),
MAP_TERMINATOR
};
/* Map for clock 0 timezone */
DEFINE_MAP(clock0_timezone) = {
MAP_INT( "gmt", 0 ),
MAP_INT( "local", 1 ),
MAP_TERMINATOR
};
/* Map for identifying the clock for the timezone */
DEFINE_MAP(clocks) = {
MAP_CLOCK_ID(1),
MAP_CLOCK_ID(2),
MAP_CLOCK_ID(3),
MAP_TERMINATOR
};
/* Map for identifying the time format */
DEFINE_MAP(time_format) = {
MAP_CLOCK_FORMAT(12HR),
MAP_CLOCK_FORMAT(24HR),
MAP_TERMINATOR
};
static int update_led(libx52_device *x52, void *args[])
{
return libx52_set_led_state(x52,
PARSE_ARGUMENT(libx52_led_id, args[0]),
PARSE_ARGUMENT(libx52_led_state, args[1]));
}
static int update_bri(libx52_device *x52, void *args[])
{
unsigned long int brightness = strtoul(args[1], NULL, 0);
return libx52_set_brightness(x52,
PARSE_ARGUMENT(uint8_t, args[0]), (uint16_t)brightness);
}
static int update_mfd(libx52_device *x52, void *args[])
{
uint8_t line = (uint8_t)strtoul(args[0], NULL, 0);
uint8_t length = strlen(args[1]);
return libx52_set_text(x52, line, args[1], length);
}
static int update_blink(libx52_device *x52, void *args[])
{
return libx52_set_blink(x52, PARSE_ARGUMENT(int, args[0]));
}
static int update_shift(libx52_device *x52, void *args[])
{
return libx52_set_shift(x52, PARSE_ARGUMENT(int, args[0]));
}
static int update_clock(libx52_device *x52, void *args[])
{
int rc;
rc = libx52_set_clock(x52, time(NULL),
PARSE_ARGUMENT(int, args[0]));
if (!rc) {
rc = libx52_set_clock_format(x52, LIBX52_CLOCK_1,
PARSE_ARGUMENT(libx52_clock_format, args[1]));
}
if (!rc) {
rc = libx52_set_date_format(x52,
PARSE_ARGUMENT(libx52_date_format, args[2]));
}
return rc;
}
static int update_offset(libx52_device *x52, void *args[])
{
int offset = (int)strtol(args[1], NULL, 0);
int rc;
SAVE_ARGUMENT(libx52_clock_id, clock, args[0]);
rc = libx52_set_clock_timezone(x52, clock, offset);
if (!rc) {
rc = libx52_set_clock_format(x52, clock,
PARSE_ARGUMENT(libx52_clock_format, args[2]));
}
return rc;
}
static int update_time(libx52_device *x52, void *args[])
{
int hh = (int)strtol(args[0], NULL, 0);
int mm = (int)strtol(args[1], NULL, 0);
int rc;
/* Set the time value */
rc = libx52_set_time(x52, hh, mm);
if (!rc) {
rc = libx52_set_clock_format(x52, LIBX52_CLOCK_1,
PARSE_ARGUMENT(libx52_clock_format, args[2]));
}
return rc;
}
static int update_date(libx52_device *x52, void *args[])
{
int dd = (int)strtol(args[0], NULL, 0);
int mm = (int)strtol(args[1], NULL, 0);
int yy = (int)strtol(args[2], NULL, 0);
int rc;
/* Set the date value */
rc = libx52_set_date(x52, dd, mm, yy);
if (!rc) {
rc = libx52_set_date_format(x52,
PARSE_ARGUMENT(libx52_date_format, args[3]));
}
return rc;
}
static int update_raw(libx52_device *x52, void *args[])
{
uint16_t wIndex = (uint16_t)strtoul(args[0], NULL, 0);
uint16_t wValue = (uint16_t)strtoul(args[1], NULL, 0);
return libx52_vendor_command(x52, wIndex, wValue);
}
/* Commands for CLI */
#define COMMANDS \
X(led, LED_STATE, " ", 2, \
MAP(led_id), MAP(led_state)) \
X(bri, BRIGHTNESS, "{mfd | led} ", 2, \
MAP(brightness_targets), NULL) \
X(mfd, MFD_TEXT, " ", 2, \
NULL, NULL) \
X(blink, BLINK, "{ on | off }", 1, \
MAP(on_off)) \
X(shift, SHIFT, "{ on | off }", 1, \
MAP(on_off)) \
X(clock, CLOCK, \
"{local | gmt} {12hr | 24hr} {ddmmyy | mmddyy | yymmdd}", \
3, MAP(clock0_timezone), MAP(time_format), MAP(date_format)) \
X(offset, OFFSET, \
"{2 | 3} {12hr | 24hr}", \
3, MAP(clocks), NULL, MAP(time_format)) \
X(time, TIME, \
" {12hr | 24hr}", 3, \
NULL, NULL, MAP(time_format)) \
X(date, DATE, \
" {ddmmyy | mmddyy | yymmdd}", 4, \
NULL, NULL, NULL, MAP(date_format)) \
X(raw, RAW, " ", 2, NULL, NULL)
/* Enums for command identification */
#define X(cmd, en, help, args, ...) X52_CTL_CMD_ ## en,
enum {
COMMANDS
X52_CTL_CMD_MAX
};
#undef X
/* Map for commands */
#define X(cmd, en, help, args, ...) MAP_INT( #cmd, X52_CTL_CMD_ ## en),
DEFINE_MAP(command) = {
COMMANDS
MAP_TERMINATOR
};
#undef X
/* Command handlers */
#define X(cmd, en, help, args, ...) \
[X52_CTL_CMD_ ## en] = { \
update_ ## cmd, \
args, \
{ __VA_ARGS__ }, \
#cmd " " help \
},
const struct command_handler handlers[X52_CTL_CMD_MAX] = {
COMMANDS
};
#undef X
static void do_help(const struct command_handler *cmd)
{
int i;
if (cmd) {
fprintf(stderr, "Command usage: %s\n", cmd->help);
} else {
printf("\nCommands:\n");
for (i = 0; i < X52_CTL_CMD_MAX; i++) {
printf("\t%s\n", handlers[i].help);
}
printf("\nWARNING: raw command may damage your device\n\n");
}
}
int main(int argc, char **argv)
{
libx52_device *x52;
struct string_map result;
const struct command_handler *cmd;
int i;
void *args[MAX_ARGS];
int rc;
if (argc < 2) {
fprintf(stderr, "Usage: %s [arguments]\n", argv[0]);
do_help(NULL);
return 1;
}
if (!map_lookup(command_map, argv[1], &result)) {
fprintf(stderr, "Unsupported command %s\n", argv[1]);
do_help(NULL);
return 1;
}
cmd = &handlers[result.value.int_val];
if (!cmd->handler) {
fprintf(stderr, "Command %s not implemented yet!\n", argv[1]);
return 1;
}
if (cmd->num_args > argc - 2) {
fprintf(stderr, "Insufficient arguments for command %s\n", argv[1]);
do_help(cmd);
return 1;
}
/* Clear the arguments array */
memset(args, 0, sizeof(args));
for (i = 0; i < cmd->num_args; i++) {
if (cmd->maps[i]) {
if (!map_lookup(cmd->maps[i], argv[2+i], &result)) {
fprintf(stderr, "Invalid argument %s\n", argv[2+i]);
return 1;
}
args[i] = (void *)result.value.ptr_val;
} else {
args[i] = argv[2+i];
}
}
/* Initialize libx52 */
rc = libx52_init(&x52);
if (rc != LIBX52_SUCCESS) {
fprintf(stderr, "Error initializing X52 library: %s\n", libx52_strerror(rc));
return 1;
}
/* Make sure we are connected to the joystick */
rc = libx52_connect(x52);
if (rc != LIBX52_SUCCESS) {
fprintf(stderr, "Error connecting to joystick: %s\n", libx52_strerror(rc));
return 1;
}
rc = (*(cmd->handler))(x52, args);
if (rc != LIBX52_SUCCESS) {
fprintf(stderr, "Error: %s\n", libx52_strerror(rc));
}
libx52_update(x52);
libx52_exit(x52);
return rc;
}