1,651
edits
Extra Sensors: Difference between revisions
m
→Operation
m (→Introduction) |
m (→Operation) |
||
| Line 12: | Line 12: | ||
== Operation == | == Operation == | ||
The operation requires two steps: | CumulusUtils must be run once with the command ''ExtraSensors'' or ''Website'' to create the required parameters in the section ''[ExtraSensors]'' in the inifile. | ||
#creating the Extra Sensor page and dashboard to be used by the generated website | |||
#creating the datafile to be used by the Extra Sensor page. CumulusMX does not produce a JSON datafile for the Extra Sensors | The module requires that the user has ''Extra Sensor'' logging enabled in CumulusMX(''CMX menu=>Station Settings=>Common Options=>Log Extra sensors'' must be enabled). | ||
AND the user must set the parameter ''ExtraSensors'' in the cumulusutils.ini file to ''true''. This last parameter makes it possible to have ''Extra Sensors'' operational in CMX but not display them on the web (if you are generating the website). | |||
Once both parameters are set to true the module is active. | |||
For the [[Website_Generator|Website Generator]] this means everything is automatically available in the menu of the website. When used as a module it means the user can make use of the Sensor values as plotvariables in the [[ChartsCompiler]]. When using the module output (''extrasensors.txt'') in any other website it is required to have: | |||
<div></div> to automatically accept the table with the values | |||
<div><div> to automatically accept the charts. | |||
The module only contains some styling and some javascript. | |||
To receive the data for the ExtraSensors you have to run ''CumulusUtils [[UserAskedData]]''. It would be logical to do this on the normal FTP frequency on which all other chart data are generated by CMX and by the requirements of the [[ChartsCompiler]] and the [[AirLink]] module. | |||
Finally, to make it work and to bring system in the ''Extra Sensors'', '''it is required''' for the user to use strings.ini (copy it from samplestrings.ini in the distribution of CumulusMX) in the CumulusMX directory and give the sensors you want to be handled by CumulusUtils a short meaningfull name. Existing Sensors which keep their default names will be displayed in the CMX interface but will not be used by CumulusUtils. | |||
Internally, the operation requires two steps: | |||
#creating the Extra Sensor page and dashboard to be used by the generated website (when used as a module the user has to create the required <div>'s to receive the informations). | |||
#creating the datafile to be used by the Extra Sensor page. CumulusMX does not produce a JSON datafile for the Extra Sensors, CumulusUtils produces its own datafile to be able to display all possible sensors. | |||
The commands for the above named steps are: | The commands for the above named steps are: | ||
''utils/bin/cumulusutils.exe ExtraSensors'' => this command includes the following step to create the | ''utils/bin/cumulusutils.exe ExtraSensors'' => this command includes the following step to create the module files (see output) | ||
and: | and: | ||