RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #8668 from aabadie/pr/pkg/semtech-loramac_doc

Browse Source 
pkg/semtech-loramac: fix doxygen documentation
This commit is contained in:
Alexandre Abadie 2018-03-01 14:42:26 +01:00 committed by GitHub
commit ed95802d88
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/doxygen/riot.doxyfile
View File

@ -831,7 +831,6 @@ EXCLUDE_PATTERNS = */board/*/tools/* \
*/pkg/lwip/* \
*/pkg/nordic_softdevice_ble/* \
*/pkg/openthread/* \
*/pkg/semtech-loramac/* \
*/pkg/tlsf/patch.txt \
*/sys/include/embUnit/* \
*/sys/random/tinymt32/* \

17
pkg/semtech-loramac/include/semtech_loramac.h
View File

@ -56,6 +56,9 @@ enum {
SEMTECH_LORAMAC_RX_DATA, /**< Data received */
};
/**
* @brief Structure containing LoRaWAN RX data
*/
typedef struct {
uint8_t payload[LORAWAN_APP_DATA_MAX_SIZE]; /**< RX payload buffer */
uint8_t payload_len; /**< Length of the RX payload */
@ -144,28 +147,28 @@ void semtech_loramac_get_appkey(uint8_t *key);
/**
* @brief Sets the application session key
*
* @param[in] key The application session key
* @param[in] skey The application session key
*/
void semtech_loramac_set_appskey(const uint8_t *skey);
/**
* @brief Gets the application session key
*
* @param[in] key The application session key
* @param[in] skey The application session key
*/
void semtech_loramac_get_appskey(uint8_t *skey);
/**
* @brief Sets the network session key
*
* @param[in] key The network session key
* @param[in] skey The network session key
*/
void semtech_loramac_set_nwkskey(const uint8_t *skey);
/**
* @brief Gets the network session key
*
* @param[in] key The network session key
* @param[in] skey The network session key
*/
void semtech_loramac_get_nwkskey(uint8_t *skey);
@ -242,7 +245,7 @@ bool semtech_loramac_get_public_network(void);
/**
* @brief Sets the NetID (only useful with ABP join procedure)
*
* @param[in] network_id The NetID
* @param[in] netid The NetID
*/
void semtech_loramac_set_netid(uint32_t netid);
@ -256,7 +259,7 @@ uint32_t semtech_loramac_get_netid(void);
/**
* @brief Sets the channels TX power index
*
* @param[in] dr The TX power index (from 1 to 16)
* @param[in] power The TX power index (from 1 to 16)
*/
void semtech_loramac_set_tx_power(uint8_t power);
@ -284,7 +287,7 @@ uint32_t semtech_loramac_get_rx2_freq(void);
/**
* @brief Sets the RX2 datarate
*
* @param[in] freq The RX2 datarate
* @param[in] dr The RX2 datarate
*/
void semtech_loramac_set_rx2_dr(uint8_t dr);