Structs, types, ...

Collaboration diagram for Structs, types, ...:

Typedefs
typedef struct MlpiDiagnosis	MlpiDiagnosis
typedef struct MlpiMemoryInfo	MlpiMemoryInfo
typedef struct MlpiSpecialPathInfo	MlpiSpecialPathInfo
typedef struct MlpiTransmissionStatus	MlpiTransmissionStatus
typedef struct MlpiTransmissionInfo	MlpiTransmissionInfo

Enumerations

Variables
static const LONG	MLPI_DIAGNOSIS_STRING_LEN = 124
static const WCHAR16	MLPI_VERSION_FIRMWARE [] = {'V','E','R','S','I','O','N','_','F','I','R','M','W','A','R','E','\0'}
static const WCHAR16	MLPI_VERSION_HARDWARE [] = {'V','E','R','S','I','O','N','_','H','A','R','D','W','A','R','E','\0'}
static const WCHAR16	MLPI_VERSION_LOGIC [] = {'V','E','R','S','I','O','N','_','L','O','G','I','C','\0'}
static const WCHAR16	MLPI_VERSION_BSP [] = {'V','E','R','S','I','O','N','_','B','S','P','\0'}
static const WCHAR16	MLPI_VERSION_MLPI_SERVER_CORE [] = {'V','E','R','S','I','O','N','_','M','L','P','I','_','S','E','R','V','E','R','_','C','O','R','E','\0'}
static const LONG	MLPI_TRANSMISSION_URL_LEN = 256
static const LONG	MLPI_TRANSMISSION_ERROR_LEN = 128

Detailed Description

List of used types, enumerations, structures and more...

Typedef Documentation

MlpiDiagnosis

This structure defines the information returned when accessing the diagnosis. A diagnosis is either an error (F...), a warning (E...) or a message (A...). An error must be cleared by the user, warnings remain active until the reason for the warning is removed. Messages only serve an informational purpose. When an error is cleared, two entries exist in the diagnostic log. One where state is set MLPI_DIAGNOSIS_ACTIVE and another one where it is set to MLPI_DIAGNOSIS_RESET.

Elements of struct MlpiDiagnosis

Type	Element	Description
ULONG	number	Ident number that is described in the help manual and identifies the diagnosis.
MlpiDiagnosisState	state	State of a diagnostic message.
MlpiDateAndTime	dateTime	Date and time when the diagnosis took place.
LONG	logicalAddress	Logical address of the device(e.g. axis, touchprobe,...) that dispatched the diagnosis.
LONG	physicalAddress	Physical address of a physical device possibly connected to the logical object. E.g. Drive of an axis.
MlpiDiagnosisDespatcher	despatcher	Identifying source of diagnosis.
ULONG	index	Index of the diagnosis inside the diagnosis ring buffer.
WCHAR16[]	text	Diagnosis text with diagnosis description.

MlpiMemoryInfo

This structure defines the memory information.

Elements of struct MlpiMemoryInfo

Type	Element	Description
ULLONG	totalVolatileBytes	Total RAM of the device in bytes.
ULLONG	totalNonvolatileBytes	Total non-volatile RAM of the device in bytes. This memory is not directly accessible for the user, but used for storing system parameters and settings. For example, axis configuration etc...
ULLONG	freeVolatileBytes	Free RAM of the device in bytes.
ULLONG	freeNonvolatileBytes	Free non-volatile RAM of the device in bytes. This value should never reach 0.

MlpiSpecialPathInfo

This structure defines the special path information.

Elements of struct MlpiSpecialPathInfo

Type	Element	Description
ULLONG	totalBytes	Total size of the partition in bytes.
ULLONG	freeBytes	Free disk-space of the partition in bytes.

MlpiTransmissionStatus

This structure defines the information returned when accessing status of a transmission.

Elements of struct MlpiTransmissionStatus

Type	Element	Description
MLPIHANDLE	handle	Handle of transmission.
MLPIRESULT	result	MLPI status code of this transmission.
MlpiProcessState	state	State of the transmission.
ULONG	totalBytes	Total bytes to transfer. Zero if size of file is unknown.
ULONG	transmittedBytes	Current bytes transferred.

MlpiTransmissionInfo

This structure defines the information returned when accessing information of a transmission.

Elements of struct MlpiTransmissionInfo

Type	Element	Description
MLPIRESULT	result	MLPI status code of this transmission.
MlpiProcessState	state	State of the transmission.
WCHAR16[]	host	Remote host.
WCHAR16[]	localFilename	Local file name.
WCHAR16[]	remoteFilename	Remote file name.
ULONG	totalBytes	Total bytes to transfer. Zero if size of file is unknown.
ULONG	transmittedBytes	Current bytes transferred.
WCHAR16[]	errorMessage	error message of transmission.
BOOL	direction	Direction of transmission. TRUE = send, FALSE = receive

Enumeration Type Documentation

enum MlpiLanguage

This enumeration must be used when accessing language settings in the device.

Enumerator
MLPI_LANGUAGE_GERMAN	German language setting.
MLPI_LANGUAGE_ENGLISH	English language setting.
MLPI_LANGUAGE_USER_DEFINED	Load language data from user defined xml file.

Definition at line 351 of file mlpiSystemLib.h.

enum MlpiSystemMode

This enumeration must be used when accessing the mode settings in the device. The mode can only be set to initialization mode (MLPI_SYSTEMMODE_P0), parameter mode (MLPI_SYSTEMMODE_P2) or operation mode (MLPI_SYSTEMMODE_BB). The read only modes can also be displayed in case of an error during a mode transition.

Enumerator
MLPI_SYSTEMMODE_P0	initialization mode.
MLPI_SYSTEMMODE_P1	transition state from initialization mode to parameter mode.
MLPI_SYSTEMMODE_P2	parameter mode.
MLPI_SYSTEMMODE_P3	transition state from parameter mode to operation mode.
MLPI_SYSTEMMODE_BB	operation mode.
MLPI_SYSTEMMODE_SWITCHING	mode switching active.

Definition at line 363 of file mlpiSystemLib.h.

enum MlpiDiagnosisState

This enumeration must be used when accessing the diagnostic details in the device.

Enumerator
MLPI_DIAGNOSIS_PASSIVE	diagnosis entry is passive.
MLPI_DIAGNOSIS_ACTIVE	diagnosis entry is active.
MLPI_DIAGNOSIS_RESET	diagnosis entry is reset.
MLPI_DIAGNOSIS_UNKNOWN	diagnosis entry state is unknown.

Definition at line 375 of file mlpiSystemLib.h.

enum MlpiDiagnosisDespatcher

This enumeration must be used when accessing the diagnostic details in the device.

Enumerator
MLPI_DESPATCHER_CONTROL	diagnosis entry from control.
MLPI_DESPATCHER_DRIVE	diagnosis entry from drive.
MLPI_DESPATCHER_LOGIC	diagnosis entry from PLC function block.
MLPI_DESPATCHER_AXIS	diagnosis entry from axis.
MLPI_DESPATCHER_KINEMATIC	diagnosis entry from kinematic.
MLPI_DESPATCHER_PCI	diagnosis entry from PCI device.

Definition at line 385 of file mlpiSystemLib.h.

enum MlpiSpecialPath

This enumeration contains different logical paths on the device.

Note

Usually, your target device has at least 3 partitions, a SYSTEM, an OEM and an USER partition. The absolute, native paths of these partitions depends on the target itself, e.g. on an IndraMotion XLC CML45 the absolute path of the OEM partition is called "/ata0a/". Different FTP clients shows the absolute paths itself (Filezilla, e.g. "/ata0a/") or the logical paths (IndraWorks, e.g. "OEM").

MLPI_PATH_SYSTEM	"/ata0/"	"/SYSTEM/"
MLPI_PATH_OEM	"/ata0a/"	"/OEM/"
MLPI_PATH_USER	"/ata0b/"	"/USER/"
MLPI_PATH_PROJECTDATA	"/ata0a/ProjectData/"	"/OEM/ProjectData/"
MLPI_PATH_PROJECTDATAPROTECTED	"/ata0a/ProjectDataProtected/"	"/OEM/ProjectDataProtected/"
MLPI_PATH_PROJECTDATA_BUNDLES	"/ata0a/ProjectData/bundles/"	"/OEM/ProjectData/bundles/"
MLPI_PATH_PROJECTDATAPROTECTED_BUNDLES	"/ata0a/ProjectDataProtected/bundles"	"/OEM/ProjectDataProtected/bundles"
MLPI_PATH_PROJECTDATA_PLC	"/ata0a/ProjectData/PLC/"	"/OEM/ProjectData/PLC/"
MLPI_PATH_PROJECTDATA_TMP	"/ata0a/ProjectData/TMP/"	"/OEM/ProjectData/TMP/"
MLPI_PATH_PROJECTDATA_JVM	"/ata0a/ProjectData/jvm/"	"/OEM/ProjectData/jvm/"
MLPI_PATH_PROJECTDATA_JVM_BUNDLES	"/ata0a/ProjectData/jvm/bundles/"	"/OEM/ProjectData/jvm/bundles/"
MLPI_PATH_PROJECTDATA_JVM_LIC	"/ata0a/ProjectData/jvm/lic/"	"/OEM/ProjectData/jvm/lic/"
MLPI_PATH_PROJECTDATA_JVM_USER	"/ata0a/ProjectData/jvm/user/"	"/OEM/ProjectData/jvm/user/"
MLPI_PATH_PROJECTDATAPROTECTED_JVM	"/ata0a/ProjectDataProtected/jvm/"	"/OEM/ProjectDataProtected/jvm/"
MLPI_PATH_PROJECTDATAPROTECTED_JVM_BUNDLES	"/ata0a/ProjectDataProtected/jvm/bundles/"	"/OEM/ProjectDataProtected/jvm/bundles/"
MLPI_PATH_PROJECTDATAPROTECTED_JVM_LIC	"/ata0a/ProjectDataProtected/jvm/lic/"	"/OEM/ProjectDataProtected/jvm/lic/"
MLPI_PATH_PROJECTDATAPROTECTED_JVM_USER	"/ata0a/ProjectDataProtected/jvm/user/"	"/OEM/ProjectDataProtected/jvm/user/"
MLPI_PATH_OTHER	Any other path.	Any other path.

Use mlpiSystemGetSpecialPath to retrieve absolute path information on a specific device.

Enumerator
MLPI_PATH_SYSTEM	SYSTEM path, root.
MLPI_PATH_OEM	OEM path, root.
MLPI_PATH_USER	User path, root.
MLPI_PATH_PROJECTDATAPROTECTED	Protected project data path.
MLPI_PATH_PROJECTDATA	Project data path.
MLPI_PATH_PROJECTDATA_BUNDLES	C/C++ user bundles path.
MLPI_PATH_PROJECTDATA_PLC	PLC project data path.
MLPI_PATH_PROJECTDATA_TMP	Temporary project data path.
MLPI_PATH_PROJECTDATA_JVM	Java VM root path.
MLPI_PATH_PROJECTDATA_JVM_BUNDLES	Java VM bundles path.
MLPI_PATH_PROJECTDATA_JVM_LIC	Java VM licenses path.
MLPI_PATH_PROJECTDATA_JVM_USER	Java VM user data path.
MLPI_PATH_PROJECTDATAPROTECTED_BUNDLES	Protected C/C++ user bundles path.
MLPI_PATH_PROJECTDATAPROTECTED_JVM	Protected Java VM root path.
MLPI_PATH_PROJECTDATAPROTECTED_JVM_BUNDLES	Protected Java VM bundles path.
MLPI_PATH_PROJECTDATAPROTECTED_JVM_LIC	Protected Java VM licenses path.
MLPI_PATH_PROJECTDATAPROTECTED_JVM_USER	Protected Java VM user data path.
MLPI_PATH_OTHER	Path(s) without special assignments.

Definition at line 424 of file mlpiSystemLib.h.

enum MlpiDiagnosisCategory

This enumeration contains different diagnosis categories on the device.

Enumerator
MLPI_DIAGNOSIS_ERROR_FATAL	Fatal error, error reaction in motion system.
MLPI_DIAGNOSIS_ERROR_NONFATAL_CONTROL	Non-fatal error, all axes are disengaged the best possible.
MLPI_DIAGNOSIS_ERROR_NONFATAL	Non-fatal error, no error reaction.
MLPI_DIAGNOSIS_WARNING	Warning.
MLPI_DIAGNOSIS_MESSAGE	Message.

Definition at line 448 of file mlpiSystemLib.h.

enum MlpiLedPattern

This enumeration provides different LED status resp. diagnosis pattern.

Enumerator
MLPI_LED_PATTERN_GREEN	Switch on LED permanently green.
MLPI_LED_PATTERN_GREEN_250	Toggle LED green/OFF with 4Hz ( 250ms).
MLPI_LED_PATTERN_GREEN_500	Toggle LED green/OFF with 2Hz ( 500ms).
MLPI_LED_PATTERN_GREEN_1000	Toggle LED green/OFF with 1Hz (1000ms).
MLPI_LED_PATTERN_GREEN_ORANGE_250	Toggle LED green/orange with 4Hz ( 250ms).
MLPI_LED_PATTERN_GREEN_ORANGE_500	Toggle LED green/orange with 2Hz ( 500ms).
MLPI_LED_PATTERN_GREEN_ORANGE_1000	Toggle LED green/orange with 1Hz (1000ms).
MLPI_LED_PATTERN_GREEN_RED_250	Toggle LED green/red with 4Hz ( 250ms).
MLPI_LED_PATTERN_GREEN_RED_500	Toggle LED green/red with 2Hz ( 500ms).
MLPI_LED_PATTERN_GREEN_RED_1000	Toggle LED green/red with 1Hz (1000ms).
MLPI_LED_PATTERN_INVALID	Invalid LED pattern.

Definition at line 459 of file mlpiSystemLib.h.

enum MlpiSystemLimit

This enumeration provides different limit defines.

Enumerator
MLPI_SYSTEM_LIMIT_MAX_APPLICATIONS	Maximum number of application.
MLPI_SYSTEM_LIMIT_MAX_CONTROLS	Maximum number of controls.
MLPI_SYSTEM_LIMIT_MAX_AXIS	Maximum number of axis.
MLPI_SYSTEM_LIMIT_MAX_PLS	Maximum number of PLS.
MLPI_SYSTEM_LIMIT_MAX_KINEMATICS	Maximum number of kinematics.
MLPI_SYSTEM_LIMIT_MAX_TOUCHPROBES	Maximum number of touch probes.
MLPI_SYSTEM_LIMIT_MAX_OSCI_CHANNELS	Maximum number of oscilloscope channels.
MLPI_SYSTEM_LIMIT_INVALID	Invalid limit.

Definition at line 477 of file mlpiSystemLib.h.

Variable Documentation

const LONG MLPI_DIAGNOSIS_STRING_LEN = 124

static

The variable defines the maximum text length to be returned in a diagnosis from the device.

Definition at line 321 of file mlpiSystemLib.h.

const WCHAR16 MLPI_VERSION_FIRMWARE[] = {'V','E','R','S','I','O','N','_','F','I','R','M','W','A','R','E','\0'}

static

This variable defines the value to read the firmware version string.

Definition at line 324 of file mlpiSystemLib.h.

const WCHAR16 MLPI_VERSION_HARDWARE[] = {'V','E','R','S','I','O','N','_','H','A','R','D','W','A','R','E','\0'}

static

This variable defines the value to read the hardware version string.

Definition at line 327 of file mlpiSystemLib.h.

const WCHAR16 MLPI_VERSION_LOGIC[] = {'V','E','R','S','I','O','N','_','L','O','G','I','C','\0'}

static

This variable defines the value to read the logic version string.

Definition at line 330 of file mlpiSystemLib.h.

const WCHAR16 MLPI_VERSION_BSP[] = {'V','E','R','S','I','O','N','_','B','S','P','\0'}

static

This variable defines the value to read the board support version string.

Definition at line 333 of file mlpiSystemLib.h.

const WCHAR16 MLPI_VERSION_MLPI_SERVER_CORE[] = {'V','E','R','S','I','O','N','_','M','L','P','I','_','S','E','R','V','E','R','_','C','O','R','E','\0'}

static

This variable defines the value to read the MLPI server core version string.

Definition at line 336 of file mlpiSystemLib.h.

const LONG MLPI_TRANSMISSION_URL_LEN = 256

static

The variable defines the maximum length of a URL.

Definition at line 339 of file mlpiSystemLib.h.

const LONG MLPI_TRANSMISSION_ERROR_LEN = 128

static

The variable defines the maximum length of an error message.

Definition at line 342 of file mlpiSystemLib.h.