You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
113 lines
4.1 KiB
113 lines
4.1 KiB
/*
|
|
|
|
MQTT MODULE
|
|
|
|
Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com>
|
|
Updated secure client support by Niek van der Maas < mail at niekvandermaas dot nl>
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "system.h"
|
|
|
|
#include <functional>
|
|
|
|
// These will be concatenated to the MQTT_TOPIC base to form the actual topic
|
|
|
|
#define MQTT_TOPIC_JSON "data"
|
|
#define MQTT_TOPIC_ACTION "action"
|
|
#define MQTT_TOPIC_RELAY "relay"
|
|
#define MQTT_TOPIC_LED "led"
|
|
#define MQTT_TOPIC_LOCK "lock"
|
|
#define MQTT_TOPIC_BUTTON "button"
|
|
#define MQTT_TOPIC_IP "ip"
|
|
#define MQTT_TOPIC_SSID "ssid"
|
|
#define MQTT_TOPIC_BSSID "bssid"
|
|
#define MQTT_TOPIC_VERSION "version"
|
|
#define MQTT_TOPIC_UPTIME "uptime"
|
|
#define MQTT_TOPIC_DATETIME "datetime"
|
|
#define MQTT_TOPIC_TIMESTAMP "timestamp"
|
|
#define MQTT_TOPIC_FREEHEAP "freeheap"
|
|
#define MQTT_TOPIC_VCC "vcc"
|
|
#define MQTT_TOPIC_STATUS "status"
|
|
#define MQTT_TOPIC_MAC "mac"
|
|
#define MQTT_TOPIC_RSSI "rssi"
|
|
#define MQTT_TOPIC_MESSAGE_ID "id"
|
|
#define MQTT_TOPIC_APP "app"
|
|
#define MQTT_TOPIC_INTERVAL "interval"
|
|
#define MQTT_TOPIC_HOSTNAME "host"
|
|
#define MQTT_TOPIC_DESCRIPTION "desc"
|
|
#define MQTT_TOPIC_TIME "time"
|
|
#define MQTT_TOPIC_RFOUT "rfout"
|
|
#define MQTT_TOPIC_RFIN "rfin"
|
|
#define MQTT_TOPIC_RFLEARN "rflearn"
|
|
#define MQTT_TOPIC_RFRAW "rfraw"
|
|
#define MQTT_TOPIC_UARTIN "uartin"
|
|
#define MQTT_TOPIC_UARTOUT "uartout"
|
|
#define MQTT_TOPIC_LOADAVG "loadavg"
|
|
#define MQTT_TOPIC_BOARD "board"
|
|
#define MQTT_TOPIC_PULSE "pulse"
|
|
#define MQTT_TOPIC_SPEED "speed"
|
|
#define MQTT_TOPIC_OTA "ota"
|
|
#define MQTT_TOPIC_TELNET_REVERSE "telnet_reverse"
|
|
#define MQTT_TOPIC_CURTAIN "curtain"
|
|
#define MQTT_TOPIC_CMD "cmd"
|
|
#define MQTT_TOPIC_SCHEDULE "schedule"
|
|
|
|
void mqttHeartbeat(espurna::heartbeat::Callback);
|
|
|
|
// stateless callback; generally, registered once per module when calling setup()
|
|
using MqttCallback = void(*)(unsigned int type, espurna::StringView topic, espurna::StringView payload);
|
|
void mqttRegister(MqttCallback);
|
|
|
|
// stateful callback for ACK'ed messages; should be used when waiting for certain messsage to be PUBlished
|
|
using MqttPidCallback = std::function<void()>;
|
|
void mqttOnPublish(uint16_t pid, MqttPidCallback);
|
|
void mqttOnSubscribe(uint16_t pid, MqttPidCallback);
|
|
|
|
String mqttTopic(const String& magnitude);
|
|
String mqttTopic(const String& magnitude, size_t index);
|
|
|
|
String mqttTopicSetter(const String& magnitude);
|
|
String mqttTopicSetter(const String& magnitude, size_t index);
|
|
|
|
espurna::StringView mqttMagnitude(espurna::StringView topic);
|
|
|
|
uint16_t mqttSendRaw(const char * topic, const char * message, bool retain, int qos);
|
|
uint16_t mqttSendRaw(const char * topic, const char * message, bool retain);
|
|
uint16_t mqttSendRaw(const char * topic, const char * message);
|
|
|
|
uint16_t mqttSubscribeRaw(const char * topic, int qos);
|
|
uint16_t mqttSubscribeRaw(const char * topic);
|
|
bool mqttSubscribe(const char * topic);
|
|
|
|
uint16_t mqttUnsubscribeRaw(const char * topic);
|
|
bool mqttUnsubscribe(const char * topic);
|
|
|
|
bool mqttSend(const char * topic, const char * message, bool force, bool retain);
|
|
bool mqttSend(const char * topic, const char * message, bool force);
|
|
bool mqttSend(const char * topic, const char * message);
|
|
|
|
bool mqttSend(const char * topic, unsigned int index, const char * message, bool force, bool retain);
|
|
bool mqttSend(const char * topic, unsigned int index, const char * message, bool force);
|
|
bool mqttSend(const char * topic, unsigned int index, const char * message);
|
|
|
|
void mqttSendStatus();
|
|
void mqttFlush();
|
|
|
|
void mqttEnqueue(espurna::StringView topic, espurna::StringView payload);
|
|
|
|
const String& mqttPayloadOnline();
|
|
const String& mqttPayloadOffline();
|
|
const char* mqttPayloadStatus(bool status);
|
|
|
|
void mqttEnabled(bool status);
|
|
bool mqttEnabled();
|
|
|
|
bool mqttForward();
|
|
|
|
bool mqttConnected();
|
|
|
|
void mqttDisconnect();
|
|
void mqttSetup();
|