Finish documention until someone change something

This commit is contained in:
2022-02-15 20:12:50 +01:00
parent 3a2e51713b
commit c8e3344b27
50 changed files with 991 additions and 223 deletions
+19 -9
View File
@@ -69,15 +69,16 @@ class DebugMqtt {
* @brief Construct a new Debug Mqtt object.
*
* @param name A String with send with every Message.
* @param bufSize for the addCharacter function.
*/
DebugMqtt(const char* name);
DebugMqtt(const char* name, uint8_t bufSize = 0);
~DebugMqtt();
/**
* @brief Send a Message via MQTT
*
* This funtion uses sendData to send the given string and
* This function uses sendData to send the given string and
* add the name to the message given by the constructer.
*
* @see sendData()
@@ -93,9 +94,9 @@ class DebugMqtt {
/**
* @brief Send a Message via MQTT
*
* This funtion sends the Data via MQTT with the given topic
* This function sends the Data via MQTT with the given topic
* from Loglevel or followed by given String topic.
* Normaly this function is called by sendMsg() or by
* Normally this function is called by sendMsg() or by
* writeToInflux()
*
* @see sendData()
@@ -112,7 +113,7 @@ class DebugMqtt {
/**
* @brief Send a Message via MQTT for InfluxDB
*
* This funtion sends a MQTT message which is intended for
* This function sends a MQTT message which is intended for
* Telegraf. Telegraf can listen on MQTT messages and put
* them in an Influx Database.
*
@@ -123,14 +124,23 @@ class DebugMqtt {
*/
void writeToInflux(String measurement_name, String field_set, float measurement, uint64_t nanos);
/**
* @brief Adds a single character to the buf
*
* The buf will be flushed out:
* 1. when the buffer is full
* 2. when the character is '\n'
*
* @param c
*/
void addCharacter(char c);
/**
* @brief Initalize debugMQTT for all instances
* @brief Initialize debugMQTT for all instances
*
* You only have to call this function once for your project.
* If you call this funtion again you overwrite the client and
* the loglevel. If you only eant du overwrite the max_loglevel
* If you call this function again you overwrite the client and
* the loglevel. If you only want du overwrite the max_loglevel
* use changeLoglevel()
*
* @see changeLoglevel()
@@ -153,7 +163,7 @@ class DebugMqtt {
const char* name;
char* buf;
uint8_t bufPos = 0;
uint8_t bufSitze = 100;
uint8_t bufSize = 100;
static String enum_to_string(Loglevel loglevel);