Original Cumulus Wiki: Difference between revisions

Latest revision as of 21:53, 12 November 2022

Welcome to the Cumulus Wiki. This community Wiki is for sharing knowledge of the Cumulus Weather Station software.

The current maintained and supported version of the software is known as Cumulus MX. There is limited support available for the legacy Cumulus 1 software - any remaining users are encouraged to migrate from Cumulus 1 to Cumulus MX. A number of developers are contributing to MX, but the bulk of the development has been done by Mark Crossley.

If you are new to Wikis we suggest you spend a few minutes reading basic articles about them. Familiarise yourself with:

Explaining tabs at top of page
How to read
How to search

Please see the bottom of this page for how you can contribute to this Wiki. If you plan on contributing to the Wiki, then you will need a account with userid. Use the Request Account form to apply for an account. Use the biography box to explain how you will contribute if you are granted write access. Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.

If you have any questions please raise them on the Cumulus forum.

Cumulus MX (V.3)

Legacy Cumulus (V.1)

Customisation

Reference

Starting point for all MX documentation
Solving problems
How to Upgrade to new MX build
Software Download links:
Install on Unix/Linux/Raspberry Pi OS
- and Preparing your Linux computer for MX
Install on Microsoft Windows OS
Settings:
- Configuration Wizard
- MX Interface included in MX download (aka Local interface, User interface, Administrative interface, and Dashboard interface): Local pages, Settings, and Editing
- The_Alternative_Interface_(ai.cmx): Local pages, Settings, and Editing
- Full guide to Configuration/settings (3.8.0 onwards)
Local Application Programming Interface
- Customising Tag Parameters
MX default web site:
Basic MX information
Release tracker
Recent Charts and Historic Charts
Known Issues/bugs
Frequently asked
Supported Devices

Web Server:

Shared by Third Parties:

Twitter users (obsolete)

It's your Wiki......

We always welcome contributions from the Cumulus Community and if you feel you can contribute, please do.

If you already have a userid, then just Login here (link also available on top right of any page).

Are you willing to contribute to this Wiki's documentation?
Are you new to Cumulus MX? If so, you are the best possible person to know what newcomers need in this Wiki. You also know what you have discovered, and can document it to be useful for others.

As a starting point, we suggest you read How to Edit,
- that is full of hints on how to write Wiki pages,
- including Cumulus Wiki specific help.
If you
- want a suggestion to start you off ...
- or want to make a suggestion ...
  - ... How_you_can_contribute is the page you should go to, its content should be updated when work done, or suggestions need to be recorded.

This Main Page (only administrators can update this page) provides direct links to a set of category pages. In the future, anyone will be able to edit the new, and amended, "category" pages, those are now the entry points grouping the rest of the documentation in this Wiki.
1. The pages specific to MX and specific to legacy software are now in separate columns
2. This main page does provide direct links to key pages that are unlikely to be renamed/removed, but administrators have limited time to edit such links.

The old Fine Offset stations were long ago documented in some pages linked from Category:StationSpecific
There is minimal documentation for Davis stations and Instromet stations, can you rectify this?
There is no documentation yet for the newer Ecowitt devices, can you rectify this?
This Wiki documents the legacy Cumulus 1 in good detail due to many different contributors
Cumulus MX nowadays is different from the early MX beta; do you use/understand any of the new functionality meaning you can document it for those new to that functionality? Some of the early MX documentation has been deleted, and some pages make it clear that they apply to an earlier MX release.
MX offers much functionality. Some pages use the {{Template:WorkInProgressBanner}} to indicate other contributors are needed to expand the current content

@@ Line 1: / Line 1: @@
-<big>'''Welcome to the Cumulus Wiki'''</big>, this community Wiki is for sharing knowledge of the [[About Cumulus|Cumulus]] Weather Station software. [[CumulusWiki:About|This Wiki]] was originated to document the (original) Cumulus (1) software Steve Loft developed. ''The vast majority of the original content used Steve's own words, and he was a key contributor.''
+'''Welcome to the Cumulus Wiki'''.  This community Wiki is for sharing knowledge of the [[About Cumulus|Cumulus]] Weather Station software.
+The current maintained and supported version of the software is known as Cumulus MX.  There is limited support available for the legacy Cumulus 1 software - any remaining users are encouraged to [[Migrating from Cumulus 1 to MX|migrate from Cumulus 1]] to Cumulus MX.  A number of developers are contributing to MX, but the bulk of the development has been done by Mark Crossley.
-Other contributors reviewed what Steve said in answers in the support forum, and collated that material into pages in this Wiki, so Steve's knowledge could be shared more systematically. When Steve Loft developed other flavours, the content here also covered those. This Wiki retains content for the legacy original Cumulus software that people still use, some of that legacy content has been locked against further editing. Steve Loft deleted the material on Cumulus 2 when he abandoned that development, but his [[Cumulus 3 (MX) beta documentation|MX 3.0.0 beta]] documentation remains.  This copy of the original Cumulus Wiki was cloned on 26-Oct-2018, just before Steve Loft ended his association with Cumulus, and all user credentials from the deleted original Wiki hosted by ''sandaysoft.com'' should be valid here.
-There is limited support available for the legacy software and any remaining legacy users are encouraged to [[Migrating from Cumulus 1 to MX|Migrate from Cumulus 1]] to the vastly different Cumulus MX. A number of developers are contributing to MX, but the big transformation (from Steve's original) has been almost entirely developed by Mark Crossley.
 <div style="padding-left: 20px; width: 95%; border:solid; border-width: thin; padding:10px; margin-bottom:20px; padding-bottom:20px; background-color:LightYellow;">
+If you are new to Wikis we suggest you spend a few minutes reading basic articles about them. Familiarise yourself with:
-<big>'''''You do not need a userid to READ any of the content on this Wiki.''''' </big>
-If you are new to Wiki's we suggest you spend a few minutes reading basic articles about this Wiki. Familiarise yourself with:
 *Explaining [[Help:Contents/tabs|tabs]] at top of page
 *How to [[Help:Contents#Reading|read]]
 *How to [[Help:Contents#Searching|search]]
-Please see the bottom of this page for how ''you can contribute'' to this Wiki. If you plan on '''CONTRIBUTING''' to the Wiki, then you will need a account with userid.
+Please see the bottom of this page for how you can contribute to this Wiki. If you plan on contributing to the Wiki, then you will need a account with userid.
+Use the [[Special:RequestAccount|Request Account]] form to apply for an account.  Use the biography box to explain how you will contribute if you are granted write access.  Note that the Wiki is currently undergoing restructuring and is largely locked for editing, but please apply for an account if you wish to contribute in the future.
- The quickest way to get a new account is to put a request via the support forum (see pink background text there)
- '''''When requesting a Wiki account, please quote the user name you use on the Cumulus support forum, or provide other evidence of you being a genuine Cumulus user.
- Otherwise use the [[Special:RequestAccount|Request Account]] form to apply for a userid, '''use the biography box to explain what you will contribute if you are granted write access''', not to describe your past  (you may have to wait some time for an administrator to have spare time to wade through loads of spam requests to find any real Cumulus user request).
- Do be aware there are many spammers attempting to gain access, and any request that does not comply with above instruction makes it impossible for the admins to identify genuine account requests from spammers.'''''
- (Please note, the support forum and this Wiki are hosted by different people, on different web hosts, so do use a different password!)
-Brian Underdown (weather34) has allowed us to host his [[HomeWeatherStationTemplate|Home Weather Station template for Cumulus]] on the Wiki.
-</div>
-If you have any questions please raise them on either the [https://cumulus.hosiene.co.uk/viewforum.php?f=38 Cumulus forum] or [https://www.wxforum.net/index.php?board=105.0 Cumulus board at WXForum.net].
+If you have any questions please raise them on the [https://cumulus.hosiene.co.uk/viewforum.php?f=38 Cumulus forum].
 <div>
 {| class="t_nav_main"
@@ Line 34: / Line 22: @@
 !style="width:80px"| [[Image:Icon article.png|left|50px]]Reference
 |-
 |
-*[[:Category:Cumulus MX|Starting point for all MX documentation]]
+* [[:Category:Cumulus MX|Starting point for all MX documentation]]
-*[[What_to_do_when_I_have_a_problem_with_MX|Solving problems]]
+* [[What_to_do_when_I_have_a_problem_with_MX|Solving problems]]
+* [[Updating_MX_to_new_version|How to Upgrade to new MX build]]
-*'''Download''' links:
+*'''Software Download''' links:
 ** [[Software#Current_Release|Current MX]],
+*** [https://github.com/cumulusmx/CumulusMX/releases Earlier MX Releases]
 ** [[Software#Create_Missing|Create Missing utility]],
 ** [[Software#ExportToMySQL|Export To MySQL utility]],
+** [[Software#Raspberry_Pi_Image|Download Raspberry Pi Image]] and [[Raspberry Pi Image|Raspberry Pi Image Instructions]]
-** and [https://github.com/cumulusmx/CumulusMX/releases Earlier Releases]
-* [[Raspberry Pi Image]]
+* [[MX_on_Linux|Install on Unix/Linux/Raspberry Pi OS]]
+** and [[Preparing your Linux computer for MX]]
-*[[MX_on_Linux|Install on Unix/Linux/Raspberry Pi OS]]
-*[[MX_on_Windows_OS|Install on Microsoft Windows OS]]
+* [[MX_on_Windows_OS|Install on Microsoft Windows OS]]
+* Settings:
-* [[The_Alternative_Interface_(ai.cmx)]]: Local pages, Settings, and Editing
+** [[First Run of MX|Configuration Wizard]]
-*[[MX_Administrative_Interface|MX Interface included in MX download ('''aka''' Local interface, User interface, Administrative interface, and Dashboard interface)]]: Local pages, Settings, and Editing
+** [[MX_Administrative_Interface|MX Interface included in MX download ('''aka''' Local interface, User interface, Administrative interface, and Dashboard interface)]]: Local pages, Settings, and Editing
-*[[Cumulus.ini|Configuration/settings (3.8.0 onwards)]]
+** [[The_Alternative_Interface_(ai.cmx)]]: Local pages, Settings, and Editing
-*MX default web site:
+** [[Cumulus.ini|Full guide to Configuration/settings (3.8.0 onwards)]]
-**[[New Default Web Site Information|Usage information]]
+* [[Cumulus MX Local API|Local Application Programming Interface]]
-**[[Default_Website_Development|latest developments]]
+** [[Webtags/Parameters|Customising Tag Parameters]]
-**[[Cumulus.ini#Optional_Web_Server|Settings relevant to web site]]
+* MX default web site:
-**[[:Category:JSON Files|Supporting JSON files]]
+** [[New Default Web Site Information|Usage information]]
-**[[WebsitedataT.json|Data for web site tables]]
+** [[Default_Website_Development|Latest developments]]
-**[[Webtags/Parameters|Customising Parameters]]
+** [[Cumulus.ini#Optional_Web_Server|Settings relevant to web site]]
-*[[Updating_MX_to_new_version|How to Upgrade to new MX build]]
+** [[:Category:JSON Files|Supporting JSON files]]
-*[[Cumulus_MX_formal_release_versions|Release tracker]]
+** [[WebsitedataT.json|Data for web site tables]]
-*[[MX_Basic_info|Basic MX information]]
+* [[MX_Basic_info|Basic MX information]]
-*[[Cumulus MX Local API|Local Application Programming Interface]]
+* [[Cumulus_MX_formal_release_versions|Release tracker]]
-*[[Highcharts_-_Recent|Recent Charts]] and [[Highcharts_-_Historic|Historic Charts]]
+* [[Highcharts_-_Recent|Recent Charts]] and [[Highcharts_-_Historic|Historic Charts]]
-*[[MX_Issues|Known Issues/bugs]]
+* [[MX_Issues|Known Issues/bugs]]
-*[[Cumulus_MX_FAQ|Frequently asked]]
+* [[Cumulus_MX_FAQ|Frequently asked]]
-*[[Supported Devices]]
+* [[Supported Devices]]
@@ Line 83: / Line 73: @@
 *[[:Category:Other Languages|Other Languages]]
 *[[Supported Devices]]
+*[[Cumulus Users|List of legacy Cumulus Users and their Websites]]
 |
 '''Web Server:'''
+* [[Webspace|Commercial Web site hosting]]
-*[[:Category:WebTips|Starting point for Web tips/documentation (including some basic HTML, CSS, JavaScript,PHP etc. tips)]]
+* [[Your_Own_Server|Your Own Web/Database Server]]
-*[[Customised templates|Customising Cumulus legacy templates]] and [[Cumulus_template_file|Guide to Cumulus template files]]
+* [[:Category:WebTips|Starting point for Web tips/documentation (including some basic HTML, CSS, JavaScript,PHP etc. tips)]]
-* Definitive list of [[Webtags|tag names for template files]] and [[Webtags/Parameters|Input and Output Modification Parameters for those web tags]]
+* [[Customised templates|Customising Cumulus legacy templates]] and [[Cumulus_template_file|Guide to Cumulus template files]]
-*[[Reports folder|The (NOAA style) Climate Reports functionality]]
+* Definitive list of [[Webtags|tag names for template files]]
-*[[Simple_Website_setup|Legacy simple web site]]
+** [[Webtags/Parameters|Input and Output Modification Parameters for those web tags]]
-*[[Webspace|Commercial Web site hosting]]
+* [[Reports folder|The (NOAA style) Climate Reports functionality]]
-*[[Your_Own_Server|Your Own Web/Database Server]]
+* [[Simple_Website_setup|Legacy simple web site]]
+<br>
+<br>
 '''Shared by Third Parties:'''
 *[[:Category:User Contributions|Starting point for 3rd Party Contributions]]
@@ Line 108: / Line 101: @@
 * [[:Category:StationSpecific|Details specific to a particular weather station type]]
 * [[:Category:Cumulus Files|Information by folder and file names]]
-* [[:Category:Ini Files|All about the '''.ini''' files that store extreme records]]
+** [[:Category:Ini Files|All about the '''.ini''' files that store extreme records]]
+** [[Correcting Extremes|Full guide to correcting extremes Records]]
-* [[:Category:Files with Comma Separated Values|All about text files that store data with Comma Separated Values]]
+** [[:Category:Files with Comma Separated Values|All about text files that store data with Comma Separated Values]]
-* [[Correcting Extremes|Full guide to correcting extremes Records]]
-* [[Standard log files|Logging of standard values]] and [[Calculate_Missing_Values|Full guide to populating missing standard values]]
+*** [[Dayfile.txt|The daily summary log (dayfile.txt) introduction]] and [[Amending dayfile|Full guide to dayfile.txt correction]]
-* [[Dayfile.txt|The daily summary log (dayfile.txt) introduction]] and [[Amending dayfile|Full guide to dayfile.txt correction]]
+*** [[Standard log files|Logging of standard values]] and [[Calculate_Missing_Values|Full guide to populating missing standard values]]
 * [[Raspberry_Pi_computer_page|Raspberry Pi computer and MX]]
 * [[Migrating from Cumulus 1 to MX|How to migrate from legacy original Cumulus to MX]]
@@ Line 118: / Line 111: @@
 *[[Twitter Usernames|Twitter users]] (obsolete)
-*[[Cumulus Users|User Websites]] (obsolete)
 |}
@@ Line 124: / Line 116: @@
 <br>
+<div style="padding-left: 20px; width: 95%; border:solid; border-width: thin; padding:10px; margin-bottom:20px; padding-bottom:20px; background-color:LightYellow;">'''It's your Wiki......'''<br> <br>We always welcome contributions from the Cumulus Community and if you feel you can contribute, please do.
-==Please help==
-<div style="padding-left: 20px; width: 95%; border:solid; border-width: thin; padding:10px; margin-bottom:20px; padding-bottom:20px; background-color:LightYellow;"><big>'''It's your Wiki......'''</big><br> <br>We always welcome contributions from the Cumulus Community and if you feel you can contribute, please do.
 :If you already have a userid, then just [[Special:UserLogin|Login here]] (link also available on top right of any page).
@@ Line 132: / Line 122: @@
 *'''Are you willing to contribute to this Wiki's documentation?'''
 * Are you new to Cumulus MX? If so, you are the best possible person to know what newcomers need in this Wiki.  You also know what you have discovered, and can document it to be useful for others.
-#<big>As a starting point, we suggest you read [[Help:Contents/Editing|How to Edit]],</big>
+#As a starting point, we suggest you read [[Help:Contents/Editing|How to Edit]],
 #*that is full of hints on how to write Wiki pages,
 #*including Cumulus Wiki specific help.
@@ Line 138: / Line 128: @@
 #*want a suggestion to start you off  ...
 #*or want to make a suggestion ...
-#** ... [[How_you_can_contribute]] is where '''what needs doing''' is listed
+#** ... [[How_you_can_contribute]] is the page you should go to, its content should be updated when work done, or suggestions need to be recorded.
-# MX has changed dramatically, therefore some of the early MX documentation has been deleted, and some pages make it clear that they apply to an earlier MX release.
+* This ''Main Page'' (only administrators can update this page) provides direct links to a set of [[Special:Categories|category pages]].  In the future, anyone will be able to edit the new, and amended, "category" pages, those are now the entry points grouping the rest of the documentation in this Wiki.
-# MX offers so much functionality, that nobody uses everything MX can do.  Some pages use the '''<nowiki>{{Template:WorkInProgressBanner}}</nowiki>''' to indicate other contributors are needed to expand the current content
+*# The pages specific to MX and specific to legacy software are now in separate columns
+*# This main page does provide direct links to key pages that are unlikely to be renamed/removed, but administrators have limited time to edit such links.
-* This ''Main Page'' (only administrators can update this page) has been rewritten, separating MX and legacy links, to provide a better way into a new set of category pages together with direct links to key pages
-* '''The new, and amended, "category" pages are now the entry points grouping the rest of the documentation in this Wiki, you can edit any of those.'''
-* The old Fine Offset stations have been documented in [[:Category:StationSpecific]], but there is no documentation for any Davis or Ecowitt devices, can you rectify this?
+* The old Fine Offset stations were long ago documented in some pages linked from [[:Category:StationSpecific]]
+* There is minimal documentation for [[Davis]] stations and [[Instromet]] stations, can you rectify this?
+* There is no documentation yet for the newer Ecowitt devices, can you rectify this?
 * This Wiki documents the legacy Cumulus 1 in good detail due to many different contributors
+* Cumulus MX nowadays is different from the early MX beta; do you use/understand any of the new functionality meaning you can document it for those new to that functionality?  Some of the early MX documentation has been deleted, and some pages make it clear that they apply to an earlier MX release.
-* Steve Loft, and Mark Crossley, (plus others), modified some legacy pages to also cover the original [[Cumulus_3_(MX)_beta_documentation| MX 3.0.0 beta]], but that had very limited functionality (just a subset of that available in Cumulus 1) and only 2 new pages were added.
+* MX offers much functionality.  Some pages use the '''<nowiki>{{Template:WorkInProgressBanner}}</nowiki>''' to indicate other contributors are needed to expand the current content
-* Most pages that are specific to legacy Cumulus 1 have been locked, to prevent editing for MX differences and to ensure they are preserved for those still using the legacy software (all pages relating to Cumulus 2 were removed by Steve Loft)
-* <big>The MX of today, thanks to Mark Crossley leading development (with small contributions from others), is totally different from that early MX beta; do you use/understand any of the new functionality (not documented for legacy software) meaning you can document it for those new to that functionality?</big>
 </div>