Skip to content

Commit 93a34fc

Browse files
author
Amanda Butler
authored
Copy edit README.md
Copy edit for minor grammar changes, such as active voice, proper nouns and typo fixes.
1 parent 100a7b9 commit 93a34fc

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Example cellular application for mbed OS
22

3-
This is a simple example based upon mbed-os celular APIs that demonstrates a simple TCP or UDP echo transaction with a public echo server.
3+
This is an example based on `mbed-os` cellular APIs that demonstrates a TCP or UDP echo transaction with a public echo server.
44

55
## Getting started
66

7-
This particular Cellular application uses a Cellular network and network-socket APIs that are provided as a part of [mbed-os](github.com/armmbed/mbed-os).
7+
This particular cellular application uses a cellular network and network-socket APIs that are part of [`mbed-os`](github.com/armmbed/mbed-os).
88

9-
The program uses a [generic celular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver) utilizing an external IP stack (LWIP) standard 3GPP AT 27.007 AT commands to setup the cellular modem and registers to the network.
10-
After registration, the driver opens up a PPP (point-to-point protocol) pipe using LWIP with the cellular modem and connects to internet. This driver currently supports UART data connection type only between your cellular modem and MCU.
9+
The program uses a [generic cellular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver) using an external IP stack (LWIP) standard 3GPP AT 27.007 AT commands to setup the cellular modem and registers to the network.
1110

12-
For more information on ARM mbed-os cellular APIs and porting guide, please visit [mbed-os Cellular Docs](https://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/communication/cellular/).
11+
After registration, the driver opens a point-to-point protocol (PPP) pipe using LWIP with the cellular modem and connects to internet. This driver currently supports UART data connection type only between your cellular modem and MCU.
12+
13+
For more information on ARM mbed OS cellular APIs and porting guide, please visit the [mbed OS cellular documentation](https://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/communication/cellular/).
1314

1415
### Download the application
1516

@@ -25,8 +26,7 @@ $ cd mbed-os-example-cellular
2526

2627
### Change the network and SIM credentials
2728

28-
See the file `mbed_app.json` in te root directory of your application. This file contains all the user specific configurations needed by your application.
29-
Provide the pin code for your SIM crad as well as any APN settings if needed, e.g.,
29+
See the file `mbed_app.json` in the root directory of your application. This file contains all the user specific configurations your application needs. Provide the pin code for your SIM card, as well as any APN settings if needed. For example:
3030

3131
```json
3232
"sim-pin-code": {
@@ -49,18 +49,17 @@ Provide the pin code for your SIM crad as well as any APN settings if needed, e.
4949

5050
### Selecting socket type (TCP or UDP)
5151

52-
You can choose which socket type the application should use, e.g.,
52+
You can choose which socket type the application should use. For example:
5353

5454
```json
5555

5656
"sock-type": "TCP",
5757

5858
```
5959

60-
### Turning Modem AT echo trace on
60+
### Turning modem AT echo trace on
6161

62-
If you like details and wish to know about all the AT interactions between the modem and your driver, turn on the modem AT echo trace.
63-
Set `modem_trace` field value to be true.
62+
If you like details and wish to know about all the AT interactions between the modem and your driver, turn on the modem AT echo trace. Set the `modem_trace` field value to be true.
6463

6564
```json
6665
"modem_trace": {
@@ -71,23 +70,23 @@ Set `modem_trace` field value to be true.
7170

7271
### Board support
7372

74-
The [generic celular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver) used by this application is written using only a standard AT command set and the uses PPP with a full fledge mbed-supported external IP stack. These abilities make the driver essentially generic, i.e., non-vendor specific. However, this particular driver is written for onboard-modem types, i.e., the modem exists on the mbed-enabled target as oppose to plugin-modules (shields). For more details, please check documentation [mbed-os Cellular Docs](https://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/communication/cellular/).
73+
The [generic cellular modem driver](https://github.com/ARMmbed/mbed-os/tree/master/features/netsocket/cellular/generic_modem_driver) this application uses was written using only a standard AT command set. It uses PPP with an mbed-supported external IP stack. These abilities make the driver essentially generic, or nonvendor specific. However, this particular driver is for onboard-modem types. In other words, the modem exists on the mbed Enabled target as opposed to plug-in modules (shields). For more details, please see our [mbed OS cellular documentation](https://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/communication/cellular/).
7574

76-
Examples of mbed-enabled boards with onboard modem chips can be, [u-blox C027](https://developer.mbed.org/platforms/u-blox-C027/) and [MultiTech MTS Dragonfly](https://developer.mbed.org/platforms/MTS-Dragonfly/).
75+
Examples of mbed Enabled boards with onboard modem chips include [u-blox C027](https://developer.mbed.org/platforms/u-blox-C027/) and [MultiTech MTS Dragonfly](https://developer.mbed.org/platforms/MTS-Dragonfly/).
7776

7877
## Compiling the application
7978

80-
Use mbed-cli commands to generate a binary for the application, e.g., in case of GCC use the following command:
79+
Use mbed CLI commands to generate a binary for the application. For example, in the case of GCC, use the following command:
8180

8281
```sh
8382
$ mbed compile -m YOUR_TARGET_WITH_MODEM -t GCC_ARM
8483
```
8584

8685
## Running the application
8786

88-
Drag and drop the application binary from `BUILD/YOUR_TARGET_WITH_MODEM/GCC_ARM/mbed-os-example-cellular.bin` to your mbed-enabled target hardware which appears as a USB device on your host machine.
87+
Drag and drop the application binary from `BUILD/YOUR_TARGET_WITH_MODEM/GCC_ARM/mbed-os-example-cellular.bin` to your mbed Enabled target hardware, which appears as a USB device on your host machine.
8988

90-
Attatch a serial console emulator of your choice (e.g., putty, minicom, screen etc) to your USB device, set the baudrate to be 115200 and reset your board by pressing reset button.
89+
Attach a serial console emulator of your choice (for example, PuTTY, Minicom or screen) to your USB device. Set the baudrate to 115200, and reset your board by pressing the reset button.
9190

9291
You should see an output similar to this:
9392

@@ -102,5 +101,4 @@ Received from echo server 4 Bytes
102101
103102
Success. Exiting
104103
105-
```
106-
104+
```

0 commit comments

Comments
 (0)