CmpKBus Library Documentation ¶ Company : CODESYS Title : CmpKBus Version : 4.10.0.0 Categories : System|SysLibs Namespace : KBUS Author : CODESYS Development GmbH Placeholder : CmpKBus Description [ 1 ] ¶ lowlevel wago kbus access Contents: ¶ Libname Enums Functions GlobalConstants Structs Types Indices and tables ¶ [ 1 ] Based on CmpKBus.library, last modified 25.10.2023, 14:04:35. LibDoc 4.4.0.0-b.37 The content file CmpKBus.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 25.10.2023, 14:04:37.
Enums ¶ ERROR (Enum) tApplicationState (Enum) tBusState (Enum) tDiagnoseState (Enum)
Libname ¶ Enums ERROR (Enum) tApplicationState (Enum) tBusState (Enum) tDiagnoseState (Enum) Functions ApplicationStateChanged (Function) CallDeviceSpecificFunction (Function) CloseKbus (Function) ConfigureDevice (Function) ConfigureSubdevice (Function) DiagnoseGetDeviceState (Function) DiagnoseGetSubdeviceState (Function) GetDeviceFlags (Function) GetIoSizes (Function) GetLastError (Function) OpenKbus (Function) ReadBit (Function) ReadBool (Function) ReadBytes (Function) ReadEnd (Function) ReadStart (Function) RegisterEventHandler (Function) UnregisterEventHandler (Function) WatchdogSetTime (Function) WatchdogStart (Function) WatchdogStop (Function) WatchdogTrigger (Function) WriteBit (Function) WriteBool (Function) WriteBytes (Function) WriteEnd (Function) WriteStart (Function) kbus_information ldkc_KbusInfo_Create (Function) ldkc_KbusInfo_Destroy (Function) ldkc_KbusInfo_GetDigitalOffset (Function) ldkc_KbusInfo_GetDigitalOffsetInput (Function) ldkc_KbusInfo_GetDigitalOffsetOutput (Function) ldkc_KbusInfo_GetStatus (Function) ldkc_KbusInfo_GetTerminalCount (Function) ldkc_KbusInfo_GetTerminalDiagnose (Function) ldkc_KbusInfo_GetTerminalInfo (Function) ldkc_KbusInfo_GetTerminalList (Function) ldkc_KbusInfo_TerminalDiagnoseRelease (Function) GlobalConstants Constants (GVL) Structs ApplicationStateChangedEvent (Struct) tKbusInfo_Status (Struct) tKbusInfo_TerminalDiagnose (Struct) tKbusInfo_TerminalInfo (Struct) Types tEventHandler (Alias)
ERROR (ENUM) ¶ TYPE ERROR : {attribute ‘conditionalshow’ := ‘SomeText’} {attribute ‘conditionalshow’} {attribute ‘hide’} Attributes: qualified_only InOut: Name NO_ERROR FIRST_ERROR TIME_OUT FIRST_MF LAST_ERROR
tApplicationState (ENUM) ¶ TYPE tApplicationState : InOut: Name Initial ApplicationState_BASE 0 ApplicationState_Running ApplicationState_Stopped ApplicationState_Unconfigured ApplicationState_TOP
tBusState (ENUM) ¶ TYPE tBusState : InOut: Name Initial BusState_NotEnabled 0 BusState_BusOk 1 BusState_BusFault 2 BusState_BusNotCommunicating 3 BusState_BusStopped 4
tDiagnoseState (ENUM) ¶ TYPE tDiagnoseState : InOut: Name Initial DiagnoseState_InvalidInputParameter -1 DiagnoseState_NotEnabled 0 DiagnoseState_GetDiagInfo 1 DiagnoseState_DiagInfoAvailable 2 DiagnoseState_DiagInfoNotAvailable 3
Functions ¶ ApplicationStateChanged (Function) CallDeviceSpecificFunction (Function) CloseKbus (Function) ConfigureDevice (Function) ConfigureSubdevice (Function) DiagnoseGetDeviceState (Function) DiagnoseGetSubdeviceState (Function) GetDeviceFlags (Function) GetIoSizes (Function) GetLastError (Function) OpenKbus (Function) ReadBit (Function) ReadBool (Function) ReadBytes (Function) ReadEnd (Function) ReadStart (Function) RegisterEventHandler (Function) UnregisterEventHandler (Function) WatchdogSetTime (Function) WatchdogStart (Function) WatchdogStop (Function) WatchdogTrigger (Function) WriteBit (Function) WriteBool (Function) WriteBytes (Function) WriteEnd (Function) WriteStart (Function) kbus_information ldkc_KbusInfo_Create (Function) ldkc_KbusInfo_Destroy (Function) ldkc_KbusInfo_GetDigitalOffset (Function) ldkc_KbusInfo_GetDigitalOffsetInput (Function) ldkc_KbusInfo_GetDigitalOffsetOutput (Function) ldkc_KbusInfo_GetStatus (Function) ldkc_KbusInfo_GetTerminalCount (Function) ldkc_KbusInfo_GetTerminalDiagnose (Function) ldkc_KbusInfo_GetTerminalInfo (Function) ldkc_KbusInfo_GetTerminalList (Function) ldkc_KbusInfo_TerminalDiagnoseRelease (Function)
ApplicationStateChanged (FUN) ¶ FUNCTION ApplicationStateChanged : DINT Sets the state of the PLC application. Its up to the devices to react accordingly. @param state The state of the application. @return DAL_SUCCESS on success. DAL_FAILURE when at least one device returned an error. InOut: Scope Name Type Return ApplicationStateChanged DINT Input event ApplicationStateChangedEvent
CallDeviceSpecificFunction (FUN) ¶ FUNCTION CallDeviceSpecificFunction : DINT @brief Calls a device-specific function implemented by a device library. @param fnName Name of the function to invoke @param retVal Return value @param … Additional parameters @return DAL_SUCCESS if the function was invoked successfully DAL_FAILURE on error DAL_NOTUSED if the function was not found InOut: Scope Name Type Return CallDeviceSpecificFunction DINT Input fnName STRING retVal POINTER TO UDINT