localhorst/ttn-esp32
1
0
Fork 0
mirror of https://github.com/manuelbl/ttn-esp32.git synced 2025-07-13 22:42:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation output

Browse Source
This commit is contained in:
Manuel Bleichenbacher
2021-07-29 23:06:13 +02:00
parent eb5792fbb9
commit 5c1db030f2
13 changed files with 1785 additions and 394 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
include/TheThingsNetwork.h
View File

@ -10,11 +10,20 @@
* High-level C++ API for ttn-esp32.
*******************************************************************************/
/**
* @file TheThingsNetwork.h
*/
#ifndef _THETHINGSNETWORK_H_
#define _THETHINGSNETWORK_H_
#include "ttn.h"
/**
* @brief Integer data type for specified the port of an uplink or downlink message.
*
* @deprecated Use @ref ttn_port_t instead.
*/
typedef ttn_port_t port_t;
/**
@ -22,9 +31,13 @@ typedef ttn_port_t port_t;
*/
enum TTNResponseCode
{
/** @brief Transmission failed error */
kTTNErrorTransmissionFailed = TTN_ERROR_TRANSMISSION_FAILED,
/** @brief Unexpected or internal error */
kTTNErrorUnexpected = TTN_ERROR_UNEXPECTED,
/** @brief Successful transmission of an uplink message */
kTTNSuccessfulTransmission = TTN_SUCCESSFUL_TRANSMISSION,
/** @brief Successful receipt of a downlink message */
kTTNSuccessfulReceive = TTN_SUCCESSFUL_RECEIVE
};
@ -401,7 +414,7 @@ struct TTNRFSettings
* @param length number of received bytes
* @param port port the message was received on
*/
typedef void (*TTNMessageCallback)(const uint8_t* payload, size_t length, port_t port);
typedef void (*TTNMessageCallback)(const uint8_t* payload, size_t length, ttn_port_t port);
/**
* @brief TTN device
@ -559,7 +572,7 @@ public:
* @param confirm flag indicating if a confirmation should be requested. Defaults to `false`
* @return `kTTNSuccessfulTransmission` for successful transmission, `kTTNErrorTransmissionFailed` for failed transmission, `kTTNErrorUnexpected` for unexpected error
*/
TTNResponseCode transmitMessage(const uint8_t *payload, size_t length, port_t port = 1, bool confirm = false)
TTNResponseCode transmitMessage(const uint8_t *payload, size_t length, ttn_port_t port = 1, bool confirm = false)
{
return static_cast<TTNResponseCode>(ttn_transmit_message(payload, length, port, confirm));
}

9
include/ttn.h
View File

@ -10,6 +10,12 @@
* High-level C API for ttn-esp32.
*******************************************************************************/
/**
* @file ttn.h
*
* C interface for ttn-esp32
*/
#ifndef TTN_C_H
#define TTN_C_H
@ -28,6 +34,9 @@ extern "C" {
#define TTN_NOT_CONNECTED 0xff
/**
* @brief Integer data type for specifiying the port of an uplink or downlink message.
*/
typedef uint8_t ttn_port_t;
/**