Extra Sensors

NOTE: Under construction / module not released yet

Introduction

Extra Sensors is a feature already present in Cumulus 1. Ignored for long time by CumulusUtils, with the rise of the Ecowitt ecology and the support of CumulusMX for the GW1000 (and higher) devices, it has been decided to make Extra Sensors a standard module of CumulusUtils.

Extra Sensors have a certain complexity because, although handled by CumulusMX, they are kind of anarchic: unregulated, CumulusMX does not care, when detected they are always displayed only logged when logging is switched on and then not all of them are logged. There are more webtags than logged sensors etc... This complexity made some additional handling necessary.

For the obvious reason of the absence of a log, the lightning sensor will be ignored by CumulusUtils as are additional sensors which can not be logged (like e.g. LeafTemp3 and 4).

Please read the paragraph operation carefully and report any difficulty in operating the module both in this Wiki, from within the website or otherwise. I think all cases are covered but you never know.

Operation

1. CumulusUtils must be run once with the command ExtraSensors or Website to create the required parameters in the section [ExtraSensors] in the inifile.
2. 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.

1. 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.

For the Website Generator this means everything is automatically available in the menu of the website. Using as a module requires some additional editing to make use of the table with the current values (Note the libraries as well). The charts are always available (see outputs).

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.

The commands for the above named steps are:

 utils/bin/cumulusutils.exe ExtraSensors         => this command includes the following step to create the module files (see output)

and:

 utils/bin/cumulusutils.exe UserAskedData    => this command produces the ExtraSensors datafiles with only those data required for the present and activated sensors.

NOTE: UserAskedData is typically used in an interval through the scheduler. See also the AirLink and the ChartsCompiler

Output

The Extra Sensors module has multiple outputs:

1. extrasensors.txt => contains the activation code for the module, activated by the menu choice
2. extrasensorscharts.txt => contains the charts which go with the extra sensors (analogue to the trend charts produced by CMX with the same periodic generation and the same period shown)
3. extrasensorsrealtime.txt => contains the webtags for the current value of the Extra Sensors used. Has to be entered in Extra Webfiles as source to be processed end FTP'd to the webroot at realtime.
4. extrasensorsdata.json => contains all data for the extra sensors specified (by the command utils/cumulusutils.exe UserAskedData.

In addition the module produces a menu item SC map which, when clicked, activates sensorcommunity.txt which is also output of this module. This loads the global map of sensor.community centered on the coordinates of the users weather station. The user may wish to upload his/her data to the sensor.community project which is beyond the scope of CumulusUtils and CumulusMX.

The user can optionally create the charts himself by setting the parameter UserModificationExtraSensorCharts to false.
The outputfile for the charts MUST always be extrasensorscharts.txt.

Inifile Parameters

The Extra Sensor module has the following inifile parameters (see cumulusutils.ini):

 [ExtraSensors]
 ExtraSensors=false                       => If false the module is skipped, no menu entry will be made
 ParticipatesSensorCommunity=false        => If false, the menu option SC map will not be generated
 CleanupExtraSensorLogs=false             => If true will remove old logfiles and keep only the current and the previous month
 UserModificationExtraSensorCharts=false  => If true the Extra Sensor charts will not be overwritten in CutilsCharts.def and give the user the possibility to create his own charts