com.boschrexroth.mlpi.System Class Reference

Inherits com.boschrexroth.mlpi.MlpiComponent.

Collaboration diagram for com.boschrexroth.mlpi.System:

Classes
class	DateAndTime
class	Diagnosis
enum	DiagnosisCategory
enum	DiagnosisDespatcher
enum	DiagnosisState
enum	Language
enum	MlpiLedPattern
enum	MlpiSystemLimit
enum	SpecialPath
class	SpecialPathInfo
enum	SystemMode

Public Member Functions
native String	getName ()
native void	setName (String name)
native long	getTargetId ()
native float	getTemperature ()
native float	getTemperatureMax ()
native void	resetTemperature ()
native String	getIpAddress ()
native void	setIpAddress (String ipAddress)
native String	getSubnetMask ()
native void	setSubnetMask (String subnetMask)
native String	getGateway ()
native void	setGateway (String gateway)
native SystemMode	getCurrentMode ()
native void	setTargetMode (SystemMode mode)
native float	getCpuLoad ()
native float	getCpuLoadMax ()
native void	resetCpuLoad ()
native Diagnosis	getDisplayedDiagnosis ()
native long	getNewestDiagnosisIndex ()
native long	getOldestDiagnosisIndex ()
native Diagnosis[]	getDiagnosisLog (long startIndex, long numToRead)
native String	convertDiagnosisNumberToText (int diagnosisNumber)
native long	getOperationHours ()
native void	reboot ()
native void	cleanup ()
native Language	getLanguage ()
native void	setLanguage (Language language)
native SpecialPathInfo	getSpecialPathInfo (SpecialPath pathIdentifier)
native MemoryInfo	getMemoryInfo ()
native DateAndTime	getDateAndTimeUtc ()
native void	setDateAndTimeUtc (DateAndTime dateTime)
native void	setDateAndTimeUtcByNtp (long timeout, String server, int port)
native String	getSpecialPath (SpecialPath pathIdentifier)
native String[]	getRootPaths ()
native String	getLicenseInformation ()
native String	getVersionInfo (String component)
native String	getSerialNumber ()
native String	getMacAddress ()
native void	clearError ()
native String	getHardwareDetails ()
native void	setDiagnosis (DiagnosisCategory category, int number, String diagnosisText)
native void	setBootLed (MlpiLedPattern pattern, int count)
native void	clearBootLed ()
native long	getLimit (MlpiSystemLimit limit)

Detailed Description

Class definition of the SystemLib.

Definition at line 65 of file System.java.

Member Function Documentation

native String com.boschrexroth.mlpi.System.getName

(

)

This function reads the device name.

Returns

The device name.

Example Java:

java.lang.System.out.println("Name of device: " + connection.system().getName());

Note:

This method maps to the mlpiCore function mlpiSystemGetName, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setName

(

String

name

)

This function writes the device name.

Parameters

[in]

name

The device name.

Example Java:

java.lang.System.out.println("Old Name: " + connection.system().getName());
// change name
connection.system().setName("Skynet");
java.lang.System.out.println("New Name: " + connection.system().getName());

Note:

This method maps to the mlpiCore function mlpiSystemSetName, where you can find further documentation.

native long com.boschrexroth.mlpi.System.getTargetId

(

)

This function reads the device target-id.

Returns

TargetId of Device.

Example Java:

java.lang.System.out.println("TargetId of device: " + connection.system().getTargetId());

Note:

This method maps to the mlpiCore function mlpiSystemGetTargetId, where you can find further documentation.

native float com.boschrexroth.mlpi.System.getTemperature

(

)

This function reads the current temperature of the device.

Returns

The current temperature of the device.

Example Java:

java.lang.System.out.println("Temperature: " + connection.system().getTemperature());

Note:

This method maps to the mlpiCore function mlpiSystemGetTemperature, where you can find further documentation.

native float com.boschrexroth.mlpi.System.getTemperatureMax

(

)

This function reads the maximum temperature of the device.

Returns

The maximum temperature of the device.

Example Java:

java.lang.System.out.println("Temperature: " + connection.system().getTemperatureMax());

Note:

This method maps to the mlpiCore function mlpiSystemGetTemperatureMax, where you can find further documentation.

native void com.boschrexroth.mlpi.System.resetTemperature

(

)

This function reset the temperature values of the device to the current temperature.

Note:

This method maps to the mlpiCore function mlpiSystemResetTemperature, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getIpAddress

(

)

This function reads the IP address of the device. Value is a string in quad-dotted notation of four decimal integers, e.g. "192.168.001.001" (IPv4).

Returns

The IP address.

Example Java:

java.lang.System.out.println("IpAddress: " + connection.system().getIpAddress());
java.lang.System.out.println("SubnetMask: " + connection.system().getSubnetMask());
java.lang.System.out.println("Gateway: " + connection.system().getGateway());
java.lang.System.out.println("MacAddress: " + connection.system().getMacAddress());

Note:

This method maps to the mlpiCore function mlpiSystemGetIpAddress, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setIpAddress

(

String

ipAddress

)

This function writes the IP address of the device. Value is a string in quad-dotted notation of four decimal integers, e.g. "192.168.001.001" (IPv4). A reboot is necessary for the new IP address to become active.

Parameters

[in]

ipAddress

The IP address.

Example Java:

connection.system().setIpAddress("192.168.0.17");
connection.system().setSubnetMask("255.255.0.0");
connection.system().setGateway("192.168.0.1");

Note:

This method maps to the mlpiCore function mlpiSystemSetIpAddress, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getSubnetMask

(

)

This function reads the subnet mask of the device. Value is a string in quad-dotted notation of four decimal integers, e.g. "255.255.255.000" (IPv4).

Returns

The subnet mask.

Example Java:

See documentation of method getIpAddress.

Note:

This method maps to the mlpiCore function mlpiSystemGetSubnetMask, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setSubnetMask

(

String

subnetMask

)

This function writes the subnet mask of the device. Value is a string in quad-dotted notation of four decimal integers, e.g. "255.255.255.000" (IPv4).

Parameters

[in]

subnetMask

The subnet mask.

Example Java:

See documentation of method setIpAddress.

Note:

This method maps to the mlpiCore function mlpiSystemSetSubnetMask, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getGateway

(

)

This function reads the gateway address of the device. Value is a string in quad-dotted notation of four decimal integers, e.g. "192.168.001.001" (IPv4).

Returns

The gateway address.

Example Java:

See documentation of method getIpAddress.

Note:

This method maps to the mlpiCore function mlpiSystemGetGateway, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setGateway

(

String

gateway

)

This function writes the gateway address of the device. Value is a string in quad-dotted notation of four decimal integers, e.g. "192.168.001.001" (IPv4).

Parameters

[in]

gateway

The gateway address.

Example Java:

See documentation of method setIpAddress.

Note:

This method maps to the mlpiCore function mlpiSystemSetGateway, where you can find further documentation.

native SystemMode com.boschrexroth.mlpi.System.getCurrentMode

(

)

This function reads the current device mode (SystemMode).

Returns

The current mode of the device.

Example Java:

java.lang.System.out.println("Current SystemMode: " + connection.system().getCurrentMode().toString());

Note:

This method maps to the mlpiCore function mlpiSystemGetCurrentMode, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setTargetMode

(

SystemMode

mode

)

This function writes the device mode (SystemMode). 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 is reached.

Parameters

[in]

mode

Mode of the device to which it has to be switched.

Example Java:

SystemMode currentMode = connection.system().getCurrentMode();
java.lang.System.out.println("Current SystemMode: " + currentMode.toString());
// let's switch to another mode
SystemMode newMode = (currentMode == SystemMode.SYSTEMMODE_BB) ? SystemMode.SYSTEMMODE_P0 : SystemMode.SYSTEMMODE_BB;
java.lang.System.out.println("Starting switching operation to " + newMode.toString());
connection.system().setTargetMode(newMode);
// poll for state change
int timeout = 20000;
do
{
   Thread.sleep(100);
   timeout -= 100;
   if (timeout < 0)
      throw new Exception("timeout during mode switching!");
}
while (connection.system().getCurrentMode() != newMode);
java.lang.System.out.println("Reached new mode!");

Note:

This method maps to the mlpiCore function mlpiSystemSetTargetMode, where you can find further documentation.

native float com.boschrexroth.mlpi.System.getCpuLoad

(

)

This function reads the current CPU load of the device in percent.

Returns

The current cpu load of the device.

Example Java:

java.lang.System.out.println("CPU Load: " + connection.system().getCpuLoad());

Note:

This method maps to the mlpiCore function mlpiSystemGetCpuLoad, where you can find further documentation.

native float com.boschrexroth.mlpi.System.getCpuLoadMax

(

)

This function reads the maximum CPU load of the device in percent.

Returns

The maximum cpu load of the device.

Example Java:

java.lang.System.out.println("CPU Load: " + connection.system().getCpuLoadMax());

Note:

This method maps to the mlpiCore function mlpiSystemGetCpuLoadMax, where you can find further documentation.

native void com.boschrexroth.mlpi.System.resetCpuLoad

(

)

This function reset the CPU load values of the device to the current CPU load.

Note:

This method maps to the mlpiCore function mlpiSystemResetCpuLoad, where you can find further documentation.

native Diagnosis com.boschrexroth.mlpi.System.getDisplayedDiagnosis

(

)

This function 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 diagnostic message can differ from the newest or last inserted diagnostic message.

Returns

The displayed diagnosis as Diagnosis object.

Example Java:

// read displayed diagnosis of device
Diagnosis diagnosis = connection.system().getDisplayedDiagnosis();
//create output string
String strFormattedOutput = "";
// add timestamp
strFormattedOutput += "Time: "
+ String.format("%02d.",diagnosis.dateTime.day)
+ String.format("%02d.",diagnosis.dateTime.month)
+ String.format("%02d - ",diagnosis.dateTime.year)
+ String.format("%02d:",diagnosis.dateTime.hour)
+ String.format("%02d:",diagnosis.dateTime.minute)
+ String.format("%02d\n",diagnosis.dateTime.second);
// add current state
strFormattedOutput += "State: " + diagnosis.state.toString() + "\n";
// add dispatcher of diagnosis
strFormattedOutput += "Despatcher: " + diagnosis.despatcher.toString() + "\n";
// add error number
strFormattedOutput += "Number: 0x" + String.format("%X", diagnosis.number) + "\n";
// add description
strFormattedOutput += "Text: " + diagnosis.text;
// print to console
java.lang.System.out.println(strFormattedOutput);

Note:

This method maps to the mlpiCore function mlpiSystemGetDisplayedDiagnosis, where you can find further documentation.

native long com.boschrexroth.mlpi.System.getNewestDiagnosisIndex

(

)

Each new diagnosis in the diagnosis logbook gets a unique incremented diagnosis index. This function returns the index of the latest and therefore most recently inserted diagnosis. This index can be used as a parameter using the function getDiagnosisLog to read the complete logbook of the newest diagnostic messages.

Returns

The index of the newest diagnosis.

Example Java:

See documentation of method getDiagnosisLog.

Note:

This method maps to the mlpiCore function mlpiSystemGetNewestDiagnosisIndex, where you can find further documentation.

native long com.boschrexroth.mlpi.System.getOldestDiagnosisIndex

(

)

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 this function to get the index of the oldest diagnostic message that is still in memory and can be returned by the function getDiagnosisLog.

Returns

The index of the oldest diagnosis.

Example Java:

See documentation of method getDiagnosisLog.

Note:

This method maps to the mlpiCore function mlpiSystemGetOldestDiagnosisIndex, where you can find further documentation.

native Diagnosis [] com.boschrexroth.mlpi.System.getDiagnosisLog	(	long	startIndex,
		long	numToRead
	)

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 latest and thus most recently inserted diagnosis, you can use the function getNewestDiagnosisIndex. 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 getOldestDiagnosisIndex 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.

Parameters

[in]	startIndex	Index of the first diagnosis index to start reading.
[in]	numToRead	Number of Diagnosis elements you want to read.

Returns

The read diagnoses as array of Diagnosis objects.

Example Java:

// read the complete diagnosis log of device
long newestIndex = connection.system().getNewestDiagnosisIndex();
long oldestIndex = connection.system().getOldestDiagnosisIndex();
long numAvailable = newestIndex - oldestIndex;
Diagnosis[] diagnosisLog = connection.system().getDiagnosisLog(newestIndex, numAvailable);
// print each diagnosis log entry in the returned array
for (Diagnosis diagnosis: diagnosisLog)
{
   String strFormattedOutput = "";
   strFormattedOutput += diagnosis.index + "\n";
   strFormattedOutput += "-Time: "
      + String.format("%02d.", diagnosis.dateTime.day)
      + String.format("%02d.", diagnosis.dateTime.month)
      + String.format("%02d - ", diagnosis.dateTime.year)
      + String.format("%02d:", diagnosis.dateTime.hour)
      + String.format("%02d:", diagnosis.dateTime.minute)
      + String.format("%02d\n", diagnosis.dateTime.second);
   strFormattedOutput += "-State: " + diagnosis.state.toString() + "\n";
   strFormattedOutput += "-Despatcher: " + diagnosis.despatcher.toString() + "\n";
   strFormattedOutput += String.format("-Number: 0x%X\n", diagnosis.number);
   strFormattedOutput += "-Text: " + diagnosis.text;
   java.lang.System.out.println(strFormattedOutput);
}

Note:

This method maps to the mlpiCore function mlpiSystemGetDiagnosisLog, where you can find further documentation.

native String com.boschrexroth.mlpi.System.convertDiagnosisNumberToText

(

int

diagnosisNumber

)

This function tries to retrieve a textual description 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 string "No entry found in data base" is returned.

Parameters

[in]

diagnosisNumber

Diagnosis number.

Returns

The converted diagnosis text.

Example Java:

// let's convert a sercos error to a text description
int diagnosisNumber = 0xF02D7001;
String diagnosisText = connection.system().convertDiagnosisNumberToText(diagnosisNumber);
java.lang.System.out.println("Diagnosis Text: " + diagnosisText);

Note:

This method maps to the mlpiCore function mlpiSystemConvertDiagnosisNumberToText, where you can find further documentation.

native long com.boschrexroth.mlpi.System.getOperationHours

(

)

This function reads the operating time in industrial minutes of the device.

Returns

The operating time of the device.

Example Java:

java.lang.System.out.println("Operation Hours of device: " + connection.system().getOperationHours());

Note:

This method maps to the mlpiCore function mlpiSystemGetOperationHours, where you can find further documentation.

native void com.boschrexroth.mlpi.System.reboot

(

)

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 setTargetMode) before.

Note:

This method maps to the mlpiCore function mlpiSystemReboot, where you can find further documentation.

native void com.boschrexroth.mlpi.System.cleanup

(

)

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 setTargetMode) beforehand. Please note that the device reboots immediately and that all project data is deleted during the next boot up.

Note:

This method maps to the mlpiCore function mlpiSystemCleanup, where you can find further documentation.

native Language com.boschrexroth.mlpi.System.getLanguage

(

)

This function reads the current system language of the device (Language).

Returns

The currently selected system language.

Example Java:

Language language = connection.system().getLanguage();
java.lang.System.out.println("Language: " + language.toString());

Note:

This method maps to the mlpiCore function mlpiSystemGetLanguage, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setLanguage

(

Language

language

)

This function writes the system language of the device (Language).

Parameters

[in]

language

System language of the device to which it has to be switched.

Example Java:

java.lang.System.out.println("Old Language: " + connection.system().getLanguage().toString());
Language newLang = (connection.system().getLanguage() == Language.LANGUAGE_GERMAN) ? Language.LANGUAGE_ENGLISH : Language.LANGUAGE_GERMAN;
connection.system().setLanguage(newLang);
java.lang.System.out.println("New Language: " + connection.system().getLanguage().toString());

Note:

This method maps to the mlpiCore function mlpiSystemSetLanguage, where you can find further documentation.

native SpecialPathInfo com.boschrexroth.mlpi.System.getSpecialPathInfo

(

SpecialPath

pathIdentifier

)

This function retrieves some information about the current spaces of special paths on the device. The figures are given in Bytes.

Parameters

[in]

pathIdentifier

Identifier for the path to query for.

Returns

The path information as SpecialPathInfo object.

Example Java:

// read data from device
SpecialPathInfo pathInfo = connection.system().getSpecialPathInfo(SpecialPath.PATH_USER);
// print to console
java.lang.System.out.println("User Path - Free Bytes: " + pathInfo.freeDiskspace);
java.lang.System.out.println("User Path - Total Bytes: " + pathInfo.totalDiskspace);

Note:

This method maps to the mlpiCore function mlpiSystemGetSpecialPathInfo, where you can find further documentation.

native MemoryInfo com.boschrexroth.mlpi.System.getMemoryInfo

(

)

This function retrieves some information about the current free RAM on the device. The figures are given in bytes. The function can be used to trace the total system performance of the device.

Returns

The memory information as MemoryInfo object.

Example Java:

// read data from device
MemoryInfo info = connection.system().getMemoryInfo();
// print to console
java.lang.System.out.println("totalVolatileBytes: " + info.totalVolatileBytes);
java.lang.System.out.println("freeVolatileBytes: " + info.freeVolatileBytes);
java.lang.System.out.println("totalNonvolatileBytes: " + info.totalNonvolatileBytes);
java.lang.System.out.println("freeNonvolatileBytes: " + info.freeNonvolatileBytes);

Note:

This method maps to the mlpiCore function mlpiSystemGetMemoryInfo, where you can find further documentation.

native DateAndTime com.boschrexroth.mlpi.System.getDateAndTimeUtc

(

)

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

Returns

The date and time of the device as DateAndTime object.

Example Java:

DateAndTime dat = connection.system().getDateAndTimeUtc();
java.lang.System.out.println("Date and Time: " + dat.day + "." + dat.month + "." + dat.year + " " + dat.hour + ":" + dat.minute + ":" + dat.year);

Note:

This method maps to the mlpiCore function mlpiSystemGetDateAndTimeUtc, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setDateAndTimeUtc

(

DateAndTime

dateTime

)

This function writes the system date and time (broken down time, UTC) into the device.

Parameters

[in]

dateTime

The date and time of the device as DateAndTime object.

Example Java:

DateAndTime dateTime;
// get current date and time
dateTime = connection.system().getDateAndTimeUtc();
// increment hour and write it back...
dateTime.hour = dateTime.hour + 1;
connection.system().setDateAndTimeUtc(dateTime);

Note:

This method maps to the mlpiCore function mlpiSystemSetDateAndTimeUtc, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setDateAndTimeUtcByNtp	(	long	timeout,
		String	server,
		int	port
	)

This function writes the system date and time of the device by a NTP server.

Parameters

[in]	timeout	Timeout until NTP server response.
[in]	server	NTP server URI.
[in]	port	Port of NTP server, use "0" for default port.

Example Java:

// trigger update date and time ...
connection.system().setDateAndTimeUtcByNtp(5000, "192.168.1.1", 0);

Note:

This method maps to the mlpiCore function mlpiSystemSetDateAndTimeUtcByNtp, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getSpecialPath

(

SpecialPath

pathIdentifier

)

This function returns the platform specific absolute path of given symbolic path (MlpiSpecialPath). For example, it is possible to retrieve the absolute path of the system path on the connected device. This information can then be used to access files via ftp on the given 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.

Parameters

[in]

pathIdentifier

Identifier for the path to query for.

Returns

The requested special path. Starts and ends with path delimiter ("/")

Example Java:

String pathSYS = connection.system().getSpecialPath(SpecialPath.PATH_SYSTEM);
String pathOEM = connection.system().getSpecialPath(SpecialPath.PATH_OEM);
String pathUSR = connection.system().getSpecialPath(SpecialPath.PATH_USER);
java.lang.System.out.println("SYSTEM root path: " + pathSYS); // --> e.g. "/ata0/"
java.lang.System.out.println("OEM root path: " + pathOEM);    // --> e.g. "/ata0a/"
java.lang.System.out.println("USER root path: " + pathUSR);   // --> e.g. "/ata0b/"

Note:

This method maps to the mlpiCore function mlpiSystemGetSpecialPath, where you can find further documentation.

native String [] com.boschrexroth.mlpi.System.getRootPaths

(

)

This function returns all available platform specific root paths. The information about the root paths can be used to access files via ftp. This function is necessary because it is not guaranteed that the root path always has the same absolute path, meaning the root paths can varies in different operating systems or on storage devices.

Returns

All available platform specific root paths as array of strings.

Example Java:

String[] paths = connection.system().getRootPaths();
for (String path: paths)
{
  java.lang.System.out.println(path);
}

Note:

This method maps to the mlpiCore function mlpiSystemGetRootPaths, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getLicenseInformation

(

)

This function returns the license information of the device (raw format).

Returns

License information of device.

Example Java:

String license = connection.system().getLicenceInformation();

Note:

This method maps to the mlpiCore function mlpiSystemGetLicenseInformation, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getVersionInfo

(

String

component

)

This function returns the version information of different components of the device. The component name has to be given as a string. The following constants are already defined by the MLPI:

• VERSION_FIRMWARE
• VERSION_HARDWARE
• VERSION_LOGIC
• VERSION_BSP

• VERSION_MLPI_SERVER_CORE

  Parameters

  [in]

  component

  String that identifies the component for which version string was read (see global constants e.g. MLPI_VERSION_FIRMWARE).

  Returns

  The requested version information. Note that the format of the version information string may differ depending on the selected component.

  Example Java:

  // get data from device
  String versionFirmware = connection.system().getVersionInfo("VERSION_FIRMWARE");
  String versionHardware = connection.system().getVersionInfo("VERSION_HARDWARE");
  String versionLogic = connection.system().getVersionInfo("VERSION_LOGIC");
  String versionBoard = connection.system().getVersionInfo("VERSION_BSP");
  // print data to console
  java.lang.System.out.println("Version-Firmware: " + versionFirmware);
  java.lang.System.out.println("Version-Hardware: " + versionHardware);
  java.lang.System.out.println("Version-Logic: " + versionLogic);
  java.lang.System.out.println("Version-Board: " + versionBoard);

  Note:

  This method maps to the mlpiCore function mlpiSystemGetVersionInfo, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getSerialNumber

(

)

This function reads the serial number of the device.

Returns

The serial number of the device as string.

Example Java:

java.lang.System.out.println(connection.system().getSerialNumber());

Note:

This method maps to the mlpiCore function mlpiSystemGetSerialNumber, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getMacAddress

(

)

This method reads the MAC address of the device. Value is a string in format "00:00:00:00:00:00".

Returns

The MAC address of the device as string.

Example Java:

See documentation of method getIpAddress.

Note:

This method maps to the mlpiCore function mlpiSystemGetMacAddress, where you can find further documentation.

native void com.boschrexroth.mlpi.System.clearError

(

)

This function clears pending errors.

Note:

This method maps to the mlpiCore function mlpiSystemClearError, where you can find further documentation.

native String com.boschrexroth.mlpi.System.getHardwareDetails

(

)

This function reads the hardware details of the device.

Returns

A hardware information string.

Example Java:

java.lang.System.out.println("Hardware details: " + connection.system().getHardwareDetails());

Note:

This method maps to the mlpiCore function mlpiSystemGetHardwareDetails, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setDiagnosis	(	DiagnosisCategory	category,
		int	number,
		String	diagnosisText
	)

This function writes a diagnosis with message to the diagnosis system of the device.

Parameters

[in]	category	Diagnosis category (DiagnosisCategory)
[in]	number	User specific diagnosis number (Maximum 4 hexadecimal characters!)
[in]	diagnosisText	Diagnosis text

Example Java:

// print a simple message to the diagnosis log which might also get shown in the display of the device
connection.system().setDiagnosis(DiagnosisCategory.DIAGNOSIS_MESSAGE, 23, "All your base are belong to us!");

Note:

This method maps to the mlpiCore function mlpiSystemSetDiagnosis, where you can find further documentation.

native void com.boschrexroth.mlpi.System.setBootLed	(	MlpiLedPattern	pattern,
		int	count
	)

This function set the boot LED 'BT' (if available) regarding the selected MlpiLedPattern pattern.

Parameters

[in]	pattern	LED pattern.
[in]	count	Count of repeat pattern. Use "-1" for repeat infinite.

Example Java:

// set boot LED 'BT' infinite to green.
connection.system().setBootLed(MlpiLedPattern.MLPI_LED_PATTERN_GREEN, -1);

Note:

This method maps to the mlpiCore function mlpiSystemSetBootLed, where you can find further documentation.

native void com.boschrexroth.mlpi.System.clearBootLed

(

)

This function clear the boot LED 'BT' (if available).

Example Java:

// clear boot LED 'BT'.
connection.system().clearBootLed();

Note:

This method maps to the mlpiCore function mlpiSystemClearBootLed, where you can find further documentation.

native long com.boschrexroth.mlpi.System.getLimit

(

MlpiSystemLimit

limit

)

This function reads a limit (e.g. maximum number of applications) of the device (MlpiSystemLimit).

Parameters

[in]

limit

Identifier for the limit to query for.

Returns

The requested limit value.

Example Java:

long max = connection.system().getLimit(MlpiSystemLimit.MAX_APPLICATIONS);
java.lang.System.out.println("Maximum number of application: " + max); // --> e.g. "1"

Note:

This method maps to the mlpiCore function mlpiSystemGetLimit, where you can find further documentation.

---

The documentation for this class was generated from the following file:

• System.java