1 files changed, 228 insertions, 0 deletions
diff --git a/src/org.freedesktop.DeviceKit.Power.Source.xml b/src/org.freedesktop.DeviceKit.Power.Source.xml
new file mode 100644
index 0000000..a98dbbd
--- /dev/null
+++ b/src/org.freedesktop.DeviceKit.Power.Source.xml
@@ -0,0 +1,228 @@
+<!DOCTYPE node PUBLIC
+"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
+  <!ENTITY ERROR_GENERAL "org.freedesktop.DeviceKit.Disks.Power.Source.GeneralError">
+]>
+<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+  <interface name="org.freedesktop.DeviceKit.Power.Source">
+    <doc:doc>
+      <doc:description>
+        <doc:para>
+          TODO: some explanatory text etc. etc. Mention that we
+          collect history to provide more precise values of
+          battery-time-to-empty, battery-time-to-full. Go into detail
+          with the algorithms.
+        </doc:para>
+        <doc:para>
+          TODO: do we need to export voltage and other things? Do we need to export raw data?
+        </doc:para>
+        <doc:para>
+          Unless otherwise noted, an empty string or the value 0 in a
+          property means not set.
+        </doc:para>
+      </doc:description>
+    </doc:doc>
+
+
+    <!-- ************************************************************ -->
+
+    <method name="Refresh">
+      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
+
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            Refreshes the data collected from the power source.
+          </doc:para>
+        </doc:description>
+        <doc:permission>Callers need the org.freedesktop.devicekit.power.refresh-power-source authorization</doc:permission>
+        <doc:errors>
+          <doc:error name="&ERROR_GENERAL;">if an error occured while refreshing</doc:error>
+        </doc:errors>
+      </doc:doc>
+    </method>
+
+    <!-- ************************************************************ -->
+
+    <signal name="Changed">
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            Some value on the power source changed.
+          </doc:para>
+        </doc:description>
+      </doc:doc>
+    </signal>
+
+    <!-- ************************************************************ -->
+
+    <property name="native-path" type="s" access="read">
+      <doc:doc><doc:description><doc:para>
+            OS specific native path of the power source. On Linux this
+            is the sysfs path, for
+            example <doc:tt>/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0</doc:tt>. Is
+            blank if the device is being driven by a user space
+            driver.
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="vendor" type="s" access="read">
+      <doc:doc><doc:description><doc:para>
+            Name of the vendor of the battery.
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="model" type="s" access="read">
+      <doc:doc><doc:description><doc:para>
+            Name of the model of this battery.
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="serial" type="s" access="read">
+      <doc:doc><doc:description><doc:para>
+            Unique serial number of the battery.
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="update-time" type="t" access="read">
+      <doc:doc><doc:description><doc:para>
+            The point in time (seconds since the Epoch Jan 1, 1970
+            0:00 UTC) that data was read from the power source.
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="type" type="s" access="read">
+      <doc:doc><doc:description><doc:para>
+            Type of power source. Known values are "battery" and "line-power".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="line-power-online" type="b" access="read">
+      <doc:doc><doc:description><doc:para>
+            Whether power is currently being provided through line power.
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "line-power".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-energy" type="d" access="read">
+      <doc:doc><doc:description><doc:para>
+            Amount of energy (measured in Wh) currently available in
+            the power source.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-energy-empty" type="d" access="read">
+      <doc:doc><doc:description><doc:para>
+            Amount of energy (measured in Wh) in the power source when
+            it's considered to be empty.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-energy-empty-design" type="d" access="read">
+      <doc:doc><doc:description><doc:para>
+            Amount of energy (measured in Wh) the power source is
+            designed to hold when it's considered to be empty.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-energy-full" type="d" access="read">
+      <doc:doc><doc:description><doc:para>
+            Amount of energy (measured in Wh) in the power source when
+            it's considered full.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-energy-full-design" type="d" access="read">
+      <doc:doc><doc:description><doc:para>
+            Amount of energy (measured in Wh) the power source is
+            designed to hold when it's considered full.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-energy-rate" type="d" access="read">
+      <doc:doc><doc:description><doc:para>
+            Amount of energy being drained from the source, measured
+            in W. If positive, the source is being discharged, if
+            negative it's being charged.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-time-to-empty" type="x" access="read">
+      <doc:doc><doc:description><doc:para>
+            Number of seconds until the power source is considered empty.
+            Is set to -1 if unknown.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-time-to-full" type="x" access="read">
+      <doc:doc><doc:description><doc:para>
+            Number of seconds until the power source is considered full.
+            Is set to -1 if unknown.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-percentage" type="d" access="read">
+      <doc:doc><doc:description><doc:para>
+            The amount of energy left in the power source expressed as
+            a percentage between 0 and 100. Typically this is the same as
+            (<doc:ref type="property" to="Source:battery-energy">battery-energy</doc:ref> -
+            <doc:ref type="property" to="Source:battery-energy-empty">battery-energy-empty</doc:ref>) /
+            (<doc:ref type="property" to="Source:battery-energy-full">battery-energy-full</doc:ref> -
+            <doc:ref type="property" to="Source:battery-energy-empty">battery-energy-empty</doc:ref>).
+            However, some primitive power sources are capable of only
+            reporting percentages and in this case the battery-energy-*
+            properties will be unset while this property is set.
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+    <property name="battery-technology" type="s" access="read">
+      <doc:doc><doc:description><doc:para>
+            Technology used in the battery; known values are "Li-ion".
+          </doc:para><doc:para>
+            This property is only valid if the property
+            <doc:ref type="property" to="Source:type">type</doc:ref>
+            has the value "battery".
+      </doc:para></doc:description></doc:doc>
+    </property>
+
+  </interface>
+
+</node>