Command line/en - Revision history

FuzzyBot: Updating to match new version of source page

2016-11-06T15:48:36Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2016-03-09T10:26:28Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2016-03-09T10:17:39Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2015-09-30T13:04:54Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2014-09-03T08:26:53Z

Updating to match new version of source page

Show changes

FuzzyBot: Updating to match new version of source page

2013-11-07T12:58:54Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2013-11-07T12:02:58Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2013-07-08T20:25:35Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2013-06-17T11:26:33Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2013-05-16T14:17:13Z

Updating to match new version of source page

@@ Line 161: / Line 161: @@
    gimx -c config.xml --status -t DS4
-==General gimx options==
+==Multiple controllers==
 * --curses
@@ Line 181: / Line 188: @@
 :Events that are not generated by macros are ignored.<br />
 :Another use case is the sending of a single command (it requires to use a macro as no key up event is generated).
 * --event "name(value)"
 :It's possible to send controls to the console from the command line, without having to create a configuration and macros to use with the --keygen argument.
@@ Line 197: / Line 209: @@
 * --src IP:port
 :Specifies a source IP+port to listen on. Ex: 127.0.0.1:51914.

@@ Line 194: / Line 194: @@
 :Example:
    gimx --src 127.0.0.1:51914 -t Sixaxis -b XX:XX:XX:XX:XX:XX
-   gimx --event "cross(255)" --dst 127.0.0.1:51914
+   gimx --event "abs_axis_10(255)" --dst 127.0.0.1:51914
 * --src IP:port
 :Specifies a source IP+port to listen on. Ex: 127.0.0.1:51914.
 :This argument has to be placed before the --bdaddr and --port arguments.

@@ Line 181: / Line 181: @@
 :Events that are not generated by macros are ignored.<br />
 :Another use case is the sending of a single command (it requires to use a macro as no key up event is generated).
-* --event "control(value)"
+* --event "name(value)"
 :It's possible to send controls to the console from the command line, without having to create a configuration and macros to use with the --keygen argument.
 :Example:
-   gimx --event "lstick x(127)" --event "rstick y(-128)" --event "circle(255)" --event "square(0)" -d 127.0.0.1:51914
+   gimx --event "rel_axis_0(127)" --event "rel_axis_3(-128)" --event "abs_axis_8(255)" --event "abs_axis_10(0)" -d 127.0.0.1:51914
-:This moves the left stick right, the right stick forward, fully presses the circle button, and releases the square button.
+:For a Sixaxis controller, this moves the left stick right, the right stick forward, fully presses the circle button, and releases the square button.
-:The state of all other controls is cleared, i.e. all other buttons and axes are released (in the above command, --event "square(0)" is not necessary).
+:The state of all other controls is cleared, i.e. all other buttons and axes are released (in the above command, --event "abs_axis_10(0)" is not necessary).
 :gimx should complete in about 10ms.
 :When using events, it is recommended to run two gimx instances, especially in the following cases:
 :* the target console a PS4 (one gimx instance has to be connected all the time because of the authentication)

@@ Line 102: / Line 102: @@
 . Start the DS4. It should connect to GIMX, which in turn should connect to the PS4.
-==Linux or Windows + DIY USB adapter or GPP==
+==Linux or Windows + DIY USB adapter==
 In a terminal:<br />
@@ Line 117: / Line 117: @@
 :The serial port. Ex: /dev/ttyUSB0 in Linux, COM4 in windows.<br />
 :Only mandatory for the DIY USB adapter.
 * --refresh 4
 :The refresh period, in ms.<br />
@@ Line 136: / Line 152: @@
 :The destination IP+port. Ex: 127.0.0.1:51914.<br />
 :The remote GIMX has to be started with the --src argument, with the same IP:port value.
 ==General gimx options==
@@ Line 150: / Line 174: @@
 * --subpos
 :Improve stick precision (counteract rounding issues).
 * --keygen key
 :Generate a key press at gimx startup.<br />
@@ Line 158: / Line 184: @@
 :It's possible to send controls to the console from the command line, without having to create a configuration and macros to use with the --keygen argument.
 :Example:
-   gimx -p /dev/ttyUSB0 --event "lstick x(127)" --event "rstick y(-128)" --event "circle(255)" --event "square(0)"
+   gimx --event "lstick x(127)" --event "rstick y(-128)" --event "circle(255)" --event "square(0)" -d 127.0.0.1:51914
 :This moves the left stick right, the right stick forward, fully presses the circle button, and releases the square button.
 :The state of all other controls is cleared, i.e. all other buttons and axes are released (in the above command, --event "square(0)" is not necessary).
@@ Line 167: / Line 193: @@
 :"select", "start", "PS", "l3", "r3": {0, 255} (only two values as these buttons are not pressure-sensitive)
 :"up", "right", "down", "left", "triangle", "circle", "cross", "square", "l1", "r1", "l2", "r2": [0,255]
 * --src IP:port
 :Specifies a source IP+port to listen on. Ex: 127.0.0.1:51914.
 :This argument has to be placed before the --bdaddr and --port arguments.

@@ Line 55: / Line 55: @@
 In a terminal:<br />
- GIMX later than 0.51:
+GIMX 1.10 and later:
-   emuclient --config file_name --port /dev/ttyUSBX --type joystick --refresh 4
+   emuclient --config file_name --port /dev/ttyUSBX
   or
-   emuclient -c file_name -p /dev/ttyUSBX -t joystick -r 4
+   emuclient -c file_name -p /dev/ttyUSBX
-  GIMX 1.10 and later:
+  <span style="color:#808080">GIMX 0.51 or older:
-   emuclient --config file_name --port /dev/ttyUSBX
+  emuclient --config file_name --serial --port /dev/ttyUSBX --joystick --precision 16 --refresh 4</span>
   or
-   emuclient -c file_name -p /dev/ttyUSBX
+   emuclient -c file_name -p /dev/ttyUSBX -t joystick -r 4</span>
 emuclient options:
@@ Line 72: / Line 73: @@
 :The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).<br />
 :This argument is mandatory.
 * --port /dev/ttyUSB0
 :The serial port. Ex: /dev/ttyUSB0 in Linux, COM4 in windows.<br />
 :Only mandatory for the DIY USB adapter.
 * --type joystick/GPP/360pad/Sixaxis/PS2pad
 :The type of USB adapter.
@@ Line 87: / Line 81: @@
 :Sixaxis is for the DIY USB adapter with the sixaxis firmware
 :This option is only applicable for GIMX later than 0.51.
-:Not required anymore since GIMX 1.10.
+:Optional since GIMX 1.10.
 * --refresh 4
 :The refresh period, in ms.<br />
@@ Line 96: / Line 87: @@
 :joystick/GPP/360pad/Sixaxis: 4 (250Hz)<br />
 :PS2pad: 16 (62.5Hz)
-:Not required anymore since GIMX 1.10.
+:Optional since GIMX 1.10.
 ==General emuclient options==
@@ Line 115: / Line 117: @@
 :The main use case for this is the automation of macro's execution.<br />
 :Events that are not generated by macros are ignored.<br />
-:The only way to quit is to add KEYDOWN LSHIFT and KEYDOWN ESCAPE at the end of the macro, or use --nograb and press ctrl+c into the terminal.<br />
+:<span style="color:#808080">For GIMX older than 1.10: the only way to quit is to add KEYDOWN LSHIFT and KEYDOWN ESCAPE at the end of the macro, or use --nograb and press ctrl+c into the terminal.<br /></span>
 :Another use case is the sending of a single command (it requires to use a macro as no key up event is generated).
 * --event "control(value)"

@@ Line 75: / Line 75: @@
 * --joystick / --GPP / --360pad / --Sixaxis / --PS2pad
 :The type of USB adapter.
-:--joystick is for the DIY USB adapter, and --Sixaxis is for the Bluetooth dongle.
+:--joystick is for the DIY USB adapter with the joystick firmware
 :This option is only applicable for GIMX 0.51 and older.
 * --type joystick/GPP/360pad/Sixaxis/PS2pad

@@ Line 20: / Line 20: @@
   Current Bluetooth Device Address: sixaxis_bt_address
 Get the current dongle address:
-  bdaddr -r -i hciN
+  bdaddr -i hciN
 where N is the dongle index (type "hciconfig -a" to see all dongles).
@@ Line 28: / Line 28: @@
   bdaddr -r -i hciN sixaxis_bt_address
 Check the result:
-  bdaddr -r -i hciN
+  bdaddr -i hciN
 ===Run GIMX===

@@ Line 2: / Line 2: @@
 ==Motivation==
-It's not for performance at this time, but a future release may be able to run entirely from a Linux terminal without having to run a windowing system.<br />
+GIMX can be run from a Linux terminal without having to run a windowing system.<br />
-This would improve performances on all hardwares, especially on small ones like the [http://www.raspberrypi.org/ raspberry pi] or [http://en.wikipedia.org/wiki/Thin_client thin clients].<br />
+This improves performances, especially on small targets like the [[RPi|Raspberry Pi]] or [http://en.wikipedia.org/wiki/Thin_client thin clients].<br />
 It's also useful for other stuff like automation.
 ==Linux + bluetooth==
 In a terminal:<br />
-    emu ps3_mac_address bt_device_index sixaxis_index
+ emu ps3_bt_address bt_device_index sixaxis_index
-* ps3_mac_address
+* ps3_bt_address
 :This argument is mandatory.
 * bt_device_index
@@ Line 21: / Line 45: @@
 In another terminal:<br />
-    emuclient --config file_name
+ emuclient --config file_name
 * file_name
@@ Line 31: / Line 55: @@
 In a terminal:<br />
-    GIMX 0.51 or older:
+ GIMX 0.51 or older:
-    emuclient --config file_name --serial --port /dev/ttyUSBX --joystick --precision 16 --refresh 4
+  emuclient --config file_name --serial --port /dev/ttyUSBX --joystick --precision 16 --refresh 4
-    GIMX later than 0.51:
+ GIMX later than 0.51:
-    emuclient --config file_name --port /dev/ttyUSBX --type joystick --refresh 4
+  emuclient --config file_name --port /dev/ttyUSBX --type joystick --refresh 4
 emuclient options: