Skip to content

Commit e5fa889

Browse files
committed
Final change to connectivity
1 parent 932893b commit e5fa889

File tree

7 files changed

+23
-27
lines changed

7 files changed

+23
-27
lines changed

docs.json

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -701,10 +701,10 @@
701701
},
702702
{
703703
"title": "Connectivity architecture",
704-
"intro": {
704+
"sources": [{
705705
"path": "docs/api/networking-arch.md"
706706
},
707-
"sources": [{
707+
{
708708
"path": "docs/api/networksocket/networksocket.md"
709709
},
710710
{
@@ -793,18 +793,10 @@
793793
{
794794
"path": "docs/api/networkinterfaces/MeshInterface.md"
795795
},
796-
{
797-
"path": "docs/api/nfc/MessageBuilder.md"
798-
},
799-
{
800-
"path": "docs/api/nfc/MessageParser.md"
801-
},
802796
{
803797
"path": "docs/api/networkinterfaces/NetworkStatus.md"
804798
},
805-
{
806-
"path": "docs/api/nfc/SimpleMessageParser.md"
807-
},
799+
808800
{
809801
"path": "docs/api/networkinterfaces/WifiInterface.md"
810802
}
@@ -854,14 +846,20 @@
854846
},
855847
{
856848
"title": "NFC APIs",
857-
"intro": {
858-
"path": "docs/api/nfc/NDEF.md"
859-
},
860849
"sources": [{
850+
"path": "docs/api/nfc/MessageBuilder.md"
851+
},
852+
{
853+
"path": "docs/api/nfc/MessageParser.md"
854+
},
855+
{
861856
"path": "docs/api/nfc/NFCController.md"
862857
},
863858
{
864859
"path": "docs/api/nfc/NFCEEPROM.md"
860+
},
861+
{
862+
"path": "docs/api/nfc/SimpleMessageParser.md"
865863
}
866864
]
867865
},

docs/api/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,10 +219,7 @@ This list does not include the internal APIs, which are not intended for use by
219219
| [Cellular](../apis/cellular-api.html) | ✔ | |
220220
| [Ethernet](../apis/ethernet.html) | ✔ | |
221221
| [Mesh](../apis/mesh-api.htm) | ✔ | |
222-
| [MessageBuilder](../apis/messagebuilder.html) | ✔ | |
223-
| [MessageParser](../apis/messageparser.html) | ✔ | |
224222
| [Network status](../apis/network-status.html) | ✔ | |
225-
| [SimpleMessageParser](../apis/simplemessageparser.html) | ✔ | |
226223
| [Wi-Fi](../apis/wi-fi.html) | ✔ | |
227224

228225
### Secure socket
@@ -258,8 +255,11 @@ This list does not include the internal APIs, which are not intended for use by
258255

259256
| API | Full profile | Bare metal profile |
260257
| - | - | - |
258+
| [MessageBuilder](../apis/messagebuilder.html) | ✔ | |
259+
| [MessageParser](../apis/messageparser.html) | ✔ | |
261260
| [NFCController](../apis/nfccontroller.html) | ✔ |✔ (can be manually enabled) |
262261
| [NFC EEPROM](../apis/nfc-eeprom.html) | ✔ | ✔ (can be manually enabled) |
262+
| [SimpleMessageParser](../apis/simplemessageparser.html) | ✔ | |
263263

264264
### LoRaWAN
265265

docs/api/bluetooth/ble_tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 id="ble-tutorial">BLE</h1>
1+
# BLE tutorials
22

33
## Getting started
44

docs/api/connectivity_list.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@
1414
- [Cellular](../apis/cellular-api.html): Connect to the internet over a Cellular device.
1515
- [Ethernet](../apis/ethernet.html): Connect to the internet over Ethernet.
1616
- [Mesh](../apis/mesh-api.htm): Use the IPv6 mesh network topologies through the Nanostack networking stack to connect to a mesh network: Wi-Sun or 6LoWPAN-ND.
17-
- [MessageBuilder](../apis/messagebuilder.html): Construct NDEF messages, the common data format exchange for NFC messages.
18-
- [MessageParser](../apis/messageparser.html): An event-driven NDEF message parser for a data buffer.
1917
- [Network status](../apis/network-status.html): Trigger a callback each time the network interface's status changes.
20-
- [SimpleMessageParser](../apis/simplemessageparser.html): Similar to MessageParser, but includes subparsers for well-known NFC types records, such as Text, URI or Mime records, and produces usable objects out of the box.
2118
- [Wi-Fi](../apis/wi-fi.html): Connect to the internet over a Wi-Fi device.
2219

2320
## Secure socket
@@ -41,10 +38,11 @@
4138

4239
## NFC
4340

41+
- [MessageBuilder](../apis/messagebuilder.html): Construct NDEF messages, the common data format exchange for NFC messages.
42+
- [MessageParser](../apis/messageparser.html): An event-driven NDEF message parser for a data buffer.
4443
- [NFCController](../apis/nfccontroller.html): Emulate NFC tags that a smartphone can read and generate NDEF messages on demand.
4544
- [NFC EEPROM](../apis/nfc-eeprom.html): Store NDEF messages.
46-
47-
Note: Use MessageParser SimpleMessageParser and MessageBuilder to construct and parse NDEF messages.
45+
- [SimpleMessageParser](../apis/simplemessageparser.html): Similar to MessageParser, but includes subparsers for well-known NFC types records, such as Text, URI or Mime records, and produces usable objects out of the box.
4846

4947
## LoRaWAN
5048

docs/api/lorawan/lorawanintro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# LoRaWAN overview
1+
# LoRaWAN usage
22

33
LoRaWAN is a technology designed for low-power battery powered devices. These devices operate in an unlicensed spectrum, creating high density wide-area networks.
44

docs/api/networkinterfaces/networkinterface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Network interface overview
1+
# Network interface
22

33
A socket requires a NetworkInterface instance to indicate which NetworkInterface the socket should be created on. The NetworkInterface provides a network stack that implements the underlying socket operations.
44

@@ -118,7 +118,7 @@ Please see the previous section, [Default network interface](#default-network-in
118118

119119
For network status changes, the API is specified in [Network status](network-status.html) section. Being portable means that your application only communicates after `NSAPI_STATUS_GLOBAL_UP` is received and tries to reconnect the network if `NSAPI_STATUS_DISCONNECTED` is received without calling `NetworkInterface::disconnect()`.
120120

121-
# Using multiple network interfaces
121+
## Using multiple network interfaces
122122

123123
In Mbed OS, applications usually use one network interface at a time, and most APIs are designed this way. With few limitations, applications are able to operate more than one NetworkInterface. In Mbed OS, there are two built-in IP stacks and many external IP stacks provided by modules. Please refer to the [Architecture:IP networking](../reference/ip-networking.html) section for an explanation of how different stacks are integrated into Mbed OS.
124124

docs/api/networksocket/networksocket.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1 id="network-socket">Network socket overview</h1>
1+
# Network socket
22

33
The application programming interface for IP networking is the Socket API. As described in the [IP networking](../reference/ip-networking.html) section, the Socket API relates to OSI layer 4, the Transport layer. In Mbed OS, the Socket API is abstract and supports various protocols such as TCP, UDP and non-IP data delivery for NB-IoT cellular networks.
44

0 commit comments

Comments
 (0)