|
The system function 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 functions of this group.
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
System-Function: Reset control to factory default.
This function performs a reboot and total clean up of the complete device. This is only allowed if the device is switched to initialization mode (MLPI_SYSTEMMODE_P0 using m4MSystemSetTargetMode) before. Please note that the device reboots immediately and that all project data is deleted during the next boot up.
m4MSystemCleanup(connection) result = m4MSystemCleanup(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemCleanup
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Reset controls current system errors.
This function can be used to resets all system errors in the connected MLPI device.
m4MSystemClearError(connection) result = m4MSystemClearError(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemClearError
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Convert diagnosis number to text.
This function tries to retrieve a textual description from the target for a given diagnosis number. Please note that this is not possible for every diagnosis number that is returned from the system. This includes user-specific diagnosis numbers or diagnosis numbers which represent a group of error conditions. In case no match was found, the char array No entry found in data base is returned.
This function does not support code generation.
[diagnosisText] = m4MSystemConvertDiagnosisNumberToText(... connection, diagnosisNumber) [diagnosisText, result] = m4MSystemConvertDiagnosisNumberToText(... connection, diagnosisNumber)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
diagnosisNumber defines the diagnosis number(s). The argument must be a real numeric number and can be a Mx1 or 1xM matrix. Internally the argument will be casted to uint32.
diagnosisText contains the textual diagnosis description. The argument is a Mx1 cell array. Each cell contains a 1xL char array with the text corresponding to the diagnosis number. In case a diagnosis number can not be converted to text, the char array No entry found in data base is returned for that number.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: m4MSystemConvertDiagnosisNumberToText
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the maximum target CPU load.
This function returns the maximum system CPU load of the connected MLPI device in percent.
[cpuLoadMax] = m4MSystemGetCpuLoadMax(connection) [cpuLoadMax, result] = m4MSystemGetCpuLoadMax(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
cpuLoadMax contains the maximum system CPU load in percent. The argument is a scalar value of type single.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetCpuLoadMax
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the target CPU load.
This function returns the current system CPU load of the connected MLPI device in percent.
[cpuLoad] = m4MSystemGetCpuLoad(connection) [cpuLoad, result] = m4MSystemGetCpuLoad(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
cpuLoad contains the current system CPU load in percent. The argument is a scalar value of type single.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetCpuLoad
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get actual mode of operation.
This function reads the actual mode of operation of the MLPI device.
[mode] = m4MSystemGetCurrentMode(connection) [mode, result] = m4MSystemGetCurrentMode(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
mode contains the current operation mode. The argument is a scalar MlpiSystemMode 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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetCurrentMode
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get time and date in UTC (Universal Time Coordinated) time standard.
This function reads the system date and time (broken down time, UTC) of the device.
[time] = m4MSystemGetDateAndTimeUtc(connection) [time, result] = m4MSystemGetDateAndTimeUtc(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
time contains the UTC time and date information of the device as scalar MlpiDateAndTime structure.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetDateAndTimeUtc
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get control diagnosis log.
This function reads the device diagnosis log. The function returns an array of diagnostic messages starting from newer to older diagnostic messages. Each diagnosis in the diagnosis logbook has a unique incrementing diagnosis index. You need to specify from which index you want to start reading the diagnosis logbook. To get the index of the newest and thus most recently inserted diagnosis you can use the function m4MSystemGetNewestDiagnosisIndex. As the device is limited in memory resources, it is not possible to hold all diagnostic messages in the logbook from the start of power up. Because of that, older diagnostic messages are first swapped to disk and then discarded. Use the function m4MSystemGetOldestDiagnosisIndex to get the oldest available diagnosis to read. Diagnostic messages which are not located between the oldest and newest diagnosis index can no longer be read by this function. This function will therefore return the number of diagnoses that have actually been read. This function will not return an error if the number of diagnoses you want to read is larger than the number of diagnoses that are available.
[diagLog] = m4MSystemGetDiagnosisLog(connection, numOfDiags) [diagLog, result] = m4MSystemGetDiagnosisLog(connection, numOfDiags)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
numOfDiags defines the number of diagnosis messages that shall be read. The argument must be a scalar positive numeric number. Internally the argument will be casted to uint32.
diagLog contains the diagnosis information. The argument is a Mx1 array of MlpiDiagnosis structures. The number M is equal or lower than numOfDiags depending on the number of diagnosis messages available from the logbook.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetDiagnosisLog
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get displayed control diagnosis message.
Within the control, all diagnostic messages are logged. This function can read the currently displayed diagnosis from the control.
[diag] = m4MSystemGetDisplayedDiagnosis(connection) [diag, result] = m4MSystemGetDisplayedDiagnosis(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
diag contains the diagnosis message. The argument is a scalar MlpiDiagnosis structure.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetDisplayedDiagnosis
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the function modul bus configuration of the connected MLPI device.
This function reads the function module bus configuration of the device. The output argument is a char array in semicolon separated format like "A001: SERCOS III (0x002B);A002: n/a (0x0000);A003: n/a (0x0000);A004: n/a (0x0000)". Each separated segment contains the address, the name and the identification code (hex format).
[configuration] = m4MSystemGetFunctionModulBusConfiguration(... connection) [configuration, result] = m4MSystemGetFunctionModulBusConfiguration(... connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
configuration contains function module bus configuration information. The argument is a 1xL char array.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetFunctionModuleBusConfiguration
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the function modul hardware details.
This function reads the hardware details of the function modules attached to the device.
[hardwareDetails] = m4MSystemGetFunctionModulHardwareDetails(... connection) [hardwareDetails, result] = m4MSystemGetFunctionModulHardwareDetails(... connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
hardwareDetails contains function module hardware configuration. The argument is a 1xL char array.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetFunctionModuleHardwareConfiguration
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the gateway of the connected MLPI device.
This function reads the gateway address of the IP settings of the connected MLPI device.
[gateway] = m4MSystemGetGateway(connection) [gateway, result] = m4MSystemGetGateway(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
gateway contains the gateway address. The argument is a 1xL char array in the format 'xxx.xxx.xxx.xxx'.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetGateway
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the hardware details of the connected MLPI device.
This function reads the hardware details information of the connected MLPI device.
[hardwareDetails] = m4MSystemGetHardwareDetails(connection) [hardwareDetails, result] = m4MSystemGetHardwareDetails(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
hardwareDetails contains the hardware detail information. The argument is a 1xL char array.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetHardwareDetails
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the IP-Address of the connected MLPI device.
This function reads the IP address of the connected MLPI device.
[ipAddress] = m4MSystemGetIpAddress(connection) [ipAddress, result] = m4MSystemGetIpAddress(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
ipAddress contains the internet protocol (IP) address of the connected device. The argument is a 1xL char array in the format 'xxx.xxx.xxx.xxx'.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetIpAddress
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get current language.
This function reads the current system language of the device.
[language] = m4MSystemGetLanguage(connection) [language, result] = m4MSystemGetLanguage(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
language contains the language descriptor. The argument is a scalar MlpiLanguage 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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetLanguage
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the local bus configuration of the connected MLPI device.
This function reads the local bus configuration of the device.
[configuration] = m4MSystemGetLocalBusConfiguration(connection) [configuration, result] = m4MSystemGetLocalBusConfiguration(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
configuration contains the local bus configuration information. The argument is a 1xL char array with a semicolon separated format like "A005: netX (0x0100);A006: Sercos III PCI-BusMaster (0x000E);A007: n/a (0x0000);A254: SRAM (0x0013)". Each separated segment contains the address, the name and a identification code (hex format).
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetLocalBusConfiguration
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the MAC address of the connected MLPI device.
This function reads the media-access-controller (MAC) address of the connected MLPI device.
[macAddress] = m4MSystemGetMacAddress(connection) [macAddress, result] = m4MSystemGetMacAddress(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
macAddress contains the MAC address. The argument is a 1xL char array in the format 'xx:xx:xx:xx:xx:xx'.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetMacAddress
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get memory information of the connected MLPI device.
This function retrieves some information about the currently free RAM on the device. The figures are given in bytes. The function can be used to trace the total memory consumption of the device.
[memoryInfo] = m4MSystemGetMemoryInfo(connection) [memoryInfo, result] = m4MSystemGetMemoryInfo(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
memoryInfo contains the information about the memory in the MLPI device. The argument is a scalar MlpiMemoryInfo structure.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetMemoryInfo
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the name of the connected MLPI device.
This function reads the name of the motion-controller.
[name] = m4MSystemGetName(connection) [name, result] = m4MSystemGetName(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
name contains the name of the connected MLPI device. The argument is a 1xL char array.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetName
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the newest diagnosis index.
This function reads the newest diagnosis index.
Each new diagnosis in the diagnosis logbook gets a unique incremented diagnosis index. This function returns the index of the newest and therefore most recently inserted diagnosis. This index can be used as a parameter using the function m4MSystemGetDiagnosisLog to read the complete logbook of the newest diagnostic messages.
[newestIndex] = m4MSystemGetNewestDiagnosisIndex(connection) [newestIndex, result] = m4MSystemGetNewestDiagnosisIndex(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
newestIndex contains the newest diagnosis index. The argument is a scalar uint32 value.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetNewestDiagnosisIndex
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the oldest diagnosis index.
This function reads the oldest diagnosis index.
As the device is limited in memory resources, it is not possible to hold all diagnostic messages in the logbook from the start of power up. Because of that, older diagnostic messages are first swapped to disk and then discard. Use this function to get the index of the oldest diagnostic message that is still in memory and can be returned by the function m4MSystemGetDiagnosisLog.
[oldestIndex] = m4MSystemGetOldestDiagnosisIndex(connection) [oldestIndex, result] = m4MSystemGetOldestDiagnosisIndex(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
oldestIndex contains the oldest diagnosis index. The argument is a scalar uint32 value.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetOldestDiagnosisIndex
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get operation hours of MLPI device.
This function reads the operating time in industrial minutes of the connected MLPI device.
[hours] = m4MSystemGetOperationHours(connection) [hours, result] = m4MSystemGetOperationHours(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
hours contains the operation time in industrial minutes. The argument is a scalar uint32 value.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetOperationHours
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the serial number of the MLPI device.
This function reads the serial number of the connected MLPI device.
[serialNumber] = m4MSystemGetSerialNumber(connection) [serialNumber, result] = m4MSystemGetSerialNumber(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
serialNumber contains the serial number of the device. The argument is a 1xL char array.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetSerialNumber
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get information about platform specific path.
This function reads information about the current space of special paths on the device. The values are returned in bytes.
This function does not support code generation.
[pathInfo] = m4MSystemGetSpecialPathInfo(connection,pathIdentifier) [pathInfo, result] = m4MSystemGetSpecialPathInfo(connection,pathIdentifier)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
pathIdentifier defines the symbolic path enumeration. The argument must be a scalar MlpiSpecialPath enumeration value.
pathInfo contains the information about the platform specific absolute path. The argument is a scalar MlpiSpecialPathInfo structure.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetSpecialPathInfo
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get platform specific absolute path.
This function returns the platform specific absolute path of given a symbolic path (MlpiSpecialPath). For example, it is possible to retrieve the absolute path of the system path on the connected device. This information can be used to access files via ftp with the returned path. This function is necessary because it is not guaranteed that the system path always has the same absolute path. Those special paths can vary in different operating systems or on storage devices.
This function does not support code generation.
[specialPath] = m4MSystemGetSpecialPath(connection,pathIdentifier) [specialPath, result] = m4MSystemGetSpecialPath(connection,pathIdentifier)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
pathIdentifier defines the symbolic path enumeration. The argument can be a Mx1 of 1xM matrix with MlpiSpecialPath enumeration values.
specialPath contains the platform specific absolute path. The argument is a Mx1 cell array. Each cell is a 1xL char array that starts and ends with the path delimiter ('/'). The maximum length L is 512 characters.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetSpecialPath
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the subnet mask of the connected MLPI device.
Returns the control subnet mask of the connected MLPI device as character array.
[subnetMask] = m4MSystemGetSubnetMask(connection) [subnetMask, result] = m4MSystemGetSubnetMask(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
subnetMask contains the subnet mask of the MLPI device. The argument is a 1xL char array.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetSubnetMask
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the maximum system temperature.
This function will read the maximum system temperature of the connected MLPI device.
[maxTemp] = m4MSystemGetTemperatureMax(connection) [maxTemp, result] = m4MSystemGetTemperatureMax(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
maxTemp contains the maximum 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 argument is a scalar single value.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetTemperatureMax
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get the system temperature of the connected MLPI device.
Returns the system-temperature of the connected MLPI device as a double.
[temp] = m4MSystemGetTemperature(connection) [temp, result] = m4MSystemGetTemperature(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
temp 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 argument is a scalar single value.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetTemperatureMax
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Get versions information.
This function returns the version information of different components of the device. The following components can be accessed:
[versionInfo] = m4MSystemGetVersionInfo(connection, component) [versionInfo, result] = m4MSystemGetVersionInfo(connection, component)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
component defines the components for which the information shall be read. The argument must be a 1xM char array with the name of the component. The strings are available from the constant class M4M_CONST.
versionInfo contains version information of the component. The argument is a 1xL char array.
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.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemGetVersionInfo
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Reboot the MLPI target.
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 m4MSystemSetTargetMode) before.
m4MSystemReboot(connection) result = m4MSystemReboot(connection)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemReboot
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set time and date in UTC (Universal Time Coordinated) time standard.
This function sets the system date and time (broken down time, UTC) of the device.
m4MSystemSetDateAndTimeUtc(connection, year, month, day, hour,... minute, second, milliSecond, microSecond, dayOfWeek, dayOfYear) result = m4MSystemSetDateAndTimeUtc(connection, year, month, day,... hour, minute, second, milliSecond, microSecond, dayOfWeek, dayOfYear)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
year defines the year. The argument must be a scalar real numeric value.
month defines the month. The argument must be a scalar real numeric value.
day defines the day. The argument must be a scalar real numeric value.
hour defines the hour. The argument must be a scalar real numeric value.
minute defines the minute. The argument must be a scalar real numeric value.
second defines the second. The argument must be a scalar real numeric value.
milliSecond defines the millisecond. The argument must be a scalar real numeric value.
microSecond defines the microsecond. The argument must be a scalar real numeric value.
dayOfWeek defines the day of the week (Monday = 1). The argument must be a scalar real numeric value.
dayOfYear defines the day of the year (Jan. 1st = 1). The argument must be a scalar real numeric value.
Internally the real numeric values will be casted to uint16.
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetDateAndTimeUtc
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set system diagnosis.
This function writes a diagnosis with message to the diagnosis system of the device. The diagnostic group is set to 0x3F automatically.
m4MSystemSetDiagnosis(connection, category, number, diagnosisText)
result = m4MSystemSetDiagnosis(connection, category, number,...
diagnosisText)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
category defines the diagnosis category. The argument must be a scalar MlpiDiagnosisCategory enumeration.
number defines the diagnosis number. The argument must be a scalar uint16 value.
diagnosisText defines the diagnosis text. The argument must be a 1xL char array.
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetDiagnosis
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set the gateway address of the connected MLPI device.
This function writes the gateway address to the device. The input argument is a char array in dot format "xxx.xxx.xxx.xxx". A reboot is necessary to activate the new gateway address.
m4MSystemSetGateway(connection,gateway) result = m4MSystemSetGateway(connection,gateway)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
dateway defines the gateway address of the MLPI target. The argument must be a 1xL char array. The char array must contain the gateway address in dot format "xxx.xxx.xxx.xxx".
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetGateway
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set the IP-Address of the connected MLPI device.
This function writes the IP address to the device. The input argument is a char array in dot format "xxx.xxx.xxx.xxx". A reboot is necessary to activate the new IP address.
m4MSystemSetIpAddress(connection,ipAddress) result = m4MSystemSetIpAddress(connection,ipAddress)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
ipAddress defines the IP address of the MLPI target. The argument must be a 1xL char array. The char array must contain the IP address in dot format "xxx.xxx.xxx.xxx".
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetIpAddress
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set actual language.
This function sets the system language of the device MlpiLanguage.
m4MSystemSetLanguage(connection, language) result = m4MSystemSetLanguage(connection, language)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
language defines the language. The argument must be a scalar MlpiLanguage 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. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetLanguage
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set the name of the connected MLPI device.
This function sets the name of the device.
m4MSystemSetName(connection,deviceName) result = m4MSystemSetName(connection,deviceName)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
deviceName defines the name of the MLPI target. The argument must be a 1xL char array. The maximum name length is defined in the constant M4M_CONST.MEX_SYSTEM_NAME_LENGTH_MAX.
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetName
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set the subnet mask of the connected MLPI device.
This function writes the subnet mask to the device. The input argument is a char array in dot format "xxx.xxx.xxx.xxx". A reboot is necessary to activate the new gateway address.
m4MSystemSetSubnetMask(connection,subnetMask) result = m4MSystemSetSubnetMask(connection,subnetMask)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
subnetMask defines the subnet mask of the MLPI target. The argument must be a 1xL char array. The char array must contain the gateway address in dot format "xxx.xxx.xxx.xxx".
result contains the return value of the MLPI function. The argument is scalar and of type int32. Negative values indicate a failed function call. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetSubnetMask
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0
System-Function: Set target operation mode.
This function writes the operation mode (MlpiSystemMode). After writing the mode, the device will NOT be in this mode. It will be in the process of switching to this mode. In order to switch to a certain mode, and perform an action while in this mode, you have to set the mode then read it back until the desired mode has been reached.
m4MSystemSetTargetMode(connection, targetMode) result = m4MSystemSetTargetMode(connection, targetMode)
connection defines the connection that will be used. The argument must be scalar and of type MlpiConnection.
targetMode defines the desired system mode. The argument must be a scalar MlpiSystemMode 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. For details refer to the section Error Identification and Handling in Fundamentals of MLPI Programming.
Here you will find instructions to use the examples.
The following example is available in the folder ./mlpi/mlpi4MATLAB/bin:
This function maps to the mlpiCore function: mlpiSystemSetTargetMode
Copyright
Legal notice and version: © 2017 Bosch Rexroth Corporation http://www.boschrexroth.com DC-AE/EAS1 (MGo) Library version: 1.26.2.0.0