Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpiCore)  1.26.2
Server version since 1.26.0.0 (MLC-FW: 14V22)
Collaboration diagram for Server version since 1.26.0.0 (MLC-FW: 14V22):
Note
Since firmware version 14V22 (MLPI-Server-Version: 1.26.0.0) a centralized permission management has been implemented in target controls XM2, L75 and VPx. Some permissions have been summarized in order to improve their usability. Additional information regarding the usage of older manifest files (i.e. accounts.xml) with newer server versions can be found in Manifest since server version 1.26.0.0.
Users of other CML controls (i.e. L25, L45, L65) have to use the old permissions as defined in Server versions before 1.26.0.0
List of valid permissions for mlpiEthercatLib. These permissions shall be assigned to the groups (i.e. in the group manifest file groups.xml) rather than the users.
Permission-Ident Description
ETHERCAT_INFO Get status and configuration info of bus and devices - Allows get status and configuration info of EtherCAT bus and devices.
ETHERCAT_OPERATION Operation - Allows to set the bus state, perform bus scan and reset statistics.TD</ >
ETHERCAT_READ Read data from devices - Allows to read data from EtherCAT devices.
ETHERCAT_SETUP Setup and configure master and devices - Allows to setup and configure the EtherCAT master and devices.
ETHERCAT_WRITE Write data to devices - Allows to write data to EtherCAT devices.
List of available functions in mlpiEthercatLib and the permissions required for their use.
Function Server version Permission-Ident
mlpiEthercatGetTopologyStatus 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetConfigFiles 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatSetConfigFiles 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatControl 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatGetMasterState 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatSetMasterState 1.18.0.0 "ETHERCAT_OPERATION"
mlpiEthercatGetNumConfiguredSlaves 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetNumConnectedSlaves 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetSlaveState 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatSetSlaveState 1.18.0.0 "ETHERCAT_OPERATION"
mlpiEthercatGetSlaveOnlineInfo 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetSlaveConfigInfo 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetSlavePortState 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatReadSlaveRegister 1.18.0.0 "ETHERCAT_OPERATION"
mlpiEthercatWriteSlaveRegister 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatResetSlaveController 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatReadSlaveEeprom 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatWriteSlaveEeprom 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatReloadSlaveEeprom 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatAssignSlaveEeprom 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatCheckSlaveEeprom 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatReadSlaveIdentification 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetSlaveStatistics 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatResetSlaveStatistics 1.18.0.0 "ETHERCAT_OPERATION"
mlpiEthercatSetSlaveStatisticsPeriod 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatCoeGetOdList 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatCoeGetObjectDescription 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatCoeGetEntryDescription 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatCoeSdoUpload 1.18.0.0 "ETHERCAT_READ"
mlpiEthercatCoeSdoDownload 1.18.0.0 "ETHERCAT_WRITE"
mlpiEthercatSoeRead 1.18.0.0 "ETHERCAT_WRITE"
mlpiEthercatSoeWrite 1.18.0.0 "ETHERCAT_READ"
mlpiEthercatGetVendorInfo 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGenerateEsi 1.18.0.0 "ETHERCAT_SETUP"
mlpiEthercatStartBusScan 1.18.0.0 "ETHERCAT_OPERATION"
mlpiEthercatGetBusScanStatus 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetBusScanSlaveInfo 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetProcessData 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatSetProcessData 1.18.0.0 "ETHERCAT_WRITE"
mlpiEthercatGetProcessDataSize 1.18.0.0 "ETHERCAT_INFO"
mlpiEthercatGetMasterStatus 1.23.0.0 "ETHERCAT_INFO"
mlpiEthercatGetSlaveStatus 1.23.0.0 "ETHERCAT_INFO"
mlpiEthercatGetSlaveStatisticsPeriod 1.23.0.0 "ETHERCAT_INFO"
List of the old permissions of mlpiEthercatLib and their corresponding new permission.
Old permission new Permission
MLPI_ETHERCATLIB_PERMISSION_ALWAYS IMPLICIT
MLPI_ETHERCATLIB_PERMISSION_CONFIG ETHERCAT_SETUP
MLPI_ETHERCATLIB_PERMISSION_INFO ETHERCAT_INFO
MLPI_ETHERCATLIB_PERMISSION_OPERATION ETHERCAT_OPERATION
MLPI_ETHERCATLIB_PERMISSION_DATA_READ ETHERCAT_READ
MLPI_ETHERCATLIB_PERMISSION_DATA_WRITE ETHERCAT_WRITE