SupervisorFlags (GVL) ¶ Supervisor flags Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant RTS_SUPERVISOR_FLAG_WATCHDOG UDINT 16#10000 This is a watchdog (consumer), that uses the supervisor to protect the controller!
SupervisorInstance (STRUCT) ¶ TYPE SupervisorInstance : STRUCT InOut: Name Type Comment hInstance RTS_IEC_HANDLE Handle to the instance idInstance UDINT Id of the instance xIsIECInstance BOOL TRUE=hInstance is an IEC instance, FALSE=hInstance is a runtime handle
SupervisorOperationAlive (FUN) ¶ FUNCTION SupervisorOperationAlive : RTS_IEC_RESULT Reassures the alive state of the operation with the given timestamp in order to retrigger the hardware watchdog InOut: Scope Name Type Comment Return SupervisorOperationAlive RTS_IEC_RESULT Error code Error code: ERR_OK: Alive state was successfully reassured ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: Supervision is disabled for the operation ERR_NOT_SUPPORTED”>SysTimeGetUs is not supported Input hOperation RTS_IEC_HANDLE Handle to the operation pstTimestampUs POINTER TO ULINT Pointer to timestamp. May be NULL, if time check is enabled timestamp is set to current time.
SupervisorOperationDead (FUN) ¶ FUNCTION SupervisorOperationDead : RTS_IEC_RESULT Signals a desperate situation of an operation in order to prevent the retriggering of the hardware watchdog. After this call, the operation is marked immediate as failed! InOut: Scope Name Type Comment Return SupervisorOperationDead RTS_IEC_RESULT Error code Error code: ERR_OK: Dead state was successfully signalled ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: Supervision is disabled for the operation Input hOperation RTS_IEC_HANDLE Handle to the operation
SupervisorOperationDisable (FUN) ¶ FUNCTION SupervisorOperationDisable : RTS_IEC_RESULT Disables supervision for this operation. This operation will never be supervised, until the next SupervisorOperationEnable() call! InOut: Scope Name Type Comment Return SupervisorOperationDisable RTS_IEC_RESULT Error code Error code: ERR_OK: Supervision was successfully disabled ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: The operation is already disabled Input hOperation RTS_IEC_HANDLE Handle to the operation
SupervisorOperationEnable (FUN) ¶ FUNCTION SupervisorOperationEnable : RTS_IEC_RESULT Enables supervision for this operation: Sets timestamp to current time and alive flag InOut: Scope Name Type Comment Return SupervisorOperationEnable RTS_IEC_RESULT Error code Error code: ERR_OK: Supervision was successfully enabled ERR_NOTINITIALIZED: The operation memory is not initialized ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid ERR_NO_CHANGE: The operation is already supervised ERR_NOT_SUPPORTED”>SysTimeGetUs is not supported Input hOperation RTS_IEC_HANDLE Handle to the operation
SupervisorOperationGetEntry (FUN) ¶ FUNCTION SupervisorOperationGetEntry : POINTER TO SupervisorEntry Returns the SupervisorEntry of a given operation handle Error code: ERR_OK: The SupervisorEntry was successfully retrieved ERR_INVALID_HANDLE: The handle to the operation is invalid ERR_PARAMETER: The handle to the operation is invalid InOut: Scope Name Type Comment Return SupervisorOperationGetEntry POINTER TO SupervisorEntry Pointer to SupervisorEntry of the given operation handle or NULL in case of an error Input hOperation RTS_IEC_HANDLE Handle to the operation pResult POINTER TO RTS_IEC_RESULT Pointer to error code
SupervisorOperationGetFirst (FUN) ¶ FUNCTION SupervisorOperationGetFirst : RTS_IEC_HANDLE Iteration interface to get the first registered operation Error code: ERR_OK: The first operation was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_NO_OBJECT: There are no registered operations InOut: Scope Name Type Comment Return SupervisorOperationGetFirst RTS_IEC_HANDLE Handle to the first operation or RTS_INVALID_HANDLE in case of an error Input pResult POINTER TO RTS_IEC_RESULT Pointer to error code
SupervisorOperationGetNext (FUN) ¶ FUNCTION SupervisorOperationGetNext : RTS_IEC_HANDLE Iteration interface to get the next registered operation. Must be started with SupervisorOperationGetFirst() Error code: ERR_OK: The next operation was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_END_OF_OBJECT: There are no registered operations left InOut: Scope Name Type Comment Return SupervisorOperationGetNext RTS_IEC_HANDLE Handle to the first operation or RTS_INVALID_HANDLE in case of an error Input hPrevOperation RTS_IEC_HANDLE Handle to the previous operation retrieved via SupervisorOperationGetFirst() or subsequent calls of SupervisorOperationGetNext() pResult POINTER TO RTS_IEC_RESULT Pointer to error code
SupervisorOperationGetState2 (FUN) ¶ FUNCTION SupervisorOperationGetState2 : RTS_IEC_RESULT Retrieves the supervisor state for all supervised operations! Here you can check with one call how many operations failed. InOut: Scope Name Type Comment Return SupervisorOperationGetState2 RTS_IEC_RESULT Error code Error code: ERR_OK: The SupervisorState was successfully retrieved ERR_NOTINITIALIZED: The operation memory is not initialized ERR_PARAMETER: The pointer to the SupervisorState is invalid ERR_NOT_SUPPORTED”>SysTimeGetUs is not supported Input pSupervisorState POINTER TO SupervisorState Pointer to the SupervisorState, will be filled with the corresponding information. The caller has to hold the buffer.