Cumulusutils.ini

From Cumulus Wiki
Jump to navigationJump to search

Introduction

CumulusUtils is a configurable application and its parameters are stored in the file CumulusUtils.ini.

This page will list most parameters and if deemed necessary, a short explanation will be given. Most parameters will be discussed on the page of the module.

The phrase most parameters is used, because parameters - if non-existent - are created with their default values when used during a run of CumulusUtils. As not all parameters are needed, those not needed will not be seen by the user. Although through testing I assume my inifile has all parameters, I cannot guarantee that: the complexity has increased quickly and I may have missed some. You are invited to notify me or update this file yourself. (I and me being HansR)

The order of the parameters can be changed by the user and will be maintained. This can be handy in grouping parameters within sections, especially for the larger sections like Website and Graphs

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 parameters is accomplished by deleting this file, the user has to start from scratch.

Listing of the Parameters per section

[General]

LoggingOn=true
NormalMessageToConsole=true
TraceInfoLevel=info
IgnoreDataErrors=true
GeneratejQueryInclude=false
DoLibraryIncludes=false
;Language=nl-NL
 Language=en-GB
ChartContainerHeight=650
ChartBackgroundImage=
UseScrollableTables=true    NOTE: Used for Top10, Day Records and pwsFWI. The thin scrollbar does work with FireFox but not with Chrome
 RecordsBeganDate=01/01/20    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
MaxErrors=10
CMXport=8998
UseSpecificHighchartsVersion=11.2.0
DoModular=false
ModulePath=
NeedSolarEnergyDailyValuesInCSV=false   Used to output the values of the Solar Energy graph into a CSV file
CheckDateOrder=true   Checks the date order when reading the Monthly Logs. Set to false when corrections made
LastUploadTime=13/03/24 10:30

The parameters GeneratejQueryInclude and DoLibraryIncludes require special attention. Please read the chapter on the modules for modular use of javascript libraries.

[pwsFWI]

Analyse=90
WarningLevel=5
ResultFormat=beteljuice
FireImage=true
predictionURL=http://api.yourweather.co.uk/index.php?api_lang=en&localidad=xxxxxx&affiliate_id=yyyyyyyyyy&v=2.0
PredictionBackground=Moccasin
CurrentIndexFormat=Standard
;CurrentIndexFormat=Betel-Kocher
CurrentIndexDay=Today
CurrentPwsFWI=<span id='CurrentPwsFWI' style="border: 1px solid black;text-align:center;background:green;color: white">  26.4 pwsFWI</span>

NOTE: CurrentPwsFWI is not configurable but is set/read by the application. Any value you put here will be modified.

[Top10]

BackgroundColorHeader=#d0d0d0
BackgroundColorTable=#f0f0f0
TextColorAccentTable=DarkOrange
TextColorHeader=Green
NumberOfColumns=3

[NOAA]

FTPDirectory=./reports/
ColorNOAAText=Black
ColorNOAABackground=#f9f8EB
StartInCurrentMonth=true

NOTE: the report directory MUST be the directory you configure in Cumulus.ini

[Graphs]

UseHighchartsBoostModule=true
UseNormalTempReference=both
UseNormalRainReference=both
MaxNrOfSeriesVisibileInGraph=3
PeriodMovingAverage=365
WindRoseNrOfWindforceClasses=6
WindRoseMaxWindSpeed=60
WindRoseInversed=false
WindrunClassWidth=75
DailyRain=true
MonthlyRain=true
YearRainstats=true
YearMonthRainstats=true
RAINvsEVT=true
MonthlyTemp=true
YearTempstats=true
YearMonthTempstats=true
WarmerDays=true
HeatMap=true
WindRose=true
Windrun=true
SolarHours=true
SolarEnergy=true
SolarHoursYearMonth=true
SolarEnergyYearMonth=true
TempSum=true
GrowingDegreeDays=true
Seasons=true
DailyEVT=true
MonthlyEVT=true
AverageClash=true
GraphColors=
;GraphColors=['#058DC7', '#50B432', '#ED561B', '#DDDF00', '#24CBE5', '#64E572', '#FF9655', '#FFF263', '#6AF9C4']
WindRoseColors=
;WindRoseColors=['lightgrey', 'green', 'blue', 'yellow', 'orange', 'red', 'deeppink', 'purple', 'black']
HeatmapNumberOfYearsPerPage=10
GrowingDegreeDaysReferenceTemp=5
WinterToSpringTemperatureLimit=5
SpringToSummerTemperatureLimit=15

[FTP site]

DoUploadFTP=true
UploadDir=
FtpLog=on

[Maps]

Website=[fill in your website URL for the CUtils site or the specifc page of your own website]
Participant=true
DoneToday=15-05-21

[Website]

// The statistics parameters are currently either for Google or Matomo, Google is default
// If the corresponding ID's and or Url are not filled in, invalid code is generated. If you do not want
// statistics than set StatisticsType without value

StatisticsType= [Google || Matomo] default is empty
GoogleStatsId=
MatomoTrackerUrl=
MatomoSiteId=
PermitGoogleOptout=false (default)

CumulusRealTimeLocation=
ShowInsideMeasurements=true
CumulusRealTimeInterval=30
ShowUV=true
ShowSolar=true
HeaderLeftText=
HeaderRightText=
SiteTitleAddition=
PwsfwiButtonInHeader=true (default)       => When true the direct access pwsFWI button will show in the header, when false it shows in the menu bar

ColorMenuBackground=Lightgrey
ColorMenuText=Black
ColorDropdownMenuBackground=Lightgrey
ColorDropdownMenuText=Black
ColorDropdownMenuHoverBackground=Silver
ColorDropdownMenuHoverText=Black
ColorTitleBar=#E87510
ColorTitleText=White
ColorDashboardCellTitleBarBackground=#C5C55B
ColorDashboardCellTitleBarText=White
ColorDashboardCellText=Black
ColorDashboardCellBackground=White
ColorReportviewText=black
ColorReportviewBackground=white
ColorReportviewTableData=Black
ColorFooterLink=#E87510
ColorFooterLinkHover=OrangeRed
ColorFooterBackground=lightgrey
ColorFooterText=Black
ColorBodyBackground=white
ColorDashboardTextAccent=Chartreuse
ColorTitleBackGroundImage=
ColorToggler=Black
ColorDashboardUpIndicator=Chartreuse
ColorDashboardDownIndicator=Red
SteelseriesFramedesign=SHINY_METAL
SteelseriesBackgroundColor=BROWN
SteelseriesPointerColour=RED
SteelseriesPointerType=type3
SteelseriesDirAvgPointertype=TYPE3
SteelseriesDirAvgPointerColour=BLUE
SteelseriesLcdColour=ORANGE
SteelseriesForegroundType=type1
SteelseriesKnobType=STANDARD_KNOB
SteelseriesKnobStyle=SILVER
SteelseriesRainUseSectionColours=true
SteelseriesRainUseGradientColours=true
SteelseriesTempThresholdValue=30
SteelseriesLedVisible=false
ThresholdTempVisible=true
ThresholdTempValue=30
ThresholdHumidityVisible=true
ThresholdHumidityValue=80
ThresholdWindVisible=true
ThresholdWindValue=30
ThresholdRainVisible=true
ThresholdRainValue=20
ThresholdRRateVisible=true
ThresholdRRateValue=10
ThresholdUVVisible=true
ThresholdUVValue=8
HomeGraphTempColor=#058DC7
HomeGraphDewPointColor=#50B432
HomeGraphApparentTempColor=#ED561B
HomeGraphFeelsLikeColor=#DDDF00
HomeGraphWindChillColor=#24CBE5
HomeGraphHeatIndexColor=#64E572
HomeGraphHumidexColor=#FF9655
HomeGraphInsideTempColor=#6AF9C4
HomeGraphPressureColor=#058DC7
HomeGraphBearingColor=#058DC7
HomeGraphAverageBearingColor=#ED561B
HomeGraphWindSpeedColor=#058DC7
HomeGraphWindGustColor=#ED561B
HomeGraphRainfallColor1=#50B432
HomeGraphRainfallColor2=
HomeGraphRainfallColor3=
HomeGraphRainRateColor=#058DC7
HomeGraphHumidityColor=#058DC7
HomeGraphInsideHumidityColor=#50B432
HomeGraphSolarTheoreticalMaxColor1=#DDDF00
HomeGraphSolarTheoreticalMaxColor2=
HomeGraphSolarTheoreticalMaxColor3=
HomeGraphSolarRadiationColor1=#FF9655
HomeGraphSolarRadiationColor2=
HomeGraphSolarRadiationColor3=
HomeGraphUVindexColor=#058DC7
HomeGraphSunHoursColor=gold
HomeGraphDailyRainColor=#058DC7
HomeGraphLineWidth=2
HomeGraphDailyTempAverageColor=#50B432
HomeGraphDailyTempMinColor=#058DC7
HomeGraphDailyTempMaxColor=#ED561B
Panel-1=TemperatureText
Panel-2=PressureText
Panel-3=RainText
Panel-4=Clocks
Panel-8=WindText
Panel-9=SolarDisc
Panel-10=LunarDisc
Panel-11=HumidityText
Panel-12=SolarText
Panel-13=TemperatureGauge
Panel-14=OtherTempsGauge
Panel-15=PressureGauge
Panel-16=HumidityGauge
Panel-20=CloudBaseGauge
Panel-21=RainGauge
Panel-22=RainSpeedGauge
Panel-23=SolarGauge
Panel-24=UVGauge
UseCMXMoonImage=false
MoonImageLocation=
ColorTitleBackGroundImage=HPIM3899_day.JPG
ColorTitleBackGroundImageCivil=HPIM3899_civil.JPG
ColorTitleBackGroundImageNautical=HPIM3899_nautical.JPG
ColorTitleBackGroundImageAstronomical=HPIM3899_astronomical.JPG
ColorTitleBackGroundImageNight=HPIM3899_night.JPG

[Forecasts]

SevenDayPredictionURL=http://api.yourweather.co.uk/index.php?[registration specifics]
ForecastSystem=SpotWx
NorwegianURL=https://retro.yr.no/place/Netherlands/Groningen/Wagenborgen/
WXsimURL=

NOTE: the Norwegian site is in process of transition, it will be reworked sometime. At some point it may cease to function.

[SysInfo]

ReportWidth=700
SystemInfoLinesToSkip=
ExtraStationInfo=
Tx=

[Thrifty]

Top10RecordsPeriod=1
RainGraphsPeriod=1
TempGraphsPeriod=1
WindGraphsPeriod=3
MiscGraphsPeriod=1
MapsPeriod=1
SolarGraphsPeriod=3

[StationMap]

StationMapMenu=true
ArrowLatitude=53.2948
ArrowLongitude=7.0673
Zoomlevel=13
CompassRosePosition=bottomright
CompassRoseType=2
WindArrowType=1

[Compiler]

SmaPeriod=5
DoneToday=04-09-21

[MeteoCam]

MeteoCamMenu=true
MeteoCamDir=./MeteoCam
TimelapseExtension=mp4
MeteoCamName=meteocam.jpg
CamType=[manual | EcowittHP10]

[AirLink]

(before version 6.1 this section was [AirQuality]

CountrySelected=EU
WantToSeeNow=true
WantToSeeNowCast=true
WantToSee1hr=true
WantToSee3hr=true
WantToSee24hr=true
WantToSeeWind=true
CleanupAirlinkLogs=false
ReferenceLineThickness=4

[ExtraSensors]

ExtraSensors=false
ParticipatesSensorCommunity=false
CleanupExtraSensorslog=false
UserModificationExtraSensorCharts=false
LightningSensor=[ false | true ]
ExternalExtraSensors=[ fill with comma separated liste of sensor names ]

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=
ExtraHum=
ExtraDP=
SoilTemperature=
SoilMoisture=
AirQuality=
UserTemp=
LeafTemp=

[CustomLogs]

CustomLogs=false
UserModificationCustomLogsCharts=false
DoneToday=2023-10-16T12:41:00


NOTE:

  1. 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 emptying this parameter.
  2. the Ecowitt CO2 sensor is not parameterised but its presence is detected by the presence of a value in the database.
  3. the Ecowitt AirQuality sensors have an implicit accompanying AirQualityAvg giving the 24 hr average
Retrieved from "https://www.cumuluswiki.org/index.php?title=Cumulusutils.ini&oldid=11599"