.drone.yml

@@ -3,30 +3,21 @@ name: default
 
 steps:
 - name: build
-  image: python:3
+  image: python:2
   commands:
   - pip install platformio
   - pio run
 - name: upload
-  image: python:3
+  image: python:2
   commands:
   - make otaupload
-  when:
-    event: tag
 - name: release
   image: plugins/gitea-release
   settings:
-    api_key: 
+    api_key: a7f3afc9f77e721951e48b4af66d7565700b7a2e
-      from_secret: DRONE_ACCESS_TOKEN
     base_url: https://code.jcktrue.dk
     files:
-      - .pio/build/nodemcu/firmware.bin
+      - .pioenvs/nodemcu/firmware.bin
-    checksum:
+      - .pioenvs/nodemcu/firmware.elf
-      - md5
-      - sha1
-      - sha256
-      - sha512
-      - adler32
-      - crc32
   when:
     event: tag

.gitignore

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

Jenkinsfile

@@ -0,0 +1,41 @@
+pipeline {
+    agent {
+        docker {
+            image 'debian:stretch-slim' 
+        }
+    }
+
+    stages {
+        stage('Requirements') { 
+            steps {
+                sh 'apt-get -y update && apt-get -y install git python-pip cloc && pip install platformio' 
+            }
+        }
+        stage('Build') {
+            steps {
+                sh 'pio run'
+            }
+            post {
+                always {
+                    archiveArtifacts '.pioenvs/nodemcu/firmware.bin, .pioenvs/nodemcu/firmware.elf'
+                }
+            }
+        }
+        stage('Coverage') {
+            steps {
+                sh 'cloc --by-file --xml --out=.test/cloc.xml src include'
+            }
+            post {
+                always {
+                    recordIssues(tools: [taskScanner(ignoreCase: true, includePattern: 'src/*.*', normalTags: 'TODO')])
+                    sloccountPublish encoding: '', pattern: '.test/cloc.xml'
+                }
+            }
+        }
+        stage('Upload') {
+            steps {
+                sh 'make otaupload'
+            }
+        }
+    }
+}

Makefile

@@ -2,8 +2,5 @@ build:
 	pio run
 
 otaupload: 
-	pip install -r .pio/libdeps/nodemcu/Homie/scripts/ota_updater/requirements.txt
+	pip install -r .piolibdeps/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
+	python .piolibdeps/Homie/scripts/ota_updater/ota_updater.py -l mqtt.jcktrue.dk -i 18fe34f2f987 .pioenvs/nodemcu/firmware.bin
-
-docs:
-	doxygen .\.doxygen

README.md

@@ -1,5 +1,4 @@
-[![Build Status](https://build.jcktrue.dk/api/badges/jct/deskcontrol/status.svg)](https://build.jcktrue.dk/jct/deskcontrol)
 # README #
-* edit data/homie/config.json
+edit data/homie/config.json
-* platformio run -t upload
+platformio run -t upload
-* platformio run -t uploadfs
+platformio run -t uploadfs

data/homie/config.example.json

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

include/config.h

@@ -1,36 +0,0 @@
-/**
- * \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,12 +1,27 @@
-[env]
+#
-platform = espressif8266
+# Project Configuration File
-framework = arduino
+#
+# A detailed documentation with the EXAMPLES is located here:
+# http://docs.platformio.org/en/latest/projectconf.html
+#
 
-upload_speed=921600
+# A sign `#` at the beginning of the line indicates a comment
+# Comment lines are ignored.
 
-build_flags = -DPIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY -DVERSION=${sysenv.DRONE_SEMVER}
+# Simple and base environment
-lib_deps = https://github.com/homieiot/homie-esp8266.git#develop, DHT sensor library for ESPx, HomieLoggerNode
+# [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
+lib_deps = https://github.com/homieiot/homie-esp8266.git#develop, Syslog

src/main.cpp

@@ -1,180 +1,116 @@
-/**
- * \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);
 
-#include <LoggerNode.h>
+const int PIN_RELAY = D1;
-LoggerNode LN; ///<Instance of the LoggerNode library
+int timer = 0;
-
+HomieNode powerNode("power", "switch");
-#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");
+bool powerOnHandler(const HomieRange& range, const String& value) {
-HomieNode temperatureNode("temperature", "Temperature", "temperature");
+    if (value != "true" && value != "false") return false;
-
+    bool on = (value == "true");
-/** Power state handler 
+    digitalWrite(PIN_RELAY, on ? LOW : HIGH);
- * Handles event on the power state MQTT node
+    powerNode.setProperty("on").send(value);
- * \param[in] range Currently unused
+    Homie.getLogger() << "Power is " << (on ? "on" : "off") << endl;
- * \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")
-    {
-      OUTPUT_SET(true);
-      LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power ON");
-    }
-    else
-    {
-      OUTPUT_SET(false); LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power OFF");
-    }
 
     return true;
 }
 
-/**
+void setupHandler() {
- * \brief powerTimer event handler.
+    pinMode(PIN_RELAY, OUTPUT);
- * Handler for events on the powerTimer node.
+    digitalWrite(PIN_RELAY, HIGH);
- * \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;
 
-    timer = millis() + (settimer * 1000 * 60);
+    powerNode.setProperty("on").send("false");
-    next_timer_update = millis() + 60*1000;
-    powerNode.setProperty("timer").send(String(settimer));
-    powerNode.setProperty("state").send("on");
-    LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power on for %d minutes", settimer);
-    OUTPUT_SET(true);
-    return true;
 }
 
-/**
+void onHomieEvent(const HomieEvent& event) {
- * setupHandler. Comply with Homie interface
+  switch(event.type) {
- */
+    case HomieEventType::STANDALONE_MODE:
-void setupHandler()
+      // Do whatever you want when standalone mode is started
-{
+      break;
-  pinMode(CONFIG_IO_RELAY, OUTPUT);
+    case HomieEventType::CONFIGURATION_MODE:
-  OUTPUT_SET(false);
+      // Do whatever you want when configuration mode is started
-  powerNode.setProperty("state").send("off");
+      break;
-  powerNode.setProperty("timer").send("0");
+    case HomieEventType::NORMAL_MODE:
+      // Do whatever you want when normal mode is started
+      break;
+    case HomieEventType::OTA_STARTED:
+      // Do whatever you want when OTA is started
+      break;
+    case HomieEventType::OTA_PROGRESS:
+      // Do whatever you want when OTA is in progress
 
-  dht.setup(CONFIG_IO_DHT11, DHTesp::DHT11); // Connect DHT sensor to GPIO 17
+      // You can use event.sizeDone and event.sizeTotal
-}
+      break;
+    case HomieEventType::OTA_FAILED:
+      // Do whatever you want when OTA is failed
+      break;
+    case HomieEventType::OTA_SUCCESSFUL:
+      // Do whatever you want when OTA is successful
+      break;
+    case HomieEventType::ABOUT_TO_RESET:
+      // Do whatever you want when the device is about to reset
+      break;
+    case HomieEventType::WIFI_CONNECTED:
+      // Do whatever you want when Wi-Fi is connected in normal mode
+      syslog.deviceHostname(Homie.getConfiguration().name);
+      syslog.appName("deskcontrol");
+      syslog.defaultPriority(LOG_ERR);
+      syslog.log(LOG_INFO, "WiFi Connected, software version: 1.0");
+      // You can use event.ip, event.gateway, event.mask
+      break;
+    case HomieEventType::WIFI_DISCONNECTED:
+      // Do whatever you want when Wi-Fi is disconnected in normal mode
 
-/**
+      // You can use event.wifiReason
- * Handle timer updates from the main event loop
+      break;
- */
+    case HomieEventType::MQTT_READY:
-void loopHandleTimer() 
+      // Do whatever you want when MQTT is connected in normal mode
-{
+      syslog.log(LOG_INFO, "MQTT connected");
-  if(timer)
+      break;
-  {
+    case HomieEventType::MQTT_DISCONNECTED:
-    if(timer < millis()) 
+      // Do whatever you want when MQTT is disconnected in normal mode
-    { //Timer has expired. (Ignore the wraparound...)
+      syslog.log(LOG_INFO, "MQTT disconnected");
-      timer = 0;
+      // You can use event.mqttReason
-      OUTPUT_SET(false);
+      break;
-      powerNode.setProperty("timer").send("0");
+    case HomieEventType::MQTT_PACKET_ACKNOWLEDGED:
-      powerNode.setProperty("state").send("off");
+      // Do whatever you want when an MQTT packet with QoS > 0 is acknowledged by the broker
-    }
 
-    if(next_timer_update && millis() > next_timer_update)
+      // You can use event.packetId
-    {
+      break;
-      next_timer_update = millis() + 60*1000;
+    case HomieEventType::READY_TO_SLEEP:
-      unsigned int time_remaining = timer - millis();
+      // After you've called `prepareToSleep()`, the event is triggered when MQTT is disconnected
-      unsigned int min_left = time_remaining / (60*1000);
+      break;
-      powerNode.setProperty("timer").send(String(min_left));
+    case HomieEventType::SENDING_STATISTICS:
-    }
+      // Do whatever you want when statistics are sent in normal mode
+      break;
   }
 }
 
-/**
+void setup() {
- * Handle periodic temperature measurements from the main event loop
+    syslog.server("192.168.1.100", 514);
- */
-void loopHandleTemperature() 
-{
-  static unsigned long lastTemperatureSent = 0;
-  if (millis() - lastTemperatureSent >= CONFIG_TEMPERATURE_SEND_INTERVAL * 1000UL || lastTemperatureSent == 0)
-  {
-    float humidity = dht.getHumidity();
-    float temperature = dht.getTemperature();
-    LN.logf(__PRETTY_FUNCTION__, LoggerNode::DEBUG, "Temperature: %f C Humidity: %f", temperature, humidity);
-    temperatureNode.setProperty("temperature").send(String(temperature));
-    temperatureNode.setProperty("humidity").send(String(humidity));
-    lastTemperatureSent = millis();
-  }
-}
     
-/**
- * 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()
-{
 
-    Homie_setFirmware("deskcontrol", VERSION);
+    Serial << endl << endl;
-    Homie.setLoggingPrinter(&Serial);
+    Serial << "Firmware 0.0.1" << endl;
-    Serial.begin(CONFIG_SERIAL_BAUDRATE);
+    Serial << endl << endl;
 
-    Homie.disableResetTrigger();
+    Homie_setFirmware("deskcontrol", "1.0.0");
+    Homie_setBrand("FuryFire");
 
-    //Power
+    powerNode.advertise("on").settable(powerOnHandler);
-    powerNode.advertise("state").settable(powerStateHandler);
-    powerNode.advertise("timer").settable(powerTimerHandler);
-
-    //Temperature
-    temperatureNode.advertise("humidity");
-    temperatureNode.advertise("temperature");
 
     Homie.setSetupFunction(setupHandler);
-    Homie.setLoopFunction(loopHandler);
+    Homie.onEvent(onHomieEvent); // before Homie.setup() 
-
     Homie.setup();
 }
 
-/**
+void loop() {
- * Arduino main loop. Forwarded to Homie framework
- */
-void loop()
-{
     Homie.loop();
 }