AB&T / SOEM

Dependents:   EasyCAT_LAB_simple EasyCAT_LAB_very_simple EasyCAT_LAB

Embed: (wiki syntax)

« Back to documentation index

ethercatfoe.c File Reference

ethercatfoe.c File Reference

File over EtherCAT (FoE) module. More...

Go to the source code of this file.

Typedefs

typedef PACKED_BEGIN struct PACKED ec_FOEt
 FOE structure.

Functions

PACKED_END int ecx_FOEdefinehook (ecx_contextt *context, void *hook)
 FoE progress hook.
int ecx_FOEread (ecx_contextt *context, uint16 slave, char *filename, uint32 password, int *psize, void *p, int timeout)
 FoE read, blocking.
int ecx_FOEwrite (ecx_contextt *context, uint16 slave, char *filename, uint32 password, int psize, void *p, int timeout)
 FoE write, blocking.

Detailed Description

File over EtherCAT (FoE) module.

SDO read / write and SDO service functions

Definition in file ethercatfoe.c.


Typedef Documentation

typedef PACKED_BEGIN struct PACKED ec_FOEt

FOE structure.

Used for Read, Write, Data, Ack and Error mailbox packets.


Function Documentation

PACKED_END int ecx_FOEdefinehook ( ecx_contextt context,
void *  hook 
)

FoE progress hook.

Parameters:
[in]context= context struct
[in]hook= Pointer to hook function.
Returns:
1

Definition at line 54 of file ethercatfoe.c.

int ecx_FOEread ( ecx_contextt context,
uint16  slave,
char *  filename,
uint32  password,
int *  psize,
void *  p,
int  timeout 
)

FoE read, blocking.

Parameters:
[in]context= context struct
[in]slave= Slave number.
[in]filename= Filename of file to read.
[in]password= password.
[in,out]psize= Size in bytes of file buffer, returns bytes read from file.
[out]p= Pointer to file buffer
[in]timeout= Timeout per mailbox cycle in us, standard is EC_TIMEOUTRXM
Returns:
Workcounter from last slave response

Definition at line 71 of file ethercatfoe.c.

int ecx_FOEwrite ( ecx_contextt context,
uint16  slave,
char *  filename,
uint32  password,
int  psize,
void *  p,
int  timeout 
)

FoE write, blocking.

Parameters:
[in]context= context struct
[in]slave= Slave number.
[in]filename= Filename of file to write.
[in]password= password.
[in]psize= Size in bytes of file buffer.
[out]p= Pointer to file buffer
[in]timeout= Timeout per mailbox cycle in us, standard is EC_TIMEOUTRXM
Returns:
Workcounter from last slave response

Definition at line 199 of file ethercatfoe.c.