Skip to content

Commit 6165386

Browse files
author
Cruz Monrreal
authored
Merge pull request #7893 from kivaisan/improve_callback_descriptions
Lora: Improve description of callback methods
2 parents dd91b90 + e4c4e7c commit 6165386

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

features/lorawan/lorawan_types.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -242,10 +242,6 @@ typedef enum lora_events {
242242
* 'link_check_resp' callback. The result is thus transported to the application
243243
* via callback function provided.
244244
*
245-
* As can be seen from declaration, mbed::Callback<void(uint8_t, uint8_t)> *link_check_resp)
246-
* carries two parameters. First one is Demodulation Margin and the second one
247-
* is number of gateways involved in the path to network server.
248-
*
249245
* 'battery_level' callback goes in the down direction, i.e., it informs
250246
* the stack about the battery level by calling a function provided
251247
* by the upper layers.
@@ -257,11 +253,16 @@ typedef struct {
257253
mbed::Callback<void(lorawan_event_t)> events;
258254

259255
/**
260-
* Optional
256+
* This callback is optional
257+
*
258+
* The first parameter to the callback function is the demodulation margin, and the second
259+
* parameter is the number of gateways that successfully received the last request.
261260
*/
262261
mbed::Callback<void(uint8_t, uint8_t)> link_check_resp;
263262

264263
/**
264+
* This callback is optional. If the callback is not set, the stack returns 255 to gateway.
265+
*
265266
* Battery level return value must follow the specification
266267
* for DevStatusAns MAC command:
267268
*

0 commit comments

Comments
 (0)