Added methods to calculate and show sunrise and sunset times

include/SunPosition.h

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+#pragma once
+
+#include <sunset.h>
+
+#define SUNPOS_UPDATE_INTERVAL 60000l
+
+class SunPositionClass {
+public:
+    SunPositionClass();
+    void init();
+    void loop();
+
+    bool isDayPeriod();
+    bool sunsetTime(struct tm* info);
+    bool sunriseTime(struct tm* info);
+
+private:
+    void updateSunData();
+
+    SunSet _sun;
+    bool _isDayPeriod = true;
+    uint _sunriseMinutes = 0;
+    uint _sunsetMinutes = 0;
+
+    uint32_t _lastUpdate = 0;
+    bool _isValidInfo = false;
+};
+
+extern SunPositionClass SunPosition;

include/Utils.h

@@ -7,4 +7,5 @@ class Utils {
 public:
     static uint32_t getChipId();
     static uint64_t generateDtuSerial();
+    static int getTimezoneOffset();
 };

platformio.ini

@@ -27,6 +27,7 @@ lib_deps =
     https://github.com/bertmelis/espMqttClient.git#v1.3.3
     nrf24/RF24 @ ^1.4.5
     olikraus/U8g2 @ ^2.34.13
+    buelowp/sunset @ ^1.1.3
 
 extra_scripts =
     pre:auto_firmware_version.py

src/SunPosition.cpp

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright (C) 2023 Thomas Basler and others
+ */
+#include "SunPosition.h"
+#include "Configuration.h"
+#include "Utils.h"
+
+SunPositionClass SunPosition;
+
+SunPositionClass::SunPositionClass()
+{
+}
+
+void SunPositionClass::init()
+{
+}
+
+void SunPositionClass::loop()
+{
+    if (millis() - _lastUpdate > SUNPOS_UPDATE_INTERVAL) {
+        updateSunData();
+        _lastUpdate = millis();
+    }
+}
+
+bool SunPositionClass::isDayPeriod()
+{
+    return _isDayPeriod;
+}
+
+void SunPositionClass::updateSunData()
+{
+    CONFIG_T const& config = Configuration.get();
+    int offset = Utils::getTimezoneOffset() / 3600;
+    _sun.setPosition(config.Ntp_Latitude, config.Ntp_Longitude, offset);
+
+    struct tm timeinfo;
+    if (!getLocalTime(&timeinfo, 5)) {
+        _isDayPeriod = false;
+        _sunriseMinutes = 0;
+        _sunsetMinutes = 0;
+        _isValidInfo = false;
+        return;
+    }
+
+    _sun.setCurrentDate(1900 + timeinfo.tm_year, timeinfo.tm_mon + 1, timeinfo.tm_mday);
+    _sunriseMinutes = (int)_sun.calcCustomSunrise(SunSet::SUNSET_NAUTICAL);
+    _sunsetMinutes = (int)_sun.calcCustomSunset(SunSet::SUNSET_NAUTICAL);
+    uint minutesPastMidnight = timeinfo.tm_hour * 60 + timeinfo.tm_min;
+
+    _isDayPeriod = (minutesPastMidnight >= _sunriseMinutes) && (minutesPastMidnight < _sunsetMinutes);
+    _isValidInfo = true;
+}
+
+bool SunPositionClass::sunsetTime(struct tm* info)
+{
+    // Get today's date
+    time_t aTime = time(NULL);
+
+    // Set the time to midnight
+    struct tm* tm = localtime(&aTime);
+    tm->tm_sec = 0;
+    tm->tm_min = _sunsetMinutes;
+    tm->tm_hour = 0;
+    tm->tm_isdst = -1;
+    time_t midnight = mktime(tm);
+
+    localtime_r(&midnight, info);
+    return _isValidInfo;
+}
+
+bool SunPositionClass::sunriseTime(struct tm* info)
+{
+    // Get today's date
+    time_t aTime = time(NULL);
+
+    // Set the time to midnight
+    struct tm* tm = localtime(&aTime);
+    tm->tm_sec = 0;
+    tm->tm_min = _sunriseMinutes;
+    tm->tm_hour = 0;
+    tm->tm_isdst = -1;
+    time_t midnight = mktime(tm);
+
+    localtime_r(&midnight, info);
+    return _isValidInfo;
+}

src/Utils.cpp

@@ -35,4 +35,21 @@ uint64_t Utils::generateDtuSerial()
     }
 
     return dtuId;
+}
+
+int Utils::getTimezoneOffset()
+{
+    // see: https://stackoverflow.com/questions/13804095/get-the-time-zone-gmt-offset-in-c/44063597#44063597
+
+    time_t gmt, rawtime = time(NULL);
+    struct tm* ptm;
+
+    struct tm gbuf;
+    ptm = gmtime_r(&rawtime, &gbuf);
+
+    // Request that mktime() looksup dst in timezone database
+    ptm->tm_isdst = -1;
+    gmt = mktime(ptm);
+
+    return static_cast<int>(difftime(rawtime, gmt));
 }

src/WebApi_ntp.cpp

@@ -5,6 +5,7 @@
 #include "WebApi_ntp.h"
 #include "Configuration.h"
 #include "NtpSettings.h"
+#include "SunPosition.h"
 #include "WebApi.h"
 #include "WebApi_errors.h"
 #include "helper.h"
@@ -51,6 +52,16 @@ void WebApiNtpClass::onNtpStatus(AsyncWebServerRequest* request)
     strftime(timeStringBuff, sizeof(timeStringBuff), "%A, %B %d %Y %H:%M:%S", &timeinfo);
     root[F("ntp_localtime")] = timeStringBuff;
 
+    SunPosition.sunriseTime(&timeinfo);
+    strftime(timeStringBuff, sizeof(timeStringBuff), "%A, %B %d %Y %H:%M:%S", &timeinfo);
+    root[F("sun_risetime")] = timeStringBuff;
+
+    SunPosition.sunsetTime(&timeinfo);
+    strftime(timeStringBuff, sizeof(timeStringBuff), "%A, %B %d %Y %H:%M:%S", &timeinfo);
+    root[F("sun_settime")] = timeStringBuff;
+
+    root[F("sun_isDayPeriod")] = SunPosition.isDayPeriod();
+
     response->setLength();
     request->send(response);
 }

src/main.cpp

@@ -12,6 +12,7 @@
 #include "NetworkSettings.h"
 #include "NtpSettings.h"
 #include "PinMapping.h"
+#include "SunPosition.h"
 #include "Utils.h"
 #include "WebApi.h"
 #include "defaults.h"
@@ -80,6 +81,11 @@ void setup()
     NtpSettings.init();
     MessageOutput.println(F("done"));
 
+    // Initialize SunPosition
+    MessageOutput.print(F("Initialize SunPosition... "));
+    SunPosition.init();
+    MessageOutput.println(F("done"));
+
     // Initialize MqTT
     MessageOutput.print(F("Initialize MqTT... "));
     MqttSettings.init();
@@ -178,6 +184,8 @@ void loop()
     yield();
     Display.loop();
     yield();
+    SunPosition.loop();
+    yield();
     MessageOutput.loop();
     yield();
 }

webapp/src/locales/de.json

@@ -228,7 +228,12 @@
         "Status": "Status",
         "Synced": "synchronisiert",
         "NotSynced": "nicht synchronisiert",
-        "LocalTime": "Lokale Uhrzeit"
+        "LocalTime": "Lokale Uhrzeit",
+        "Sunrise": "Nautische Morgendämmerung",
+        "Sunset": "Nautische Abenddämmerung",
+        "Mode": "Modus",
+        "Day": "Tag",
+        "Night": "Nacht"
     },
     "mqttinfo": {
         "MqttInformation": "MQTT Informationen",

webapp/src/locales/en.json

@@ -228,7 +228,12 @@
         "Status": "Status",
         "Synced": "synced",
         "NotSynced": "not synced",
-        "LocalTime": "Local Time"
+        "LocalTime": "Local Time",
+        "Sunrise": "Nautical Sunrise",
+        "Sunset": "Nautical Sunset",
+        "Mode": "Mode",
+        "Day": "Day",
+        "Night": "Night"
     },
     "mqttinfo": {
         "MqttInformation": "MQTT Information",

webapp/src/locales/fr.json

@@ -228,7 +228,12 @@
         "Status": "Statut",
         "Synced": "synchronisée",
         "NotSynced": "pas synchronisée",
-        "LocalTime": "Heure locale"
+        "LocalTime": "Heure locale",
+        "Sunrise": "Nautical Sunrise",
+        "Sunset": "Nautical Sunset",
+        "Mode": "Mode",
+        "Day": "Day",
+        "Night": "Night"
     },
     "mqttinfo": {
         "MqttInformation": "MQTT Information",

webapp/src/types/NtpStatus.ts

@@ -4,4 +4,7 @@ export interface NtpStatus {
     ntp_timezone_descr: string
     ntp_status: boolean;
     ntp_localtime: string;
+    sun_risetime: string;
+    sun_settime: string;
+    sun_isDayPeriod: boolean;
 }

webapp/src/views/NtpInfoView.vue

@@ -39,6 +39,25 @@
                             <th>{{ $t('ntpinfo.LocalTime') }}</th>
                             <td>{{ ntpDataList.ntp_localtime }}</td>
                         </tr>
+
+                        <tr>
+                            <th>{{ $t('ntpinfo.Sunrise') }}</th>
+                            <td>{{ ntpDataList.sun_risetime }}</td>
+                        </tr>
+                        <tr>
+                            <th>{{ $t('ntpinfo.Sunset') }}</th>
+                            <td>{{ ntpDataList.sun_settime }}</td>
+                        </tr>
+                        <tr>
+                            <th>{{ $t('ntpinfo.Mode') }}</th>
+                            <td class="badge" :class="{
+                                'text-bg-dark': !ntpDataList.sun_isDayPeriod,
+                                'text-bg-warning': ntpDataList.sun_isDayPeriod,
+                            }">
+                                <span v-if="ntpDataList.sun_isDayPeriod">{{ $t('ntpinfo.Day') }}</span>
+                                <span v-else>{{ $t('ntpinfo.Night') }}</span>
+                            </td>
+                        </tr>
                     </tbody>
                 </table>
             </div>