ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit LoRaWANBase.h 

Copy edit file for minor grammar nits.
pull/7719/head
Amanda Butler 2018-08-09 15:51:11 -05:00 committed by GitHub
parent 57f89a2576
commit 9e74fa5072
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
features/lorawan/LoRaWANBase.h
View File

@ -141,9 +141,9 @@ public:
* *
* One way to use this API may be the validation of connectivity after a long deep sleep. * One way to use this API may be the validation of connectivity after a long deep sleep.
* Mbed LoRaWANStack follows the MAC commands with data frame payload, so the application needs * Mbed LoRaWANStack follows the MAC commands with data frame payload, so the application needs
* send something, and the Network Server may respond during the RX slots. * to send something, and the Network Server may respond during the RX slots.
* *
* This API is usable only when the 'link_check_resp' callback is set by the application. * This API is usable only when the application sets the 'link_check_resp' callback.
* See add_lora_app_callbacks API. If the above mentioned callback is not set, * See add_lora_app_callbacks API. If the above mentioned callback is not set,
* a LORAWAN_STATUS_PARAMETER_INVALID error is thrown. * a LORAWAN_STATUS_PARAMETER_INVALID error is thrown.
* *
@ -151,7 +151,7 @@ public:
* is the number of gateways that successfully received the last request. * is the number of gateways that successfully received the last request.
* *
* A 'Link Check Request' MAC command remains set for every subsequent transmission, until/unless * A 'Link Check Request' MAC command remains set for every subsequent transmission, until/unless
* application explicitly turns it off using remove_link_check_request() API. * the application explicitly turns it off using the remove_link_check_request() API.
* *
* @return LORAWAN_STATUS_OK on successfully queuing a request, or * @return LORAWAN_STATUS_OK on successfully queuing a request, or
* a negative error code on failure: * a negative error code on failure:
@ -170,7 +170,7 @@ public:
/** Sets up a particular data rate /** Sets up a particular data rate
* *
* @param data_rate The intended data rate, for example DR_0 or DR_1. * @param data_rate The intended data rate, for example DR_0 or DR_1.
* Please note, that the macro DR_* can mean different things in different regions. * Please note that the macro DR_* can mean different things in different regions.
* @return LORAWAN_STATUS_OK if everything goes well, otherwise a negative error code: * @return LORAWAN_STATUS_OK if everything goes well, otherwise a negative error code:
* LORAWAN_STATUS_NOT_INITIALIZED if system is not initialized with initialize(), * LORAWAN_STATUS_NOT_INITIALIZED if system is not initialized with initialize(),
* LORAWAN_STATUS_PARAMETER_INVALID if ADR is enabled or invalid data rate is given * LORAWAN_STATUS_PARAMETER_INVALID if ADR is enabled or invalid data rate is given
@ -232,7 +232,7 @@ public:
* You need to ensure that the corresponding base station supports the channel or channels being added. * You need to ensure that the corresponding base station supports the channel or channels being added.
* *
* If your list includes a default channel (a channel where Join Requests are received), * If your list includes a default channel (a channel where Join Requests are received),
* you cannot fully configure the channel parameters. Either leave the channel settings to default * you cannot fully configure the channel parameters. Either leave the channel settings to default,
* or check your corresponding PHY layer implementation. For example, LoRaPHYE868. * or check your corresponding PHY layer implementation. For example, LoRaPHYE868.
* *
* @param channel_plan The channel plan to set. * @param channel_plan The channel plan to set.
@ -462,14 +462,14 @@ public:
/** Get hold of backoff time /** Get hold of backoff time
* *
* In the TX path, because of automatic duty cycling, the transmission is delayed by a certain * In the TX path, because of automatic duty cycling, the transmission is delayed by a certain
* amount of time which is the backoff time. While the system schedules application data to be sent, * amount of time, which is the backoff time. While the system schedules application data to be sent,
* the application can inquire about how much time is left in the actual transmission to happen. * the application can inquire about how much time is left in the actual transmission to happen.
* *
* The system will provide you with a backoff time only if the application data is in the TX pipe. * The system will provide you with a backoff time only if the application data is in the TX pipe.
* If however, the event is already queued for the transmission, this API returns a * If however, the event is already queued for the transmission, this API returns a
* LORAWAN_STATUS_METADATA_NOT_AVAILABLE error code. * LORAWAN_STATUS_METADATA_NOT_AVAILABLE error code.
* *
* @param backoff the inbound integer that will be carry the backoff time if it is available. * @param backoff the inbound integer that will carry the backoff time if it is available.
* *
* @return LORAWAN_STATUS_OK if the meta-data is available, * @return LORAWAN_STATUS_OK if the meta-data is available,
* otherwise other negative error code if request failed: * otherwise other negative error code if request failed: