[PATCH v4 01/10] battery: Add generic device battery documentation
From: <hidden>
Date: 2012-09-24 07:15:10
Subsystem:
the rest · Maintainer:
Linus Torvalds
From: Chen Ganir <redacted> Add documentation for the generic battery D-Bus interface. --- doc/battery-api.txt | 31 +++++++++++++++++++++++++++++++ doc/device-api.txt | 5 +++++ 2 files changed, 36 insertions(+) create mode 100644 doc/battery-api.txt
diff --git a/doc/battery-api.txt b/doc/battery-api.txt
new file mode 100644
index 0000000..7e1b94f
--- /dev/null
+++ b/doc/battery-api.txt@@ -0,0 +1,31 @@ +BlueZ D-Bus Battery API description +**************************************** + + Texas Instruments, Inc. <chen.ganir@ti.com> + +Device Battery hierarchy +===================================== + +Service org.bluez +Interface org.bluez.Battery +Object path [variable prefix]/{hci0,..}/dev_XX_XX_XX_XX_XX_XX/BATTYYYY +YYYY is numeric value between 0 and 9999. + +Methods dict GetProperties() + + Returns all properties for the interface. See the + Properties section for the available properties. + + void Refresh() + + Refresh the batterty level. If the battery level changed, the + PropertyChanged signal will be sent with the new value. + +Signals PropertyChanged(string name, variant value) + + This signal indicates a changed value of the given + property. + +Properties uint16 Level [readonly] + + Battery level (0-100).
diff --git a/doc/device-api.txt b/doc/device-api.txt
index 1f0dc96..c98d539 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt@@ -179,3 +179,8 @@ Properties string Address [readonly] Note that this property can exhibit false-positives in the case of Bluetooth 2.1 (or newer) devices that have disabled Extended Inquiry Response support. + + array{object} Batteries [readonly] + + List of device battery object paths that represents the available + batteries on the remote device.
--
1.7.9.5