More doxygen comments added.

Reviewed-on: #6

.drone.yml

@@ -16,10 +16,17 @@ steps:
 - name: release
   image: plugins/gitea-release
   settings:
-    api_key: a7f3afc9f77e721951e48b4af66d7565700b7a2e
+    api_key: 
+      from_secret: DRONE_ACCESS_TOKEN
     base_url: https://code.jcktrue.dk
     files:
       - .pio/build/nodemcu/firmware.bin
-      - .pio/build/nodemcu/firmware.elf
+    checksum:
+      - md5
+      - sha1
+      - sha256
+      - sha512
+      - adler32
+      - crc32
   when:
     event: tag

.gitignore

@@ -1,5 +1,4 @@
-.pioenvs
-.piolibdeps
 .pio
 data/homie/config.json
-nbproject
+.vscode
+output/doxygen

Makefile

@@ -4,3 +4,6 @@ build:
 otaupload: 
 	pip install -r .pio/libdeps/nodemcu/Homie/scripts/ota_updater/requirements.txt
 	python .pio/libdeps/nodemcu/Homie/scripts/ota_updater/ota_updater.py -l mqtt.jcktrue.dk -i 18fe34f2f987 .pio/build/nodemcu/firmware.bin
+
+docs:
+	doxygen .\.doxygen

data/homie/config.example.json

@@ -0,0 +1,15 @@
+{
+  "name": "deskcontrol",
+  "wifi": {
+    "ssid": "<SSID>",
+    "password": "<PASS>"
+  },
+  "mqtt": {
+    "host": "<Domain>",
+    "port": 1883,
+    "auth": false
+  },
+  "ota": {
+    "enabled": true
+  }
+}

include/config.h

@@ -0,0 +1,36 @@
+/**
+ * \file
+ * \class Config
+ */
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#ifndef VERSION
+//SEMVER style version
+/**
+ * \brief Version string. 
+ * Update as needed. Formatted as SEMVER style string.
+ * See https://semver.org/ for more information.
+ */
+#define VERSION          "0.4.5-Dev"
+#endif
+
+/**
+ * Set the default Serial baudrate in bits/seconds
+ */
+#define CONFIG_SERIAL_BAUDRATE  115200
+
+/**
+ * Pin ID of the output relay
+ */
+#define CONFIG_IO_RELAY         D1
+/**
+ * Pin ID of the DHT11 temperature sensor
+ */
+#define CONFIG_IO_DHT11         D2
+
+/**
+ * Interval at which the tempreature is sent in seconds
+ */
+#define CONFIG_TEMPERATURE_SEND_INTERVAL 60
+#endif

platformio.ini

@@ -1,27 +1,12 @@
-#
+[env]
-# Project Configuration File
-#
-# A detailed documentation with the EXAMPLES is located here:
-# http://docs.platformio.org/en/latest/projectconf.html
-#
-
-# A sign `#` at the beginning of the line indicates a comment
-# Comment lines are ignored.
-
-# Simple and base environment
-# [env:mybaseenv]
-# platform = %INSTALLED_PLATFORM_NAME_HERE%
-# framework =
-# board =
-#
-# Automatic targets - enable auto-uploading
-# targets = upload
-
-[env:nodemcu]
 platform = espressif8266
 framework = arduino
-board = nodemcu
+
 upload_speed=921600
 
-build_flags = -D PIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY
+build_flags = -DPIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY -DVERSION=${sysenv.DRONE_SEMVER}
-lib_deps = https://github.com/homieiot/homie-esp8266.git#develop-v3, Syslog
+lib_deps = https://github.com/homieiot/homie-esp8266.git#develop, DHT sensor library for ESPx, HomieLoggerNode
+
+[env:nodemcu]
+board = nodemcu
+

src/main.cpp

@@ -1,32 +1,70 @@
+/**
+ * \brief Entry point
+ * 
+ * Deskcontrol is a simple on/off timer switch inteded for use with an ATX PSU.
+ * The theory of operation is turning on and off power by pulling the control line low/high while 
+ * running of the 5V standby line.
+ * 
+ * Additional features include support for a DHT11 to log the temperature.
+ * \file
+ */
+
+#include "config.h"
+
 #include <Homie.h>
-#include <Syslog.h>
-#include <WiFiUdp.h>
-WiFiUDP udpClient;
-Syslog syslog(udpClient, SYSLOG_PROTO_IETF);
 
-const int PIN_RELAY = D1;
+#include <LoggerNode.h>
-#define OUTPUT_SET(x)  digitalWrite(PIN_RELAY, x ? LOW : HIGH);
+LoggerNode LN; ///<Instance of the LoggerNode library
-unsigned int timer = 0;
+
-unsigned int next_timer_update = 0;
+#include "DHTesp.h"
+DHTesp dht; ///< Instance of the DHT temperature controller. 
+
+
+#define OUTPUT_SET(x)  digitalWrite(CONFIG_IO_RELAY, x ? LOW : HIGH)  ///< Macro for controlling the output state.
+unsigned int timer = 0;   ///< Remaining time when counting down.
+unsigned int next_timer_update = 0; ///< Timer used to control when the timer value should be pushed to the server
+
 HomieNode powerNode("power", "Power", "switch");
+HomieNode temperatureNode("temperature", "Temperature", "temperature");
 
-bool powerStateHandler(const HomieRange& range, const String& value) {
+/** Power state handler 
-    if (value != "on" && value != "off") return false;
+ * Handles event on the power state MQTT node
+ * \param[in] range Currently unused
+ * \param[in] value New value of the power state. (Either "on" or off")
+ * \return False if input is invalid. Otherwise true.
+ */
+bool powerStateHandler(const HomieRange& range, const String& value)
+{
+    if (value != "on" && value != "off") 
+    {
+      return false;
+    }
     powerNode.setProperty("state").send(value);
     powerNode.setProperty("timer").send("0");
     timer = 0;
-    if(value == "on") {
+
+    if(value == "on")
+    {
       OUTPUT_SET(true);
-      Homie.getLogger() << "Power is on" << endl;
+      LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power ON");
-    } else {
+    }
-      OUTPUT_SET(false);
+    else
-      Homie.getLogger() << "Power is off" << endl;
+    {
+      OUTPUT_SET(false); LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power OFF");
     }
     
     return true;
 }
 
-bool powerTimerHandler(const HomieRange& range, const String& value) {
+/**
+ * \brief powerTimer event handler.
+ * Handler for events on the powerTimer node.
+ * \param[in] range Currently unused.
+ * \param[in] value New value for the timer in minutes. ASCII representation of an integer from 1 to 120.
+ * \return False if input is invalid. Otherwise true.
+ */
+bool powerTimerHandler(const HomieRange& range, const String& value)
+{
     int settimer = value.toInt();
     if(settimer == 0 || settimer > 120) 
          return false;
@@ -35,86 +73,108 @@ bool powerTimerHandler(const HomieRange& range, const String& value) {
     next_timer_update = millis() + 60*1000;
     powerNode.setProperty("timer").send(String(settimer));
     powerNode.setProperty("state").send("on");
-    Homie.getLogger() << "Power is on for " << settimer << "minutes" << endl;
+    LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power on for %d minutes", settimer);
     OUTPUT_SET(true);
     return true;
 }
 
+/**
+ * setupHandler. Comply with Homie interface
+ */
+void setupHandler()
+{
+  pinMode(CONFIG_IO_RELAY, OUTPUT);
+  OUTPUT_SET(false);
+  powerNode.setProperty("state").send("off");
+  powerNode.setProperty("timer").send("0");
 
-void setupHandler() {
+  dht.setup(CONFIG_IO_DHT11, DHTesp::DHT11); // Connect DHT sensor to GPIO 17
-    pinMode(PIN_RELAY, OUTPUT);
-    OUTPUT_SET(false);
-    powerNode.setProperty("state").send("off");
-    powerNode.setProperty("timer").send("0");
 }
 
-void loopHandler() {
+/**
+ * Handle timer updates from the main event loop
+ */
+void loopHandleTimer() 
+{
   if(timer)
   {
     if(timer < millis()) 
-    {
+    { //Timer has expired. (Ignore the wraparound...)
       timer = 0;
       OUTPUT_SET(false);
       powerNode.setProperty("timer").send("0");
       powerNode.setProperty("state").send("off");
     }
-    if(millis() > next_timer_update) {
+
+    if(next_timer_update && millis() > next_timer_update)
+    {
       next_timer_update = millis() + 60*1000;
       unsigned int time_remaining = timer - millis();
       unsigned int min_left = time_remaining / (60*1000);
       powerNode.setProperty("timer").send(String(min_left));
-
     }
   }
 }
 
-void onHomieEvent(const HomieEvent& event) {
+/**
-  switch(event.type) {
+ * Handle periodic temperature measurements from the main event loop
-    case HomieEventType::OTA_FAILED:
+ */
-      syslog.log(LOG_INFO, "OTA failed");
+void loopHandleTemperature() 
-      // Do whatever you want when OTA is failed
+{
-      break;
+  static unsigned long lastTemperatureSent = 0;
-    case HomieEventType::OTA_SUCCESSFUL:
+  if (millis() - lastTemperatureSent >= CONFIG_TEMPERATURE_SEND_INTERVAL * 1000UL || lastTemperatureSent == 0)
-      syslog.log(LOG_INFO, "OTA completed");
+  {
-      break;
+    float humidity = dht.getHumidity();
-    case HomieEventType::WIFI_CONNECTED:
+    float temperature = dht.getTemperature();
-      // Do whatever you want when Wi-Fi is connected in normal mode
+    LN.logf(__PRETTY_FUNCTION__, LoggerNode::DEBUG, "Temperature: %f C Humidity: %f", temperature, humidity);
-      syslog.deviceHostname(Homie.getConfiguration().name);
+    temperatureNode.setProperty("temperature").send(String(temperature));
-      syslog.appName("deskcontrol");
+    temperatureNode.setProperty("humidity").send(String(humidity));
-      syslog.defaultPriority(LOG_ERR);
+    lastTemperatureSent = millis();
-      syslog.log(LOG_INFO, "WiFi Connected, software version: 1.0");
-      break;
-    case HomieEventType::MQTT_READY:
-      syslog.log(LOG_INFO, "MQTT connected");
-      break;
-    case HomieEventType::MQTT_DISCONNECTED:
-      syslog.log(LOG_INFO, "MQTT disconnected");
-      break;
-    default:
-      break;
   }
 }
 
-void setup() {
+/**
-    syslog.server("192.168.1.100", 514);
+ * Main event loop. Part of the Homie API. This runs while the device is active and connected.
+ * 
+ * \callgraph
+ */
+void loopHandler()
+{
+  loopHandleTimer();
+  loopHandleTemperature();
+}
 
-    Serial.begin(115200);
+/**
+ * Arduino style setup() routine.
+ * Configure the Homie framework by adding the two nodes "power" and "temperature"
+ */
+void setup()
+{
 
-    Serial << endl << endl;
+    Homie_setFirmware("deskcontrol", VERSION);
-    Serial << "Firmware 0.0.1" << endl;
+    Homie.setLoggingPrinter(&Serial);
-    Serial << endl << endl;
+    Serial.begin(CONFIG_SERIAL_BAUDRATE);
 
-    Homie_setFirmware("deskcontrol", "1.0.0");
+    Homie.disableResetTrigger();
-    Homie_setBrand("FuryFire");
 
+    //Power
     powerNode.advertise("state").settable(powerStateHandler);
     powerNode.advertise("timer").settable(powerTimerHandler);
+
+    //Temperature
+    temperatureNode.advertise("humidity");
+    temperatureNode.advertise("temperature");
+
     Homie.setSetupFunction(setupHandler);
-    Homie.onEvent(onHomieEvent); // before Homie.setup()
     Homie.setLoopFunction(loopHandler);
+
     Homie.setup();
 }
 
-void loop() {
+/**
+ * Arduino main loop. Forwarded to Homie framework
+ */
+void loop()
+{
     Homie.loop();
 }