Skip to content

Commit b62ed07

Browse files
Amanda ButlerHasnain Virk
authored andcommitted
Copy edit README.md
Copy edit README for minor grammar issues.
1 parent 7c2a428 commit b62ed07

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,24 @@ $ cd mbed-os-example-lorawan
1919
$ mbed deploy
2020
```
2121

22-
### Selecting Radio
23-
Mbed-OS provides inherent support for a variety of modules. If your device is one of the those modules, you may skip this part.
24-
As you may notice that the correct radio type and pin set is already provided for the said modules in the `target-overrides` field.
25-
For more information on supported modules, please refer to [module support section](#module-support)
26-
27-
If you are using an Mbed enabled radio shield like [Mbed SX1276 shield LoRa](https://os.mbed.com/components/SX1276MB1xAS/) or [Mbed SX1272 LoRa shield ](https://os.mbed.com/components/SX1272MB2xAS/) with virtually any Mbed-enabled board, this part is relevant.
28-
You can virtually use any Mbed-enabled board which comes with arduino form factor.
29-
Please select your radio type by modifying `lora-radio` field and provide pin set if it is different from the default.
30-
For example:
22+
### Selecting radio
23+
24+
Mbed OS provides inherent support for a variety of modules. If your device is one of the those modules, you may skip this part. The correct radio type and pin set is already provided for the modules in the `target-overrides` field. For more information on supported modules, please refer to the [module support section](#module-support)
25+
26+
If you are using an Mbed Enabled radio shield such as [Mbed SX1276 shield LoRa](https://os.mbed.com/components/SX1276MB1xAS/) or [Mbed SX1272 LoRa shield ](https://os.mbed.com/components/SX1272MB2xAS/) with any Mbed Enabled board, this part is relevant. You can use any Mbed Enabled board that comes with an arduino form factor.
27+
28+
Please select your radio type by modifying the `lora-radio` field and providing a pin set if it is different from the default. For example:
29+
3130
```json
3231
"lora-radio": {
3332
"help": "Which radio to use (options: SX1272,SX1276)",
3433
"value": "SX1272"
3534
},
3635
```
36+
3737
### Add network credentials
3838

39-
Open the file `mbed_app.json` in the root directory of your application.
40-
This file contains all the user specific configurations your application and the Mbed-OS LoRaWAN stack needs.
39+
Open the file `mbed_app.json` in the root directory of your application. This file contains all the user specific configurations your application and the Mbed OS LoRaWAN stack need.
4140

4241
#### For OTAA
4342

@@ -58,20 +57,21 @@ For Activation-By-Personalization (ABP) connection method, modify the `mbed_app.
5857
"lora.over-the-air-activation": false,
5958
```
6059

61-
In addition to that you need to provide `Application Session Key`, `Network Session Key` and `Device Address`. For example:
60+
In addition to that, you need to provide `Application Session Key`, `Network Session Key` and `Device Address`. For example:
6261

6362
```json
6463
"lora.appskey": "{ YOUR_APPLICATION_SESSION_KEY }",
6564
"lora.nwkskey": "{ YOUR_NETWORK_SESSION_KEY }",
6665
"lora.device-address": " YOUR_DEVICE_ADDRESS_IN_HEX "
6766
```
67+
6868
## Configuring the application
6969

70-
Mbed-OS LoRaWAN stack provides a lot of configuration controls to the application via Mbed-OS config system. Some of such controls are discussed in the previous section. In this section we will highlight some useful features that can be configured.
70+
The Mbed OS LoRaWAN stack provides a lot of configuration controls to the application through the Mbed OS configuration system. The previous section discusses some of these controls. This section highlights some useful features that you can configure.
7171

7272
### Selecting a PHY
7373

74-
LoRaWAN protocol is subjected to various country specific regulations concerning radio emissions. That's why Mbed-OS LoRaWAN stack provides a `LoRaPHY` class which can be used to implement any region specific PHY layer. Currently, Mbed-OS LoRaWAN stack provides 10 different country-specific implementations of `LoRaPHY` class. Selection of a specific PHY layer happens at compile time. Bu default, the Mbed-OS LoRaWAN stack uses `EU 868 MHz` PHY. An example of selecting a PHY can be:
74+
The LoRaWAN protocol is subject to various country specific regulations concerning radio emissions. That's why the Mbed OS LoRaWAN stack provides a `LoRaPHY` class that you can use to implement any region specific PHY layer. Currently, the Mbed OS LoRaWAN stack provides 10 different country specific implementations of `LoRaPHY` class. Selection of a specific PHY layer happens at compile time. By default, the Mbed OS LoRaWAN stack uses `EU 868 MHz` PHY. An example of selecting a PHY can be:
7575

7676
```josn
7777
"phy": {
@@ -82,9 +82,9 @@ LoRaWAN protocol is subjected to various country specific regulations concerning
8282

8383
### Duty cycling
8484

85-
LoRaWAN v1.0.2 specifcation is exclusively duty cycle based. This application comes with duty cycle enabled by default, i.e., the Mbed-OS LoRaWAN stack enforces duty cycle. The stack keep track of transmissions on the channels in use and hence schedules transmissions on channels which become available in the shortest time possible. We recommend to keep duty cycle on for compliance to your country specific regulation.
85+
LoRaWAN v1.0.2 specifcation is exclusively duty cycle based. This application comes with duty cycle enabled by default. In other words, the Mbed OS LoRaWAN stack enforces duty cycle. The stack keeps track of transmissions on the channels in use and schedules transmissions on channels that become available in the shortest time possible. We recommend you keep duty cycle on for compliance with your country specific regulations.
8686

87-
However, user can define a timer value in the application which can be used to perform a periodic uplink when the duty cycle is turned off. Such a setup should be used only for testing or with a large enough timer value. For example:
87+
However, you can define a timer value in the application, which you can use to perform a periodic uplink when the duty cycle is turned off. Such a setup should be used only for testing or with a large enough timer value. For example:
8888

8989
```josn
9090
"target_overrides": {
@@ -97,13 +97,13 @@ However, user can define a timer value in the application which can be used to p
9797

9898
## Module support
9999

100-
Here is a non-exhaustive list of boards and modules which we have tested with Mbed-OS LoRaWAN stack.
100+
Here is a nonexhaustive list of boards and modules that we have tested with the Mbed OS LoRaWAN stack.
101101

102-
- MultiTech mDot
103-
- MultiTech xDot
104-
- LTEK_FF1705
105-
- Advantech Wise 1510
106-
- ST B-L072Z-LRWAN1 LoRa®Discovery kit (with muRata radio chip)
102+
- MultiTech mDot.
103+
- MultiTech xDot.
104+
- LTEK_FF1705.
105+
- Advantech Wise 1510.
106+
- ST B-L072Z-LRWAN1 LoRa®Discovery kit (with muRata radio chip).
107107

108108
## Compiling the application
109109

@@ -116,7 +116,7 @@ $ mbed compile -m YOUR_TARGET -t ARM
116116

117117
## Running the application
118118

119-
Drag and drop the application binary from `BUILD/YOUR_TARGET/ARM/mbed-os-example-lora.bin` yo your Mbed enabled target hardware which appears as USB device on your host machine.
119+
Drag and drop the application binary from `BUILD/YOUR_TARGET/ARM/mbed-os-example-lora.bin` to your Mbed enabled target hardware, which appears as a USB device on your host machine.
120120

121121
Attach a serial console emulator of your choice (for example, PuTTY, Minicom or screen) to your USB device. Set the baudrate to 115200 bit/s, and reset your board by pressing the reset button.
122122

@@ -142,13 +142,17 @@ Mbed LoRaWANStack initialized
142142
```
143143

144144
## [Optional] Memory optimization
145-
Using `Arm CC compiler` instead of `GCC` reduces `3K` of RAM. Currently the application takes about `15K` of static RAM with Arm CC which spills over for the platforms with `20K` of RAM because we need to leave space about `5K` for dynamic allocation. So if we reduce the application stack size, we can barely fit into the 20K platforms.
145+
146+
Using `Arm CC compiler` instead of `GCC` reduces `3K` of RAM. Currently the application takes about `15K` of static RAM with Arm CC, which spills over for the platforms with `20K` of RAM because you need to leave space, about `5K`, for dynamic allocation. So if you reduce the application stack size, you can barely fit into the 20K platforms.
147+
146148
For example, add the following into `config` section in your `mbed_app.json`:
147149

148150
```
149151
"main_stack_size": {
150152
"value": 2048
151153
}
152154
```
153-
Essentially you can make the whole application with Mbed LoRaWAN stack in 6K if you drop the RTOS from Mbed-OS.
154-
For more information, please follow the blog post [here](https://os.mbed.com/blog/entry/Reducing-memory-usage-by-tuning-RTOS-con/).
155+
156+
Essentially you can make the whole application with Mbed LoRaWAN stack in 6K if you drop the RTOS from Mbed OS.
157+
158+
For more information, please follow this [blog post](https://os.mbed.com/blog/entry/Reducing-memory-usage-by-tuning-RTOS-con/).

0 commit comments

Comments
 (0)