diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..64b5d4d --- /dev/null +++ b/.clang-format @@ -0,0 +1,107 @@ +--- +Language: Cpp + +DisableFormat: false +Standard: Latest +BasedOnStyle: WebKit +TabWidth: 4 +IndentWidth: 4 +ContinuationIndentWidth: 4 +ConstructorInitializerIndentWidth: 1 +UseTab: Never +ColumnLimit: 120 + +AccessModifierOffset: -4 +AlignAfterOpenBracket: AlwaysBreak +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignConsecutiveMacros: false +AlignEscapedNewlines: DontAlign +AlignOperands: false +AlignTrailingComments: false +AllowAllArgumentsOnNextLine: false +AllowAllConstructorInitializersOnNextLine: false +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: Never +AllowShortCaseLabelsOnASingleLine: false +AllowShortLambdasOnASingleLine: Inline +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: No +BinPackArguments: false +BinPackParameters: false + +# Configure each individual brace in BraceWrapping +BreakBeforeBraces: Custom +# Control of individual brace wrapping cases +BraceWrapping: + AfterCaseLabel: true + AfterClass: false + AfterControlStatement: Always + AfterEnum: true + AfterFunction: true + AfterNamespace: true + AfterStruct: true + AfterUnion: true + AfterExternBlock: true + BeforeCatch: true + BeforeElse: true + BeforeLambdaBody: true + IndentBraces: false + SplitEmptyFunction: false + SplitEmptyRecord: false + SplitEmptyNamespace: true + +BreakAfterJavaFieldAnnotations: true +BreakBeforeTernaryOperators: false +BreakConstructorInitializers: BeforeColon +BreakInheritanceList: BeforeColon +BreakStringLiterals: false +CommentPragmas: "^ IWYU pragma:" +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: false +Cpp11BracedListStyle: true +FixNamespaceComments: false +IndentCaseLabels: true +IndentPPDirectives: BeforeHash +IndentWrappedFunctionNames: false +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: "" +MacroBlockEnd: "" +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: All +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 + +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Middle +# QualifierAlignment: Right # Only supported in clang-format 14+ +# ReferenceAlignmentStyle: Middle # Only supported in clang-format 14+ +SortIncludes: true +SortUsingDeclarations: true +SpaceAfterCStyleCast: false +SpaceAfterLogicalNot: false +SpaceAfterTemplateKeyword: false +SpaceBeforeAssignmentOperators: true +SpaceBeforeCpp11BracedList: true +SpaceBeforeCtorInitializerColon: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: Never +SpaceBeforeRangeBasedForLoopColon: false +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInCStyleCastParentheses: false +SpacesInContainerLiterals: false +SpacesInParentheses: false +SpacesInSquareBrackets: false + +# Comments are for developers, they should arrange them +ReflowComments: false + +IncludeBlocks: Preserve +--- diff --git a/.gitignore b/.gitignore index e257658..c248bb8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +build/ + # ---> C++ # Prerequisites *.d diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json new file mode 100644 index 0000000..5624bd8 --- /dev/null +++ b/.vscode/c_cpp_properties.json @@ -0,0 +1,19 @@ +{ + "configurations": [ + { + "name": "Linux", + "intelliSenseMode": "gcc-x64", + "includePath": [ + "${workspaceFolder}/include" + ], + "defines": [ + "SPDLOG_FMT_EXTERNAL" + ], + "forcedInclude": [], + "compilerPath": "/usr/bin/gcc", + "cStandard": "c11", + "cppStandard": "c++17" + } + ], + "version": 4 +} \ No newline at end of file diff --git a/.vscode/configurationCache.log b/.vscode/configurationCache.log new file mode 100644 index 0000000..df53f4b --- /dev/null +++ b/.vscode/configurationCache.log @@ -0,0 +1 @@ +{"buildTargets":["all","bin/electricity-logger","bin/electricity-server","bin/migrator","bin/solar-logger","bin/solar-server","build/electricity-logger/database.o","build/electricity-logger/dsmr.o","build/electricity-logger/main.o","build/electricity-logger/serialport.o","build/solar-logger/main.o","check-electricity-logger","check-electricity-server","check-solar-logger","check-solar-server","clean","install","install-electricity-server","install-loggers","install-servers","install-solar-server","solarpaneloutput.db"],"launchTargets":["/home/tijmen/project/home-data-collection-tools/bin>electricity-logger()","/home/tijmen/project/home-data-collection-tools/bin>electricity-server()","/home/tijmen/project/home-data-collection-tools/bin>migrator()","/home/tijmen/project/home-data-collection-tools/bin>solar-logger()","/home/tijmen/project/home-data-collection-tools/bin>solar-server()"],"customConfigurationProvider":{"workspaceBrowse":{"browsePath":["/home/tijmen/project/home-data-collection-tools/include/","/home/tijmen/project/home-data-collection-tools/src/electricity-logger","/home/tijmen/project/home-data-collection-tools/src/electricity-server","/home/tijmen/project/home-data-collection-tools/src/electricity-server/server","/home/tijmen/project/home-data-collection-tools/src/migrator","/home/tijmen/project/home-data-collection-tools/src/migrator/migrations","/home/tijmen/project/home-data-collection-tools/src/solar-logger","/home/tijmen/project/home-data-collection-tools/src/solar-server","/home/tijmen/project/home-data-collection-tools/src/solar-server/database"],"compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-server/server/database.cpp","-o","build/electricity-server/server/database.o"],"compilerPath":"/usr/bin/g++","standard":"c++20","windowsSdkVersion":""},"fileIndex":[["/home/tijmen/project/home-data-collection-tools/src/solar-logger/main.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/main.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/main.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-logger/main.cpp","-o","build/solar-logger/main.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-logger/main.cpp -o build/solar-logger/main.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/main.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/solar-logger/zeverdata.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/zeverdata.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/zeverdata.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-logger/zeverdata.cpp","-o","build/solar-logger/zeverdata.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-logger/zeverdata.cpp -o build/solar-logger/zeverdata.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/zeverdata.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/solar-logger/database.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/database.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/database.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-logger/database.cpp","-o","build/solar-logger/database.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-logger/database.cpp -o build/solar-logger/database.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-logger/database.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/solar-server/database/connection.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-server/database/connection.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-server/database/connection.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-server/database/connection.cpp","-o","build/solar-server/database/connection.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/database/connection.cpp -o build/solar-server/database/connection.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-server/database/connection.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/solar-server/database/database.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-server/database/database.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-server/database/database.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-server/database/database.cpp","-o","build/solar-server/database/database.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/database/database.cpp -o build/solar-server/database/database.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-server/database/database.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/solar-server/api.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-server/api.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-server/api.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-server/api.cpp","-o","build/solar-server/api.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/api.cpp -o build/solar-server/api.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-server/api.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/solar-server/main.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-server/main.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-server/main.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-server/main.cpp","-o","build/solar-server/main.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/main.cpp -o build/solar-server/main.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-server/main.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/solar-server/configuration.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/solar-server/configuration.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/solar-server/configuration.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/solar-server/configuration.cpp","-o","build/solar-server/configuration.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/configuration.cpp -o build/solar-server/configuration.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/solar-server/configuration.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/updatesummarytable.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/updatesummarytable.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/updatesummarytable.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/migrator/migrations/updatesummarytable.cpp","-o","build/migrator/migrations/updatesummarytable.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/migrations/updatesummarytable.cpp -o build/migrator/migrations/updatesummarytable.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/updatesummarytable.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/epochtodatetime.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/epochtodatetime.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/epochtodatetime.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/migrator/migrations/epochtodatetime.cpp","-o","build/migrator/migrations/epochtodatetime.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/migrations/epochtodatetime.cpp -o build/migrator/migrations/epochtodatetime.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/migrator/migrations/epochtodatetime.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/migrator/main.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/migrator/main.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/migrator/main.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/migrator/main.cpp","-o","build/migrator/main.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/main.cpp -o build/migrator/main.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/migrator/main.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/migrator/transaction.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/migrator/transaction.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/migrator/transaction.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/migrator/transaction.cpp","-o","build/migrator/transaction.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/transaction.cpp -o build/migrator/transaction.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/migrator/transaction.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-logger/serialport.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/serialport.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/serialport.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-logger/serialport.cpp","-o","build/electricity-logger/serialport.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/serialport.cpp -o build/electricity-logger/serialport.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/serialport.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-logger/dsmr.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/dsmr.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/dsmr.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-logger/dsmr.cpp","-o","build/electricity-logger/dsmr.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/dsmr.cpp -o build/electricity-logger/dsmr.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/dsmr.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-logger/main.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/main.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/main.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-logger/main.cpp","-o","build/electricity-logger/main.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/main.cpp -o build/electricity-logger/main.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/main.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-logger/database.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/database.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/database.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-logger/database.cpp","-o","build/electricity-logger/database.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/database.cpp -o build/electricity-logger/database.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-logger/database.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-server/main.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/main.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/main.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-server/main.cpp","-o","build/electricity-server/main.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/main.cpp -o build/electricity-server/main.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/main.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/api.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/api.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/api.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-server/server/api.cpp","-o","build/electricity-server/server/api.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/server/api.cpp -o build/electricity-server/server/api.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/api.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/configuration.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/configuration.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/configuration.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-server/server/configuration.cpp","-o","build/electricity-server/server/configuration.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/server/configuration.cpp -o build/electricity-server/server/configuration.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/configuration.cpp"}}],["/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/database.cpp",{"uri":{"$mid":1,"fsPath":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/database.cpp","path":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/database.cpp","scheme":"file"},"configuration":{"defines":["SPDLOG_FMT_EXTERNAL"],"standard":"c++20","includePath":["/home/tijmen/project/home-data-collection-tools/include/"],"forcedInclude":[],"intelliSenseMode":"gcc-x64","compilerPath":"/usr/bin/g++","compilerArgs":["-Wall","-Wextra","-O2","-MMD","-c","src/electricity-server/server/database.cpp","-o","build/electricity-server/server/database.o"],"windowsSdkVersion":""},"compileCommand":{"command":"g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/server/database.cpp -o build/electricity-server/server/database.o","directory":"/home/tijmen/project/home-data-collection-tools","file":"/home/tijmen/project/home-data-collection-tools/src/electricity-server/server/database.cpp"}}]]}} \ No newline at end of file diff --git a/.vscode/dryrun.log b/.vscode/dryrun.log new file mode 100644 index 0000000..01f1fcf --- /dev/null +++ b/.vscode/dryrun.log @@ -0,0 +1,55 @@ +make --dry-run --always-make --keep-going --print-directory +make: Entering directory '/home/tijmen/project/home-data-collection-tools' + +mkdir -p build/solar-logger +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-logger/main.cpp -o build/solar-logger/main.o +mkdir -p build/solar-logger +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-logger/zeverdata.cpp -o build/solar-logger/zeverdata.o +mkdir -p build/solar-logger +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-logger/database.cpp -o build/solar-logger/database.o +mkdir -p bin +g++ build/solar-logger/main.o build/solar-logger/zeverdata.o build/solar-logger/database.o -lsqlite3 -lcurl -o bin/solar-logger +mkdir -p build/solar-server/database +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/database/connection.cpp -o build/solar-server/database/connection.o +mkdir -p build/solar-server/database +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/database/database.cpp -o build/solar-server/database/database.o +mkdir -p build/solar-server +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/api.cpp -o build/solar-server/api.o +mkdir -p build/solar-server +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/main.cpp -o build/solar-server/main.o +mkdir -p build/solar-server +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/solar-server/configuration.cpp -o build/solar-server/configuration.o +mkdir -p bin +g++ build/solar-server/database/connection.o build/solar-server/database/database.o build/solar-server/api.o build/solar-server/main.o build/solar-server/configuration.o -lpistache -lsqlite3 -lstdc++fs -lspdlog -lfmt -o bin/solar-server +mkdir -p build/migrator/migrations +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/migrations/updatesummarytable.cpp -o build/migrator/migrations/updatesummarytable.o +mkdir -p build/migrator/migrations +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/migrations/epochtodatetime.cpp -o build/migrator/migrations/epochtodatetime.o +mkdir -p build/migrator +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/main.cpp -o build/migrator/main.o +mkdir -p build/migrator +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/migrator/transaction.cpp -o build/migrator/transaction.o +mkdir -p bin +g++ build/migrator/migrations/updatesummarytable.o build/migrator/migrations/epochtodatetime.o build/migrator/main.o build/migrator/transaction.o -lsqlite3 -o bin/migrator +mkdir -p build/electricity-logger +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/serialport.cpp -o build/electricity-logger/serialport.o +mkdir -p build/electricity-logger +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/dsmr.cpp -o build/electricity-logger/dsmr.o +mkdir -p build/electricity-logger +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/main.cpp -o build/electricity-logger/main.o +mkdir -p build/electricity-logger +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-logger/database.cpp -o build/electricity-logger/database.o +mkdir -p bin +g++ build/electricity-logger/serialport.o build/electricity-logger/dsmr.o build/electricity-logger/main.o build/electricity-logger/database.o -lsqlite3 -lspdlog -lfmt -o bin/electricity-logger +mkdir -p build/electricity-server +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/main.cpp -o build/electricity-server/main.o +mkdir -p build/electricity-server/server +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/server/api.cpp -o build/electricity-server/server/api.o +mkdir -p build/electricity-server/server +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/server/configuration.cpp -o build/electricity-server/server/configuration.o +mkdir -p build/electricity-server/server +g++ -DSPDLOG_FMT_EXTERNAL -Wall -Wextra -std=c++20 -O2 -Iinclude/ -MMD -c src/electricity-server/server/database.cpp -o build/electricity-server/server/database.o +mkdir -p bin +g++ build/electricity-server/main.o build/electricity-server/server/api.o build/electricity-server/server/configuration.o build/electricity-server/server/database.o -lpistache -lsqlite3 -lstdc++fs -lspdlog -lfmt -o bin/electricity-server +make: Leaving directory '/home/tijmen/project/home-data-collection-tools' + diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..e977881 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "llvm-vs-code-extensions.vscode-clangd", + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..989aab9 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,79 @@ +{ + "editor.detectIndentation": true, + "editor.insertSpaces": true, + "editor.tabSize": 4, + "files.associations": { + "string": "cpp", + "array": "cpp", + "atomic": "cpp", + "hash_map": "cpp", + "bit": "cpp", + "*.tcc": "cpp", + "bitset": "cpp", + "cctype": "cpp", + "chrono": "cpp", + "clocale": "cpp", + "cmath": "cpp", + "compare": "cpp", + "concepts": "cpp", + "condition_variable": "cpp", + "csignal": "cpp", + "cstdarg": "cpp", + "cstddef": "cpp", + "cstdint": "cpp", + "cstdio": "cpp", + "cstdlib": "cpp", + "cstring": "cpp", + "ctime": "cpp", + "cwchar": "cpp", + "cwctype": "cpp", + "deque": "cpp", + "forward_list": "cpp", + "list": "cpp", + "map": "cpp", + "set": "cpp", + "unordered_map": "cpp", + "unordered_set": "cpp", + "vector": "cpp", + "exception": "cpp", + "algorithm": "cpp", + "functional": "cpp", + "iterator": "cpp", + "memory": "cpp", + "memory_resource": "cpp", + "numeric": "cpp", + "optional": "cpp", + "random": "cpp", + "ratio": "cpp", + "regex": "cpp", + "string_view": "cpp", + "system_error": "cpp", + "tuple": "cpp", + "type_traits": "cpp", + "utility": "cpp", + "fstream": "cpp", + "future": "cpp", + "initializer_list": "cpp", + "iomanip": "cpp", + "iosfwd": "cpp", + "iostream": "cpp", + "istream": "cpp", + "limits": "cpp", + "mutex": "cpp", + "new": "cpp", + "numbers": "cpp", + "ostream": "cpp", + "semaphore": "cpp", + "sstream": "cpp", + "stdexcept": "cpp", + "stop_token": "cpp", + "streambuf": "cpp", + "thread": "cpp", + "cinttypes": "cpp", + "typeindex": "cpp", + "typeinfo": "cpp", + "valarray": "cpp", + "variant": "cpp", + "strstream": "cpp" + } +} \ No newline at end of file diff --git a/.vscode/targets.log b/.vscode/targets.log new file mode 100644 index 0000000..6ac0569 --- /dev/null +++ b/.vscode/targets.log @@ -0,0 +1,829 @@ +make all --print-data-base --no-builtin-variables --no-builtin-rules --question +# GNU Make 4.3 +# Built for x86_64-pc-linux-gnu +# Copyright (C) 1988-2020 Free Software Foundation, Inc. +# License GPLv3+: GNU GPL version 3 or later +# This is free software: you are free to change and redistribute it. +# There is NO WARRANTY, to the extent permitted by law. + +# Make data base, printed on Mon Jun 27 19:09:36 2022 + +# Variables + +# environment +GDK_BACKEND = x11 +# environment +LC_ALL = C +# environment +NO_AT_BRIDGE = 1 +# environment +GTK_RC_FILES = /etc/gtk/gtkrc:/home/tijmen/.gtkrc:/home/tijmen/.config/gtkrc +# makefile (from 'makefile', line 16) +MIGRATOR_CPPS = $(shell find src/migrator/ -name *.cpp) +# makefile (from 'makefile', line 30) +MIGRATOR_BINARY_PATH = bin/migrator +# makefile (from 'makefile', line 9) +SOLAR_LOGGER_OBJS = $(patsubst src/%.cpp, build/%.o, ${SOLAR_LOGGER_CPPS}) +# environment +VSCODE_IPC_HOOK_EXTHOST = /run/user/1000/vscode-ipc-582970dc-f3ab-44e6-8729-662e27dd760f.sock +# environment +KONSOLE_DBUS_SERVICE = :1.81 + +# environment +LC_NUMERIC = en_US.UTF-8 +# environment +VSCODE_CWD = /home/tijmen/project/home-data-collection-tools +# environment +WINDOWID = 115343367 +# environment +WINDOWPATH = 1 +# makefile (from 'makefile', line 17) +MIGRATOR_OBJS = $(patsubst src/%.cpp, build/%.o, ${MIGRATOR_CPPS}) +# default +MAKE_COMMAND := make +# automatic +@D = $(patsubst %/,%,$(dir $@)) +# makefile (from 'makefile', line 31) +ELECT_LOGGER_BINARY_PATH = bin/electricity-logger +# environment +KONSOLE_VERSION = 220402 +# environment +VSCODE_HANDLES_UNCAUGHT_ERRORS = true +# default +.VARIABLES := +# environment +PWD = /home/tijmen/project/home-data-collection-tools +# automatic +%D = $(patsubst %/,%,$(dir $%)) +# environment +MAIL = /var/spool/mail/tijmen +# makefile (from 'makefile', line 24) +ELECT_SRV_CPPS = $(shell find src/electricity-server/ -name *.cpp) +# environment +OLDPWD = /home/tijmen +# environment +KONSOLE_DBUS_WINDOW = /Windows/1 +# automatic +^D = $(patsubst %/,%,$(dir $^)) +# makefile (from 'makefile', line 25) +ELECT_SRV_OBJS = $(patsubst src/%.cpp, build/%.o, ${ELECT_SRV_CPPS}) +# environment +VSCODE_LOG_STACK = false +# automatic +%F = $(notdir $%) +# makefile (from 'makefile', line 5) +SERVER_LFLAGS = -lpistache -lsqlite3 -lstdc++fs -lspdlog -lfmt +# environment +VSCODE_CODE_CACHE_PATH = /home/tijmen/.config/Code/CachedData/30d9c6cd9483b2cc586687151bcbcd635f373630 +# environment +LANG = C +# environment +XAUTHORITY = /home/tijmen/.Xauthority +# default +.LOADED := +# default +.INCLUDE_DIRS = /usr/include /usr/local/include /usr/include +# environment +COLORFGBG = 15;0 +# makefile +MAKEFLAGS = pqrR +# makefile +CURDIR := /home/tijmen/project/home-data-collection-tools +# environment +VSCODE_PIPE_LOGGING = true +# environment +APPLICATION_INSIGHTS_NO_DIAGNOSTIC_CHANNEL = 1 +# automatic +*D = $(patsubst %/,%,$(dir $*)) +# environment +MFLAGS = -pqrR +# default +.SHELLFLAGS := -c +# makefile (from 'makefile', line 3) +ELECTRICITY_LOGGER_LFLAGS = -lsqlite3 -lspdlog -lfmt +# makefile (from 'makefile', line 29) +SOLAR_SRV_BINARY_PATH = bin/solar-server +# environment +XDG_CONFIG_DIRS = /home/tijmen/.config/kdedefaults:/etc/xdg +# automatic ++D = $(patsubst %/,%,$(dir $+)) +# environment +XCURSOR_THEME = breeze_cursors +# makefile (from 'build/electricity-logger/database.d', line 1) +MAKEFILE_LIST := makefile build/electricity-logger/serialport.d build/electricity-logger/dsmr.d build/electricity-logger/main.d build/electricity-logger/database.d +# automatic +@F = $(notdir $@) +# environment +VSCODE_VERBOSE_LOGGING = true +# environment +VSCODE_PID = 2616 +# environment +XDG_SESSION_TYPE = tty +# automatic +?D = $(patsubst %/,%,$(dir $?)) +# environment +SESSION_MANAGER = local/ARCHDESKTOP:@/tmp/.ICE-unix/942,unix/ARCHDESKTOP:/tmp/.ICE-unix/942 +# automatic +*F = $(notdir $*) +# environment +CHROME_DESKTOP = code-url-handler.desktop +# environment +DBUS_SESSION_BUS_ADDRESS = unix:path=/run/user/1000/bus +# automatic + +Copyright (c) 2022 Tijmen van Nesselrooij Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.md b/README.md index 487f61c..3d3b50c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,50 @@ -# home-data-collection-tools +# Home Data Collection Tools -A collection of tools to log collected data from a Zeverlution smart inverter and DSMR protocol supporting meters. \ No newline at end of file +A mono repository containing all the homebrew collectors and REST APIs running on the local server. See it in action [here](https://valkendaal.duckdns.org). + +## Contents + +This repository houses various projects. All are listed below. + +- The Zeverlution S3000 logger, [documentation](docs/SOLAR_LOGGER.md) +- The Landis Gyr E350 logger, [documentation](docs/ELECTRICITY_LOGGER.md) +- Two pistache REST HTTP APIs, [documentation](docs/SERVER.md) + - A solar panel log server, [documentation](docs/SOLAR_API.md) + - An electricity log server, [documentation](docs/ELECTRICITY_API.md) +- A migrator to convert and build data structures yielded by the loggers, [documentation](docs/MIGRATOR.md) + +## Project Directory + +|- `.vscode` => A folder with Visual Studio Code IDE specific files, for developing this project
+|- `docs` => A folder housing all the documentation files (`*.md`)
+|- `include` => A folder housing all the header files used by the source files in `src/`
+|- `script` => A folder with handy bash scripts to create and migrate databases
+|- `src` => A folder with all the source files of the different projects that require compilation
+|....|- `electricity-logger` => The Landis Gyr E350 logger source files
+|....|- `electricity-server` => The pistache REST API sources for serving the electricity logs
+|....|- `migrator ` => The migrator source files
+|....|- `solar-logger` => The Zeverlution S3000 logger source files
+|....|- `solar-server` => The pistache REST API sources for serving the solar panel logs
+|- `systemd` => A folder with example systemd service files for the servers
+ +## Miscellaneous + +A few benchmarks have been done for the solar-server project, which can be found [here](docs/BENCHMARK.md). + +## Dependencies + +### Runtime (server) + +- Curl: the multiprotocol file tranfser library, [website](https://curl.haxx.se/libcurl/) +- cxxopts, [website](https://github.com/jarro2783/cxxopts/tree/v3.0.0) +- Docker CE, [website](https://www.docker.com/) +- GNU Make, [website](https://www.gnu.org/software/make/) +- Pistache: an elegant C++ REST framework, [website](http://pistache.io/) +- Spdlog, [website](https://github.com/gabime/spdlog) +- Sqlite3: a small SQL database engine, [website](https://www.sqlite.org/index.html) + +### Development + +In addition to all the runtime dependencies the following dependencies are required for development: + +- A C++20 compatible compiler diff --git a/bin/electricity-logger b/bin/electricity-logger new file mode 100755 index 0000000..01e0c7f Binary files /dev/null and b/bin/electricity-logger differ diff --git a/compile_flags.txt b/compile_flags.txt new file mode 100644 index 0000000..f685a90 --- /dev/null +++ b/compile_flags.txt @@ -0,0 +1,6 @@ +-xc++ +-Wall +-Wextra +-DSPDLOG_FMT_EXTERNAL +-Iinclude/ +-std=c++17 \ No newline at end of file diff --git a/docs/BENCHMARK.md b/docs/BENCHMARK.md new file mode 100644 index 0000000..66f7d43 --- /dev/null +++ b/docs/BENCHMARK.md @@ -0,0 +1,75 @@ +# solar-server Benchmarks + +Comparing a NodeJS REST API using ExpressJS and a file based logging solution against a Pistache REST API using an Sqlite3 logging solution. Measurements are made with Firefox, server is a Raspberry Pi 3 with all content stored on a microsd card (slow!). See the conclusion at the end if you want a TLDR;. + +## Raspberry Pi Model 3 B Benchmarks +Iteration #1: Fetching stuff from the database on a day by day basis (1 day = 1 query) + +| Operation | NodeJS | Pistache | Difference | +|-----------|-------:|---------:|-----------:| +| Day | 11ms | 6ms | -5ms | +| Month | 38ms | 80ms | +80ms | +| Year | 2122ms | 3353ms | +1231ms | + +Iteration #2: Fetching stuff from the database in a single query for all requests ++ Index on DateTimeUtc + +| Operation | NodeJS | Pistache | Difference | +|-----------|-------:|---------:|-----------:| +| Day | 12ms | 16ms | +4ms | +| Month | 40ms | 127ms | +87ms | +| Year | 1281ms | 6143ms | +4942ms | + +Iteration #3: Tweaks ++ Index on KilowattHour ++ Reindex + +**No difference** + +Iteration #4: Split DateTimeUtc into separate TEXT columns + +| Operation | NodeJS | Pistache | Difference | +|-----------|-------:|---------:|-----------:| +| Day | 10ms | 18ms | +8ms | +| Month | 34ms | 45ms | +11ms | +| Year | 1151ms | 2110ms | +959ms | + +## Pentium G5400 Benchmarks + +Iteration #5: Hardware change (Raspberry Pi 3+ to Pentium G5400) + +| Operation | NodeJS | Pistache | Difference | +|-----------|-------:|---------:|-----------:| +| Day | - | 3ms | - | +| Month | - | 5ms | - | +| Year | - | 83ms | - | + +Iteration #6: Keep a separate summary table + +| Operation | NodeJS | Pistache | Difference | +|-----------|-------:|---------:|-----------:| +| Day | - | 3ms | - | +| Month | - | 1ms | - | +| Year | - | 4ms | - | + +Comparison to the raspberry pi running the same software: + +| Operation | RPi | Pentium | Difference | +|-----------|-------:|---------:|-----------:| +| Day | 14ms | 3ms | -11ms | +| Month | 5ms | 1ms | -4ms | +| Year | 16ms | 4ms | -12ms | + +## Conclusion + +Clarification: +- All platforms run Debian Buster +- RPi = Raspbery Pi Model 3 B+ +- NodeJS = NodeJS Express.js server serving the solar logs stored as file per day (/var/log/solar/[yyyy]/[mm_dd].txt) +- Pistache = Pistache server serving the solar logs stored in a SQLite3 database + +| Operation | RPi NodeJS | RPi Pistache | Pentium G5400 Pistache | +|-----------|-----------:|-------------:|-----------------------:| +| Day | 11ms | 14ms | 3ms | +| Month | 38ms | 5ms | 1ms | +| Year | 2122ms | 16ms | 4ms | \ No newline at end of file diff --git a/docs/ELECTRICITY_API.md b/docs/ELECTRICITY_API.md new file mode 100644 index 0000000..3cdad67 --- /dev/null +++ b/docs/ELECTRICITY_API.md @@ -0,0 +1,37 @@ +# The electricity-server REST API + +This project depends on the `pistache` HTTP framework, see their [website](http://pistache.io/) for more info. + +## Endpoints +All endpoints respond in JSON. Examples can be found in the Examples section. Dates are always in ISO format, meaning they take the shape of `year-month-day` with leading zeroes for month and day. Example: `2019-01-11` is the eleventh day of January, 2019. + +- `/day?start=[yyyy-MM-dd]` This tells the server what date to serve all the collected records from the specified day. +- `/day?start=[yyyy-MM-dd]&stop=[yyyy-MM-dd]` This tells the server what date range to serve a per day summary for. + +### Example Response /day?start=2020-01-10 +Will give you as many objects as there are recorded values for the 10th of January, 2020. Ordered from earliest to latest. If there are no records for the given day an empty array is returned. +```json +[ + { + "dateTime":1578614401, + "totalPowerUse":3282.95, + "totalPowerReturn":2790.88, + "totalGasUse":3769.23 + }, + ... +] +``` + +### Example Response /day?start=2020-01-01&stop=2020-01-19 +Will give you a summary for each recorded day in the range 1st of January 2020 to the 19th of January 2020. If no logs exist for the day on the server it will send an object with a valid dateTime for that day but with 0 values for the other fields. +```json +[ + { + "dateTime":1578614401, + "totalPowerUse": 8.324, + "totalPowerReturn": 3.62, + "totalGasUse": 11.05 + }, + ... +] +``` \ No newline at end of file diff --git a/docs/ELECTRICITY_LOGGER.md b/docs/ELECTRICITY_LOGGER.md new file mode 100644 index 0000000..e1e8f82 --- /dev/null +++ b/docs/ELECTRICITY_LOGGER.md @@ -0,0 +1,24 @@ +## About + +This small tool is meant for logging the electricity values from the `Landis Gyr E350` electricity meter. As a bonus it also stores the gas concumption values. + +## Example Usage + +```bash +#!/bin/bash + +directoryPath="/var/log/electricity/$(date +%Y/)" +if ! [ -d "$directoryPath" ]; then + mkdir -p "$directoryPath" +fi + +outputFile="$directoryPath$(date +%m_%d.txt)" +if ! [ -f "$outputFile" ]; then + touch "$outputFile" +fi + +datestr="$(date +%Y-%m-%dT%T)" +electricity-logger -c "$datestr" /dev/ttyUSB0 >> "$outputFile" +``` + +Use the `--help` switch for more information about the possible arguments `electricity-logger` can take. \ No newline at end of file diff --git a/docs/SERVER.md b/docs/SERVER.md new file mode 100644 index 0000000..b376c84 --- /dev/null +++ b/docs/SERVER.md @@ -0,0 +1,43 @@ +# Serving Data + +This project includes to data servers: the solar server and electricity server. Both host the data collected by their respective logger counterparts. + +## API Description + +[The solar api description](./SOLAR_API.md) +[The electricity api description](./ELECTRICITY_API.md) + +## Reverse Proxy + +It is recommended to use a reverse proxy setup to make all servers and content reachable through standard HTTP(S) ports. When using nginx something like this suffices, using the solar server as example: +``` +server { + server_name solar.valkendaal.duckdns.org; + location / { + if ($request_method = 'GET') { + add_header 'Access-Control-Allow-Origin' '*'; + add_header 'Access-Control-Allow-Methods' 'GET'; + } + proxy_pass http://localhost:3001; + } +} +``` + +The additional if statement within the location scope allows fetching of solar resources by any other domain. This is used to display data exposed by the solar server on the website (`public/`). + +## Restricting Access + +The electricity server exposes sensitive data, hence it shouldn't be accessible to anyone except users of the household. The easy solution here is to verify the requestee's IP address, since anyone making the request from the household itself should share the same external IP address, including the server. Therefore the electricity server checks the requestee's IP address against its own external one (by resolving the given domain parameter argument to an IP address). + +For this a little hackery was necessary in the reverse proxy, since it normally makes the request to the electricity server on its own behalf. This would result in all requests originating from 127.0.0.1 (localhost). To solve this the following line was added before the `proxy_pass` directive: +``` +proxy_set_header X-Real-IP $remote_addr; +``` + +The value of the X-Real-IP HTTP header is then used by the electricity server to validate against the domain resolved IP address. If they match it means the request came from the same network as the server. + +This obviously is not watertight, but it serves the purpose well enough and avoids having to lay down more complicated authorization infrastructure. + +## Launch Parameters + +Both servers use TCLAP for their launch parameters. Simply run either executable without any parameters or use the `--help` switch to get all available commands. \ No newline at end of file diff --git a/docs/SOLAR_API.md b/docs/SOLAR_API.md new file mode 100644 index 0000000..304616e --- /dev/null +++ b/docs/SOLAR_API.md @@ -0,0 +1,42 @@ +# The solar-server REST API + +This project depends on the `pistache` HTTP framework, see their [website](http://pistache.io/) for more info. + +## Endpoints +All endpoints respond in JSON. Examples can be found in the Examples section. Dates are always in ISO format, meaning they take the shape of `year-month-day` with leading zeroes for month and day. Example: `2019-01-11` is the eleventh day of January, 2019. + +- `/day?start=[yyyy-MM-dd]` This tells the server what date to serve all the collected records from the specified day. +- `/day?start=[yyyy-MM-dd]&stop=[yyyy-MM-dd]` This tells the server what date to serve the highest recorded kilowatt hour collected for each day in the specified date range. Stop date is inclusive. +- `/month?&start=[yyyy-mm]&stop=[yyyy-mm]` This returns the total kilowatthours generated for a given month. The stop month is inclusive. + +## Example Response +All times are always in UTC. For these examples the current date is 25 December, 2019. + +### /day?start=2019-02-15 +Will give you as many objects as there are recorded values for the 15th of Febuary, 2019. Ordered from earliest to latest. +```json +[ + { + "time": 1550226776, + "watt": 1456, + "kwh": 14.53 + }, + { + "time": 1550226834, + "watt": 1456, + "kwh": 14.54 + }, + ... +] +``` + +### /month?start=2019-06&stop=2019-06 +Will give you a total kilowatt hours generated for the month July, 2019. The time component is the first day of the month at 00:00 (midnight) UTC. For multiple months the result is ordered earliest to latest. +```json +[ + { + "time": 1559347200, + "watt": 0, + "kwh": 451.64 + } +] \ No newline at end of file diff --git a/docs/SOLAR_LOGGER.md b/docs/SOLAR_LOGGER.md new file mode 100644 index 0000000..c6b3ccf --- /dev/null +++ b/docs/SOLAR_LOGGER.md @@ -0,0 +1,22 @@ +# About +This software targets linux and has been tested on both x86_64 and armv7 hardware. + +## solar-logger +Simple data collecting program for ZeverSolar's Zeverlution Sxxxx "smart" inverters with a network interface (referred to as "combox" by the manufacturer). It collects all the exposed data of the Zeverlution, including current power generation (watts) and today's cummulative power production (kilowatt/hours). + +### Strange output +Zeverlution Smart Inverters currently have a bug that causes leading zeroes in a decimal number to be ignored. Concretely this means that the value 0.01 becomes 0.10, 3.09 becomes 3.9, etcetera. This is causing strange peaks in the logged data where sequences go from 2.80 to 2.90 to 2.10. + +Another bug is the inverter turning itself off and back on again throughout the day. This happens if the yield get too low. This will cause the cumulative power to reset to zero (kilowatt per hour). + +# Building +## Dependencies +### solar-logger +Dependencies for this program are: +- `libcurl` which can be installed using your package manager. It has been tested with the `openSSL` flavour, libcurl version 4. +- `sqlite3` which is sometimes also referred to as `libsqlite3-dev`. + +## Building +The logger program can be build by running the makefile (`make all`) in the project root. It will create a `bin` folder where it puts the newly created binaries. Move these to wherever you keep your binaries or use the `install` make target. + +Refer to the `--help` switch to find out more about supported launch parameters. diff --git a/include/cxxopts.hpp b/include/cxxopts.hpp new file mode 100644 index 0000000..4855966 --- /dev/null +++ b/include/cxxopts.hpp @@ -0,0 +1,2086 @@ +/* + +Copyright (c) 2014, 2015, 2016, 2017 Jarryd Beck + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +*/ + +#ifndef CXXOPTS_HPP_INCLUDED +#define CXXOPTS_HPP_INCLUDED + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if defined(__GNUC__) && !defined(__clang__) + #if(__GNUC__ * 10 + __GNUC_MINOR__) < 49 + #define CXXOPTS_NO_REGEX true + #endif +#endif + +#ifndef CXXOPTS_NO_REGEX + #include +#endif // CXXOPTS_NO_REGEX + +// Nonstandard before C++17, which is coincidentally what we also need for +#ifdef __has_include + #if __has_include() + #include + #ifdef __cpp_lib_optional + #define CXXOPTS_HAS_OPTIONAL + #endif + #endif +#endif + +#if __cplusplus >= 201603L + #define CXXOPTS_NODISCARD [[nodiscard]] +#else + #define CXXOPTS_NODISCARD +#endif + +#ifndef CXXOPTS_VECTOR_DELIMITER + #define CXXOPTS_VECTOR_DELIMITER ',' +#endif + +#define CXXOPTS__VERSION_MAJOR 3 +#define CXXOPTS__VERSION_MINOR 0 +#define CXXOPTS__VERSION_PATCH 0 + +#if(__GNUC__ < 10 || (__GNUC__ == 10 && __GNUC_MINOR__ < 1)) && __GNUC__ >= 6 + #define CXXOPTS_NULL_DEREF_IGNORE +#endif + +namespace cxxopts +{ + static constexpr struct + { + uint8_t major, minor, patch; + } version = {CXXOPTS__VERSION_MAJOR, CXXOPTS__VERSION_MINOR, CXXOPTS__VERSION_PATCH}; +} // namespace cxxopts + +//when we ask cxxopts to use Unicode, help strings are processed using ICU, +//which results in the correct lengths being computed for strings when they +//are formatted for the help output +//it is necessary to make sure that can be found by the +//compiler, and that icu-uc is linked in to the binary. + +#ifdef CXXOPTS_USE_UNICODE + #include + +namespace cxxopts +{ + using String = icu::UnicodeString; + + inline String toLocalString(std::string s) { return icu::UnicodeString::fromUTF8(std::move(s)); } + + #if defined(__GNUC__) + // GNU GCC with -Weffc++ will issue a warning regarding the upcoming class, we want to silence it: + // warning: base class 'class std::enable_shared_from_this' has accessible non-virtual destructor + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wnon-virtual-dtor" + #pragma GCC diagnostic ignored "-Weffc++" + // This will be ignored under other compilers like LLVM clang. + #endif + class UnicodeStringIterator : public std::iterator { + public: + UnicodeStringIterator(const icu::UnicodeString * string, int32_t pos) : s(string), i(pos) { } + + value_type operator*() const { return s->char32At(i); } + + bool operator==(const UnicodeStringIterator & rhs) const { return s == rhs.s && i == rhs.i; } + + bool operator!=(const UnicodeStringIterator & rhs) const { return !(*this == rhs); } + + UnicodeStringIterator & operator++() + { + ++i; + return *this; + } + + UnicodeStringIterator operator+(int32_t v) { return UnicodeStringIterator(s, i + v); } + + private: + const icu::UnicodeString * s; + int32_t i; + }; + #if defined(__GNUC__) + #pragma GCC diagnostic pop + #endif + + inline String & stringAppend(String & s, String a) { return s.append(std::move(a)); } + + inline String & stringAppend(String & s, size_t n, UChar32 c) + { + for(size_t i = 0; i != n; ++i) + { + s.append(c); + } + + return s; + } + + template String & stringAppend(String & s, Iterator begin, Iterator end) + { + while(begin != end) + { + s.append(*begin); + ++begin; + } + + return s; + } + + inline size_t stringLength(const String & s) { return s.length(); } + + inline std::string toUTF8String(const String & s) + { + std::string result; + s.toUTF8String(result); + + return result; + } + + inline bool empty(const String & s) { return s.isEmpty(); } +} + +namespace std +{ + inline cxxopts::UnicodeStringIterator begin(const icu::UnicodeString & s) + { + return cxxopts::UnicodeStringIterator(&s, 0); + } + + inline cxxopts::UnicodeStringIterator end(const icu::UnicodeString & s) + { + return cxxopts::UnicodeStringIterator(&s, s.length()); + } +} + +//ifdef CXXOPTS_USE_UNICODE +#else + +namespace cxxopts +{ + using String = std::string; + + template T toLocalString(T && t) { return std::forward(t); } + + inline size_t stringLength(const String & s) { return s.length(); } + + inline String & stringAppend(String & s, const String & a) { return s.append(a); } + + inline String & stringAppend(String & s, size_t n, char c) { return s.append(n, c); } + + template String & stringAppend(String & s, Iterator begin, Iterator end) + { + return s.append(begin, end); + } + + template std::string toUTF8String(T && t) { return std::forward(t); } + + inline bool empty(const std::string & s) { return s.empty(); } +} // namespace cxxopts + +//ifdef CXXOPTS_USE_UNICODE +#endif + +namespace cxxopts +{ + namespace + { +#ifdef _WIN32 + const std::string LQUOTE("\'"); + const std::string RQUOTE("\'"); +#else + const std::string LQUOTE("‘"); + const std::string RQUOTE("’"); +#endif + } // namespace + +#if defined(__GNUC__) + // GNU GCC with -Weffc++ will issue a warning regarding the upcoming class, we want to silence it: + // warning: base class 'class std::enable_shared_from_this' has accessible non-virtual destructor + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wnon-virtual-dtor" + #pragma GCC diagnostic ignored "-Weffc++" +// This will be ignored under other compilers like LLVM clang. +#endif + class Value : public std::enable_shared_from_this { + public: + virtual ~Value() = default; + + virtual std::shared_ptr clone() const = 0; + + virtual void parse(const std::string & text) const = 0; + + virtual void parse() const = 0; + + virtual bool has_default() const = 0; + + virtual bool is_container() const = 0; + + virtual bool has_implicit() const = 0; + + virtual std::string get_default_value() const = 0; + + virtual std::string get_implicit_value() const = 0; + + virtual std::shared_ptr default_value(const std::string & value) = 0; + + virtual std::shared_ptr implicit_value(const std::string & value) = 0; + + virtual std::shared_ptr no_implicit_value() = 0; + + virtual bool is_boolean() const = 0; + }; +#if defined(__GNUC__) + #pragma GCC diagnostic pop +#endif + class OptionException : public std::exception { + public: + explicit OptionException(std::string message) : m_message(std::move(message)) { } + + CXXOPTS_NODISCARD + const char * what() const noexcept override { return m_message.c_str(); } + + private: + std::string m_message; + }; + + class OptionSpecException : public OptionException { + public: + explicit OptionSpecException(const std::string & message) : OptionException(message) { } + }; + + class OptionParseException : public OptionException { + public: + explicit OptionParseException(const std::string & message) : OptionException(message) { } + }; + + class option_exists_error : public OptionSpecException { + public: + explicit option_exists_error(const std::string & option) + : OptionSpecException("Option " + LQUOTE + option + RQUOTE + " already exists") + { } + }; + + class invalid_option_format_error : public OptionSpecException { + public: + explicit invalid_option_format_error(const std::string & format) + : OptionSpecException("Invalid option format " + LQUOTE + format + RQUOTE) + { } + }; + + class option_syntax_exception : public OptionParseException { + public: + explicit option_syntax_exception(const std::string & text) + : OptionParseException("Argument " + LQUOTE + text + RQUOTE + " starts with a - but has incorrect syntax") + { } + }; + + class option_not_exists_exception : public OptionParseException { + public: + explicit option_not_exists_exception(const std::string & option) + : OptionParseException("Option " + LQUOTE + option + RQUOTE + " does not exist") + { } + }; + + class missing_argument_exception : public OptionParseException { + public: + explicit missing_argument_exception(const std::string & option) + : OptionParseException("Option " + LQUOTE + option + RQUOTE + " is missing an argument") + { } + }; + + class option_requires_argument_exception : public OptionParseException { + public: + explicit option_requires_argument_exception(const std::string & option) + : OptionParseException("Option " + LQUOTE + option + RQUOTE + " requires an argument") + { } + }; + + class option_not_has_argument_exception : public OptionParseException { + public: + option_not_has_argument_exception(const std::string & option, const std::string & arg) + : OptionParseException( + "Option " + LQUOTE + option + RQUOTE + " does not take an argument, but argument " + LQUOTE + arg + RQUOTE + + " given") + { } + }; + + class option_not_present_exception : public OptionParseException { + public: + explicit option_not_present_exception(const std::string & option) + : OptionParseException("Option " + LQUOTE + option + RQUOTE + " not present") + { } + }; + + class option_has_no_value_exception : public OptionException { + public: + explicit option_has_no_value_exception(const std::string & option) + : OptionException( + !option.empty() ? ("Option " + LQUOTE + option + RQUOTE + " has no value") : "Option has no value") + { } + }; + + class argument_incorrect_type : public OptionParseException { + public: + explicit argument_incorrect_type(const std::string & arg) + : OptionParseException("Argument " + LQUOTE + arg + RQUOTE + " failed to parse") + { } + }; + + class option_required_exception : public OptionParseException { + public: + explicit option_required_exception(const std::string & option) + : OptionParseException("Option " + LQUOTE + option + RQUOTE + " is required but not present") + { } + }; + + template void throw_or_mimic(const std::string & text) + { + static_assert( + std::is_base_of::value, + "throw_or_mimic only works on std::exception and " + "deriving classes"); + +#ifndef CXXOPTS_NO_EXCEPTIONS + // If CXXOPTS_NO_EXCEPTIONS is not defined, just throw + throw T {text}; +#else + // Otherwise manually instantiate the exception, print what() to stderr, + // and exit + T exception {text}; + std::cerr << exception.what() << std::endl; + std::exit(EXIT_FAILURE); +#endif + } + + namespace values + { + namespace parser_tool + { + struct IntegerDesc + { + std::string negative = ""; + std::string base = ""; + std::string value = ""; + }; + struct ArguDesc + { + std::string arg_name = ""; + bool grouping = false; + bool set_value = false; + std::string value = ""; + }; +#ifdef CXXOPTS_NO_REGEX + inline IntegerDesc SplitInteger(const std::string & text) + { + if(text.empty()) + { + throw_or_mimic(text); + } + IntegerDesc desc; + const char * pdata = text.c_str(); + if(*pdata == '-') + { + pdata += 1; + desc.negative = "-"; + } + if(strncmp(pdata, "0x", 2) == 0) + { + pdata += 2; + desc.base = "0x"; + } + if(*pdata != '\0') + { + desc.value = std::string(pdata); + } + else + { + throw_or_mimic(text); + } + return desc; + } + + inline bool IsTrueText(const std::string & text) + { + const char * pdata = text.c_str(); + if(*pdata == 't' || *pdata == 'T') + { + pdata += 1; + if(strncmp(pdata, "rue\0", 4) == 0) + { + return true; + } + } + else if(strncmp(pdata, "1\0", 2) == 0) + { + return true; + } + return false; + } + + inline bool IsFalseText(const std::string & text) + { + const char * pdata = text.c_str(); + if(*pdata == 'f' || *pdata == 'F') + { + pdata += 1; + if(strncmp(pdata, "alse\0", 5) == 0) + { + return true; + } + } + else if(strncmp(pdata, "0\0", 2) == 0) + { + return true; + } + return false; + } + + inline std::pair SplitSwitchDef(const std::string & text) + { + std::string short_sw, long_sw; + const char * pdata = text.c_str(); + if(isalnum(*pdata) && *(pdata + 1) == ',') + { + short_sw = std::string(1, *pdata); + pdata += 2; + } + while(*pdata == ' ') + { + pdata += 1; + } + if(isalnum(*pdata)) + { + const char * store = pdata; + pdata += 1; + while(isalnum(*pdata) || *pdata == '-' || *pdata == '_') + { + pdata += 1; + } + if(*pdata == '\0') + { + long_sw = std::string(store, pdata - store); + } + else + { + throw_or_mimic(text); + } + } + return std::pair(short_sw, long_sw); + } + + inline ArguDesc ParseArgument(const char * arg, bool & matched) + { + ArguDesc argu_desc; + const char * pdata = arg; + matched = false; + if(strncmp(pdata, "--", 2) == 0) + { + pdata += 2; + if(isalnum(*pdata)) + { + argu_desc.arg_name.push_back(*pdata); + pdata += 1; + while(isalnum(*pdata) || *pdata == '-' || *pdata == '_') + { + argu_desc.arg_name.push_back(*pdata); + pdata += 1; + } + if(argu_desc.arg_name.length() > 1) + { + if(*pdata == '=') + { + argu_desc.set_value = true; + pdata += 1; + if(*pdata != '\0') + { + argu_desc.value = std::string(pdata); + } + matched = true; + } + else if(*pdata == '\0') + { + matched = true; + } + } + } + } + else if(strncmp(pdata, "-", 1) == 0) + { + pdata += 1; + argu_desc.grouping = true; + while(isalnum(*pdata)) + { + argu_desc.arg_name.push_back(*pdata); + pdata += 1; + } + matched = !argu_desc.arg_name.empty() && *pdata == '\0'; + } + return argu_desc; + } + +#else // CXXOPTS_NO_REGEX + + namespace + { + + std::basic_regex integer_pattern("(-)?(0x)?([0-9a-zA-Z]+)|((0x)?0)"); + std::basic_regex truthy_pattern("(t|T)(rue)?|1"); + std::basic_regex falsy_pattern("(f|F)(alse)?|0"); + + std::basic_regex option_matcher("--([[:alnum:]][-_[:alnum:]]+)(=(.*))?|-([[:alnum:]]+)"); + std::basic_regex option_specifier("(([[:alnum:]]),)?[ ]*([[:alnum:]][-_[:alnum:]]*)?"); + + } // namespace + + inline IntegerDesc SplitInteger(const std::string & text) + { + std::smatch match; + std::regex_match(text, match, integer_pattern); + + if(match.length() == 0) + { + throw_or_mimic(text); + } + + IntegerDesc desc; + desc.negative = match[1]; + desc.base = match[2]; + desc.value = match[3]; + + if(match.length(4) > 0) + { + desc.base = match[5]; + desc.value = "0"; + return desc; + } + + return desc; + } + + inline bool IsTrueText(const std::string & text) + { + std::smatch result; + std::regex_match(text, result, truthy_pattern); + return !result.empty(); + } + + inline bool IsFalseText(const std::string & text) + { + std::smatch result; + std::regex_match(text, result, falsy_pattern); + return !result.empty(); + } + + inline std::pair SplitSwitchDef(const std::string & text) + { + std::match_results result; + std::regex_match(text.c_str(), result, option_specifier); + if(result.empty()) + { + throw_or_mimic(text); + } + + const std::string & short_sw = result[2]; + const std::string & long_sw = result[3]; + + return std::pair(short_sw, long_sw); + } + + inline ArguDesc ParseArgument(const char * arg, bool & matched) + { + std::match_results result; + std::regex_match(arg, result, option_matcher); + matched = !result.empty(); + + ArguDesc argu_desc; + if(matched) + { + argu_desc.arg_name = result[1].str(); + argu_desc.set_value = result[2].length() > 0; + argu_desc.value = result[3].str(); + if(result[4].length() > 0) + { + argu_desc.grouping = true; + argu_desc.arg_name = result[4].str(); + } + } + + return argu_desc; + } + +#endif // CXXOPTS_NO_REGEX +#undef CXXOPTS_NO_REGEX + } + + namespace detail + { + template struct SignedCheck; + + template struct SignedCheck + { + template void operator()(bool negative, U u, const std::string & text) + { + if(negative) + { + if(u > static_cast((std::numeric_limits::min)())) + { + throw_or_mimic(text); + } + } + else + { + if(u > static_cast((std::numeric_limits::max)())) + { + throw_or_mimic(text); + } + } + } + }; + + template struct SignedCheck + { + template void operator()(bool, U, const std::string &) const { } + }; + + template void check_signed_range(bool negative, U value, const std::string & text) + { + SignedCheck::is_signed>()(negative, value, text); + } + } // namespace detail + + template void checked_negate(R & r, T && t, const std::string &, std::true_type) + { + // if we got to here, then `t` is a positive number that fits into + // `R`. So to avoid MSVC C4146, we first cast it to `R`. + // See https://github.com/jarro2783/cxxopts/issues/62 for more details. + r = static_cast(-static_cast(t - 1) - 1); + } + + template void checked_negate(R &, T &&, const std::string & text, std::false_type) + { + throw_or_mimic(text); + } + + template void integer_parser(const std::string & text, T & value) + { + parser_tool::IntegerDesc int_desc = parser_tool::SplitInteger(text); + + using US = typename std::make_unsigned::type; + constexpr bool is_signed = std::numeric_limits::is_signed; + + const bool negative = int_desc.negative.length() > 0; + const uint8_t base = int_desc.base.length() > 0 ? 16 : 10; + const std::string & value_match = int_desc.value; + + US result = 0; + + for(char ch: value_match) + { + US digit = 0; + + if(ch >= '0' && ch <= '9') + { + digit = static_cast(ch - '0'); + } + else if(base == 16 && ch >= 'a' && ch <= 'f') + { + digit = static_cast(ch - 'a' + 10); + } + else if(base == 16 && ch >= 'A' && ch <= 'F') + { + digit = static_cast(ch - 'A' + 10); + } + else + { + throw_or_mimic(text); + } + + const US next = static_cast(result * base + digit); + if(result > next) + { + throw_or_mimic(text); + } + + result = next; + } + + detail::check_signed_range(negative, result, text); + + if(negative) + { + checked_negate(value, result, text, std::integral_constant()); + } + else + { + value = static_cast(result); + } + } + + template void stringstream_parser(const std::string & text, T & value) + { + std::stringstream in(text); + in >> value; + if(!in) + { + throw_or_mimic(text); + } + } + + template::value>::type * = nullptr> + void parse_value(const std::string & text, T & value) + { + integer_parser(text, value); + } + + inline void parse_value(const std::string & text, bool & value) + { + if(parser_tool::IsTrueText(text)) + { + value = true; + return; + } + + if(parser_tool::IsFalseText(text)) + { + value = false; + return; + } + + throw_or_mimic(text); + } + + inline void parse_value(const std::string & text, std::string & value) { value = text; } + + // The fallback parser. It uses the stringstream parser to parse all types + // that have not been overloaded explicitly. It has to be placed in the + // source code before all other more specialized templates. + template::value>::type * = nullptr> + void parse_value(const std::string & text, T & value) + { + stringstream_parser(text, value); + } + + template void parse_value(const std::string & text, std::vector & value) + { + if(text.empty()) + { + T v; + parse_value(text, v); + value.emplace_back(std::move(v)); + return; + } + std::stringstream in(text); + std::string token; + while(!in.eof() && std::getline(in, token, CXXOPTS_VECTOR_DELIMITER)) + { + T v; + parse_value(token, v); + value.emplace_back(std::move(v)); + } + } + +#ifdef CXXOPTS_HAS_OPTIONAL + template void parse_value(const std::string & text, std::optional & value) + { + T result; + parse_value(text, result); + value = std::move(result); + } +#endif + + inline void parse_value(const std::string & text, char & c) + { + if(text.length() != 1) + { + throw_or_mimic(text); + } + + c = text[0]; + } + + template struct type_is_container + { + static constexpr bool value = false; + }; + + template struct type_is_container> + { + static constexpr bool value = true; + }; + + template class abstract_value : public Value { + using Self = abstract_value; + + public: + abstract_value() : m_result(std::make_shared()), m_store(m_result.get()) { } + + explicit abstract_value(T * t) : m_store(t) { } + + ~abstract_value() override = default; + + abstract_value & operator=(const abstract_value &) = default; + + abstract_value(const abstract_value & rhs) + { + if(rhs.m_result) + { + m_result = std::make_shared(); + m_store = m_result.get(); + } + else + { + m_store = rhs.m_store; + } + + m_default = rhs.m_default; + m_implicit = rhs.m_implicit; + m_default_value = rhs.m_default_value; + m_implicit_value = rhs.m_implicit_value; + } + + void parse(const std::string & text) const override { parse_value(text, *m_store); } + + bool is_container() const override { return type_is_container::value; } + + void parse() const override { parse_value(m_default_value, *m_store); } + + bool has_default() const override { return m_default; } + + bool has_implicit() const override { return m_implicit; } + + std::shared_ptr default_value(const std::string & value) override + { + m_default = true; + m_default_value = value; + return shared_from_this(); + } + + std::shared_ptr implicit_value(const std::string & value) override + { + m_implicit = true; + m_implicit_value = value; + return shared_from_this(); + } + + std::shared_ptr no_implicit_value() override + { + m_implicit = false; + return shared_from_this(); + } + + std::string get_default_value() const override { return m_default_value; } + + std::string get_implicit_value() const override { return m_implicit_value; } + + bool is_boolean() const override { return std::is_same::value; } + + const T & get() const + { + if(m_store == nullptr) + { + return *m_result; + } + return *m_store; + } + + protected: + std::shared_ptr m_result {}; + T * m_store {}; + + bool m_default = false; + bool m_implicit = false; + + std::string m_default_value {}; + std::string m_implicit_value {}; + }; + + template class standard_value : public abstract_value { + public: + using abstract_value::abstract_value; + + CXXOPTS_NODISCARD + std::shared_ptr clone() const override { return std::make_shared>(*this); } + }; + + template<> class standard_value : public abstract_value { + public: + ~standard_value() override = default; + + standard_value() { set_default_and_implicit(); } + + explicit standard_value(bool * b) : abstract_value(b) { set_default_and_implicit(); } + + std::shared_ptr clone() const override { return std::make_shared>(*this); } + + private: + void set_default_and_implicit() + { + m_default = true; + m_default_value = "false"; + m_implicit = true; + m_implicit_value = "true"; + } + }; + } // namespace values + + template std::shared_ptr value() { return std::make_shared>(); } + + template std::shared_ptr value(T & t) { return std::make_shared>(&t); } + + class OptionAdder; + + class OptionDetails { + public: + OptionDetails(std::string short_, std::string long_, String desc, std::shared_ptr val) + : m_short(std::move(short_)), m_long(std::move(long_)), m_desc(std::move(desc)), m_value(std::move(val)), + m_count(0) + { + m_hash = std::hash {}(m_long + m_short); + } + + OptionDetails(const OptionDetails & rhs) + : m_desc(rhs.m_desc), m_value(rhs.m_value->clone()), m_count(rhs.m_count) + { } + + OptionDetails(OptionDetails && rhs) = default; + + CXXOPTS_NODISCARD + const String & description() const { return m_desc; } + + CXXOPTS_NODISCARD + const Value & value() const { return *m_value; } + + CXXOPTS_NODISCARD + std::shared_ptr make_storage() const { return m_value->clone(); } + + CXXOPTS_NODISCARD + const std::string & short_name() const { return m_short; } + + CXXOPTS_NODISCARD + const std::string & long_name() const { return m_long; } + + size_t hash() const { return m_hash; } + + private: + std::string m_short {}; + std::string m_long {}; + String m_desc {}; + std::shared_ptr m_value {}; + int m_count; + + size_t m_hash {}; + }; + + struct HelpOptionDetails + { + std::string s; + std::string l; + String desc; + bool has_default; + std::string default_value; + bool has_implicit; + std::string implicit_value; + std::string arg_help; + bool is_container; + bool is_boolean; + }; + + struct HelpGroupDetails + { + std::string name {}; + std::string description {}; + std::vector options {}; + }; + + class OptionValue { + public: + void parse(const std::shared_ptr & details, const std::string & text) + { + ensure_value(details); + ++m_count; + m_value->parse(text); + m_long_name = &details->long_name(); + } + + void parse_default(const std::shared_ptr & details) + { + ensure_value(details); + m_default = true; + m_long_name = &details->long_name(); + m_value->parse(); + } + + void parse_no_value(const std::shared_ptr & details) + { + m_long_name = &details->long_name(); + } + +#if defined(CXXOPTS_NULL_DEREF_IGNORE) + #pragma GCC diagnostic push + #pragma GCC diagnostic ignored "-Wnull-dereference" +#endif + + CXXOPTS_NODISCARD + size_t count() const noexcept { return m_count; } + +#if defined(CXXOPTS_NULL_DEREF_IGNORE) + #pragma GCC diagnostic pop +#endif + + // TODO: maybe default options should count towards the number of arguments + CXXOPTS_NODISCARD + bool has_default() const noexcept { return m_default; } + + template const T & as() const + { + if(m_value == nullptr) + { + throw_or_mimic(m_long_name == nullptr ? "" : *m_long_name); + } + +#ifdef CXXOPTS_NO_RTTI + return static_cast &>(*m_value).get(); +#else + return dynamic_cast &>(*m_value).get(); +#endif + } + + private: + void ensure_value(const std::shared_ptr & details) + { + if(m_value == nullptr) + { + m_value = details->make_storage(); + } + } + + const std::string * m_long_name = nullptr; + // Holding this pointer is safe, since OptionValue's only exist in key-value pairs, + // where the key has the string we point to. + std::shared_ptr m_value {}; + size_t m_count = 0; + bool m_default = false; + }; + + class KeyValue { + public: + KeyValue(std::string key_, std::string value_) : m_key(std::move(key_)), m_value(std::move(value_)) { } + + CXXOPTS_NODISCARD + const std::string & key() const { return m_key; } + + CXXOPTS_NODISCARD + const std::string & value() const { return m_value; } + + template T as() const + { + T result; + values::parse_value(m_value, result); + return result; + } + + private: + std::string m_key; + std::string m_value; + }; + + using ParsedHashMap = std::unordered_map; + using NameHashMap = std::unordered_map; + + class ParseResult { + public: + ParseResult() = default; + ParseResult(const ParseResult &) = default; + + ParseResult( + NameHashMap && keys, + ParsedHashMap && values, + std::vector sequential, + std::vector && unmatched_args) + : m_keys(std::move(keys)), m_values(std::move(values)), m_sequential(std::move(sequential)), + m_unmatched(std::move(unmatched_args)) + { } + + ParseResult & operator=(ParseResult &&) = default; + ParseResult & operator=(const ParseResult &) = default; + + size_t count(const std::string & o) const + { + auto iter = m_keys.find(o); + if(iter == m_keys.end()) + { + return 0; + } + + auto viter = m_values.find(iter->second); + + if(viter == m_values.end()) + { + return 0; + } + + return viter->second.count(); + } + + const OptionValue & operator[](const std::string & option) const + { + auto iter = m_keys.find(option); + + if(iter == m_keys.end()) + { + throw_or_mimic(option); + } + + auto viter = m_values.find(iter->second); + + if(viter == m_values.end()) + { + throw_or_mimic(option); + } + + return viter->second; + } + + const std::vector & arguments() const { return m_sequential; } + + const std::vector & unmatched() const { return m_unmatched; } + + private: + NameHashMap m_keys {}; + ParsedHashMap m_values {}; + std::vector m_sequential {}; + std::vector m_unmatched {}; + }; + + struct Option + { + Option( + std::string opts, + std::string desc, + std::shared_ptr value = ::cxxopts::value(), + std::string arg_help = "") + : opts_(std::move(opts)), desc_(std::move(desc)), value_(std::move(value)), arg_help_(std::move(arg_help)) + { } + + std::string opts_; + std::string desc_; + std::shared_ptr value_; + std::string arg_help_; + }; + + using OptionMap = std::unordered_map>; + using PositionalList = std::vector; + using PositionalListIterator = PositionalList::const_iterator; + + class OptionParser { + public: + OptionParser(const OptionMap & options, const PositionalList & positional, bool allow_unrecognised) + : m_options(options), m_positional(positional), m_allow_unrecognised(allow_unrecognised) + { } + + ParseResult parse(int argc, const char * const * argv); + + bool consume_positional(const std::string & a, PositionalListIterator & next); + + void checked_parse_arg( + int argc, + const char * const * argv, + int & current, + const std::shared_ptr & value, + const std::string & name); + + void add_to_option(OptionMap::const_iterator iter, const std::string & option, const std::string & arg); + + void parse_option( + const std::shared_ptr & value, + const std::string & name, + const std::string & arg = ""); + + void parse_default(const std::shared_ptr & details); + + void parse_no_value(const std::shared_ptr & details); + + private: + void finalise_aliases(); + + const OptionMap & m_options; + const PositionalList & m_positional; + + std::vector m_sequential {}; + bool m_allow_unrecognised; + + ParsedHashMap m_parsed {}; + NameHashMap m_keys {}; + }; + + class Options { + public: + explicit Options(std::string program, std::string help_string = "") + : m_program(std::move(program)), m_help_string(toLocalString(std::move(help_string))), + m_custom_help("[OPTION...]"), m_positional_help("positional parameters"), m_show_positional(false), + m_allow_unrecognised(false), m_width(76), m_tab_expansion(false), m_options(std::make_shared()) + { } + + Options & positional_help(std::string help_text) + { + m_positional_help = std::move(help_text); + return *this; + } + + Options & custom_help(std::string help_text) + { + m_custom_help = std::move(help_text); + return *this; + } + + Options & show_positional_help() + { + m_show_positional = true; + return *this; + } + + Options & allow_unrecognised_options() + { + m_allow_unrecognised = true; + return *this; + } + + Options & set_width(size_t width) + { + m_width = width; + return *this; + } + + Options & set_tab_expansion(bool expansion = true) + { + m_tab_expansion = expansion; + return *this; + } + + ParseResult parse(int argc, const char * const * argv); + + OptionAdder add_options(std::string group = ""); + + void add_options(const std::string & group, std::initializer_list