OSDN Git Service

doc: Add management commands for Add Device and Remove Device
authorMarcel Holtmann <marcel@holtmann.org>
Sun, 29 Jun 2014 11:54:35 +0000 (13:54 +0200)
committerMarcel Holtmann <marcel@holtmann.org>
Sun, 29 Jun 2014 11:54:35 +0000 (13:54 +0200)
doc/mgmt-api.txt

index 3461f78..2f31f5e 100644 (file)
@@ -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
 ==================================