MX Administrative Interface: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

MX Administrative Interface (view source)

Revision as of 11:36, 31 December 2021

25,527 bytes added ,  11:36, 31 December 2021
m
→‎How to see and use the Admin Interface
m (→‎Program Settings: see note for previous edit)
 
(39 intermediate revisions by one other user not shown)
Line 1: Line 1:


{{Template:WorkInProgressBanner}}


#Type the URL which is displayed (when MX starts running) into your browser (replace the * with the IP address, or use 'localhost') and the '''admin interface''' should appear.  You will be viewing your admin interface on the same network as the the MX engine is using, so what you type might be something like <tt>http://192.168.1.xy:8998</tt> and you may need to look at your hub or router to see what to use for x and y as they represent the device where MX is running.
 
=Terminology=
 
This Wiki page has the title "MX administrative interface". That name is fully descriptive of the purpose of the functionality documented on this page. In subsequent references this is shortened to "admin interface".
 
Put simply this means the various pages you see in a browser that allow you to look at weather data and change settings.
 
When Steve Loft made his original cumulus software (legacy cumulus 1) available for others to use, it was natural for him to use "user interface" as a collective term for all the [[Cumulus_Screenshots|various screens]] that he included with that software. 
 
When he worked on Cumulus 2 alpha builds, he needed to explain how the design of his new software was different, and he talked about it separating "engine" and "user interface".  Basically, the engine read information from the weather station, calculated derivatives, and monitored extreme records. The user interface was a web server generated by the engine, here you could amend settings, and see those weather derivatives (the alpha Cumulus 2 never had ability to feed any information to an external web server).
 
Thus Steve Loft used the same terminology (engine and user interface) for his Cumulus 3 beta (also known as MX). When Mark Crossley took over development and brought MX out of beta, he added much more to the web server that the engine generated, and he talks about "the code" where Steve used "engine" and he uses "admin interface" for the enhanced collection of web pages generated by "the code" allowing you to do many administrative tasks like correcting log files (both data logs and extreme record logs). Since then, Mark has redesigned almost every page that Steve Loft created, so there is effectively nothing of the old "user interface" left, and "admin interface" therefore describes the new functionality better.
 
=How to see and use the Admin Interface=
 
#Type the URL which is displayed (when MX starts running) into your browser (replace the * with the IP address, or use 'localhost') and the '''admin interface''' should appear.   
# As the admin interface can both display and change settings, it must not be exposed on the internet.
# However, it is available on the device running the MX code (engine).
#*If the only web server running is the one generated by MX, you can replace the "*" shown by <tt>localhost</tt>
#The admin interface is also available to any device connected to your local (wired or wireless) network.
#*In this case, what you type might be something like <tt>http://192.168.1.xy:8998</tt>
#** You may need to look at your hub or router to see what to use for x and y as they represent the device where MX is running.
#*If this is a 'clean' installation, ''i.e. you don't have an existing [[Cumulus.ini]] file defining station type and units to be used'', the first thing you will need to do is to go to the '''settings''' screen.  
#*If this is a 'clean' installation, ''i.e. you don't have an existing [[Cumulus.ini]] file defining station type and units to be used'', the first thing you will need to do is to go to the '''settings''' screen.  
#When that page is displayed it always shows the options to set the station type and units.
#When that page is displayed it always shows the options to set the station type and units.
Line 7: Line 29:
#Now go to bottom of this page and click the 'Save' button.
#Now go to bottom of this page and click the 'Save' button.


Having set the station type, and other settings, you will need stop Cumulus MX and start it again.  
Having set the station type, and other settings, you will need stop Cumulus MX and start it again.
 
If you have chosen to download and use the alternative Admin Interface (AI) it will be available using the url: <tt>http://localhost:8998/ai.cmx/</tt>.  All the information on this page also applies to the AI.  For other information on the AI visit the [[Alternative_Interface|Alternative Interface]] page.
 
=What does the admin interface contain?=
 
Essentially, the admin interface contains some web pages allowing you to view your weather data locally (there is an option in MX to upload data to a separate web server that might be provided externally). The data shown is provided via an "application programming interface" or '''api''' and that is described next.
 
The admin interface web pages that Mark has either added, or redesigned significantly, are those that  allow you to edit the data log (.txt) files, to edit the extreme record (.ini) log files, and to input and modify configuration settings. These have changed a lot as Mark has developed MX, and the documentation of these later may not be kept up to date with the latest changes.
==Weather pages==
 
===Dashboard===
 
Mix of tables and gauges to show current conditions, and alarms
 
===Now===
 
Current data in tabular format
 
===Gauges===
 
Current data in [[SteelSeries Gauges]] format
 
===Charts===
 
[[Highcharts - Recent|Recent]], Selectachart, and [[Highcharts - Historic|historic]] graphs
 
===Today/yesterday===
 
Data for today-so-far, and yesterday in tabular format
 
===Records===
 
Data for this month-to-date, this year-to-date, all January months ... all December months, and all-time in tabular format


== The API interface ==
== The API interface ==


The current data is transferred from the MX engine to the Admin interface as a JSON string accessed via a Application Program Interface (api). To see the full content type into your browser the same IP reference as for the admin interface and add a few more items i.e. something like <tt>http://192.168.1.x:y/api/data/currentdata</tt> and you may need to look at your hub or router to see what to use for x and y as they represent the device where MX is running.
The current data is transferred from the MX engine to the Admin interface as a JSON string accessed via a Application Program Interface (api).  
 
To see the full content of the api for an individual web page in the admin interface,
#type into your browser the same IP reference as for the admin interface and  
#add a few more items  
#*i.e. something like <tt>http://192.168.1.x:y/api/data/currentdata </tt> for the api that is how the current data (now.html) page in the admin interface gets its data
#there is more information on [[Cumulus_MX_Local_API|Local API page]].
 
Again you may need to look at your hub or router to see what to use for x and y as they represent the device where MX is running.
 
Many browsers (e.g Firefox) allow you to specify the type of a file you want to view. So if you specify '''json''' as the type, this will make the browser show it in a long but fairly readable format.  


Many browsers (e.g Firefox) allow you to specify the type of a file you want to view. So if you specify json as the type this will make the browser show it in a long but fairly readable format. This api is how the current data (now.html) page in the admin interface gets its data. Each table cell contains a span element and each span element is given an id attribute whose value matches one of the items in the json stream coming via the api.
Each table cell (on a admin interface page that lists your weather data in a tabular format), contains a span element. Each span element is given an '''id attribute''' whose value matches one of the items in the json stream coming via the api.


This same api can be used to get weather data into another device, although you may prefer to use MQTT instead as that is more easily customised to just share the few weather values you might want.
This same api can be used to get weather data into another device, although you may prefer to use MQTT instead as that is more easily customised to just share the few weather values you might want.
Line 19: Line 85:
===Technical aside===
===Technical aside===


When reading the support forum (or articles in this Wiki), you may see mention of AJAX and WebSockets. They are both methods of exchanging information between a web page and the data source.  In the Cumulus MX context, they represent two ways of updating the data shown on an admin interface page like '''now.html''' or ''todayyest.html''.
When reading the support forum (or articles in this Wiki), you may see mention of AJAX and Web Sockets. They are both methods of exchanging information between a web page and the data source, and explained below.   
 
In the Cumulus MX context, they represent two ways of updating the data shown on an admin interface page like '''now.html''' or ''todayyest.html''.
*Steve Loft's MX beta builds used different ports for the two methods, and allowed you to pick which ports were used and which way was used.
*Mark's builds use the same port for both methods, although there is still an optional parameter (when issuing the command to run MX) that can change the port used.
**The latest MX releases use web sockets for updating admin interface pages that you have open, as the "engine" is coded to send updated data on a regular interval (less often in newer releases).
 
'''Asynchronous JavaScript and XML''' (AJAX) is the widely used name for what Microsoft invented as '''XMLHttpRequest''' (late 1999, Internet Explorer 5.0).  Now it is implemented in all browsers, and no longer purely a Microsoft feature.  Put as simply as I can, it lets code (written into JavaScript) ask for updated information from the Cumulus MX engine to update the numbers on the web page.  This is used in the data log editing pages to see if any line update has been successful.


Asynchronous JavaScript and XML (AJAX) is the widely used name for what Microsoft invented as '''XMLHttpRequest''' (late 1999, Internet Explorer 5.0) now it is implemented in all browsers and no longer purely Microsoft feature.  Put as simply as I can, it lets code written into JavaScript ask for updated information from the Cumulus MX engine to update the numbers on the web page.  In the standard Cumulus 1 trends.htm web page, AJAX was used to load an updated graph into the web page each time the client pressed a button requesting a graph.
In the legacy Cumulus 1, for its trends.htm web page, AJAX was used to load an updated graph into the web page each time the client pressed a button requesting a graph.


WebSockets is an improvement on AJAX. While AJAX needs the client to make a request before an update can be made, WebSockets adds the option that the source can generate the request and do a remote update.  Thus when you open ''todayyest.html'', the MX engine gets a request from that web page to insert the various sub-tables into that web page. Subsequently, when WebSocket use is enabled, the MX engine sends updates with new figures, until you close the web page and a '''Connection Closed''' message is sent instead.
WebSockets is an improvement on AJAX. While AJAX needs the client to make a request before an update can be made, WebSockets adds the option that the source can generate the request and do a remote update.  Thus when you open ''todayyest.html'', the MX engine gets a request from that web page to insert the various sub-tables into that web page. Subsequently, when WebSocket use is enabled, the MX engine sends updates with new figures, until you close the web page and a '''Connection Closed''' message is sent instead.
Line 27: Line 100:
== The MQTT interface ==
== The MQTT interface ==


Until this section is written, please see [[Cumulus.ini#MQTT]] for the information you can put into settings, and where to enter it.
Until this section is written, please see [[Cumulus.ini (MX 3.0.0 to 3.7.0)#MQTT]] for the information you can put into settings, and where to enter it.


== The Data Log Viewing and Editing interface ==
== The Data Log Viewing and Editing interface ==


<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section was written around the MX release in July 2020; that is no longer latest!
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section, it may even need a redesign so it can correctly cover both past and more recent releases!
</div>


The '''Data logs''' tab in the admin interface, gives access to screens that can display the contents of 3 types of log files:
The '''Data logs''' tab in the admin interface, gives access to screens that can display the contents of 3 types of log files:
Line 36: Line 114:
#The [[Extra Sensor Files|Extra Sensor log File]]; there is one of these for each month - choose menu item '''Extra Data Logs'''
#The [[Extra Sensor Files|Extra Sensor log File]]; there is one of these for each month - choose menu item '''Extra Data Logs'''
#The [[Dayfile.txt|Daily Summary log file]]; there is only one of these - choose menu item '''Dayfile'''
#The [[Dayfile.txt|Daily Summary log file]]; there is only one of these - choose menu item '''Dayfile'''
<big>This interface has changed in newer releases, and the information here may be out of date.</big>


=== General points common to web pages for editing standard and extra sensor logs ===
=== General points common to web pages for editing standard and extra sensor logs ===
Line 50: Line 130:


'''For all 3 web pages'''
'''For all 3 web pages'''
<big>This interface has changed in newer releases, and the information here may be out of date.</big>


The application programming interface only takes a copy of just 10 (or less if not all ten available) lines from log file and sends those to the admin interface.
The application programming interface only takes a copy of just 10 (or less if not all ten available) lines from log file and sends those to the admin interface.
Line 84: Line 167:
*The way that MX has been written is inconsistent in the way it deals with fields that MX now expects but at the time that any log line was created did not exist. When adding the missing fields, some are added with empty string as content and some are added with a single space as content. When the editing modal is opened it may display placeholder text where a missing field is empty, but if you don't see that place-holder, there is probably a space included in the supposedly empty field (that you can't see), but that space (if not removed) could muck up any number you now want to store there.
*The way that MX has been written is inconsistent in the way it deals with fields that MX now expects but at the time that any log line was created did not exist. When adding the missing fields, some are added with empty string as content and some are added with a single space as content. When the editing modal is opened it may display placeholder text where a missing field is empty, but if you don't see that place-holder, there is probably a space included in the supposedly empty field (that you can't see), but that space (if not removed) could muck up any number you now want to store there.
*If you do edit a line, and then '''Save''', then that particular line (but no others in the log file) will change its length to that used by the current version of MX and you will see additional trailing field separators (commas, semicolons, or whatever defined for your locale) in that line making it seem different from its neighbours. Again you may spot an inconsistency in content as some gaps may appear between delimiters where spaces have been added for fields that were originally missing.
*If you do edit a line, and then '''Save''', then that particular line (but no others in the log file) will change its length to that used by the current version of MX and you will see additional trailing field separators (commas, semicolons, or whatever defined for your locale) in that line making it seem different from its neighbours. Again you may spot an inconsistency in content as some gaps may appear between delimiters where spaces have been added for fields that were originally missing.
== The Edit menu==
As the name suggests, this menu contains various options for editing much of what Cumulus stores. However, to edit the [[Standard log files]], [[Extra Sensor Files]], or [[Dayfile.txt]] you need to use the "Data Logs" menu as described above.
===Today's rain===
Don't use this option near rollover. Decreasing rainfall amount here, increases the "start of day rainfall counter".  It does not correct all rainfall information held by Cumulus, so you may need to make further edits, or wait until next day and see if any remaining issues.
See [[Today.ini#Editing_rainfall_in_today.ini_within_Cumulus|Editing rainfall in 'today.ini']]
===Weather diary===
Allows text to be stored against dates, includes way of reporting snow (if falling, if lying and depth).  See [[Weather Diary]] for general points and [[Diary.db]] for MX specifics.
===Current conditions===
Allows input of free text. Intended as way of getting that text onto your web site (via [[Webtags#Current_Conditions|<#currcond> web tag]]. Note that this is temporary content, it is not retained.
===Extreme editing===
See [[Correcting Extremes]] page which covers using each of the menu selections listed below:
*All time records
*Monthly records
*This month's records
*This year's records


== Changing Settings ==
== Changing Settings ==


All settings are stored in [[Cumulus.ini]], so when you stop and restart MX, it can continue without you entering settings again.
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section was written around the MX release in July 2020; that is no longer latest!
 
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for these sections, they may even need a redesign so it can correctly cover both past and more recent releases!
</div>
All settings are stored in [[Cumulus.ini]], so when you stop and restart MX, it can continue without you entering settings again.  On that linked page, the settings are explained for each settings page, explaining which entry in the configuration file is affected.


Adjusting the majority of the settings is best done using these MX "admin interface" screens simply because for some settings the interface does validation (whilst editing the file directly could introduce invalid settings), you will see that '''Settings''' is the penultimate option in the navigation bar, and it has a drop down for the various settings screens that are now described. [[File:Settings Menu.png|right]]
Adjusting the majority of the settings is best done using these MX "admin interface" screens simply because for some settings the interface does validation (whilst editing the file directly could introduce invalid settings), you will see that '''Settings''' is the penultimate option in the navigation bar, and it has a drop down for the various settings screens that are now described. [[File:Settings Menu.png|right]]
Line 101: Line 215:
If you attempt to set these settings by directly editing the file where they are stored, there is a danger of either making a typo or of choosing an illegal value for a particular attribute.
If you attempt to set these settings by directly editing the file where they are stored, there is a danger of either making a typo or of choosing an illegal value for a particular attribute.


There are however some '''read only''' settings that can not be found in any of the setting screens, for these MX cannot set the values, it can only read them. As MX cannot set the values, you need to edit the [[Cumulus.ini]] file directly, and the referenced Wiki page identifies read-only settings that can only be adjusted by adding parameters directly in the file. The configuration article lists the read-write settings as well, and tells you what values are accepted for those attributes, and also explains some of the differences in the settings available between Cumulus 1 and MX.
For older MX releases, some '''read only''' settings can not be found in any of the setting screens, for these MX cannot set the values, it can only read them. As MX cannot set the values, you need to edit the [[Cumulus.ini (MX_3.0.0_to_3.7.0)]] directly, and the referenced Wiki page identifies read-only settings that can only be adjusted by adding parameters directly in the file. The configuration article lists the read-write settings as well, and tells you what values are accepted for those attributes, and also explains some of the differences in the settings available between Cumulus 1 and MX.
   
   
'''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (The developer has not provided a list anywhere of which settings do, and which do not, take effect immediently, although sometimes a release notice mentions this for a new setting) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the read-write settings in [[Cumulus.ini]], and when you restart it it uses the read-only, and read-write, settings it reads from that file.
'''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (The developer has not provided a list anywhere of which settings do, and which do not, take effect immediently, although sometimes a release notice mentions this for a new setting) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the read-write settings in [[Cumulus.ini]], and when you restart it it uses the read-only, and read-write, settings it reads from that file.
Line 107: Line 221:
=== Program Settings ===
=== Program Settings ===


Applies from Release 3.9.4 - build 3099 onwards
This sub-section is applicable from Release 3.9.4 - build 3099 onwards
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section title was added for Release 3.9.4 - build 3099; that is no longer latest!
 


'''<big>Please would somebody who has experience of this version amend this section</big>'''
'''<big>Please would somebody who has experience of this version amend this section.</big>''' Please work through all MX release announcements and work out all the many updates needed for this page, it may even need a redesign for more recent releases!
</div>


????????????
The '''debug logging''', '''data logging''', and '''stop second instance''' options (each of which can be enabled or disabled) are on this page of the admin interface from version 3.9.4 onwards. For earlier versions, the same options are on the ''Station settings page'' and so [[MX_Administrative_Interface#Options|described for that next section]].


The other options on this page are new, and not available in earlier versions.


=== Station Settings ===
=== Station Settings ===


<big>This applies up to release 3.9.2 - b3097 only</big>
 
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest!
 
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section,
 
recent releases have totally changed the content of all settings pages in the admin interface,
 
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
</div>
 
 


Each setting has a hint beside it (with a small 'i' for information before each hint). If you have used [[Cumulus_Screenshots#Station|Cumulus 1]], the layout and section headings will be familiar. No settings takes effect until '''Save''' button pressed.
Each setting has a hint beside it (with a small 'i' for information before each hint). If you have used [[Cumulus_Screenshots#Station|Cumulus 1]], the layout and section headings will be familiar. No settings takes effect until '''Save''' button pressed.
Line 122: Line 252:
Like all the settings pages, there are headings with settings below them that are collapsed so click headings to see the items under them.  
Like all the settings pages, there are headings with settings below them that are collapsed so click headings to see the items under them.  


The table [[Cumulus.ini#Section:_Station|here for the [Station] section]] will explain how MX stores the selections you make here, and give a bit more detail about each item and the values it can take.  
Please note that '''release 3.10.1''' totally changed the station settings page (and others) compared to earlier MX releases. This Wiki page was originally written for release versions up to 3.6.0, and so the sub-sections covering earlier releases are better laid out than the sub-section covering release 3.10.1 onwards.


Please note that, in the '''Options''' section, there are two settings that take effect immediately '''Save'''  is pressed, but are not written to '''Cumulus.ini''' when MX is closed, so will be reset when MX is restarted; these two exceptions are to use '''Debugging logging''' and to use '''Data Logging'''.  The first adds extra output to the log file created in "CumulusMX/MXDiags" folder reporting in detail each output task MX does. The second adds extra output to the log file created in "CumulusMX/MXDiags" folder reporting in detail each input received from the weather station.
Please note that, in the '''Options''' section, there are two settings that take effect immediately '''Save'''  is pressed, but are not written to '''Cumulus.ini''' when MX is closed, so will be reset when MX is restarted; these two exceptions are to use '''Debugging logging''' and to use '''Data Logging'''.  The first adds extra output to the log file created in "CumulusMX/MXDiags" folder reporting in detail each output task MX does. The second adds extra output to the log file created in "CumulusMX/MXDiags" folder reporting in detail each input received from the weather station.
=== Release 3.10.1 onwards ===
The following list of options and allowed values is taken from '''StationOptions.json''' for release 3.10.2. You will not see all these options as certain settings determine which other settings are shown:
<pre> Select Station :  "Davis Vantage Pro",  "Davis Vantage Pro2/Vue",  "Davis WeatherLink Live",
                        "Oregon Scientific WMR-928",  "Oregon Scientific WM-918", "Oregon Scientific WMR100",  "Oregon Scientific WMR200",
                        "EasyWeather",
                        "Fine Offset", "Fine Offset with Solar Sensors",
                        "Instromet",
                        "Ecowitt GW1000",
                        "LaCrosse WS2300"
  "loginterval":  "1 minute", "5 minutes", "10 minutes", "15 minutes", "20 minutes",  "30 minutes"
  "logrollover": "9am",  "Use 10am in Summer"
  "units":  "wind":  "Metres per second (m/s)",  "Miles per hour (mph)",  "Kilometres per hour (km/h)",  "Knots (kts)"
            "pressure": "Milli-bar (mbar)",      "Hectopascal (hPa)",    "Inches of mercury (inHg)"
            "temp": "Celsius",  "Fahrenheit"
            "rain": "Millimetres",  "Inches"
"advanced": "Here be dragons! Only alter these settings if you understand what they do.",
              "tempdp","pressdp","raindp","winddp", "windavgdp", "windrundp", "airqulaitydp", "sunshinedp", "uvdp"
"Location": "A short name for the location", "A longer description of the location",  "Latitude",  "Longitude"
  "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
                    "Records Began Date"
WEATHER STATION DEPENDENT
"davisvp2": "Serial",  "TCP/IP", "Your station serial port (real or virtual)","Period to disconnect once a minute from IP loggers to allow them to upload to WeatherLink.com. Time in seconds"
      "advanced":  "Here be dragons! Only alter these settings if you understand what they do.",
                    "Synchronise station clock","Read Davis reception stats", "Set the Davis Logger interval to match Cumulus MX interval", "Enable use of the LOOP2 data packets (UseDavisLoop2)", "Davis VP 1-minute barometer update (ForceVPBarUpdate)","Time to wait after establishing a connection to an IP logger before sending commands","TCP/IP port for your logger. Default is 22222",  "Serial port speed in bps",
"daviswll": "Auto-Discovery","api", "Select the ISS transmitter ID for your Wind sensor", "Select the ISS transmitter ID for your Temperature/Humidity sensor", "Select the ISS transmitter ID for your Rain sensor", Select the ISS transmitter ID for your Solar sensor", Select the ISS transmitter ID for your UV sensor", "select the transmitter ID for your extra temperature sensor #1, #2, #3, #4", "Select the transmitter ID for your extra soil moisture sensor #1, #2, #3, #4", "Select the index within the transmitter ID for your soil moisture leaf sensor #1, #2, #3, #4", Select the transmitter ID for your extra leaf sensor #1,#2", "Select the transmitter ID for your extra temperature/humidity sensor #1, #2, #3, #4, #5, #6, #7, #8", "Is sensor #1 a combined temperature/humidity sensor?"
    "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
                "raingaugetype": "Auto",  "Metric (0.2 mm)*",  "Imperial (0.01 in)*", "Metric (0.1 mm)",  "Imperial (0.001 in)"
                "The UDP multicast port used by the WLL, this will normally be discovered from the WLL"
"gw1000":  "Auto-Discovery",  "ipv4",  "macaddress"
"fineoffset":  "Synchronise Reads",
      "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
              "readtime", "vid", "pid"
"easyw": "How often to read the EasyWeather data file in minutes", "filename" "minpressmb", "maxpressmb", "raintipdiff", "pressoffset"
"imet": "comportname", "baudrate"
        "advanced": "Here be dragons! Only alter these settings if you understand what they do.",
              "syncstationclock",  "syncclockhour",  "updatepointer","waittime", "readdelay"
"wmr928": "comportname"
"LaCrosse": "Use computer clock instead of LaCrosse station clock for archive data"
"Options": "Use bearing zero when calm"", "Calculate average wind speed", "Use speed for average calculation", "Use 100% for 98% humidity", "Calculate dew point", "Cumulus pressure trend names", "Round wind speeds to the nearest whole number", "Display and log extra sensors, if fitted", "Make Cumulus MX run even if you do not have the minimum sensors required (temp, press, wind)"
      "advanced":  "Here be dragons! Only alter these settings if you understand what they do.",
                    "Period of time in minutes to average out wind bearings", "Period of time in minutes to average out wind speeds", "Period of time in minutes to record the peak gust speed"
"Forecast": "Use the Zambretti forecast generated by Cumulus", "If using the Cumulus forecast, update only once an hour rather than every data update", "The low pressure extreme for your location", "The high pressure extreme for your location", "The units that you have used for the pressure extremes"
  "Solar": "Select the algorithm to use for solar irradiation calculations", "The percentage of the current theoretical solar value above which the sun should be considered to be shining (default = 75)", "The minimum solar reading for the sun to be considered to be shining (default = 0)", "The R-S transmission factor of the solar radiation through the atmosphere (0.70 - 0.91, default 0.80)", "The Bras turbidity factor (1.00=clear, 5.00=smoggy, default = 2.00)"
  "AnnualRainfall": "Enter a rainfall amount to be added to the total for the year when you started using Cumulus - for the period for which you have no Cumulus data",  "Enter the year to apply the correct to (normally this year or last year) as a four digit number. Leave as zero to disable", "Select the month from which the annual total is to be calculated",
  "Graphs": "The number of hours shown on the minute-by-minute graphs", "The number of days shown on the daily graphs"; SHOW/HIDE: "Outdoor Temperature", "Indoor Temperature", "Heat Index", "Dew Point", "Wind Chill", "Apparent Temperature" , "Feels Like", "Humidex", "Daily Maximum Temperature", "Daily Average Temperature", "Daily Minimum Temperature", "Outdoor Humidity", "Indoor Humidity", "UV Index", "Solar Irradiation",  "Sunshine Hours"
  "DisplayOptions": "Enabling this option will display Apparent temperature on the default web site/Disabling this option will display Feels Like temperature on the default web site", "Display Solar data", "Display UV-I data", "The number of cardinal points to display on the Wind Rose",
</pre>


==== Station Type ====
==== Station Type ====
Line 206: Line 388:




<big>This applies from Beta MX version 3.0.0 to release 3.9.2 - b3097 only</big>
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 259: Line 442:
'''Extra Sensors''' - any sensors whose readings are logged in the standard log file are not '''extra'''. You tick here if you want Cumulus to log sensors using the extra sensors log file. Both log files are known as monthly logs in that a new log is created for each new month. (This is nothing to do with the '''special log''' that Cumulus 1 maintained for multiple temperature and humidity readings, as it is not available in MX).
'''Extra Sensors''' - any sensors whose readings are logged in the standard log file are not '''extra'''. You tick here if you want Cumulus to log sensors using the extra sensors log file. Both log files are known as monthly logs in that a new log is created for each new month. (This is nothing to do with the '''special log''' that Cumulus 1 maintained for multiple temperature and humidity readings, as it is not available in MX).


'''Debug logging''' is used to switch on extra debugging information (about what Cumulus does in its processing) in the [[MXDiags]] log file.  It only remains on until either it is turned off here or Cumulus is closed. Use [[Cumulus_MX#Parameter_for_adding_debugging|a parameter '''-debug''' for adding debugging]] when you start Cumulus if you want the debugging to persist.
'''Debug logging''' is used to switch on extra debugging information (about what Cumulus does in its processing) in the [[MXdiags_folder]] log file.  It only remains on until either it is turned off here or Cumulus is closed. Use [[Cumulus_MX#Parameter_for_adding_debugging|a parameter '''-debug''' for adding debugging]] when you start Cumulus if you want the debugging to persist.


'''Data logging'''  is used to switch on extra debugging information (about interaction between weather station and Cumulus) in the [[MXDiags]] log file.  It only remains on until either it is turned off here or Cumulus is closed. Use [[Cumulus_MX#Parameter_for_adding_debugging|a parameter '''-logging''' for adding data logging]] when you start Cumulus if you want the data logging to persist.
'''Data logging'''  is used to switch on extra debugging information (about interaction between weather station and Cumulus) in the [[MXdiags_folder]] log file.  It only remains on until either it is turned off here or Cumulus is closed. Use [[Cumulus_MX#Parameter_for_adding_debugging|a parameter '''-logging''' for adding data logging]] when you start Cumulus if you want the data logging to persist.


'''Stop second instance'''  Invokes code that stops you having 2 copies of MX running at same time and conflicting.
'''Stop second instance'''  Invokes code that stops you having 2 copies of MX running at same time and conflicting.
Line 291: Line 474:


=== Internet Settings ===
=== Internet Settings ===
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest!
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section,
recent releases have totally changed the content of all settings pages in the admin interface,
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
</div>


All settings entered here are stored in [[Cumulus.ini]]. No settings take effect until '''Save''' button pressed. [[File:Include graph data files.PNG|right]]
All settings entered here are stored in [[Cumulus.ini]]. No settings take effect until '''Save''' button pressed. [[File:Include graph data files.PNG|right]]


All retain their settings when MX is restarted. No settings take effect until '''Save''' button pressed. This includes '''FTP logging''' in '''Web/FTP settings''' section, (it is not in this image as it is further down), which is used to add additional information to [[MXDiags]] about standard File Transfer Process actions; it will persist across stopping and restarting MX, so you must switch it off here (or with MX stopped within [[Cumulus.ini#Section:_FTP_site|Cumulus.ini '''FTP site''' section]].
Some settings don't take full effect unless, after saving the change, you restart MX. There is not yet a definitive list of which settings are only read when MX is started, but for example from build 3048 onwards the '''enable/disable Realtime FTP''' setting does not need a restart, but for earlier builds of MX it does.
 
All retain their settings when MX is restarted. No settings take effect until '''Save''' button pressed. This includes '''FTP logging''' in '''Web/FTP settings''' section, (it is not in this image as it is further down), which is used to add additional information to [[MXdiags_folder]] about standard File Transfer Process actions; it will persist across stopping and restarting MX, so you must switch it off here (or with MX stopped within [[Cumulus.ini#Section:_FTP_site|Cumulus.ini '''FTP site''' section]].


The MX settings on this web page have a lot of similarities with the [[Cumulus_Screenshots#Sites.2FOptions_Tab|Cumulus 1 settings]]
The MX settings on this web page have a lot of similarities with the [[Cumulus_Screenshots#Sites.2FOptions_Tab|Cumulus 1 settings]]
Line 301: Line 498:
*some defaults are different in the two flavours.  
*some defaults are different in the two flavours.  


While Cumulus 1 only supports standard FTP, MX supports tha,t plus SFTP and FTPS.  Which you select depends on your web site, it might be that you used a tool to manually upload files and so you can copy settings from that tool into the MX settings.
 
==== Admin Interface: Settings Menu: Internet settings: '''Web/FTP settings''' ====
 
{{Version badge Mx}}[[File:Include graph data files.PNG|right]]
#Click on this heading to expand settings as per illustration.
#''Auto update''
#*Tick this to enable updates to a web server by MX. (Don't tick it if you don't have any web space).
#''Include standard files''
#* Standard files are the web page templates in the web folder, each file as a name ending in "T.htm". Tick here if you want those files to be processed by MX and uploaded at standard web interval to the host and directory we have set earlier.
#''Include graph data files''
#* These are files with an extension ".json" and MX generates these automatically, storing them in the web folder. Tick here (as arrowed) if you want those files to be processed by MX and uploaded at standard web interval to the host and directory we have set earlier.
#''Include Moon image file''
#*We first need to set (later on this same settings page) that MX is to use system drawing to produce "moon.png" in the same web folder from "MoonBaseImage.png" in that folder. The base image is of a full moon, MX uses system drawing to generated a masked version of this image every hour that reflects the current phase of the moon and stores that in "moon.png".
#*With "moon.png" being generated, we can tick here to include the new image in an upload by FTP every hour.
#''ActiveFTP mode, FTP rename, Delete before upload''
#*Please be guided by the tips below these selections on the settings page.
#''UTF-8 encoding''
#*Cumulus supports just two encodings, please see [[Webtags#Encoding|Encoding]] section in another article for more information. Here just tick this selection for standard web pages.
#''FTP logging''
#*Normally, this is left unticked, but if you want to check MX is uploading (and you use the simple FTP protocol), you can tick this for every FTP transfer to be logged to [[MXdiags_folder]].
#''Upload interval''
#*Standard web pages are updated on the hour and every x minutes thereafter, where x is the number you enter here. Most people would choose 10, 15, 20, or 30, here depending how much uploading they want, and how up to date they want the displayed information to be.
#*As an aside, if you are not using the standard web pages, many [[:Category:User Contributions|third party]] web pages use ajax (don't worry about what that is) to allow some of the web page content to be updated far more frequently than the actual web pages get uploaded.
#The realtime settings are only needed for the gauges page and settings depend on your MX version, right hand picture is Cumulus MX settings screen)[[File:Cumulus MX realtime settings.png |Right]]
 
From build 3042, MX automatically uploads the realtimegauges.txt file.
 
Note that the realtimegaugesT.txt file for MX is slightly different to the one for Cumulus 1, and it is important to use the one supplied with MX for MX.
 
You have now told Cumulus how to update your web space with the [[Customised_templates#The_Standard_Templates |Standard Cumulus Template]] files for the web.
 
====ADDITIONAL INSTRUCTIONS FOR OLDER MX BUILDS:====
 
Prior to build 3042, you also need to specify an extra file in the table for the steel series gauges page to work:[[File:Extra web settings.png | Right]]
#'Local filenames' column
#*Enter the path and filename for the realtimegaugesT.txt file where shown by red box. This will normally be web\realtimegaugesT.txt on Windows, and web/realtimegaugesT.txt on other platforms.
#'Remote filenames' column
#*The green box shows where you must type the path to where you want the web page to appear (i.e. where the other web pages are uploaded to) ending with the file name '' realtimegauges.txt''. Typically the path will involve specifying the directory you entered on the 'Sites/Options' tab (see the 'Web Site' settings step 3 for that tab above).
#'Process?' column
#*Select this (ringed in purple), as ''realtimegaugesT.txt'' contains web tags and needs to be processed to create the remote file.
#'Realtime?' column
#*Select this (ringed in purple), only ''if you want the file to be created at whatever interval you have defined for real-time updates'' (see 'web settings' point 7 above for where you did that); otherwise it will be updated on your web site at the normal updating interval.
# 'FTP?' column
#*Select this (ringed in purple) if the destination is remote (don't select if the destination is local).
#'UTF-8?' column
#*This is irrelevant for this file.
 
==== Other Internet Settings ====
While Cumulus 1 only supports standard FTP, MX supports that plus SFTP and FTPS.  Which you select depends on your web site, it might be that you used a tool to manually upload files and so you can copy settings from that tool into the MX settings.


Like Cumulus 1, MX has an '''External Programs''' section. Here you can enter a command and (in separate box) parameters for 3 possible timings (at real-time, at interval, and at end of day). Typically, on a windows device you would enter the name of a batch file (filename ends in .cmd). On a device running Linux, it could be a shell command file (ends in .sh) or indeed a command like "php" to run a php script whose name is specifed in parameters box.  The final parameter might be preceded by ">" to direct the output to a log file.
Like Cumulus 1, MX has an '''External Programs''' section. Here you can enter a command and (in separate box) parameters for 3 possible timings (at real-time, at interval, and at end of day). Typically, on a windows device you would enter the name of a batch file (filename ends in .cmd). On a device running Linux, it could be a shell command file (ends in .sh) or indeed a command like "php" to run a php script whose name is specifed in parameters box.  The final parameter might be preceded by ">" to direct the output to a log file.
Line 324: Line 569:
This is an extension of the Cumulus 1 facility on the "Files" tab of its Internet Settings.  
This is an extension of the Cumulus 1 facility on the "Files" tab of its Internet Settings.  


How to use these settings is explained for both Cumulus flavours on  [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|this wiki page]], MX has an extra "end of day" (EOD) option, but otherwise you fill it out exactly the same way.  Settings in one table cell are stored when you click in another table cell.  
[[File:Extra web settings.png]]How to use these settings is explained for both Cumulus flavours on  [[Customised_templates#What_to_select_on_the_.27Files.27_tab_of_the_Internet_Settings_screen_within_the_.27Configuration.27_menu|this wiki page]], MX has an extra "end of day" (EOD) option, but otherwise you fill it out exactly the same way.  Settings in one table cell are stored when you click in another table cell.  
 
#'''Local Filename'''
#*Enter here something like "<currentlogfile>" or "./web/moon.png" or "./data/dayfile.txt" or "./webMX/realtime-xT.txt"
#*You will see that "./" specifies the folder where '''CumulusMX.exe''' is stored, and you can refer to sub-folders within it that MX provides or for non-standard files that you have added
#'''Destination Filename'''
#*You can put a path to somewhere else on the device running MX here, or a path from your FTP root on your web server.
#*Always enter a full path and file name, but you can incorporate in what you put here any of the constants that MX provides (which are  "<currentlogfile>" and  "<currentextralogfile>" and "<airlinklogfile>")
#'''Process'''
#*You tick this box if, and only if, the file specified in '''Local Filename''' is a Cumulus Template file, i.e. it contains [[Webtags#The_Web_Tags_for_Cumulus|Cumulus Web Tags]].
#*A template file can have any file extension you like (e.g. '''.tmpl''' or ''.cum'' can be used in '''Local Filename''') and used to generate any of these file types: .htm, .html, .js, .json, .php, .txt (used in '''Local Filename''')
#'''Realtime'''
#* Only available if you have selected "Enable realtime" in the '''Internet Settings''' page as described above
#*You tick this box if you want the local filename read, and the destination filename created at the interval you have set up for real time processing
#'''FTP'''
#* Only available if you have defined host and other settings for FTP, SFTP, or FTPS, in the  '''Internet Settings''' page as described above
#*You tick this box if you want the file to be transferred using the defined settings
#'''UTF-8'''
#*For the content of files to be understood they must use the right [[Reports_folder#Encoding|Encoding]]. You can follow the link for the full technical explanation.
#*For non-technical people, tick this whenever you leave the next box un-ticked, it is safest as this signifies the modern standard encoding
#'''Binary'''
#*You tick this box if what you are uploading is for example an image file (.jpeg, .png, and many others) or complied code
#*You leave this box without a tick if what you are uploading is text (any of these file types: .htm, .html, .js, .json, .php, .txt)
#'''End of day'''
#*You tick this box if you want the local filename read, and the destination filename created when Cumulus is processing the end of any meteorological day
#*Note that if neither '''Realtime'''  nor '''End of day''' are ticked, the local filename is read, and the destination filename created when Cumulus is processing the Standard Upload Interval as defined by your settings
#*Although to tick both real-time and end-of-day (EOD) seems nonsensical, MX will let you tick both for any selected file(s), as it will then do any processes, and uploads, at both intervals. I don't see why you should do that for normal running, but you might tick both to test a template without waiting for EOD, and after it has been processed once, remove the unwanted real-time tick, so from then onwards it just happens at EOD
 
Although, there is no Save button (as clicking in another cell stores previous edit), you can optionally press the "Enter" button (as labelled on many keyboards) to be sure you have saved all edits made before you leave the web page.
 
 


Although, there is no Save button as clicking in another cell stores previous edit, the "Enter" button on many keyboards can optionally be used to be sure you have saved all edits made before you leave the screen.


Although to tick both real-time and EOD seems nonsensical, MX will let you tick both for any selected file(s), as it wil then do any processes, and uploads, at both intervals. I don't see why you should do that for normal running, but you might tick both to test a template without waiting for EOD, and after it has been processed once, remove the unwanted real-time tick, so from then onwards it just happens at EOD.
====Been using legacy Cumulus?====


'''If you have moved from Cumulus 1''', and are therefore using an existing Cumulus.ini, these screens may be partly pre-populated, but because mX adds extra options you might need to:
'''If you have moved from Cumulus 1''', and are therefore using an existing Cumulus.ini, these screens may be partly pre-populated, but because MX adds extra options you might need to:
# change some paths in local column, (if your Cumulus 1 and your MX locations are different)
# change some paths in local column, (if your Cumulus 1 and your MX locations are different)
#*if you have moved to a Raspberry Pi, or other Unix-derived operating system, remember that path names in Windows use "\" as directory separator, but all other systems use "/".   
#*if you have moved to a Raspberry Pi, or other Unix-derived operating system, remember that path names in Microsoft Windows operating systems use "\" as directory separator, but all other systems use "/".   
#*There is more advice available at [[Setting_up_Raspberry_Pi#Configuration_files]].
#*There is more advice available at [[MX_on_Linux#Configuration_files]].
# untick one column, and tick another, now that EOD is an option for the timing as well as real-time and (normal logging/ftp) interval.
# untick one column, and tick another, now that '''End of day''' is an option for the timing as well as real-time and (normal uploading/ftp) interval.
# edit some templates (local files) where the process column is ticked because of [[Webtags|Web tags differences]] (some output modifiers are interpreted differently), you will need to revisit every web tag in every template to check whether the output format will need to be added, or amended, to give the output you want.
# edit some templates (local files) where the process column is ticked because of [[Webtags|Web tags differences]] (some output modifiers are interpreted differently), you will need to revisit every web tag in every template to check whether the output format will need to be added, or amended, to give the output you want.
# you should not need to change remote file names, providing that you have not changed any directories on your web site as (like in Cumulus 1), for extra files, the remote path/file name required ignores any directories specified on Internet Settings screen for FTP settings.
# you should not need to change remote file names, providing that you have not changed any directories on your web site as (like in Cumulus 1), for extra files, the remote path/file name required ignores any directories specified on Internet Settings screen for FTP settings.
Line 343: Line 617:
=== Calibration settings ===
=== Calibration settings ===


This is identical to [[Cumulus_Screenshots#Calibration|Cumulus 1 screen]] functionality, already explained in [[FAQ#I_get_very_large_amounts_of_rainfall_shown.2C_or_other_high_readings|Cumulus 1 FAQ here]] and [[Dayfile.txt#Dealing_with_rogue_measurements|"Dealing with rogue measurements"]] in this wiki.
This is identical to [[Cumulus_Screenshots#Calibration|Cumulus 1 screen]] functionality, already explained in [[FAQ#I_get_very_large_amounts_of_rainfall_shown.2C_or_other_high_readings|Cumulus 1 FAQ here]] and for MX described in [[Cumulus.ini#Spike_Removal|Spike removal]] section of this Wiki.


=== NOAA report settings ===
=== NOAA report settings ===
Line 349: Line 623:
[[File:NOAA settings.png|right | 200 px]]  
[[File:NOAA settings.png|right | 200 px]]  


This is identical to Cumulus 1 functionality, the various settings available on this screen are already explained [[Cumulus.ini#Section:_NOAA|for the settings file here]].
The various settings available on this screen are explained [[Cumulus.ini#Optional_Report_Settings|here]].


Just a quick reminder here that while Cumulus 1 is case insensitive for the code for the different ways to specify a month, MX only accepts upper case ('MM' for digits, 'MMM' for 3 letter month etc.), read more about [[Webtags#NOAA_style_Report_Naming|the naming here]].
Just a quick reminder here that while Cumulus 1 is case insensitive for the code for the different ways to specify a month, MX only accepts upper case ('MM' for digits, 'MMM' for 3 letter month etc.), read more about [[Reports_folder#NOAA_style_Report_Naming|the naming here]].


=== MySQL settings ===
=== MySQL settings ===
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest!
Appeal to contributors: Please work through all MX release announcements and work out any updates needed for this section,
recent releases have totally changed the content of all settings pages in the admin interface,
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
</div>


Cumulus MX includes functionality not in Cumulus 1, and this is one example of a new feature.  It is designed to automate updating of MySQL databases whose schema has each table based on one of the Cumulus log files. This MX feature was developed from [[ImportCumulusFile|this script]] for Cumulus 1.  
Cumulus MX includes functionality not in Cumulus 1, and this is one example of a new feature.  It is designed to automate updating of MySQL databases whose schema has each table based on one of the Cumulus log files. This MX feature was developed from [[ImportCumulusFile|this script]] for Cumulus 1.  
Line 501: Line 786:
# Now move down the screen and click the '''Save''' button, and wait for MX to pop up '''Settings Saved''' message.
# Now move down the screen and click the '''Save''' button, and wait for MX to pop up '''Settings Saved''' message.


===== Another table unpdated at an interval measured in seconds =====
===== Another table updated at an interval measured in seconds =====


*6. ''Custom upload - seconds interval''
*6. ''Custom upload - seconds interval''
Line 511: Line 796:


=== Alarms  ===
=== Alarms  ===
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest!
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section,
recent releases have totally changed the content of all settings pages in the admin interface,
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
</div>


This is identical to Cumulus 1 functionality, apart from using a new default location for the files "\CumulusMX\interface\sounds", and  the list of alarms available is extended in MX compared to Cumulus 1.
This is identical to Cumulus 1 functionality, apart from using a new default location for the files "\CumulusMX\interface\sounds", and  the list of alarms available is extended in MX compared to Cumulus 1.
Line 519: Line 816:


=== FTP Now ===
=== FTP Now ===
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This section was last updated for the MX release in July 2020; that is no longer latest!
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this section,
recent releases have totally changed the content of all settings pages in the admin interface,
consequently, the whole page may even need either a replacement set of pages, splitting of this page into multiple pages, or just a redesign of this section, for more recent releases!
</div>


This is similar to the option in the file menu of Cumulus 1 to do an update now. Depending on which build of MX you are using, the functionality varies. On latest build it does whatever updates are set up to happen at normal updating interval whether these are by FTP to your web site, or by copying files between local and remote filenames with path (although both could be on same device).
This is similar to the option in the file menu of Cumulus 1 to do an update now. Depending on which build of MX you are using, the functionality varies. On latest build it does whatever updates are set up to happen at normal updating interval whether these are by FTP to your web site, or by copying files between local and remote filenames with path (although both could be on same device).
Line 615: Line 924:


There is a section of the support forum devoted to [https://cumulus.hosiene.co.uk/viewforum.php?f=28 Cumulus MX interface customisation], so you can see what other people are doing.  There is also [https://cumulus.hosiene.co.uk/viewforum.php?f=36 another sub-forum] for making suggestions on what you would like added to MX.
There is a section of the support forum devoted to [https://cumulus.hosiene.co.uk/viewforum.php?f=28 Cumulus MX interface customisation], so you can see what other people are doing.  There is also [https://cumulus.hosiene.co.uk/viewforum.php?f=36 another sub-forum] for making suggestions on what you would like added to MX.
[[Category:Cumulus_MX]]
NeilThomas
313

edits

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

Navigation menu