summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDanny Kukawka <danny.kukawka@web.de>2008-11-28 19:45:00 +0100
committerDanny Kukawka <danny.kukawka@web.de>2008-11-28 19:45:00 +0100
commit9b564550ad6fbae7d74ec388c8541d9abdaee100 (patch)
tree46c2d22fc777b890d0660ac4ea3204d64e8002a2 /doc
parent4948bdd2254931513cf5974e9c9f6c52705fab75 (diff)
add org.freedesktop.Hal.Device.Leds interface to spec
Added org.freedesktop.Hal.Device.Leds interface to the spec.
Diffstat (limited to 'doc')
-rw-r--r--doc/spec/hal-spec-interfaces.xml48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/spec/hal-spec-interfaces.xml b/doc/spec/hal-spec-interfaces.xml
index 07a335c1..edd360d0 100644
--- a/doc/spec/hal-spec-interfaces.xml
+++ b/doc/spec/hal-spec-interfaces.xml
@@ -763,6 +763,54 @@ $ dbus-send --system --print-reply --dest=org.freedesktop.Hal \
</para>
</sect1>
+ <sect1 id="interface-device-leds">
+ <title>org.freedesktop.Hal.Device.Leds interface</title>
+ <para>
+ This interface provides a mechanism to get/set the brightness of
+ a LED (light-emitting diode). The following methods are available:
+ </para>
+
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Method</entry>
+ <entry>Returns</entry>
+ <entry>Parameters</entry>
+ <entry>Throws</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>GetBrightness</entry>
+ <entry>Int</entry>
+ <entry></entry>
+ <entry></entry>
+ <entry>
+ Get the current brightness of the LED.
+ </entry>
+ </row>
+ <row>
+ <entry>SetBrightness</entry>
+ <entry></entry>
+ <entry>Int brightness</entry>
+ <entry></entry>
+ <entry>
+ Set the current brightness of the LED. The value 0 deactivate
+ normally the LED, any higher value active the LED again.
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para>
+ This interface does not emit any signals.
+ </para>
+ </sect1>
+
<sect1 id="interface-device-laptop-panel">
<title>org.freedesktop.Hal.Device.LaptopPanel interface</title>
<para>