Cumulus Wiki

Cumulus.ini: Difference between revisions

Cumulus.ini (view source)

Revision as of 11:41, 29 July 2021

2,181 bytes added ,  11:41, 29 July 2021
m
→‎Station specific alternatives: Done all I can
m (→‎Optional Report Settings: Revert description back taking out text about editing a file that is part of release)
Line 4,007: Line 4,007:
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!
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!


 
===Selecting the weather station type determines which options are shown===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 4,053: Line 4,053:


===Airlink===
===Airlink===
The details in this sub-section need to be checked by someone who uses the relevant hardware.


* Introduced Release
* Introduced Release
Line 4,084: Line 4,086:
===Davis===
===Davis===


Two Wiki sub-sections:
Two Wiki sub-sections, that need to be checked by by somebody who uses the relevant functionality:




Line 4,254: Line 4,256:
===EasyWeather (Reading File instead of connecting to a Weather Station)===
===EasyWeather (Reading File instead of connecting to a Weather Station)===


This sub-section is based on what applied for the legacy software, assuming nothing has changed for MX.


* Introduced in a Legacy version
* Introduced in a Legacy version
Line 4,308: Line 4,311:


===Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific===
===Ecowitt GW1000 and Froggit DP1500 (and any equivalents) specific===
{{Template:WorkInProgressBanner}} An Ecowitt user needs to check/update this sub-section, it is understood significant changes are included in 3.12.0 beta builds, but the forum does not give away any details


* Introduced in release 3.2.0
* Introduced in release 3.2.0
Line 4,340: Line 4,345:


===Fine Offset Stations===
===Fine Offset Stations===
{{Template:WorkInProgressBanner}} This table has not been populated yet


* Introduced in a Legacy version
* Introduced in a Legacy version
Line 4,353: Line 4,355:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:100px" | Shown on Settings page?
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
|-
| FOReadAvoidPeriod=3
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| 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)
|-
| ??
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Set the Fine Offset Logger interval to match Cumulus MX interval
| 0 (disabled)
| Simple tick or not - labelled as "Experimental - use with caution"
* Tick (value shown as 1 in Cumulus.ini) for MX to attempt to "update the Davis interval" (I said copy and paste was used from Davis section!) to match the interval MX is using.
* Don't tick (value shown as 0 in Cumulus.ini) for no effect on your weather station
|-
| FineOffsetReadTime=150
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| Request/Read Delay
| 150 (milliseconds)
| Adjust time (in milliseconds) between request for read, and actual attempt to read data via USB
|-
| ProductID=-1
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| USB Product Id (PID)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|-  
|-  
| SyncFOReads=0
| SyncFOReads=0
| Legacy Cumulus
| Only if Fine Offset selected
| Station Settings → Fine Offset Settings
| Synchronise Reads
| Synchronise Reads
| 0 (disabled)
| 0 (disabled)
Line 4,363: Line 4,407:
* 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
* 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
* 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.
|-
| FOReadAvoidPeriod=3
| 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"
# The parameter was added for legacy releases, to try to reduce the occurrence of "lock-up" issues.
|-
# MX uses a different way to interrogate Fine Offset stations, originally ticking this could result in more reads being skipped, than actually processed, potentially updating just a few times a day, so it was best disabled!
!style="width:30px" | Parameter Line Entry
# The MX code relating to this parameter was rewritten 1n 3.11.0, but the developer labels this as an "attempt", so it may still be best to try to manage without enabling this setting
!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
|-
|-
|
| VendorID=-1
| MX release ??
| Only if Fine Offset selected
| Station Settings → Fine Offset Advanced Settings
| USB Vendor Id (PID)
| -1 (default setting)
| Advanced setting if you don't want to leave it to MX to find your HID
|}
|}


Line 4,393: Line 4,424:




{{Template:WorkInProgressBanner}} The following table has some gaps to fill in
{{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station


* Introduced in a Legacy version
* Introduced in a Legacy version
Line 4,454: Line 4,485:




===La Crosse stations===
===LaCrosse stations===






{{Template:WorkInProgressBanner}} The following table has some gaps to fill in
{{Template:WorkInProgressBanner}} The following table has some gaps to fill in, needs a contributor who uses this type of weather station




Line 4,490: Line 4,521:
Oregon Scientific specific
Oregon Scientific specific


{{Template:WorkInProgressBanner}} This table has not been populated yet
{{Template:WorkInProgressBanner}} This table has not been populated yet, needs a contributor who uses this type of weather station


* Introduced for legacy Cumulus
* Introduced for legacy Cumulus
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/9639"