1,651
edits
Modules: Difference between revisions
m
no edit summary
mNo edit summary |
|||
| Line 1: | Line 1: | ||
== Introduction == | == Introduction == | ||
Modules are the basic building blocks of CumulusUtils. Identifying modules on the commandline they become synonym with commands to CumulusUtils. | 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 == | == The list of modules == | ||
CumulusUtils offers the following modules (which can be used as commands): | CumulusUtils offers the following modules (which can be used as commands): | ||
#[[SysInfo]] | #[[SysInfo]] | ||
#[[pwsFWI]] | #[[pwsFWI]] | ||
#[[ | #[[Extra Sensors|ExtraSensors]] | ||
#[[Custom Logs]] | |||
#[[Graphs]] | #[[Graphs]] | ||
#[[Yadr]] | #[[Yadr]] | ||
#[[Records]] | #[[Records]] | ||
#[[NOAA]] | #[[NOAA]] | ||
#[[Forecast]] | |||
#[[StationMap]] | |||
#[[UserReports]] | |||
#[[Records - Top10|Top10]] | |||
#[[Records - DayRecords|DayRecords]] | #[[Records - DayRecords|DayRecords]] | ||
#[[AirLink]] (before version 6.1 this was [[AirQuality]]) | #[[AirLink]] (before version 6.1 this was [[AirQuality]]) | ||
#[[ChartsCompiler]] | #[[ChartsCompiler]] | ||
#[[ | #[[MeteoCam]] | ||
#[[UserAskedData]] | #[[UserAskedData]] | ||
| Line 23: | Line 25: | ||
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: | 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. | #[[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 ( | #[[UserAskedData]] => a specific command used for generating JSON datafiles when required by other modules (e.g. ''AirLink'', ''Extra Sensors'' and ''CustomLogs'') | ||
#[[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. | #[[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 == | == Javascript libraries == | ||