diff options
author | Alex Deymo <deymo@chromium.org> | 2013-04-16 14:58:37 -0700 |
---|---|---|
committer | Johan Hedberg <johan.hedberg@intel.com> | 2013-04-23 10:37:15 +0300 |
commit | be37902b7dca39b23edf109dd95da75848e7fc6f (patch) | |
tree | 6b24ed7f6f5517e380ecbc5a65de7b06e46d3632 /doc/input-api.txt | |
parent | 6ebbf94bccb74d4ae2d13e73f6c6e8023cdb37d8 (diff) | |
download | bluez-be37902b7dca39b23edf109dd95da75848e7fc6f.tar.gz |
input: Documentation for new Input1 interface
Adds documentation for a new Input1 interface explaining a new
"ReconnectMode" property that exposes the Connectability mode of
a HID device.
Diffstat (limited to 'doc/input-api.txt')
-rw-r--r-- | doc/input-api.txt | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/input-api.txt b/doc/input-api.txt new file mode 100644 index 000000000..67da08b10 --- /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 ReconnectMode [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. |