Cumulus.ini (MX 3.0.0 to 3.7.0): Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (MX 3.0.0 to 3.7.0) (view source)

Revision as of 08:12, 17 July 2021

1,064 bytes added ,  08:12, 17 July 2021
m
Undo revision 9422 by Sfws (talk)
m (Undo revision 9422 by Sfws (talk))
Tag: Undo
 
(5 intermediate revisions by the same user not shown)
Line 2: Line 2:
[[File:Crystal Clear info.png|40px]] This page was last updated for the MX release in July 2020; that is no longer latest!
[[File:Crystal Clear info.png|40px]] This page was last updated for the MX release in July 2020; that is no longer latest!


Appeal to contributors: Please work through all MX release announcements and work out any updates needed for this page
Information on this page was originally on a page called "Cumulus.ini", it has been moved to this new page because the information now only applies if you are using Cumulus MX beta release 3.0.0 or Mark's releases up to 3.7.0
</div>
</div>




[[File:Badge vMx.png]] This page now only applies if you are using Cumulus MX beta release 3.0.0 or Mark's release up to 3.9.7.
[[File:Badge vMx.png]] The accuracy/completeness of information on this page is not guaranteed, except for those entries made by the developer.


The main [[Cumulus.ini]] page is now only for 3.10.1 onwards.
For release 3.8.0 and later, you should read the newest [[Cumulus.ini]] page.


The information for the legacy Cumulus has been moved to the new [[Cumulus.ini (Cumulus 1)]] page.
The information for the legacy Cumulus has been moved to the new [[Cumulus.ini (Cumulus 1)]] page.
Line 96: Line 96:
When you download Cumulus MX, ''there is no configuration file included in the download''. So when you first use the software,  you will need to enter some settings, and that will lead to creation of the main configuration file.  How to enter these minimum settings will be described next.
When you download Cumulus MX, ''there is no configuration file included in the download''. So when you first use the software,  you will need to enter some settings, and that will lead to creation of the main configuration file.  How to enter these minimum settings will be described next.


 
# If you start Cumulus MX without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this: [[File:MX first start.PNG]]
#If you start Cumulus MX without a configuration file, and you have a screen attached so you can see the output from the engine, it will show this: [[File:MX first start.PNG]]
# As you can see, it is running, but it does not know what station type, so it cannot connect to it, and will not do anything more.
#As you can see, it is running, but it does not know what station type, so it cannot connect to it, and will not do anything more.
# At this stage, MX creates a very basic Cumulus.ini with the default settings (shown below).
# At this stage, MX creates a very basic Cumulus.ini with the default settings (shown below).
#Open the [[MX Administrative Interface|admin interface]], and select the station settings if necessary: [[File:MX_station_settings.png|800px|center]]
#Open the [[MX Administrative Interface|admin interface]], and select the station settings if necessary: [[File:MX_station_settings.png|800px|center]]
#At the very minimum, you must select a station type and units (as shown in image here)
# At the very minimum, you must select a station type and units (as shown in image here)
#Optionally, move down the page, entering more settings, or move to other settings pages accessed from the menu seen in the image
# Optionally, move down the page, entering more settings,
# Optionally create a [[Strings.ini]] file (look up the cross reference if you want to do this now, but you can leave it to later) where you can tailor a number of texts that Cumulus produces.
#* The settings that are displayed to you vary depending on the station type you have selected (and the particular MX release), so there is not a screenshot to show you the other settings for your station type.
# If you have a screen attached to the device running the MX engine, you can click in that screen and terminate Cumulus MX. Otherwise do whatever is needed to end the MX executable on your installation. This is the action that will create the main configuration file.
# Optionally, move to other settings pages accessed from the menu seen in the image, these cover the optional functionality of MX, so the pages you need to visit depends on what functionality you wish to use.
#Restart Cumulus MX, it will save your settings on exit, it will read your new settings on re-starting, it will find the weather station, and start reading the weather data from it. On this first access to your weather station, it will not read any archive data (there is a way to modify [[today.ini]] so it can read what is in the separate logger), it will read (and from time to time log) the live data while MX remains running.
# Optionally, use [[Samplestring.ini]] file as a guide to create a [[Strings.ini|strings.ini]] file (look up the cross reference if you want to do this now, but you can leave it to later) where you can tailor a number of texts that Cumulus produces.
#* The advantage of creating your '''strings.ini''' file now, is that it is read when MX starts, and we will shortly restart MX.
# Closing MX is the action that will create the main configuration file.
# MX must be stopped correctly, because it has to do a number of actions after it receives a request to close:
#* If you have a screen attached to the device running the MX engine, you can click in that screen and terminate Cumulus MX by typing '''C''' while holding down the control key (or equivalent if you are using an apple mac).
#* If you are connecting to MX from a remote device, then type into that remote session the control '''C'''.
#* Otherwise do whatever is needed to end the MX executable on your installation.  
# Restart Cumulus MX, it will read your new settings (in '''Cumulus.ini''' and the optional '''strings.ini''') on re-starting, it will find the weather station, and start reading the weather data from it. On this first access to your weather station, it will not read any archive data (there is a way to modify [[today.ini]] so it can read what is in the separate logger), but from now (until you stop it) it will read (and from time to time log) the live data while MX remains running.


====Default Cumulus.ini====
====Default Cumulus.ini====
Line 427: Line 433:
Note in particular, that some settings (such as units, date/time formats) must be got right first time. If you do change those later, it is a lot of work because you will need to edit all the other files that Cumulus creates to reflect those changes.
Note in particular, that some settings (such as units, date/time formats) must be got right first time. If you do change those later, it is a lot of work because you will need to edit all the other files that Cumulus creates to reflect those changes.


For Cumulus MX, if it is being run for the first time and it does not inherit a file, it needs some settings before it can do anything.  Consequently, MX just hangs, because unless you look at the Terminal output or the file it creates in [[MXDiags_folder]], you won't know it is waiting for settings. You need to start up the[[MX_Administrative_Interface| Administrative Interface]] and go into the various settings pages yourself to select what MX needs to continue to work. You then need to stop MX so it stores those settings and can use them next time it starts.  
For Cumulus MX, if it is being run for the first time and it does not inherit a file, it needs some settings before it can do anything.  Consequently, MX just hangs, because unless you look at the Terminal output or the file it creates in [[MXdiags_folder]], you won't know it is waiting for settings. You need to start up the[[MX_Administrative_Interface| Administrative Interface]] and go into the various settings pages yourself to select what MX needs to continue to work. You then need to stop MX so it stores those settings and can use them next time it starts.  


Please note some settings can take immediate effect while MX is running, others only take on their new values when MX is restarted. Don't ever edit the configuration file directly while Cumulus MX is running!
Please note some settings can take immediate effect while MX is running, others only take on their new values when MX is restarted. Don't ever edit the configuration file directly while Cumulus MX is running!
Line 837: Line 843:
|-
|-
|DataLogging=0
|DataLogging=0
|This parameter (attribute=value) is ignored for MX prior to build 3018, it determines if (when you next start Cumulus) it will send enhanced information to a [[MXDiags_folder]] file about the data coming from your weather station.  It is important to record here that, if you subsequently stop Cumulus, this parameter is reset to zero on exit.
|This parameter (attribute=value) is ignored for MX prior to build 3018, it determines if (when you next start Cumulus) it will send enhanced information to a [[MXdiags_folder]] file about the data coming from your weather station.  It is important to record here that, if you subsequently stop Cumulus, this parameter is reset to zero on exit.
*0 = default of normal output
*0 = default of normal output
*1 = Set it to 1 to enable the enhanced output to the log that aids debugging if there is a problem
*1 = Set it to 1 to enable the enhanced output to the log that aids debugging if there is a problem
Sfws
5,838

edits

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

Navigation menu