summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2014-06-29 13:54:35 +0200
committerMarcel Holtmann <marcel@holtmann.org>2014-06-29 13:54:35 +0200
commit9c76a0a4832bbd3a01f278e0d003c01be4d1e35a (patch)
tree44c9ee4341c9683af44d0b87d11cb0d18ee5126b /doc
parent83038976865c7008de266820aacdec9a96f59a17 (diff)
downloadbluez-9c76a0a4832bbd3a01f278e0d003c01be4d1e35a.tar.gz
doc: Add management commands for Add Device and Remove Device
Diffstat (limited to 'doc')
-rw-r--r--doc/mgmt-api.txt62
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt
index 3461f7899..2f31f5e0f 100644
--- a/doc/mgmt-api.txt
+++ b/doc/mgmt-api.txt
@@ -1822,6 +1822,68 @@ Get Clock Information Command
Invalid Index
+Add Device Command
+==================
+
+ Command Code: 0x0033
+ Controller Index: <controller id>
+ Command Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+ Action (1 Octet)
+ Return Parameters:
+
+ This command is used to add a device to the action list. The
+ action list allows scanning for devices and auto-connection
+ to known devices.
+
+ Possible values for the Action parameter:
+ 0 Background scan for device
+ 1 Auto-connect device
+
+ With the Action 0, when the device is found, a new Device Found
+ event will be send indicating this device is available. Devices
+ using direct advertising will be connected.
+
+ With the Action 1, when the device is found, it will be connected
+ and if successful a Device Connected event will be send.
+
+ This command can be used when the controller is not powered and
+ all settings will be programmed once powered.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+ Possible errors: Busy
+ Invalid Parameters
+ Invalid Index
+
+
+Remove Device Command
+=====================
+
+ Command Code: 0x0034
+ Controller Index: <controller id>
+ Command Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+ Return Parameters:
+
+ This command is used to remove a device from the action list
+ previously added by using the Add Device command.
+
+ When the Address parameter is 00:00:00:00:00:00, then all
+ previously added devices wil be removed.
+
+ This command can be used when the controller is not powered and
+ all settings will be programmed once powered.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+ Possible errors: Busy
+ Invalid Parameters
+ Invalid Index
+
+
Load Connection Parameters Command
==================================