michaelh/zephyr
1
0
Fork 0
Code Releases Activity

lora: fix lora_recv parameter description

Browse source 
The timeout parameter for `lora_recv` is no longer a millisecond value
but a standard `k_timeout_t` value.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
This commit is contained in:
Jordan Yates 2021-06-25 20:39:19 +10:00 • committed by Christopher Friedt
commit abdd61c3e9
1 changed files with 1 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/drivers/lora.h
View file

@ -141,9 +141,7 @@ static inline int lora_send(const struct device *dev,
* @param data Buffer to hold received data * @param data Buffer to hold received data
* @param size Size of the buffer to hold the received data. Max size * @param size Size of the buffer to hold the received data. Max size
allowed is 255. allowed is 255.
* @param timeout Timeout value in milliseconds. API also accepts, 0 * @param timeout Duration to wait for a packet.
for no wait time and SYS_FOREVER_MS for blocking until
data arrives.
* @param rssi RSSI of received data * @param rssi RSSI of received data
* @param snr SNR of received data * @param snr SNR of received data
* @return Length of the data received on success, negative on error * @return Length of the data received on success, negative on error