IDevice.GetDeviceDiagnosisInfo (METH) ¶ METHOD GetDeviceDiagnosisInfo : ERROR Returns a DiagnosisInfo if xDiagnosisInfoAvailable of IDevice.GetDeviceState was true. Note The interpretation of pData is fieldbus dependent and will be specified by the associated fieldbus driver. InOut: Scope Name Type Comment Return GetDeviceDiagnosisInfo ERROR Input pData CAA.PVOID Pointer to memory szSize CAA.SIZE Size of memory in bytes where pData is pointing to Output szCount CAA.SIZE Number of Bytes written to pData
IDevice.GetDeviceErrorAsync (METH) ¶ METHOD GetDeviceErrorAsync : PROC_STATE Returns the device error of the current node. Note This is an asynchronous method. For easier handling use function block GetDeviceError . InOut: Scope Name Type Comment Return GetDeviceErrorAsync PROC_STATE Input eCmd PROC_CMD Inout eriDeviceError ERROR_INFO error information Output eError ERROR error code if method fails
IDevice.GetDeviceInfo (METH) ¶ METHOD GetDeviceInfo : ERROR Returns the device information of the current node InOut: Scope Name Type Comment Return GetDeviceInfo ERROR Inout deiInfo DEVICE_INFO device information
IDevice.GetDeviceState (METH) ¶ METHOD GetDeviceState : DEVICE_STATE Returns the state of the device; if device state is DEVICE_STATE.ERROR further information can be read by GetDeviceError . InOut: Scope Name Type Comment Return GetDeviceState DEVICE_STATE current device state Output xDiagnosisInfoAvailable BOOL if true, diagnosis info can be read by calling IDevice.GetDeviceDiagnosisInfo (if supported) eError ERROR
IDevice.SetCommunicationState (METH) ¶ METHOD SetCommunicationState : ERROR Starts, stops or resets a device Note Use IDevice2.CheckSupportedCommunicationState and IDevice2.CheckCurrentSupportedCommunicationState to check which transitions are possible! InOut: Scope Name Type Comment Return SetCommunicationState ERROR Input eRequestedState DEVICE_TRANSITION_STATE desired transition
IDevice2 (ITF) ¶ INTERFACE IDevice2 EXTENDS IDevice Interface extension for IDevice Properties: ChildNodeCount , inherited from INode Enable , inherited from INode FirstChildNode , inherited from INode IsRootNode , inherited from INode NextSiblingNode , inherited from INode ParentNode , inherited from INode SiblingNodeCount , inherited from INode Methods: CheckCurrentSupportedCommunicationState CheckSupportedCommunicationState GetDeviceDiagnosisInfo , inherited from IDevice GetDeviceErrorAsync , inherited from IDevice GetDeviceInfo , inherited from IDevice GetDeviceState , inherited from IDevice GetSpecificDeviceErrorAsync , inherited from IDevice GetSpecificDeviceState , inherited from IDevice SetCommunicationState , inherited from IDevice Structure: CheckCurrentSupportedCommunicationState (Method) CheckSupportedCommunicationState (Method)
IDevice2.CheckCurrentSupportedCommunicationState (METH) ¶ METHOD CheckCurrentSupportedCommunicationState : BOOL This method checks if a specific DEVICE_TRANSITION_STATE can be processed in the current state. Note Use IDevice2.CheckSupportedCommunicationState to check which DEVICE_TRANSITION_STATE is supported in general. InOut: Scope Name Type Comment Return CheckCurrentSupportedCommunicationState BOOL True if node supports the requested DEVICE_TRANSITION_STATE in the current state. Input eRequestedState DEVICE_TRANSITION_STATE The communication state to be checked.
IDevice2.CheckSupportedCommunicationState (METH) ¶ METHOD CheckSupportedCommunicationState : BOOL This method checks if a specific DEVICE_TRANSITION_STATE is supported by the node in general. Note Use IDevice2.CheckCurrentSupportedCommunicationState to check which DEVICE_TRANSITION_STATE is possible in the current state. InOut: Scope Name Type Comment Return CheckSupportedCommunicationState BOOL True if node supports the requested DEVICE_TRANSITION_STATE in general. Input eRequestedState DEVICE_TRANSITION_STATE The communication state to be checked.
ILogger (ITF) ¶ INTERFACE ILogger Interface for a logger. Methods: DisableLogger EnableLogger GetLogEntry Structure: DisableLogger (Method) EnableLogger (Method) GetLogEntry (Method)
ILogger.DisableLogger (METH) ¶ METHOD DisableLogger : ERROR Disables logging. InOut: Scope Name Type Return DisableLogger ERROR
