Rockwell Automation 9307 FactoryTalk EnergyMetrix - Manual (Page 130)

FactoryTalk EnergyMetrix Software
130
Peak Function
The Peak function returns the maximum of the selected value logged between the report
start and end dates, and during the periods defined by the SeasonType, DayType,
TimeOfUseType (or StartHour and EndHour) arguments. The Peak function is generally
used for rate-of-change values such as demand real and reactive power (kW, kVAR). It
returns a Double value.
Usage
Quantity = Peak(ValueType.enumValue)
Quantity = Peak(ValueType.enumValue, SeasonType.enumValue)
Quantity = Peak(ValueType.enumValue, SeasonType.enumValue,
DayType.enumValue)
Quantity = Peak(ValueType.enumValue, DayType.enumValue)
Quantity = Peak(ValueType.enumValue, startHour, endHour)
Quantity = Peak(ValueType.enumValue, TimeOfUseType.enumValue)
Quantity = Peak(ValueType.enumValue, SeasonType.enumValue,
DayType.enumValue, startHour, endHour)
Quantity = Peak(ValueType.enumValue, SeasonType.enumValue,
DayType.enumValue, TimeOfUseType.enumValue)
Quantity = Peak(ValueType.enumValue, DayType.enumValue,
TimeOfUseType.enumValue)
Comments
For calculating peaks which occur outside the report period, use the Ratchet Function .
The startHour and endHour arguments are integers in the range of 1…24, where
24 = midnight.
Example
The following script calculates the peak real demand power that occurred during the
Summer season, on working days, during the hours of 10:00 am to 4:00 pm:
Quantity = Peak(ValueType.RealPowerDemand, SeasonType.Summer,
DayType.WorkingDay, 10, 16)
PeakTimestamp Function
The PeakTimestamp function returns the time and date that the maximum of the selected
value was logged between the report start and end dates, and during the periods defined by
the SeasonType, DayType, TimeOfUseType (or StartHour and EndHour) arguments. The
PeakTimestamp function is generally used for rate-of-change values such as demand real
and reactive power (kW, kVAR). It returns a DateTime value.