381 lines
14 KiB
C#
381 lines
14 KiB
C#
///
|
|
/// Copyright (c) 2013-2015 Sensus Metering Systems
|
|
///
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using log4net;
|
|
using TBF.BenchControl.GenericDevices;
|
|
using TBF.Boxes;
|
|
|
|
namespace TBF.BenchControl.Elde.RegulValveTandem
|
|
{
|
|
public class SetFlowOp : IOperation
|
|
{
|
|
private static readonly ILog log = LogManager.GetLogger(typeof(SetFlowOp));
|
|
public override string ToString()
|
|
{
|
|
return string.Format("SetFlowOp({0}, Qfrom={1}, Qto={2}, PID={3})", regulValve.Name, finalReqFlowLo, finalReqFlowHi, pidCoef);
|
|
}
|
|
|
|
/// Set by the constructor
|
|
readonly ControlBoardDev controlBoard;
|
|
readonly Elde.RegulValve.RegulValve regulValve;
|
|
readonly int regulValveNr;
|
|
readonly Elde.RegulValve.RegulValve fixedRV;
|
|
readonly int fixedRVNr;
|
|
readonly float fixedPctLo;
|
|
readonly float fixedPctHi;
|
|
readonly int flowMeterNr;
|
|
readonly float finalReqFlowLo;
|
|
readonly float finalReqFlowHi;
|
|
readonly float reqFlowAve;
|
|
readonly float pidCoef;
|
|
readonly int timeout;
|
|
readonly bool leaveMeasurementRunning;
|
|
|
|
readonly float nominalFlow;
|
|
|
|
/// Process values
|
|
enum OpState
|
|
{
|
|
Idle = 0,
|
|
IssueSetPositionCommand,
|
|
SettingPosition,
|
|
IssueSetPositionCommand_FixedRV,
|
|
SettingPosition_FixedRV,
|
|
IssueSetFlowCommand,
|
|
SettingFlow,
|
|
FlowReached,
|
|
}
|
|
OpState opState;
|
|
|
|
float currentReqFlowLo;
|
|
float currentReqFlowHi;
|
|
float targetPositionLo;
|
|
float targetPositionHi;
|
|
|
|
int expireTime;
|
|
DoubleBox measuredFlow;
|
|
int flowWithinBoundsTime;
|
|
|
|
|
|
/// <summary>
|
|
/// Set required water flow. Conditionally leave the measurement running.
|
|
/// Events: FlowSet, FlowTimeOut
|
|
/// </summary>
|
|
/// <param name="ControlBoard">Control board device</param>
|
|
/// <param name="_regulValve">Regulation valve component</param>
|
|
/// <param name="fxdRV">Regulation valve set to a fixed position</param>
|
|
/// <param name="fixedPctLo">Lower limit of the fixed position of the fixed reg.v.</param>
|
|
/// <param name="fixedPctHi">Upper limit of the fixed position of the fixed reg.v.</param>
|
|
/// <param name="flowMeter">Flowmeter component</param>
|
|
/// <param name="requiredFlowLo">Lower limit of the flow to be achieved in [m3/h]</param>
|
|
/// <param name="requiredFlowHi">Upper limit of the flow to be achieved in [m3/h]</param>
|
|
/// <param name="pidCoef">PID coefficient (float)</param>
|
|
/// <param name="timeout">Timeout for the flow setting in [s]</param>
|
|
/// <param name="leaveMeasurementRunning">true = Leave the measurement running after op. stop</param>
|
|
/// <remarks>Only Elde.Valve flow are used, other flow on the lists are ignored</remarks>
|
|
public SetFlowOp(ControlBoardDev controlBoard, IRegulValve regV, IRegulValve fxdRV, float fxdPctLo, float fxdPctHi,
|
|
IFlowMeter flowMeter, float requiredFlowLo, float requiredFlowHi, float pidCoef, DoubleBox measuredFlow,
|
|
int timeout, bool leaveMeasurementRunning)
|
|
{
|
|
if (controlBoard == null) throw new ArgumentNullException("ctrlBoard");
|
|
this.controlBoard = controlBoard;
|
|
|
|
regulValve = regV as Elde.RegulValve.RegulValve;
|
|
if (regulValve == null) throw new ArgumentNullException("regValve is null or not Elde");
|
|
regulValveNr = regulValve.Idx1;
|
|
|
|
fixedRV = fxdRV as Elde.RegulValve.RegulValve;
|
|
if (fixedRV == null) throw new ArgumentNullException("regValve is null or not Elde");
|
|
fixedRVNr = fixedRV.Idx1;
|
|
|
|
this.fixedPctLo = fxdPctLo;
|
|
this.fixedPctHi = fxdPctHi;
|
|
|
|
if (flowMeter is Elde.FlowMeter.FlowMeter)
|
|
{
|
|
this.flowMeterNr = (flowMeter as Elde.FlowMeter.FlowMeter).Idx1;
|
|
}
|
|
else if (flowMeter is Elde.FlowMeterTwins.FlowMeter)
|
|
{
|
|
this.flowMeterNr = 0;
|
|
}
|
|
else
|
|
{
|
|
throw new ArgumentNullException("flowMeter is null or not Elde");
|
|
}
|
|
|
|
nominalFlow = flowMeter.NominalFlow;
|
|
|
|
this.finalReqFlowLo = requiredFlowLo;
|
|
this.finalReqFlowHi = requiredFlowHi;
|
|
this.reqFlowAve = (requiredFlowLo + requiredFlowHi) / 2.0f;
|
|
this.pidCoef = pidCoef;
|
|
this.measuredFlow = measuredFlow;
|
|
|
|
this.timeout = timeout;
|
|
|
|
this.leaveMeasurementRunning = leaveMeasurementRunning;
|
|
|
|
log.Debug(this.ToString());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Set required water flow - Do not leave the measurement running.
|
|
/// Events: FlowSet
|
|
/// </summary>
|
|
public SetFlowOp(ControlBoardDev controlBoard, IRegulValve regValve, IRegulValve fixedRV, float fixedPctLo, float fixedPctHi,
|
|
IFlowMeter flowMeter, float requiredFlowLo, float requiredFlowHi, float pidCoef, DoubleBox measuredFlow, int timeout)
|
|
: this(controlBoard, regValve, fixedRV, fixedPctLo, fixedPctHi, flowMeter, requiredFlowLo, requiredFlowHi, pidCoef, measuredFlow, timeout, false)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Set required water flow - No timeout.
|
|
/// Events: FlowSet
|
|
/// </summary>
|
|
public SetFlowOp(ControlBoardDev controlBoard, IRegulValve regValve, IRegulValve fixedRV, float fixedPctLo, float fixedPctHi,
|
|
IFlowMeter flowMeter, float requiredFlowLo, float requiredFlowHi, float pidCoef, DoubleBox measuredFlow)
|
|
: this(controlBoard, regValve, fixedRV, fixedPctLo, fixedPctHi, flowMeter, requiredFlowLo, pidCoef, requiredFlowHi, measuredFlow, int.MaxValue, false)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Fetch target position limits from the dictionary or return false
|
|
/// </summary>
|
|
/// <param name="avgReqFlow">Average of the flow targer range (input)</param>
|
|
/// <param name="positionLo">Target valve position low limit (output)</param>
|
|
/// <param name="positionHi">Target valve position high limit (output)</param>
|
|
/// <returns>true when positions for the target flow are stored in the memory, otherwise return false</returns>
|
|
bool FetchTargetPosition(float avgReqFlow, out float positionLo, out float positionHi)
|
|
{
|
|
float targetPosition;
|
|
if (regulValve.Dict.TryGetValue(avgReqFlow, out targetPosition))
|
|
{
|
|
positionLo = Math.Max(targetPosition * 0.95f, 0.0f);
|
|
positionHi = Math.Min(targetPosition * 1.05f, 100.0f);
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
positionLo = 0.0f;
|
|
positionHi = 0.0f;
|
|
return false;
|
|
}
|
|
}
|
|
|
|
void StoreTargetPosition(float avgReqFlow, float actPosition)
|
|
{
|
|
if (!regulValve.Dict.ContainsKey(reqFlowAve))
|
|
{
|
|
regulValve.Dict.Add(new KeyValuePair<float, float>(avgReqFlow, actPosition));
|
|
}
|
|
return;
|
|
}
|
|
|
|
/// <summary>Start this operation</summary>
|
|
public void Start()
|
|
{
|
|
double flowMtrFreq = controlBoard.ReferenceFreq;
|
|
currentReqFlowLo = reqFlowAve;
|
|
currentReqFlowHi = reqFlowAve;
|
|
///
|
|
if (flowMtrFreq != 0)
|
|
{
|
|
double flow = flowMtrFreq * nominalFlow / 2000.0;
|
|
if (measuredFlow != null) measuredFlow.Val = flow;
|
|
if (flow >= reqFlowAve) currentReqFlowLo = finalReqFlowLo;
|
|
if (flow <= reqFlowAve) currentReqFlowHi = finalReqFlowHi;
|
|
}
|
|
else
|
|
{
|
|
currentReqFlowLo = finalReqFlowLo; /// Unexpected case when flowMtrFreq==0
|
|
currentReqFlowHi = finalReqFlowHi;
|
|
}
|
|
|
|
flowWithinBoundsTime = 0;
|
|
|
|
if (regulValve.RegulValveCfg.StoredPositionReuse && FetchTargetPosition(reqFlowAve, out targetPositionLo, out targetPositionHi))
|
|
{
|
|
log.InfoFormat("Start(): rv#={0} flowMtr#={1} TARGET: flowLo={2} flowHi={3} FETCHED: posLo={4} posHi={5}",
|
|
regulValveNr, flowMeterNr, currentReqFlowLo, currentReqFlowHi, targetPositionLo, targetPositionHi);
|
|
|
|
opState = OpState.IssueSetPositionCommand;
|
|
}
|
|
else
|
|
{
|
|
log.InfoFormat("Start(): rv#={0} flowMtr#={1} TARGET: flowLo={2} flowHi={3}",
|
|
regulValveNr, flowMeterNr, currentReqFlowLo, currentReqFlowHi);
|
|
|
|
opState = OpState.IssueSetPositionCommand_FixedRV;
|
|
}
|
|
|
|
expireTime = StateMachine.Time + timeout;
|
|
if (expireTime < 0) expireTime = int.MaxValue;
|
|
|
|
TestMethods tm = 0;
|
|
StopDevs sd = 0;
|
|
// '_regulValve.RegulValveTandemCfg.PidCoef' replaced by a casted operation parameter 'pidCoef'
|
|
controlBoard.SendCommand(Command.Start, flowMeterNr, controlBoard.Route,
|
|
int.MaxValue, int.MaxValue, tm,
|
|
new int[] { 0, 0, 0, 0, 0, 0, 0, 0 }, (int)pidCoef, 0, sd);
|
|
}
|
|
|
|
/// <summary>Run this operation</summary>
|
|
/// <returns>
|
|
/// Event.None, Event.FlowReached, Event.RegulValveTimeOut, Event.OpArgumentError
|
|
/// </returns>
|
|
public Event Run()
|
|
{
|
|
float rvPosition = controlBoard.RValvePosition(regulValveNr);
|
|
float fixedRVPosition = controlBoard.RValvePosition(fixedRVNr);
|
|
double flowMtrFreq = controlBoard.ReferenceFreq;
|
|
double flow = flowMtrFreq * nominalFlow / 2000.0;
|
|
|
|
if (flowMtrFreq != 0)
|
|
{
|
|
if (measuredFlow != null) measuredFlow.Val = flow;
|
|
if (flow >= reqFlowAve) currentReqFlowLo = finalReqFlowLo;
|
|
if (flow <= reqFlowAve) currentReqFlowHi = finalReqFlowHi;
|
|
}
|
|
|
|
log.InfoFormat("Run(): rv#={0} pos={1}% freq={2} flow={3} opState={4}",
|
|
regulValveNr, rvPosition.ToString("F1"), flowMtrFreq, flow, opState);
|
|
|
|
if (opState == OpState.IssueSetPositionCommand)
|
|
{
|
|
///
|
|
/// Done once, issues an appropriate ValveMove(...) command
|
|
///
|
|
controlBoard.ValveMove(regulValveNr, RegulValveMode.TargetPosition,
|
|
new float[2] { targetPositionLo, targetPositionHi },
|
|
regulValve.StableTime);
|
|
|
|
opState = OpState.SettingPosition;
|
|
return Event.None;
|
|
}
|
|
else if (opState == OpState.SettingPosition)
|
|
{
|
|
///
|
|
/// Repeated untill position is reached
|
|
///
|
|
if ((targetPositionLo <= rvPosition) && (rvPosition <= targetPositionHi))
|
|
{
|
|
opState = OpState.IssueSetPositionCommand_FixedRV;
|
|
}
|
|
return Event.None;
|
|
}
|
|
else if (opState == OpState.IssueSetPositionCommand_FixedRV)
|
|
{
|
|
///
|
|
/// Done once, issues an appropriate ValveMove(...) command
|
|
///
|
|
controlBoard.ValveMove(fixedRVNr, RegulValveMode.TargetPosition,
|
|
new float[2] { fixedPctLo, fixedPctHi },
|
|
regulValve.StableTime);
|
|
|
|
opState = OpState.SettingPosition_FixedRV;
|
|
return Event.None;
|
|
}
|
|
else if (opState == OpState.SettingPosition_FixedRV)
|
|
{
|
|
///
|
|
/// Repeated untill position is reached
|
|
///
|
|
if ((fixedPctLo <= fixedRVPosition) && (fixedRVPosition <= fixedPctHi))
|
|
{
|
|
opState = OpState.IssueSetFlowCommand;
|
|
}
|
|
return Event.None;
|
|
}
|
|
else if (opState == OpState.IssueSetFlowCommand)
|
|
{
|
|
///
|
|
/// Done once, issues an appropriate ValveMove(...) command
|
|
///
|
|
if (currentReqFlowLo >= currentReqFlowHi || currentReqFlowLo > nominalFlow || currentReqFlowHi <= 0)
|
|
{
|
|
return Event.OpArgumentError;
|
|
}
|
|
|
|
log.InfoFormat("Run(): rv#={0} flowMtr#={1} TARGET: flowLo={2} flowHi={3}",
|
|
regulValveNr, flowMeterNr, currentReqFlowLo, currentReqFlowHi);
|
|
|
|
float freqLo = 2000.0f * currentReqFlowLo / nominalFlow;
|
|
float freqHi = 2000.0f * currentReqFlowHi / nominalFlow;
|
|
controlBoard.ValveMove(regulValveNr, RegulValveMode.TargetFrequency,
|
|
new float[2] { freqLo, freqHi },
|
|
regulValve.StableTime);
|
|
|
|
opState = OpState.SettingFlow;
|
|
return Event.None;
|
|
}
|
|
else if (opState == OpState.SettingFlow)
|
|
{
|
|
///
|
|
/// Repeated untill the required flow is reached
|
|
///
|
|
if ((currentReqFlowLo <= flow) && (flow <= currentReqFlowHi))
|
|
{
|
|
if (flowWithinBoundsTime++ >= regulValve.FlowStableSec)
|
|
{
|
|
if (regulValve.RegulValveCfg.StoredPositionReuse)
|
|
{
|
|
float storedPosition;
|
|
if (regulValve.Dict.TryGetValue(reqFlowAve, out storedPosition))
|
|
{
|
|
/// update the stored valve position
|
|
StoreTargetPosition(reqFlowAve, (rvPosition + storedPosition) / 2.0f);
|
|
log.InfoFormat("Run(): rv#={0} reqFlow={1} pos={2}% stored={3} <--- Updating a stored position",
|
|
regulValveNr, reqFlowAve, rvPosition.ToString("F1"), storedPosition);
|
|
}
|
|
else
|
|
{
|
|
/// store the valve position
|
|
StoreTargetPosition(reqFlowAve, rvPosition);
|
|
log.InfoFormat("Run(): rv#={0} reqFlow={1} pos={2}% <--- Storing a new position",
|
|
regulValveNr, reqFlowAve, rvPosition.ToString("F1"));
|
|
}
|
|
}
|
|
opState = OpState.FlowReached;
|
|
return Event.FlowReached;
|
|
}
|
|
else
|
|
{
|
|
return Event.None;
|
|
}
|
|
}
|
|
else if (StateMachine.Time > expireTime)
|
|
{
|
|
return Event.RegulValveTimeOut;
|
|
}
|
|
else
|
|
{
|
|
flowWithinBoundsTime = 0;
|
|
return Event.None;
|
|
}
|
|
}
|
|
else /// opState == OpState.FlowReached
|
|
{
|
|
return Event.FlowReached;
|
|
}
|
|
}
|
|
|
|
/// <summary>Start this operation</summary>
|
|
public void Stop()
|
|
{
|
|
opState = OpState.Idle;
|
|
|
|
if (leaveMeasurementRunning) return;
|
|
|
|
/// Stop measurement
|
|
TestMethods tm = 0;
|
|
StopDevs sd = StopDevs.RegValveRegulation;
|
|
controlBoard.SendCommand(Command.Stop, flowMeterNr, controlBoard.Route,
|
|
50000, 50000, tm,
|
|
new int[] { 0, 0, 0, 0, 0, 0, 0, 0 }, 20, 0, sd);
|
|
}
|
|
}
|
|
}
|