Skip to content

Commit 531525f

Browse files
committed
Quick and dirty attempt to fix the H1 issue
1 parent 6f2fd55 commit 531525f

File tree

346 files changed

+2144
-2144
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

346 files changed

+2144
-2144
lines changed

docs/api/api.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Full API list
22

3-
## Platform APIs
3+
# Platform APIs
44

55
[Platform APIs](platform.html) provide general purpose MCU management infrastructure, common data structures and a consistent user experience on top of different standard libraries and toolchains.
66

@@ -45,7 +45,7 @@
4545
</tbody>
4646
</table>
4747

48-
## Drivers APIs
48+
# Drivers APIs
4949

5050
[Driver APIs](drivers.html) include analog and digital inputs and outputs on development boards, as well as digital interfaces, which allow your board to interface with a computer or external devices.
5151

@@ -99,7 +99,7 @@
9999
</tbody>
100100
</table>
101101

102-
## RTOS APIs
102+
# RTOS APIs
103103

104104
The [Mbed OS RTOS](rtos.html) capabilities include managing objects such as threads, synchronization objects and timers. It also provides interfaces for attaching an application-specific idle hook function, reads the OS tick count and implements functionality to report RTOS errors.
105105

@@ -127,7 +127,7 @@ The [Mbed OS RTOS](rtos.html) capabilities include managing objects such as thre
127127
</tbody>
128128
</table>
129129

130-
## USB APIs
130+
# USB APIs
131131

132132
The Mbed OS classes providing USB peripheral functionality, also known as [USB components](../apis/usb.html), inherit from USBDevice and provide specific USB peripherial functionality.
133133

@@ -150,7 +150,7 @@ The Mbed OS classes providing USB peripheral functionality, also known as [USB c
150150
</tbody>
151151
</table>
152152

153-
## Network socket APIs
153+
# Network socket APIs
154154

155155
[Network socket APIs](network-socket.html) include the application programming interface for IP networking. In Mbed OS, this API supports both TCP and UDP protocols.
156156

@@ -171,7 +171,7 @@ The Mbed OS classes providing USB peripheral functionality, also known as [USB c
171171
</tbody>
172172
</table>
173173

174-
## Network interfaces APIs
174+
# Network interfaces APIs
175175

176176
[Network interfaces](network-interfaces.html) are the application level APIs where users choose the driver, connectivity method and IP stack. These include ethernet, Wi-Fi, cellular and mesh interfaces.
177177

@@ -189,7 +189,7 @@ The Mbed OS classes providing USB peripheral functionality, also known as [USB c
189189
</tbody>
190190
</table>
191191

192-
## Bluetooth Low Energy (BLE) APIs
192+
# Bluetooth Low Energy (BLE) APIs
193193

194194
[Bluetooth low energy (BLE)](bluetooth.html) 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.
195195

@@ -210,7 +210,7 @@ The Mbed OS classes providing USB peripheral functionality, also known as [USB c
210210
</tbody>
211211
</table>
212212

213-
## LoRaWAN APIs
213+
# LoRaWAN APIs
214214

215215
Arm Mbed OS provides a native network stack for [LoRaWAN](lorawan.html). LoRaWAN is a technology designed for low-power battery-powered devices. These devices operate in an unlicensed spectrum, creating high density wide-area networks.
216216

@@ -225,7 +225,7 @@ Arm Mbed OS provides a native network stack for [LoRaWAN](lorawan.html). LoRaWAN
225225
</tbody>
226226
</table>
227227

228-
## NFC APIs
228+
# NFC APIs
229229

230230
You can use [Near-Field Communication (NFC)](nfc.html), a short-range radio technology, to enable use cases such as contactless payments, access control and device pairing.
231231

@@ -243,7 +243,7 @@ You can use [Near-Field Communication (NFC)](nfc.html), a short-range radio tech
243243
</tbody>
244244
</table>
245245

246-
## Security API
246+
# Security API
247247

248248
With [Arm Mbed TLS](security.html), a comprehensive SSL/TLS solution, you can include cryptographic and SSL/TLS capabilities in your code.
249249

@@ -261,7 +261,7 @@ With [Arm Mbed TLS](security.html), a comprehensive SSL/TLS solution, you can in
261261
</tbody>
262262
</table>
263263

264-
## Storage APIs
264+
# Storage APIs
265265

266266
The [storage APIs](storage.html) include file system APIs, for file system operations, and block devices, which provide the raw storage for the file systems.
267267

docs/api/bluetooth/BLE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Arm Mbed BLE, also called `BLE_API`, is the Bluetooth Low Energy software soluti
88

99
Mbed’s `BLE_API` interfaces with the BLE controller on the platform. It hides the BLE stack’s complexity behind C++ abstractions and is compatible with all BLE-enabled Mbed platforms. The Mbed OS `BLE_API` automatically configuring the clocks, timers and other hardware peripherals to work at their lowest power consumption.
1010

11-
## `BLE_API`, bridges and stacks
11+
# `BLE_API`, bridges and stacks
1212

1313
<span class="images">![](../../images/BLEDiagram.png)</span>
1414

@@ -18,7 +18,7 @@ You can build a BLE application using Mbed OS, `BLE_API` and a controller-specif
1818
- The bridge software is specific to each vendor’s platform. It provides the instantiations for the interfaces `BLE_API` offers and helps drive the underlying controller and Bluetooth stack.
1919
- The Bluetooth stack implements the Bluetooth protocol and is specific to the controller, so a vendor using different controllers may provide different stacks.
2020

21-
## Inside `BLE_API`
21+
# Inside `BLE_API`
2222

2323
<span class="images">![](../../images/Inside_API.png)</span>
2424

@@ -28,7 +28,7 @@ You can build a BLE application using Mbed OS, `BLE_API` and a controller-specif
2828

2929
1. Classes under `ble/services` to offer reference implementations for many of the commonly used GATT profiles. The code under 'services/' isn't essential, but it’s a useful starting point for prototyping. We continue to implement the standard GATT profiles.
3030

31-
## The BLEDevice class and header
31+
# The BLEDevice class and header
3232

3333
The entry point of Mbed's `BLE_API` is the BLE class accessible using the header `ble/BLE.h`. This class allows you to obtain a BLE object that includes the basic attributes of a spec-compatible BLE device and can work with any BLE radio:
3434

@@ -44,31 +44,31 @@ The class's member functions can be divided by purpose:
4444

4545
1. Accessor to Bluetooth Modules that manage GAP, GATT or the security.
4646

47-
## Usage
47+
# Usage
4848

4949
1. Set up advertising and connection modes.
5050
1. Assign UUIDs to the service and its characteristic.
5151
1. Create an input characteristic.
5252
1. Construct a service class and add it to the BLE stack.
5353
1. Push notifications when the characteristic's value changes.
5454

55-
## BLE class reference
55+
# BLE class reference
5656

5757
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_b_l_e.html)
5858

59-
## Example: BLE beacon
59+
# Example: BLE beacon
6060

6161
Here is an example demonstrating how you can create a BLE beacon.
6262

6363
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_Beacon/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.14/BLE_Beacon/source/main.cpp)
6464

65-
## Example: BLE heart rate monitor
65+
# Example: BLE heart rate monitor
6666

6767
Here is an example demonstrating how to build a heart rate sensor that can be connected and monitored by a BLE client such as your phone.
6868

6969
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_HeartRate/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.14/BLE_HeartRate/source/main.cpp)
7070

71-
## Related content
71+
# Related content
7272

7373
- Mbed Enabled [targets and components](https://os.mbed.com/platforms/?mbed-enabled=15&connectivity=3) that support BLE.
7474
- [BLE tutorial](../tutorials/ble-tutorial.html).

docs/api/bluetooth/BatteryService.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
## BatteryService
1+
# BatteryService
22

33
It is often a requirement for devices operating on battery to report the battery charge level to the user.
44

55
The [Bluetooth Battery Service](https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=245138) defines how to expose a battery charge level through a BLE link. It allows a client - usually a smartphone application - of a device to read the current battery charge level and follow its evolution.
66

77
The BatteryService class implements the Bluetooth Battery Service as defined by the Bluetooth SIG. Makers of BLE devices operating on battery can use the API to expose interoperably the charge level of their products.
88

9-
### BatteryService class reference
9+
## BatteryService class reference
1010

1111
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_battery_service.html)
1212

13-
### BatteryService example
13+
## BatteryService example
1414

1515
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_BatteryLevel/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.14/BLE_BatteryLevel/source/main.cpp)
1616

17-
### Related content
17+
## Related content
1818

1919
- [Bluetooth Battery Service](https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=245138) specification.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
## EnvironmentalService
1+
# EnvironmentalService
22

33
[Add description here.]
44

5-
### EnvironmentalService class reference
5+
## EnvironmentalService class reference
66

77
[![View code](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_environmental_service.html)
88

9-
### EnvironmentalService example
9+
## EnvironmentalService example
1010

1111
[Add example here.]

docs/api/bluetooth/Gap.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## GAP
1+
# GAP
22

33
<span class="notes">**Note:** Some functions, variables or types have been deprecated. Please see the class reference linked below for details.</span>
44

@@ -12,19 +12,19 @@ The other side of the process is the act of scanning, which listens for advertis
1212

1313
Advertising, scanning and connection all have parameters that let you find a compromise between desired power consumption levels, latency and efficiency of these processes.
1414

15-
### Advertising
15+
## Advertising
1616

1717
Advertising consists of broadcasting at a regular interval a small amount of data containing valuable information about the device. Peer devices listening on BLE advertising channels may scan these packets.
1818

1919
Scanners may also request additional information from device advertising by sending a scan request. If the broadcaster accepts scan requests, it can reply with a scan response packet containing additional information.
2020

21-
### Scanning
21+
## Scanning
2222

2323
Scanning consists of listening for peer advertising packets. From a scan, a device can identify devices available in its environment.
2424

2525
If the device scans actively, it sends scan request to scannable advertisers and collects their scan responses.
2626

27-
### Extended and periodic advertising
27+
## Extended and periodic advertising
2828

2929
BLE controllers supporting Bluetooth 5.0 may offer additional advertising and scanning options. Use `isFeatureSupported()` to check feature availability.
3030

@@ -36,13 +36,13 @@ There may be many advertising sets active at one time on a single advertiser. Th
3636

3737
Devices that do not support extended and periodic advertising will not see these advertisements. You may use legacy advertising alongside extended advertising, running at the same time, to support older devices in the environment.
3838

39-
### Privacy
39+
## Privacy
4040

4141
Privacy is a feature that allows a device to avoid being tracked by other (untrusted) devices. The device achieves it by periodically generating a new random address. The random address may be a resolvable random address, enabling trusted devices to recognize it as belonging to the same device. These trusted devices receive an Identity Resolution Key (IRK) during pairing. The SecurityManager handles this and relies on the other device accepting and storing the IRK.
4242

4343
You need to enable privacy by calling `enablePrivacy()` after initializing the SecurityManager because privacy requires SecurityManager to handle IRKs. Set the behavior of privacy enabled devices by using `setCentralPrivacyConfiguration()`, which specifies what the device should be with devices using random addresses, and `setPeripheralPrivacyConfiguration`. Random addresses that privacy enabled devices generate can be of two types: resolvable (by devices who have the IRK) and unresolvable. You can't use unresolvable addresses for connecting and connectable advertising; therefore, use a resolvable one for these, regardless of the privacy configuration.
4444

45-
### Modulation schemes
45+
## Modulation schemes
4646

4747
When supported by the host and controller, you can select different modulation schemes:
4848

@@ -56,7 +56,7 @@ You may set preferred PHYs (separately for RX and TX) using `setPreferredPhys()`
5656

5757
You may query the currently used PHY using `readPhy()`, which returns the result through a call to the registered event handler. You may register the handler with `setEventHandler()`. The events inform about the currently used PHY and of any changes to PHYs, which the controller or the peer may trigger autonomously.
5858

59-
### Data length (over-the-air MTU)
59+
## Data length (over-the-air MTU)
6060

6161
In addition to modulation schemes, Maximum Transmission Unit (MTU) size also strongly affects throughput. Newer controllers allow you to negotiate bigger MTUs. Because each packet contains overhead, bigger packets maximize throughput.
6262

@@ -66,11 +66,11 @@ The default value of data length supported by all controllers is 23 octets. If b
6666

6767
`ATT_MTU` and data length are independent of each other.
6868

69-
### GAP class reference
69+
## GAP class reference
7070

7171
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_gap.html)
7272

73-
### GAP example
73+
## GAP example
7474

7575
Here is an example demonstrating how to use the GAP API to advertise, scan, connect and disconnect and how parameters influence efficiency of these actions.
7676

docs/api/bluetooth/GattClient.md

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

33
<span class="notes">**Note:** Some functions, variables or types have been deprecated. Please see the class reference linked below for details.</span>
44

55
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`.
66

7-
### Discovery procedures
7+
## Discovery procedures
88

99
A GattServer hosts a fixed set of services. These services are a logical composition of characteristics that may be discovered, read or written and can broadcast their state to a connected client. These characteristics may also contain metainformation and named characteristic descriptors. A characteristic descriptor may indicate the unit used for a characteristic value, describe the characteristic purpose in a textual form or allow a client to register for update notifications for the characteristic value.
1010

1111
Prior to any interaction with a server characteristic, a GattClient discovers the layout of the services and characteristics present on the server.
1212

1313
The layout of the descriptors of a characteristic may also be issued as an extra discovery step.
1414

15-
### Attribute manipulation
15+
## Attribute manipulation
1616

1717
As a result of the discovery process, the client can start interacting with the characteristic discovered. Depending on the characteristic properties (acquired during discovery), a client can read or write the value of a given characteristic.
1818

1919
Mbed BLE abstracts read and write operations to offer a single API that can be used to read or write characteristic values. The application code does not have to handle the necessary fragmentation or reassembly process if the attribute value to be transported can't fit in a single data packet.
2020

21-
### Attribute Protocol Maximum Transmission Unit (ATT_MTU)
21+
## Attribute Protocol Maximum Transmission Unit (ATT_MTU)
2222

2323
`ATT_MTU` is the maximum size of the attribute protocol packet. Operation on attributes too large to fit into a single packet are split across multiple operations.
2424

@@ -28,16 +28,16 @@ Only `GattClient` can trigger the exchange of `ATT_MTU` between client and serve
2828

2929
`ATT_MTU` is at least 23 octets by default. If a larger size is negotiated, the user application will be informed through the `onAttMtuChange` function called in the `GattClient::EventHandler`. (`GattServer::EventHandler` is also informed.)
3030

31-
### Server initiated events
31+
## Server initiated events
3232

3333
When a server updates a characteristic value, it can forward the new value to any registered clients. Clients may register for these updates on a per-characteristic basis. The server sends the updates by using notifications (no confirmation from client) or indications (client confirms receipt). This mechanism minimizes the number of transactions between a client and a server by avoiding polling.
3434

3535
Clients register for these updates by setting the Client Characteristic Configuration Descriptor (CCCD) value. This is an attribute, and the client needs to discover its descriptor. It is present in the characteristic if its notify or indicate properties are set.
3636

37-
### GattClient class reference
37+
## GattClient class reference
3838

3939
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_gatt_client.html)
4040

41-
### GattClient example
41+
## GattClient example
4242

4343
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-GattClient/)](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-GattClient/file/38639a71a0f1/source/main.cpp)

0 commit comments

Comments
 (0)