1,651
edits
CumulusUtils: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→RPi: Using crontab
m (→Introduction) |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
This is the first page of the CumulusUtils Wiki. From here you should be able to find everything you need to know for this tool. | This is the first page of the CumulusUtils Wiki. From here you should be able to find everything you need to know for this tool. | ||
If needed you can always go to the | If needed you can always go to the CumulusUtils Category page (see bottom of this page). | ||
== Prerequisites == | == Prerequisites == | ||
| Line 70: | Line 70: | ||
Beside the libraries the distribution contains: | Beside the libraries the distribution contains: | ||
#CUserAbout-example.txt : as an example of the user about file - when used rename to ''CUserAbout.txt'' | #CUserAbout-example.txt : as an example of the user about file - when used rename to ''CUserAbout.txt'' | ||
# | #CutilsMenu-example-for-use.def : as an example of the menu structure - when used rename to ''CutilsMenu.def'' | ||
#CutilsCharts-default-for-use.def : when used rename to ''CutilsCharts.def'' | #CutilsCharts-default-for-use.def : when used rename to ''CutilsCharts.def'' | ||
#CutilsCharts-examples.def : not intended for direct use, contains some more elaborate examples of the [[ChartsCompiler]] possibilities | #CutilsCharts-examples.def : not intended for direct use, contains some more elaborate examples of the [[ChartsCompiler]] possibilities | ||
| Line 92: | Line 92: | ||
| index.html || <webroot> | | index.html || <webroot> | ||
|- | |- | ||
| | | CUgauges.js || <webroot>/lib || Despite the same name this file is very different from the one in CMX | ||
|- | |- | ||
| | | CUlanguage.js || <webroot>/lib | ||
|- | |- | ||
| HighchartsDefaults.js || <webroot>/lib | | HighchartsDefaults.js || <webroot>/lib | ||
| Line 100: | Line 100: | ||
| suncalc.js || <webroot>/lib | | suncalc.js || <webroot>/lib | ||
|- | |- | ||
| | | CUtween.min.js || <webroot>/lib | ||
|- | |- | ||
| | | CUsteelseries.min.js || <webroot>/lib | ||
|- | |- | ||
| | | CURGraph.rose.js || <webroot>/lib | ||
|- | |- | ||
| | | CURGraph.common.core.js || <webroot>/lib | ||
|- | |- | ||
| | | CUgauges-ss.css || <webroot>/css | ||
|- | |- | ||
! Generated File !! Destination !! Remark | ! Generated File !! Destination !! Remark | ||
| Line 157: | Line 157: | ||
== Running CumulusUtils == | == Running CumulusUtils == | ||
CumulusUtils is a [https://www.mono-project.com/ ''mono''] executable. Mono is an open source implementation of Microsoft's .NET Framework based on the ECMA standards for C# and the Common Language Runtime. | CumulusUtils is - up to v6.x.y - a [https://www.mono-project.com/ ''mono''] executable. | ||
From v7.0.0 and up it runs under [https://dotnet.microsoft.com/en-us/ ''dotnet (.NET 8)'']. | |||
Both environments are very different and not interchangeable. However running CumulusUtils is pretty similar on both environment and mono and dotnet can co-exist on the same machine. See the CMX installation on how to install either mono or dotnet. CumulusUtils assumes the correct installation of either environment. | |||
Mono is an open source implementation of Microsoft's .NET Framework based on the ECMA standards for C# and the Common Language Runtime. | |||
''CumulusUtils'' runs on any operating system CumulusMX runs on and it '''MUST''' run in the CumulusMX directory (as ''working directory''). | ''CumulusUtils'' runs on any operating system CumulusMX runs on and it '''MUST''' run in the CumulusMX directory (as ''working directory''). | ||
Running ''CumulusUtils'' is done from the commandline in a command window (under any OS). | Running ''CumulusUtils'' is done from the commandline in a command window (under any OS). | ||
| Line 163: | Line 168: | ||
''CumulusUtils'' takes one or more commandline parameters (in short: commands) and must be like (see NOTE 1 below; square brackets means ''optional'' so DON'T TYPE THEM): | ''CumulusUtils'' takes one or more commandline parameters (in short: commands) and must be like (see NOTE 1 below; square brackets means ''optional'' so DON'T TYPE THEM): | ||
''utils/bin/cumulusutils.exe [command]'' | ''utils/bin/cumulusutils.exe [command]'' (the ''mono'' syntax - this assumes mono is already active) | ||
''dotnet utils/bin/cumulusutils.dll [command]'' (the ''.NET'' syntax - ''dotnet'' is obligatory on the commandline. Note the '''dll''') | |||
Below is described for ''mono'', when using .NET, please change the command as above. Note you will have to carry this on in scripts as well. Using the dotnet command in crontab requires using the explicit path to the dotnet command or defining the PATH environment variable in the crontab script which does not know the environment (a bit awkward). | |||
If no commands are given the application responds with: | If no commands are given the application responds with: | ||
| Line 173: | Line 182: | ||
[ [[pwsFWI]] ][ [[Records - Top10|Top10]] ][ [[Graphs]] ][ [[Yadr]] ][ [[Records]] ] | [ [[pwsFWI]] ][ [[Records - Top10|Top10]] ][ [[Graphs]] ][ [[Yadr]] ][ [[Records]] ] | ||
[ [[NOAA]] ][ [[Records - DayRecords|DayRecords]] ][ [[AirLink]] ][ [[UserAskedData]] ] | [ [[NOAA]] ][ [[Records - DayRecords|DayRecords]] ][ [[AirLink]] ][ [[UserAskedData]] ] | ||
[ [[ChartsCompiler|CompileOnly]] ] [ [[Extra Sensors|ExtraSensors]] [[Custom Logs|CustomLogs]]] | [ [[ChartsCompiler|CompileOnly]] ] [ [[Extra Sensors|ExtraSensors]] ] [ [[Custom Logs|CustomLogs]] ] | ||
| [ [[Thrifty - Cutils Command Qualifier|Thrifty]] ] | | [ [[Thrifty - Cutils Command Qualifier|Thrifty]] ] | ||
| Line 226: | Line 235: | ||
Automating the run of CumulusUtils on the Raspberry Pi is typically done through [https://man7.org/linux/man-pages/man5/crontab.5.html ''crontab'']. Below is the crontab of the author of CumulusUtils to be used as an '''example'''! | Automating the run of CumulusUtils on the Raspberry Pi is typically done through [https://man7.org/linux/man-pages/man5/crontab.5.html ''crontab'']. Below is the crontab of the author of CumulusUtils to be used as an '''example'''! | ||
===== For dotnet ===== | |||
05 1 * * * cd /home/CumulusMX; /usr/share/dotnet/dotnet utils/bin/cumulusutils.dll thrifty website | |||
1-51/10 * * * * cd /home/CumulusMX; /usr/share/dotnet/dotnet utils/bin/cumulusutils.dll sysinfo UserAskedData UserReports | |||
===== For mono ===== | |||
15 1 * * * cd /home/CumulusMX; utils/bin/cumulusutils.exe thrifty website | 15 1 * * * cd /home/CumulusMX; utils/bin/cumulusutils.exe thrifty website | ||
1-51/10 * * * * cd /home/CumulusMX; utils/bin/cumulusutils.exe sysinfo UserAskedData UserReport | |||
==== Windows: Using the scheduler ==== | ==== Windows: Using the scheduler ==== | ||
