5,838
edits
Cumulus.ini (preserving history): Difference between revisions
Cumulus.ini (preserving history) (view source)
Revision as of 21:07, 25 March 2020
, 21:07, 25 March 2020→Introduction
m (→Cumulus MX) |
m (→Introduction) |
||
| Line 2: | Line 2: | ||
{{TOCright}} | {{TOCright}} | ||
= Introduction = | = Introduction = | ||
*'''Cumulus.ini''' is a text file containing initialization parameters used by the Cumulus 1.x.x, or Cumulus MX, application. | |||
*It is '''only''' read when Cumulus (of either flavour) starts up. When Cumulus (either flavour) is run for very first time, the file does not exist, as it is not included in the download (of either flavour). For MX only, if the file does exist as MX starts, a backup is taken so if you subsequently change any settings you can go back to how it was before you made those changes. | |||
*Cumulus (1 or 2 or MX) creates a new version of this file when it ''shuts down'', if this is the first run of the software this will create the file for first time. | |||
*The file shows as 'modified date' the last time that Cumulus was shut down, the file will contain the contents of the application's configuration screens and also any parameters that were in any previous copy of the file that cannot be configured within Cumulus. | |||
*Note this Cumulus save action may change the order, or add lines, compared to any file that you manually edited. | |||
*For Cumulus MX only, a back up copy of Cumulus.ini is stored at end of each day (together with some of the log files). | |||
*If you do need to edit the file, close Cumulus first to ensure you are working on latest contents, and your edit cannot conflict with any edit Cumulus may be making. When Cumulus restarts it will read the file again and see any edits you have made. | |||
The parameters listed can change the look of Cumulus, can hold basic information about your location, can amend the way Cumulus interfaces with your weather station, can hold the settings used to interface with your website, and with various external websites. | |||
Later on this page there is a table showing parameters that may be in the configuration file, the default value for each attribute is mentioned, and it is made clear whether that parameter can be set through the settings screen in the software or must be manually added to the file. The list was created for Cumulus 1.x.y, and all of it applies to the final formal release. The majority of the parameters are also used by Cumulus MX, which can edit in its settings screens some that Cumulus 1 cannot edit. There are also extra parameters that only apply to MX, plus some extra values available for some attributes like weather station make. | |||
If you are using an older Cumulus 1 version, then ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below as available in latest release of Cumulus 1. | |||
Similarly, the parameters available may vary between different versions/builds of MX, again ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below. | |||
[[Category:Configuration Files]] | |||
== Creating Configuration File == | == Creating Configuration File == | ||
When you download Cumulus 1 or MX, ''there is no configuration file included in the download''. So when you first use the software, either flavour of Cumulus, 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 1 or MX, ''there is no configuration file included in the download''. So when you first use the software, either flavour of Cumulus, 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. | ||