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

m
Undo revision 9422 by Sfws (talk)
m (Text replacement - "[[MXDiags" to "[[MXdiags")
m (Undo revision 9422 by Sfws (talk))
Tag: Undo
 
(4 intermediate revisions by the same user not shown)
[[File:Crystal Clear info.png|40px]] This page was last updated for the MX release in July 2020; that is no longer latest!
 
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
Appeal to contributors: Please work through all MX release announcements and work out any updates needed for this page
</div>
 
 
[[File:Badge vMx.png]] ThisThe pageaccuracy/completeness nowof onlyinformation applieson ifthis you are usingpage Cumulusis MXnot betaguaranteed, releaseexcept 3.0.0for orthose Mark'sentries releasemade upby tothe 3.9.7developer.
 
For release 3.8.0 and later, you should read the newest [[Cumulus.ini]] page.
The main [[Cumulus.ini]] page is now only for 3.10.1 onwards.
 
The information for the legacy Cumulus has been moved to the new [[Cumulus.ini (Cumulus 1)]] page.
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]]
 
# 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.
#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.
# 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]]
# 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
#* 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.
# 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.
# 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.
# 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, 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.
#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.
#* 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. Otherwiseby dotyping whatever'''C''' iswhile neededholding to enddown the MXcontrol executablekey on(or yourequivalent installation.if Thisyou isare theusing actionan thatapple willmac). create the main configuration file.
#* 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 saveread your new settings on(in exit,'''Cumulus.ini''' itand willthe readoptional your new settings'''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====
5,838

edits