Category:Cumulus MX: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
1,685 bytes added ,  05:37, 28 May 2020
m
(9 intermediate revisions by the same user not shown)
Line 774: Line 774:
== The Data Log Viewing and Editing interface ==
== The Data Log Viewing and Editing interface ==
[[File:Data Logs Options.png|right|800px]]
[[File:Data Logs Options.png|right|800px]]
The '''Data logs''' tab in the admin interface a shown right gives access to screens that can display the contents of [[Monthly log files|Detailed log files for any month]] with menu item '''Data logs''' (yes same name as tab),  the [[Extra Sensor Files|Extra Sensor Log Files]] with menu item '''Extra Data Logs''', and the [[Dayfile.txt|daily summary log (dayfile.txt)]] with menu item '''Dayfile'''.
The '''Data logs''' tab in the admin interface, as shown in image to right (which is taken from an experimental version, the released version of mX has different headings), gives access to screens that can display the contents of [[Monthly log files|Detailed log files for any month]] with menu item '''Data logs''' (yes same name as tab),  the [[Extra Sensor Files|Extra Sensor Log Files]] with menu item '''Extra Data Logs''', and the [[Dayfile.txt|daily summary log (dayfile.txt)]] with menu item '''Dayfile'''.


All screens use the datatables library to access the application programme interface (api) representing the selected log file, and the schema used is based on that defined in the version of MX you are running.
All screens use the datatables library to access the application programme interface (api) generated by MX for representing the selected log file, and to produce the formatted output that you see. In the api the schema used is based on that defined in the version of MX you are running, with nulls added for any fields in the current schema, but not in the schema when the line being read was created.


Version 3.6.1 changes the wording on the pop up dialogs showing a single row; Earlier versions used "Close", "Edit" buttons. Later versions use the more meaningful "Cancel" and "Save" buttons respectively. The new terminology takes precedence in the following sub-sections.
Version 3.6.1 changes the wording on the pop up dialogs for editing a single row; Earlier versions used "Close", "Edit" buttons. Later versions use the more meaningful "Cancel" and "Save" buttons respectively for '''Edit''' on main screen. All versions use "Cancel" and "Delete" respectively on the pop up dialog when selecting "Delete" on main screen. The new terminology takes precedence in the following sub-sections.


<big>WARNING: In any of these editors, when you save a row that was shorter because it was created by an earlier version, datatables will store the row with the length defined in the MX version you are using, so extra commas (and any values you set) will be added to end of just any line that has been edited, leaving other lines unchanged in length.</big>
<big>WARNING: In any of the log files, if you choose to Edit a row, when you then save it, if that row that was originally shorter because it was created by an earlier version, MX will have generated nulls for the extra fields, thus datatables will store the row with the length defined in the MX version you are now using, so extra commas (and any values you set) will be added to end of just any line that has been edited, leaving other lines in the log file unchanged in length.</big>


=== Data logs ===
=== Data logs ===
Line 828: Line 828:


=== Station Settings ===
=== Station Settings ===
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. Like all the settings pages, the headings are collapsed and need to be clicked to see the items under them. The table [[Cumulus.ini#Section:_Station|here]] 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. No settings take 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 take effect until '''Save''' button pressed.
 
Like all the settings pages, the headings are collapsed and need to be clicked 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, in the '''Options''' section, there are two settings that take effect immediately '''Save''' is pressed, but are not written to '''Cumulus.ini''' and 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.


=== Internet Settings ===
=== Internet Settings ===
This has a lot of similarities with the [[Cumulus_Screenshots#Sites.2FOptions_Tab|Cumulus 1 settings]], except that this screen only covers what was on the main tab in Cumulus 1. Again there are hints, MX has more options than Cumulus 1 had, and some defaults are different in the two flavours. No settings take effect until '''Save''' button pressed. In Cumulus 1, you had one setting to upload the standard files and that included web pages, moon image, and the graphs. MX has separate selection settings for the uploading the standard files (web pages), the include graph files (JSON files used by charts) [[File:Include graph data files.PNG]], for generating the moon image, and for uploading the moon image.


Windy has been added to the external web sites that can be automatically updated. No settings take effect until '''Save''' button pressed.
This has a lot of similarities with the [[Cumulus_Screenshots#Sites.2FOptions_Tab|Cumulus 1 settings]], except that this screen only covers what was on the main tab in Cumulus 1. Again there are hints, MX has more options than Cumulus 1 had, and some defaults are different in the two flavours. No settings take effect until '''Save''' button pressed.
 
[[File:Include graph data files.PNG|right]]
 
In Cumulus 1, you had one setting to upload the standard files and that included web pages, moon image, and the graphs. MX has separate selection settings for the uploading the standard files (web pages), the include graph files (JSON files used by charts), for generating the moon image, and for uploading the moon image. See image where the graph file option is arrowed.
 
All settings entered here are stored in [[Cumulus.ini]] and all (including '''FTP logging''' in '''Web/FTP settings''' section, it is not in the image as it is further down) retain their settings when MX is restarted. No settings take effect until '''Save''' button pressed.
 
Each section for an external web site has a number of parameters to set, once set MX will automatically upload to that site the weather values in the correct format. Windy has been added to the external web sites that can be automatically updated. No settings take effect until '''Save''' button pressed.


The main new feature within this settings page is a '''Custom Http''' section. Within here you can define commands to be executed either at some multiple of seconds interval, and/or at a selected intervals in minutes, and/or at end of day (in [[#MX_End_of_Day_Process|EOD sequence shown below]], the Custom HTTP is run before external programs are run, and that is before upload of Extra Files at EOD). In each of these you can use web tags to supply values for parameters to the command. Typically this would be used to send information to a remote web server. Here is a Custom HTTP  example <pre>https://the_URL_here/your_api_here?winddir=<#avgbearing>&windspeedmph=<#wspeed>&windgustmph=<#wgust>&tempf=<#temp>&rainin=<#rhour>&baromin=<#press>&dewptf=<#dew>&humidity=<#hum>&uv=<#UV>"</pre>  No settings take effect until '''Save''' button pressed. You need to turn on enhanced debug logging to see any confirmation that the http has run:
The main new feature within this settings page is a '''Custom Http''' section. Within here you can define commands to be executed either at some multiple of seconds interval, and/or at a selected intervals in minutes, and/or at end of day (in [[#MX_End_of_Day_Process|EOD sequence shown below]], the Custom HTTP is run before external programs are run, and that is before upload of Extra Files at EOD). In each of these you can use web tags to supply values for parameters to the command. Typically this would be used to send information to a remote web server. Here is a Custom HTTP  example <pre>https://the_URL_here/your_api_here?winddir=<#avgbearing>&windspeedmph=<#wspeed>&windgustmph=<#wgust>&tempf=<#temp>&rainin=<#rhour>&baromin=<#press>&dewptf=<#dew>&humidity=<#hum>&uv=<#UV>"</pre>  No settings take effect until '''Save''' button pressed. You need to turn on enhanced debug logging to see any confirmation that the http has run:
5,838

edits

Navigation menu