5,838
edits
Cumulus.ini (preserving history): Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Section: FTP Site: adding new parameters made available from v1.9.3 (previously missing here), making all consistent especially with regard to how set from configuration menu
(→Davis family specific:: Added ClockSettingHour) |
m (→Section: FTP Site: adding new parameters made available from v1.9.3 (previously missing here), making all consistent especially with regard to how set from configuration menu) |
||
|
|style="background:lightgray;"|[FTP site]
|style="background:lightgray;"|Section Name - the following parameters relate to your website FTP parameters
|-
|DailyProgram=
|Selected in the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run once a day, after the daily 'rollover' has been performed.
*default - none
|-
|DailyParams=
|Selected in the '''Params''' box alongside the '''Daily''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'DailyProgram' used to specify any parameters to be passed to that command.
*default - none
|-
|Host=
|Selected in the ''Internet'' option of '''Configuration'''
''Leave blank if you are not using ftp, but simply creating the output files on your pc with a Copy instruction.''
|-
|Port=21
|Selected in the ''Internet'' option of '''Configuration'''
|-
|Username=
|Select your web site FTP login Username in the ''Internet'' option of '''Configuration'''
|-
|Password=
|Shows your web site FTP login password as entered in the ''Internet'' option of '''Configuration'''
|-
|Directory=
|Selected in the ''Internet'' option of '''Configuration'''
*value is left Blank, default, the root position specified by ftp server (see Host above)
*A path from the starting point as the position specified by ftp server (see Host above)
|-
|IncludeSTD=1
|
*0 = Disabled
*1 = Enabled, (default) the standard web files provided with Cumulus will be processed and uploaded at each automatic or manual web update to the FTP root or any 'Directory' you have specified (see above).
|-
|IncludeSTDImages=1
|
*0 = Disabled
*1 = Enabled,(default) the standard image files generated by Cumulus (graphs, etc) will be uploaded at each automatic or manual web update to a
|-
|ResizeGraphs=0
|Set in the ''Internet''
*0 = Disabled (default) Cumulus uploads the default 750 x 300 pixel graphs.
*1 = Cumulus resizes the large graph images when creating them for upload to your web site. Specify the required height and width in the corresponding boxes of same Web graphs block (see below for related parameters). Note that the images are simply scaled to the new size; there will be some loss of quality.
|-
|GraphHeight=300
|Graph height, default is 300 (pixels) - see previous parameter
|-
|GraphWidth=750
|Graph width, default is 750 (pixels) - see ResizeGraphs parameter
|-
|ImageFolder=
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Copy Images to folder'' at the bottom of ''Files'' Tab screen.
*value is blank (default) no action
*Path and file name in LOCAL folder to which the generated image files are also copied after each upload, either at manual web update and the 'normal' automatic interval, or the 'real time' interval, depending on next parameter. Used if you want backups of generated images. See Cumulus Help.
|-
|ImageCopyRealtime=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Realtime?'' at the bottom of ''Files'' Tab screen.
*0 = (default) the generated image files are copied at each manual web update and automatically in 'normal' interval
*1 = the generated image files are copied in 'real time' interval.
|-
|IncludeSolarChart=0
|Set in the ''Internet'' option of '''Configuration''' menu by the ''Solar'' at the top of ''Files'' Tab screen.
*0 = Disabled (default)
*1 = Enabled, the optional solar graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|IncludeUVChart=0
|
*0 = Disabled (default)
*1 = Enabled, the optional UV graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|IncludeSunshineChart=0
|Set in the ''Internet''
*0 = Disabled (default)
*1 = Enabled, the optional sunshine graph image file generated by Cumulus will be uploaded at each automatic or manual web update to a sub-folder of the 'Directory' you specified called 'images'.
|-
|
|
*0 = Disabled, an upload will only occur if ''Web upload'' is selected manually either from the '''File''' menu or the right click menu if Cumulus is minimised.
*1 = Enabled, Cumulus will automatically upload your processed web pages to your web site at regular intervals (as specified by the 'Update ''Interval'' ' - see below) using FTP to the directory as specified in 'Directory' (see above).
|-
|ActiveFTP=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use active FTP mode''.
*0 = Disabled (default)
*1 = Enabled, Cumulus will use 'active' FTP mode instead of the default 'passive' mode. You should only select active mode if you are having problems with FTP uploads.
|-
|FTPRename=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Use FTP rename''.
*0 = Disabled (default), no name change after uploading onto the server
*1 = Enabled, the new update is loaded using temporary names, files are renamed on the sever afterwards
|-
|DeleteBeforeUpload=0
|
*0 = Disabled (default)
*1 = Enabled, files are deleted from sever before the new update is loaded
|-
|UpdateInterval=15
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab in '''Interval''' box. The interval in minutes at which you wish normal (not real-time) updates (either FTP to your website, or copy to a local directory on your pc) to automatically occur. Default 15 minutes.
|-
|ExternalProgram=
|Selected in the '''Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'normal' web update interval, after all of the other processing has been performed.
|-
|ExternalParams=
|Selected in the '''Params''' box alongside the '''Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'ExternalProgram' used to specify any parameters to be passed to that command.
|-
|EnableRealtime=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Enable Realtime''.
The [[realtime.txt]] file contains various weather parameters and is used by the CumulusRealtime.swf (shock wave flash) real time wind gauges (as on the supplied 'gauges' web page for Cumulus 1). This parameter controls when it is created.
*0 = Disabled (default)
** - If you do not have ''Auto Update'' option set (top of Web Settings block), the ''realtime.txt'' file is not created/updated.
** - If you have the ''Auto Update'' option set (and a suitable ''Interval'' configured), Cumulus will create the ''realtime.txt'' file at that specified normal update ''Interval'' (not the Real-time Interval)
** It only creates the file (any previous creation is lost) at that interval, but you can separately specify it as an extra file to upload during the 'normal' upload, or just use it for any other purpose on your PC.
*1 = Enabled, Cumulus will create a new ''realtime.txt'' file at the Real-time Interval,
** - Other parameters need to be set for more actions.
** - If you have the ''RealtimeFTPEnabled'' option set, and a suitable ''RealtimeInterval'' configured, (for both of these see below) Cumulus will upload the file to your web site, after the number of seconds specified by '''RealtimeInterval''' (see that parameter below) since any previous upload.
|-
|RealtimeFTPEnabled=0
|Set in the ''Internet'' option of '''Configuration'''
*0 =
*1 = Enabled, Cumulus will establish an FTP connection to your web site, so that the realtime.txt file, and any other files you specify, can be uploaded when realtime processing takes place. The 'EnableRealtime' setting must be set to 1 for this setting to have any effect.
|-
|RealtimeTxtFTP=0
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime.txt FTP''.
When set to 1 Cumulus will upload the [[realtime.txt]] to your web site during realtime processing. The 'EnableRealtime' and 'RealtimeFTPEnabled' settings must both be set to 1 for this setting to have any effect.
|-
|RealtimeInterval=15
|Set in the ''Internet'' option of '''Configuration''' menu in Web Settings block of ''Sites/Options'' tab as ''Realtime Interval''. The time in seconds between uploads of the '''realtime.txt''' file, and any other files associated with real-time interval, (i.e. a new upload of files will begin this number of seconds after the last upload has ended).
*If you set it to 15 seconds and it takes more than say 10 seconds for any uploads, it will not be until the time it takes plus another 15 seconds has elapsed that it does the next upload.
*If you set it to 5 seconds, and it takes more than say 10 seconds for any uploads, while you won't actually get an upload every 5 seconds, it will always attempt the next upload within 5 seconds of the previous one ending.
|-
|RealtimeProgram=
|Selected in the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The name (including path) of a command-line program to be run at the 'realtime' web update interval, after all of the processing has been performed.
|-
|RealtimeParams=
|Selected in the '''Params''' box alongside the '''Realtime Program''' box of ''Internet'' option of '''Configuration''' menu, ''Sites/Options tab'' in '''External Programs''' block. The corresponding 'parameters' for 'RealtimeProgram' used to specify any parameters to be passed to that command.
|-
|ExtraLocal[0-9]=
|Set in the ''Internet'' option of '''Configuration''' menu by an entry in the ''Local'' column of the table on the ''Files'' Tab screen.
*value is blank (default)
*Path and file name on local computer for alternate files #0 through #9. See cumulus '''Help''' for details of how to specify reading current monthly log here.
|-
|ExtraLocal[10-99]=
|Path and file name on local computer for alternate file #10 through #99. These additional files can only be selected by adding parameter lines to the configuration file, they
|-
|ExtraRemote[0-9]=
|Set in the ''Internet'' option of '''Configuration''' menu by an entry in the ''Local'' column of the table on the ''Files'' Tab screen.
*value is blank (default)
*Path and file name on web server for alternate files #0 through #9. Set in Internet Configuration Screen Files tab. See cumulus Help for details of how to specify creating current monthly log here.
|-
|ExtraRemote[10-99]=
|Path and file name on web server for alternate file #10 through #99. These additional paths/files can only be selected by adding parameter lines to the configuration file, they
|-
|ExtraProcess[0-9]=0
|Set in the ''Internet'' option of '''Configuration'''
*0 = Disabled, (default) extra file will not pass through the cumulus 'tag processor'.
*1 = Enabled, extra file will be passed through the 'tag processor' in Cumulus, in the same way that the standard Cumulus web pages are. This allows to you to create your own web pages into which Cumulus will insert the various weather parameters. See the "Web tags" section of the help file for a list of the tags which you can use. Cumulus will create a temporary file to hold the processed version of your file and then upload that.
|-
|ExtraProcess[10-99]=0
|Set in this config file only, they cannot be entered on any Configuration screen.
*0 = Disabled, alternate file #10 through #99 will not pass through the cumulus 'tag processor'.
*1 = Enabled, alternate file #10 through #99 will be passed through the 'tag processor' in Cumulus, in the same way that the standard Cumulus web pages are. This allows to you to create your own web pages into which Cumulus will insert the various weather parameters. See the "Web tags" section of the help file for a list of the tags which you can use. Cumulus will create a temporary file to hold the processed version of your file and then upload that
|-
|UTF8encode=1
|
*0 = Standard Cumulus Web Templates are processed into '''charset=iso-8859-1''' web pages as for builds prior to 1093.
*1 = Default from build 1093, Standard Cumulus Web Templates are processed into '''charset=utf-8''' web pages
|-
|ExtraUTF[0-9]=0
|Set in the ''Internet'' option of '''Configuration'''
*0 = Default
*1 = Customised/extra Cumulus Web Templates are processed into '''charset=utf-8''' web pages
|-
|ExtraUTF[10-99]=0
*1 = Customised Cumulus Web Templates are processed into '''charset=utf-8''' web pages from build 1093
|-
|ExtraBinary[0-9]=0
|Set in the ''Internet'' option of '''Configuration'''
*0 = not binary (if pure ASCII characters)
*1 = Binary (e.g. images)
|-
|ExtraRealtime[0-9]=0
|Set in the ''Internet'' option of '''Configuration''' menu by selecting in the ''Realtime?'' column of the table on the
*0 = Disabled, (default) file uploaded as part of normal upload
*1 = Enabled, file uploaded during Realtime upload
*0 = Disabled, alternate file #10 through #99 copied to the location specified in the Remote Filename box.
*1 = Enabled, alternate file #10 through #99 uploaded by FTP
|-
|MaxFTPconnectRetries=3
| |||
