Extra Sensors: Difference between revisions

201 bytes added ,  17:22, 17 September 2021
m
Line 16: Line 16:
#CumulusUtils must be run once with the  command ''ExtraSensors'' or ''Website'' to create the required parameters in the section ''[ExtraSensors]'' in the inifile.
#CumulusUtils must be run once with the  command ''ExtraSensors'' or ''Website'' to create the required parameters in the section ''[ExtraSensors]'' in the inifile.
#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.  
#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.  
#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'''. Leave the default value or remove the default value to make an empty string to have CumulusUtils ignore the sensor. '''Default value or empty define a sensor as NOT PRESENT.''' Existing sensors which keep their default names will be displayed in the CMX interface but will not be used by CumulusUtils.
#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'''. Leave the default value or remove the default value to make an empty string to have CumulusUtils ignore the sensor. '''Default value or empty define a sensor as NOT PRESENT.''' Existing sensors which keep their default names (or have empty entries) will be displayed in the CMX interface but will not be used by CumulusUtils.


For the [[Website_Generator|Website Generator]] this means everything is automatically available in the menu of the website.
For the [[Website_Generator|Website Generator]] this means everything is automatically available in the menu of the website.
The ''extrasensorsrealtime.txt'' file needs to be processed in the CMX ''Extra Webfiles'' utility and send to the webroot on the realtime frequency.


Using as a module requires some additional editing to make use of the table with the current values (Note [[Modules#Javascript_libraries|the libraries]] as well). The charts are always available (see outputs). It is advised not to use this module outside the context of the [[Website_Generator|Website Generator]] but skilled users can use the module as the basis for their own website (as has been done with AirLink and other modules).
Using as a module requires some additional editing to make use of the table with the current values (Note [[Modules#Javascript_libraries|the libraries]] as well). The charts are always available (see outputs). It is advised not to use this module outside the context of the [[Website_Generator|Website Generator]] but skilled users can use the module as the basis for their own website (as has been done with AirLink and other modules).
Line 25: Line 27:


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 module files (see output)
   ''utils/bin/cumulusutils.exe ExtraSensors CompileOnly''        => this command creates the outputfiles.
or:
  ''utils/bin/cumulusutils.exe website''


and:
and:
   ''utils/bin/cumulusutils.exe [[UserAskedData]]''   => this command produces the ExtraSensors datafiles with only those data required for the present and activated sensors.
   ''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]]
NOTE: [[UserAskedData]] is typically used in an interval through the scheduler. See also the [[AirLink]] and the [[ChartsCompiler]]