From 82e453f8bacc4ab0c994a650cda1aeadc4eac24c Mon Sep 17 00:00:00 2001 From: jens Date: Wed, 17 Dec 2025 18:16:00 +0100 Subject: [PATCH] Initial commit --- .gitignore | 5 + .vscode/extensions.json | 10 ++ include/README | 37 ++++++++ lib/README | 46 +++++++++ platformio.ini | 19 ++++ src/main.cpp | 190 +++++++++++++++++++++++++++++++++++++ src/otterpy.code-workspace | 12 +++ test/README | 11 +++ 8 files changed, 330 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/main.cpp create mode 100644 src/otterpy.code-workspace create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/include/README b/include/README new file mode 100644 index 0000000..49819c0 --- /dev/null +++ b/include/README @@ -0,0 +1,37 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the convention is to give header files names that end with `.h'. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..9379397 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into the executable file. + +The source code of each library should be placed in a separate directory +("lib/your_library_name/[Code]"). + +For example, see the structure of the following example libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +Example contents of `src/main.c` using Foo and Bar: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +The PlatformIO Library Dependency Finder will find automatically dependent +libraries by scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..5e86e1b --- /dev/null +++ b/platformio.ini @@ -0,0 +1,19 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:d1_mini] +platform = espressif8266 +board = d1_mini +framework = arduino +lib_deps = + bblanchon/ArduinoJson @ 6.21.3 + pubsubclient @ 2.8 + arduino-libraries/NTPClient@^3.2.1 +monitor_speed = 115200 \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..6f784bc --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,190 @@ +#include +#include +#include +#include +#include +#include + +// Hardware Configuration +#define REED_PIN D3 // GPIO0 (mit internem Pullup) +const float PULSES_PER_M3 = 100.0; // Anpassen an Ihren Gaszähler + +// Network Credentials +const char* SSID = "pipanet"; +const char* PASS = "passatvr6"; + +// MQTT Configuration +const char* MQTT_SERVER = "192.168.2.173"; +const char* STATE_TOPIC = "homeassistant/sensor/gas_meter/state"; +const char* COMMAND_TOPIC = "homeassistant/sensor/gas_meter/set"; +const char* CONFIG_TOPIC = "homeassistant/sensor/gas_meter/config"; +const char* AVAILABILITY_TOPIC = "homeassistant/sensor/gas_meter/status"; + +// Global Variables +volatile unsigned long totalPulses = 0; +volatile unsigned long dailyPulses = 0; +volatile bool reedState = false; +volatile unsigned long lastDebounce = 0; +const unsigned long DEBOUNCE_MS = 50; + +// Objects +WiFiUDP ntpUDP; +NTPClient timeClient(ntpUDP, "pool.ntp.org"); +WiFiClient wifiClient; +PubSubClient mqtt(wifiClient); + +void saveData() { + EEPROM.put(0, totalPulses); + EEPROM.put(sizeof(totalPulses), dailyPulses); + EEPROM.commit(); +} + +void loadData() { + EEPROM.begin(64); + EEPROM.get(0, totalPulses); + EEPROM.get(sizeof(totalPulses), dailyPulses); +} + +void ICACHE_RAM_ATTR handleInterrupt() { + if (millis() - lastDebounce > DEBOUNCE_MS) { + bool currentState = digitalRead(REED_PIN); + if (currentState != reedState) { + if (currentState == LOW) { + totalPulses++; + dailyPulses++; + saveData(); + } + reedState = currentState; + lastDebounce = millis(); + } + } +} + +void sendConfig() { + StaticJsonDocument<256> doc; + doc["name"] = "Gas Meter"; + doc["dev_cla"] = "gas"; + doc["stat_t"] = STATE_TOPIC; + doc["cmd_t"] = COMMAND_TOPIC; + doc["unit_of_meas"] = "m³"; + doc["stat_cla"] = "total_increasing"; + doc["val_tpl"] = "{{ value_json.total_m3 }}"; + doc["avty_t"] = AVAILABILITY_TOPIC; + doc["pl_avail"] = "online"; + doc["pl_not_avail"] = "offline"; + doc["uniq_id"] = "gas_meter_" + String(ESP.getChipId(), HEX); + + char config[256]; + serializeJson(doc, config); + mqtt.publish(CONFIG_TOPIC, config, true); +} + +void sendData() { + StaticJsonDocument<200> doc; + doc["total_m3"] = totalPulses / PULSES_PER_M3; + doc["daily_m3"] = dailyPulses / PULSES_PER_M3; + doc["total_pulses"] = totalPulses; + doc["timestamp"] = timeClient.getFormattedTime(); + + char output[200]; + serializeJson(doc, output); + mqtt.publish(STATE_TOPIC, output, true); + + Serial.printf("Sent: Total=%.1fm³, Daily=%.1fm³, Pulses=%lu\n", + totalPulses/PULSES_PER_M3, + dailyPulses/PULSES_PER_M3, + totalPulses); +} + +void mqttCallback(char* topic, byte* payload, unsigned int length) { + String message; + for (unsigned int i = 0; i < length; i++) { + message += (char)payload[i]; + } + + if (String(topic) == COMMAND_TOPIC) { + if (message == "reset_total") { + totalPulses = 0; + } else if (message == "reset_daily") { + dailyPulses = 0; + } + saveData(); + Serial.println("Counter reset via MQTT"); + } +} + +void reconnectMQTT() { + static unsigned long lastAttempt = 0; + if (!mqtt.connected() && millis() - lastAttempt > 5000) { + Serial.println("Attempting MQTT connection..."); + if (mqtt.connect("GasMeter", AVAILABILITY_TOPIC, 1, true, "offline")) { + mqtt.publish(AVAILABILITY_TOPIC, "online", true); + mqtt.subscribe(COMMAND_TOPIC); + sendConfig(); + Serial.println("MQTT connected!"); + } else { + Serial.println("MQTT connection failed"); + } + lastAttempt = millis(); + } +} + +void checkDailyReset() { + static int lastDay = -1; + timeClient.update(); + int currentDay = timeClient.getDay(); + + if (lastDay != -1 && currentDay != lastDay) { + dailyPulses = 0; + saveData(); + Serial.println("Daily counter reset"); + } + lastDay = currentDay; +} + +void setup() { + Serial.begin(115200); + Serial.println("\nBooting Gas Meter..."); + + // Load Data + EEPROM.begin(64); + loadData(); + + // Reed Switch + pinMode(REED_PIN, INPUT_PULLUP); + attachInterrupt(digitalPinToInterrupt(REED_PIN), handleInterrupt, CHANGE); + + // WiFi + WiFi.begin(SSID, PASS); + while (WiFi.status() != WL_CONNECTED) { + delay(500); + Serial.print("."); + } + Serial.println("\nWiFi connected"); + + // NTP + timeClient.begin(); + timeClient.update(); + + // MQTT + mqtt.setServer(MQTT_SERVER, 1883); + mqtt.setCallback(mqttCallback); +} + +void loop() { + static unsigned long lastSend = 0; + + timeClient.update(); + mqtt.loop(); + reconnectMQTT(); + checkDailyReset(); + + if (millis() - lastSend >= 30000) { + if (mqtt.connected()) { + sendData(); + } + lastSend = millis(); + } + + delay(10); +} \ No newline at end of file diff --git a/src/otterpy.code-workspace b/src/otterpy.code-workspace new file mode 100644 index 0000000..34a1703 --- /dev/null +++ b/src/otterpy.code-workspace @@ -0,0 +1,12 @@ +{ + "folders": [ + { + "path": "../../../../docker/otterpy" + }, + { + "name": "KY25_ESP8266", + "path": ".." + } + ], + "settings": {} +} \ No newline at end of file diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html