Full list of Webtags: Difference between revisions

78 bytes removed ,  12:49, 27 September 2022
m
Line 401: Line 401:
==== Extra Sensors: Ecowitt ====
==== Extra Sensors: Ecowitt ====


Ecowitt stations are sold under other names depending on nation,  e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in this Wiki See also [https://www.wxforum.net/index.php?board=111.0 WXForum.net].
Ecowitt stations are sold under other names depending on nation,  e.g. Ambient in USA, Froggit in central Europe, so Ecowitt is used as a generic name in this Wiki. See also [https://www.wxforum.net/index.php?board=111.0 WXForum.net].


=====Extra Sensors: Ecowitt WH45 CO₂ sensor=====
===== WH45 CO₂ sensor =====


[[File:Badge vMx.png]] Unless otherwise indicated these web tags become available from release 3.9.5.
Available from release 3.9.5.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |Web tag_name
!style="width:150px" |Webtag name
!style="width:600px" |Function
!style="width:600px" |Function
|-
|-
| <#CO2>
| <#CO2>
| The actual CO<small>2</small>concentration in ppm
| The actual CO<sub>2</sub>concentration in ppm
|-
|-
| <#CO2-pm2p5>
| <#CO2-pm2p5>
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<small>3</small> or less
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<sup>3</sup> or less
|-
|-
| <#CO2-pm2p5-24h>
| <#CO2-pm2p5-24h>
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<small>3</small>, or less, 24 hours moving average
| Air Quality expressed in terms of particulate matter of 2.5 μm/m<sup>3</sup>, or less, 24 hours moving average
|-
|-
| <#CO2-pm10>
| <#CO2-pm10>
| Air Quality expressed in terms of particulate matter of 10 μm/m<small>3</small>, or less (yes, this includes the 2.5 figure)
| Air Quality expressed in terms of particulate matter of 10 μm/m<sup>3</sup>, or less (includes the 2.5 figure)
|-
|-
| <#CO2-pm10-24h>
| <#CO2-pm10-24h>
| Air Quality expressed in terms of particulate matter of 10 μm/m<small>3</small>, or less, 24 hours moving average  
| Air Quality expressed in terms of particulate matter of 10 μm/m<sup>3</sup>, or less, 24 hours moving average  
|-
|-
| <#CO2-temp>
| <#CO2-temp><sup>See note</sup>
| Temperature as reported by Air Quality monitor.  
| Temperature as reported by Air Quality monitor.  
Note that this temperature has nothing to do with the temperature as reported by the main weather station. It reflects the temperature of the sensor and would be used in combination with the sensors measured humidity (see next) for correction of the measured PM (particulate matter) value. Determination of how to correct the PM value is highly dependent on the conditions and placement of the sensor. See the specification sheet for the sensor or create some multivariate regression line based on calibration measurements. This is also valid for PM sensors like the AirLink. The normal amateur usage of PM sensors is that the uncorrected values are published.
|-
|-
| <#CO2-hum>
| <#CO2-hum>
Line 436: Line 434:
|}
|}


=====Extra Sensors: Ecowitt WH34 soil and water sensor=====
'''Note''': This temperature reflects the temperature of the sensor and would be used in combination with the sensors measured humidity (see next) for correction of the measured PM (particulate matter) value. This correction is responsibility of the user and is subject to a lot of discussion. Determination of how to correct the PM value is highly dependent on the conditions and placement of the sensor. See the specification sheet for the sensor or create some multivariate regression line based on calibration measurements. This is also valid for PM sensors like the AirLink. The normal amateur usage of PM sensors is that the uncorrected values are published.


Cumulus MX can support the Ecowitt WH34 (other model types exist and are reported here as if WH34) soil and water temperature sensors.
===== WN34 soil and water sensor =====


They are reported as "User Temperture 1" to "User Temperature 8", as listed in the table within next sub-section.
Cumulus MX can support the Ecowitt WN34 (other model types exist and are reported here as if WN34) soil and water temperature sensors. They are reported as "User Temperature 1" to "User Temperature 8".


{| class="wikitable" border="1"
|-
!style="width:150px" | Webtag name
!style="width:600px" | Function
|-
|<#UserTemp1 - 8>
|The temperature of the sensor
|}


=====Extra Sensors: Ecowitt Air quality, leak sensors, lighting detector, and extra temperature sensors=====
===== Divers Extra Sensors =====
 
Below are described the tags resulting from ''Ecowitt Air quality (WH41,WH43,WH45)'', Ecowitt leak sensor (WH55), lighting detector (WH57), and extra temperature sensors (WN34)
[[File:Badge v1.png]] Not available in Cumulus 1.


[[File:Badge vMx.png]] Please see release announcements for when individual web tags became available
This sub-section applies only to those using Ecowitt GW1000 (also Froggit DS1500, and other equivalents, see [[Supported Devices]]) an interface unit that picks up various external sensors and sends the data via an application programming interface to CumulusMX which then generates the following web tags:


This sub-section applies only to those using Ecowitt GW1000 (also Froggit DS1500, and other equivalents, see [[Supported Devices]]) an interface unit that picks up various external sensors and sends the data via an application programming interface to MX which then generates the following web tags:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px" |Web tag_name
!style="width:150px" |Webtag name
!style="width:600px" |Function
!style="width:600px" |Function
|-
|-
Line 462: Line 466:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
!style="width:150px"|Web tag_name
!style="width:150px"|Webtag name
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in the viewer/editor
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in the viewer/editor
|-
|-
|<#AirQuality1>
|<#AirQuality1 - 4>
| Air quality in μm/m<small>3</small> or less
| Air quality in μm/m<sup>3</sup>
|-
|-
|<#AirQuality2>
|<#AirQualityAvg1 - 4>
| Air quality in μm/m<small>3</small> or less
| 24 hr moving average Air quality in μm/m<sup>3</sup>
|-
|-
|colspan="2"|... and so on up to <#AirQuality4>
|<#LeakSensor1 - 4>
|
|-
|-
|<#AirQualityAvg1>
|<#LightningDistance>
| 24 hr running average Air quality in μm/m<small>3</small> or less
|Distance to last strike
Same units as wind run - miles/km/nm. Returns 0.0 if you don't have a sensor, GW1000 api returns max value you can put in a byte - 0xFF which translates to 158.4 miles = 255 km if have sensor but no strike detected yet, so CMX translates that to '----'.
|-
|-
|<#AirQualityAvg2>
|<#LightningTime>
| 24 hr running average Air quality in μm/m<small>3</small> or less
|Date and Time of last strike.
Default without output parameters is locale's short time format e.g. 18:02 or 6:02 pm, without date, but tag accepts both date and time output parameters.
Returns '----' if you don't have sensor or there has not been a strike since the sensor was installed.
|-
|-
|colspan="2"|... and so on up to <#AirQualityAvg4>
|<#LightningSrikesToday>
|Number of lighting strikes today
|-
|-
|<#LeakSensor1>
|<#UserTemp1 - 8>  
|Leak sensor 1 - returns false/true as 0 or 1  
|User Temperature 1 - 8
|}
 
The WH32 produces Temperature, Humidity and Dewpoint tags as the Davis above, WH51 soilmoisture produces similar tags.
 
{| class="wikitable" border="1"
|-
|-
|<#LeakSensor2>
!style="width:150px"|Webtag name
|Leak sensor 2 - returns false/true as 0 or 1
!style="width:600px"|The related description can be changed in 'strings.ini', but below are default descriptions that will be shown in the viewer/editor
|-
|-
|colspan="2"|... and so on up to <#LeakSensor4>
|<#ExtraTemp1 - 8>
|Extra temperature Sensor 1 - 8
|-
|-
|<#LightningDistance>
|<#ExtraDP1 - 8>
|Distance to last strike (same units as wind run - miles/km/nm) (Returns 0.0 if you don't have a sensor, GW1000 api returns max value you can put in a byte - 0xFF which translates to 158.4 miles = 255 km if have sensor but no strike detected yet, so MX translates that to '----')
|Extra dew point Sensor 1 - 8
|-
|-
|<#LightningTime>
|<#ExtraHum1 - 8>
|Date and Time of last strike (default without output parameters is locale's short time format e.g. 18:02 or 6:02 pm, without date, but tag accepts both date and time output parameters). Returns '----' if you don't have sensor or there has not been a strike since the sensor was installed. (GW1000 api returns FFFF FFFF seconds after midnight on 01 Jan 1970, which translates to 07/02/2106 06:28:15, so MX translates that to '----')
|Extra humidity Sensor 1 - 8
|-
|-
|<#LightningSrikesToday>
|colspan="2" style="background:lightgray;"| WH51 soilmoisture sensor
|Number of lighting strikes today
|-
|-
|<#UserTemp1>  
|<#SoilMoisture1 - 8>
|User Temperature 1
|Soil moisture 1 - 8
|-
|-
|colspan="2"|... and so on up to <#UserTemp8> = User temperature 8
|}
|}