Debian Codegraph @

src/org.freedesktop.ColorManager.Sensor.xml

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "https://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
4 <node name="/" xmlns:doc="https://www.freedesktop.org/dbus/1.0/doc.dtd">
5 <interface name='org.freedesktop.ColorManager.Sensor'>
6 <doc:doc>
7 <doc:description>
8 <doc:para>
9 The interface used for querying color sensors.
10 </doc:para>
11 </doc:description>
12 </doc:doc>
13
14 <!--***********************************************************-->
15 <property name='SensorId' type='s' access='read'>
16 <doc:doc>
17 <doc:description>
18 <doc:para>
19 The sensor id string.
20 </doc:para>
21 </doc:description>
22 </doc:doc>
23 </property>
24
25 <!--***********************************************************-->
26 <property name='Kind' type='s' access='read'>
27 <doc:doc>
28 <doc:description>
29 <doc:para>
30 The kind of the sensor, e.g. <doc:tt>colormunki</doc:tt>
31 </doc:para>
32 </doc:description>
33 </doc:doc>
34 </property>
35
36 <!--***********************************************************-->
37 <property name='State' type='s' access='read'>
38 <doc:doc>
39 <doc:description>
40 <doc:para>
41 The state of the sensor, e.g. <doc:tt>starting</doc:tt>,
42 <doc:tt>idle</doc:tt> or <doc:tt>measuring</doc:tt>.
43 </doc:para>
44 </doc:description>
45 </doc:doc>
46 </property>
47
48 <!--***********************************************************-->
49 <property name='Mode' type='s' access='read'>
50 <doc:doc>
51 <doc:description>
52 <doc:para>
53 The operating mode of the sensor, e.g. <doc:tt>ambient</doc:tt>,
54 <doc:tt>printer</doc:tt> or <doc:tt>unknown</doc:tt>.
55 </doc:para>
56 <doc:para>
57 On some devices, a sensor has to be set to a specific
58 position before a reading can be taken.
59 This property should be set to the current device mode.
60 </doc:para>
61 </doc:description>
62 </doc:doc>
63 </property>
64
65 <!--***********************************************************-->
66 <property name='Serial' type='s' access='read'>
67 <doc:doc>
68 <doc:description>
69 <doc:para>
70 The sensor serial number, e.g. <doc:tt>012345678a</doc:tt>.
71 </doc:para>
72 </doc:description>
73 </doc:doc>
74 </property>
75
76 <!--***********************************************************-->
77 <property name='Model' type='s' access='read'>
78 <doc:doc>
79 <doc:description>
80 <doc:para>
81 The sensor model, e.g. <doc:tt>ColorMunki</doc:tt>.
82 </doc:para>
83 </doc:description>
84 </doc:doc>
85 </property>
86
87 <!--***********************************************************-->
88 <property name='Vendor' type='s' access='read'>
89 <doc:doc>
90 <doc:description>
91 <doc:para>
92 The sensor vendor, e.g. <doc:tt>XRite</doc:tt>.
93 </doc:para>
94 </doc:description>
95 </doc:doc>
96 </property>
97
98 <!--***********************************************************-->
99 <property name='Native' type='b' access='read'>
100 <doc:doc>
101 <doc:description>
102 <doc:para>
103 If the sensor is supported with a native driver, which does
104 not require additional tools such as argyllcms.
105 </doc:para>
106 </doc:description>
107 </doc:doc>
108 </property>
109
110 <!--***********************************************************-->
111 <property name='Embedded' type='b' access='read'>
112 <doc:doc>
113 <doc:description>
114 <doc:para>
115 If the sensor is embedded into the laptop hardware, for
116 example the W700 device from Lenovo.
117 </doc:para>
118 <doc:para>
119 If this property is set then the calibration process should
120 show the color patch fullscreen and should emit an audible
121 alert when completed.
122 </doc:para>
123 </doc:description>
124 </doc:doc>
125 </property>
126
127 <!--***********************************************************-->
128 <property name='Locked' type='b' access='read'>
129 <doc:doc>
130 <doc:description>
131 <doc:para>
132 If the sensor is locked for use by colord.
133 </doc:para>
134 </doc:description>
135 </doc:doc>
136 </property>
137
138 <!--***********************************************************-->
139 <property name='Capabilities' type='as' access='read'>
140 <doc:doc>
141 <doc:description>
142 <doc:para>
143 The capabilities of the sensor, e.g <doc:tt>['display',
144 'printer', 'projector', 'spot']</doc:tt>.
145 </doc:para>
146 </doc:description>
147 </doc:doc>
148 </property>
149
150 <!--***********************************************************-->
151 <property name='Options' type='a{sv}' access='read'>
152 <annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
153 <doc:doc>
154 <doc:description>
155 <doc:para>
156 The options currently set on the sensor.
157 </doc:para>
158 <doc:para>
159 This is a dictionary of property keys and values, e.g.
160 <doc:tt>remote-profile-hash = deadbeef</doc:tt>.
161 </doc:para>
162 </doc:description>
163 </doc:doc>
164 </property>
165
166 <!--***********************************************************-->
167 <property name='Metadata' type='a{ss}' access='read'>
168 <annotation name="org.qtproject.QtDBus.QtTypeName" value="CdStringMap"/>
169 <doc:doc>
170 <doc:description>
171 <doc:para>
172 The metadata for the sensor, which may include optional
173 keys like <doc:tt>AttachImage</doc:tt>.
174 </doc:para>
175 </doc:description>
176 </doc:doc>
177 </property>
178
179 <!--***********************************************************-->
180 <method name='Lock'>
181 <doc:doc>
182 <doc:description>
183 <doc:para>
184 Locks the sensor for use by an application.
185 </doc:para>
186 <doc:para>
187 If the current holder of the lock quits without calling
188 <doc:tt>Unlock</doc:tt> then it is automatically removed.
189 </doc:para>
190 </doc:description>
191 </doc:doc>
192 </method>
193
194 <!--***********************************************************-->
195 <method name='Unlock'>
196 <doc:doc>
197 <doc:description>
198 <doc:para>
199 Unlocks the sensor for use by other applications.
200 </doc:para>
201 </doc:description>
202 </doc:doc>
203 </method>
204
205 <!--***********************************************************-->
206 <method name='GetSample'>
207 <doc:doc>
208 <doc:description>
209 <doc:para>
210 Gets a color sample using the sensor.
211 </doc:para>
212 </doc:description>
213 </doc:doc>
214 <arg type='s' name='capability' direction='in'>
215 <doc:doc>
216 <doc:summary>
217 <doc:para>
218 The capability we are using, e.g. <doc:tt>crt</doc:tt>,
219 <doc:tt>ambient</doc:tt>, <doc:tt>lcd</doc:tt>,
220 <doc:tt>led</doc:tt> or <doc:tt>projector</doc:tt>.
221 </doc:para>
222 </doc:summary>
223 </doc:doc>
224 </arg>
225 <arg type='d' name='sample_x' direction='out'>
226 <doc:doc>
227 <doc:summary>
228 <doc:para>
229 The X value, or <doc:tt>-1.0</doc:tt> for an error.
230 </doc:para>
231 <doc:para>
232 For the capability of <doc:tt>ambient</doc:tt> this is
233 the brightness in Lux.
234 </doc:para>
235 </doc:summary>
236 </doc:doc>
237 </arg>
238 <arg type='d' name='sample_y' direction='out'>
239 <doc:doc>
240 <doc:summary>
241 <doc:para>
242 The Y value, or <doc:tt>-1.0</doc:tt> for an error.
243 </doc:para>
244 </doc:summary>
245 </doc:doc>
246 </arg>
247 <arg type='d' name='sample_z' direction='out'>
248 <doc:doc>
249 <doc:summary>
250 <doc:para>
251 The Z value, or <doc:tt>-1.0</doc:tt> for an error.
252 </doc:para>
253 </doc:summary>
254 </doc:doc>
255 </arg>
256 </method>
257
258 <!--***********************************************************-->
259 <method name='GetSpectrum'>
260 <doc:doc>
261 <doc:description>
262 <doc:para>
263 Gets a color spectrum using the sensor.
264 </doc:para>
265 </doc:description>
266 </doc:doc>
267 <arg type='s' name='capability' direction='in'>
268 <doc:doc>
269 <doc:summary>
270 <doc:para>
271 The capability we are using, e.g. <doc:tt>crt</doc:tt>,
272 <doc:tt>ambient</doc:tt>, <doc:tt>lcd</doc:tt>,
273 <doc:tt>led</doc:tt> or <doc:tt>projector</doc:tt>.
274 </doc:para>
275 </doc:summary>
276 </doc:doc>
277 </arg>
278 <arg type='d' name='start_nm' direction='out'>
279 <doc:doc>
280 <doc:summary>
281 <doc:para>
282 The start of the wavelength range in nm.
283 </doc:para>
284 </doc:summary>
285 </doc:doc>
286 </arg>
287 <arg type='d' name='end_nm' direction='out'>
288 <doc:doc>
289 <doc:summary>
290 <doc:para>
291 The end of the wavelength range in nm.
292 </doc:para>
293 </doc:summary>
294 </doc:doc>
295 </arg>
296 <arg type='ad' name='data' direction='out'>
297 <doc:doc>
298 <doc:summary>
299 <doc:para>
300 The non-normalised data array.
301 </doc:para>
302 </doc:summary>
303 </doc:doc>
304 </arg>
305 </method>
306
307 <!--***********************************************************-->
308 <method name='SetOptions'>
309 <doc:doc>
310 <doc:description>
311 <doc:para>
312 Sets one or multiple options on the sensor.
313 </doc:para>
314 </doc:description>
315 </doc:doc>
316 <arg type='a{sv}' name='values' direction='in'>
317 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
318 <doc:doc>
319 <doc:summary>
320 <doc:para>
321 A dictionary of property keys and values, e.g.
322 <doc:tt>remote-profile-hash = deadbeef</doc:tt>.
323 </doc:para>
324 </doc:summary>
325 </doc:doc>
326 </arg>
327 </method>
328
329 <!-- ************************************************************ -->
330 <signal name='ButtonPressed'>
331 <doc:doc>
332 <doc:description>
333 <doc:para>
334 A button on the sensor has been pressed.
335 </doc:para>
336 </doc:description>
337 </doc:doc>
338 </signal>
339
340 </interface>
341 </node>