Collaboration diagram for WatchdogLib:

Watchdog Functions

Description

Using the watchdog function group you can establish a mechanism between your application and the firmware in order to react to exceptions or problems within your client program execution.

The following steps are necessary:

Setup the watchdog and specify the timeout in milliseconds as well as the action to be taken when the timeout is reached.
Start the watchdog.
Reset the watchdog on a cyclic time basis that is lower than the specified timeout. As soon as you do not reset the watchdog in time, it will execute the action as specified during the setup. E.g. stop the PLC or restart the device.

More Information

For more information, refer to mlpiCore documentation: WatchdogLib.

Copyright

m4MWatchdogGetState

Watchdog-Function: Get watchdog state.

Description

This function will return the current state of the watchdog.

The watchdog is individual for each connection. Use the same connection handle to access the same watchdog.

Syntax

[state]         = m4MWatchdogGetState(connection)
[state, result] = m4MWatchdogGetState(connection)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

Output Arguments

state contains the current state of the watchdog. Once the watchdog timout expired the state will be MLPI_WATCHDOG_TIMEOUT until the watchdog is started again. The argument is a scalar MlpiWatchdogState enumeration.

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. If the function call fails, other output arguments will be set to NaN. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MWatchdogGetState_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiWatchdogGetState

Copyright

m4MWatchdogReset

Watchdog-Function: Reset the watchdog.

Description

This function resets the watchdog. The reset has to be called in an interval which is shorter than the timeout that has been specified by m4MWatchdogSetup.

The watchdog is individual for each connection. Use the same connection handle to access the same watchdog.

Syntax

m4MWatchdogReset(connection)
result = m4MWatchdogReset(connection)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

Output Arguments

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. If the function call fails, other output arguments will be set to NaN. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MWatchdogReset_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiWatchdogReset

Copyright

m4MWatchdogSetup

Watchdog-Function: Configure watchdog.

Description

This function initializes or changes the watchdog functionality.

The watchdog is individual for each connection. Use the same connection handle to access the same watchdog.

Syntax

m4MWatchdogSetup(connection, timeout, action)
result = m4MWatchdogSetup(connection, timeout, action)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

timeout defines the timeout value of the watchdog in milliseconds. The timeout is checked every millisecond. The argument must be real numeric and scalar. Internally the value will be casted to uint32.

action defines the action that will be taken if the watchdog timeout expires. The argument must be a MlpiWatchdogAction enumeration and scalar.

Output Arguments

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. If the function call fails, other output arguments will be set to NaN. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MWatchdogSetup_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiWatchdogSetup

Copyright

m4MWatchdogStart

Watchdog-Function: Start the watchdog.

Description

This function starts the watchdog supervision.

The watchdog is individual for each connection. Use the same connection handle to access the same watchdog.

Syntax

m4MWatchdogStart(connection)
result = m4MWatchdogStart(connection)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

Output Arguments

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. If the function call fails, other output arguments will be set to NaN. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MWatchdogStart_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiWatchdogStart

Copyright

m4MWatchdogStop

Watchdog-Function: Stop the watchdog.

Description

This function stops the watchdog supervision.

The watchdog is individual for each connection. Use the same connection handle to access the same watchdog.

Syntax

m4MWatchdogStop(connection)
result = m4MWatchdogStop(connection)

Input Arguments

connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.

Output Arguments

result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. If the function call fails, other output arguments will be set to NaN. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Example Files

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:

m4MWatchdogStop_Sample.m

Reference to mlpiCore

This function maps to the mlpiCore function: mlpiWatchdogStop

Copyright

Watchdog Functions

Description

More Information

m4MWatchdogGetState

m4MWatchdogGetState

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore

m4MWatchdogReset

m4MWatchdogReset

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore

m4MWatchdogSetup

m4MWatchdogSetup

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore

m4MWatchdogStart

m4MWatchdogStart

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore

m4MWatchdogStop

m4MWatchdogStop

Description

Syntax

Input Arguments

Output Arguments

Example Files

See also

Reference to mlpiCore