Cumulus Wiki

Cumulus.ini: Difference between revisions

Page Discussion

Cumulus.ini (view source)

Revision as of 11:15, 12 June 2022

6,827 bytes removed ,  12 June 2022
m
no edit summary
mNo edit summary
The MX software offers much functionality and flexibility. Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting.
 
<big>Please see [[First Run of MX]] for how to set up settings when you first use MX.</big>
==First run of MX==
 
This Wiki page does not explain how to start using MX, please see [[MX on Linux]], [[MX on Windows OS]], and [[MX Administrative Interface]] as appropriate.
 
The key fact relevant here is that no Cumulus release distribution contains a '''Cumulus.ini''' file. So when you first use the software, you will need to use the [[MX_Administrative_Interface#Changing_Settings|admin interface]] to enter all settings (some have defaults that might be right for you) as described later in this page, and that will lead to creation of the main configuration file.
 
# 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:engineoutput.png|800px|center]]
# 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.
#Open the [[MX Administrative Interface|admin interface]] (either type in http://localhost:8998/ or http://IP Address of your CumulusMX computer:8998/ in your browser of choice), and from the Dashboard interface select Settings and then from the dropdown Config Wizard: [[File:dashboardwiz.jpg|800px|center]] Note this easier than re-typing everything plus "wizard.html" in the URL box of your browser.
#The following screen will open [[File:wizard1.jpg|800px|center]]
#*This is the First Time Setup Wizard which will lead you through the 6 steps that are the minimum requirements to get station up and running with CumulusMX. There is a Next button at the bottom of the page that will take you through these steps. However, the Next button will allow you to move on even though some fields have not been completed. This is not a good idea, however, as CumulusMX will not function correctly if you do not enter these fields so DO NOT click on Next until all the fields on a Wizard page are completed. This is especially true of the Latitude and Longitude settings and the Unit settings. Please make sure that the Unit settings are what you want to use as once set they CANNOT be changed without causing major problems.
#* The settings that are displayed to you in the Station part 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.
#* Location = Your Station name and description, your latitude and longitude (in decimal format (Google Maps provides this if you pin your location), and your height above Sea Level in feet/metres.
#* Units = The units you are going to use for Temperature, Wind, Pressure and Rain. As stated these cannot be changed after their original settings as it will render all CumulusMX stored data invalid, so make sure you set them correctly.
#* Station = Select a Station type from the dropdown box and once you have set this additional settings will appear that are pertinent to the station type you have selected. It is important to get this correct as failure to do so will result in CumulusMX being unable to find your Weather Station.
#* Logging = This is frequency that CumulusMX will store data in the log files. It defaults to 5 minutes but may be changed to other values by clicking on the dropdown. This is also where you set the data Rollover Time to either 9am or Midnight which tells CumulusMX when you consider your end of metrological day processing should take place.
#* Internet = Local Copy or FTP. Local copy assumes you are running your own Internet Web Server on which you will host your own or the default web site and when you click on it a path field will open up so you can tell CumulusMX where to put your files. FTP assumes you will be using a Hosting Company (most people use this option) for your Web Site and once you click on FTP further fields will open up and it is here that you put the details given to you by your Hosting Service in order to FTP the web files to your Web Site. You can set both if you wish but be aware of the extra load that this may impose on your CumulusMX computer.
#* Actions = This where you set the time intervals for CumulusMx to upload standard file and realtime files to your Web Host. Standard files are the files required for a web site and this is called the Normal Interval. To enable it you click on the first box, but if you want these files to be go to Web Host as well you must also click on the FTP box as well. Note this interval is in minutes and that is set on the Normal Interval box (default 15 minutes). Realtime files are those required to run features on your web site like the Gauges. This is in seconds, but please be careful setting it below 5 seconds, as depending on the speed of you Internet connection and the response of your Web Host it may be possible to set a time when the FTP task never completes leading to incorrect readings. The default is 30 seconds and as with the Normal settings you have to enable it and and tick on FTP if you want these files sent to your Web Host.
#* at this point you have set up the minimum settings to get CumulusMX up and running and you will notice that Next button has changed to All Done. When you click on this two things will happen, your initial Cumulus.ini file will be saved and a popup will appear on you Browser and additional line will appear in CumulusMX.exe saying the Station Type has changed - restart required.
# 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 required in order to pick up main configuration file you created in the Wizard and then find your Weather Station.
# 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.
 
==What happens if I upgrade MX?==
Sfws
5,838

edits

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