1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
|
function [gamepadIndices, productNames, allInfos]= GetGamepadIndices(product, serialNumber, locationID)
% [gamepadIndices, productNames, allInfos] = GetGamepadIndices([productName][, serialNumber][, locationID])
%
% PsychHID assigns each USB HID device connected to you computer a
% unique index. GetGamepadIndices returns the indices for those HID devices
% which are gamepads. The product names of each gamepad are returned in a
% second argument which is useful to identify the gamepad associated with
% an index. The third return argument is a cell-array with complete
% information about the gamepad device, e.g., allInfos{1} returns
% all known info about the 1st detected gamepad.
%
% If you have multiple gamepads connected you can restrict the set of
% returned gamepads by specifying the following optional match-critera:
%
% product = Product name of target devices, as returned in 'productNames'.
%
% serialNumber = Serial number of target devices. This is a text string,
% not a number!
%
% locationID = Numeric id of where the device is connected to the
% computer. The number is supposed to be unique for a given
% connection port. E.g., the same number will be returned
% whenever the device is connected to the same USB port of
% the computer. The value should be persistent across
% reboots of the machine, but may not be persistent across
% operating system upgrades - or may not be persistent at
% all in case of os bugs. Your mileage may vary...
% On Linux X11 this is currently remapped to interfaceID,
% as locationID is not meaningful in the current implementation.
%
% LINUX: _______________________________________________________________________
% See Linux specific help section in "help Gamepad" for needed setup on Linux.
%
% WINDOWS: _____________________________________________________________________
% GetGamepadIndices does not work on Windows.
% _________________________________________________________________________
%
% see also: GetKeyboardIndices
% HISTORY
% 7/6/03 awi Wrote it.
% 7/13/04 awi Improved documentation
% 1/20/05 mk Added fix for Logitech joystick (Forum msg. 4149)
% 9/07/16 mk Add matching logic for selection of subsets of devices.
% 7/06/22 mk Refine for Linux/X11: Only match floating slaves by default,
% fallback to regular slave pointers only if needed. Filter out
% devices with zero axes.
if nargin < 1
product = [];
end
if nargin < 2
serialNumber = [];
end
if nargin < 3
locationID = [];
end
gamepadIndices=[];
productNames=cell(0);
allInfos=cell(0);
if ~IsOSX
% On Linux/X11, we first only try if there are floating slave devices,
% as suitable X11 InputClass joystick config files will set recognized
% joysticks/gamepads as floating and assign the joystick or evdev driver:
d = PsychHID('Devices', 5);
% Only if no such floating devices are found for some reason, fallback to
% classic slave pointer devices, which will also match mice and other usually
% less wanted stuff:
if length(d) == 0
d = PsychHID('Devices', 3);
end
else
% On macOS, get all devices, filter below by usagePageValue + usageValue:
d = PsychHID('Devices');
end
for i = 1:length(d)
% macOS: Filter by HID usagePageValue/usageValue.
% Linux: Prefiltered above, also assume any Gamepad/Joystick has some axes:
if (IsLinux && (d(i).axes > 0)) || (d(i).usagePageValue==1 && (d(i).usageValue == 5 || d(i).usageValue == 4))
% Check if additional match-criteria provided. Skip this device on mismatch:
if ~isempty(product) && ~strcmpi(d(i).product, product)
continue;
end
if ~isempty(serialNumber) && ~strcmpi(d(i).serialNumber, serialNumber)
continue;
end
if ~isempty(locationID) && IsOSX && (d(i).locationID ~= locationID)
continue;
end
if ~isempty(locationID) && IsLinux && (d(i).interfaceID ~= locationID)
continue;
end
% Match! Append to list of gamepads, including optional
% detailed information:
gamepadIndices(end+1)=d(i).index; %#ok<AGROW>
productNames{end+1}=d(i).product; %#ok<AGROW>
allInfos{end+1}=d(i); %#ok<AGROW>
end
end
|