Basic Functions

Overview

The basic API functions cover general functionality such as creating, initializing, starting, and deleting an EtherCAT subdevice object. The subdevice object is a required input parameter for all other subdevice API functions. Also supported are API functions to retrieve the subdevice status and to register status and error handler callback functions.

Functions
uint32_t	EC_API_SLV_getVersion (EC_API_SLV_SHandle_t *pHandle, uint32_t *pVersion)
	Get Stack Library Version.
uint32_t	EC_API_SLV_getVersionStr (EC_API_SLV_SHandle_t *pHandle, uint32_t bufLen, char *pBuffer, uint32_t *pUsedLen)
	Get version string.
uint32_t	EC_API_SLV_getVersionId (EC_API_SLV_SHandle_t *pHandle, uint32_t bufLen, char *pBuffer, uint32_t *pUsedLen)
	Get Version Id (Shasum)
uint32_t	EC_API_SLV_stackInit (void)
	This is the function to initialize Stack backend.
EC_API_SLV_SHandle_t *	EC_API_SLV_new (void)
	This is the function to create a new EtherCAT Slave device instance.
uint32_t	EC_API_SLV_delete (EC_API_SLV_SHandle_t *pHandle)
	This is the function to delete a created adapter.
uint32_t	EC_API_SLV_init (EC_API_SLV_SHandle_t *pHandle)
	This is the function to initialize the EtherCAT Slave API.
uint32_t	EC_API_SLV_run (EC_API_SLV_SHandle_t *pHandle)
	This is the function to run the EtherCAT Slave API.
uint32_t	EC_API_SLV_stop (EC_API_SLV_SHandle_t *pHandle)
	This is the function to stop the EtherCAT Slave API.
uint32_t	EC_API_SLV_reset (EC_API_SLV_SHandle_t *pHandle)
	Reset configuration to default values.
uint32_t	EC_API_SLV_getConfigStatus (EC_API_SLV_SHandle_t *pHandle)
	This function reads the EtherCAT driver status.
uint32_t	EC_API_SLV_getCyclicStatus (EC_API_SLV_SHandle_t *pHandle)
	This function reads if there is any error cyclic communication error.
uint32_t	EC_API_SLV_getState (EC_API_SLV_SHandle_t *pHandle, EC_API_SLV_EEsmState_t *pState, uint16_t *pAlErrorCode)
	This is the function to read the EtherCAT Slave state machine.
uint32_t	EC_API_SLV_setState (EC_API_SLV_SHandle_t *pHandle, EC_API_SLV_EEsmState_t state, uint16_t alErrorCode)
	This is the function to request a EtherCAT state.
uint32_t	EC_API_SLV_setStationAlias (EC_API_SLV_SHandle_t *pHandle, uint16_t stationAlias)
	This is the function to set station alias.
uint32_t	EC_API_SLV_setExplicitDeviceId (EC_API_SLV_SHandle_t *pHandle, uint16_t deviceId)
	Set the explicit device Id of EtherCAT.
uint32_t	EC_API_SLV_getExplicitDeviceId (EC_API_SLV_SHandle_t *pHandle, uint16_t *deviceId)
	Get the explicit device Id of EtherCAT.
uint32_t	EC_API_SLV_readByteEscRegister (EC_API_SLV_SHandle_t *pHandle, uint16_t escAddress, uint8_t *pValue)
	This is the function reads a byte from ESC Register.
uint32_t	EC_API_SLV_readWordEscRegister (EC_API_SLV_SHandle_t *pHandle, uint16_t escAddress, uint16_t *pValue)
	This is the function reads a byte from ESC Register.
uint32_t	EC_API_SLV_readDoubleWordEscRegister (EC_API_SLV_SHandle_t *pHandle, uint16_t escAddress, uint32_t *pValue)
	This is the function reads a byte from ESC Register.
uint32_t	EC_API_SLV_writeByteEscRegister (EC_API_SLV_SHandle_t *pHandle, uint16_t escAddress, uint8_t value)
	Write to virtual ESC register.
uint32_t	EC_API_SLV_writeWordEscRegister (EC_API_SLV_SHandle_t *pHandle, uint16_t escAddress, uint16_t value)
	Write to virtual ESC register.
uint32_t	EC_API_SLV_writeDoubleWordEscRegister (EC_API_SLV_SHandle_t *pHandle, uint16_t escAddress, uint32_t value)
	Write to ESC register.
uint32_t	EC_API_SLV_mainLoopCyclic (void)
	Trigger stack mainloop.
uint32_t	EC_API_SLV_cbRegisterErrorHandler (EC_API_SLV_SHandle_t *pHandle, EC_API_SLV_CBStackError_t cbFunc, void *pContext)
	Register Error callback handler.
uint32_t	EC_API_SLV_enableMdioManualMode (EC_API_SLV_SHandle_t *pHandle, uint32_t manualMdioAddress, uint32_t firmwareConfig)
	Enable mdio manual mode (TI workaround enable)
uint32_t	EC_API_SLV_cbRegisterMeasurement (EC_API_SLV_SHandle_t *pHandle, EC_API_SLV_CBMsrmt_t cbFunc, void *pContext)
	Register measurement callback.