A wrapper over WiFi, MQTT and OTA for ESP8266
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples/ESPManager no message Dec 11, 2018
src Initial commit Dec 10, 2018
LICENSE Initial commit Dec 10, 2018
README.md Update README.md Dec 11, 2018
library.properties no message Dec 11, 2018

README.md

ESPManager

A wrapper over Wifi and MQTT.

Dependencies:

For details using SettingsManager please see the read.me file.

Constructor

ESPManager(<string spiffConfFile>, <int mqttQOS>, <boolean sendStatus>);

  • Initialise MQTT;
  • Reading settings from SPIFFS;
  • Configure WIFI as station;

addOutputEventHandler

addOutputEventHandler(<string mqttTopic>, <long intervalToSubmit>, <function executeFn> ) Will execute the executeFn in interval of intervalToSubmit and submit the returned value to mqttTopic topic;

  • mqttTopic a string with mqtt topic;
  • intervalToSubmit time to delay until next function trigger;
  • executeFn a function which returns the string that will be sent over MQTT;

executeFn(String const & topic, SettingsManager & settings)

addInputEventHandler

addInputEventHandler(<string mqttTopic>, <function onCall>) Creates a listener on a specific MQTT topic and will execute the onCall when something has been submitted;

  • mqttTopic a string with MQTT topic;
  • onCall a void function;

onCall(String const & msg, SettingsManager & settings)

  • msg message received on MQTT;
  • settings settings object(see SettingsManager);

createConnections;

createConnections() Creates connections and starts the process.