Skip to content

Commit 9e74fa5

Browse files
author
Amanda Butler
authored
Copy edit LoRaWANBase.h
Copy edit file for minor grammar nits.
1 parent 57f89a2 commit 9e74fa5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

features/lorawan/LoRaWANBase.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -141,17 +141,17 @@ class LoRaWANBase {
141141
*
142142
* One way to use this API may be the validation of connectivity after a long deep sleep.
143143
* Mbed LoRaWANStack follows the MAC commands with data frame payload, so the application needs
144-
* send something, and the Network Server may respond during the RX slots.
144+
* to send something, and the Network Server may respond during the RX slots.
145145
*
146-
* This API is usable only when the 'link_check_resp' callback is set by the application.
146+
* This API is usable only when the application sets the 'link_check_resp' callback.
147147
* See add_lora_app_callbacks API. If the above mentioned callback is not set,
148148
* a LORAWAN_STATUS_PARAMETER_INVALID error is thrown.
149149
*
150150
* The first parameter to callback function is the demodulation margin, and the second parameter
151151
* is the number of gateways that successfully received the last request.
152152
*
153153
* A 'Link Check Request' MAC command remains set for every subsequent transmission, until/unless
154-
* application explicitly turns it off using remove_link_check_request() API.
154+
* the application explicitly turns it off using the remove_link_check_request() API.
155155
*
156156
* @return LORAWAN_STATUS_OK on successfully queuing a request, or
157157
* a negative error code on failure:
@@ -170,7 +170,7 @@ class LoRaWANBase {
170170
/** Sets up a particular data rate
171171
*
172172
* @param data_rate The intended data rate, for example DR_0 or DR_1.
173-
* Please note, that the macro DR_* can mean different things in different regions.
173+
* Please note that the macro DR_* can mean different things in different regions.
174174
* @return LORAWAN_STATUS_OK if everything goes well, otherwise a negative error code:
175175
* LORAWAN_STATUS_NOT_INITIALIZED if system is not initialized with initialize(),
176176
* LORAWAN_STATUS_PARAMETER_INVALID if ADR is enabled or invalid data rate is given
@@ -232,7 +232,7 @@ class LoRaWANBase {
232232
* You need to ensure that the corresponding base station supports the channel or channels being added.
233233
*
234234
* If your list includes a default channel (a channel where Join Requests are received),
235-
* you cannot fully configure the channel parameters. Either leave the channel settings to default
235+
* you cannot fully configure the channel parameters. Either leave the channel settings to default,
236236
* or check your corresponding PHY layer implementation. For example, LoRaPHYE868.
237237
*
238238
* @param channel_plan The channel plan to set.
@@ -462,14 +462,14 @@ class LoRaWANBase {
462462
/** Get hold of backoff time
463463
*
464464
* In the TX path, because of automatic duty cycling, the transmission is delayed by a certain
465-
* amount of time which is the backoff time. While the system schedules application data to be sent,
465+
* amount of time, which is the backoff time. While the system schedules application data to be sent,
466466
* the application can inquire about how much time is left in the actual transmission to happen.
467467
*
468468
* The system will provide you with a backoff time only if the application data is in the TX pipe.
469469
* If however, the event is already queued for the transmission, this API returns a
470470
* LORAWAN_STATUS_METADATA_NOT_AVAILABLE error code.
471471
*
472-
* @param backoff the inbound integer that will be carry the backoff time if it is available.
472+
* @param backoff the inbound integer that will carry the backoff time if it is available.
473473
*
474474
* @return LORAWAN_STATUS_OK if the meta-data is available,
475475
* otherwise other negative error code if request failed:

0 commit comments

Comments
 (0)