Skip to content

Commit

Permalink
refactor(aquamqtt): various improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
@tspopp
tspopp committed Dec 8, 2023
1 parent 9bd15f8 commit a76aec6
Show file tree
Hide file tree
Showing 17 changed files with 1,278 additions and 811 deletions.
6 changes: 4 additions & 2 deletions AquaMQTT/include/config/Configuration.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ constexpr char ntpServer[] = "pool.ntp.org";

constexpr EOperationMode OPERATION_MODE = EOperationMode::MITM;

constexpr uint8_t WATCHDOG_TIMEOUT_S = 5;
constexpr uint16_t MQTT_STATS_UPDATE_MS = 5000;
constexpr uint8_t WATCHDOG_TIMEOUT_S = 5;
constexpr uint16_t MQTT_STATS_UPDATE_MS = 5000;
constexpr uint8_t MQTT_MAX_TOPIC_SIZE = 50;
constexpr uint8_t MQTT_MAX_PAYLOAD_SIZE = 50;

// AquaMQTT Board Rev 1.0
constexpr uint8_t GPIO_MAIN_RX = 2;
Expand Down
273 changes: 57 additions & 216 deletions AquaMQTT/include/message/HMIMessage.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,245 +3,86 @@

#include <cstring>

#include "MessageConstants.h"

namespace aquamqtt
{
namespace message
{
enum HMIOperationMode : uint8_t
{
ABSENCE = 0,
ECO_ACTIVE = 1,
ECO_INACTIVE = 2,
BOOST = 3,
AUTO = 4
};

// 0 == Umluft
// 16 == 1 Kanal Luftanschluss
// 32 == 2 Kanal Luftamschluss
enum HMIAirDuctConfig : uint8_t
{
IN_IN = 0,
EXT_IN = 16,
EXT_EXT = 32
};

enum HMITestMode : uint8_t
{
OFF = 0,
ENTERED = 1,
HEAT_PUMP = 2,
HEAT_ELEMENT = 3,
FAN_LOW = 4,
FAN_HIGH = 5
};

class HMIMessage
{
public:
explicit HMIMessage(uint8_t* data) : mData(data)
{
}
explicit HMIMessage(uint8_t* data);

~HMIMessage() = default;

float waterTempTarget()
{
return (float) (((int16_t) mData[2] << 8) | mData[1]) / 10.0;
}

// TODO: sanity we should not allow more than 62°C
void setWaterTempTarget(float targetTemperature)
{
mData[1] = (int) targetTemperature * 10 & 0xFF;
mData[2] = ((int) targetTemperature * 10 >> 8) & 0xFF;
}

HMIOperationMode operationMode()
{
return HMIOperationMode(mData[3] & 0x0F);
}

void setOperationMode(HMIOperationMode operationMode)
{
mData[3] = (mData[3] & 0xF0) | (operationMode & 0x0F);
}

bool isTimerModeEnabled()
{
return mData[3] & 0x40;
}

void setTimerModeEnabled(boolean enabled)
{
mData[3] = (mData[3] & ~(1 << 6)) | (enabled << 6);
}
float waterTempTarget();

void setWaterTempTarget(float targetTemperature);

HMIOperationMode operationMode();

void setOperationMode(HMIOperationMode operationMode);

bool isTimerModeEnabled();

void setTimerModeEnabled(boolean enabled);

// TODO: sanity you cannot active emergency mode if heating element is disabled
bool isEmergencyModeEnabled()
{
return mData[6] & 0x01;
}
bool isEmergencyModeEnabled();

// TODO: you cannot disable heating elment if emergency mode is activated
bool isHeatingElementEnabled()
{
return mData[9] & 0x04;
}
bool isHeatingElementEnabled();

// TODO: implement
bool setupModeA()
{
// Fresh-Reset = 164 / 1010 0100? (nothing set)
return mData[9] & 0x80;
};
bool setupModeA();

// TODO: implement
bool setupModeB()
{
// Then 36 0010 0100 (umluftbetrieb set, rest missing
return mData[9] & 0x20;
}

uint8_t antiLegionellaModePerMonth()
{
return (uint8_t) (mData[5] & 0x0F);
};

// TODO: enum, naming
uint8_t airFlow()
{
// 0 == Umluft
// 16 == 1 Kanal Luftanschluss
// 32 == 2 Kanal Luftamschluss
return (uint8_t) (mData[5] & 0xF0);
};

// TODO: enum, naming
uint16_t installationOptions()
{

//| WT, WP-Only: 0000 0000,
// WP+Heizkessel-Prio-Wärmepumpe: 0000 0001,
// Wp+Heizkessel-Opt-Wärmepumpe: 17 / 0001 0001,
// Wp+Heizkelsse-Opt-Heizkessel: 33 / 0010 0001,
// Wp+Heizkessel-Prio-Heizkessel: 49 // 0011 0001,
// Wp+Solarthermie: 50 // 0011 0010|

return mData[17];
}

// TODO: enum, naming
uint16_t testMode()
{
// HMI Left TestMode = 0
// HMI Entered TestMode = 1
// WP TestMode Running = 2;
// Heating-Element = 3
// Fan TestMode Running (slow) = 4
// Fan TestMode Running (fast) = 5
// Defrost = 6,
return mData[22];
}
bool setupModeB();

uint8_t antiLegionellaModePerMonth();

HMIAirDuctConfig airDuctConfig();

HMIInstallation installationMode();

HMITestMode testMode();

// TODO: sanity, timer window cannot exceed 14 hours (both a and b)
// 1st range duration: 4 hours < time < 14 hours;
// Total duration of the 2 ranges: 8 hours minimum and 14 hours maximum.
// FIXME: do not return string
std::string timerWindowStr(bool firstWindow)
{
uint16_t start = firstWindow ? timerWindowAStart() : timerWindowBStart();
uint16_t duration = firstWindow ? timerWindowALength() : timerWindowBLength();

char beginStr[13];
const uint8_t beginHours = (start * 15) / 60;
const uint8_t beginMinutes = (start * 15) % 60;
const uint8_t lengthHours = (duration * 15) / 60;
const uint8_t lengthMinutes = (duration * 15) % 60;
const uint8_t endMinutes = (beginMinutes + lengthMinutes) % 60;
const uint8_t hourOverlap = (beginMinutes + lengthMinutes) / 60;
const uint8_t endHours = (beginHours + lengthHours) % 24 + hourOverlap;
sprintf(beginStr, "%02d:%02d-%02d:%02d", beginHours, beginMinutes, endHours, endMinutes);
return beginStr;
}

uint16_t timerWindowAStart()
{
return mData[10];
};

uint16_t timerWindowALength()
{
return mData[11];
};

uint16_t timerWindowBStart()
{
return mData[12];
};

uint16_t timerWindowBLength()
{
return mData[13];
};

uint8_t timeHours()
{
return mData[21];
}

void setTimeHours(uint8_t hour)
{
mData[21] = hour;
}

uint8_t timeMinutes()
{
return mData[20];
}

void setTimeMinutes(uint8_t minute)
{
mData[20] = minute;
}

uint8_t timeSeconds()
{
return mData[17];
}

void setTimeSeconds(uint8_t second)
{
mData[17] = second;
}

uint16_t dateYear()
{
return 2000 + (mData[19] / 2);
}

void setDateMonthAndYear(uint8_t month, uint16_t year)
{
int pastJuly = month > 7 ? 1 : 0;
mData[19] = ((year - 2000) * 2) + pastJuly;
int monthValue = (pastJuly ? month - 8 : month) << 5;
mData[18] = (mData[18] & 0x1F) | (monthValue & 0xE0);
}

uint8_t dateMonth()
{
return (mData[18] >> 5) + ((mData[19] % 2) * 8);
}

uint8_t dateDay()
{
return mData[18] & 0x1F;
}

void setDateDay(uint8_t day)
{
mData[18] = (mData[18] & 0xE0) | (day & 0x1F);
};
std::string timerWindowStr(bool firstWindow);

uint16_t timerWindowAStart();

uint16_t timerWindowALength();

uint16_t timerWindowBStart();

uint16_t timerWindowBLength();

uint8_t timeHours();

void setTimeHours(uint8_t hour);

uint8_t timeMinutes();

void setTimeMinutes(uint8_t minute);

uint8_t timeSeconds();

void setTimeSeconds(uint8_t second);

uint16_t dateYear();

void setDateMonthAndYear(uint8_t month, uint16_t year);

uint8_t dateMonth();

uint8_t dateDay();

void setDateDay(uint8_t day);

private:
uint8_t* mData;
Expand Down
40 changes: 7 additions & 33 deletions AquaMQTT/include/message/MainEnergyMessage.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,45 +16,19 @@ class MainEnergyMessage

~MainEnergyMessage() = default;

uint32_t totalHeatpumpHours()
{
return ((uint32_t) mData[14] << 24) | ((uint32_t) mData[13] << 16) | ((uint32_t) mData[12] << 8)
| (uint32_t) mData[11];
}
uint32_t totalHeatpumpHours();

uint32_t totalHeatingElemHours()
{
return ((uint32_t) mData[18] << 24) | ((uint32_t) mData[17] << 16) | ((uint32_t) mData[16] << 8)
| (uint32_t) mData[15];
}
uint32_t totalHeatingElemHours();

uint32_t totalHours()
{
return ((uint32_t) mData[22] << 24) | ((uint32_t) mData[21] << 16) | ((uint32_t) mData[20] << 8)
| (uint32_t) mData[19];
}
uint32_t totalHours();

uint64_t totalEnergyCounter()
{
return ((uint64_t) mData[30] << 56) | ((uint64_t) mData[29] << 48) | ((uint64_t) mData[28] << 40)
| ((uint64_t) mData[27] << 32) | ((uint64_t) mData[26] << 24) | ((uint64_t) mData[25] << 16)
| ((uint64_t) mData[24] << 8) | (uint64_t) mData[23];
}
uint64_t totalEnergyCounter();

uint16_t powerHeatpump()
{
return ((uint16_t) mData[2] << 8) | (uint16_t) mData[1];
}
uint16_t powerHeatpump();

uint16_t powerHeatElement()
{
return ((uint16_t) mData[4] << 8) | (uint16_t) mData[3];
}
uint16_t powerHeatElement();

uint16_t powerOverall()
{
return ((uint16_t) mData[8] << 8) | (uint16_t) mData[7];
}
uint16_t powerOverall();

private:
uint8_t* mData;
Expand Down
Loading

0 comments on commit a76aec6

Please sign in to comment.