Skip to content

Commit ea2cbdf

Browse files
author
Ari Parkkila
committed
Cellular docs updated
1 parent 17e2374 commit ea2cbdf

File tree

9 files changed

+41
-92
lines changed

9 files changed

+41
-92
lines changed

docs.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1147,10 +1147,6 @@
11471147
"type": "markdown",
11481148
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/tutorials/using_apis/flow_control.md"
11491149
},
1150-
{
1151-
"type": "markdown",
1152-
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/tutorials/using_apis/connectivity/cellular_tcp.md"
1153-
},
11541150
{
11551151
"type": "markdown",
11561152
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/tutorials/using_apis/ble_tutorial.md"

docs/api/networkinterfaces/CellularInterface.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<h2 id="cellular-api">Cellular</h2>
1+
<h2 id="cellular-api">Cellular API</h2>
22

3-
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_base.png)<span>CellularBase class hierarchy</span></span>
3+
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_interface.png)<span>CellularInterface class hierarchy</span></span>
44

5-
The [CellularBase](https://os.mbed.com/docs/development/mbed-os-api-doxy/_cellular_base_8h_source.html) provides a C++ API for connecting to the internet over a Cellular device.
6-
7-
Arm Mbed OS provides a [reference implementation of CellularBase](https://os.mbed.com/docs/development/mbed-os-api-doxy/_cellular_context_8h_source.html), which has more information.
5+
The [CellularInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_interface.html) class provides a C++ API for connecting to the internet over a Cellular device.
86

97
##### Getting started
108

@@ -48,15 +46,15 @@ You can use and extend a cellular interface in various different ways. For examp
4846
- The easy cellular connection uses standard 3GPP AT 27.007 AT commands to set up the cellular modem and to register to the network.
4947
- After registration, the driver opens a PPP pipe using LWIP with the cellular modem and connects to the internet. If AT only mode is in use, then modem-specific AT commands are used for socket data control.
5048

51-
### CellularBase class reference
49+
### CellularInterface class reference
5250

53-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_base.html)
51+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_interface.html)
5452

5553
### Usage
5654

5755
To bring up the network interface:
5856

59-
1. Instantiate an implementation of the CellularBase class.
57+
1. Instantiate an implementation of the CellularInterface class.
6058
1. Call the `connect(pincode, apn)` function with a PIN code for your SIM card and an APN for your network.
6159
1. Once connected, you can use Mbed OS [network sockets](network-socket.html) as usual.
6260

@@ -69,6 +67,6 @@ This example establishes connection with the cellular network using Mbed OS Cell
6967
### Related content
7068

7169
- [Network socket](network-socket.html) API reference overview.
72-
- [Cellular architecture](../reference/cellular.html).
70+
- [Cellular overview](../reference/cellular.html) describes more details about the cellular architecture and its usage.
7371
- [Cellular TCP sockets example](../tutorials/cellular-tcp-sockets.html).
7472
- [Cellular configuration documentation](../reference/configuration-connectivity.html).

docs/api/networkinterfaces/networkinterface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Applications may also ask for a specific type of connection, as the following ta
7979
|`*WiFiInterface::get_default_instance()`| Wi-Fi interface | Requires security parameters (mode, SSID, password). |
8080
|`*EthInterface::get_default_instance()` | Wired Ethernet interface, not Wi-Fi | none |
8181
|`*MeshInterface::get_default_instance()` | Returns either `LoWPANNDInterface` or `ThreadInterface`, depending on which is set to default | Target provides a driver or macro `DEVICE_802_15_4_PHY` is enabled. |
82-
| `*CellularBase::get_default_instance()` | Return cellular connectivity | Requires network parameters (pin, APN, username, password). |
82+
| `*CellularInterface::get_default_instance()` | Return cellular connectivity | Requires network parameters (pin, APN, username, password). |
8383
| `*NetworkInterface::get_default_instance()` | One of the above, depending on `target.network-default-interface-type`. | |
8484

8585
Note that the calls for a specific interface type do not preconfigure credentials such as SSID because an interface-type-specific application is expected to configure these in code. `NULL` is returned if no interface of that type is available.

docs/porting/connectivity/CellularInterface.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Cellular module porting
1+
## Cellular device porting
22

3-
This document provides guidelines how to make a cellular modem adaptation for Mbed OS. Please see [Cellular API usage](../apis/cellular-api.html) about how to use cellular modules from an application point of view.
3+
This document provides guidelines how to make a cellular device adaptation for Mbed OS.
44

5-
### Adding modem target support
5+
### Adding cellular on Mbed OS target
66

77
For new targets, you may need to modify [targets.json](../reference/adding-and-configuring-targets.html), which defines all the target platforms that Mbed OS supports. If Mbed OS supports your specific target, an entry for your target is in this file. To tell the Mbed OS build configuration that your target board has an onboard cellular module, you need to define `modem_is_on_board` and `modem_data_connection_type`.
88

@@ -56,7 +56,7 @@ typedef enum {
5656

5757
```
5858

59-
### Adding a new cellular target
59+
### Adding a new cellular device
6060

6161
You need to specify in [CellularTargets.h](https://os.mbed.com/docs/development/mbed-os-api-doxy/_cellular_targets_8h_source.html) the `<manufacturer-module>` that is mounted on your board.
6262

docs/porting/connectivity/NetworkStack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Please refer to the [IP networking architecture](../reference/ip-networking.html
1414

1515
#### NetworkInterface Class
1616

17-
The current NetworkInterface subclasses are [CellularInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_base.html), [EthernetInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_eth_interface.html), [MeshInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_mesh_interface.html) and [WiFiInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.html). Your communication interface is a subclass of one of these, as well as the NetworkStack. For example, the [ESP8266Interface](https://github.com/ARMmbed/esp8266-driver) inheritance structure looks like this:
17+
The current NetworkInterface subclasses are [CellularInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_interface.html), [EthernetInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_eth_interface.html), [MeshInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_mesh_interface.html) and [WiFiInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.html). Your communication interface is a subclass of one of these, as well as the NetworkStack. For example, the [ESP8266Interface](https://github.com/ARMmbed/esp8266-driver) inheritance structure looks like this:
1818

1919
<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/esp-class.png)<span>Class</span></span>
2020

docs/porting/connectivity/connectivity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The **DeviceInterface** should also inherit one of the following (unless it is a
1212

1313
- [EthInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_eth_interface.html).
1414
- [WiFiInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.html).
15-
- [CellularInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_base.html).
15+
- [CellularInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_cellular_interface.html).
1616
- [MeshInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_mesh_interface.html).
1717

1818
The **NetworkInterface** implementation provides the following methods:

docs/reference/configuration/Connectivity.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -198,11 +198,11 @@ Boards that provide only Ethernet connectivity do not require any configuration.
198198

199199
Select the default interface type by using one of the following `target.network-default-interface-type` parameters:
200200

201-
| `target.network-default-interface-type` | Required configuration |
201+
| `target.network-default-interface-type` | Configuration parameters |
202202
|-----------------------------------------|------------------------|
203203
| `ETHERNET` | nothing |
204204
| `WIFI` | `nsapi.default-wifi-security`, `nsapi.default-wifi-ssid` and `nsapi.default-wifi-password` |
205-
| `CELLULAR` | `nsapi.default-cellular-apn`, `nsapi.default-cellular-username` and `nsapi.default-cellular-password` |
205+
| `CELLULAR` | `nsapi.default-cellular-sim-pin`, `nsapi.default-cellular-apn`, `nsapi.default-cellular-username` and `nsapi.default-cellular-password`, `nsapi.default-cellular-plmn` |
206206
| `MESH` | `nsapi.default-mesh-type` |
207207

208208
```
@@ -223,9 +223,6 @@ Name: nsapi.default-wifi-ssid
223223
Name: nsapi.default-wifi-password
224224
Defined by: library:nsapi
225225
No value set
226-
Name: nsapi.default-cellular-plmn
227-
Defined by: library:nsapi
228-
No value set
229226
Name: nsapi.default-cellular-sim-pin
230227
Defined by: library:nsapi
231228
No value set
@@ -238,6 +235,9 @@ Name: nsapi.default-cellular-password
238235
Name: nsapi.default-cellular-username
239236
Defined by: library:nsapi
240237
No value set
238+
Name: nsapi.default-cellular-plmn
239+
Defined by: library:nsapi
240+
No value set
241241
Name: nsapi.default-mesh-type
242242
Defined by: library:nsapi
243243
Macro name: MBED_CONF_NSAPI_DEFAULT_MESH_TYPE

0 commit comments

Comments
 (0)