5,838
edits
Cumulus.ini: Difference between revisions
m
Resequence
m (→Optional Web Server: added) |
m (Resequence) |
||
|
* File Section is [NOAA]
Rainfall equivalents of mean temperature described above
| (blank)
| Can be used to add a link to any other web page, you have on any web server. In default web pages will be labelled as "web cam", but for your own web pages, this might lead to a home or blog page.
|}
==Program Start-up Options==
* Introduced release 3.9.4 - b3099
* File Section is [Program]
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|StartupPingHost=
| Program Settings → Program Start-up Options
|Host to PING on program start-up
|None (no remote host)
| Add a hostname or IP to address to ping at startup. Cumulus waits until the ping is successful before trying to read from your station. Leave blank to disable
|-
|StartupPingEscapeTime=999
|PING escape time (mins)
|999 (minutes)
|Specify a time after which if no ping response is received carry on starting Cumulus MX anyway
|-
|StartupDelaySecs=0
|Start-up Delay (secs)
|zero (no delay)
|Add a delay before the Cumulus tries to start reading the station.
|-
|StartupDelayMaxUptime=300
|Max system uptime to apply the start-up delay
|300 (seconds equivalent to 5 minutes)
|The time that has passed sice MX was started (up-time) is compared against the (max delay time) figure here.
*If max delay time less than up-time, the delay specified in previous parameter will NOT be applied
*If up-time less than this max delay time, then MX will apply any delay specified in previous parameter
*If this parameter is set to zero, then MX will always apply any delay specified in previous parameter
|}
==Station specific alternatives==
A number of settings are shown only for specific station types, and so the following tables are grouped here.
Since MX is being developed by someone who uses a Davis station, a lot of "Labels on the Settings Screens" mention "Davis" even if you have selected a different station, because the code was written by copy and paste!
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | File Section
!style="width:100px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|Type= -1
| [Station]
| 0 (all releases), 1 (Early legacy releases), 2 and 3 (from version 1.7.0), 4 (from version 1.7.12), 5 (from version 1.8.0), 6 (from version 1.8.3), 7 (from version 1.9.1), 8 to 10 (from release 1.9.2), 11 (from a MX beta build), and 12 (from release 3.2.0)
| Station Settings → General Settings
| Station type
| Drop-down
* -1 = "Select Station", shown before a selection from those below is made
* 0 = Davis Vantage Pro station
* 1 = Davis Vantage Pro2 or Vue station
* 2 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wireless connection (e.g. WMR-928 station)
* 3 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) which have a serial port connection and have wired connection (e.g. WM-918 station)
* 4 = Reading from file [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |EasyWeather.dat]] (using EasyWeather software version 6.2, or earlier, running continuously with Cumulus). Fine Offset weather stations that record Solar and UV measurements output to [[EasyWeather_Format#EasyWeatherPlus.dat| EasyWeatherPlus.dat file]] when Easyweather software version 6.x is running. This has the same fields as easyweather.dat, plus two extra fields for Solar and UV data at the end, and so Cumulus can understand the fields you must also have '''LogExtraSensors=1''' set.
'''NOTE:''' You can also use ''Type=4'' if you want to run Cumulus with reduced functionality without a weather station attached, to view historical observations. A full set of (historic) files in the ''data'' subfolder copied from a system with a weather station attached is needed, but in this case, the [[#Introduced for problems with Fine Offset family:| EWFile= ]] attribute should be at its default of not having any filename value.
* 5 = Fine Offset, Maplin, Chas Olsen, MyDEL, Nevada, Watson, Tycon Power, Aercus, etc as defined in [[Supported_Devices#Fine_Offset|Fine Offset section in Supported_Devices article]] ('''without''' solar measurement sensors (with or without solar recharging))
* 6 = For all La Crosse WS23xx models e.g. WS2300
* 7 = Fine Offset/Watson/MyDel etc '''with Solar Sensors''' as defined in [[Supported_Devices#Fine_Offset_with_UV/Light sensor|Fine Offset with UV/Light sensor in Supported_Devices article]].
* 8 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR100
* 9 = Oregon Scientific stations and similar re-badged stations (Huger, Radio Shack etc) using [[WMR100-200_Protocol]] e.g. WMR200
* 10 = Instromet (with optional extra solar sensors or without)
* 11 = Davis WLL
* 12 = Ecowitt GW1000 and Froggit DP1500 (and any equivalents)
'''Selection made here determines what MX sections appear on the Station Settings page
|-
| Model=
| [Station]
| Early legacy version
| Station Settings → General Settings
| Station model
| (empty)
|The weather station model description that you want output by the web tag <#stationtype>
|}
===Airlink===
* Introduced Release
* File Section is [AirLink]
* Not Shown on Settings page?
IsWllNode=0
WLv2ApiKey=
WLv2ApiSecret=
AutoUpdateIpAddress=1
In-Enabled=0
In-IPAddress=0.0.0.0
In-WLStationId=-1
In-Hostname=
Out-Enabled=0
Out-IPAddress=0.0.0.0
Out-WLStationId=-1
Out-Hostname=
AQIformula=0
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|
|}
===Davis===
Two Wiki sub-sections:
====Davis VP/VP2/Vue====
{{Template:WorkInProgressBanner}} This table does not yet have all details in it.
* Introduced for leagacy Cumulus
* File Section is [Station]
* Only "Shown on Settings page" if either "Type=0" or "Type=1"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|VP2SleepInterval=500
|
|500 (milli-seconds)
|the period which Cumulus waits between reads of the data from Davis stations, the value is in milliseconds.
* if you suspect that data is being missed, reduce number
*For VirtualVP users, tests revealed that VP2SleepInterval = 1100 seems to work the best. It updates every two seconds with few exceptions.
|-
|VPClosedownTime=x
|
|(default not yet documented)
| x is the number of seconds after the start of the re-connect attempts that you want the program to close itself
|-
|DavisCalcAltPress=1
|
|1
|Davis stations calculate Sea Level Pressure (SLP) from Station Pressure (SP) using a formula based on temperature, humidity, and altitude
CWOP require 'Altimeter Pressure' (AP) to be uploaded, i.e. a value calculated simply using altitude.
*0 = Use SLP supplied by Davis
*1 = Convert the SP Davis supplies to AP using the altitude you have supplied.
|-
|SyncDavisClock=0
|
|0
|When set, at Cumulus start-up and at a fixed time (default 04:00, see next parameter) each day, Cumulus will set the Davis VP/VP2 clock to within a minute of the same time as the PC. (From build 3015 for MX).
*0 = Disabled, default (as deselected on the Station Configuration Screen)
*1 = Enabled, ensures that when Cumulus asks the station for data since time X, both recognise X!
|-
|ClockSettingHour=4
|
|4
|Controls what hour of the day the SyncDavisClock activity will take place if it is enabled.
*4 = 04:00 (default value)
*0-23 = 00:00 to 23:00
|-
|VP2ConnectionType=1
|
|
|Weather station connection type
*0 = serial (see next parameter to specify COM port)
*(1 = usb - setting no longer available on screen, remains as default in cumulus.ini for those not using a Davis)
*2 = TCP/IP (see later parameters to specify ports)
Default is type 1, i.e. neither option on screen selected, so if you use a Davis you must select either serial or TCP/IP.
|-
|VP2TCPPort=22222
|
| 2222
|Communications port used if VP type has TCP/IP selected.
|-
|VP2IPAddr=0.0.0.0
|
| 0.0.0.0
|Weather station IP address if VP type has TCP/IP selected.
|-
|VP2PeriodicDisconnectInterval=0
|
|0 (disable)
|When the clock minute changes, Cumulus stops the current stream of data from the console, disconnects, waits for the specified number of milliseconds, to allow the Weatherlink IP to briefly connect to the Davis Weatherlink site. Cumulus then attempts to reconnect.
Set it to zero to disable, if you are not using the Weatherlink site.
|-
|LogExtraSensors=0
|
|0
|This is set in the '''Settings''' block on the Station settings screen off the configuration menu. Set this to 1 if you have additional sensors (e.g. a Davis Leaf Wetness probe) to make Cumulus read, display, and log the readings from the sensors. You don't select this for Solar/UV sensors.
|-
|UseDavisLoop2=1
|
|1 (use Loop2)
|The current MX code uses ''LOOP2'' for two purposes. First, it uses the 'peak 10-minute gust' value, to avoid the problem where a gust might be missed, and secondly it uses the 'absolute pressure' value to make calculation of 'altimeter pressure' easier and more accurate. This is mainly used if you upload to CWOP.
*1 (default) = Cumulus MX will use the LOOP2 packet for Davis Weather Stations by default. The LOOP2 packet is supported on the VP2 with firmware version 1.90 or later, and on the Vue.
*0 = Select this if you have a Vantage Pro (i.e. the original 'VP1'), or a VP2 with pre-1.90 firmware, or if you are using Virtual VP, none of these support the LOOP2 packet.
Without this setting, Cumulus will revert to calculating the 10-minute gust value itself from the individual wind speed readings, but it will not currently attempt to calculate altimeter pressure correctly, it will simply use the sea-level pressure instead. This is likely to be an issue if you are at high altitude and you upload to CWOP using Cumulus MX.
|-
|DavisIPResponseTime=500
|
|500
|The length of time in milliseconds which Cumulus waits to allow a response from the console to a command (i.e. a request for any kind of data) from an IP logger, see Cumulus MX forum where times up to 2000ms are suggested.
|-
|ForceVPBarUpdate=0
|
|0 (normal)
| Added in build 3042 (January 2017).
The default (value=0) is to assume standard barometer updates on Davis stations. Set to 1, by adding ForceVPBarUpdate=1 in [Station] section to force more frequent barometer updates on Davis stations. Steve says "Having checked the code, I see it asks for 20 packets from the 'LOOP2' if the barometer forcing is on, otherwise it stops receiving LOOP data after 50 packets". Note that ForceVPBarUpdate=1 is only useful on very old versions of the console firmware.
|-
|DavisIncrementPressureDP=0
|
|1
|(from version 3.0.0 build 3042)
* 0= Pressure values shown to 1 decimal places when reported in mb/hPa, shown to 2 decimal places for inHg
* 1= Pressure values shown to 2 decimal places when reported in mb/hPa, shown to 3 decimal places for inHg
|-
|VPrainGaugeType=0
|
|1
|Specifies the units selected on your Vantage Pro Rain Gauge.
*0 = Metric Rain Adapter fitted, a 0.2mm gauge
*1 = Imperial gauge without adapter, a 0.01" gauge.
Note that if the units you choose for rainfall do not match your rain gauge type, conversion rounding errors will then occur.
|-
|DataLogging=0
|
|0
|(Build 3018 onwards).
*0 (default) = Cumulus MX will not add extra logging.
*1 = To add extra logging to the diags file for data received from Davis stations. Use this with care, the log will get very large.
I've also added some more diagnostics to try to find the cause of the problem where data stops being read from Davis stations. Debug logging is required to be turned on. (Build 3022 onwards).
|-
|AutoUpdateIpAddress=1
|
|1
|default = 1, set to 0 to switch off the WLL autodetection of IP address. This is a workaround for a WLL firmware bug that does not update the IP address when it changes using DHCP.
|-
|ZeroConfig
|
|(default not known)
|set this on station settings screen; to enable/disable the entry/update of the stations IP address via auto-discovery
|}
====Davis WeatherLink Live====
{{Template:WorkInProgressBanner}} This table has not been populated yet
* Introduced in a MX beta build
* File Section is [WLL]
* Only "Shown on Settings page" if "Type=11"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|
|
|
|
|}
===EasyWeather (Reading File instead of connecting to a Weather Station)===
* Introduced in a Legacy version
* File Section is [Station]
* MX Section is "EasyWeather File Settings"
* Only "Shown on Settings page" if "Type=4"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
| EWInterval=10
| File Read Interval
| 10 (minutes between new line becoming available in file)
| Cumulus needs to know how often to read a new record from the easyweather.dat file. Enter any number in box.
*0= Default, meaning not applicable
*n= any positive decimal value representing Easyweather version 6.2, or earlier, logging interval in minutes (used for reading single latest observations from [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather]] software output). Note to specify seconds, use decimal minutes, e.g. 30 seconds = 0.5
|-
| EWFile=
| Filename
| (empty)
| * Full file path/name for [[EasyWeather_Format#Usage_of_easyweather.dat_fields_for_Cumulus_input_of_latest_record: |Easyweather.dat or EasyWeatherPlus.dat]]
* (empty) (i.e. attribute and equals sign, but no value) '''Note:''' If you want to run Cumulus without an attached weather station (because your station has a fault or because you have a second PC), it is possible to run Cumulus with station '''Type=4''' but with the default of no file specified in this parameter. The full Cumulus directory structure and its files including those in the ''data'' sub-directory are needed (kept from when your station was working or copied from the PC with the station). Although only the old observations can be accessed, (no new ones are being added), this does allow analysis of the old observations via all Cumulus features
See [[FAQ#Cumulus_isn.27t_performing_periodic_tasks.2C_like_data_logging_or_web_uploads|FAQ here]] for reduced functionality using Cumulus 1 in this way.
|-
| EWminpressureMB=900
| Minimum Pressure Value
| 900
| Cumulus will ignore all pressure readings from the station that are less than this value (units are always hPa/millibars)
|-
| EWmaxpressureMB=1200
| Maximum Pressure Value
| 1200
| Cumulus will ignore all pressure readings from the station that are greater than this value (units are always hPa/millibars)
|-
| EWMaxRainTipDiff=40
| Rain Tip Difference
| Default=30 tips in Cumulus 1, MX default is 40 tips
| This configurable threshold is the maximum feasible amount of rain between updates (i.e. within 48-seconds on Fine Offset stations without solar, 60 seconds on those measuring solar), set in units of count of tips.
For standard Fine Offset rain gauges, each tip represents 0.3mm, so 30 tips are equivalent to 9 mm, or just over a third of an inch in 48 seconds.
This setting affects rain rate, rain last hour, rain so far today (and what is recorded in today.ini/dayfile.txt), but does not affect the web tag <#r24hour>.
|-
| EWpressureoffset=x.y
| Pressure Offset
| 9999
| The pressure that Cumulus MX processes is equal to what read in the file plus the value set for this parameter. Normally used to convert the station pressure to the equivalent Sea Level Pressure.
|}
===Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific===
* Introduced in release 3.2.0
* File Section is [GW100]
* MX Section is "Ecowitt GW1000 Settings"
* Only "Shown on Settings page" if "Type=12"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|AutoUpdateIpAddress=1
|Auto-discovery
|1 (selected)
|Should MX attempt to discover IP address
*0=Disable
*1=Enable
|-
|IPAddress=
|IP address
|(no default)
| stores the IP address of your GW1000 WiFi logger
|-
|MACAddress=
|MAC addresss
|(no default)
|Populated by MX when auto-discovery enabled
|}
===Fine Offset Stations===
{{Template:WorkInProgressBanner}} This table has not been populated yet
* Introduced in a Legacy version
* File Section is [Station]
* MX Section is "Fine Offset Settings"
* Only "Shown on Settings page" if either "Type=5" or "Type=7"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|
| Synchronise Reads
| 0 (disabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to work out when your Fine Offset is writing data to the console log, so that MX does not read the Fine Offset circular memory when it is being updated
* Don't tick (value shown as 0 in Cumulus.ini) for MX to read the Fine Offset circular memory whenever it next wants data
Selecting this parameter has given some problems in earlier MX builds, so the code has recently been rewritten.
|-
|
| Read Avoid Period
| 3 (seconds)
| If previous setting enabled, MX will avoid reading the circular memory from the number of seconds specified before it expects Fine Offset to be writing to the circular memory, to the number of seconds specified after it expects Fine Offset to be writing to the circular memory
(One issue is that Fine Offset will move from one position to the next position in the circular memory, at the Fine Offset Logging Interval, but will delay this move by up to one minute, if the existing memory position is actually being updated by a read from the sensors and normally those updates happen every 40 seconds for non-solar sensors, and every 60 seconds for solar sensor)
|}
{{Template:WorkInProgressBanner}}
There are a number of settings in a MX sub-section called "Fine Offset Advanced Options". These are new settings, and have not been documented yet.
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|
|}
===Instromet Settings===
{{Template:WorkInProgressBanner}} The following table has some gaps to fill in
* Introduced in a Legacy version
* File Section is [Station]
* MX Section is "Instromet Settings" or "Instromet Advanced Options" as indicated
* Only "Shown on Settings page" if either "Type=5" or "Type=7"
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
| ComportName=xxxxxx
| Station Settings → Instromet Settings
| Serial port name
| /dev/ttyUSB0 (on Linux), COM1 (on Microsoft Windows)
| Only required if your station is connected via a real, or virtual, serial port
|-
|ImetBaudRate=19200
| Station Settings → Instromet Settings
| Serial Baud Rate (DavisBaudRate)
| 19200
| Some ?older? Instromet loggers operate at 115200, if you have one of these older loggers you will need to reset this value
|-
| "SyncDavisClock=0" and "ClockSettingHour=4"
| Station Settings → Instromet Advanced Options
| "Sychronise Station Clock" and "Clock sync hour"
| Tick box not selected, data box set to 4
| Note despite the name of the parameter within 'Cumulus.ini', this does apply to Instromet stations.
*Simple tick or not
** Tick (value shown as 1 in Cumulus.ini) for MX to attempt to sychronise the Instromet Station Clock with your computer time. This ensures that when Cumulus asks the station for data since time X, both recognise X as representing same time!
** Don't tick (value shown as 0 in Cumulus.ini) if you don't want MX to attempt to keep station clock in line with computer clock
* Box taking an integer
** The hour of the day when, if enabled, Cumulus will set the Instromet clock to within a minute of the same time as the computer. This will happen at a default time of 04:00 each day, (4 a.m.) unless the setting box is edited
|-
| ImetUpdateLogPointer=1
| Station Settings → Instromet Advanced Options
| Update logger pointer
| 1 (enabled)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) for MX to update the memory pointer to the last record after every 30 data reads
* Don't tick to disable this action
|-
|ImetWaitTime=500
| Station Settings → Instromet Advanced Options
| Delay between sending data read commands
| 500
| Specifies the time in milliseconds that Cumulus waits after one read, before it does the next read from an Instromet station. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
|-
| ImetReadDelay=500
| Station Settings → Instromet Advanced Options
| Delay after sending a command before trying to read data from the serial port
| 500
| Specifies the time in milliseconds that Cumulus allows after sending a command before it tries to read data on the serial port. According to the specification, 500 ms is the absolute maximum time that the station should take to respond to any command. For Cumulus 1, the default was 200 milli-seconds, so you might try that too.
|}
===WM918/WMR928 Settings===
Oregon Scientific specific
{{Template:WorkInProgressBanner}} This table has not been populated yet
* Introduced for legacy Cumulus
* File Section is [Station]
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|}
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[Station]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in Station section
|-
|Humidity98Fix=0
|
|0 (disable)
|Applies to weather station types that never report more than 98% relative humidity.
*0 = Disabled (default)
*1 = Enabled, humidity displayed and recorded as 100% if your sensor registers a relative humidity of 98%. Normally only useful for Oregon Scientific stations.
|-
|LogExtraSensors=0
|
|0 (disable)
|This setting determines whether MX looks for readings from extra temperature probes etc.
*0=Disabled (default)
*1= Enabled - Used for Oregon Scientific WMR-928 and similar stations if you have additional sensors (e.g. another temperature probe) to make Cumulus read, display, and log the readings from those sensors. You don't use this for Solar/UV sensors..
|-
|WMR928TempChannel=N
|
|(no default)
|for WMR-928 stations (and other serial stations using the same protocol, eg WMR-968) to use an 'extra' channel (see previous parameter) as your main temperature sensor, set N to the required channel
|-
|WMR200TempChannel=N
|
|(no default)
|for WMR200 stations (and any other Oregon Scientific USB stations which work with Cumulus, e.g. WMR100) to use an 'extra' channel as your main temperature sensor, set N to the required channel
|}
| |||