This file is indexed.

/usr/share/psychtoolbox-3/PsychHardware/NetStation.m is in psychtoolbox-3-common 3.0.11.20131230.dfsg1-1build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
function [status, error] = NetStation(varargin)
%
% NetStation - Basic control of the EGI/NetStation EEG recording system via
% TCP/IP network connection. (See http://www.egi.com)
%
% This function was developed and contributed to Psychtoolbox by Gergely Csibra, 2006-2008.
% Code is based on Rick Gilmore's routines, 2005. Thanks!
% Code adapted to PCs (and Macs with Intel architecture) by Zhao Fan, 2008.
% This function was modified by Matt Mollison to accommodate sending more
%   than just int16s to Net Station (logical, int8, int16, int32, single,
%   double, and char).
%
%
% General syntax
%
% 	[status, error] = NetStation('command', ...)
%
% 	if status == 0, the command has been succesfully executed
% 	otherwise see string "error" for error message
%
% Commands
%
% 	NetStation('Connect', host [, port])
%
%           Establishes TCP/IP connection to the NetStation host computer.
%           "host" is the hostname as a string (e.g., 'anything.com' or '187.14.176.12')
%           "port" is the ethernet port to be used. Default is 55513.
%
% 	NetStation('Disconnect')
%
%           Disconnects from NetStation host.
%
% 	NetStation('Synchronize' [, SynchLimit])
%
%           Synchronize to the connected host. "SynchLimit" could specify the maximum allowed difference
%           IN MILLISECONDS. Default is 2.5 ms.
%
% 	NetStation('StartRecording')
%
%           Instructs NetStation to start recording.
%
% 	NetStation('StopRecording')
%
%           Instructs NetStation to stop recording.
%
% 	NetStation('Event' [,code] [,starttime] [,duration] [,keycode1] [,keyvalue1] [...])
%
%           Send an event to the NetStation host.
%
% 			"code"		The 4-char event code (e.g., 'STIM')
% 						Default: 'EVEN'
% 			"starttime"	The time IN SECONDS when the event started. The VBL time
% 						returned by Screen('Flip') can be passed here as a parameter.
% 						Default: current time.
% 			"duration"	The duration of the event IN SECONDS.
% 						Default: 0.001.
% 			"keycode"	The 4-char code of a key (e.g., 'tria').
% 			"keyvalue"	The value of the key (any number or string)
% 			The keycode-keyvalue pairs can be repeated arbitrary times.
%
%   Uses a modified version of the TCP/UDP/IP Toolbox 2.0.5, a third party GPL'ed
%   open source toolbox, which is included in Psychtoolbox,
%   but also available from the Mathworks website:
%   http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=345
%
%   The toolbox has been modified for lower communication latency.
%
%   Created by Gergely Csibra, 2006-2008
%   Based on Rick Gilmore's routines, 2005
%   Adapted to PC by Zhao Fan, 2008
%


persistent NSIDENTIFIER;
persistent NSSTATUS; %#ok<USENS>
persistent NSRECORDING;

DefaultSynchLimit=2.5;		% The accuracy of synchronization in milliseconds

if nargin < 1
    if(isempty(NSSTATUS))
        status = -1;
    else
        status = NSSTATUS;
    end
else
    switch lower(varargin{1})
        case 'connect'
            if(nargin<2)
                status = 2;
            else
                NetStationHostName = varargin{2};
                if (~isempty(NSIDENTIFIER)) && (NSIDENTIFIER > 0)
                    send(NSIDENTIFIER,'X');
                    rep=receive(NSIDENTIFIER,1); %#ok<NASGU>
                    pnet( NSIDENTIFIER, 'close' );
                    NSIDENTIFIER = 0;
                end
                port=55513;
                if nargin > 2
                    port = varargin{3};
                end
                c = pnet( 'tcpconnect', NetStationHostName, port );
                if(c < 0)
                    status = 3;
                else
                    NSIDENTIFIER = c;
                    NSRECORDING=0;
                    ECCType='QMAC-';
                    send(NSIDENTIFIER,ECCType);
                    rep=receive(NSIDENTIFIER,1);
                    switch char(rep)
                        case 'F'
                            status=4;
                        case 'I'
                            vers=receive(NSIDENTIFIER,1);
                            if(int8(vers) ~= 1)
                                status = 5;
                            else
                                status = 0;
                            end
                    end
                    if status ~= 0
                        pnet( NSIDENTIFIER, 'close' );
                        NSIDENTIFIER = 0;
                    end
                end
            end
        case 'disconnect'
            if isempty(NSIDENTIFIER) || (NSIDENTIFIER < 0)
                status = 1;
            else
                if NSRECORDING
                    WaitSecs(.5);
                    send(NSIDENTIFIER,'E');
                    rep=receive(NSIDENTIFIER,1); %#ok<NASGU>
                    NSRECORDING=0;
                end
                WaitSecs(1.);
                send( NSIDENTIFIER,'X');
                rep=receive(NSIDENTIFIER,1); %#ok<NASGU>
                WaitSecs(.5);
                pnet( NSIDENTIFIER, 'close' );
                NSIDENTIFIER = -1;
                status = 0;
            end
        case 'synchronize'
            if isempty(NSIDENTIFIER) || (NSIDENTIFIER < 0)
                status = 1;
            else
                NSSynchLimit = DefaultSynchLimit;
                if nargin > 1
                    NSSynchLimit = varargin{2};
                end
                if NSSynchLimit < .5 || NSSynchLimit > 50,
                    NSSynchLimit = DefaultSynchLimit;
                end
                df=10000;
                n=1;
                while df > NSSynchLimit && n < 100
                    send(NSIDENTIFIER,'A');
                    receive(NSIDENTIFIER,1);
                    now=GetSecs();
                    send(NSIDENTIFIER,'T',int32(now*1000));
                    receive(NSIDENTIFIER,1);
                    ack=GetSecs();
                    df=1000*(ack-now);
                    status=0;
                    n=n+1;
                end
                if n>=100
                    warning('\nNetStation synchronization did not succeed within %.1f ms\nSynchronizatoin accuracy is %.1f ms\n',NSSynchLimit,df);
                end
                %fprintf('synch: %.1f ms at the %ith attempt\n',df,n-1);
            end
        case 'startrecording'
            if isempty(NSIDENTIFIER) || (NSIDENTIFIER < 0)
                status = 1;
            else
                if ~NSRECORDING
                    send(NSIDENTIFIER,'B');
                    rep=receive(NSIDENTIFIER,1); %#ok<NASGU>
                    NSRECORDING=1;
                end
                status=0;
            end
        case 'stoprecording'
            if isempty(NSIDENTIFIER) || (NSIDENTIFIER < 0)
                status = 1;
            else
                if NSRECORDING
                    WaitSecs(.5);
                    send(NSIDENTIFIER,'E');
                    rep=receive(NSIDENTIFIER,1); %#ok<NASGU>
                    NSRECORDING=0;
                end
                status=0;
            end
        case 'event'
            if isempty(NSIDENTIFIER) || (NSIDENTIFIER < 0)
                fprintf('%e',NSIDENTIFIER);
                status = 1;
            else
                if nargin < 2
                    event='EVEN';
                else
                    event=[char(varargin{2}) '    '];
                end
                if nargin < 3
                    start=GetSecs();
                else
                    start=varargin{3};
                end
                if nargin < 4
                    duration=.001;
                else
                    duration=varargin{4};
                end
                if isnumeric(duration)
                    if duration > 120
                        duration=.001;
                    %else
                    %    duration= duration;
                    end
                end

                karg=nargin-4;
                if karg >0
                    keyn=floor(karg/2);
                else
                    keyn=0;
                end
                
                nbytes_total = 0;
                for k=1:keyn
                    % Net Staiton GES Hardware Technical Manual Appendix G
                    val = cell2mat(varargin((k * 2) + 4));
                    
                    % I don't understand it, but these 10 extra bytes need
                    % to be counted
                    extraBytes = 10;
                    
                    if isa(val,'logical')
                        % will convert to int8 because NS expects 1-byte
                        % booleans but reads as int8
                        nbytes = 1 + extraBytes;
                    elseif isa(val,'int8')
                        % will convert to int16 because NS expects 2-byte
                        % short signed integers and you should use logical
                        % true/false if you meant to have boolean data
                        nbytes = 2 + extraBytes;
                    elseif isa(val,'int16')
                        nbytes = 2 + extraBytes;
                    elseif isa(val,'int32')
                        nbytes = 4 + extraBytes;
                    elseif isa(val,'single')
                        nbytes = 4 + extraBytes;
                    elseif isa(val,'double')
                        nbytes = 8 + extraBytes;
                    elseif isa(val,'char')
                        % strings get sent as single-byte characters, as
                        % explained in pnet.m
                        nbytes = length(val) + extraBytes;
                    end
                    nbytes_total = nbytes_total + nbytes;
                end
                send(NSIDENTIFIER,'D',uint16(15 + nbytes_total),int32(start*1000),uint32(duration*1000),event(1:4),int16(0),uint8(keyn));
                
                for k=1:keyn
                    id=[char(varargin{(k-1)*2+5}), '    '];
                    
                    % Net Staiton GES Hardware Technical Manual Appendix G
                    val = cell2mat(varargin((k * 2) + 4));
                    
                    if isa(val,'logical')
                        val = int8(val);
                        dtype = 'bool';
                        nbytes = 1;
                    elseif isa(val,'int8')
                        val = int16(val);
                        dtype = 'shor';
                        nbytes = 2;
                    elseif isa(val,'int16')
                        dtype = 'shor';
                        nbytes = 2;
                    elseif isa(val,'int32')
                        dtype = 'long';
                        nbytes = 4;
                    elseif isa(val,'single')
                        dtype = 'sing';
                        nbytes = 4;
                    elseif isa(val,'double')
                        dtype = 'doub';
                        nbytes = 8;
                    elseif isa(val,'char')
                        dtype = 'TEXT';
                        nbytes = length(val);
                    end
                    send(NSIDENTIFIER,id(1:4),dtype,uint16(nbytes),val);
                end

                rep=receive(NSIDENTIFIER,1); %#ok<NASGU>
                status=0;
            end
        otherwise
            status=7;
    end
end

error=nserr(status);

return


function send(con,varargin)
i=1;
while i <= nargin-1
    pnet(con,'write',varargin{i},'network');
    i = i+1;
end
return



function rep=receive(con,len)

rep=pnet(con,'read',len,'char');

return



function errstr=nserr(status)

switch status
    case -1
        errstr='NetStation has not been initialized';
    case 0
        errstr='No error';
    case 1
        errstr='NetStation host not connected';
    case 2
        errstr='NS connect: NetStation host name must be specified';
    case 3
        errstr='NS connect: Unable to connect to host';
    case 4
        errstr='NS connect: ECI error';
    case 5
        errstr='NS connect: Unknown ECI version';
    case 6
        errstr='NS event: Unsuccessful';
    case 7
        errstr='Unknown NetStation command';
    otherwise
        errstr='NS unknown error';
end

return