IFDBConfig.AddMACFDB (METH) ¶ METHOD AddMACFDB : UDINT InOut: Scope Name Type Comment Return AddMACFDB UDINT Input destination UINT 0: local, 1: port 1, 2; port 2 mac ARRAY [0..5] OF BYTE MAC address priority USINT Priority according to IEEE 802.1Q (0..7)

IFDBConfig.ClearFDB (METH) ¶ METHOD ClearFDB : UDINT InOut: Scope Name Type Comment Return ClearFDB UDINT Input uiTime UINT time in ms

IFDBConfig.ClearLocalFDB (METH) ¶ METHOD ClearLocalFDB : UDINT InOut: Scope Name Type Return ClearLocalFDB UDINT

IFDBConfig.EgressFilter (METH) ¶ METHOD EgressFilter : UDINT set/clear MAC egress filter on specified port InOut: Scope Name Type Comment Return EgressFilter UDINT Input port USINT port number (1..n) block BOOL TRUE: Block an outgoing frame (egress filter) with the provided MAC mac ARRAY [0..5] OF BYTE MAC address

IFDBConfig.InitFDB (METH) ¶ METHOD InitFDB : UDINT InOut: Scope Name Type Comment Return InitFDB UDINT Input mac ARRAY [0..5] OF BYTE interface MAC address usiPort1 USINT Number of first port for MRP usiPort2 USINT Number of second port for MRP

Aggregate variants ¶ Aggregates in the building automation field tend to have variants - most likely variants of certain actuator types. An aggregate providing a valve “variant aspect” (continuous valve vs. thermal actuator valve) can be considered as a simple example. The CODESYS Building Automation library supports building aggregates with variants with the concept “external composition” described hereafter. Generalized functionality is abstracted by interfaces (example: IActuatorContinuous ). Specific function blocks implement those interfaces (example: ValveContinuous and ValveThermo implementing IValveContinuous ). Aggregate function blocks supporting variants provide one (interface type) input per “variant aspect” (example: |RoomControlFCUSimple| ). The user of such an aggregate function blocks (which supports variants) connects a specific function block instance to the “variant aspect” input of the aggregate function block instance. So the specific function block instance which implements the generalized functionality of the “variant aspect” in fact resides outside (or “external”) of the aggregate function block itself Other options to implement variants (not used in the CODESYS Building Automation library) include the following: Implement all variants inside the aggregate function block and select by input configuration This approach leads to unwanted complexity and large amounts of unused code and resources. Using the CODESYS Application Composer This approach requires the application developer to implement complex Application Composer “modules”. CFC-specific considerations ¶ Function blocks which implement an interface (for example, ValveThermo implementing IValveContinuous ) provide an output itf* (example: itfValveContinuous). This is about to support usability of the function block in CFC. Example ¶ The CODESYS Building Automation library comes with extensive examples including a examples regarding aggregate variants. See the sample project BuildingLib_examples.project - function block and visualization Example_AggregateVariants_CFC and Example_AggregateVariants_ST - for a first example of how to deal with variants. You may want to look at ExampleFancoil3StageAggregate and ExampleRoomAutomation as well.

Building Automation Library Documentation ¶ Company CODESYS Group Title Building Automation Version 1.0.0.0 Categories Application|Utils Namespace Building Author CODESYS Group Placeholder BuildingAutomation Description 1 ¶ CODESYS Building Automation library - open source, free to use Building Automation library. CODESYS Building library - detailed information ¶ Contents: ¶ BuildingAutomation Doc Enums Function Blocks Functions GlobalTextList (GlobalTextList) TextListForCombobox_AutoOnOff (TextList) TextListForCombobox_EnergyLevel (TextList) TextListForCombobox_Error (TextList) TextListForCombobox_Fan3StageState (TextList) TextListForCombobox_HeatCoolOperationMode (TextList) TextListForCombobox_SequenceControlSequences (TextList) TextListForCombobox_ValveThermoWarmupState (TextList) TextListForCombobox_WEEKDAY (TextList) TextListForCombobox_WindowActuatorState (TextList) Indices and tables ¶ 1 Based on Building Automation.library, last modified 20.07.2022, 10:54:35. LibDoc 4.4.0.0-b.27 The content file Building Automation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.07.2022, 10:54:36.

Doc ¶ This folder contains documentation not related to DUTs / POU’s. Aggregate variants CFC-specific considerations Example Air types - Terms, abbreviations, and colors Compile options Levels of application development and functional aspects covered currently Levels of application development covered currently Functional aspects covered currently Examples Functional aspects in the building automation field Implementation Implementation language Implementation rules Introduction Legal Disclaimer License Terms Levels of building automation application development Other useful resources OSCAT http://www.oscat.de/ OSCAT BUILDING LIBRARY - computation of physics. The following are especially worth mentioning: OSCAT BUILDING LIBRARY - blind modules: Persistence as an option System requirements and restrictions Exceptions System schemes Visualization Non-real-time testing and simulation - how to use the “warp clock” What is the “warp clock”? How to use the “warp clock”?

System requirements and restrictions ¶ The CODESYS Building Automation library is intended to work on all platforms supported by CODESYS and all PLCs which have sufficient resources. CODESYS Development System V3.5.14.0 or higher CODESYS Control runtime system V3.5.14.0 or higher Exceptions ¶ The compile option BuildingLib_LogErrors is utilizing __POUNAME() which was introduced with CODESYS 3.5.16.0. When using a CODESYS Development System older than V3.5.16.0, this compile option cannot be used.

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:01:20 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpCharDevice2_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpCharDevice2_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True SourceLibrary False LastModificationDateTime date 02.03.2023, 11:01:18 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 3 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpCharDevice2_Itfs Title CmpCharDevice2 Interfaces Version version 3.5.19.0