Linux bluetooth development
 help / color / mirror / Atom feed
From: Alex Deymo <deymo@chromium.org>
To: linux-bluetooth@vger.kernel.org
Cc: marcel@holtmann.org, keybuk@chromium.org,
	vinicius.gomes@openbossa.org, Alex Deymo <deymo@chromium.org>
Subject: [PATCH v4 1/2] input: Documentation for new Input1 interface
Date: Thu,  4 Apr 2013 14:31:52 -0700	[thread overview]
Message-ID: <1365111113-13741-2-git-send-email-deymo@chromium.org> (raw)
In-Reply-To: <1365111113-13741-1-git-send-email-deymo@chromium.org>

Adds new documentation for a new Input1 interface explaining a new
"ReconnectionMode" property that exposes the Connectability mode of
a HID device.
---
 doc/input-api.txt | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 doc/input-api.txt

diff --git a/doc/input-api.txt b/doc/input-api.txt
new file mode 100644
index 0000000..66debae
--- /dev/null
+++ b/doc/input-api.txt
@@ -0,0 +1,32 @@
+BlueZ D-Bus Input API description
+*********************************
+
+Input hierarchy
+===============
+
+Service		org.bluez
+Interface	org.bluez.Input1
+Object path	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
+
+Properties	string ReconnectionMode [readonly]
+
+			Determines the Connectability mode of the HID device as
+			defined by the HID Profile specification, Section 5.4.2.
+
+			This mode is based in the two properties
+			HIDReconnectInitiate (see Section 5.3.4.6) and
+			HIDNormallyConnectable (see Section 5.3.4.14) which
+			define the following four possible values:
+
+			"None"		Device and host are not required to
+					automatically restore the connection.
+
+			"Host"		Bluetooth HID host restores connection.
+
+			"Device"	Bluetooth HID device restores
+					connection.
+
+			"Any"		Bluetooth HID device shall attempt to
+					restore the lost connection, but
+					Bluetooth HID Host may also restore the
+					connection.
-- 
1.8.1.3


  reply	other threads:[~2013-04-04 21:31 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-04 21:31 [PATCH v4 0/2] Input1 Connectability revisited Alex Deymo
2013-04-04 21:31 ` Alex Deymo [this message]
2013-04-04 21:31 ` [PATCH v4 2/2] input: Implement the new ReconnectMode Input1 property Alex Deymo
2013-04-04 21:49   ` Vinicius Costa Gomes
2013-04-04 21:44 ` [PATCH v4 0/2] Input1 Connectability revisited Vinicius Costa Gomes
2013-04-05  2:47   ` Alex Deymo

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=1365111113-13741-2-git-send-email-deymo@chromium.org \
    --to=deymo@chromium.org \
    --cc=keybuk@chromium.org \
    --cc=linux-bluetooth@vger.kernel.org \
    --cc=marcel@holtmann.org \
    --cc=vinicius.gomes@openbossa.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