GetTitle (FUN) ¶ FUNCTION GetTitle : WSTRING This function has been automatically generated from the project information. InOut: Scope Name Type Return GetTitle WSTRING
SequenceSwitch (FB) ¶ FUNCTION_BLOCK SequenceSwitch SequenceSwitch is suppose to be used to switch sequence configuration of SequenceControl depending on process information. It’s not a lot functionality, basically it’s a type safe multiplexer of type SequenceControlSequences . InOut: Scope Name Type Initial Comment Input eSequences1 SequenceControlSequences SequenceControlSequences.UNUSED Sequence configuration 1 eSequences2 SequenceControlSequences SequenceControlSequences.UNUSED Sequence configuration 2 xSequences1 BOOL TRUE Sequence configuration selection - TRUE -> sequence configuration 1, FALSE -> equence configuration 2 Output eSequences SequenceControlSequences
GetVersion (FUN) ¶ FUNCTION GetVersion : VERSION This function has been automatically generated from the project information. InOut: Scope Name Type Return GetVersion VERSION
GetVersionProperty (FUN) ¶ FUNCTION GetVersionProperty : VERSION This function has been automatically generated from the project information. InOut: Scope Name Type Return GetVersionProperty VERSION Input stKey WSTRING
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 13.12.2023, 09:24:38 companyName string 3S-Smart Software Solutions GmbH libraryFile SM3_Drive_ETC_SanyoDenki_RS2.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SM3_Drive_ETC_SanyoDenki_RS2.clean.json version version 2.0.0.0 ProjectInformation Released bool True ShowSmartCodingInfo True LastModificationDateTime date 13.12.2023, 09:24:30 LibraryCategories library-category-list Intern|SoftMotion Author string CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description Placeholder SM3_Drive_ETC_SanyoDenki_RS2 Project SM3_Drive_ETC_SanyoDenki_RS2 Title SM3_Drive_ETC_SanyoDenki_RS2 Version version 4.16.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. SM3_Basic ¶ Library Identification ¶ Placeholder: SM3_Basic Default Resolution: SM3_Basic, * (CODESYS) Namespace: SM3_Basic Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SM3_Basic SM3_Drive_CiA_DSP402 ¶ Library Identification ¶ Placeholder: SM3_Drive_CiA_DSP402 Default Resolution: SM3_Drive_CiA_DSP402, * (CODESYS) Namespace: SM3_Drive_CiA_DSP402 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SM3_Drive_CiA_DSP402 SM3_Drive_ETC ¶ Library Identification ¶ Placeholder: SM3_Drive_ETC Default Resolution: SM3_Drive_ETC, * (CODESYS) Namespace: SM3_Drive_ETC Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SM3_Drive_ETC SM3_Drive_ETC_DS402_CyclicSync ¶ Library Identification ¶ Placeholder: SM3_Drive_ETC_DS402_CyclicSync Default Resolution: SM3_Drive_ETC_DS402_CyclicSync, * (3S - Smart Software Solutions GmbH) Namespace: SM3_Drive_ETC_DS402_CyclicSync Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SM3_Drive_ETC_DS402_CyclicSync SM3_ETC_ITF ¶ Library Identification ¶ Placeholder: SM3_ETC_ITF Default Resolution: SM3_ETC_ITF, * (CODESYS) Namespace: SM3_ETC_ITF Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SM3_ETC_ITF Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard
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)
ExampleAirConditioning1 (FB) ¶ FUNCTION_BLOCK ExampleAirConditioning1 Example air conditioning 1 This example function block implements a very simple air conditioning plant to demonstrate how to: implement a plant / an aggregate in CFC using CODESYS Building Automation library function blocks use SequenceControl This example involves: sequence control of heater coil / cooler coil energy level 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 damper heater coil (water operated) 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 heater coil / cooler coil ¶ SequenceControl is used to control two sequences - heater coil and cooler coil. Hints ¶ Unused pins of function block instances are hidden, so refer to the function block documentation for more details. This example is evolved into ExampleAirConditioning2 . Caveats ¶ To keep complexity as low as possible this example omits the following real world application aspects worth mentioning: ignoring the subtle differences between indoor air control vs. extract air control (assuming extract air temp. = indoor air temp.) no anti-freeze mechanism for heater coil no indoor air / supply air cascade control (control quality) no supply air minimum enforced (physiological problems caused by low supply air temperature) configuration missing (configuration of m_energyLevelSetpoint, m_sequenceControl, m_hvacHeaterCoil and m_hvacCoolerCoil is not exposed on the ExampleAirConditioning1 VAR_INPUT section) input consistency checks (implausible measurement values, …) xError / eErrorID not computed from xError / eErrorID of all function block instances used, see ExampleAirConditioning2 how to do this 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 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%). rEhaDamperOut REAL Exhaust air damper signal (0..100%). xFan BOOL Extract air / supply air fan xError BOOL Error indication eErrorID Error Error ID
PumpOnOff (FB) ¶ FUNCTION_BLOCK PumpOnOff IMPLEMENTS IActuatorOnOff Pump on/off. Application example ¶ Pumps are widely used for certain tasks in building automation applications, most prominently: heating pumps circulating pumps Device examples ¶ Grundfos ALPHA2 https://product-selection.grundfos.com/de/products/alpha/alpha2?tab=models Wilo Stratos MAXO https://wilo.com/de/de/Katalog/de/produkte-expertise/wilo-stratos-maxo Wilo Stratos PICO plus https://wilo.com/de/de/Katalog/de/produkte-expertise/wilo-stratos-pico-plus/stratos-pico-plus-15-1-4 Functionality ¶ PumpOnOff controls a pump on/off covering the following aspects: on / off delay blocking protection command execution monitoring using pump service indication hardware error indication (input) malfunction detection malfunction locking operational time on / off delay ¶ Swichting on / off the pump (xOn) is delayed by given values tOnDelay, tOffDelay. Can be disabled by setting tOnDelay, tOffDelay to T#0S. blocking protection ¶ If pump is not running for a given time tBpMaxOff, run it even if reqest xReqOn = FALSE for a given time tBpTime. command execution monitoring ¶ Functionality of CommandExecutionMonitoring is applied to xSvciOn, xSvciOn_Used, tCemMargin. Can be diabled setting xSvciOn_Used := FALSE and/or tCemMargin := T#0S malfunction detection ¶ If a hardware malfunction is detected via command execution monitoring or hardware error indication (input) xError is set to TRUE, eErrorID is set to Error.HardwareError. malfunction locking ¶ Malfunction locking makes the difference how to handle / recover from a detected hardware malfunction. Malfunction locking enabled (xMalFuncLock := TRUE): If a malfunction is detected, the pump (xOn) is shut off. If the hardware malfunction is gone, xError / eErrorID and pump shutoff are kept until a reset (xReset := TRUE). Malfunction locking disabled (xMalFuncLock := FALSE): If a malfunction is detected, the pump (xOn) is NOT shut off. The pump recovers from a hardware malfunction automatically. InOut: Scope Name Type Initial Comment Input xReqOn BOOL FALSE Control signal - request to switch on pump tOnDelay TIME TIME#0ms On-delay tOffDelay TIME TIME#5m0s0ms Off-delay tBpMaxOff TIME TIME#2880m0s0ms Blocking protection maximum off time tBpTime TIME TIME#0ms Blocking protection time, set to T#0S to disable blocking protection xSvciOn BOOL FALSE Service indication - pump is running xSvciOn_Used BOOL FALSE Service indication xSvci is used / connected. tCemMargin TIME TIME#5s0ms Command execution monitoring margin time xErri BOOL FALSE Error indication - pump is signaling an error xMalFuncLock BOOL FALSE Enable the malfunction locking xOpTimeInit BOOL FALSE Initialize the operational time with a given value (tInit). tOpTimeInit LTIME LTIME#0ns Initialization value 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 Switch on pump tOpTime LTIME Operational time xError BOOL Error indication eErrorID Error Error ID itfActuatorOnOff IActuatorOnOff Output to connect THIS to other function block inputs Properties: DateTimeProvider ErrorIdOut ErrorOut IsOn RequestOn Reset Structure: DateTimeProvider (Property) ErrorIdOut (Property) ErrorOut (Property) IsOn (Property) RequestOn (Property) Reset (Property)
SM3_Drive_ETC_Copley Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title SM3_Drive_ETC_Copley Version 4.14.0.0 Categories Intern|SoftMotion Author None Placeholder SM3_Drive_ETC_Copley Description 1 ¶ SoftMotion EtherCAT driver for Copley drives Contents: ¶ Copley AXIS_REF_ETC_Copley (FunctionBlock) Projektinformationen GetBooleanProperty (Function) GetCompany (Function) GetNumberProperty (Function) GetTextProperty (Function) GetTextProperty2 (Function) GetTitle (Function) GetVersion (Function) GetVersionProperty (Function) Indices and tables ¶ 1 Based on SM3_Drive_ETC_Copley.library, last modified 10.03.2023, 13:23:56. LibDoc 4.4.0.0-b.27 The content file SM3_Drive_ETC_Copley.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 10.03.2023, 13:23:56.