Modules: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
601 bytes added ,  14 November 2023
m
no edit summary
mNo edit summary
== Introduction ==
Modules are the basic building blocks of CumulusUtils. Identifying modules on the commandline they become synonym with commands to CumulusUtils and can be used in a users own website. The [[Website Generator|website]] is not seen as a module but it is the CUtils own aggregate of the modules.
 
== The list of modules ==
CumulusUtils offers the following modules (which can be used as commands):
#[[SysInfo]]
#[[Forecast]]
#[[StationMap]]
#[[UserReports]]
#[[pwsFWI]]
#[[RecordsExtra - Top10Sensors|Top10ExtraSensors]]
#[[Custom Logs]]
#[[Graphs]]
#[[Yadr]]
#[[Records]]
#[[NOAA]]
#[[Forecast]]
#[[StationMap]]
#[[UserReports]]
#[[Records - Top10|Top10]]
#[[Records - DayRecords|DayRecords]]
#[[AirLink]] (before version 6.1 this was [[AirQuality]])
#[[ChartsCompiler]]
#[[MeteoCam]]
#[[Extra Sensors|ExtraSensors]]
#[[UserAskedData]]
 
In addition to the true modules which are equivalent to commands, there are commands which are strictly spoken not modules because they do not comprise a single functionality:
#[[Website Generator|Website]] => generates the website which consists of all modules, the inclusion of the libraries is embedded in website's index.html.
#[[UserAskedData]] => a specific command used for generating JSON datafiles when required by other modules (Compilere.g. ''AirLink'', ''Extra Sensors'' and/or AirLink''CustomLogs'')
#[[Extra Sensors|ExtraSensors]] => a command to generate the ExtraSensors module but which implicitly activates the compiler.
#[[ChartsCompiler|CompileOnly]] => a command which activates the compiler only. This is a very specific command with more than one effect. Please check out its own page.
 
If you use modules but want the resulting server location outside of you main website location (e.g. in a subdirectory CUtils) then please create that directory and set your uploads for CUtils accordingly. To have your website find the specific realtime values (the JSON files) specifically generated for CUtils, than run the [[UserAskedData]] command and set the parameter where to locate those data. In the case as above:
DoModular=true
ModulePath=<path>
''DoModular'' and the command ''Website'' are incompatibe
 
== Javascript libraries ==

Navigation menu