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
|
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"https://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="https://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name='org.freedesktop.ColorManager.Sensor'>
<doc:doc>
<doc:description>
<doc:para>
The interface used for querying color sensors.
</doc:para>
</doc:description>
</doc:doc>
<!--***********************************************************-->
<property name='SensorId' type='s' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The sensor id string.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Kind' type='s' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The kind of the sensor, e.g. <doc:tt>colormunki</doc:tt>
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='State' type='s' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The state of the sensor, e.g. <doc:tt>starting</doc:tt>,
<doc:tt>idle</doc:tt> or <doc:tt>measuring</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Mode' type='s' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The operating mode of the sensor, e.g. <doc:tt>ambient</doc:tt>,
<doc:tt>printer</doc:tt> or <doc:tt>unknown</doc:tt>.
</doc:para>
<doc:para>
On some devices, a sensor has to be set to a specific
position before a reading can be taken.
This property should be set to the current device mode.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Serial' type='s' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The sensor serial number, e.g. <doc:tt>012345678a</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Model' type='s' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The sensor model, e.g. <doc:tt>ColorMunki</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Vendor' type='s' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The sensor vendor, e.g. <doc:tt>XRite</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Native' type='b' access='read'>
<doc:doc>
<doc:description>
<doc:para>
If the sensor is supported with a native driver, which does
not require additional tools such as argyllcms.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Embedded' type='b' access='read'>
<doc:doc>
<doc:description>
<doc:para>
If the sensor is embedded into the laptop hardware, for
example the W700 device from Lenovo.
</doc:para>
<doc:para>
If this property is set then the calibration process should
show the color patch fullscreen and should emit an audible
alert when completed.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Locked' type='b' access='read'>
<doc:doc>
<doc:description>
<doc:para>
If the sensor is locked for use by colord.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Capabilities' type='as' access='read'>
<doc:doc>
<doc:description>
<doc:para>
The capabilities of the sensor, e.g <doc:tt>['display',
'printer', 'projector', 'spot']</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Options' type='a{sv}' access='read'>
<annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
<doc:doc>
<doc:description>
<doc:para>
The options currently set on the sensor.
</doc:para>
<doc:para>
This is a dictionary of property keys and values, e.g.
<doc:tt>remote-profile-hash = deadbeef</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<property name='Metadata' type='a{ss}' access='read'>
<annotation name="org.qtproject.QtDBus.QtTypeName" value="CdStringMap"/>
<doc:doc>
<doc:description>
<doc:para>
The metadata for the sensor, which may include optional
keys like <doc:tt>AttachImage</doc:tt>.
</doc:para>
</doc:description>
</doc:doc>
</property>
<!--***********************************************************-->
<method name='Lock'>
<doc:doc>
<doc:description>
<doc:para>
Locks the sensor for use by an application.
</doc:para>
<doc:para>
If the current holder of the lock quits without calling
<doc:tt>Unlock</doc:tt> then it is automatically removed.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!--***********************************************************-->
<method name='Unlock'>
<doc:doc>
<doc:description>
<doc:para>
Unlocks the sensor for use by other applications.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!--***********************************************************-->
<method name='GetSample'>
<doc:doc>
<doc:description>
<doc:para>
Gets a color sample using the sensor.
</doc:para>
</doc:description>
</doc:doc>
<arg type='s' name='capability' direction='in'>
<doc:doc>
<doc:summary>
<doc:para>
The capability we are using, e.g. <doc:tt>crt</doc:tt>,
<doc:tt>ambient</doc:tt>, <doc:tt>lcd</doc:tt>,
<doc:tt>led</doc:tt> or <doc:tt>projector</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type='d' name='sample_x' direction='out'>
<doc:doc>
<doc:summary>
<doc:para>
The X value, or <doc:tt>-1.0</doc:tt> for an error.
</doc:para>
<doc:para>
For the capability of <doc:tt>ambient</doc:tt> this is
the brightness in Lux.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type='d' name='sample_y' direction='out'>
<doc:doc>
<doc:summary>
<doc:para>
The Y value, or <doc:tt>-1.0</doc:tt> for an error.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type='d' name='sample_z' direction='out'>
<doc:doc>
<doc:summary>
<doc:para>
The Z value, or <doc:tt>-1.0</doc:tt> for an error.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--***********************************************************-->
<method name='GetSpectrum'>
<doc:doc>
<doc:description>
<doc:para>
Gets a color spectrum using the sensor.
</doc:para>
</doc:description>
</doc:doc>
<arg type='s' name='capability' direction='in'>
<doc:doc>
<doc:summary>
<doc:para>
The capability we are using, e.g. <doc:tt>crt</doc:tt>,
<doc:tt>ambient</doc:tt>, <doc:tt>lcd</doc:tt>,
<doc:tt>led</doc:tt> or <doc:tt>projector</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type='d' name='start_nm' direction='out'>
<doc:doc>
<doc:summary>
<doc:para>
The start of the wavelength range in nm.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type='d' name='end_nm' direction='out'>
<doc:doc>
<doc:summary>
<doc:para>
The end of the wavelength range in nm.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
<arg type='ad' name='data' direction='out'>
<doc:doc>
<doc:summary>
<doc:para>
The non-normalised data array.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!--***********************************************************-->
<method name='SetOptions'>
<doc:doc>
<doc:description>
<doc:para>
Sets one or multiple options on the sensor.
</doc:para>
</doc:description>
</doc:doc>
<arg type='a{sv}' name='values' direction='in'>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
<doc:doc>
<doc:summary>
<doc:para>
A dictionary of property keys and values, e.g.
<doc:tt>remote-profile-hash = deadbeef</doc:tt>.
</doc:para>
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ************************************************************ -->
<signal name='ButtonPressed'>
<doc:doc>
<doc:description>
<doc:para>
A button on the sensor has been pressed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
</interface>
</node>
|
