summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFlorian Grandel <fgrandel@gmail.com>2015-06-18 03:17:32 +0200
committerJohan Hedberg <johan.hedberg@intel.com>2015-06-18 13:18:20 +0300
commit3c8ae2631eee3e542392ff76738be501451051c4 (patch)
tree2adf0e3b0254e0ada42ee2fb519caea5eb52a7e2 /doc
parenta1a6ec40542b3c2567c340a248b578af6da71fde (diff)
downloadbluez-3c8ae2631eee3e542392ff76738be501451051c4.tar.gz
doc/mgmt-api: fix typos
This patch fixes a few minor typos and grammar errors in the mgmt api spec.
Diffstat (limited to 'doc')
-rw-r--r--doc/mgmt-api.txt32
1 files changed, 16 insertions, 16 deletions
diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt
index 58f60a588..ae0cf386f 100644
--- a/doc/mgmt-api.txt
+++ b/doc/mgmt-api.txt
@@ -390,7 +390,7 @@ Set Connectable Command
and for LE controllers it changes the advertising type. For
dual mode controllers it affects both settings.
- For LE capable controllers the connectable setting takes affect
+ For LE capable controllers the connectable setting takes effect
when advertising is enabled (peripheral) or when directed
advertising events are received (central).
@@ -891,7 +891,7 @@ Get Connections Command
Address2 { }
...
- This command is used to retreive a list of currently connected
+ This command is used to retrieve a list of currently connected
devices.
Possible values for the Address_Type parameter:
@@ -1043,7 +1043,7 @@ Pair Device Command
To allow tracking of which resolvable random address changed
into which identity address, the New Identity Resolving Key
- event will be send before receiving Command Complete event
+ event will be sent before receiving Command Complete event
for this command.
This command can only be used when the controller is powered.
@@ -1484,7 +1484,7 @@ Block Device Command
Address_Type (1 Octet)
This command is used to add a device to the list of devices
- which should be blocked from being connect to the local
+ which should be blocked from being connected to the local
controller.
Possible values for the Address_Type parameter:
@@ -1492,7 +1492,7 @@ Block Device Command
1 LE Public
2 LE Random
- For Low Energy devices, the blocking of a device take presedence
+ For Low Energy devices, the blocking of a device takes precedence
over auto-connection actions provided by Add Device. Blocked
devices will not be auto-connected or even reported when found
during background scanning. If the controller is connectable
@@ -1562,9 +1562,9 @@ Set Device ID Command
0x0001 Bluetooth SIG
0x0002 USB Implementer’s Forum
- The information are put into the EIR data. If the controller does
+ The information is put into the EIR data. If the controller does
not support EIR or if SSP is disabled, this command will still
- succeed. The information are stored for later use and will survive
+ succeed. The information is stored for later use and will survive
toggling SSP on and off.
This command generates a Command Complete event on success or
@@ -1609,7 +1609,7 @@ Set Advertising Command
The value 0x02 should be the preferred mode of operation when
implementing peripheral mode.
- Using this command will temporarily deactive any configuration
+ Using this command will temporarily deactivate any configuration
made by the Add Advertising command. This command takes precedence.
Once a Set Advertising command with value 0x00 is issued any
previously made configurations via Add/Remove Advertising, including
@@ -1983,17 +1983,17 @@ Add Device Command
2 Auto-connect remote device
With the Action 0, when the device is found, a new Device Found
- event will be send indicating this device is available. This
+ event will be sent indicating this device is available. This
action is only valid for LE Public and LE Random address types.
With the Action 1, the device is allowed to connect. For BR/EDR
address type this means an incoming connection. For LE Public
and LE Random address types, a connection will be established
to devices using directed advertising. If successful a Device
- Connected event will be send.
+ Connected event will be sent.
With the Action 2, when the device is found, it will be connected
- and if successful a Device Connected event will be send. This
+ and if successful a Device Connected event will be sent. This
action is only valid for LE Public and LE Random address types.
When a device is blocked using Block Device command, then it is
@@ -2224,8 +2224,8 @@ Set Public Address Command
For a fully configured controller, the current controller index
will become invalid and an Unconfigured Index Removed event will
- be send. Once the address has been successfully changed an Index
- Added event will be send. There is no guarantee that the controller
+ be sent. Once the address has been successfully changed an Index
+ Added event will be sent. There is no guarantee that the controller
index stays the same.
All previous configured parameters and settings are lost when
@@ -2540,7 +2540,7 @@ Read Advertising Features Command
however might decrease the actual available length in these
data fields.
- With Num_Instances and Instance array the current occupied
+ With Num_Instances and Instance array the currently occupied
Instance identifiers can be retrieved.
This command generates a Command Complete event on success or
@@ -2629,13 +2629,13 @@ Add Advertising Command
The Timeout parameter configures the life-time of an Instance. In
case the value 0 is used it indicates no expiration time. If a
- timeout value is provided, then the advertising Instace will be
+ timeout value is provided, then the advertising Instance will be
automatically removed when the timeout passes. The value for the
timeout is in seconds. Powering down a controller will invalidate
all advertising Instances and it is not possible to add a new
Instance with a timeout when the controller is powered down.
- When a Timeout is provided, then the Duration substracts from
+ When a Timeout is provided, then the Duration subtracts from
the actual Timeout value of that Instance. For example an Instance
with Timeout of 5 and Duration of 2 will be scheduled exactly 3
times, twice with 2 seconds and once with one second. Other