Feature: show hint if device profile missing or not selected

tbnobody · Dec 14, 2024 · 58382be · 58382be
1 parent 2edec64
commit 58382be
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 5 deletions.
diff --git a/include/PinMapping.h b/include/PinMapping.h
@@ -59,6 +59,8 @@ class PinMappingClass {
     bool init(const String& deviceMapping);
     PinMapping_t& get();
 
+    bool isMappingSelected() const { return _mappingSelected; }
+
     bool isValidNrf24Config() const;
     bool isValidCmt2300Config() const;
     bool isValidW5500Config() const;
@@ -68,6 +70,8 @@ class PinMappingClass {
 
 private:
     PinMapping_t _pinMapping;
+
+    bool _mappingSelected = false;
 };
 
 extern PinMappingClass PinMapping;
diff --git a/lang/es.lang.json b/lang/es.lang.json
@@ -637,7 +637,8 @@
             "TimeSync": "El reloj aún no ha sido sincronizado. Sin un reloj correctamente ajustado, no se realizan solicitudes al inversor. Esto es normal poco después del inicio. Sin embargo, después de un tiempo de ejecución más largo (>1 minuto), indica que el servidor NTP no es accesible.",
             "TimeSyncLink": "Por favor, verifica la configuración de tu hora.",
             "DefaultPassword": "Estás utilizando la contraseña predeterminada para la interfaz web y el punto de acceso de emergencia. Esto potencialmente es inseguro.",
-            "DefaultPasswordLink": "Por favor, cambia la contraseña."
+            "DefaultPasswordLink": "Por favor, cambia la contraseña.",
+            "PinMappingIssue": "You are using a generic firmware image, but have not yet uploaded a file with device profiles (<code>pin_mapping.json</code>) or have not selected a profile defined there. Please refer to the <a href=\"https://opendtu.solar/firmware/device_profiles/\" target=\"_blank\" class=\"alert-link\">documentation</a> for details."
         },
         "deviceadmin": {
             "DeviceManager": "Administrador de Dispositivos",

diff --git a/lang/it.lang.json b/lang/it.lang.json
@@ -637,7 +637,8 @@
             "TimeSync": "La Data/Ora non sono state sincronizzate, ed in tal caso non è possibile eseguire richieste all'inverter. Questa condizione è normale appena avviato, tuttavia dopo un po' (>1 minuto), questa situazione potrebbe indicare un problema di accesso al server NTP.",
             "TimeSyncLink": "Controlla le impostazioni Data/Ora.",
             "DefaultPassword": "Stai usando la password di default per accedere all'interfaccia web e per la modalità Access Point di emergenza. Questo può portare ad un rischio di sicurezza.",
-            "DefaultPasswordLink": "Per favore cambia la password."
+            "DefaultPasswordLink": "Per favore cambia la password.",
+            "PinMappingIssue": "You are using a generic firmware image, but have not yet uploaded a file with device profiles (<code>pin_mapping.json</code>) or have not selected a profile defined there. Please refer to the <a href=\"https://opendtu.solar/firmware/device_profiles/\" target=\"_blank\" class=\"alert-link\">documentation</a> for details."
         },
         "deviceadmin": {
             "DeviceManager": "Device-Manager",

diff --git a/src/PinMapping.cpp b/src/PinMapping.cpp
@@ -212,6 +212,8 @@ bool PinMappingClass::init(const String& deviceMapping)
     for (uint8_t i = 0; i < doc.size(); i++) {
         String devName = doc[i]["name"] | "";
         if (devName == deviceMapping) {
+            _mappingSelected = true;
+
             strlcpy(_pinMapping.name, devName.c_str(), sizeof(_pinMapping.name));
             _pinMapping.nrf24_clk = doc[i]["nrf24"]["clk"] | HOYMILES_PIN_SCLK;
             _pinMapping.nrf24_cs = doc[i]["nrf24"]["cs"] | HOYMILES_PIN_CS;

diff --git a/src/WebApi_ws_live.cpp b/src/WebApi_ws_live.cpp
@@ -125,6 +125,9 @@ void WebApiWsLiveClass::generateCommonJsonResponse(JsonVariant& root)
     hintObj["time_sync"] = !getLocalTime(&timeinfo, 5);
     hintObj["radio_problem"] = (Hoymiles.getRadioNrf()->isInitialized() && (!Hoymiles.getRadioNrf()->isConnected() || !Hoymiles.getRadioNrf()->isPVariant())) || (Hoymiles.getRadioCmt()->isInitialized() && (!Hoymiles.getRadioCmt()->isConnected()));
     hintObj["default_password"] = strcmp(Configuration.get().Security.Password, ACCESS_POINT_PASSWORD) == 0;
+
+    bool isGeneric = String(PIOENV) == "generic";
+    hintObj["pin_mapping_issue"] = !isGeneric && !PinMapping.isMappingSelected();
 }
 
 void WebApiWsLiveClass::generateInverterCommonJsonResponse(JsonObject& root, std::shared_ptr<InverterAbstract> inv)

diff --git a/webapp/src/components/HintView.vue b/webapp/src/components/HintView.vue
@@ -25,6 +25,13 @@
             </div>
         </div>
     </BootstrapAlert>
+
+    <BootstrapAlert :show="hints.pin_mapping_issue" variant="warning">
+        <div class="d-flex">
+            <div class="align-content-center"><BIconExclamationCircle class="fs-4" /></div>
+            <div class="align-content-center ms-3" v-html="$t('hints.PinMappingIssue')"></div>
+        </div>
+    </BootstrapAlert>
 </template>
 
 <script lang="ts">

diff --git a/webapp/src/locales/de.json b/webapp/src/locales/de.json
@@ -627,7 +627,8 @@
         "TimeSync": "Die Uhr wurde noch nicht synchronisiert. Ohne eine korrekt eingestellte Uhr werden keine Anfragen an den Wechselrichter gesendet. Dies ist kurz nach dem Start normal. Nach einer längeren Laufzeit (>1 Minute) bedeutet es jedoch, dass der NTP-Server nicht erreichbar ist.",
         "TimeSyncLink": "Bitte überprüfen Sie Ihre Zeiteinstellungen.",
         "DefaultPassword": "Sie verwenden das Standardpasswort für die Weboberfläche und den Notfall Access Point. Dies ist potenziell unsicher.",
-        "DefaultPasswordLink": "Bitte ändern Sie das Passwort."
+        "DefaultPasswordLink": "Bitte ändern Sie das Passwort.",
+        "PinMappingIssue": "Sie verwenden eine generische Firmware, haben jedoch noch keine Datei mit Verdrahtungsprofilen (<code>pin_mapping.json</code>) hochgeladen oder kein dort definiertes Profil ausgewählt. Details hierzu entnehmen Sie bitte der <a href=\"https://opendtu.solar/firmware/device_profiles/\" target=\"_blank\" class=\"alert-link\">Dokumentation</a>."
     },
     "deviceadmin": {
         "DeviceManager": "Hardware-Einstellungen",

diff --git a/webapp/src/locales/en.json b/webapp/src/locales/en.json
@@ -627,7 +627,8 @@
         "TimeSync": "The clock has not yet been synchronised. Without a correctly set clock, no requests are made to the inverter. This is normal shortly after the start. However, after a longer runtime (>1 minute), it indicates that the NTP server is not accessible.",
         "TimeSyncLink": "Please check your time settings.",
         "DefaultPassword": "You are using the default password for the web interface and the emergency access point. This is potentially insecure.",
-        "DefaultPasswordLink": "Please change the password."
+        "DefaultPasswordLink": "Please change the password.",
+        "PinMappingIssue": "You are using a generic firmware image, but have not yet uploaded a file with device profiles (<code>pin_mapping.json</code>) or have not selected a profile defined there. Please refer to the <a href=\"https://opendtu.solar/firmware/device_profiles/\" target=\"_blank\" class=\"alert-link\">documentation</a> for details."
     },
     "deviceadmin": {
         "DeviceManager": "Device-Manager",

diff --git a/webapp/src/locales/fr.json b/webapp/src/locales/fr.json
@@ -609,7 +609,8 @@
         "TimeSync": "L'horloge n'a pas encore été synchronisée. Sans une horloge correctement réglée, aucune demande n'est adressée à l'onduleur. Ceci est normal peu de temps après le démarrage. Cependant, après un temps de fonctionnement plus long (>1 minute), cela indique que le serveur NTP n'est pas accessible.",
         "TimeSyncLink": "Veuillez vérifier vos paramètres horaires.",
         "DefaultPassword": "Vous utilisez le mot de passe par défaut pour l'interface Web et le point d'accès d'urgence. Ceci est potentiellement non sécurisé.",
-        "DefaultPasswordLink": "Merci de changer le mot de passe."
+        "DefaultPasswordLink": "Merci de changer le mot de passe.",
+        "PinMappingIssue": "Vous utilisez une image générique du micrologiciel, mais vous n'avez pas encore téléchargé un fichier contenant les profils de l'appareil (<code>pin_mapping.json</code>) ou vous n'avez pas sélectionné un profil défini dans ce fichier. Veuillez vous référer à la <a href=\"https://opendtu.solar/firmware/device_profiles/\" target=\"_blank\" class=\"alert-link\">documentation</a> pour plus de détails."
     },
     "deviceadmin": {
         "DeviceManager": "Gestionnaire de périphériques",

diff --git a/webapp/src/types/LiveDataStatus.ts b/webapp/src/types/LiveDataStatus.ts
@@ -58,6 +58,7 @@ export interface Hints {
     time_sync: boolean;
     default_password: boolean;
     radio_problem: boolean;
+    pin_mapping_issue: boolean;
 }
 
 export interface LiveData {