OptoMMP3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Opto22.OptoMMP3.OptoMMP.stPid Struct Reference

When reading or writing a PID, these are the available parameters returned or written. More...

Public Attributes

Single f32Error
 Current error calculated by the PID. More...
 
Single f32GainContribution
 Contribution of the gain portion of the PID. More...
 
Single f32IntegralContribution
 Contribution of the integral portion of the PID. More...
 
Single f32DerivativeContribution
 Contribution of the derivative portion of the PID. More...
 
Single f32CurrentIntegral
 The current integral value. More...
 
UInt32 u32ScanCounter
 Current scan counter. More...
 
Boolean bInputBelowLowScale
 True when the input is too low. Input clamping must be enabled. More...
 
Boolean bInputAboveHighScale
 True when the input is too high. Input clamping must be enabled. More...
 
Boolean bOutputForced
 True when the output is forced. Output forcing must be enabled. More...
 
Single f32ProcessVariableOrInput
 Current process variable read or the value provided by the supervisory system. More...
 
Single f32Setpoint
 Current setpoint read or the value provided by the supervisory system. More...
 
Single f32CurrentFeedForwardContribution
 Current feed forward contribution. More...
 
Single f32CurrentOutput
 Current output computed by the PID. Use to overwrite the output when a PID is in manual mode. The output may be used by a supervisory system. More...
 
Single f32GainParameter
 Gain, K, or proprotional term. More...
 
Single f32IntegralParameter
 I term. More...
 
Single f32DerivativeParameter
 D or derivative term. More...
 
Single f32FeedForwardGainParameter
 Feed forward gain. More...
 
Single f32MaximumOutputChange
 Maximum output change limit. More...
 
Single f32MinimumOutputChange
 Minimum output change limit. More...
 
Single f32InputLowRange
 Input low range limit. More...
 
Single f32InputHighRange
 Input high range limit. More...
 
Single f32OutputLowerClamp
 Lower output clamp limit. More...
 
Single f32OutputUpperClamp
 Upper output clamp limit. More...
 
Single f32PidScanTimeSeconds
 Scan time, in seconds (with 1 ms resolution). More...
 
Single f32InputLowOutputForceValue
 When the input is too low, this is the value to force the output too. More...
 
Single f32InputHighOutputForceValue
 When the input is too high, this is the value to force the output too. More...
 
UInt32 u32InputSourceOptoMmpAddress
 OptoMMP address of the input source. Use the lower 32-bits of the OptoMMP 48-bit address. Use zero if the input is provided by the supervisory system. More...
 
UInt32 u32SetpointSourceOptoMmpAddress
 OptoMMP address of the setpoint source. Use the lower 32-bits of the OptoMMP 48-bit address. Use zero if the setpoint is provided by the supervisory system. More...
 
UInt32 u32OutputDestinationOptoMmpAddress
 OptoMMP address of the output destination. Use the lower 32-bits of the OptoMMP 48-bit address. Use zero if the output is read and processed only by the supervisory system. More...
 
ePidAlgorithm eAlgorithm
 Algorithm selection. More...
 
Boolean bInManualMode
 Manual (true) or automatic mode. More...
 
Boolean bSquareRootOfInput
 Square root the input. Use for differential-pressure based flowmeters. More...
 
Boolean bForceOutputWhenInputOutOfRange
 Controls if the output is forced when the input is out of range. More...
 
Boolean bSwitchToManualWhenInputOutOfRange
 Controls if the PID is forced to manual mode when the input is out of range. More...
 
Single f32CurrentInput
 The immediate input available to the PID. More...
 
Single f32CurrentSetpoint
 The immediate setpoint available to the PID. More...
 
Single f32SupervisoryInputToPid
 When algorithm is set to Velocity C and the Input OptoMMP address is zero, and firmware is R8.5e or later, use this value as the location to provide the PID the supervisory input. This is also coorelated with KB81008. You may search for the KB on the Opto 22 website. More...
 

Detailed Description

When reading or writing a PID, these are the available parameters returned or written.

Member Data Documentation

Boolean Opto22.OptoMMP3.OptoMMP.stPid.bForceOutputWhenInputOutOfRange

Controls if the output is forced when the input is out of range.

Boolean Opto22.OptoMMP3.OptoMMP.stPid.bInManualMode

Manual (true) or automatic mode.

Boolean Opto22.OptoMMP3.OptoMMP.stPid.bInputAboveHighScale

True when the input is too high. Input clamping must be enabled.

Boolean Opto22.OptoMMP3.OptoMMP.stPid.bInputBelowLowScale

True when the input is too low. Input clamping must be enabled.

Boolean Opto22.OptoMMP3.OptoMMP.stPid.bOutputForced

True when the output is forced. Output forcing must be enabled.

Boolean Opto22.OptoMMP3.OptoMMP.stPid.bSquareRootOfInput

Square root the input. Use for differential-pressure based flowmeters.

Boolean Opto22.OptoMMP3.OptoMMP.stPid.bSwitchToManualWhenInputOutOfRange

Controls if the PID is forced to manual mode when the input is out of range.

ePidAlgorithm Opto22.OptoMMP3.OptoMMP.stPid.eAlgorithm

Algorithm selection.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32CurrentFeedForwardContribution

Current feed forward contribution.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32CurrentInput

The immediate input available to the PID.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32CurrentIntegral

The current integral value.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32CurrentOutput

Current output computed by the PID. Use to overwrite the output when a PID is in manual mode. The output may be used by a supervisory system.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32CurrentSetpoint

The immediate setpoint available to the PID.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32DerivativeContribution

Contribution of the derivative portion of the PID.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32DerivativeParameter

D or derivative term.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32Error

Current error calculated by the PID.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32FeedForwardGainParameter

Feed forward gain.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32GainContribution

Contribution of the gain portion of the PID.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32GainParameter

Gain, K, or proprotional term.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32InputHighOutputForceValue

When the input is too high, this is the value to force the output too.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32InputHighRange

Input high range limit.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32InputLowOutputForceValue

When the input is too low, this is the value to force the output too.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32InputLowRange

Input low range limit.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32IntegralContribution

Contribution of the integral portion of the PID.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32IntegralParameter

I term.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32MaximumOutputChange

Maximum output change limit.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32MinimumOutputChange

Minimum output change limit.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32OutputLowerClamp

Lower output clamp limit.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32OutputUpperClamp

Upper output clamp limit.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32PidScanTimeSeconds

Scan time, in seconds (with 1 ms resolution).

Single Opto22.OptoMMP3.OptoMMP.stPid.f32ProcessVariableOrInput

Current process variable read or the value provided by the supervisory system.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32Setpoint

Current setpoint read or the value provided by the supervisory system.

Single Opto22.OptoMMP3.OptoMMP.stPid.f32SupervisoryInputToPid

When algorithm is set to Velocity C and the Input OptoMMP address is zero, and firmware is R8.5e or later, use this value as the location to provide the PID the supervisory input. This is also coorelated with KB81008. You may search for the KB on the Opto 22 website.

UInt32 Opto22.OptoMMP3.OptoMMP.stPid.u32InputSourceOptoMmpAddress

OptoMMP address of the input source. Use the lower 32-bits of the OptoMMP 48-bit address. Use zero if the input is provided by the supervisory system.

Warning. For users of the Velocity C algorithm with firmware R8.5e and later, and with an input OptoMMP address == 0, use the alternate PID Input value when setting the PID input.

UInt32 Opto22.OptoMMP3.OptoMMP.stPid.u32OutputDestinationOptoMmpAddress

OptoMMP address of the output destination. Use the lower 32-bits of the OptoMMP 48-bit address. Use zero if the output is read and processed only by the supervisory system.

UInt32 Opto22.OptoMMP3.OptoMMP.stPid.u32ScanCounter

Current scan counter.

UInt32 Opto22.OptoMMP3.OptoMMP.stPid.u32SetpointSourceOptoMmpAddress

OptoMMP address of the setpoint source. Use the lower 32-bits of the OptoMMP 48-bit address. Use zero if the setpoint is provided by the supervisory system.


The documentation for this struct was generated from the following file: