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>, the 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 software Steve Loft developed, and later modified to also cover other flavours (Cumulus 2 and MX beta) Steve Loft developed. Steve Loft deleted the material on Cumulus 2 when that was abandoned. The Wiki retains content for the legacy original Cumulus software that people still use.
+'''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.
-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. At that time, [[Cumulus_3_(MX)_beta_documentation|Steve's MX beta]] had limited functionality, and its documentation was sparse.
 <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:
-'''You do not need a userid to READ any of the content on this Wiki.'''
-Brian Underdown (weather34) has allowed us to host his [[HomeWeatherStationTemplate|Home Weather Station template for Cumulus]] on the Wiki.
-</div>
-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.
-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].
+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.
+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 24: / 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:
-*[[MX_Administrative_Interface|Admin Interface ('''aka''' Local interface, User interface, and Dashboard interface)]]: Local pages, Settings, and Editing
-*[[Cumulus.ini|Configuration/settings (3.8.0 onwards)]]
+** [[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 default web site:
+** [[The_Alternative_Interface_(ai.cmx)]]: Local pages, Settings, and Editing
-**[[New Default Web Site Information|Usage information]]
+** [[Cumulus.ini|Full guide to Configuration/settings (3.8.0 onwards)]]
-**[[Default_Website_Development|latest developments]]
+* [[Cumulus MX Local API|Local Application Programming Interface]]
-**[[:Category:JSON Files|Supporting JSON files]]
+** [[Webtags/Parameters|Customising Tag Parameters]]
-**[[WebsitedataT.json|Data for web site tables]]
+* MX default web site:
-**[[Webtags/Parameters|Customising Parameters]]
+** [[New Default Web Site Information|Usage information]]
-*[[Updating_MX_to_new_version|How to Upgrade to new MX build]]
+** [[Default_Website_Development|Latest developments]]
-*[[Cumulus_MX_formal_release_versions|Release tracker]]
+** [[Cumulus.ini#Optional_Web_Server|Settings relevant to web site]]
-*[[MX_Basic_info|Basic MX information]]
+** [[:Category:JSON Files|Supporting JSON files]]
-*[[Cumulus MX Local API|Local Application Programming Interface]]
+** [[WebsitedataT.json|Data for web site tables]]
-*[[Highcharts_-_Recent|Recent Charts]] and [[Highcharts_-_Historic|Historic Charts]]
+* [[MX_Basic_info|Basic MX information]]
-*[[MX_Issues|Known Issues/bugs]]
+* [[Cumulus_MX_formal_release_versions|Release tracker]]
-*[[Cumulus_MX_FAQ|Frequently asked]]
+* [[Highcharts_-_Recent|Recent Charts]] and [[Highcharts_-_Historic|Historic Charts]]
-*[[Supported Devices]]
+* [[MX_Issues|Known Issues/bugs]]
+* [[Cumulus_MX_FAQ|Frequently asked]]
+* [[Supported Devices]]
@@ Line 71: / 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]]
+* [[Your_Own_Server|Your Own Web/Database 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]]
-* Definitive [[Webtags|Web tags]] and [[Webtags/Parameters|Modification Parameters]] for [[Customised templates|Customising]] of [[Cumulus_template_file|Cumulus template files]]
+* [[Customised templates|Customising Cumulus legacy templates]] and [[Cumulus_template_file|Guide to Cumulus template files]]
+* 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]]
+* [[Reports folder|The (NOAA style) Climate Reports functionality]]
+* [[Simple_Website_setup|Legacy simple web site]]
+<br>
+<br>
 '''Shared by Third Parties:'''
 *[[:Category:User Contributions|Starting point for 3rd Party Contributions]]
@@ Line 91: / Line 98: @@
 |
-*[[:Category:Cumulus Files|Information by folder and file names]]
+* [[:Category:Terminology|Cumulus Terminology]]
-*[[:Category:StationSpecific|Details specific to a particular weather station type]]
+* [[:Category:StationSpecific|Details specific to a particular weather station type]]
-*[[:Category:Terminology|Cumulus Terminology]]
+* [[:Category:Cumulus Files|Information by folder and file names]]
+** [[:Category:Ini Files|All about the '''.ini''' files that store extreme records]]
-*[[Correcting Extremes|Correcting extremes Records]]
+** [[Correcting Extremes|Full guide to correcting extremes Records]]
-*[[Calculate_Missing_Values|Inserting Missing fields in log files]]
+** [[:Category:Files with Comma Separated Values|All about text files that store data with Comma Separated Values]]
-*[[Amending dayfile]]
+*** [[Dayfile.txt|The daily summary log (dayfile.txt) introduction]] and [[Amending dayfile|Full guide to dayfile.txt correction]]
-*[[:Category:WebTips|Some basic HTML, CSS, JavaScript,PHP etc. tips]]
+*** [[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]]
+* [[Raspberry_Pi_computer_page|Raspberry Pi computer and MX]]
-*[[Migrating from Cumulus 1 to MX|How to migrate from legacy original Cumulus to MX]]
-*[[Compare C1 and MX|Compare functionality in legacy original Cumulus with MX]]
+* [[Migrating from Cumulus 1 to MX|How to migrate from legacy original Cumulus to MX]]
+* [[Compare C1 and MX|Compare functionality in legacy original Cumulus with MX]]
 *[[Twitter Usernames|Twitter users]] (obsolete)
-*[[Cumulus Users|User Websites]] (obsolete)
 |}
@@ Line 109: / 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==
+:If you already have a userid, then just [[Special:UserLogin|Login here]] (link also available on top right of any page).
-<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.
-*'''Are you willing to help us rewrite this Wiki to document MX'''?
+*'''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.
-*MX has been evolving rapidly since Mark Crossley started leading development (with small contributions from others), ''so there is much more to document''.
+#As a starting point, we suggest you read [[Help:Contents/Editing|How to Edit]],
-*In particular, '''can you help make it more friendly for those whose first encounter with Cumulus is a MX release? '''
-*The first step has been done, rewriting this page to promote MX over the legacy Cumulus; but many other pages are still largely as they were created decades ago.
-#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 124: / 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.
-#If you see a warning about a page, or section, being '''out of date''', can you help document how MX has changed?
-#If a page uses '''<nowiki>{{Template:WorkInProgressBanner}}</nowiki>''', then can you help to finish off that documentation?
+* 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.
-</div>
+*# The pages specific to MX and specific to legacy software are now in separate columns
-*If you plan on '''CONTRIBUTING''' to the Wiki, then you will need a userid.
+*# 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.
-**Please use the [[Special:RequestAccount|Request Account]] form to apply for a userid  (you may have to wait some time for a response),  or
-**If you already have a userid, then just [[Special:UserLogin|Login here]] (link also available on top right of any page).
-'''''When requesting a Wiki account, it would be helpful if you can use the same user name as on the Cumulus forum (but use a different password!), it makes it easier for the admins to identify genuine account requests from spammers.'''''
+* 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 '''<nowiki>{{Template:WorkInProgressBanner}}</nowiki>''' to indicate other contributors are needed to expand the current content
+</div>