XBox_Controller_Linux_Interface

KO | EN

gitlite — search

#typescript #golang #machine-learning #deep-learning #linux #nodejs #java #cli #kubernetes #awesome-list #vue #security #ios #openai

XBox_Controller_Linux_Interface

(★ 134)

An interface that interacts with an XBox One controller via the usb stream. With simple methods for object or camera control (i.e. for OpenGL contexts).

XBox_Controller_Linux_Interface Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Linux Interface for an XBox One Controller

This is a linux interface, to integrate the Xbox-Controller directly into your favorite project.
If you require different mappings or axes, please see the linux
programs: **jscal** and **jstest-gtk** to change the mapping on the controller.

It is also recommended, to calibrate the controller before using it. This is also done with: **jscal** or **jstest-gtk**.

This library possibly works with other joystick devices but is only tested with the XBox controller.

# Library Dependencies

Because some vector and quaternion based math is required to calculate the joystick movements, I provide the appropriate libraries needed to use Xbox-Controller here:

**Quaternion library:** [https://github.com/MauriceGit/Quaternion_Library](https://github.com/MauriceGit/Quaternion_Library).

**Vector library:** [https://github.com/MauriceGit/Vector_Library](https://github.com/MauriceGit/Vector_Library).

Just place the .c and .h files in the same directory and compile them with your project.

# Functionality

The only interface and functions you should use, are the documented as function heads in the **mtXboxController.h** file.
More documentation about these functions are found above the apropriate function bodies in **mtXboxController.c**.

Function | Description |
--- | ---
`int mtInitJoyControl(char* name)` | This function MUST be called before any other. It initialises the usb stream connection.
`int mtFinishJoyControl()` | This function should be called after any interaction with the Controller is finished.
`void mtCalcJoyCameraMovement(double interval)` | This function should be called in very short intervals, to allow a very smooth joystick handling. The parameter is the time since the last call to this method.
`MTVec3D mtGetJoyPosition()` | The current position is retreived (of the camera or object, controlled via the Controller).
`MTVec3D mtGetJoyUp()` | The current up-vector is retreived (of the camera or object, controlled via the Controller).
`MTVec3D mtGetJoyCenter()` | The current center point is retreived (of the camera or object, controlled via the Controller).

# Calibration

There are two constants, to change the sensitivity of the joystick input. They are found in the `mtXboxController.h` and can be
changed at will. Please ensure, that these values are of floating point.

Changes might be necessary depending on your application and size of your virtual environment.

Name | Default Value | Description
 --- | --- | ---
`MT_XBOX_TRANS_NORMALISATION` | 500000.0 | The smaller this value, the faster the translation will get. Affected are: Right stick, LT Axis and RT Axis (See: [Controller Assignment](#controller-assignment)).
`MT_XBOX_TURN_NORMALISATION`  | 2000.0   | The smaller this value, the faster Pitch and Yaw will be. Left stick is affected (See: [Controller Assignment](#controller-assignment)).

The following constants will affect the axis and give them an offset (if value > 0).
The offset could be used, to for example ignore the negative axis values.

Name | Default Value | Assignment
 --- | --- | ---
`MT_AXIS_2_OFFSET` | 32768 | LT Axis
`MT_AXIS_3_OFFSET` | 0 | Left stick
`MT_AXIS_4_OFFSET` | 0 | Right stick
`MT_AXIS_5_OFFSET` | 32768 | RT Axis

See also: [Controller Assignment](#controller-assignment).

# What about the Buttons?

You might have noticed that we ignored any buttons from your Controller and the `mtXboxController` does in fact not give you any interface
for buttons. Reason for that is, that this controller interface acts as an abstraction level for the transformation of axis movements
to 3D orientation calculation, that internally uses Quaternions.

Buttons don't need fancy calculations and abstractions around them. So if you like to implement actions for your Xbox Controller buttons,
just include the `mtJoystick.h` and call the appropriate function directly (`int getButtonValue(int buttonNumber, short * value)`).

# Usage

This library can be used to control a camera or object in a 3D environment.

The following example uses the Controller to move the camera in an OpenGL context.

```c
// This is done right at the start of your program, before entering the main loop.
char* jsSource = "/dev/input/js0";
if (!mtInitJoyControl(jsSource)) {
    // Error. Initialisation failed.
}

...

// In GLUT or GLFW, there is a timer, allowing us to get the time interval between
// two frames. We need this interval, to update the camera position via the Controller
float interval = ...
mtCalcJoyMovement(interval);

...

// Later, we want to set our camera position and direction with gluLookAt().
// The result of our functions fit exactly into this scheme.
MTVec3D cam = mtGetJoyPosition();
MTVec3D center = mtGetJoyCenter();
MTVec3D up = mtGetJoyUp();
gluLookAt (cam.x,    cam.y,    cam.z,
           center.x, center.y, center.z,
           up.x,     up.y,     up.z);

...

// Don't forget, to nicely kill the controller ;)
mtFinishJoyControl();
```

# Controller Assignment

All code is tested with the XBox One controller (see following image).

![XBox Controller](https://github.com/MauriceGit/XBox_Controller_Linux_Interface/blob/master/Images/controller.png "XBox controller")

The following axes are assigned:

Axis | Assignment
 --- | ---
![LT Axis](https://github.com/MauriceGit/XBox_Controller_Linux_Interface/blob/master/Images/XboxOne_LT.png "LT Axis") | Increases the height of the object/camera along the Y axis.
![RT Axis](https://github.com/MauriceGit/XBox_Controller_Linux_Interface/blob/master/Images/XboxOne_RT.png "RT Axis") | Decreases the height of the object/camera along the Y axis.
![Left Stick](https://github.com/MauriceGit/XBox_Controller_Linux_Interface/blob/master/Images/XboxOne_Left_Stick.png "Left Stick") | Controls the Pitch and Yaw axis. (Front/Back: Pitch, Left/Right: Yaw).
![Right Stick](https://github.com/MauriceGit/XBox_Controller_Linux_Interface/blob/master/Images/XboxOne_Right_Stick.png "Right Stick") | Moves the object/camera on the X/Z plane relative to the current position and orientation. Front/Back/Left/Right accordingly.

XBox_Controller_Linux_Interface

XBox_Controller_Linux_Interface Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

XBox_Controller_Linux_Interface

XBox_Controller_Linux_Interface Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README