Cumulusutils.ini: Difference between revisions

m
mNo edit summary
(55 intermediate revisions by the same user not shown)
Line 13: Line 13:
Lines starting with a semicolon (';') are treated as comment and ignored.
Lines starting with a semicolon (';') are treated as comment and ignored.


Each parameter can be reset to its default by simply deleting it from the file. A new entry will be created with its default value on the next run, adding it to the end of the already existing section. A total reset of all paremeters is accomplished by deleting this file, the user has to start from scratch.
Each parameter can be reset to its default by simply deleting it from the file. A new entry will be created with its default value on the next run, adding it to the end of the already existing section. A total reset of all parameters is accomplished by deleting this file, the user has to start from scratch.


== Listing of the Parameters per section ==
== Listing of the Parameters per section ==


=== [General] ===
=== [General] ===
LoggingOn=true<br>
NormalMessageToConsole=true<br>
TraceInfoLevel=info<br>
IgnoreDataErrors=true<br>
IgnoreDataErrors=true<br>
GeneratejQueryInclude=false<br>
GeneratejQueryInclude=false<br>
DoLibraryIncludes=true<br>
DoLibraryIncludes=false<br>
<nowiki>;Language=nl-NL</nowiki><br>
<code>;Language=nl-NL<br></code>
Language=en-GB<br>
Language=en-GB<br>
NormalMessageToConsole=true<br>
ChartContainerHeight=650<br>
TraceInfoLevel=Info<br>
ChartBackgroundImage=<br>
MonthsOfMiracleAndWonder=jan,feb,mrt,apr,mei,jun,jul,aug,sep,okt,nov,dec<br>
UseScrollableTables=true       &nbsp;&nbsp;&nbsp;''NOTE: Used for Top10, Day Records and pwsFWI. The thin scrollbar does work with FireFox but not with Chrome<br>
RecordsBeganDate=01/01/20 &nbsp;&nbsp;&nbsp;Normally used to trim your start year to 01/01/yy '''(note the 2-digit year)''' but any date within the dataset can be used<br>
MaxErrors=10<br>
CMXport=8998<br>
UseSpecificHighchartsVersion=11.2.0<br>
DoModular=false<br>
ModulePath=<br>
NeedSolarEnergyDailyValuesInCSV=false    &nbsp;&nbsp;Used to output the values of the Solar Energy graph into a CSV file<br>
CheckDateOrder=true  &nbsp;&nbsp;Checks the date order when reading the Monthly Logs. Set to false when corrections made<br>
LastUploadTime=13/03/24 10:30<br>
 
The parameters ''GeneratejQueryInclude'' and ''DoLibraryIncludes'' require special attention. Please read the chapter on the [[modules]] for modular use of javascript libraries.


=== [pwsFWI] ===
=== [pwsFWI] ===
Line 32: Line 46:
ResultFormat=beteljuice<br>
ResultFormat=beteljuice<br>
FireImage=true<br>
FireImage=true<br>
<nowiki>predictionURL=http://api.yourweather.co.uk/index.php?api_lang=en&localidad=185686&affiliate_id=52wzikfato88&v=2.0</nowiki><br>
<nowiki>predictionURL=http://api.yourweather.co.uk/index.php?api_lang=en&localidad=xxxxxx&affiliate_id=yyyyyyyyyy&v=2.0</nowiki><br>
PredictionBackground=Moccasin<br>
PredictionBackground=Moccasin<br>
CurrentIndexFormat=Standard<br>
CurrentIndexFormat=Standard<br>
Line 53: Line 67:
ColorNOAABackground=#f9f8EB<br>
ColorNOAABackground=#f9f8EB<br>
StartInCurrentMonth=true<br>
StartInCurrentMonth=true<br>
NOTE: the report directory MUST be the directory you configure in ''Cumulus.ini''


=== [Graphs] ===  
=== [Graphs] ===  
Line 68: Line 84:
YearRainstats=true<br>
YearRainstats=true<br>
YearMonthRainstats=true<br>
YearMonthRainstats=true<br>
RAINvsEVT=true<br>
MonthlyTemp=true<br>
MonthlyTemp=true<br>
YearTempstats=true<br>
YearTempstats=true<br>
Line 79: Line 96:
SolarHoursYearMonth=true<br>
SolarHoursYearMonth=true<br>
SolarEnergyYearMonth=true<br>
SolarEnergyYearMonth=true<br>
TempSum=true<br>
GrowingDegreeDays=true<br>
Seasons=true<br>
DailyEVT=true<br>
DailyEVT=true<br>
MonthlyEVT=true<br>
MonthlyEVT=true<br>
Line 87: Line 107:
<nowiki>;WindRoseColors=['lightgrey', 'green', 'blue', 'yellow', 'orange', 'red', 'deeppink', 'purple', 'black']</nowiki><br>
<nowiki>;WindRoseColors=['lightgrey', 'green', 'blue', 'yellow', 'orange', 'red', 'deeppink', 'purple', 'black']</nowiki><br>
HeatmapNumberOfYearsPerPage=10<br>
HeatmapNumberOfYearsPerPage=10<br>
TempSum=true<br>
GrowingDegreeDays=true<br>
GrowingDegreeDaysReferenceTemp=5<br>
GrowingDegreeDaysReferenceTemp=5<br>
WinterToSpringTemperatureLimit=5<br>
SpringToSummerTemperatureLimit=15<br>


=== [FTP site] ===
=== [FTP site] ===
Line 97: Line 117:


=== [Maps] ===
=== [Maps] ===
Website=https://meteo-wagenborgen.nl/<br>
Website=[fill in your website URL for the CUtils site or the specifc page of your own website]<br/>
Participant=true<br>
Participant=true<br/>
DoneToday=15-05-21<br/>


=== [Website] ===
=== [Website] ===
GoogleStatsId=<br>
// The statistics parameters are currently either for Google or Matomo, Google is default </br>
// If the corresponding ID's and or Url are not filled in, invalid code is generated. If you do not want </br>
// statistics than set ''StatisticsType'' without value </br> </br>
 
StatisticsType= [Google || Matomo] default is empty  </br>
GoogleStatsId= </br>
MatomoTrackerUrl= </br>
MatomoSiteId= </br>
PermitGoogleOptout=false (default)<br>
 
CumulusRealTimeLocation=<br>
CumulusRealTimeLocation=<br>
ShowInsideMeasurements=true<br>
ShowInsideMeasurements=true<br>
Line 108: Line 138:
ShowSolar=true<br>
ShowSolar=true<br>
HeaderLeftText=<br>
HeaderLeftText=<br>
<nowiki>HeaderRightText=<a href='http://cumulussites.net/'><img src='http://cumulussites.net/button.php?u=HansR' style='border-width:0' alt='Cumulus Top Weather Sites'/></a></nowiki><br>
HeaderRightText=<br>
PermitGoogleOptout=true<br>
SiteTitleAddition=<br>
SiteTitleAddition=<br>
PwsfwiButtonInHeader=true (default) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; => When true the direct access pwsFWI button will show in the header, when false it shows in the menu bar <br />
ColorMenuBackground=Lightgrey<br>
ColorMenuBackground=Lightgrey<br>
ColorMenuText=Black<br>
ColorMenuText=Black<br>
Line 194: Line 225:
HomeGraphDailyTempMinColor=#058DC7<br>
HomeGraphDailyTempMinColor=#058DC7<br>
HomeGraphDailyTempMaxColor=#ED561B<br>
HomeGraphDailyTempMaxColor=#ED561B<br>
Panel-1=TemperatureText<br>
Panel-2=PressureText<br>
Panel-3=RainText<br>
Panel-4=Clocks<br>
Panel-8=WindText<br>
Panel-9=SolarDisc<br>
Panel-10=LunarDisc<br>
Panel-11=HumidityText<br>
Panel-12=SolarText<br>
Panel-13=TemperatureGauge<br>
Panel-14=OtherTempsGauge<br>
Panel-15=PressureGauge<br>
Panel-16=HumidityGauge<br>
Panel-20=CloudBaseGauge<br>
Panel-21=RainGauge<br>
Panel-22=RainSpeedGauge<br>
Panel-23=SolarGauge<br>
Panel-24=UVGauge<br>
UseCMXMoonImage=false<br>
MoonImageLocation=<br>
ColorTitleBackGroundImage=HPIM3899_day.JPG<br>
ColorTitleBackGroundImageCivil=HPIM3899_civil.JPG<br>
ColorTitleBackGroundImageNautical=HPIM3899_nautical.JPG<br>
ColorTitleBackGroundImageAstronomical=HPIM3899_astronomical.JPG<br>
ColorTitleBackGroundImageNight=HPIM3899_night.JPG<br>


=== [Forecasts] ===
=== [Forecasts] ===
Line 206: Line 262:
ReportWidth=700<br>
ReportWidth=700<br>
SystemInfoLinesToSkip=<br>
SystemInfoLinesToSkip=<br>
ExtraStationInfo=<br>
Tx=<br>


=== [Thrifty] ===
=== [Thrifty] ===
Line 225: Line 283:
WindArrowType=1<br>
WindArrowType=1<br>


=== [AirQuality] ===
=== [Compiler] ===
CountrySelected=EU<br>
SmaPeriod=5<br>
WantToSeeNow=true<br>
DoneToday=04-09-21<br>
WantToSeeNowCast=true<br>
 
WantToSee1hr=true<br>
=== [MeteoCam] ===
WantToSee3hr=true<br>
MeteoCamMenu=true<br/>
WantToSee24hr=true<br>
MeteoCamDir=./MeteoCam<br/>
WantToSeeWind=true<br>
TimelapseExtension=mp4<br/>
MeteoCamName=meteocam.jpg<br/>
CamType=[manual | EcowittHP10]<br>
 
=== [AirLink] ===
(before version 6.1 this section was '''[AirQuality]'''
 
CountrySelected=EU<br/>
WantToSeeNow=true<br/>
WantToSeeNowCast=true<br/>
WantToSee1hr=true<br/>
WantToSee3hr=true<br/>
WantToSee24hr=true<br/>
WantToSeeWind=true<br/>
CleanupAirlinkLogs=false<br/>
ReferenceLineThickness=4<br/>
 
=== [ExtraSensors] ===
ExtraSensors=false<br/>
ParticipatesSensorCommunity=false<br/>
CleanupExtraSensorslog=false<br/>
UserModificationExtraSensorCharts=false<br/>
LightningSensor=[ false | true ]<br/>
ExternalExtraSensors=[ fill with comma separated liste of sensor names ]<br/>
 
The list of parameters below defines which extra sensors are used in your system (combine with strings.txt for the descriptions (Captions) used). Fill with comma separated integer list representing the extra sensor(s):
 
ExtraTemp=<br/>
ExtraHum=<br/>
ExtraDP=<br/>
SoilTemperature=<br/>
SoilMoisture=<br/>
AirQuality=<br/>
UserTemp=<br/>
LeafTemp=<br/>
 
=== [CustomLogs] ===
CustomLogs=false<br/>
UserModificationCustomLogsCharts=false<br/>
DoneToday=2023-10-16T12:41:00<br/>
 
 
'''NOTE:''' <br/>
#''DoneToday'' is not configurable but is set/read by the application. Any value you put here will be modified. If the date is today then the corresponding action will not be carried out. You can force the action by removing this parameter.
#the Ecowitt CO2 sensor is not parameterised but its presence is detected by the presence of a value in the database.
#the Ecowitt AirQuality sensors have an implicit accompanying AirQualityAvg giving the 24 hr average


=== [Compiler] ===
ChartContainerHeight=700<br>
DoneToday=12/04/21<br>


'''NOTE:'''
''DoneToday'' is not configurable but is set/read by the application. Any value you put here will be modified. BUT the datafiles belonging to the compiler demands will not be transferred to the website if the value is today or in the future. So if you want to a kind of reset of your charts, it is best to remove it and have it reinitialised by CumulusUtils.


[[Category:CumulusUtils]]
[[Category:CumulusUtils]]