6. Application programming interface, reference

• 6.1. Header files
• 6.2. Generic API return status values
• 6.3. Multiple EtherCAT Network Support
  • 6.3.1. Overview
  • 6.3.2. Licensing
• 6.4. General functions
  • 6.4.1. esInitSimulator
  • 6.4.2. esDeinitSimulator
  • 6.4.3. esGetSimulatorParms
  • 6.4.4. esSetSimulatorParms
  • 6.4.5. esGetSrcMacAddress
  • 6.4.6. esSetLicenseKey (HiL)
  • 6.4.7. esSetOemKey (HiL)
  • 6.4.8. esConfigureNetwork
  • 6.4.9. esGetCfgSlaveInfo
  • 6.4.10. esGetCfgSlaveSmInfo
  • 6.4.11. esSetSlaveSscApplication
  • 6.4.12. esRegisterClient
  • 6.4.13. esUnregisterClient
  • 6.4.14. esExecJob
  • 6.4.15. esGetMasterState
  • 6.4.16. esIoControl
  • 6.4.17. esIoControl - EC_IOCTL_GET_PDMEMORYSIZE
  • 6.4.18. esIoControl - EC_IOCTL_REGISTER_CYCFRAME_RX_CB
  • 6.4.19. esIoControl - EC_IOCTL_ISLINK_CONNECTED
  • 6.4.20. esIoControl - EC_IOCTL_GET_CYCLIC_CONFIG_INFO
  • 6.4.21. esIoControl - EC_IOCTL_ADDITIONAL_VARIABLES_FOR_SPECIFIC_DATA_TYPES
  • 6.4.22. esIoControl - EC_IOCTL_SIMULATOR_SET_MBX_PROCESS_CTL
  • 6.4.23. esIoControl - EC_IOCTL_SIMULATOR_GET_MBX_PROCESS_CTL
  • 6.4.24. esIoControl - EC_IOCTL_GET_LINKLAYER_MODE
  • 6.4.25. esIoControl - EC_LINKIOCTL_XXXX
  • 6.4.26. esIoControl - EC_LINKIOCTL_GET_ETHERNET_ADDRESS
  • 6.4.27. esIoControl - EC_LINKIOCTL_GET_SPEED
  • 6.4.28. esIoControl - EC_LINKIOCTL_GET_PCI_INFO
  • 6.4.29. esIoControl - EC_LINKIOCTL_FORCE_LINK_STATUS
  • 6.4.30. esGetVersion
  • 6.4.31. esGetText
  • 6.4.32. esGetMemoryUsage
  • 6.4.33. esLogFrameEnable
  • 6.4.34. esLogFrameDisable
• 6.5. Process Data Access Functions
  • 6.5.1. esGetProcessImageInputPtr
  • 6.5.2. esGetProcessImageOutputPtr
  • 6.5.3. EC_COPYBITS
  • 6.5.4. EC_GET_FRM_WORD
  • 6.5.5. EC_GET_FRM_DWORD
  • 6.5.6. EC_GET_FRM_QWORD
  • 6.5.7. EC_SET_FRM_WORD
  • 6.5.8. EC_SET_FRM_DWORD
  • 6.5.9. EC_SET_FRM_QWORD
  • 6.5.10. EC_GETBITS
  • 6.5.11. EC_SETBITS
  • 6.5.12. esGetProcessData
  • 6.5.13. esSetProcessData
  • 6.5.14. esSetProcessDataBits
  • 6.5.15. esGetProcessDataBits
• 6.6. Notifications
  • 6.6.1. Notification handler
  • 6.6.2. EC_NOTIFY_SLAVE_PRESENCE
  • 6.6.3. EC_NOTIFY_SLAVE_STATECHANGED
  • 6.6.4. EC_NOTIFY_HC_TOPOCHGDONE
  • 6.6.5. EC_NOTIFY_SLAVE_ERROR_STATUS_INFO
  • 6.6.6. EC_NOTIFY_EEPROM_OPERATION
  • 6.6.7. esNotifyApp
• 6.7. Network operation functions
  • 6.7.1. esConnectPorts
  • 6.7.2. esDisconnectPort
  • 6.7.3. esPowerSlave
• 6.8. Error simulation functions
  • 6.8.1. esSetErrorAtSlavePort
  • 6.8.2. esSetErrorGenerationAtSlavePort
  • 6.8.3. esResetErrorGenerationAtSlavePorts
  • 6.8.4. esSetLinkDownAtSlavePort
  • 6.8.5. esSetLinkDownGenerationAtSlavePort
  • 6.8.6. esResetLinkDownGenerationAtSlavePorts
  • 6.8.7. esLogFrameEnableAtSlavePort
  • 6.8.8. esLogFrameDisableAtSlavePort
  • 6.8.9. esSendSlaveCoeEmergency
  • 6.8.10. esSetSimSlaveState
• 6.9. Slave control and status functions
  • 6.9.1. esGetNumConfiguredSlaves
  • 6.9.2. esGetNumConnectedSlaves
  • 6.9.3. esGetSlaveId
  • 6.9.4. esGetSlaveIdAtPosition
  • 6.9.5. esGetSlaveState
  • 6.9.6. esSetSlaveState
  • 6.9.7. esIsSlavePresent
  • 6.9.8. esGetSlaveProp
  • 6.9.9. esGetSlavePortState
  • 6.9.10. esGetSlaveInpVarInfoNumOf
  • 6.9.11. esGetSlaveOutpVarInfoNumOf
  • 6.9.12. esGetSlaveInpVarInfo
  • 6.9.13. esGetSlaveInpVarInfoEx
  • 6.9.14. esGetSlaveOutpVarInfo
  • 6.9.15. esGetSlaveOutpVarInfoEx
  • 6.9.16. esGetSlaveInpVarByObjectEx
  • 6.9.17. esGetSlaveOutpVarByObjectEx
  • 6.9.18. esFindInpVarByName
  • 6.9.19. esFindInpVarByNameEx
  • 6.9.20. esFindOutpVarByName
  • 6.9.21. esFindOutpVarByNameEx
  • 6.9.22. esWriteSlaveRegister
  • 6.9.23. esReadSlaveRegister
  • 6.9.24. esReadSlaveEEPRom
  • 6.9.25. esWriteSlaveEEPRom
  • 6.9.26. esGetSimSlaveInfo
  • 6.9.27. esGetBusSlaveInfo
  • 6.9.28. esReadSlaveIdentification
  • 6.9.29. esGetSlaveStatistics
  • 6.9.30. esClearSlaveStatistics
• 6.10. ADS over EtherCAT (AoE)
  • 6.10.1. esAoeGetSlaveNetId
  • 6.10.2. esAoeRead
  • 6.10.3. esAoeWrite
  • 6.10.4. esAoeReadWrite
  • 6.10.5. esSetSlaveAoeObjectTransferCallbacks
  • 6.10.6. AoE Simulator and Master Example
• 6.11. CAN application protocol over EtherCAT (CoE)
  • 6.11.1. esExtendSlaveCoeObjectDictionary
  • 6.11.2. esDeleteSlaveCoeObject
  • 6.11.3. esClearSlaveCoeObjectDictionary
  • 6.11.4. esResetSlaveCoeObjectDictionary
  • 6.11.5. esSetSlaveCoeObjectTransferCallbacks
  • 6.11.6. esCoeSdoDownload
  • 6.11.7. esCoeSdoUpload
  • 6.11.8. esCoeGetODListReq
  • 6.11.9. esCoeGetObjectDescReq
  • 6.11.10. esCoeGetEntryDescReq
  • 6.11.11. CoE transfer Simulator and Master Example
• 6.12. Ethernet over EtherCAT (EoE)
  • 6.12.1. esEoeSendFrame
  • 6.12.2. esGetCfgSlaveEoeInfo
  • 6.12.3. EoE Ping Example
• 6.13. File access over EtherCAT (FoE)
• 6.14. Vendor specific access over EtherCAT (VoE)
  • 6.14.1. esVoeSend
  • 6.14.2. esSetVoeReceiveCallback
  • 6.14.3. VoE Receive Example
• 6.15. Distributed Clocks (DC)