File: ColorCal2.m

package info (click to toggle)
psychtoolbox-3 3.0.19.14.dfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 86,796 kB
  • sloc: ansic: 176,245; cpp: 20,103; objc: 5,393; sh: 2,753; python: 1,397; php: 384; makefile: 193; java: 113
file content (737 lines) | stat: -rw-r--r-- 29,961 bytes parent folder | download
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
function varargout = ColorCal2(command, varargin)
% varargout = ColorCal2(command, [varargin])
%
% Description:
% Interface function to communicate with the ColorCal2 USB device.
%
%
% WINDOWS: On MS-Windows this driver needs to use a virtual COM port method
% to communicate, instead of the more feature-rich USB method on Linux or
% OSX. As a consequence, only a subset of functions is supported, as listed
% below, and device detection may be less reliable if you have other serial
% port devices or virtual COM port devices connected, unless you help the
% driver by telling it the right COM port: The device will show up as an
% additional serial port on the system. This driver will communicate with
% the device by establishing a serial port connection via that serial port.
% The driver will check for the existence of a configuration file named
% [PsychtoolboxConfigDir 'ColorCal2Config.txt']. If the file exists and is
% readable, then presence of a serial port name in the first line of that
% text configuration file will use the serial port with that name for
% communication, otherwise the driver will try to auto-detect the proper
% serial port for communication. E.g., if the file would contain one line
% with the text COM3 then virtual COM port 3 would be used for serial port
% communication.
%
%
% macOS: macOS 10.12 or later is required for this function to work. For
% older macOS versions, look for instructions on the CRS Ltd. website.
% Access to all ColorCal2 functionality needs a 3rd party libusb-1.0.dylib
% installed - seee 'help PsychHID'. Without that, the same serial port
% method is used as on MS-Windows, with a bit more limited functionality.
%
%
% LINUX: If you want to use this function without the need to run Matlab or
% Octave as root user (i.e., without need for root login or the sudo
% command), please run PsychLinuxConfiguration once (this will happen
% automatically if you install, update or setup Psychtoolbox via
% DownloadPsychtoolbox, UpdatePsychtoolbox or SetupPsychtoolbox), or
% alternatively copy the file
% Psychtoolbox/PsychHardware/ColorCal2/60-cambridgeresearch-permissions.rules
% into the folder /etc/udev/rules.d/ on your system. This one-time copy
% will require administrator privileges, but after that, any user should be
% able to use the ColorCal devices or other CRS Ltd. devices without
% special permissions.
%
%
% Required Input:
% command (string) - Command to send to the ColorCal2 device. Commands are
%                    case insensitive.
%
% Optional Input:
% varargin - Argument(s) required for a subset of the ColorCal2
%            commands. Varies depending on the command.
%
% Optional Output:
% varargout - Value(s) returned for a subset of the ColorCal2 commands.
%
% Command List for all operating systems:
%
% 'DeviceInfo' - Retrieves the following device information in a struct:
%      firmware version number, 8 digit serial number, and firmware build
%      number. The struct's fields are romVersion, serialNumber,
%      buildNumber.
%
%      Example:
%      devInfo = ColorCal2('DeviceInfo');
%
% 'MeasureXYZ' - Measures the tri-stimulus value of the current light.
%      Returns a struct with x, y, and z in floating point format.  These
%      values should be corrected by multiplying them against the calibration
%      matrix typically stored in the 1st calibration matrix in the device.
%
%      Example: Retrieve the xyz values and correct them with the 1st
%               calibration matrix.
%      cMatrix = ColorCal2('ReadColorMatrix');
%      s = ColorCal2('MeasureXYZ');
%      correctedValues = cMatrix(1:3,:) * [s.x s.y s.z]';
%
% 'ReadColorMatrix' or 'ReadColourMatrix' - Retrieves all 3 color
%      calibration matrices from the device and returns them as a 9x3 matrix.
%      Each set of 3 rows represents a single calibration matrix.  All
%      values will be in floating point format.
%
% 'ZeroCalibration' - Removes small zero errors in the electronic system of
%      the ColorCal2 device.  It reads the current light level and stores
%      the readings in a zero correction array.  All subsequent light
%      readings have this value subtracted from them before being returned.
%      This command is intended to be issued when the ColorCal2 is in the
%      dark.  Returns 1 if the command succeeds, 0 if it fails.  This
%      command must be run after every power cycle of the device.
%
% 'NeedZeroCalibration' - Returns true if a zero calibration is needed, false
%      otherwise. Devices with firmware build 877 or later do not need this, as
%      they are factory calibrated.
%
% 'Close' - Close connection to device. A 'clear all' or 'clear ColorCal2' or
%      quitting Octave or Matlab will also close the connection, so this is
%      not strictly needed.
%
% All the following commands are not supported on MS-Windows, only on Linux
% and macOS, and on macOS they need a 3rd party installed libusb-1.0.dylib
% (see 'help PsychHID'):
%
%
% 'GetRawData' - Returns the raw data for all three light channels, the
%      contents of the zero correction array for all three channels, and
%      the current reading of the trigger ADC.  Returns a single struct
%      containing the following fields: Xdata, Xzero, Ydata, Yzero, Zdata,
%      Zzero, Trigger.  All values are unformatted.
%
% 'LEDOn' - Turns the LED on.
%
% 'LEDOff' - Turns the LED off.
%
% 'SetLEDFunction' - Controls whether the LED is illuminated when the
%      trigger signal is generated.  This state is stored in non-volatile
%      memory and will survive a power cycle.  Takes 1 additional argument:
%      0 or 1.  0 = LED not active when triggered, 1 = LED active when
%      triggered.
%
% 'SetTriggerThreshold' - Sets the threshold which must be exceeded by the
%      first derivative of the trigger ADC before a trigger pulse is
%      generated.  It is stored in non-volatile memory and will survive a
%      power cycle.  Takes 1 additional argument which is the trigger
%      threshold value.
%
% 'StartBootloader' - Causes the ColorCal2 to start its internal bootloader
%      in preparation for a firmware upgrade.
%

% *** These functions are for internal use only.  Using these functions may
% *** brick your device.  These functions are commented out below, so they
% *** must be uncommented before they can be run.
%
% 'ResetEEProm' - Resets the non-volatile memory on the ColorCal2 to its
%      default value.  ALL CALIBRATION DATA IS ERASED.
%
% 'SetColorMatrix' or 'SetColourMatrix' - Writes data into one of the
%      calibration matrices.  Takes 2 additional arguments: matrix number,
%      and a color matrix.  The ColorCal2 has 3 calibration matrices
%      indexed in the range [0,2].  The color matrix must be 3x3 in
%      floating point format.  The values contained within the color matrix
%      will be converted to a Minolta format internally.
%
%      Example: Set the first color matrix to some random values.
%      ColorCal2('SetColorMatrix', 0, rand(3,3));

% History:
% 03.04.2009  Written (Chris Broussard).
% 18.08.2010  Make useBigEndian persistent. Reported by Ian A. ("tatooed.tentackle@yahoo.com")
% 19.01.2013  Make compatible with GNU/Octave-3 (Mario Kleiner).
% 06.06.2017  Make compatible with Windows via serial port implementation (Mario Kleiner).
%             This uses code derived from the Matlab sample code by CRS, incorporated in a
%             modified form with permission of CRS under our usual MIT license.
% 02.09.2020  Make more robust against weirdly behaving display panels. (Mario Kleiner)
% 25.10.2022  Allow IOPort fallback if USBControlTransfers are unsupported on macOS. (Mario Kleiner)

persistent usbHandle;
persistent portHandle;
persistent useBigEndian;
persistent zeroCalibrated;

varargout = {};

if nargin == 0
    error('Usage: varargout = ColorCal2(command, [varargin])');
end

if ~ischar(command)
    error('command must be a string.');
end

% Connect to the ColorCal2 if we haven't already.
if isempty(usbHandle) && isempty(portHandle)
    if ~IsWin
        % Not MS-Windows: Maybe we can use efficient USB control transfers?
        % Can't do this on Windows, because MS-Windows security mechanisms
        % will prevent low-level USB access to the ColorCal2.
        LoadPsychHID;

        % USB low-level access supported? Always true on Linux, but on
        % macOS it needs a manually installed 3rd party provided
        % libusb-1.0.dylib, e.g., from HomeBrew, otherwise unavailable:
        if PsychHID('OpenUSBDevice', -1, -1)
            % Yes. Try to open USB device for low-level access:
            usbHandle = PsychHID('OpenUSBDevice', 2145, 4097);
        else
            fprintf('ColorCal2: libusb-1.0.dylib unavailable (see ''help PsychHID''). Will try to use less capable serial port method, like on MS-Windows.\n');
            fprintf('ColorCal2: Some functions will operate more slowly, and some will not work, e.g., LEDOn, LEDOff, ...\n');
        end
    end

    % Did we manage to establish low-level USB access?
    if isempty(usbHandle)
        % No: Need to use limited virtual COM port / serial port method:
        portString = [];
        configfile = [PsychtoolboxConfigDir 'ColorCal2Config.txt'];
        if ~exist(configfile, 'file')
            fprintf('ColorCal2: Could not find a ColorCal2 config file under [%s]. Trying to probe correct virtual COM port or serial port.\n', configfile);
        else
            % File exists. Parse file for a port name string:
            fid = fopen(configfile);
            fileContentsWrapped = fgets(fid);
            fclose(fid);

            % Port spec available?
            if ~isempty(fileContentsWrapped) && ischar(fileContentsWrapped)
                % Yes: Assign namestring for port.
                portString = deblank(fileContentsWrapped);
                fprintf('ColorCal2: Connecting to ColorCal2 device via serial port [%s], as provided by configuration file [%s].\n', portString, configfile);
            end
        end

        % On Windows or limited macOS we use virtual COM ports, aka serial
        % port communication instead, to work around the lack of a proper
        % USB HID driver.
        verb = IOPort('Verbosity', 1);
        portString = FindSerialPort(portString);
        portHandle = IOPort('OpenSerialPort', portString, 'ReceiveTimeout=5.0');
        IOPort('Verbosity', verb);
    end
    disp('- ColorCal2 connected');

    % Determine the byte order of the machine.
    x = typecast(uint32(1), 'uint8');
    if x(4) == 1
        useBigEndian = true;
    else
        useBigEndian = false;
    end

    % Reset zero calibration done flag:
    zeroCalibrated = [];
end

% Currently, we don't vary this value.
bRequest = 0;

switch lower(command)
    case {'close', 'cls'}
        if ~isempty(usbHandle)
            PsychHID('CloseUSBDevice', usbHandle);
        end

        if ~isempty(portHandle)
            IOPort('Close', portHandle);
        end

        disp('- ColorCal2 closed');
        usbHandle = [];
        portHandle = [];

    case {'ledon', 'lon'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('40');
            wValue = 2;
            wIndex = 0;
            wLength = 0;
            PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength);
        else
            warning('ColorCal2(''LEDOn''): LED control unsupported on this platform.');
        end
    case {'ledoff', 'lof'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('40');
            wValue = 3;
            wIndex = 0;
            wLength = 0;
            PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength);
        else
            warning('ColorCal2(''LEDOff''): LED control unsupported on this platform.');
        end

    case {'measurexyz', 'mes'}
        % Assume measurement will be valid and trustworthy as a starter:
        s.reliable = 1;

        if ~isempty(usbHandle)
            % Try up to 3 times in case of trouble:
            for retry=1:3
                % Request a measurement:
                bmRequestType = hex2dec('40');
                wValue = 1;
                wIndex = 0;
                wLength = 3;
                PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength, uint8('MES'));

                % Retrieve measured result in outString:
                bmRequestType = hex2dec('C0');
                wLength = 32;
                outString = char(PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength));

                % Parse the output string.
                [a, nr, err] = sscanf(outString, 'OK00,%6f,%6f,%6f');

                % Worked? Otherwise warn and retry...
                if nr < 3
                    fail = 1;
                    warning('ColorCal2:MeasureXYZ: Try %i, Parse error, only %i items returned instead of expected 3 in string ''%s'' - err=%s. Retrying\n', retry, nr, outString, err);

                    [a, nr] = sscanf(outString, 'OK00,1 %6f,%6f,%6f');
                    if nr == 3
                        fail = 0;
                        s.reliable = 0;
                        fprintf('ColorCal2:MeasureXYZ: Recovered at try %i with special 1-marker format parsing of string ''%s''\n', retry, outString);
                        break;
                    end

                    [a, nr] = sscanf(outString, 'OK00,%6f,1 %6f,%6f');
                    if nr == 3
                        fail = 0;
                        s.reliable = 0;
                        fprintf('ColorCal2:MeasureXYZ: Recovered at try %i with special 1-marker format parsing of string ''%s''\n', retry, outString);
                        break;
                    end

                    [a, nr] = sscanf(outString, 'OK00,%6f,%6f,1 %6f');
                    if nr == 3
                        fail = 0;
                        s.reliable = 0;
                        fprintf('ColorCal2:MeasureXYZ: Recovered at try %i with special 1-marker format parsing of string ''%s''\n', retry, outString);
                        break;
                    end
                else
                    fail = 0;
                    break;
                end
            end
        else
            % Try up to 3 times in case of trouble:
            for retry=1:3
                [a, outString] = ColorCALIIGetValues(portHandle);
                if ~any(isnan(a))
                    fail = 0;
                    break;
                else
                    fail = 1;
                    warning('ColorCal2:MeasureXYZ: Try %i, Parse error in received string ''%s''. Retrying\n', retry, outString);
                end
            end
        end

        if fail
            warning('ColorCal2:MeasureXYZ: Failed to measure after 3 retries!');
            s.x = NaN;
            s.y = NaN;
            s.z = NaN;
            s.reliable = 0;
            varargout{1} = s;
            return;
        end

        s.x = a(1);
        s.y = a(2);
        s.z = a(3);

        varargout(1) = {s};

    case {'needzerocalibration'}
        devInfo = ColorCal2 ('Deviceinfo');
        % Only devices with firmware older than 877 need zero calibration by user.
        % 877+ devices are factory calibrated:
        if (devInfo.buildNumber < 877) && isempty(zeroCalibrated)
            varargout{1} = true;
        else
            varargout{1} = false;
        end

    case {'zerocalibration', 'uzc'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('40');
            wValue = 1;
            wLength = 3;
            wIndex = 0;
            PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength, uint8('UZC'));
            bmRequestType = hex2dec('C0');
            wLength = 32;
            outString = char(PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength));
        else
            IOPort('Write', portHandle, uint8(['UZC' 13]));
            readSerial(portHandle);
            outString = readSerial(portHandle);
        end

        % Parse the output string.
        switch outString(1:4)
            case 'OK00'
                varargout(1) = {true};
                zeroCalibrated = 1;
            case 'ER11'
                varargout(1) = {false};
            otherwise
                error('Failed to parse output string from the ColorCal2');
        end

    case {'getrawdata', 'grd'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('C0');
            wValue = 4;
            wLength = 28;
            wIndex = 0;
            outData = PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength);

            % Each 4 bytes represents one value, so we must concatenate each
            % group of 4 bytes to get number we want.  On big endian systems we
            % must swap the byte order because the USB bus works in little
            % endian mode.
            extractedData = [];
            for i = 1:4:28
                % Read 4 bytes of data and convert it into an uint32 value.
                y = typecast(outData(i:i+3), 'uint32');

                % Swap the byte order if on a big endian machine.
                if useBigEndian
                    y = swapbytes(y);
                end

                extractedData(end+1) = double(y);  %#ok<AGROW>
            end
        else
            error('ColorCal2(''GetRawData''): Function unsupported on this platform.');
        end

        % Create a struct to hold the results.
        d.Xdata = extractedData(1);
        d.Xzero = extractedData(2);
        d.Ydata = extractedData(3);
        d.Yzero = extractedData(4);
        d.Zdata = extractedData(5);
        d.Zzero = extractedData(6);
        d.Trigger = extractedData(7);

        varargout(1) = {d};

    case {'readcolormatrix', 'readcolourmatrix', 'rcm'}
        colorMatrix = zeros(9, 3);

        if ~isempty(usbHandle)
            % Get data for each row in the color matrices.  There are 9 rows, 3
            % per matrix.
            for i = 1:9
                bmRequestType = hex2dec('40');
                wValue = 1;
                wLength = 3;
                wIndex = 0;

                % Grab row 'i' of the color matrix.
                PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength, uint8(sprintf('r0%d', i)));
                bmRequestType = hex2dec('C0');
                wLength = 32;
                outString = char(PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength));

                % Parse the output string and store the values returned.
                colorMatrix(i, :) = sscanf(outString, 'OK00,%d,%d,%d')';
            end
        else
            colorMatrix = getColorCALIICorrectionMatrix(portHandle);
        end

        % Convert the matrix values from Minolta format to floating point.
        varargout(1) = {Minolta2Float(colorMatrix)};

    case {'deviceinfo', 'idr'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('40');
            wValue = 1;
            wLength = 3;
            wIndex = 0;

            % Get the ColorCal2 device info.
            PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength, uint8('IDR'));
            bmRequestType = hex2dec('C0');
            wLength = 32;
            outString = char(PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength));
        else
            IOPort('Write', portHandle, uint8(['IDR' char(13)]));
            readSerial(portHandle);
            outString = readSerial(portHandle);
        end

        % Parse the device info string.
        x = sscanf(outString, 'OK00,1,%d,100.10,%d,%d');

        % Set the output: rom version, serial number, and build number.
        dInfo.romVersion = x(1);
        dInfo.serialNumber = x(2);
        dInfo.buildNumber = x(3);
        varargout(1) = {dInfo};

%    case {'reseteeprom', 'rse'}
%        if ~isempty(usbHandle)
%             bmRequestType = hex2dec('40');
%             wValue = 7;
%             wLength = 0;
%             wIndex = 0;
%
%             % Send the reset command.
%             PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength);
%        else
%            warning('ColorCal2(''ResetEEProm''): Function unsupported on this platform.');
%        end

    case {'startbootloader', 'sbl'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('40');
            wValue = 99;
            wLength = 0;
            wIndex = 0;

            % Send the start bootloader command.
            PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength);
        else
            warning('ColorCal2(''StartBootloader''): Function unsupported on this platform.');
        end
    case {'settriggerthreshold', 'stt'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('40');
            wValue = 8;
            wLength = 0;

            % Make sure a trigger value was passed.
            if nargin ~= 2
                error('Usage: ColorCal2(''SetTriggerThreshold'', triggerValue)');
            end

            % Make sure the trigger value is scalar.
            wIndex = varargin{1};
            if ~isscalar(wIndex)
                error('triggerValue must be scalar.');
            end

            % Send the set trigger threshold command.
            PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength);
        else
            warning('ColorCal2(''SetTriggerThreshold''): Function unsupported on this platform.');
        end
    case {'setledfunction', 'slf'}
        if ~isempty(usbHandle)
            bmRequestType = hex2dec('40');
            wValue = 9;
            wLength = 0;

            % Make sure a LED function value was passed.
            if nargin ~= 2
                error('Usage: ColorCal2(''SetLEDFunction'', ledFunctionValue)');
            end

            % Make sure that the function value is 0 or 1.
            wIndex = varargin{1};
            if ~isscalar(wIndex)
                error('ledFunctionValue must be a scalar.');
            end
            if ~any(wIndex == [0 1])
                error('ledFunctionValue must be 0 or 1.');
            end

            % Send the new LED function value.
            PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, wValue, wIndex, wLength);
        else
            warning('ColorCal2(''SetLEDFunction''): Function unsupported on this platform.');
        end

%     case {'setcolormatrix', 'setcolourmatrix', 'scm'}
%         if isempty(usbHandle)
%             error('SetColorMatrix is not supported on this platform.');
%         end
%
%         bmRequestType = hex2dec('40');
%         wValue = 6;
%         wLength = 18;
%
%         % Check the number of input arguments.
%         if nargin ~= 3
%             error('Usage: ColorCal2(''SetColorMatrix'', matrixNumber, colorMatrix)');
%         end
%
%         % Make sure that the 2nd argument is a valid matrix number.
%         matrixNumber = varargin{1};
%         if isscalar(matrixNumber)
%             if ~any(matrixNumber == [0 1 2])
%                 error('matrixNumber must be an integer in the range [0,2].');
%             end
%         else
%             error('matrixNumber must be a scalar value in the range [0,2].');
%         end
%         wIndex = matrixNumber;
%
%         % Make sure that argument 3 is a valid 3x3 color matrix.
%         colorMatrix = varargin{2};
%         if isnumeric(colorMatrix)
%             if ndims(colorMatrix) ~= 2 || ~all(size(colorMatrix) == [3 3])
%                 error('colorMatrix must be a 3x3 matrix.');
%             end
%         else
%             error('colorMatrix must be a numeric matrix');
%         end
%
%         % Convert the color matrix from floating point to Minolta format.
%         colorMatrix = Float2Minolta(colorMatrix);
%
%         % Repackage the color matrix into a 8 bit vector where each matrix
%         % value is represented by 2 bytes.
%         newColorMatrix = uint16([colorMatrix(1,:) colorMatrix(2,:) colorMatrix(3,:)]);
%         if useBigEndian
%             newColorMatrix = swapbytes(newColorMatrix);
%         end
%         newColorMatrix = typecast(newColorMatrix, 'uint8');
%
%         % Send over the new color matrix.
%         PsychHID('USBControlTransfer', usbHandle, bmRequestType, bRequest, ...
%             wValue, wIndex, wLength, newColorMatrix);

    otherwise
        error('Invalid command: %s', command);
end

end

function readString = readSerial(portHandle)
    vals = [];
    while length(vals) < 2 || vals(end-1) ~= 10 || vals(end) ~= 13
        curval = IOPort('Read', portHandle, 1, 1);
        vals = [vals, curval]; %#ok<AGROW>
    end

    readString = char(vals(1:end-2));
end

function myCorrectionMatrix = getColorCALIICorrectionMatrix(portHandle)
    % Obtains the individual correction matrix for the ColorCAL II, to be used
    % to translate measured readings to calibrated XYZ values
    try
        % Cycle through the 3 times 3 rows of the 3 vertically concatenated correction matrices.
        for j = 1:9
            % whichColumn is to indicate the column the current value is to be
            % written to.
            whichColumn = 1;

            % Commands are passed to the ColorCAL II as though they were being
            % written to a text file, using fprintf. The commands 'r01', 'r02'
            % and 'r03' will return the 1st, 2nd and 3rd rows of the correction
            % matrix respectively. Note the '13' represents the terminator
            % character. 13 represents a carriage return and should be included
            % at the end of every command to indicate when a command is
            % finished.
            IOPort('Write', portHandle, uint8(['r0' num2str(j) char(13)]));

            % This command returns a blank character at the start of each line
            % by default that can confuse efforts to read the values. Therefore
            % use dummy read once to remove this character.
            readSerial(portHandle);

            % Read the returned data:
            dataLine = readSerial(portHandle);

            % The returned dataLine will be returned as a string of characters
            % in the form of 'OK00, 8053,52040,50642'. Therefore loop through
            % each character until a O is found to be sure of the start
            % position of the data.
            for k = 1:length(dataLine)
                % Once an O has been found, assign the start position of the
                % numbers to 5 characters beyond this (i.e. skipping the
                % 'OKOO,').
                if dataLine(k) == 'O'
                    myStart = k+5;

                    % A comma (,) indicates the start of a value. Therefore if
                    % this is found, the value is the number formed of the next
                    % 5 characters.
                elseif dataLine(k) == ','
                    myEnd = k+5;

                    % Using j to indicate the row position and whichColumn to
                    % indicate the column position, convert the 5 characters to
                    % a number and assign it to the relevant position.
                    myCorrectionMatrix(j, whichColumn) = str2double(dataLine(myStart:myEnd)); %#ok<AGROW>

                    % reset myStart to k+6 (the first value of the next number)
                    myStart = k+6;

                    % Add 1 to the whichColumn value so that the next value
                    % will be saved to the correct location.
                    whichColumn = whichColumn + 1;

                end
            end
        end
    catch
        disp('Error');
    end
end

function [myMeasureMatrix, dataLine] = ColorCALIIGetValues(portHandle)
    % Takes a reading. These values need to be transformed by above correction
    % matrix to obtain XYZ values
    whichColumn = 1;

    try
        IOPort('Write', portHandle, uint8(['MES' 13]));

        readSerial(portHandle);
        dataLine = readSerial(portHandle);

        % The returned dataLine will be returned as a string of characters in
        % the form of 'OK00,242.85,248.11, 89.05'. In case of additional blank
        % characters before or after the relevant information, loop through
        % each character until a O is found to be sure of the start position of
        % the data.
        for k = 1:length(dataLine)
            % Once an O has been found, assign the start position of the
            % numbers to 5 characters beyond this (i.e. skipping th 'OKOO,')
            if dataLine(k) == 'O'
                myStart = k+5;

                % A comma (,) indicates the start of a value. Therefore if this
                % is found, the value is the number formed of the next 6
                % characters
            elseif dataLine(k) == ','
                myEnd = k+6;

                % Using k to indicate the row position and whichColumn to
                % indicate the column position, convert the 5 characters to a
                % number and assign it to the relevant position.
                myMeasureMatrix(whichColumn) = str2double(dataLine(myStart:myEnd)); %#ok<AGROW>

                % reset myStart to k+7 (the first value of the next number)
                myStart = k+7;

                % Add 1 to the whichColumn value so that the next value will be
                % saved to the correct location.
                whichColumn = whichColumn + 1;
            end
        end
    catch
        disp('ColorCal2: Error retrieving measurement!');
        dataLine = 'ColorCal2: Error retrieving measurement!';
    end
end