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
|
/*
* PsychToolbox3/Source/Common/PsychHID/PsychHIDSynopsis.c
*
* AUTHORS:
*
* Allen.Ingling@nyu.edu awi
* mario.kleiner.de@gmail.com mk
*
* PLATFORMS: All
*
* PROJECTS: PsychHID
*
* HISTORY:
*
* 06/20/03 awi Wrote it. Based on ScreenSynopsis
*
*/
#include "PsychHID.h"
#define MAX_SYNOPSIS_STRINGS 500
static const char *synopsisSYNOPSIS[MAX_SYNOPSIS_STRINGS];
const char** InitializeSynopsis(void)
{
int i=0;
const char **synopsis = synopsisSYNOPSIS; // abbreviate the long name
synopsis[i++] = "Usage:";
synopsis[i++] = "\n\nGeneral commands:\n\n";
synopsis[i++] = "rc = PsychHID('KeyboardHelper', commandCode)";
synopsis[i++] = "\n\nSupport for generic USB-HID devices:\n\n";
synopsis[i++] = "numberOfDevices=PsychHID('NumDevices')";
synopsis[i++] = "devices=PsychHID('Devices' [, deviceClass])";
#if PSYCH_SYSTEM == PSYCH_OSX
synopsis[i++] = "numberOfElements=PsychHID('NumElements',deviceNumber)";
synopsis[i++] = "elements=PsychHID('Elements',deviceNumber)";
synopsis[i++] = "numberOfCollections=PsychHID('NumCollections',deviceNumber)";
synopsis[i++] = "collections=PsychHID('Collections',deviceNumber)";
synopsis[i++] = "elementState=PsychHID('CalibratedState',deviceNumber,elementNumber)";
#endif
synopsis[i++] = "elementState=PsychHID('RawState',deviceNumber,elementNumber)";
synopsis[i++] = "[keyIsDown,secs,keyCode]=PsychHID('KbCheck' [, deviceNumber][, scanList])";
synopsis[i++] = "[report,err]=PsychHID('GetReport',deviceNumber,reportType,reportID,reportBytes)";
synopsis[i++] = "err=PsychHID('SetReport',deviceNumber,reportType,reportID,report)";
synopsis[i++] = "[reports,err]=PsychHID('GiveMeReports',deviceNumber,[reportBytes])";
synopsis[i++] = "err=PsychHID('ReceiveReports',deviceNumber[,options])";
synopsis[i++] = "err=PsychHID('ReceiveReportsStop',deviceNumber)";
synopsis[i++] = "\n\nQueue based keyboard queries: See 'help KbQueueCreate' for explanations:\n\n";
synopsis[i++] = "PsychHID('KbQueueCreate', [deviceNumber][, keyFlags=all][, numValuators=0][, numSlots=10000][, flags=0][, windowHandle=0])";
synopsis[i++] = "PsychHID('KbQueueRelease' [, deviceIndex])";
synopsis[i++] = "[navail] = PsychHID('KbQueueFlush' [, deviceIndex][, flushType=1])";
synopsis[i++] = "PsychHID('KbQueueStart' [, deviceIndex])";
synopsis[i++] = "PsychHID('KbQueueStop' [, deviceIndex])";
synopsis[i++] = "[keyIsDown, firstKeyPressTimes, firstKeyReleaseTimes, lastKeyPressTimes, lastKeyReleaseTimes]=PsychHID('KbQueueCheck' [, deviceIndex])";
synopsis[i++] = "secs=PsychHID('KbTriggerWait', KeysUsage, [deviceNumber])";
synopsis[i++] = "[event, navail] = PsychHID('KbQueueGetEvent' [, deviceIndex][, maxWaitTimeSecs=0])";
synopsis[i++] = "\n\nSupport for access to generic USB devices: See 'help ColorCal2' for one usage example:\n\n";
synopsis[i++] = "usbHandle = PsychHID('OpenUSBDevice', vendorID, deviceID [, configurationId=0])";
synopsis[i++] = "PsychHID('CloseUSBDevice' [, usbHandle])";
synopsis[i++] = "PsychHID('USBClaimInterface', usbHandle, interfaceId)";
synopsis[i++] = "[recData, count] = PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength [, outData][, timeOutMSecs=10000])";
synopsis[i++] = "[countOrRecData] = PsychHID('USBBulkTransfer', usbHandle, endPoint, length [, outData][, timeOutMSecs=10000])";
synopsis[i++] = "[countOrRecData] = PsychHID('USBInterruptTransfer', usbHandle, endPoint, length [, outData][, timeOutMSecs=10000])";
synopsis[i++] = NULL; // this tells PsychDisplayPsychHIDSynopsis where to stop
if (i > MAX_SYNOPSIS_STRINGS) {
PrintfExit("%s: increase dimension of synopsis[] from %ld to at least %ld and recompile.",__FILE__,(long)MAX_SYNOPSIS_STRINGS,(long)i);
}
return(synopsisSYNOPSIS);
}
PsychError PsychDisplayPsychHIDSynopsis(void)
{
int i;
for (i = 0; synopsisSYNOPSIS[i] != NULL; i++) printf("%s\n",synopsisSYNOPSIS[i]);
return(PsychError_none);
}
|
