5,838
edits
mNo edit summary |
mNo edit summary |
||
(19 intermediate revisions by 2 users not shown) | |||
Line 34: | Line 34: | ||
==Need to install MX 3.12.0 == | ==Need to install MX 3.12.0 == | ||
If you are using Cumulus 1 or a release of MX earlier than 3.12.0, be aware that the content of "Cumulus.ini" is totally different to the file for later MX releases. It might have been better had the file been given a new name in release 3. | If you are using Cumulus 1 or a release of MX earlier than 3.12.0, be aware that the content of "Cumulus.ini" is totally different to the file for later MX releases. (It might have been better had the file been given a new name in release 3.12.0). | ||
The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from [https://github.com/cumulusmx/CumulusMX/releases/download/b3141/CumulusMXDist3141.zip here] and runs that release for a while before upgrading to the latest release [https://github.com/cumulusmx/CumulusMX here]. | The way the developer decided to implement it, is that when somebody installs release 3.12.0, any existing "Cumulus.ini" file is renamed, and a new "Cumulus.ini" file is created from scratch, and from then onwards all changes apply to the new file. As 3.12.0 is the only release that can create the replacement file, it is highly recommended that anybody currently using an older release, downloads 3.12.0 from [https://github.com/cumulusmx/CumulusMX/releases/download/b3141/CumulusMXDist3141.zip here] and runs that release for a while before upgrading to the latest release [https://github.com/cumulusmx/CumulusMX here]. | ||
Line 153: | Line 153: | ||
The MX software offers much functionality and flexibility. Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting. | The MX software offers much functionality and flexibility. Consequently, it has an extensive set of configuration settings, fortunately apart from the initial settings of model and units (see next sub-section), recent releases have simplified many of the settings for optional features by providing particular selections to affect a whole range of others (for predicted uses), instead of forcing you to individually work through every individual setting. | ||
<big>Please see [[First Run of MX]] for how to set up settings when you first use MX.</big> | |||
==What happens if I upgrade MX?== | ==What happens if I upgrade MX?== | ||
Line 279: | Line 258: | ||
As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file. You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page. | As a specific example, release 3.11.0 added emailing capability; that requires quite a lot of new parameters to be added to the file. You could use MX without these new parameters, but the Alarm Settings page would not allow you to click '''Enable''' until you had defined various settings on another Settings page, as well as on this Alarm Settings page. | ||
=Tables listing Settings= | =Tables listing Settings= | ||
Line 2,253: | Line 2,230: | ||
|} | |} | ||
==Optional Report Settings== | |||
* File Section is [NOAA] | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
!style="width:30px" | | !style="width:30px" | Parameter Line Entry | ||
!style="width:100px" | | !style="width:100px" | Introduced | ||
!style="width:100px" | MX Section | |||
!style="width:60px" | Label on Settings page | |||
!style="width:20px" | Default | |||
!style="width:300px" | Description | !style="width:300px" | Description | ||
|- | |- | ||
| | | AutoCopy=0 | ||
| | | Release 3.12.0 | ||
| | | NOAA Reports Settings → FTP Options | ||
| Auto Copy NOAA report files | |||
| 0 (disable) | |||
| Simple tick or not | |||
* Tick (value shown as 1 in Cumulus.ini) if your report is to be copied to copy directory during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]] | |||
* Don't tick (value shown as 0 in Cumulus.ini) for no copy action | |||
|- | |- | ||
| AutoFTP=0 | |||
| Settings | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → FTP Options | ||
| Auto transfer NOAA report files | |||
| 0 (disable) | |||
| Simple tick or not | |||
* Tick (value shown as 1 in Cumulus.ini) to enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed) | |||
* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process | |||
|- | |- | ||
| Settings | | AutoSave=1 | ||
| | | First with Cumulus 2 | ||
| NOAA Reports Settings | |||
| Create NOAA files after daily rollover | |||
|0 | |||
| Simple tick or not | |||
* Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required | |||
|- | |- | ||
| Settings | | City= | ||
| | | First with Cumulus 2 | ||
| NOAA Reports Settings → Site Details | |||
| City | |||
| (empty) | |||
| Enter here your hamlet, village, town, or city, name | |||
|- | |- | ||
| Settings | | CoolingThreshold=22 | ||
| | | First with Cumulus 2 | ||
| NOAA Reports Settings → Thresholds | |||
| Cooling threshold | |||
| 65<sup>o</sup> F or 18.3<sup>o</sup>C | |||
| [[Heat/cold_degree_days_and_Chill_hours#Cold_Degree_Days|Cold Degree Days]] are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. An international standard says 22 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables. | |||
|- | |- | ||
| Settings | | CopyDirectory= | ||
| | | Release 3.12.0 | ||
| NOAA Reports Settings → Report Options | |||
| Copy Directory | |||
| (empty) | |||
| The folder on the web server you host to which reports are to be copied | |||
|- | |- | ||
| Settings | | FTPDirectory= | ||
| | | First with Cumulus 2 | ||
| NOAA Reports Settings → FTP Options | |||
| destination folder | |||
| Depends on release: | |||
* (3.1.0 to 3.11.4) blank | |||
* (3.12.0 onwards) to match change in default web site script specification of '''Reports''' folder | |||
| Specify the destination folder for file transfer to, on your FTP server | |||
*Leave at default (for your release) and MX will work with the default web pages script supplied (at same release) | |||
* Specify a folder relative to FTP root, and MX will upload reports to that folder instead (you are then responsible for writing any script on your web site to find each report and do any processing). | |||
|- | |- | ||
| Settings | | HeatingThreshold=15.5 | ||
| An | | First with Cumulus 2 | ||
| NOAA Reports Settings → Thresholds | |||
| Heating threshold | |||
| 65<sup>o</sup> F or 18.3<sup>o</sup>C | |||
|[[Heat/cold_degree_days_and_Chill_hours#Heat_Degree_Days| Heating Degree Days]] are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. An international standard says 15.5 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables. | |||
|- | |- | ||
| | | MaxTempComp1=22 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| | | Max temp comparison 1 | ||
| (empty) | |||
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit | |||
|- | |- | ||
| MaxTempComp2=0 | |||
| First with Cumulus 2 | |||
| NOAA Reports Settings → Thresholds | |||
| Max temp comparison 2 | |||
| (empty) | |||
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit | |||
|- | |- | ||
| | | MinTempComp1=15.5 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| | | Min temp comparison 1 | ||
| | | (empty) | ||
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit | |||
|- | |- | ||
| | | MinTempComp2=0 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| Min temp comparison 2 | |||
| (empty) | | (empty) | ||
| | | The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit | ||
|- | |- | ||
| | | MonthFileFormat='NOAAMO'MMyy'.txt' | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Output Files | ||
| | | Monthly filename format | ||
| | | 'NOAAMO'MMyy'.txt' (note quotes round '''NOAAMO''' and round '''.txt''') | ||
| Here you specify the filename template for MX to use when reading, or writing, monthly reports | |||
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid. | |||
|- | |- | ||
| | | Name=Personal Weather Station | ||
| | | First with Cumulus 2 | ||
| NOAA Reports Settings → Site Details | |||
| Site Name | |||
| | |||
| | |||
| (empty) | | (empty) | ||
| | | What you would like to see in report title for your station name | ||
|- | |- | ||
| | | NOAAUseUTF8=1 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Report Options | ||
| | | Use UTF-8 encoding | ||
| | | 1 (UTF-8) | ||
*Tick (value shown as 1 in Cumulus.ini) | | Please see [[Reports_folder#Encoding]] | ||
* | * Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the <sup>o</sup> degree symbol | ||
* If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the <sup>o</sup> degree symbol is coded differently | |||
|- | |- | ||
| | | RainComp1=0.5 | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| Rain comparison 1 | |||
| (empty) | | (empty) | ||
| | | The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold | ||
|- | |- | ||
| | | RainComp2= | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| | | Rain comparison 2 | ||
| | | (empty) | ||
| The report will count the number of days when the daily rainfall exceeds this threshold. | |||
|- | |- | ||
| | | RainComp3= | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Thresholds | ||
| Rain comparison 3 | |||
| | | (empty) | ||
| The report will count the number of days when the daily rainfall exceeds this threshold. | |||
|- | |- | ||
| | | State= | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Site Details | ||
| State | |||
| (empty) | | (empty) | ||
| | | Enter here your local authority area or region (state in USA) | ||
|- | |- | ||
| | | UseDotDecimal=0 | ||
| | | Release 3.9.5 - b3100 | ||
| | | NOAA Reports Settings → Report Options | ||
| 0 | | Use a 'dot' decimal point | ||
| Simple tick or not | | 0 (disable) | ||
*Tick (value shown as 1 in Cumulus.ini) if you want | | Formatting real numbers for when NOAA report parsed by a script | ||
* Don't tick (value shown as 0 in Cumulus.ini) if | |||
Simple tick or not | |||
* Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma | |||
* Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale | |||
|- | |- | ||
| | | UseMinMaxAvg=0 | ||
| | | Release 3.12.0 | ||
| NOAA Reports Settings → Report Options | |||
| Use WHO average or Integrated average | |||
| 0 (integrated average) | |||
| | |||
| | |||
| ( | |||
| Simple tick or not | | Simple tick or not | ||
*Tick (value shown as 1 in Cumulus.ini) if you want | * Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2 | ||
* Don't tick (value shown as 0 in Cumulus.ini) if | * Don't tick (value shown as 0 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use integrated calculation: Sum of all temperature measurements divided by count of measurements | ||
|- | |- | ||
| | | YearFileFormat='NOAAYR'yyyy'.txt’ | ||
| | | First with Cumulus 2 | ||
| | | NOAA Reports Settings → Output Files | ||
| | | Yearly filename format | ||
| | | 'NOAAYR'yyyy'.txt' | ||
| Here you specify the filename template for MX to use when reading, or writing, yearly reports | |||
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. | |||
|- | |- | ||
| | |12hourformat=0 | ||
| | | ??? | ||
| | | NOAA Reports Settings → Output Files | ||
| ( | |Time format | ||
| | |0 (24 hour) | ||
| How times are output on reports | |||
* 24 Hour (value shown as 0 in Cumulus.ini) | |||
* 12 Hour (value shown as 1 in Cumulus.ini) | |||
|} | |||
===Normal Mean Temperatures=== | |||
* File Section is [NOAA] | |||
* The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’ | |||
* There is one box labelled for each month on the settings screens | |||
* All the defaults are (blank) | |||
* What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements | |||
===Normal Precipitation=== | |||
* File Section is [NOAA] | |||
Rainfall equivalents of mean temperature described above | |||
==Optional Structured Query Language Settings== | |||
SQL is structured in the sense that keywords have to appear in the correct order, and there are rules about which words are mandatory. SQL is not just for running queries that read database tables, it can create database tables, give and revoke permissions, and do many more maintenance type tasks. SQL is a language in that each variant of SQL has a vocabulary and set of rules that are specific to that database server, although there is a sub-set, that is set by "ANSI", of words and constructions that all SQL dialects should obey. | |||
MX uses two types of SQL. One type is for SQLite database (see [[Cumulusmx.db]] and [[Diary.db]], that type stores data in rows that are numbered, and columns that are named. In a retrieval query you can sort ascending/descending on value in any column. You can select a row by specifyimg content, but that gets translated into a row number to actually determine what is updated. | |||
The file section '''[MySQL]''' is about a different type of database (i.e. Maria database, or Oracle MySQL) these implement a relational database that has to satisfy the rule that all data appears in a table with rows and columns. The columns have a particular order, but there is no control over the order of rows, so you can't specify a row number, you either specify a primary key that identifies a particular row, or you specify that what is returned from query should be sorted in an ascending/descending order of the value in a specified column. | |||
Both "CumulusMX.exe" and "ExportToMySQL.exe" make use of the following settings: | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| | !style="width:30px" | Executable | ||
| | !style="width:100px" | Function | ||
| | !style="width:300px" | Description | ||
| | |- | ||
| | | CumulusMX.exe | ||
| Data Logs menu | |||
| An option "Update MySQL on Edit" allows you to decide whether MX issues SQL when you edit a data log or "dayfile.txt", so the same edit is made to the corresponding database table, provided that the table has been created with the default name and has the column names defined by default. | |||
|- | |- | ||
! rowspan="7" |CumulusMX.exe | |||
| | | Settings menu → MySQL settings → General Options | ||
| | | An option "Buffer commands on failure" allows you to decide whether MX tries to run SQL commands again, if they fail. IMPORTANT: This is to cope with failure due to the database server going down; the option should not be ticked if you are testing new "custom" SQL and may have made a mistake in the coding. You need to ensure the SQL is either generated by MX as a fixed query, or has been tested and is correct synta before considering this option. | ||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Realtime.txt Upload | ||
| An option that can be enabled that automatically updates a "Realtime" table, each new row is effectively what is stored in the file [[realtime.txt]]. | |||
| | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Dayfile.txt Upload | ||
| | | An option that can be enabled that at end of day ensures that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table. | ||
|- | |- | ||
| | | Settings menu → MySQL settings → Monthly log file Upload | ||
| | | An option that can be enabled that automatically updates a "Monthly" table, every time a new line is added to the [[Standard_log_files|standard data log file]]. | ||
| | |- | ||
| | | Settings menu → MySQL settings → Custom Upload - seconds interval | ||
| | | An option that can be enabled that runs some predetermined SQL every time the specified number of seconds has elapsed. | ||
|- | |||
| Settings menu → MySQL settings → Custom Upload - minutes interval | |||
| An option that can be enabled that runs some predetermined SQL every time the specified number of minutes has elapsed. | |||
|- | |- | ||
| | | Settings menu → MySQL settings → Custom Upload - at rollover | ||
| An option that can be enabled that runs some predetermined SQL just after dayfile.txt has had a new line, but before other end-of-day actions occur. | |||
| | |||
|- | |- | ||
| | | ExportToMySQL.exe | ||
| | | parameters to utility | ||
| | | Determine which file read (and therefore which table updated, using table names set in table name parameters explained in next table) | ||
|} | |} | ||
WARNING: The SQL syntax for [https://mysqlconnector.net/ "My SQL Connector"] used by .NET and therefore by MX, differs in various ways from the MySQL Client or MARIA db syntax. | |||
Here is an example of what might be input as "predetermined SQL", showing how you can use conditionals and web tags: | |||
<pre> | |||
INSERT IGNORE INTO table_name_1 (primary_key, column_name_1, column_name_2 ....) VALUES ('<#primary_key>', '<#web tag_name_1 modifier_1>', '<#web tag_name_2 modifier_2>' ....); | |||
== | BEGIN NOT ATOMIC | ||
IF '<#web tag>' = '---' THEN | |||
simpler query to run if something not numeric; | |||
ELSE | |||
UPDATE table_name_2 SET column_name_1 = '<#web tag_name_1 modifier_1>', column_name_2 = '<#web tag_name_2 modifier_2>' .... WHERE primary_key = '<#primary_key>'; | |||
END IF | |||
END; | |||
</pre> | |||
* File Section is [ | * Introduced in Cumulus MX 3.0.0 beta | ||
{| class="wikitable" border="1" | * File Section is [MySQL] | ||
* MX page is Settings menu → MySQL settings | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
!style="width:30px" | Parameter Line Entry | !style="width:30px" | Parameter Line Entry | ||
!style="width:100px" | MX Section | !style="width:100px" | MX Section | ||
!style="width:60px" | Label on Settings page | !style="width:60px" | Label on Settings page | ||
!style="width:20px" | Default | !style="width:20px" | Default | ||
!style="width: | !style="width:600px" | Description | ||
|- | |- | ||
| | | BufferOnFailure=0 | ||
| | | General Options | ||
| Buffer commands on failure | |||
| | | 0 = ignore errors | ||
| 0 | |||
| Simple tick or not | | Simple tick or not | ||
* Tick (value shown as 1 in Cumulus.ini) if | *Tick (value shown as 1 in Cumulus.ini) if you want MX to store any commands that fail (see note above), and try them again (stored commands lost if MX is stopped) | ||
* Don't tick (value shown as 0 in Cumulus.ini) | * Don't tick (value shown as 0 in Cumulus.ini) if you want MX to ignore any errors | ||
|- | |- | ||
| | | CustomMySqlMinutesCommandString= | ||
| | | Custom Upload - minutes interval | ||
| | | "SQL command" only shown if next parameter is ticked | ||
| (empty) | |||
| | | See "predetermined SQL" example above | ||
| | |||
|- | |- | ||
| | | CustomMySqlMinutesEnabled=0 | ||
| Custom Upload - minutes interval | |||
| | | Custom Minutes Enabled | ||
| | | 0 = don't display other options | ||
|0 | |||
| Simple tick or not | | Simple tick or not | ||
* Tick (value shown as 1 in Cumulus.ini) if you want | *Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned | ||
* Don't tick (value shown as 0 in Cumulus.ini) if MX | * Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings | ||
|- | |- | ||
| | | CustomMySqlMinutesIntervalIndex=6 | ||
| | | Custom Upload - minutes interval | ||
| | | Interval: | ||
| | | 6 = 10 minutes | ||
| ( | | Drop-down list of predetermined intervals: | ||
* 0 = 1 minute | |||
* 1 = 2 minutes | |||
* 2 = 3 minutes | |||
* 3 = 4 minutes | |||
* 4 = 5 minutes | |||
* 5 = 6 minutes | |||
* 6 = 10 minutes | |||
* 7 = 12 minutes | |||
* 8 = 20 minutes | |||
* 9 = 30 minutes | |||
* 10 = 1 hour (60 minutes) | |||
|- | |- | ||
| | | CustomMySqlRolloverCommandString= | ||
| | | Custom Upload - at rollover | ||
| "SQL command" only shown if next parameter is ticked | |||
| | |||
| (empty) | | (empty) | ||
| | | See "predetermined SQL" example above | ||
|- | |- | ||
| | | CustomMySqlRolloverEnabled=0 | ||
| | | Custom Upload - at rollover | ||
| | | Custom Rollover Enabled | ||
| | | 0 = don't display other options | ||
| | | Simple tick or not | ||
* ( | *Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned | ||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings | |||
* | |||
|- | |- | ||
| | | CustomMySqlSecondsCommandString= | ||
| | | Custom Upload - seconds interval | ||
| "SQL command" only shown if next parameter is ticked | |||
| | |||
| (empty) | | (empty) | ||
| | | See "predetermined SQL" example above | ||
|- | |- | ||
| | | CustomMySqlSecondsEnabled=0 | ||
| | | Custom Upload - seconds interval | ||
| | | Custom Seconds Enabled | ||
| | | 0 = don't display other options | ||
| ( | | Simple tick or not | ||
*Tick (value shown as 1 in Cumulus.ini) if you want the previous and next options to be displayed, and actioned | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is not to action the previous and next settings | |||
|- | |- | ||
| | | CustomMySqlSecondsInterval=10 | ||
| | | Custom Upload - seconds interval | ||
| | | Interval (seconds): | ||
| | | 10 | ||
| A number field, takes 1 to 59 | |||
|- | |||
| Database= | |||
| Server details | |||
| Database name: | |||
| (empty) | | (empty) | ||
| | | A text field where you enter the name of the database your tables are to be created/updated in | ||
|- | |- | ||
| | | DayfileMySqlEnabled=0 | ||
| | | Dayfile.txt upload | ||
| | | Dayfile Enabled | ||
| | | 0 | ||
| ( | | Simple tick or not | ||
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at end of day ensure that a new line is added to [[dayfile.txt]] and a new row (with similar data) is inserted into a "Dayfile" table | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to dayfile.txt | |||
|- | |- | ||
| | | DayfileTable= | ||
| | | Dayfile.txt upload | ||
| | | Table name | ||
| | | Dayfile | ||
| Having defined this table, and saved the settings, click the "Create Dayfile" button to create the database table with the standard column names. If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but the option to update table when you edit "dayfile.txt" will fail (and if set to do so, keep failing as it repeats). | |||
|- | |- | ||
| | | Host=Localhost | ||
| | | Server details | ||
| | | Host name | ||
| (empty) | | (empty) | ||
| | | Set to whatever host name your database server has specified, if you host [[Your_Own_Server]], then you may be able to use "Localhost". | ||
|- | |- | ||
| | | MonthlyMySqlEnabled=0 | ||
| | | Monthly logfile upload | ||
| | | Monthly Log Enabled | ||
| | | 0 | ||
| Simple tick or not | |||
| | *Tick (value shown as 1 in Cumulus.ini) if you want MX to at your standard logging interval ensure that a new line is added to [[Standard_log_files|standard data log file]] and a new row (with similar data) is inserted into a "Monthly" table. | ||
* Tick (value shown as 1 in Cumulus.ini) | * Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file | ||
* | |||
|- | |- | ||
| | | MonthlyTable= | ||
| | | Monthly logfile upload | ||
| | | Table name | ||
| | | Monthly | ||
| | | Having defined this table, and saved the settings, click the "Create Monthly" button to create the database table with the standard column names. You might wish to change the name here once a year, to stop the database table getting enormous, if so you might name the table something like "standard2020". If you change the name here, normal updates and "ExportToMySQl.exe" will use the table name you define, but the option to update table when you edit "MMMyyyyLog.txt" will fail (and if set to do so, keep failing as it repeats). | ||
|- | |- | ||
| | | Pass= | ||
| | | Server details | ||
| | | Password | ||
| (empty) | | (empty) | ||
| | | Set to whatever password is used for update access with the database user name (see below) | ||
|- | |- | ||
| | | Port=3306 | ||
| | | Server details | ||
| | | Port number | ||
| | | 3306 | ||
| ( | | The port related to the host name (defined above) for update access to your database server | ||
|- | |- | ||
| | | RealtimeMySql1MinLimit=0 | ||
| | | Realtime.txt upload | ||
| | | Limit Inserts: | ||
| | | 0 = false | ||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) | |||
* Don't tick (value shown as 0 in Cumulus.ini) | |||
See explanation beside and below setting | |||
|- | |||
| RealtimeMySqlEnabled=0 | |||
| Realtime.txt upload | |||
| Real time Enabled | |||
| 0 = don't display other options | |||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) if you want MX to at your real time interval ensure that a new realtime.txt file is created and a new row (with similar data) is inserted into a "Realtime" table. | |||
* Don't tick (value shown as 0 in Cumulus.ini) if MX is only to ensure that a new line is added to standard data log file | |||
|- | |||
| RealtimeRetention= | |||
| Realtime.txt upload | |||
| '''Data Retention value''' and '''Data Retention unit''' | |||
| "7" and "Days" | |||
| The value field will take any number, the unit field is a dropdown: | |||
* Seconds | |||
* Minutes | |||
* Hours | |||
* Days | |||
* Weeks | |||
* Months | |||
Taken together, these determine the period for which rows are kept in the table named in "RealtimeTable", any row older than this specification will be deleted as part of the automatic SQL | |||
|- | |||
| RealtimeTable=Realtime | |||
| Realtime.txt upload | |||
| Table name | |||
| Realtime | |||
| Having defined this table, and saved the settings, click the "Create Realtime" button to create the database table with the standard column names. Remember that you can tailor the contents of "realtime.txt", if you want non-standard columns in this table, you have to create the table yourself. | |||
|- | |||
| UpdateOnEdit=1 | |||
| General Options | |||
| Update MySQL on Edit | |||
| 1 = update the table when edit the file | |||
| Simple tick or not | |||
*Tick (value shown as 1 in Cumulus.ini) | |||
* Don't tick (value shown as 0 in Cumulus.ini) | |||
Please see begining of previous table for explanation and warning about how all defaults must be set for this to work | |||
|- | |||
| User= | |||
| Server details | |||
| User name | |||
| (empty) | | (empty) | ||
| | | Database access user name, that matches with password described earlier | ||
|} | |} | ||
==Optional Third-party Upload Settings== | ==Optional Third-party Upload Settings== | ||
Line 4,805: | Line 4,782: | ||
* Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate wind chill from temperature and wind speed | * Tick (value shown as 1 in Cumulus.ini) then Cumulus will calculate wind chill from temperature and wind speed | ||
** Note that there is a maximum temperature, and minimum wind speed, for Cumulus to make the calculation, see [[Wind_chill]] page | ** Note that there is a maximum temperature, and minimum wind speed, for Cumulus to make the calculation, see [[Wind_chill]] page | ||
* Don't tick (value shown as 0 in Cumulus.ini) action depends on | * Don't tick (value shown as 0 in Cumulus.ini) action depends on other items: | ||
** If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill | ** If Cumulus has non-default multiplier and/or offset settings for temperature or wind speed, Cumulus will calculate wind chill | ||
** If station provides wind chill, then that will be used provided no multiplier/offsets have been specified for temperature or wind speed | ** If station does NOT make a wind chill value available to Cumulus, Cumulus MX reports an error if you have not ticked this setting, (that is different to how the setting worked with the legacy software). | ||
** If station provides wind chill, then that value will be used provided no multiplier/offsets have been specified for temperature or wind speed. | |||
|- | |- | ||
| ChillHourSeasonStart= | | ChillHourSeasonStart= |
edits