Charts Definition Language (CDL): Difference between revisions

The [[ChartsCompiler]] is obligatory after the introduction of the [[Extra Sensors|ExtraSensors]] module from version 6.5 onwards where the [[ChartsCompiler]] is used internally for defining and creating the charts for the [[Extra Sensors|ExtraSensors]] module which would otherwise - in a generic way - be virtually impossible. The ''CutilsCharts.def'' has a demarcation line which separates the Extra Sensors Charts (below) from the user charts (above). The user can define he wants to create his own Extra Sensor Charts by setting the parameter ''UserModificationExtraSensorCharts=true''.

A standard CutilsCharts.def and a CutilsCharts-example.def are in the distribution. The first for an initial setup, the second to guide the user into the possibilities.

[[File:ChartCompilerSpec2.jpg|upright|1300px|left|Chart Compiler Language (CDL) specification ]]

   CHART <id> TITLE [<word>...<word>]  CONNECTSto [1 … 24]

  [ PLOT [ALL||DAILY|RECENT|EXTRA] <Plotvariable> [ [[CDL - EVAL|EVAL]] '[' <Expression> ']' ]

#EQUATIONS: Starts an equations block. Such block only defines (partial) equations, it does not cause code generation in itself

#CONNECTSTO: The integer numbers which follow CONNECTSTO represent a pane in the realtime [[Dashboard|dashboard]]. When clicked on that pane this chart appears. This is only valid on charts in the default output. For other outputs there is no semantics for CONNECTSTO and a warning is issued in the logfile if it is specified in any second or higher output.

#PLOT: Starts the plot specification using one of the possible variables

#RECENT: Defines the variable to be governed by the CMX parameter ''GraphHours'' and are similar to the CMX RECENT graphs (though not equal).

#AS: Defines the type of charting for that variable.

#LINEWIDTH: Defines the linewidth for that variable.

#OUTPUT: Gives an optional name of an outputfile which starts at the chart where it is defined. Any chart after this OUTPUT specifier goes to this OUTPUT until another OUTPUT is found. Only the first OUTPUT specifier accepts click events as defined by CONNECTSTO.

       "UV", "SolarRadiation", "TheoreticalSolarMax",

       "MinTemp", "MaxTemp", "AverageTemp", "WindChill", "MaxDewpoint", "MinDewpoint","MaxFeelsLike", "MinFeelsLike",  

       "MaxGust", "WindRun", "WindSpeed",  

       "RainFall", "MaxRainRate",

       "HeatingDegreeDays","CoolingDegreeDays","EvapoTranspiration"

       Temp, Wind, Distance, Hours, Solar, UV, Rain, Rrate, Pressure, Humidity, DegreeDays, EVT, AQ, ppm

In future a generic (without title or unit) Axis will selectable to accommodate plotting in combination with other variables.

Translations for the axis titles come from the [Website] section and should require no additional effort.

#All parameters can be combined in one graph with the corresponding axis automatically added. Only when scatter is defined as Line Type it is forbidden to combine it with one of the other possibilities. This may change in future.

#The height of the graph container can be specified in the options (not defined in the language to prevent overcharge):

   [Compiler]

#The Plot Variables Evapotranspiration, CoolingDegreeDays and Heating DegreeDays are not supplied by CMX in the JSONs. CumulusUtils provides those automatically when used in the definitions (on request) with the commandline parameter [[UserAskedData]]. See also [[ChartsCompiler#Operation|ChartsCompiler Operation]].

#You have to schedule this command if you wish to use the FTP frequency CMX uses for its JSON's. Note that these JSON files specific to CumulusUtils '''always reside in the website root''' of CumulusUtils, even if you have more websites and define the ''CumulusRealTimeLocation''.

; Note the eqn is only valid for degr Celsius and Kmh.

   Plot UV zIndex 100

   Plot SolarRadiation As Area Opacity 0.4 Colour Orange zIndex 50  

   Plot TheoreticalSolarMax As Area Colour Gold zIndex 10 Opacity 0.2

; Compare the Dewpoint from Cumulus with the calculated approximation