++Files | |
| file | x52dcomm.h [code] |
| Functions, structures and enumerations for the Saitek X52 MFD & LED daemon communication library. | |
| ▼ libx52 | |
| libx52.h | Functions, structures and enumerations for the Saitek X52 MFD & LED driver library |
| ▼ libx52io | |
| libx52io.h | Functions, structures and enumerations for the Saitek X52 IO driver library |
| ▼ libx52util | |
| libx52util.h | Utility functions for the Saitek X52 MFD & LED driver library |
| ▼ daemon | |
| x52dcomm.h | Functions, structures and enumerations for the Saitek X52 MFD & LED daemon communication library |
| ▼ libx52 | |
| libx52.h | Functions, structures and enumerations for the Saitek X52 MFD & LED driver library |
| ▼ libx52io | |
| libx52io.h | Functions, structures and enumerations for the Saitek X52 IO driver library |
| ▼ libx52util | |
| libx52util.h | Utility functions for the Saitek X52 MFD & LED driver library |
|
+ libx52
+ 0.2.3
+
+ Saitek X52/X52Pro drivers for Linux/Unix
+ |
+
These functions are used to communicate with the X52 daemon. +More...
++Functions | |
| int | x52d_dial_command (const char *sock_path) |
| Open a connection to the daemon. More... | |
| int | x52d_send_command (int sock_fd, char *buffer, size_t buflen) |
| Send a command to the daemon and retrieve the response. More... | |
These functions are used to communicate with the X52 daemon.
+| int x52d_dial_command | +( | +const char * | +sock_path | ) | ++ |
Open a connection to the daemon.
+This method opens a socket connection to the daemon command socket. This socket allows the client to issue commands and retrieve data. The sock_path parameter may be NULL, in which case, it will use the default socket path.
The client will need to use the returned descriptor to communicate with the daemon using x52d_send_command. Once finished, the client may use the close(2) method to close the file descriptor.
| [in] | sock_path | Path to the daemon command socket. |
errno accordingly.| E2BIG | returned if the passed socket path is too big |
| int x52d_send_command | +( | +int | +sock_fd, | +
| + | + | char * | +buffer, | +
| + | + | size_t | +buflen | +
| + | ) | ++ |
Send a command to the daemon and retrieve the response.
+The client sends the command and parameters as a single NULL terminated string, and retrieves the response in the same manner. Depending on the result, the return status is either a positive integer or -1, and errno is set accordingly.
buffer should contain sufficient space to accomodate the returned response string.
This is a blocking function and will not return until either a response is received from the server, or an exception condition occurs.
+| [in] | sock_fd | Socket descriptor returned from x52d_dial_command |
| [in,out] | buffer | Pointer to the string containing the command and parameters. This is also used to save the returned response. |
| [in] | buflen | Length of the buffer to hold the returned response. |
errno is set accordingly.
+ 1.8.17
+
+
+
diff --git a/libx52_integration.html b/libx52_integration.html
index 1184b37..4cf5cfd 100644
--- a/libx52_integration.html
+++ b/libx52_integration.html
@@ -97,7 +97,7 @@ $(function() {
Most libx52 functions to update the joystick state do not directly write to the connected joystick, but only update internal data structures within the device context. In order to actually update the joystick, the application must call libx52_update. This function writes the updates to the joystick and resets any internal state.
Example
@@ -105,11 +105,11 @@ Joystick UpdatesMost libx52 functions return a standard libx52_error_code integer value that indicates the status of the operation. As long as the operation succeeded, the function will return LIBX52_SUCCESS. Other values returned indicate a failure of some sort.
libx52_strerror can convert the return code into a descriptive string that may be displayed to users.
-libx52_strerror automatically handles internationalization. As long as your application sets up the locale correctly, and the error strings have been translated to that locale, the returned strings will correspond to the translated values for your locale.
diff --git a/menudata.js b/menudata.js index 0818cc5..4a1a0a8 100644 --- a/menudata.js +++ b/menudata.js @@ -34,9 +34,11 @@ var menudata={children:[ {text:"File List",url:"files.html"}, {text:"Globals",url:"globals.html",children:[ {text:"All",url:"globals.html",children:[ -{text:"l",url:"globals.html#index_l"}]}, +{text:"l",url:"globals.html#index_l"}, +{text:"x",url:"globals.html#index_x"}]}, {text:"Functions",url:"globals_func.html",children:[ -{text:"l",url:"globals_func.html#index_l"}]}, +{text:"l",url:"globals_func.html#index_l"}, +{text:"x",url:"globals_func.html#index_x"}]}, {text:"Typedefs",url:"globals_type.html"}, {text:"Enumerations",url:"globals_enum.html"}, {text:"Enumerator",url:"globals_eval.html",children:[ diff --git a/modules.html b/modules.html index 5756f8b..0ed7faa 100644 --- a/modules.html +++ b/modules.html @@ -69,14 +69,15 @@ $(function() {| Library Initialization and Deinitialization | These functions are used at application entry and exit |
| Device Handling | Handle connections to the device |
| MFD & LED control | Control the MFD text and LED states |
| Clock control | Control the clocks on the MFD |
| Miscellaneous | Miscellaneous functionality |
| Stringification | Translation APIs from enumerations to string, primarily for logging |
| IO Library APIs | These functions allow an application to connect to a supported X52/X52Pro joystick and read the state of the buttons and axes |
| Utility Functions | These functions simplify some of the data handling for MFD & LED control |
| Daemon communication | These functions are used to communicate with the X52 daemon |
| Library Initialization and Deinitialization | These functions are used at application entry and exit |
| Device Handling | Handle connections to the device |
| MFD & LED control | Control the MFD text and LED states |
| Clock control | Control the clocks on the MFD |
| Miscellaneous | Miscellaneous functionality |
| Stringification | Translation APIs from enumerations to string, primarily for logging |
| IO Library APIs | These functions allow an application to connect to a supported X52/X52Pro joystick and read the state of the buttons and axes |
| Utility Functions | These functions simplify some of the data handling for MFD & LED control |
|
+ libx52
+ 0.2.3
+
+ Saitek X52/X52Pro drivers for Linux/Unix
+ |
+
+x52ctl - Command line controller to X52 daemon +
+x52ctl [-i] [-s socket-path] [command]
x52ctl is a program that can be used to communicate with the X52 daemon. It can be used either as a one-shot program that can be run from another program or script, or it can be run interactively.
+Commands are sent to the running daemon, and responses are written to standard output.
+If not running interactively, then you must specify a command, or the program will exit with a failure exit code. If running interactively, the program will request input and send that to the daemon, until the user either enters the string "quit", or terminates input by using Ctrl+D.
+
+ 1.8.17
+
+
+
diff --git a/x52dcomm_8h.html b/x52dcomm_8h.html
new file mode 100644
index 0000000..912bdac
--- /dev/null
+++ b/x52dcomm_8h.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+|
+ libx52
+ 0.2.3
+
+ Saitek X52/X52Pro drivers for Linux/Unix
+ |
+
Functions, structures and enumerations for the Saitek X52 MFD & LED daemon communication library. +More...
+ +Go to the source code of this file.
++Functions | |
| int | x52d_dial_command (const char *sock_path) |
| Open a connection to the daemon. More... | |
| int | x52d_send_command (int sock_fd, char *buffer, size_t buflen) |
| Send a command to the daemon and retrieve the response. More... | |
Functions, structures and enumerations for the Saitek X52 MFD & LED daemon communication library.
+This file contains the type, enum and function prototypes for the Saitek X52 daemon communication library. These functions allow a client application to communicate with a running X52 daemon, execute commands and retrieve data.
+ +
+ 1.8.17
+
+
+
diff --git a/x52dcomm_8h_source.html b/x52dcomm_8h_source.html
new file mode 100644
index 0000000..0411d42
--- /dev/null
+++ b/x52dcomm_8h_source.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+
+|
+ libx52
+ 0.2.3
+
+ Saitek X52/X52Pro drivers for Linux/Unix
+ |
+
+ 1.8.17
+
+
+