Cumulus Wiki

Cumulus.ini (preserving history): Difference between revisions

Cumulus.ini (preserving history) (view source)

Revision as of 07:06, 18 May 2021

4,951 bytes added ,  07:06, 18 May 2021
m
→‎Extra Web Files
mNo edit summary
Line 150: Line 150:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
!style="width:600px" | Description
Line 197: Line 197:
!style="width:30px" | Section
!style="width:30px" | Section
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:600px" | Description
!style="width:600px" | Description
|-
|-
|style="background:lightgray;"|[Program]  
|[Program]
|
|
|style="background:lightgray;"|Section name
|-
|EnableAccessibility=0
|EnableAccessibility=0
|Enable accessibility features  
|Enable accessibility features  
Line 235: Line 231:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
Line 417: Line 413:
|-
|-
!style="width:30px" | Parameter Line Entry
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Label on Settings page
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:20px" | Default
!style="width:300px" | Description
!style="width:300px" | Description
Line 564: Line 560:


===Web/FTP Settings===
===Web/FTP Settings===
====Interval Settings====
====Realtime Settings====


===Email Server Settings===
===Email Server Settings===
Line 654: Line 654:


HTTPProxyPassword=  
HTTPProxyPassword=  
==Extra Web Files==
There are 100 occurrences of each parameter in Cumulus.ini, and therefore each parameter has a base name followed by numbers 0 to 99.
The settings interface presents the rows on multiple pages, the rows are not numbered, so you have to do some counting to work out which row in the admin interface page corresponds with which parameter in Cumulus.ini file.
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:600px" | Description
|-
|style="background:lightgray;"|[FTP site]
|
|
|style="background:lightgray;"|Section name
|-
|ExtraLocal0= to ExtraLocal99=
|Local File Name
|(empty)
|You can enter:
* A relative path name, with respect to the "CumulusMX" root folder
** e.g.  '''./data/dayfile.txt''' (Note: this is the [[Daily_Summary|daily summary log file]], see link for how it can be used on a web server)
** e.g. '''./webMX/betel_monthlyrecord_liteMXT.html''' (Note: this is a third party [[Cumulus_template_file|template file]] - see [https://cumulus.hosiene.co.uk/viewtopic.php?f=14&t=7500 Alternative Monthly Extremes using <#webtag>s]
** e.g. '''./web/trendsT.htm''' (Note: That file is not part of default web site any more, but serves as another example
* A full path name for a file on the computer running MX
** e.g. '''/home/pi/documents/myFile'''
** e.g. '''C:\Users\Public\Documents\working.txt'''
*You can place any of the following constants into the entry
** These should be typed as shown on their own
*** '''<noaayearfile>''' and '''<noaamonthfile>''' these respectively represent latest yearly and latest monthly reports
***  '''<currentlogfile>''',  '''<currentextralogfile>''', and '''<airlinklogfile>''' these respectively represent [[Standard_log_files|standard]], [[Extra_Sensor_Files| extra sensor]], and [[Air_Link_Log.txt|Davis AirLink air quality monitor]] log files
|-
|ExtraRemote0= to ExtraRemote99=
|Destination Filename
|(empty)
|Defines where MX is to upload file to
* If file transfer is requested (see below), the file path should be expressed starting at the FTP/FTPS/SFTP root
**I can't tell you what the file path is for your web server, but I can give a couple of examples to steer you
*** e.g. httpdocs/dayfile.txt
*** e.g. public_html/thismonthyear.htm
* If the FTP is not ticked, the file path should be full path for a file on the computer running MX
** e.g. /var/www/html/weather/images/moon.png could be destinatation for uploading the MX generated moon image to a Linux hosted [[Your_Own_Server|server]]
** e.g. /var/www/html/weather/webfilesMX/tempdata.json for uploading one of the [[:Category:JSON_Files|files with graph data]] to a Linux hosted [[Your_Own_Server|server]]
|-
|ExtraProcess0= to ExtraProcess99=
|Process
|0
|Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if the local file is a [[Cumulus_template_file|template file]], see [[Customised_templates#What_is_meant_by_.27Cumulus_processes_templates.27|here]] for full explanation of '''Process'''
* Don't tick (value shown as 0 in Cumulus.ini) if you want local file uploaded with existing content
|-
|ExtraRealtime0= to ExtraRealtime99=
|Realtime
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if
*# See [[#Realtime Settings]], you must have "Enable realtime" ticked, and defined an interval there
*# Uploads the file to destination specified at interval defined
* Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]])
|-
|ExtraFTP0= to ExtraFTP99=
|FTP
|1
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if you want MX to use the FTP protocol specified in [[#Web/FTP Site]]
* Don't tick (value shown as 0 in Cumulus.ini) if the remote file is on the computer running MX and a simple Copy File is required
|-
|ExtraUTF0= to ExtraUTF99=
|UTF-8
|1
|Please see [[Reports_folder#Encoding|technical guidance on 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
*If unticked (0 appears in file), then iso-8859-1 encoding is used
|-
|ExtraBinary0= to ExtraBinary99=
|Binary
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if your file is e.g. an image file (e.g. moon.png)
* Don't tick (value shown as 0 in Cumulus.ini) if the file is text, HTML, PHP script, JSON, JavaScript
|-
|ExtraEOD0= to ExtraEOD99=
|End of Day
|0
|Simple tick or not
*Tick (value shown as 1 in Cumulus.ini) if your file is to be uploaded during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
* Don't tick (value shown as 0 in Cumulus.ini) if you want uploading to happen at a different interval (e.g. [[#Interval Settings|Standard interval]])
|}




Line 763: Line 862:
|Use UTF-8 encoding
|Use UTF-8 encoding
|Please see [[Reports_folder#Encoding]]
|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
By default, reports use UTF-8 encoding, this can display for example degree characters as well as normal A-Z and 0-9 (or locale equivalents)
*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
 
If unticked (0 appears in file), then iso-8859-1 encoding is used
|-
|-
|UseDotDecimal=0  
|UseDotDecimal=0  
Sfws
5,838

edits

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