Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4MATLAB)  1.26.2
SystemBlocks
Collaboration diagram for SystemBlocks:
System Blocks

System Blocks

Description

The system block group contains functions used to provide access to common device settings of the target device.

The diagnosis logbook of the target device can also be accessed using blocks of this group.

More Information

For further information, refer to the mlpiCore documentation: SystemLib

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemCleanup

m4SSystemCleanup

m4SSystemCleanup

System Block: Clean up MLPI target.

Description

This block performs a reboot and total clean up of the target device with reset to factory settings. This is only allowed if the device is switched to initialization mode (MLPI_SYSTEMMODE_P0 using m4SSystemSetTargetMode) before. Please note that the device reboots immediately and that all project data is deleted during the next boot up.

Note that access rights to the MLPI target are reset as well. This means that several block will fail as they can not access the MLPI target with default access rights. For details refer to mlpi4MATLAB_fundamentals.

Block Inputs

connection defines the connection that will be used. The argument must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The argument must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemClearError

m4SSystemClearError

m4SSystemClearError

System Block: Reset controls current system errors.

Description

This block can be used to resets all system errors in the connected MLPI device.

Block Inputs

connection defines the connection that will be used. The input must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The input must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemGetCurrentMode

m4SSystemGetCurrentMode

m4SSystemGetCurrentMode

System Block: Get actual mode of operation.

Description

This block reads the actual mode of operation of the MLPI device.

Block Inputs

connection defines the connection that will be used. The argument must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The argument must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

mode contains the current operation mode. The output is the scalar current operation mode enumeration MlpiSystemMode casted to a scalar int32 value. The default value is 0.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemGetDateAndTimeUtc

m4SSystemGetDateAndTimeUtc

m4SSystemGetDateAndTimeUtc

System Block: Read UTC date and time.

Description

This block reads the system date and time (broken down time, UTC) of the device.

Block Inputs

connection defines the connection that will be used. The argument must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The argument must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

The following outputs are all scalar int16 values.

year contains the year.

month contains the month.

day contains the day.

hour contains the hour.

minute contains the minute.

second contains the second.

milliSecond contains the millisecond.

microSecond contains the microsecond.

dayOfWeek contains the day of the week. The week starts with Monday = 1.

dayOfYear contains the day of the year. The year starts with January 1st = 1 and ends with December 31 = 365 (no leap year) or December 31 = 366 () leap year.

The default values of the output ports is 0.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemGetDisplayedDiagnosis

m4SSystemGetDisplayedDiagnosis

m4SSystemGetDisplayedDiagnosis

System Block: Read displayed diagnosis from target.

Description

This block reads the displayed diagnostic message of the device. The displayed diagnosis is the diagnosis with the highest severity of all currently active diagnoses. This means, that the displayed diagnosis message can differ from the newest or last issued diagnosic message.

Block Inputs

connection defines the connection that will be used. The argument must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The argument must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

number contains the diagnosis number. The output is a scalar uint32 value.

state containe the state of the diagnosis message. The MlpiDiagnosisState enumeration will be casted to int32. The output is a scalar int32 value.

logicalAddress contains the logical address of the device that dispatched the diagnosis. The output is a scalar int32 value.

physicalAddress contains the physical address of the device that dispatched the diagnosis. The output is a scalar int32 value.

despatcher contains the source of the diagnosis. The MlpiDiagnosisDespatcher enumeration will be casted to int32. The output is a scalar int32 value.

index contains the index of the diagnosis inside the diagnosis ring buffer. The output is a scalar uint32 value.

The default values of output ports is 0.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemGetTemperatureMax

m4SSystemGetTemperatureMax

m4SSystemGetTemperatureMax

System Block: Get the maximum system temperature of the connected MLPI device.

Description

This block returns the maximum system temperature of the connected MLPI device.

Block Inputs

connection defines the connection that will be used. The input must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The input must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

temperature contains the maximum system temperature. The unit of the numeric value depends on the scaling of parameter C-0-0071. To set the scaling refer to parameter C-0-0063. The output is a scalar single value. The default value is 0.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemGetTemperature

m4SSystemGetTemperature

m4SSystemGetTemperature

System Block: Get the system temperature of the connected MLPI device.

Description

This block returns the actual system temperature of the connected MLPI device.

Block Inputs

connection defines the connection that will be used. The input must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The input must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

temperature contains the system temperature. The unit of the numeric value depends on the scaling of parameter C-0-0070. To set the scaling refer to parameter C-0-0063. The output is a scalar single value. The default value is 0.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemReboot

m4SSystemReboot

m4SSystemReboot

System Block: Reboot MLPI target.

Description

This function performs a reboot of the complete device. This is only allowed if the device is switched to initialization mode (MLPI_SYSTEMMODE_P0 using m4SSystemSetTargetMode) before.

Block Inputs

connection defines the connection that will be used. The input must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The input must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemSetDateAndTimeUtc

m4SSystemSetDateAndTimeUtc

m4SSystemSetDateAndTimeUtc

System Block: Write UTC date and time to MLPI target.

Description

This block sets the system date and time (broken down time, UTC) of the device.

Block Inputs

connection defines the connection that will be used. The argument must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The argument must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

The following inputs must all be scalar int16 values.

year defines the year.

month defines the month.

day defines the day.

hour defines the hour.

minute defines the minute.

second defines the second.

milliSecond defines the millisecond.

microSecond defines the microsecond.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Parameters and Dialog Box

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemSetDiagnosis

m4SSystemSetDiagnosis

m4SSystemSetDiagnosis

System Block: Clean up MLPI target.

Description

This block writes a diagnosis with message to the diagnosis system of the device. The diagnostic group is set to 0x3F automatically.

Block Inputs

connection defines the connection that will be used. The argument must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The argument must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Parameters and Dialog Box

Category specifies the category of the diagnosis message. The categories are defined in MlpiDiagnosisCategory.

Number specifies the diagnosis number. The parameter must be a scalar uint16 value.

Text specifies the diagnosis message text. The parameter must be a 1xL char array.

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0

m4SSystemSetTargetMode

m4SSystemSetTargetMode

m4SSystemSetTargetMode

System Block: Set target operation mode.

Description

This block commands the MLPI target to switch to the defined operation mode (MlpiSystemMode). The block starts the switching process but does not check if the target operation mode has been reached as the switching process usually takes several seconds. Use the block m4SSystemGetCurrentMode to check in each iteration if the MLPI is still in the process of switching or if the defined target mode has been reached.

Block Inputs

connection defines the connection that will be used. The input must be a scalar uint32 value provided by m4SApiConnect.

result defines if the block will be executed. The input must be a scalar int32 value. The block will not be executed if this value is negative. For negative values the input result is directly fed through to the output result.

bExecute defines if the block will be executed. The input must be a scalar boolean value. The input is a trigger input. This means that the block will be executed for one time if a rising edge is applied at this input.

Block Outputs

connection contains the connection identifier. The input port connection is fed through to this output. The default value of this port is 0.

result contains the return value of the block. The output is a scalar int32 value. If the output is negative other outputs are invalid. The default value of this output is 0. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.

Parameters and Dialog Box

TargetMode specifies the targeted operation mode. The parameter must be a MlpiSystemMode enumeration.

Sample time (-1 for inherited) specifies the time interval between samples. To inherit the sample time, set this parameter to -1. This block supports discrete sample time, but not continuous sample time.

Characteristics

Direct Feedthrough

Yes

Sample Time

Fixed Step

Example Model

Here you will find instructions to use the examples.

The following example is available in the folder ./mlpi/mlpi4Simulink/blocks:

See also

Copyright

Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0