Merge pull request #2258 from proddy/dev

minor changes
2025-12-06 07:49:52 +03:00 · 2024-11-28 15:01:36 +01:00
parent c0bffe4ccf a3964102c9
commit b7654c7e33
14 changed files with 114 additions and 19 deletions
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
--- a/40
+++ b/40
@@ -1,10 +1,27 @@
 #
 # GNUMakefile for EMS-ESP
-# This is mainly used to generate the .o files for SonarQube analysis
 #

-NUMJOBS=${NUMJOBS:-" -j10 "}
-MAKEFLAGS+="j "
+_mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
+I := $(patsubst %/,%,$(dir $(_mkfile_path)))
+
+ifneq ($(words $(MAKECMDGOALS)),1)
+.DEFAULT_GOAL = all
+%:
+	@$(MAKE) $@ --no-print-directory -rRf $(firstword $(MAKEFILE_LIST))
+else
+ifndef ECHO
+T := $(shell $(MAKE) $(MAKECMDGOALS) --no-print-directory \
+      -nrRf $(firstword $(MAKEFILE_LIST)) \
+      ECHO="COUNTTHIS" | grep -c "COUNTTHIS")
+N := x
+C = $(words $N)$(eval N := x $N)
+ECHO = python $(I)/echo_progress.py --stepno=$C --nsteps=$T
+endif
+
+# number of parallel compiles
+JOBS ?= $(shell nproc)
+MAKEFLAGS += -j $(JOBS) -l $(JOBS)

 #----------------------------------------------------------------------
 # Project Structure
@@ -125,23 +142,27 @@ COMPILE.cpp = $(CXX) $(CXX_STANDARD) $(CXXFLAGS) $(DEPFLAGS) -c $< -o $@
 .SILENT: $(OUTPUT)

 all: $(OUTPUT)
+	@$(ECHO) All done

 $(OUTPUT): $(OBJS)
 	@mkdir -p $(@D)
+	@$(ECHO) Linking $@
 	$(LINK.o)
 	$(SYMBOLS.out)
-
+	
 $(BUILD)/%.o: %.c
 	@mkdir -p $(@D)
-	$(COMPILE.c)
+	@$(ECHO) Compiling $@
+	@$(COMPILE.c)

 $(BUILD)/%.o: %.cpp
 	@mkdir -p $(@D)
-	$(COMPILE.cpp)
+	@$(ECHO) Compiling $@
+	@$(COMPILE.cpp)

 $(BUILD)/%.o: %.s
 	@mkdir -p $(@D)
-	$(COMPILE.s)
+	@$(COMPILE.s)

 cppcheck: $(SOURCES)
 	$(CPPCHECK) $(CHECKFLAGS) $^
@@ -150,6 +171,7 @@ run: $(OUTPUT)
 	@$<

 .PHONY: clean
+
 clean:
 	@$(RM) -rf $(BUILD) $(OUTPUT)

@@ -157,4 +179,6 @@ help:
 	@echo available targets: all run clean
 	@echo $(OUTPUT)

-include $(DEPS)
+-include $(DEPS)
+
+endif
--- a/cspell.json
+++ b/cspell.json
@@ -9,5 +9,25 @@
      }
    ],
    "dictionaries": ["project-words"],
-    "ignorePaths": ["node_modules", "compile_commands.json", "WWWData.h", "**/venv/**", "lib/eModbus", "lib/ESPAsyncWebServer", "lib/espMqttClient", "analyse.html", "dist", "**/*.csv", "**/*.md", "**/*.py", "locale_translations.h", "TZ.tsx", "**/*.txt","build/**", "**/i18n/**", "/project-words.txt"]
+    "ignorePaths": [
+    "node_modules", 
+    "compile_commands.json", 
+    "WWWData.h", "**/venv/**", 
+    "lib/eModbus", 
+    "lib/ESPAsyncWebServer", 
+    "lib/espMqttClient", 
+    "analyse.html", 
+    "dist", 
+    "**/*.csv", 
+    "**/*.md", 
+    "**/*.py", 
+    "locale_translations.h", 
+    "TZ.tsx", 
+    "**/*.txt",
+    "build/**", 
+    "**/i18n/**", 
+    "/project-words.txt",
+    "Makefile",
+    "src/modbus_entity_parameters.hpp"
+  ]
  }
--- a/echo_progress.py
+++ b/echo_progress.py
@@ -0,0 +1,28 @@
+"""
+Print makefile progress
+From https://stackoverflow.com/questions/451413/make-makefile-progress-indication
+"""
+
+import argparse
+import math
+import sys
+
+def main():
+  parser = argparse.ArgumentParser(description=__doc__)
+  parser.add_argument("--stepno", type=int, required=True)
+  parser.add_argument("--nsteps", type=int, required=True)
+  parser.add_argument("remainder", nargs=argparse.REMAINDER)
+  args = parser.parse_args()
+
+  nchars = int(math.log(args.nsteps, 10)) + 1
+  fmt_str = "[{:Xd}/{:Xd}]({:6.2f}%)".replace("X", str(nchars))
+  progress = 100 * args.stepno / args.nsteps
+  sys.stdout.write(fmt_str.format(args.stepno, args.nsteps, progress))
+  for item in args.remainder:
+    sys.stdout.write(" ")
+    sys.stdout.write(item)
+  sys.stdout.write("\n")
+
+if __name__ == "__main__":
+  main()
+  
--- a/interface/src/i18n/en/index.ts
+++ b/interface/src/i18n/en/index.ts
@@ -186,7 +186,7 @@ const en: Translation = {
  BUFFER_SIZE: 'Max Buffer Size',
  COMPACT: 'Compact',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings',
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)',
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)',
  UPLOAD_DROP_TEXT: 'Drop file or click here',
  ERROR: 'Unexpected Error, please try again',
  TIME_SET: 'Time set',
--- a/interface/src/i18n/fr/index.ts
+++ b/interface/src/i18n/fr/index.ts
@@ -186,7 +186,7 @@ const fr: Translation = {
  BUFFER_SIZE: 'Max taille du buffer',
  COMPACT: 'Compact',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings', // TODO translate
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)', // TODO translate
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)', // TODO translate
  UPLOAD_DROP_TEXT: 'Déposer le fichier ou cliquer ici',
  ERROR: 'Erreur inattendue, veuillez réessayer',
  TIME_SET: 'Time set',
--- a/interface/src/i18n/it/index.ts
+++ b/interface/src/i18n/it/index.ts
@@ -186,7 +186,7 @@ const it: Translation = {
  BUFFER_SIZE: 'Max Buffer Size',
  COMPACT: 'Compact',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings', // TODO translate
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)', // TODO translate
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)', // TODO translate
  UPLOAD_DROP_TEXT: 'Trascina il file o clicca qui',
  ERROR: 'Errore Inaspettato, prego tenta ancora',
  TIME_SET: 'Imposta Ora',
--- a/interface/src/i18n/nl/index.ts
+++ b/interface/src/i18n/nl/index.ts
@@ -186,7 +186,7 @@ const nl: Translation = {
  BUFFER_SIZE: 'Max Buffer Size',
  COMPACT: 'Compact',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings', // TODO translate
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)', // TODO translate
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)', // TODO translate
  UPLOAD_DROP_TEXT: 'Sleep bestand hierheen of klik hier',
  ERROR: 'Onverwachte fout, probeer opnieuw',
  TIME_SET: 'Tijd ingesteld',
--- a/interface/src/i18n/no/index.ts
+++ b/interface/src/i18n/no/index.ts
@@ -186,7 +186,7 @@ const no: Translation = {
  BUFFER_SIZE: 'Max Buffer Størrelse',
  COMPACT: 'Komprimere',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings', // TODO translate
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)', // TODO translate
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)', // TODO translate
  UPLOAD_DROP_TEXT: 'Slipp fil eller klikk her',
  ERROR: 'Ukjent feil, prøv igjen',
  TIME_SET: 'Still in tid',
--- a/interface/src/i18n/pl/index.ts
+++ b/interface/src/i18n/pl/index.ts
@@ -186,7 +186,7 @@ const pl: BaseTranslation = {
  BUFFER_SIZE: 'Maksymalna pojemność bufora (ilość wpisów)',
  COMPACT: 'Kompaktowy',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings', // TODO translate
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)', // TODO translate
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)', // TODO translate
  UPLOAD_DROP_TEXT: 'Przeciągnij tutaj plik lub kliknij',
  ERROR: 'Nieoczekiwany błąd, spróbuj ponownie!',
  TIME_SET: 'Zegar został ustawiony.',
--- a/interface/src/i18n/sv/index.ts
+++ b/interface/src/i18n/sv/index.ts
@@ -186,7 +186,7 @@ const sv: Translation = {
  BUFFER_SIZE: 'Max Bufferstorlek',
  COMPACT: 'Komprimera',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings', // TODO translate
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)', // TODO translate
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)', // TODO translate
  UPLOAD_DROP_TEXT: 'Släpp fil eller klicka här',
  ERROR: 'Okänt Fel, var god försök igen',
  TIME_SET: 'Ställ in tid',
--- a/interface/src/i18n/tr/index.ts
+++ b/interface/src/i18n/tr/index.ts
@@ -186,7 +186,7 @@ const tr: Translation = {
  BUFFER_SIZE: 'En fazla bellek boyutu',
  COMPACT: 'Sıkışık',
  DOWNLOAD_SETTINGS_TEXT: 'Create a backup of your configuration and settings', // TODO translate
-  UPLOAD_TEXT: 'Upload a new firmware (.bin) file or a backup file (.json)', // TODO translate
+  UPLOAD_TEXT: 'Upload a new firmware file (.bin) or a backup file (.json)', // TODO translate
  UPLOAD_DROP_TEXT: 'Buraya tıklayın yada dosyayı sürükleyip bırakın',
  ERROR: 'Beklenemedik hata, lütfen tekrar deneyin.',
  TIME_SET: 'Zaman ayarı',
--- a/scripts/generate_csv_and_headers.sh
+++ b/scripts/generate_csv_and_headers.sh
@@ -33,7 +33,7 @@ EOL

 # build emsesp for standalone
 make clean
-make ARGS=-DEMSESP_STANDALONE
+make -s ARGS=-DEMSESP_STANDALONE

 # Generate Modbus entity parameters
 # One to build the modbus_entity_parameters.hpp header file
@@ -43,7 +43,7 @@ echo "test entity_dump" | ./emsesp | python3 ./scripts/strip_csv.py | python3 ./
 ls -al ./src/modbus_entity_parameters.hpp

 # dump_entities.csv
-make ARGS=-DEMSESP_STANDALONE
+make -s ARGS=-DEMSESP_STANDALONE
 rm -f ./docs/dump_entities.csv
 echo "test entity_dump" | ./emsesp | python3 ./scripts/strip_csv.py >./docs/dump_entities.csv
 ls -al ./docs/dump_entities.csv
--- a/scripts/update_all.sh
+++ b/scripts/update_all.sh
@@ -0,0 +1,23 @@
+#!/bin/sh
+
+# run from root
+# make sure ncu is installed globally (https://github.com/raineorshine/npm-check-updates)
+# as well as GNUMake (make) and python3
+
+cd interface
+ncu -u
+yarn set version stable
+yarn
+yarn format
+yarn lint
+
+cd ../mock-api
+ncu -u
+yarn set version stable
+yarn
+yarn format
+
+cd ..
+npx cspell "**" 
+
+sh ./scripts/generate_csv_and_headers.sh