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
|
#ifndef SPYD2_H
/*
* Argyll Color Correction System
*
* ColorVision Spyder 2 & 3 related software.
*
* Author: Graeme W. Gill
* Date: 19/10/2006
*
* Copyright 2006 - 2013, Graeme W. Gill
* All rights reserved.
*
* (Based on i1disp.c)
*
* This material is licenced under the GNU GENERAL PUBLIC LICENSE Version 2 or later :-
* see the License2.txt file for licencing details.
*/
/*
If you make use of the instrument driver code here, please note
that it is the author(s) of the code who take responsibility
for its operation. Any problems or queries regarding driving
instruments with the Argyll drivers, should be directed to
the Argyll's author(s), and not to any other party.
If there is some instrument feature or function that you
would like supported here, it is recommended that you
contact Argyll's author(s) first, rather than attempt to
modify the software yourself, if you don't have firm knowledge
of the instrument communicate protocols. There is a chance
that an instrument could be damaged by an incautious command
sequence, and the instrument companies generally cannot and
will not support developers that they have not qualified
and agreed to support.
*/
#include "inst.h"
#ifdef __cplusplus
extern "C" {
#endif
/* Note: update spyd2_interp_error() and spyd2_interp_code() in spyd2.c */
/* if anything of these #defines are added or subtracted */
/* Fake Error codes */
#define SPYD2_INTERNAL_ERROR 0x61 /* Internal software error */
#define SPYD2_COMS_FAIL 0x62 /* Communication failure */
#define SPYD2_UNKNOWN_MODEL 0x63 /* Not an spyd2lay */
#define SPYD2_DATA_PARSE_ERROR 0x64 /* Read data parsing error */
/* Real error code */
#define SPYD2_OK 0x00
/* Sub codes for device specific reasoning */
#define SPYD2_BADSTATUS 0x01
#define SPYD2_PLDLOAD_FAILED 0x02
#define SPYD2_BADREADSIZE 0x03
#define SPYD2_TRIGTIMEOUT 0x04
#define SPYD2_OVERALLTIMEOUT 0x05
#define SPYD2_BAD_EE_CRC 0x06
#define SPYD2_TOOBRIGHT 0x07
/* Internal software errors */
#define SPYD2_BAD_EE_ADDRESS 0x21
#define SPYD2_BAD_EE_SIZE 0x22
#define SPYD2_NO_PLD_PATTERN 0x23
#define SPYD2_NO_COMS 0x24
#define SPYD2_NOT_INITED 0x25
#define SPYD2_NOCRTCAL 0x26 /* No CRT calibration data */
#define SPYD2_NOLCDCAL 0x27 /* No LCD calibration data */
#define SPYD2_MALLOC 0x28
#define SPYD2_OBS_SELECT 0x29 /* Observer */
#define SPYD2_CAL_FAIL 0x2A
#define SPYD2_TOO_FEW_CALIBSAMP 0x2B
#define SPYD2_INT_CIECONVFAIL 0x2C
/* Configuration */
#define SPYD2_DISP_SEL_RANGE 0x40 /* Calibration selection is out of range */
/* User errors */
#define SPYD2_NO_REFRESH_DET 0x50 /* Calibration selection is out of range */
/* SPYD2/3 communication object */
struct _spyd2 {
INST_OBJ_BASE
inst_mode mode; /* Currently selected mode (emis/ambient/etc.) */
inst_opt_type trig; /* Reading trigger mode */
/* Serial EEPROM registers */
/* versioni & feature bits */
/* Spyder2 = 0x0307 */
/* Spyder3 Express = 0x040f */
/* Spyder3 Pro = 0x0407 */
/* Spyder3 Elite = 0x0407 */
/* Spyder4 Pro = 0x070F */
unsigned int hwver; /* 5:B Harware version number */
/* Spyder2 = 3 */
/* Spyder3 = 4 */
/* Spyder4 = 7 */
/* Spyder5 = 10 */
unsigned int fbits; /* 6:B Feature bits 0,1,2,3 correspond to calibration types */
/* CRT/UNK, LCD/NORM, TOK, CRT/UNK */
char serno[9]; /* 8:8xB Serial number as zero terminated string */
/* Spyder2: [0][][] = CRT, [1][][] = LCD */
/* Spyder3: [0][][] = UNK, [1][][] = CRT & LCD */
/* hwver 3..6 uses these calibrations */
double cal_A[2][3][9]; /* HW3..6: 16, 256 CRT/LCD A calibration matrix */
double cal_B[2][3][9]; /* HW3..6: 128, 384 CRT/LCD B calibration matrix */
/* HW3 [0] = CRT/UNK, [1] = LCD/NORM */
/* HW4..6 [0] = not used, [1] = LCD */
/* HW7 [0] = No used */
/* HW7: cal_A[1] computed from sensor spectral data. */
/* HWy: cal_B[1] 60, 384 Linearity correction */
/* The first (A) 3x9 is a sensor to XYZ transform. */
/* cal[0] is an offset value, while the */
/* remaining 8 entries are the sensor weightings. */
/* Because there are only 7 real sensors, cal[1] */
/* and sensor[0] are skipped. */
/* The second (B) 3x9 is an additional non-linearity */
/* correction matrix, applied to the XYZ created */
/* from the first 3x9. The cooeficients consist */
/* of the weights for each product, ie: */
/* X, Y, Z, X*X, X*Z, Y*Z, X*X, Y*Y, Z*Z */
/* for each corrected output XYZ */
double cal_F[7]; /* 240:4, 364:3 F calibration vector */
/* This might be Y only weightings for the 7 sensor values, */
/* with no offset value (TOK type ?). */
/* hwver 7 & 10 (Spyder 4/5) uses computed calibrations */
xspect sens[7]; /* Sensor sensitivity curves in Hz per mW/nm/m^2 */
/* Computed factors and state */
inst_disptypesel *_dtlist; /* Base list */
inst_disptypesel *dtlist; /* Display Type list */
int ndtlist; /* Number of valid dtlist entries */
int refrmode; /* 0 for constant, 1 for refresh display */
int cbid; /* current calibration base ID, 0 if not a base */
int ucbid; /* Underlying base ID if being used for matrix, 0 othewise */
int icx; /* Bit 0: Cal table index, 0 = CRT, 1 = LCD/normal */
/* Bits 31-1: Spyder 4 spectral cal index, 0..spyd4_nocals-1 */
disptech dtech; /* Display technology enum */
int rrset; /* Flag, nz if the refresh rate has been determined */
double refrate; /* Current refresh rate. Set to DEFREFR if not measurable */
int refrvalid; /* nz if refrate was measured */
double gain; /* hwver == 5 gain value (default 4) */
icxObserverType obType; /* ccss observer to use */
xspect custObserver[3]; /* Custom ccss observer to use */
double ccmat[3][3]; /* Colorimeter correction matrix, unity if none */
xspect *samples; /* Copy of current calibration spectral samples, NULL if none */
int nsamp; /* Number of samples, 0 if none */
int prevraw[8]; /* Previous raw reading values */
int prevrawinv; /* Previous raw readings invalid flag - after an abort */
/* Other state */
int led_state; /* Spyder 3: Current LED state */
double led_period, led_on_time_prop, led_trans_time_prop; /* Spyder 3: Pulse state */
}; typedef struct _spyd2 spyd2;
/* Constructor */
extern spyd2 *new_spyd2(icoms *icom, instType itype);
/* PLD pattern loader */
/* id = 0 for Spyder 1, 1 for Spyder 2 */
/* Return 0 if Spyder firmware is not available */
/* Return 1 if Spyder firmware is available */
extern int setup_spyd2(int id);
#ifdef __cplusplus
}
#endif
#define SPYD2_H
#endif /* SPYD2_H */
|
