From: <chen.ganir@ti.com>
To: <linux-bluetooth@vger.kernel.org>
Cc: <chen.ganir@ti.com>
Subject: [PATCH v3 01/10] battery: Add generic device battery documentation
Date: Thu, 20 Sep 2012 11:27:34 +0300 [thread overview]
Message-ID: <1348129663-1701-2-git-send-email-chen.ganir@ti.com> (raw)
In-Reply-To: <1348129663-1701-1-git-send-email-chen.ganir@ti.com>
From: Chen Ganir <chen.ganir@ti.com>
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
next prev parent reply other threads:[~2012-09-20 8:27 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-20 8:27 [PATCH v3 00/10] Implement Generic battery and LE Battery client chen.ganir
2012-09-20 8:27 ` chen.ganir [this message]
2012-09-20 8:27 ` [PATCH v3 02/10] battery: Implement Generic device battery chen.ganir
2012-09-20 8:27 ` [PATCH v3 03/10] battery: Add GATT Battery Client Service skeleton chen.ganir
2012-09-20 8:27 ` [PATCH v3 04/10] battery: Add client connection logic chen.ganir
2012-09-20 8:27 ` [PATCH v3 05/10] battery: Discover Characteristic Descriptors chen.ganir
2012-09-20 8:27 ` [PATCH v3 06/10] battery: Get Battery ID chen.ganir
2012-09-20 10:46 ` Anderson Lizardo
2012-09-20 11:03 ` Chen Ganir
2012-09-20 8:27 ` [PATCH v3 07/10] battery: Add Battery to device chen.ganir
2012-09-20 8:27 ` [PATCH v3 08/10] battery: Read Battery level characteristic chen.ganir
2012-09-20 8:27 ` [PATCH v3 09/10] battery: Add support for notifications chen.ganir
2012-09-20 10:54 ` Anderson Lizardo
2012-09-20 11:00 ` Chen Ganir
2012-09-20 8:27 ` [PATCH v3 10/10] battery: Support persistent battery level chen.ganir
2012-09-20 10:56 ` [PATCH v3 00/10] Implement Generic battery and LE Battery client Anderson Lizardo
2012-09-20 11:04 ` Chen Ganir
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1348129663-1701-2-git-send-email-chen.ganir@ti.com \
--to=chen.ganir@ti.com \
--cc=linux-bluetooth@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).