main/task_mqtt.h

Sat, 14 Mar 2020 15:52:04 +0100

author
Michiel Broek <mbroek@mbse.eu>
date
Sat, 14 Mar 2020 15:52:04 +0100
changeset 49
f526ba98a6b7
parent 44
e52d11b8f252
permissions
-rw-r--r--

Added function comment

/**
 * @file task_mqtt.h
 * @brief The FreeRTOS task to maintain MQTT connections.
 */

#ifndef	_TASK_MQTT_H
#define	_TASK_MQTT_H



/**
 * @brief Request a MQTT connection
 * @param state Request of disconnect a connection.
 */
void connect_mqtt(bool state);


/**
 * @brief Check if MQTT is connected
 * @return Returns true if MQTT is connected
 */
bool ready_mqtt(void);


/**
 * @brief Publish node birth
 */
void publishNode(void);


/**
 * @brief Publish units results
 */
void publishUnits(void);


/**
 * @brief Publish measurement logs
 */
void publishLogs(void);


/**
 * @brief The FreeRTOS task to run MQTT connections.
 * @param pvParameters Parameters for the task.
 */
void task_mqtt(void *pvParameters);


#endif

mercurial