matt/Hotdog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move configuration to json

Browse Source
This commit is contained in:
Matt Way
2025-02-09 22:45:45 +11:00
parent 41af7b508f
commit b50edfa4aa
6 changed files with 74 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
config.example.json Normal file
View File

@@ -0,0 +1,9 @@
{
"shades": [
{
"radioId": "13AC",
"mqttId": "example_blind",
"friendly_name": "Example Blind"
}
]
}

82
lib/configurator/Configurator.cpp
View File

@@ -1,62 +1,68 @@
#include "Configurator.h"
#include <cctype>
#include <ArduinoJson.h>
Configurator::Configurator() {
// TODO: Should be using MQTT directly here (and methods for handling methods should be private)
}
std::string Configurator::extractKey(std::string topic) {
int startIndex = topic.find("/") + 1;
int endIndex = topic.find("/", startIndex);
// TODO: need to verify that startIndex and endIndex are valid before substr()
return topic.substr(startIndex, endIndex - startIndex);
}
void Configurator::processIdMessage(std::string topic, std::string payload) {
auto key = extractKey(topic);
if (payload.length() != 4) {
// Ignore payloads that aren't exactly 4 characters
return;
uint16_t Configurator::parseRadioId(const char* rawRadioId) {
if (!rawRadioId) {
return 0; // Or another appropriate error value/exception
}
uint16_t id = 0;
for (char c : payload) {
// Check if valid hex digit (0-9, A-F, a-f)
if (!std::isxdigit(c)) {
return; // Invalid character, not a hex digit
std::string radioId = std::string(rawRadioId);
if (radioId.size() != 4) {
return 0; // Invalid length
}
// Convert hex digit to numerical value (0-9, A-B=10-11, ...)
int digit = std::toupper(c) - (c <= '9' ? '0' : 'A' - 10);
for (char c : radioId) {
if (!std::isxdigit(c)) {
return 0; // Invalid character, not a hex digit
}
int digit = std::toupper(c) - (c <= '9' ? '0' : 'A' - 10);
id = (id << 4) | digit;
}
discoveredIds[key] = id;
tryBuild(key);
return id;
}
void Configurator::processFriendlyNameMessage(std::string topic, std::string friendlyName) {
auto key = extractKey(topic);
void Configurator::processJson(std::string json) {
JsonDocument doc;
discoveredFriendlyNames[key] = friendlyName;
tryBuild(key);
DeserializationError error = deserializeJson(doc, json);
if (error) {
return;
}
JsonArray shades = doc["shades"];
for (JsonObject shade : shades) {
const char* rawRadioId = shade["radioId"];
const char* mqttId = shade["mqttId"];
const char* friendlyName = shade["friendly_name"];
if (rawRadioId && mqttId && friendlyName && std::char_traits<char>::length(mqttId) > 0) {
uint16_t id = parseRadioId(rawRadioId);
if (id != 0) {
Shade s{id, mqttId, friendlyName, "stopped", -1, -1};
for (const auto& callback : shadeConfiguredCallbacks) {
callback(s);
}
}
}
else
{
// Invalid JSON - missing radioId, mqttId, or friendly_name"
}
}
}
void Configurator::addShadeConfiguredCallback(std::function<void (Shade)> callback) {
shadeConfiguredCallbacks.push_back(callback);
}
bool Configurator::tryBuild(std::string key) {
if (auto id = discoveredIds.find(key); id != discoveredIds.end()) {
if (auto friendlyName = discoveredFriendlyNames.find(key); friendlyName != discoveredFriendlyNames.end()) {
auto shade = Shade{id->second, key, friendlyName->second, "stopped", -1, -1};
for (size_t i = 0; i < shadeConfiguredCallbacks.size(); i++) {
shadeConfiguredCallbacks[i](shade);
}
return true;
}
}
return false;
}

8
lib/configurator/Configurator.h
View File

@@ -12,19 +12,15 @@ class Configurator
{
private:
std::vector<std::function<void (Shade)>> shadeConfiguredCallbacks;
std::map<std::string, uint16_t> discoveredIds;
std::map<std::string, std::string> discoveredFriendlyNames;
std::string extractKey(std::string topic);
bool tryBuild(std::string topic);
uint16_t parseRadioId(const char* rawRadioId);
public:
Configurator();
void addShadeConfiguredCallback(std::function<void (Shade)> callback);
void processIdMessage(std::string topic, std::string id);
void processFriendlyNameMessage(std::string topic, std::string friendlyName);
void processJson(std::string json);
};
#endif // CONFIGURATOR_H

1
src/.gitignore vendored
View File

@@ -1 +1,2 @@
secrets.h
config.h

3
src/main.cpp
View File

@@ -4,6 +4,7 @@
#include <RFPowerView.h>
#include <random>
#include <chrono>
#include "config.h"
#include "Shade.h"
#include "Configurator.h"
#include "ShadeRepository.h"
@@ -113,6 +114,8 @@ void setup() {
publishDiscoveryTopics();
});
configurator.processJson(config_json);
delay(100);
Serial.println("Ready");

87
test/test_configurator/test_configurator.cpp
View File

@@ -10,6 +10,11 @@ void tearDown()
{
}
std::string singleBlindJson = R"({"shades": [{"radioId": "ABCD","mqttId": "test_shade","friendly_name": "Test Shade"}]})";
std::string doubleBlindJson = R"({"shades": [{"radioId": "ABCD","mqttId": "test_shade","friendly_name": "Test Shade"}, {"radioId": "1234","mqttId": "test_shade2","friendly_name": "Test Shade 2"}]})";
std::string invalidRadioIdBlindJson = R"({"shades": [{"radioId": "XYZ9","mqttId": "test_shade","friendly_name": "Test Shade"}, {"mqttId": "test_shade","friendly_name": "Test Shade"}, {"radioId": "","mqttId": "test_shade","friendly_name": "Test Shade"}, {"radioId": "ABCDE","mqttId": "test_shade","friendly_name": "Test Shade"}]})";
std::string invalidMqttIdBlindJson = R"({"shades": [{"radioId": "ABCD","mqttId": "","friendly_name": "Test Shade"}, {"radioId": "ABCD","friendly_name": "Test Shade"}]})";
void test_shade_is_configured_with_id_and_friendly_name()
{
int callbackInvokedCount = 0;
@@ -23,71 +28,26 @@ void test_shade_is_configured_with_id_and_friendly_name()
TEST_ASSERT_EQUAL_STRING("test_shade", shade.key.c_str());
});
configurator.processIdMessage("hotdog/test_shade/id", "ABCD");
configurator.processFriendlyNameMessage("hotdog/test_shade/friendly_name", "Test Shade");
configurator.processJson(singleBlindJson);
TEST_ASSERT_EQUAL_INT(1, callbackInvokedCount);
}
void test_shade_is_configured_again_with_new_friendly_name()
void test_multiple_shades_are_configured()
{
int callbackInvokedCount = 0;
Configurator configurator = Configurator();
configurator.addShadeConfiguredCallback([&] (Shade shade) {
callbackInvokedCount++;
if (callbackInvokedCount == 1) {
TEST_ASSERT_EQUAL_STRING("Test Shade", shade.friendlyName.c_str());
} else if (callbackInvokedCount == 2) {
TEST_ASSERT_EQUAL_STRING("Updated Test Shade", shade.friendlyName.c_str());
} else {
TEST_ABORT();
}
TEST_ASSERT_EQUAL_HEX16(0xABCD, shade.ID);
TEST_ASSERT_EQUAL_STRING("test_shade", shade.key.c_str());
});
configurator.processIdMessage("hotdog/test_shade/id", "ABCD");
configurator.processFriendlyNameMessage("hotdog/test_shade/friendly_name", "Test Shade");
TEST_ASSERT_EQUAL_INT(1, callbackInvokedCount);
configurator.processFriendlyNameMessage("hotdog/test_shade/friendly_name", "Updated Test Shade");
configurator.processJson(doubleBlindJson);
TEST_ASSERT_EQUAL_INT(2, callbackInvokedCount);
}
void test_shade_is_configured_again_with_new_id()
{
int callbackInvokedCount = 0;
Configurator configurator = Configurator();
configurator.addShadeConfiguredCallback([&] (Shade shade) {
callbackInvokedCount++;
TEST_ASSERT_EQUAL_STRING("Test Shade", shade.friendlyName.c_str());
if (callbackInvokedCount == 1) {
TEST_ASSERT_EQUAL_HEX16(0xABCD, shade.ID);
} else if (callbackInvokedCount == 2) {
TEST_ASSERT_EQUAL_HEX16(0x9876, shade.ID);
} else {
TEST_ABORT();
}
TEST_ASSERT_EQUAL_STRING("test_shade", shade.key.c_str());
});
configurator.processIdMessage("hotdog/test_shade/id", "ABCD");
configurator.processFriendlyNameMessage("hotdog/test_shade/friendly_name", "Test Shade");
TEST_ASSERT_EQUAL_INT(1, callbackInvokedCount);
configurator.processIdMessage("hotdog/test_shade/id", "9876");
TEST_ASSERT_EQUAL_INT(2, callbackInvokedCount);
}
void test_shade_is_not_configured_without_friendly_name()
void test_invalid_radio_id_is_ignored()
{
int callbackInvokedCount = 0;
@@ -96,12 +56,12 @@ void test_shade_is_not_configured_without_friendly_name()
callbackInvokedCount++;
});
configurator.processIdMessage("hotdog/test_shade/id", "ABCD");
configurator.processJson(invalidRadioIdBlindJson);
TEST_ASSERT_EQUAL_INT(0, callbackInvokedCount);
}
void test_shade_is_not_configured_without_id()
void test_invalid_mqtt_id_is_ignored()
{
int callbackInvokedCount = 0;
@@ -110,22 +70,7 @@ void test_shade_is_not_configured_without_id()
callbackInvokedCount++;
});
configurator.processFriendlyNameMessage("hotdog/test_shade/friendly_name", "Test Shade");
TEST_ASSERT_EQUAL_INT(0, callbackInvokedCount);
}
void test_shade_is_not_configured_with_invalid_id()
{
int callbackInvokedCount = 0;
Configurator configurator = Configurator();
configurator.addShadeConfiguredCallback([&] (Shade shade) {
callbackInvokedCount++;
});
configurator.processIdMessage("hotdog/test_shade/id", "ZZZZ");
configurator.processFriendlyNameMessage("hotdog/test_shade/friendly_name", "Test Shade");
configurator.processJson(invalidMqttIdBlindJson);
TEST_ASSERT_EQUAL_INT(0, callbackInvokedCount);
}
@@ -134,11 +79,9 @@ int runUnityTests(void)
{
UNITY_BEGIN();
RUN_TEST(test_shade_is_configured_with_id_and_friendly_name);
RUN_TEST(test_shade_is_configured_again_with_new_friendly_name);
RUN_TEST(test_shade_is_configured_again_with_new_id);
RUN_TEST(test_shade_is_not_configured_without_friendly_name);
RUN_TEST(test_shade_is_not_configured_without_id);
RUN_TEST(test_shade_is_not_configured_with_invalid_id);
RUN_TEST(test_multiple_shades_are_configured);
RUN_TEST(test_invalid_radio_id_is_ignored);
RUN_TEST(test_invalid_mqtt_id_is_ignored);
return UNITY_END();
}