Skip to content

Commit 8fbef96

Browse files
committed
API deprecation notices
1 parent 8ab645e commit 8fbef96

File tree

6 files changed

+12
-2
lines changed

6 files changed

+12
-2
lines changed

docs/api/bluetooth/BLE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# BLE
22

3+
<span class="notes">**Note:** Some functions, variables or types have been deprecated. Please see the class reference linked below for details.</span>
4+
35
Bluetooth low energy (BLE) is a low power wireless technology standard for building personal area networks. Typical applications of BLE are health care, fitness trackers, beacons, smart home, security, entertainment, proximity sensors, industrial and automotive.
46

57
Arm Mbed BLE, also called `BLE_API`, is the Bluetooth Low Energy software solution for Mbed. Many Mbed [targets and components](https://os.mbed.com/platforms/?mbed-enabled=15&connectivity=3) support Mbed BLE. Developers can use it to create new BLE enabled applications.

docs/api/bluetooth/Gap.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GAP
22

3+
<span class="notes">**Note:** Some functions, variables or types have been deprecated. Please see the class reference linked below for details.</span>
4+
35
<span class="images">![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_gap.png)<span>Gap class hierarchy</span></span>
46

57
The Generic Access Profile is the layer of the stack that handles connectivity tasks. This includes link establishment and termination, advertising and scanning.
@@ -62,7 +64,7 @@ There are two separate MTUs to consider: the `ATT_MTU` (maximum attribute size)
6264

6365
The default value of data length supported by all controllers is 23 octets. If both controllers support data length extension and a higher value is negotiated, the BLE stack will call `onDataLengthChange` in the `Gap::EventHandler` registered by the user.
6466

65-
`ATT_MTU` and data length are independent of each other.
67+
`ATT_MTU` and data length are independent of each other.
6668

6769
## GAP class reference
6870

docs/api/bluetooth/GattClient.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GattClient
22

3+
<span class="notes">**Note:** Some functions, variables or types have been deprecated. Please see the class reference linked below for details.</span>
4+
35
You can use Generic Attribute Profile (GATT) to discover services, characteristics and descriptors and to perform operations on them. The interaction happens between two peers, one of which is the client (which initiates interactions) and the other is the server (which responds). You can use Attribute Protocol (ATT) to implement this interaction. `GattClient` defines procedures required for interacting with a remote `GattServer`.
46

57
## Discovery procedures

docs/api/bluetooth/GattServer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GattServer
22

3+
<span class="notes">**Note:** Some functions, variables or types have been deprecated. Please see the class reference linked below for details.</span>
4+
35
You can use Generic Attribute Profile (GATT) to discover services, characteristics and descriptors and to perform operations on them. The interaction happens between two peers, one of which is the client (which initiates interactions) and the other is the server (which responds). You can use Attribute Protocol (ATT) to implement this interaction.
46

57
`GattServer` is a collection of GattServices. These services contain characteristics that a `GattClient` on the peer connected to the device may read or write. These characteristics may also emit updates to subscribed clients when their values change.

docs/api/bluetooth/UARTService.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UARTService
22

3-
[Add description here.]
3+
<span class="notes">**Note:** This service has been deprecated.</span>
44

55
## UARTService class reference
66

docs/api/bluetooth/iBeacon.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# iBeacon
22

3+
<span class="notes">**Note:** This class has been deprecated.</span>
4+
35
iBeacon is an Apple technology based on BLE that you can use as an indoor positioning system. It allows iOS apps to track if the user enters a specific region and offers actions and notification aware of the user context.
46

57
The iBeacon class builds an advertising payload mimicking an iBeacon and assigns it to a given BLE interface.

0 commit comments

Comments
 (0)