Compare commits

..

No commits in common. "master" and "v0.4.3" have entirely different histories.

8 changed files with 41 additions and 2726 deletions

@ -6,6 +6,7 @@ steps:
image: python:3 image: python:3
commands: commands:
- pip install platformio - pip install platformio
- pio check
- pio run - pio run
- name: upload - name: upload
image: python:3 image: python:3
@ -21,12 +22,5 @@ steps:
base_url: https://code.jcktrue.dk base_url: https://code.jcktrue.dk
files: files:
- .pio/build/nodemcu/firmware.bin - .pio/build/nodemcu/firmware.bin
checksum:
- md5
- sha1
- sha256
- sha512
- adler32
- crc32
when: when:
event: tag event: tag

5
.gitignore vendored

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

2608
Doxyfile

File diff suppressed because it is too large Load Diff

@ -4,6 +4,3 @@ build:
otaupload: otaupload:
pip install -r .pio/libdeps/nodemcu/Homie/scripts/ota_updater/requirements.txt 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 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

@ -1,36 +1,11 @@
/**
* \file
* \class Config
*/
#ifndef CONFIG_H #ifndef CONFIG_H
#define 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 #define CONFIG_SERIAL_BAUDRATE 115200
/**
* Pin ID of the output relay
*/
#define CONFIG_IO_RELAY D1 #define CONFIG_IO_RELAY D1
/**
* Pin ID of the DHT11 temperature sensor
*/
#define CONFIG_IO_DHT11 D2 #define CONFIG_IO_DHT11 D2
/**
* Interval at which the tempreature is sent in seconds
*/
#define CONFIG_TEMPERATURE_SEND_INTERVAL 60 #define CONFIG_TEMPERATURE_SEND_INTERVAL 60
#endif #endif

@ -1,11 +1,30 @@
#
# 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] [env]
platform = espressif8266 platform = espressif8266
framework = arduino framework = arduino
upload_speed=921600 upload_speed=921600
build_flags = -DPIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY -DVERSION=${sysenv.DRONE_SEMVER} build_flags = -D PIO_FRAMEWORK_ARDUINO_LWIP2_LOW_MEMORY
lib_deps = https://github.com/homieiot/homie-esp8266.git#develop, DHT sensor library for ESPx, HomieLoggerNode lib_deps = https://github.com/homieiot/homie-esp8266.git#develop-v3, DHT sensor library for ESPx
[env:nodemcu] [env:nodemcu]
board = nodemcu board = nodemcu

@ -1,68 +1,37 @@
/**
* \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 "config.h"
#include <Homie.h> #include <Homie.h>
#include <LoggerNode.h>
LoggerNode LN; ///<Instance of the LoggerNode library
#include "DHTesp.h" #include "DHTesp.h"
DHTesp dht; ///< Instance of the DHT temperature controller. DHTesp dht;
#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
#define OUTPUT_SET(x) digitalWrite(CONFIG_IO_RELAY, x ? LOW : HIGH)
unsigned int timer = 0;
unsigned int next_timer_update = 0;
HomieNode powerNode("power", "Power", "switch"); HomieNode powerNode("power", "Power", "switch");
HomieNode temperatureNode("temperature", "Temperature", "temperature"); HomieNode temperatureNode("temperature", "Temperature", "temperature");
/** Power state handler
* 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) bool powerStateHandler(const HomieRange& range, const String& value)
{ {
if (value != "on" && value != "off") if (value != "on" && value != "off") return false;
{
return false;
}
powerNode.setProperty("state").send(value); powerNode.setProperty("state").send(value);
powerNode.setProperty("timer").send("0"); powerNode.setProperty("timer").send("0");
timer = 0; timer = 0;
if(value == "on") if(value == "on")
{ {
OUTPUT_SET(true); OUTPUT_SET(true);
LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power ON"); Homie.getLogger() << "Power is on" << endl;
} }
else else
{ {
OUTPUT_SET(false); LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power OFF"); OUTPUT_SET(false);
Homie.getLogger() << "Power is off" << endl;
} }
return true; return true;
} }
/**
* \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) bool powerTimerHandler(const HomieRange& range, const String& value)
{ {
int settimer = value.toInt(); int settimer = value.toInt();
@ -73,14 +42,12 @@ bool powerTimerHandler(const HomieRange& range, const String& value)
next_timer_update = millis() + 60*1000; next_timer_update = millis() + 60*1000;
powerNode.setProperty("timer").send(String(settimer)); powerNode.setProperty("timer").send(String(settimer));
powerNode.setProperty("state").send("on"); powerNode.setProperty("state").send("on");
LN.logf(__PRETTY_FUNCTION__, LoggerNode::INFO, "Power on for %d minutes", settimer); Homie.getLogger() << "Power is on for " << settimer << "minutes" << endl;
OUTPUT_SET(true); OUTPUT_SET(true);
return true; return true;
} }
/**
* setupHandler. Comply with Homie interface
*/
void setupHandler() void setupHandler()
{ {
pinMode(CONFIG_IO_RELAY, OUTPUT); pinMode(CONFIG_IO_RELAY, OUTPUT);
@ -91,10 +58,7 @@ void setupHandler()
dht.setup(CONFIG_IO_DHT11, DHTesp::DHT11); // Connect DHT sensor to GPIO 17 dht.setup(CONFIG_IO_DHT11, DHTesp::DHT11); // Connect DHT sensor to GPIO 17
} }
/** void loopHandler()
* Handle timer updates from the main event loop
*/
void loopHandleTimer()
{ {
if(timer) if(timer)
{ {
@ -114,54 +78,30 @@ void loopHandleTimer()
powerNode.setProperty("timer").send(String(min_left)); powerNode.setProperty("timer").send(String(min_left));
} }
} }
}
/**
* Handle periodic temperature measurements from the main event loop
*/
void loopHandleTemperature()
{
static unsigned long lastTemperatureSent = 0; static unsigned long lastTemperatureSent = 0;
if (millis() - lastTemperatureSent >= CONFIG_TEMPERATURE_SEND_INTERVAL * 1000UL || lastTemperatureSent == 0) if (millis() - lastTemperatureSent >= CONFIG_TEMPERATURE_SEND_INTERVAL * 1000UL || lastTemperatureSent == 0)
{ {
float humidity = dht.getHumidity(); float humidity = dht.getHumidity();
float temperature = dht.getTemperature(); float temperature = dht.getTemperature();
LN.logf(__PRETTY_FUNCTION__, LoggerNode::DEBUG, "Temperature: %f C Humidity: %f", temperature, humidity);
Homie.getLogger() << "Temperature: " << temperature << "°C " << humidity << "% Humidty" << endl;
temperatureNode.setProperty("temperature").send(String(temperature)); temperatureNode.setProperty("temperature").send(String(temperature));
temperatureNode.setProperty("humidity").send(String(humidity)); temperatureNode.setProperty("humidity").send(String(humidity));
lastTemperatureSent = millis(); lastTemperatureSent = millis();
} }
} }
/**
* Main event loop. Part of the Homie API. This runs while the device is active and connected.
*
* \callgraph
*/
void loopHandler()
{
loopHandleTimer();
loopHandleTemperature();
}
/**
* Arduino style setup() routine.
* Configure the Homie framework by adding the two nodes "power" and "temperature"
*/
void setup() void setup()
{ {
Homie_setFirmware("deskcontrol", VERSION);
Homie.setLoggingPrinter(&Serial);
Serial.begin(CONFIG_SERIAL_BAUDRATE); Serial.begin(CONFIG_SERIAL_BAUDRATE);
Homie_setFirmware("deskcontrol", "0.4.2");
Homie.disableResetTrigger(); Homie.disableResetTrigger();
//Power
powerNode.advertise("state").settable(powerStateHandler); powerNode.advertise("state").settable(powerStateHandler);
powerNode.advertise("timer").settable(powerTimerHandler); powerNode.advertise("timer").settable(powerTimerHandler);
//Temperature
temperatureNode.advertise("humidity"); temperatureNode.advertise("humidity");
temperatureNode.advertise("temperature"); temperatureNode.advertise("temperature");
@ -171,9 +111,6 @@ void setup()
Homie.setup(); Homie.setup();
} }
/**
* Arduino main loop. Forwarded to Homie framework
*/
void loop() void loop()
{ {
Homie.loop(); Homie.loop();