Basic Functions

Overview

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

Functions
void	EC_API_SLV_SSC_setLicense (char *pLicense_p, uint8_t length_p)
	Enter license key to run the unlimited version. More...
uint32_t	EC_API_SLV_getVersionStr (uint32_t bufLen_p, char *pBuffer_p, uint32_t *pUsedLen_p)
	Get version string. More...
uint32_t	EC_API_SLV_getVersionId (uint32_t bufLen_p, char *pBuffer_p, uint32_t *pUsedLen_p)
	Get Version Id (Shasum) More...
uint32_t	EC_API_SLV_stackInit (void)
	This is the function to initialize Stack backend. More...
EC_API_SLV_SHandle_t *	EC_API_SLV_new (void)
	This is the function to create a new EtherCAT Slave device instance. More...
uint32_t	EC_API_SLV_delete (EC_API_SLV_SHandle_t *pEcSlaveApi_p)
	This is the function to delete a created adapter. More...
uint32_t	EC_API_SLV_init (EC_API_SLV_SHandle_t *pEcSlaveApi_p)
	This is the function to initialize the EtherCAT Slave API. More...
uint32_t	EC_API_SLV_run (EC_API_SLV_SHandle_t *pEcSlaveApi_p)
	This is the function to run the EtherCAT Slave API. More...
uint32_t	EC_API_SLV_stop (EC_API_SLV_SHandle_t *pEcSlaveApi_p)
	This is the function to stop the EtherCAT Slave API. More...
uint32_t	EC_API_SLV_reset (EC_API_SLV_SHandle_t *pEcSlaveApi_p)
	Reset configuration to default values. More...
uint32_t	EC_API_SLV_getConfigStatus (EC_API_SLV_SHandle_t *pEcSlaveApi_p)
	This function reads the EtherCAT driver status. More...
uint32_t	EC_API_SLV_getCyclicStatus (EC_API_SLV_SHandle_t *pEcSlaveApi_p)
	This function reads if there is any error cyclic communication error. More...
EC_API_SLV_EEsmState_t	EC_API_SLV_getState (void)
	This is the function to read the EtherCAT Slave state machine. More...
uint32_t	EC_API_SLV_setState (EC_API_SLV_SHandle_t *pEcSlaveApi_p, EC_API_SLV_EEsmState_t state_p)
	This is the function to request a EtherCAT state. More...
uint32_t	EC_API_SLV_setStationAlias (EC_API_SLV_SHandle_t *pEcSlaveApi_p, uint16_t stationAlias_p)
	This is the function to set station alias. More...
uint8_t	EC_API_SLV_readByteEscRegister (EC_API_SLV_SHandle_t *pEcSlaveApi_p, uint16_t escAddress_p)
	This is the function reads a byte from ESC Register. More...
uint16_t	EC_API_SLV_readWordEscRegister (EC_API_SLV_SHandle_t *pEcSlaveApi_p, uint16_t escAddress_p)
	This is the function reads a byte from ESC Register. More...
uint32_t	EC_API_SLV_readDoubleWordEscRegister (EC_API_SLV_SHandle_t *pEcSlaveApi_p, uint16_t escAddress_p)
	This is the function reads a byte from ESC Register. More...
void	EC_API_SLV_writeByteEscRegister (EC_API_SLV_SHandle_t *pEcSlaveApi_p, uint16_t escAddress_p, uint8_t value_p)
void	EC_API_SLV_writeWordEscRegister (EC_API_SLV_SHandle_t *pEcSlaveApi_p, uint16_t escAddress_p, uint16_t value_p)
void	EC_API_SLV_writeDoubleWordEscRegister (EC_API_SLV_SHandle_t *pEcSlaveApi_p, uint16_t escAddress_p, uint32_t value_p)
void	EC_API_SLV_mainLoopCyclic (void)
	Trigger stack mainloop. More...
void	EC_API_SLV_cbRegisterErrorHandler (EC_API_SLV_SHandle_t *pEcSlaveApi_p, void *pContext_p, EC_API_SLV_CBStackError_t cbFunc_p)
uint32_t	EC_API_SLV_setErrorRegister (EC_API_SLV_SHandle_t *pEcSlaveApi_p, EC_API_SLV_EErrorRegister_t errorRegister_p)
	Error register value defined in ETG1000.6 Error Register Table. More...