Original Cumulus Wiki: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (add link to new page "The_Alternative_Interface_(ai.cmx)")
m (Changed protection settings for "Original Cumulus Wiki" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading])
 
(22 intermediate revisions by 3 users not shown)
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. 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.  Steve Loft deleted the material on Cumulus 2 when that was abandoned, but the [[Cumulus 3 (MX) beta documentation|MX 3.0.0 beta]] documentation remains.
'''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.  


<div style="padding-left: 20px; width: 95%; border:solid; border-width: thin; padding:10px; margin-bottom:20px; padding-bottom:20px; background-color:LightYellow;">
<div style="padding-left: 20px; width: 95%; border:solid; border-width: thin; padding:10px; margin-bottom:20px; padding-bottom:20px; background-color:LightYellow;">


'''You do not need a userid to READ any of the content on this Wiki.'''
If you are new to Wikis we suggest you spend a few minutes reading basic articles about them. Familiarise yourself with:
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. 
 
This Wiki retains content for the legacy original Cumulus software that people still use, although they are encouraged to [[Migrating from Cumulus 1 to MX|Migrate from Cumulus 1]] to the vastly different Cumulus MX developed by Mark Crossley (from Steve's original).  Please see the bottom of this page for how you can contribute to 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
*Explaining [[Help:Contents/tabs|tabs]] at top of page
*How to [[Help:Contents#Reading|read]]
*How to [[Help:Contents#Reading|read]]
*How to [[Help:Contents#Searching|search]]  
*How to [[Help:Contents#Searching|search]]  


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].
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.
 
If you have any questions please raise them on the [https://cumulus.hosiene.co.uk/viewforum.php?f=38 Cumulus forum].
<div>
<div>
{| class="t_nav_main"
{| class="t_nav_main"
Line 26: Line 22:
!style="width:80px"| [[Image:Icon article.png|left|50px]]Reference
!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]]
*'''Download''' links:
* [[Updating_MX_to_new_version|How to Upgrade to new MX build]]
*'''Software Download''' links:
** [[Software#Current_Release|Current MX]],
** [[Software#Current_Release|Current MX]],
*** [https://github.com/cumulusmx/CumulusMX/releases Earlier MX Releases]
** [[Software#Create_Missing|Create Missing utility]],  
** [[Software#Create_Missing|Create Missing utility]],  
** [[Software#ExportToMySQL|Export To MySQL utility]],
** [[Software#ExportToMySQL|Export To MySQL utility]],
** and [https://github.com/cumulusmx/CumulusMX/releases Earlier Releases]
** [[Software#Raspberry_Pi_Image|Download Raspberry Pi Image]] and [[Raspberry Pi Image|Raspberry Pi Image Instructions]]
* [[Raspberry Pi Image]]
* [[MX_on_Linux|Install on Unix/Linux/Raspberry Pi OS]]
*[[MX_on_Linux|Install on Unix/Linux/Raspberry Pi OS]]
** and [[Preparing your Linux computer for MX]]
*[[MX_on_Windows_OS|Install on Microsoft Windows OS]]
* [[MX_on_Windows_OS|Install on Microsoft Windows OS]]
* [[The_Alternative_Interface_(ai.cmx)]]: Local pages, Settings, and Editing
* Settings:
*[[MX_Administrative_Interface|MX Interface included in MX download ('''aka''' Local interface, User interface, Administrative interface, and Dashboard interface)]]: Local pages, Settings, and Editing
** [[First Run of MX|Configuration Wizard]]
*[[Cumulus.ini|Configuration/settings (3.8.0 onwards)]]
** [[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 74: Line 73:
*[[:Category:Other Languages|Other Languages]]
*[[:Category:Other Languages|Other Languages]]
*[[Supported Devices]]
*[[Supported Devices]]
*[[Cumulus Users|List of legacy Cumulus Users and their Websites]]




|  
|  
'''Web Server:'''
'''Web Server:'''
*[[:Category:WebTips|Starting point for Web tips/documentation (including some basic HTML, CSS, JavaScript,PHP etc. tips)]]  
* [[Webspace|Commercial Web site hosting]]
*[[Customised templates|Customising Cumulus legacy templates]] and [[Cumulus_template_file|Guide to Cumulus template files]]
* [[Your_Own_Server|Your Own Web/Database Server]]
* Definitive list of [[Webtags|tag names for template files]] and [[Webtags/Parameters|Input and Output Modification Parameters for those web tags]]
* [[:Category:WebTips|Starting point for Web tips/documentation (including some basic HTML, CSS, JavaScript,PHP etc. tips)]]  
*[[Reports folder|The (NOAA style) Climate Reports functionality]]
* [[Customised templates|Customising Cumulus legacy templates]] and [[Cumulus_template_file|Guide to Cumulus template files]]
*[[Simple_Website_setup|Legacy simple web site]]
* Definitive list of [[Webtags|tag names for template files]]  
*[[Webspace|Commercial Web site hosting]]
** [[Webtags/Parameters|Input and Output Modification Parameters for those web tags]]
*[[Your_Own_Server|Your Own Web/Database Server]]
* [[Reports folder|The (NOAA style) Climate Reports functionality]]
 
* [[Simple_Website_setup|Legacy simple web site]]
<br>
<br>
'''Shared by Third Parties:'''
'''Shared by Third Parties:'''
*[[:Category:User Contributions|Starting point for 3rd Party Contributions]]
*[[:Category:User Contributions|Starting point for 3rd Party Contributions]]
Line 99: Line 101:
* [[:Category:StationSpecific|Details specific to a particular weather station type]]
* [[:Category:StationSpecific|Details specific to a particular weather station type]]
* [[:Category:Cumulus Files|Information by folder and file names]]
* [[: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]]
* [[: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]]
* [[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]]
* [[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]]
* [[Raspberry_Pi_computer_page|Raspberry Pi computer and MX]]
* [[Migrating from Cumulus 1 to MX|How to migrate from legacy original Cumulus to MX]]
* [[Migrating from Cumulus 1 to MX|How to migrate from legacy original Cumulus to MX]]
Line 109: Line 111:


*[[Twitter Usernames|Twitter users]] (obsolete)
*[[Twitter Usernames|Twitter users]] (obsolete)
*[[Cumulus Users|User Websites]] (obsolete)


|}
|}
Line 115: Line 116:


<br>  
<br>  
==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;">'''It's your Wiki......'''<br> <br>We always welcome contributions from the Cumulus Community and if you feel you can contribute, please do.   
 
<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).
:If you already have a userid, then just [[Special:UserLogin|Login here]] (link also available on top right of any page).
Line 123: Line 122:
*'''Are you willing to contribute to this Wiki's documentation?'''
*'''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.
* 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,  
#*that is full of hints on how to write Wiki pages,  
#*including Cumulus Wiki specific help.
#*including Cumulus Wiki specific help.
Line 129: Line 128:
#*want a suggestion to start you off  ...
#*want a suggestion to start you off  ...
#*or want to make a suggestion ...
#*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.
# 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


* 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
* 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.
* '''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 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.


* 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
* This Wiki documents the legacy Cumulus 1 in good detail due to many different contributors
* 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.
* 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.
* 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)
* MX offers much functionality.  Some pages use the '''<nowiki>{{Template:WorkInProgressBanner}}</nowiki>''' to indicate other contributors are needed to expand the current content
* <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>
</div>
'''''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, it makes it easier 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!)
*If you plan on '''CONTRIBUTING''' to the Wiki, then you will need a userid.
**The quickest way to get a new account is to put a request via the support forum (see pink background text there)
**Otherwise use the [[Special:RequestAccount|Request Account]] form to apply for a userid  (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 users)

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:

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.

Badge vMx.png
Cumulus MX (V.3)
Icon info.png
Legacy Cumulus (V.1)
Icon tool.png
Customisation
Icon article.png
Reference



Web Server:



Shared by Third Parties:



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.
  1. 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.
  2. 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