GetSupplierVersion (FUN) ¶ FUNCTION GetSupplierVersion : WORD InOut: Scope Name Type Return GetSupplierVersion WORD Input xDummy BOOL
VersionConstants (GVL) ¶ InOut: Scope Name Type Initial Constant gc_byVersion BYTE 1 gc_byVersion_1 BYTE 0
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 03.07.2017, 15:37:42 companyName string 3S-Smart Software Solutions GmbH libraryFile CAA_BehaviourModel.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP11 contentFile CAA_BehaviourModel.clean.json version version 2.0.0.0 ProjectInformation Depends on PS bool False Depends on RTS False Released True LastModificationDateTime date 03.07.2017, 15:37:40 LibraryCategories library-category-list Intern|CAA|Foundation Author string 3S - Smart Software Solutions GmbH Company CAA Technical Workgroup DefaultNamespace CBM Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder CAA Behaviour Model Project CAA_BehaviourModel Title CAA Behaviour Model SpecVersion version 3.0.0.0 Version 3.5.11.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CAA Tick Extern ¶ Library Identification ¶ Placeholder: CAA Tick Default Resolution: CAA Tick Extern, * (CAA Technical Workgroup) Namespace: TICKS Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Tick CAA TickUtil Extern ¶ Library Identification ¶ Placeholder: CAA TickUtil Default Resolution: CAA TickUtil Extern, * (CAA Technical Workgroup) Namespace: TICKU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA TickUtil CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types
CAA Callback Extern Library Documentation ¶ Company CAA Technical Workgroup Title CAA Callback Extern Version 3.5.11.0 Categories Intern|CAA|Runtime Namespace CB Author 3S - Smart Software Solutions GmbH Placeholder CAA Callback Description 1 ¶ In the runtime system different events occur. Each event can be assigned to an event class. Further on each event arises from a certain source. The runtime system has an internal list of registered callback definitions. At each occurring event the runtime system checks its list of callback definitions and if applicable calls a callback function. A callback definition consists of: Event Event class Event source Index of the function which should be called as soon as the event occurs. Event e of class c from source s triggers the callback (e, c, s), if ( e = e OR e = CB.ALL_EVENTS ) AND (( c AND c ) > 0 OR c = CB.ALL_CLASSES ) AND ( s = s OR s = CB.ALL_SOURCES ) A function which should be used as callback function, must have the following interface: FUNCTION Callback < Name > : BOOL VAR_INPUT dwSpec : DWORD ; (* CB.Event and CB.EventClass *) dwParam : DWORD ; (* Application specific Parameter *) dwSource : DWORD ; (* CB.EventSource *) END_VAR The data types are DWORDs in order to be compatible to CODESYS V2.3. These however refer to the enumerations specified in brackets. Parameter dwSpec via function CB.DecodeEvent and CB.DecodeClass can be split in two variables of type CB.Event and CB.EventClass. The parameter dwSource can be converted to data type CB.EventSource with the help of the DWORD_TO_INT conversion. Note CODESYS V3.x: As from CODESYS 3.x the POUs are not addressed any longer by an index. Due to this fact the structure and the interpretation of the CB_Callback data type must be adapted correspondingly. The interface of function CallFunctionByIndex also changes. Note On the structure and usage of the callback functions: The function name must have a prefix „Callback”. The function must not contain any local variables. The function must not be checked with breakpoints. Note CODESYS V3.x: The function muss be parameterized with property Enable system call ! Multiple callbacks may be assigned to one event. A callback (event, -class, -source, function index) however can get registered only once; if one tries to assign an identical callback, CB_RegisterCallback will dump an error. After a reset of the PLC all registered callbacks will be deregistered immediately. Callbacks, which are possible registered on event CB_AFTER_RESET, will be called once more before the automatic deregistration. Regard that callback functions can be called immediately after the event has occurred. Thereby an currently running IEC task can be interrupted. The programmer must be aware that this might raise similar problems like there are in multitasking systems (data consistency etc.); besides that the run time of a callback function should be kept as short as possible, because it blocks the whole system. The return value of the callback function is of no significance . Contents: ¶ CAA Callback Enums Functions Globale Constants Structs Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) Indices and tables ¶ 1 Based on CAA_Callback_Extern.library, last modified 03.07.2017, 15:37:46. LibDoc 4.4.0.0-b.27 The content file CAA_Callback_Extern.clean.json was generated with CODESYS V3.5 SP11 on 03.07.2017, 15:37:49.
Enums ¶ ERROR (Enum) EVENT (Enum) EVENT_CLASS (Enum) EVENT_SOURCE (Enum)
CAA Callback ¶ Enums ERROR (Enum) EVENT (Enum) EVENT_CLASS (Enum) EVENT_SOURCE (Enum) Functions Callback Info GetCallback (Function) GetHandleOfCallback (Function) GetNumberActiveCallbacks (Function) IsHandleValid (Function) Helper DecodeClass (Function) DecodeEvent (Function) EncodeSpec (Function) Indirect Functioncall CallFunctionByIndex (Function) PostEvent (Function) RegisterCallback (Function) SendEvent (Function) UnregisterCallback (Function) Globale Constants GlobalConstants (GVL) Structs CB_CALLBACK (Struct)
ERROR (ENUM) ¶ TYPE ERROR : This data structure describes errors which might occur when using functions of the CAA_Callback library. Error range 20000 – 20099 is reserved for this library in the prefix registration for libraries. Attributes: qualified_only InOut: Name Initial Comment NO_ERROR 0 No error FIRST_ERROR 20000 Start of standard error area HANDLE_INVALID 20001 Handle is invalid. Callback may be already unregistered UNKNOWN_EVENT 20002 Event not known CALLBACK_NOT_REMOVABLE 20003 Callback can’t be removed WRONG_ARGUMENT 20004 Argument is a null pointer CB_NO_MEMORY 20005 Not enough memory CB_EVENT_EXISTS 20006 The event already exists CB_CALL_CALLBACKS_FAILED 20007 The event already exists CB_NO_SYSTEM_EVENT 20008 The specified event is not an system event CB_BUFFER_NOT_AVAILABLE 20009 No buffer available CB_SYSTEM_EVENT 20010 The event, which should be sent or posted, is a system event FIRST_MF 20050 manufacturer specific LAST_ERROR 20099 End of the standard error area
EVENT (ENUM) ¶ TYPE EVENT : THIS enumeration describes all standardized events. An “X” in the table shown below indicates that each CAA PLC supports the respective event. The source OF those events is CB_RUNTIME. PLC-specific events can be used in the following number areas: 900-999, 1900-1999, 2900-2999, 3900-3999, 4900-4999, 5900-5999, 6900-6999, 7000-7999, ab 10000 The value of each event at the same results in a classification: 1000-1999 CB_ONLINE_EVENTS 2000-2999 CB_INFOS 3000-3999 CB_WARNINGS 4000-4999 CB_RTS_ERRORS 5000-5999 CB_SYSTEM_EXCEPTIONS 6000-6999 CB_INTERRUPTS 7000-7499 CB_IO 8000-9899 CB_FIELDBUS 9900-9999 CB_TIMERS 10000- CB_MANUF_SPEC Attributes: qualified_only InOut: Name Initial Comment ALL_EVENTS -1 NO_EVENT 0 START 1000 start command for PLC STOP stop command for PLC BEFORE_RESET before reset is executed AFTER_RESET after reset is executed ONLINE_CHANGE Is called after CodeInit() at Online-Change BEFORE_DOWNLOAD Is called at the beginning of a program download
EVENT_CLASS (ENUM) ¶ TYPE EVENT_CLASS : This enumeration describes the event classes. Attributes: qualified_only InOut: Name Initial Comment ALL_CLASSES -1 all classes NO_CLASS 16#0 no classes ONLINE_EVENTS 16#1 general online events INFOS 16#2 infos WARNINGS 16#4 warnings RTS_ERRORS 16#8 errors from runtime SYSTEM_EXCEPTIONS 16#10 system exceptions INTERRUPTS 16#20 interrupts IO 16#40 I/O actions FIELDBUS 16#80 Fieldbus actions TIMERS 16#100 Timer ervents MANUF_SPEC 16#200 manufacturer specific
