blob: 35d383bfeff894e79c5b995c93859298c52ff3d9 (
plain)
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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- CVSID: $Id: dbus-interface.xml 1820 2007-01-14 23:24:00Z rhughes $ -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="dbus-interface">
<title>DBUS Interface</title>
<para>
This API is currently unstable and is likely to change in the future.
</para>
<sect1 id="pm-intro">
<title>Introduction</title>
<para>
Open Hardware Manager exposes a DBUS API for programs to obtain information about
the power state and to change it if required.
</para>
<para>
The following constants are used to uniquely refer to the session-wide
Open Hardware Manager object when making DBUS method calls:
</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>DBUS Service:</entry>
<entry><literal>org.freedesktop.ohm</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect1>
<sect1 id="pm-manager">
<title>Manager functionality</title>
<para>
The manager is the core of <literal>ohmd</literal> and processes all
core functionality such as loading plugins.
</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>DBUS Object Path:</entry>
<entry><literal>/org/freedesktop/ohm/Manager</literal></entry>
</row>
<row>
<entry>DBUS Interface:</entry>
<entry><literal>org.freedesktop.ohm.Manager</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect2 id="pm-manager-keys">
<title>
<literal>Exported keys</literal>
</title>
<para>
Keys exported by the manager:
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Key</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>manager.version.major</literal></entry>
<entry>The major version number</entry>
</row>
<row>
<entry><literal>manager.version.minor</literal></entry>
<entry>The minor version number</entry>
</row>
<row>
<entry><literal>manager.version.patch</literal></entry>
<entry>The patch version number</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2 id="pm-manager-GetVersion">
<title>
<literal>GetVersion()</literal>
</title>
<para>
Gets the version of the <literal>ohmd</literal> daemon.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Direction</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>out</entry>
<entry>string</entry>
<entry>The version, e.g. 0.2.3</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2 id="pm-manager-GetPlugins">
<title>
<literal>GetPlugins()</literal>
</title>
<para>
Gets the plugings currently loaded in the daemon.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Direction</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>out</entry>
<entry>string array</entry>
<entry>A list of plugins, for instance,
<literal>backlight</literal>, <literal>heat-pol</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
</sect1>
<sect1 id="pm-keystore">
<title>Keystore functionality</title>
<para>
The keystore is the configuration plugin and processes all
preferences functionality such as the getting and setting of keys.
Session software can attempt to redefine any keys for the current user
but these may not be marked override and the operation may fail.
</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>DBUS Object Path:</entry>
<entry><literal>/org/freedesktop/ohm/Keystore</literal></entry>
</row>
<row>
<entry>DBUS Interface:</entry>
<entry><literal>org.freedesktop.ohm.Keystore</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect2 id="pm-keystore-GetKey">
<title>
<literal>GetKey()</literal>
</title>
<para>
Gets a 32 bit signed integer value.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Direction</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>in</entry>
<entry>string</entry>
<entry>the key name, e.g. <literal>ac.state</literal></entry>
</row>
<row>
<entry>out</entry>
<entry>integer</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2 id="pm-keystore-SetKey">
<title>
<literal>SetKey()</literal>
</title>
<para>
Sets a 32 bit signed integer value.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Direction</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>in</entry>
<entry>string</entry>
<entry>the key name, e.g. <literal>ac.state</literal></entry>
</row>
<row>
<entry>in</entry>
<entry>integer</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
<sect2 id="pm-keystore-AddNotifyKey">
<title>
<literal>AddNotifyKey()</literal>
</title>
<para>
Tells OHM that an application or plugin wants notification of this key
change.
This prevents uninteresting keys from being changed with no action
causing unnecessary context switches and processor usage.
<literal>KeyChanged</literal> signals will not be sent unless at least
one application has requested notifications.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Direction</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>in</entry>
<entry>string</entry>
<entry>the key name, e.g. <literal>ac.state</literal></entry>
</row>
<row>
<entry>in</entry>
<entry>integer</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
</sect1>
<sect1 id="pm-backlight">
<title>Backlight Adjustment</title>
<para>
Backlight brightness and state can be changed on most backlight hardware.
These are the optional DBUS methods for controlling the brightness of
the backlight.
</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>DBUS Object Path:</entry>
<entry><literal>/org/freedesktop/ohm/Backlight</literal></entry>
</row>
<row>
<entry>DBUS Interface:</entry>
<entry><literal>org.freedesktop.ohm.Backlight</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect2 id="pm-backlight-keys">
<title>
<literal>Exported keys</literal>
</title>
<para>
Keys exported by this plugin:
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Key</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>backlight.value_ac</literal></entry>
<entry>Brightness in percentage when on AC</entry>
</row>
<row>
<entry><literal>backlight.value_battery</literal></entry>
<entry>Brightness in percentage when on battery</entry>
</row>
<row>
<entry><literal>backlight.value_idle</literal></entry>
<entry>Brightness in percentage when idle</entry>
</row>
<row>
<entry><literal>backlight.time_idle</literal></entry>
<entry>
The amount of time in seconds before the backlight is put
into idle mode, or zero to disable.
Idle mode is typically dimming for most backlight devices.
</entry>
</row>
<row>
<entry><literal>backlight.time_off</literal></entry>
<entry>
The amount of time in seconds before the backlight is turned
off, or zero to disable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect2>
</sect1>
</chapter>
|
