AXIS_REF_ETC_Omron_G5.DriverVersion (PROP) ¶ PROPERTY DriverVersion : DWORD
ParameterAccess ¶ GetMappedDriveParameter (Method)
Assemblies ¶ Function blocks for building automation specific assemblies are collected in this folder. Assemblies - in contrast to aggregates which are build in its entirety - are build on-site from standard (loose) parts, but understood as operational unity. FourToTwoPipes (FunctionBlock) Application example Functionality
AXIS_REF_ETC_Omron_G5.GetMappedDriveParameter (METH) ¶ METHOD GetMappedDriveParameter : BOOL InOut: Scope Name Type Input bRead BOOL diParameterNumber DINT Return GetMappedDriveParameter BOOL Output diDriveParameterNumber DINT usiDataLength USINT
AWS IoT Core Client SL Library Documentation ¶ Company : CODESYS Title : AWS IoT Core Client SL Version : 1.9.0.0 Categories : Application|Utils Namespace : AWS_IOT Author : CODESYS Development GmbH Placeholder : AWS_IoT_Core_Client_SL Description [ 1 ] ¶ Client to publish and subscribe messages on AWS IoT Core. Contents: ¶ AWS Iot Core Client Enums Function Blocks Visualization Indices and tables ¶ [ 1 ] Based on AWS IoT Core Client SL.library, last modified 11.09.2023, 10:35:36. LibDoc 4.4.0.0-b.37 The content file AWS IoT Core Client SL.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 11.09.2023, 10:35:45.
ExampleAirConditioning2 (FB) ¶ FUNCTION_BLOCK ExampleAirConditioning2 Example air conditioning 2 This example function block evolves from ExampleAirConditioning1 and implements a bit more complex air conditioning plant to demonstrate how to: implement a plant / an aggregate in CFC using CODESYS Building Automation library function blocks use SequenceControl and SequenceSwitch do anti-freeze control / anti-freeze shutoff for heater coil compute the xError / eErrorID from xError / eErrorID of function block instances used This example involves following real world application aspects: recirculation air admixing minimum outdoor air ratio sequence control of recirculation air damper / heater coil / cooler coil energy selection (outdoor air vs. extract air) for recirculation air damper energy level air side anti-freeze / water side anti-freeze for heater coil exhaust air damper / outdoor air damper control extract air fan / supply air fan control Watch out for comments in the implementation where those aspects are covered. outdoor air temperatur sensor outdoor air damper recirculation air damper heater coil (water operated) frost monitor heater coil return temperatur sensor cooler coil (water operated) supply air fan extract air fan extract air temperatur sensor exhaust air damper Air types ¶ Air types - terms, abbreviations and colors oriented towards DIN EN 16798-3. Sequence control damper / heater coil / cooler coil ¶ SequenceControl is used to control three sequences - heater coil, RCA damper and cooler coil. RCA damper - 0% (maximum outdoor air) .. 100% (would be: no outdoor air) This is about to utilize mixed air or outdoor air energy as much as possible to heat / cool. In case you want to trade comfort (in this case control deviation and it’s duration) a bit higher to energy consumption, you might want to set mc_rDamperCoilOverlap to a value < 0.0, making the RCA damper sequence and the coil sequences overlap thus forcing the coils to jump in before maximum RCA ratio is reached. Set mc_rDamperCoilOverlap to -1.0 (K) will make the coil open 25% (because rXP = 4.0) if recirculation air damper reached maximum. Recirculation air admixing and energy selection ¶ RCA admixing is done using the RCA damper as primary control sequence thus minimizing heat / cool energy consumption. Please see m_energySelection for the energy selection aspect. Minimum outdoor air ratio ¶ Minimum ODA ratio is achieved by rMax2 := 100% - rMinOdaRatio Remember: RCA damper is controlled by sequence 2. rOut2 = 0% means maximum ODA ratio (100% in this case). Water side anti-freeze for heater coil ¶ Water side anti-freeze for heater coil is done with two separate sub-functionalities a controlled startup procedure continuous anti-freeze during control The startup procedure is done using HVAC_AntiFreezeControlStartup if ODA temperature < startup threshold: preload (the heater coil): ODA / ETA damper closed RCA damper open (maximum recirculation air ratio - 100%) forcing the heater coil to open check heater coil return temperature to reach a threshold after preload - wait for system to become settled (HVAC_AntiFreezeControlStartup.tFollowUp): open ODA / ETA damper to minimum ODA ratio set RCA damper accordingly to minimum ODA ratio take over to normal control actions SequenceControl.xForceEnable and .rForcedValue is used to force the heater coil sequence, thus providing smooth control takeover after sucessfull startup. The continuous anti-freeze during control is done using a CommandVariable setting the heater coil sequence minimum. Air side anti-freeze ¶ Air side anti-freeze is done using a frost monitor HVAC_AntiFreezeControlMonitor . The frost monitor simply does shut-off the whole plant, but keeping the heater coil opened to maximum. Hints ¶ Unused pins of function block instances are hidden, so refer to the function block documentation for more details. Caveats ¶ To keep complexity as low as possible this example omits the following real world application aspects worth mentioning: configuration missing (configuration of m_energyLevelSetpoint, m_sequenceControl, m_antiFreezeControlStartup and m_antiFreezeCont is not exposed on the ExampleAirConditioning1 VAR_INPUT section) ignoring the subtle differences between indoor air control vs. extract air control (assuming extract air temp. = indoor air temp.) no indoor air / supply air cascade control (control quality) no supply air minimum enforced (physiological problems caused by low supply air temperature) ramping up/down the ODA / EHA damper after anti-freeze control preload is done (our impl. does simply switch to rMinOdaRatio or 100%) cooling is not blocked if continuous anti-freeze during control is opening heater coil InOut: Scope Name Type Initial Comment Input xEnable BOOL TRUE Enable eLevel EnergyLevel EnergyLevel.COMFORT Energy level rEtaTemp REAL 22.0 Extract air temperature rSetptHeatComfort REAL 21.0 Heat setpoint comfort level rSetptCoolComfort REAL 23.0 Cool setpoint comfort level rOdaTemp REAL 10.0 Outdoor air temperature rMinOdaRatio REAL 20.0 Minimum outdoor air ratio, 0..100% rHeaterCoilReturnTemp REAL 20.0 Heater coil return temperature xFrost BOOL FALSE Heater coil frost indication xReset BOOL FALSE Reset to proportional control / reset detected input error itfDateTimeProvider Util.IDateTimeProvider Globals.g_dtpDateTimeProvider Source for the current date and time information in milliseconds since 1.1.1970 00:00:00.000 Output eModeOut HeatCoolOperationMode HeatCoolOperationMode.INACTIVE Operation mode. rHeatOut REAL Heat valve signal (0..100%). rCoolOut REAL Cool valve signal (0..100%). rOdaDamperOut REAL Outdoor air damper signal (0..100%). rRcaDamperOut REAL Recirculation air damper signal (0..100%). rEhaDamperOut REAL Exhaust air damper signal (0..100%). xFan BOOL Extract air / supply air fan xAntiFreezeStartup BOOL Anti-freeze control startup indication xAntiFreezeStartupError BOOL Anti-freeze control startup error indication xFrostAlarm BOOL Frost alarm indication xError BOOL Error indication eErrorID Error Error ID
AWS Iot Core Client ¶ Enums QOS (Enum) Function Blocks AWSIoTClient (FunctionBlock) AWSIoTGetDeviceShadow (FunctionBlock) AWSIoTPublish (FunctionBlock) AWSIoTSubscribe (FunctionBlock) AWSIoTSubscribeDeviceShadow (FunctionBlock) AWSIoTUpdateDeviceShadow (FunctionBlock) Visualization ETrigToTemplate (FunctionBlock) GlobalTextList (GlobalTextList) TextListForCombobox_MQTT_QOS (TextList) TextListForCombobox_QOS (TextList)
ExampleHeating (FB) ¶ FUNCTION_BLOCK ExampleHeating Example heating circuit This example function block implements a simple outside temperature dependent water heating circuit to demonstrate how to: implement a plant / an aggregate in CFC using CODESYS Building Automation library function blocks SequenceControl can be used for one sequence as well use DailyMeanTemperature to enable / disable heating circuit in “atomatic”-mode use HeatingCharacteristicCurve to compute supply temperature setpoint This example involves: heating circuit operation enabled / disabled in “auto”-mode using DailyMeanTemperature or outdoor temperature computation of supply temperature setpoint using HeatingCharacteristicCurve night time setpoint reduction vs. switching off heating circuit operation economy mode - switching off circulation pump and mixing valve if supply temperature to low to provide sufficient energy optional anti-freeze Watch out for comments in the implementation where those aspects are covered. outdoor air temperature sensor indoor air temperature sensor supply temperature sensor circulation pump mixing valve Heating circuit operation ¶ Heating circuit operation could be enabled / disabled manually setting eOnOff accordingly. Heating circuit operation could be determined automatically setting eOnOff to Auto. In “auto”-mode the operation is enabled if either the daily mean temperature or the outdoor temperature (xUseOdaTemp = TRUE) is below rTempLimitEnable. Night time setpoint reduction vs. switching off heating circuit operation ¶ ExampleHeating allows to use either a reduced supply temperature setpoint (rSupplyTempSetpt) at night, or to switch off operation at all. Economy mode ¶ Economy mode is switching off circulation pump and mixing valve if rSupplyTempSetpt is to low to provide sufficient energy. It differentiates low / high temperature heating systems by HeatingCharacteristicCurve gradient. Gradient < 1.0 assumes a low temperature heating system (for example floor heating). Gradient <= 1.0 - low temperature heating system: rSupplyTempSetpt < rIdaTempSetpt => switch off rSupplyTempSetpt > rIdaTempSetpt + 2.0K => switch on Gradient > 1.0 - high temperature heating system: rSupplyTempSetpt < rIdaTempSetpt + 5.0K => switch off rSupplyTempSetpt > rIdaTempSetpt + 7.0K => switch on Optional anti-freeze ¶ If anti-freeze is activated, there are three separate measures activated: low outdoor temperature (rOdaTemp < rAntiFreezeOdaTempLimit) cause the circulation pump to be enabled low supply temperature (rSupplyTemp < rAntiFreezeSupplyTempLimit) cause the heating circuit operation to be enabled anyway low indoor air temperature (rIdaTemp < rAntiFreezeIdaTempLimit) cause the heating circuit operation to be enabled anyway Caveats ¶ To keep complexity as low as possible this example omits - amongst others - the following real world application aspects worth mentioning: configuration missing (configuration of m_heatingCharacteristicCurve, m_circulationPump, m_sequenceControl, m_mixingValve, etc. is not or not completely exposed on the ExampleHeating VAR_INPUT section) sensors missing (circulation pump service / error indication, …) input consistency checks (implausible measurement values, …) day / night operation does often fullfill more complex needs scheduling (for example via BACnet scheduler) might set setpoint instead of day / night ramping up/down the setpoint instead of switching over between day / night setpoint xError / eErrorID not computed at all, see ExampleAirConditioning2 how to do this sensor / actuator process I/O not mapped (FB sensor inputs, m_circulationPump, m_mixingValve) InOut: Scope Name Type Initial Comment Input eOnOff AutoOnOff AutoOnOff.Auto Operation mode preset rSupplyTemp REAL Supply temperature rOdaTemp REAL Outdoor temperature rIdaTemp REAL 21.0 Indoor air temperature rIdaTempSetpt REAL 21.0 Indoor air temperature setpoint rTempLimitAutoEnable REAL 16.0 Temperature limit to enable operation in “auto”-mode xUseOdaTemp BOOL FALSE Decides whether to use daily mean temperature or outdoor temperature to enable operation in “auto”-mode. xUseOdaTemp := FALSE => use daily mean temperature. xUseOdaTemp := TRUE => use outdoor temperature. xDayNight BOOL TRUE Decides whether to use day / night operation rGradient REAL 1.2 HeatingCharacteristicCurve gradient. rShift REAL 0.0 HeatingCharacteristicCurve parallel shift rMinimumSupplyTemp REAL 20.0 Supply temperature minimum rMaximumSupplyTemp REAL 80.0 Supply temperature maximum xNightSetptReductionEnable BOOL TRUE Decides whether to use night time setpoint reduction vs. switching off heating circuit operation rNightSetptReduction REAL -12.0 Night time setpoint reduction xEconomyEnable BOOL TRUE Enables economy mode xAntiFreezeEnable BOOL TRUE Enables anti-freeze rAntiFreezeOdaTempLimit REAL 4.0 Anti-freeze outdoor temperature limit rAntiFreezeSupplyTempLimit REAL 10 Anti-freeze supply temperature limit rAntiFreezeIdaTempLimit REAL 14.0 Anti-freeze indoor air temperature limit xReset BOOL FALSE Reset itfDateTimeProvider Util.IDateTimeProvider Globals.g_dtpDateTimeProvider Source for the current date and time information in milliseconds since 1.1.1970 00:00:00.000 Output xOn BOOL Heating circuit is activated / enabled xHeat BOOL Heating circuit in operation rSupplyTempSetpt REAL Supply temperature setpoint xEconomy BOOL Economy mode active xFrostAlarm BOOL Frost alarm indication xCircPump BOOL Circulation pump running rValve REAL Mixing valve
QOS (ENUM) ¶ TYPE QOS : Quality of Service levels (QoS) Attributes: qualified_only InOut: Name Initial Comment QoS0 0 Send Message 1x, if disconnect from server then send can fail. QoS1 1 Send Message Nx, until Receive is acknowledged.