1,651
edits
Extra Sensors: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Operation
m (→Operation) |
m (→Operation) |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
''Extra Sensors'' is a feature already present in Cumulus 1. Ignored for long time by CumulusUtils, with the rise of the [https://www.ecowitt.com/shop/homePage 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'' is a feature already present in Cumulus 1. Ignored for long time by CumulusUtils, with the rise of the [https://www.ecowitt.com/shop/homePage 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. | ||
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. You are advised to use the [[Custom Logs|CustomLogs]] to chart Lightning. | |||
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 | |||
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. | 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. | ||
For External Extra Sensors i.e. sensors the user has available outside the CMX system such as e.g. a Geiger Counter see: [[External Extra Sensors]]. | For External Extra Sensors i.e. sensors the user has available outside the CMX system such as e.g. a Geiger Counter see: [[External Extra Sensors]]. | ||
In CMX version 3.22.0 - b3211 the Custom Logs were introduced, providing the possibility for the user to create their own logfiles for any value - also strings - which CMX produces in a [[Webtags|webtag]]. This called for a procedure in CumulusUtils to handle those logs. In version 6.21.0 this was realised. the [[Custom Logs]] procedure us based on the External Sensors module and has its own wiki page. | |||
=== Dependency === | === Dependency === | ||
| Line 24: | Line 24: | ||
UserModificationExtraSensorCharts=true | UserModificationExtraSensorCharts=true | ||
the charts will no longer be overwritten and the user may modify the generated charts to his own tasting. | the charts will no longer be overwritten and the user may modify the generated charts to his own tasting. | ||
=== Translation/Language === | |||
The translation of of this module is accommodated via two sections in the ''CUstringsXX.ini'' file: ''Compiler'' (most) and ''ExtraSensors'' (some). | |||
You will find all translation tags for the sensor names in the section ''Compiler'' and this includes the three values for the lightning detector although those are not really explicit sensors. This is analogue to all standard plot variables. | |||
The translation tags content for the extra sensor names are defaulted with the extra sensor description texts from ''strings.ini'' when the tags are created in the CUstringsXX.ini and can then be changed by the user. These modifications will be used in subsequent runs for the ''ExtraSensors'' module. As a consequence, the user may choose different descriptions in CMX and in CUtils for the ''Extra Sensors''. | |||
To set back the default values of the tag names - the values in ''strings.ini'' - just remove the tags from the ''CUstringsXX.ini'' file. | |||
== Operation == | == Operation == | ||
#CumulusUtils must be run once with the command ''ExtraSensors'' (fastest) or ''Website'' to create the required parameters in the section ''[ExtraSensors]'' in the inifile. | #CumulusUtils must be run once with the command ''ExtraSensors'' (fastest) 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. | ||
#After the first run the following inifile parameters exist (see below): ''ExtraTemp, ExtraHum, ExtraDP, SoilTemp, SoilMoisture, AirQuality, UserTemp, LeafTemp, LeafWetness''. Filling these with e.g. '''1,2,3''' activates those sensors and a subsequent run will show these under the menu choice ''Extra''. For the lightning sensor the parameter ''LightningSensor=true/false'' (de-)activates that sensor which subsequently is displayed as a normal Extra Sensor in the list. | #After the first run the following inifile parameters exist (see below): ''ExtraTemp, ExtraHum, ExtraDP, SoilTemp, SoilMoisture, AirQuality, UserTemp, LeafTemp, LeafWetness''. Filling these with e.g. '''1,2,3''' activates those sensors and a subsequent run will show these under the menu choice ''Extra''. | ||
#For the CO2 sensor the parameter ''CO2='', a value 0 (or empty ) or 1 (de-)activates that sensor which subsequently is handled as an extra sensor and will be shown under the menu choice ''Extra''. | |||
#For the lightning sensor the parameter ''LightningSensor=true/false'' (de-)activates that sensor which subsequently is displayed as a normal Extra Sensor in the list. The Lichting sensor is currently not charted as it is not logged in the ExtraSensors log. Use the [[Custom Logs|CustomLogs and its module]] for this. | |||
#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'''. | #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'''. | ||
| Line 47: | Line 58: | ||
''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]]<br/> | ||
NOTE: CUtils creates its own JSON data files and does not make use of the CMX ExtraSensors datafiles so you can switch those off and prevent too much bandwidth usage. | |||
There are some translations in the section [ExtraSensors] in the language file. The names of the Extra Sensors given by the user in strings.ini are used through the language file translations in the [Compiler] section. | There are some translations in the section [ExtraSensors] in the language file. The names of the Extra Sensors given by the user in strings.ini are used through the language file translations in the [Compiler] section. | ||
| Line 72: | Line 84: | ||
CleanupExtraSensorslog=false => If true will remove old logfiles and keep only the current and the previous month | CleanupExtraSensorslog=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 | 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 | ||
LightningSensor=false => | LightningSensor=false => If true the Ecowitt Lightning sensor is present and will be presented in the module. | ||
(NOTE that this sensor is not logged by CMX and therefore does not have a corresponding chart, see [[Extra_Sensors#Operation|Operation paragraph]]) | |||
(NOTE that this sensor is not logged by CMX and therefore does not have a corresponding chart) | |||
ExternalExtraSensors= => A comma separated list of strings naming the External Extra Sensors the user wishes to use (See [[External Extra Sensors]]) | ExternalExtraSensors= => A comma separated list of strings naming the External Extra Sensors the user wishes to use (See [[External Extra Sensors]]) | ||
| Line 88: | Line 99: | ||
LeafTemp= => fill with comma separated digits from 1 - 2 | LeafTemp= => fill with comma separated digits from 1 - 2 | ||
LeafWetness= => fill with comma separated digits from 1 - 2 | LeafWetness= => fill with comma separated digits from 1 - 2 | ||
CO2= => fill with 1 | CO2= => fill with 1 | ||
NOTE: For the Ecowitt CO2 sensor to actually show the parameter above is not enough. There must be a value for CO2 in the database.<br/> | NOTE: For the Ecowitt CO2 sensor to actually show the parameter above is not enough. There must be a value for CO2 in the database.<br/> | ||
