Error (ENUM) ¶ TYPE Error : Building lib error Attributes: qualified_only InOut: Name Initial Comment NoError 0 No error. InputError 1 Invalid / inconsistent inputs provided by caller. DateTimeError 2 Error getting system time HardwareError 3 Service indications or error indications highlight a hardware issue.
IsLibReleased (FUN) ¶ FUNCTION IsLibReleased : BOOL This function has been automatically generated from the project information. InOut: Scope Name Type Return IsLibReleased BOOL
RSM Utility ¶ Enums ERROR (Enum) Function Blocks PoolExtender AsyncProperty (Folder) GetInstancePointer (Method) RSMClass (FunctionBlock) Extend (Method) Reset (Method) Globals PoolHandling (GVL) Interfaces AsyncProperty IAsyncProperty (Interface) GetInstancePointer (Method) IPoolExtender IPoolExtender (Interface) GetRequest (Method) ScheduleRequest (Method) Structs REQUEST (Struct) RSM_HANDLE (Struct) Types APP_NAME (Alias) TASK_GROUP (Alias) TASK_NAME (Alias)
HeatCoolOperationMode (ENUM) ¶ TYPE HeatCoolOperationMode : SequenceControl and other functionalities provide / use this heat/cool operation mode. Attributes: qualified_only InOut: Name Initial UNUSED -1 HEAT 0 COOL 1 INACTIVE 2
ERROR (ENUM) ¶ TYPE ERROR : Attributes: qualified_only InOut: Name NO_ERROR WRONG_PARAMETER WRONG_CONFIGURATION ALREADY_INITIALIZED TASK_CREATION_FAILED EVENT_CREATION_FAILED NO_MEMORY SCHEDULING_FAILED
ServiceIndication (ENUM) ¶ TYPE ServiceIndication : Service indication used in conjunction with ServiceIndicationValue . Attributes: qualified_only InOut: Name Initial UNUSED -1 OFF 0 ON 1
Function Blocks ¶ PoolExtender AsyncProperty (Folder) GetInstancePointer (Method) RSMClass (FunctionBlock) Extend (Method) Reset (Method)
Function Blocks ¶ Actuator Fan3Stage (FunctionBlock) Fan3StageState (Enum) HVAC_Coil (FunctionBlock) Functionality SetError (Method) HVAC_RotaryHeatExchanger (FunctionBlock) Functionality optional cleaning operation malfunction detection malfunction locking SetError (Method) HeatCool2Linear (FunctionBlock) IActuatorContinuous (Interface) DateTimeProvider (Property) Enable (Property) ErrorIdOut (Property) ErrorOut (Property) Reset (Property) Setpoint (Property) IActuatorOnOff (Interface) DateTimeProvider (Property) ErrorIdOut (Property) ErrorOut (Property) IsOn (Property) RequestOn (Property) Reset (Property) IValveContinuous (Interface) PumpOnOff (FunctionBlock) Application example Device examples Functionality on / off delay blocking protection command execution monitoring malfunction detection malfunction locking DateTimeProvider (Property) ErrorIdOut (Property) ErrorOut (Property) IsOn (Property) RequestOn (Property) Reset (Property) ValveContinuous (FunctionBlock) Functionality Blocking protection DateTimeProvider (Property) Enable (Property) ErrorIdOut (Property) ErrorOut (Property) Reset (Property) Setpoint (Property) ValveSixWay (FunctionBlock) Application example Device examples Functionality ValveThermo (FunctionBlock) Application example Device examples Functionality Normally closed valves and warmup: Blocking protection DateTimeProvider (Property) Enable (Property) ErrorIdOut (Property) ErrorOut (Property) Reset (Property) Setpoint (Property) ValveThermoWarmupState (Enum) WindowActuator (FunctionBlock) Application example Device examples Functionality WindowActuatorState (Enum) Aggregates Examples ExampleFancoil3StageAggregate (FunctionBlock) Fancoil3Stage (FunctionBlock) Functionality Control of fan speed dependent on valve position or control deviation FancoilContinuous (FunctionBlock) Application example Device examples Why does CODESYS Building Automation library contain a fan coil unit control strategy, even if some fan coil units come with integrated controller? Functionality Characteristic curve of fan speed Assemblies FourToTwoPipes (FunctionBlock) Application example Functionality Control CommandExecutionMonitoring (FunctionBlock) CommandVariable (FunctionBlock) HVAC_AntiFreezeControlMonitor (FunctionBlock) Application example Functionality HVAC_AntiFreezeControlSensor (FunctionBlock) Application example Functionality HVAC_AntiFreezeControlStartup (FunctionBlock) Application example Functionality RedundantPlantControl8 (FunctionBlock) SequenceControl (FB) Sequence combinations: Sequence relations: Control algorithm inputs: Relation between setpoints sequences: Other control characteristics: Integrator dynamics Reset “Anti windup” (integration limit) “Soft set” SequenceControlSequences (Enum) SequenceSwitch (FunctionBlock) Examples ExampleAirConditioning1 (FB) Air types Sequence control heater coil / cooler coil Hints Caveats ExampleAirConditioning2 (FB) Air types Sequence control damper / heater coil / cooler coil Recirculation air admixing and energy selection Minimum outdoor air ratio Water side anti-freeze for heater coil Air side anti-freeze Hints Caveats ExampleHeating (FunctionBlock) Heating circuit operation Night time setpoint reduction vs. switching off heating circuit operation Economy mode Optional anti-freeze Caveats ExampleHotWater (FunctionBlock) 2 point control of boiler temperature Legionella prevention Optional unload protection Caveats ExampleRoomAutomation (FB) Air types Presence controlled energy level Night cooling Energy lock Sommer compensation Fast heat / cool Window alarm Manual fan control Hints Caveats ExampleVariantsRoomControlFCUSimple (FunctionBlock) Examples_ImagePool (ImagePool) Misc DailyMeanTemperature (FunctionBlock) When does the daily mean temperature gets valid? “Warp clock”-enabled HeatingCharacteristicCurve (FunctionBlock) Application example Functionality HysteresisReal (FunctionBlock) LogBoolChange (FunctionBlock) RoomSetpoint (FunctionBlock) “effective comfort setpoint” Setpoint outputs - whats the difference Optimization EnergyLevelSetpoint (FunctionBlock) VDI 3814 reference HeatCoolUsingOutdoorAir (FB) Functionality Cooling mode Heating mode Time related DateTimeSplit (FunctionBlock) MaxOnTime (FunctionBlock) “Warp clock”-enabled MinOnOffTime (FunctionBlock) “Warp clock”-enabled OnOffDelay (FunctionBlock) “Warp clock”-enabled OperationalTime (FunctionBlock) “Warp clock”-enabled PeriodicTimer (FunctionBlock) “Warp clock”-enabled WarpClock (FunctionBlock) AddTime (Method) ComputeWarpFactor (Method) GetDateTime (Method) GetLocalSystemTime (Method) GetUtcSystemTime (Method)
PoolExtender ¶ AsyncProperty (Folder) GetInstancePointer (Method)