AB&T / SOEM

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   EasyCAT_LAB_simple EasyCAT_LAB_very_simple EasyCAT_LAB

Embed: (wiki syntax)

« Back to documentation index

ethercatconfig.h File Reference
Functions

ethercatconfig.h File Reference

Headerfile for ethercatconfig.c. More...

Go to the source code of this file.

Functions

int ec_config_init (uint8 usetable)
 Enumerate and init all slaves.
int ec_config_map (void *pIOmap)
 Map all PDOs from slaves to IOmap with Outputs/Inputs in sequential order (legacy SOEM way).
int ec_config_overlap_map (void *pIOmap)
 Map all PDOs from slaves to IOmap with Outputs/Inputs overlapping.
int ec_config_map_group (void *pIOmap, uint8 group)
 Map all PDOs in one group of slaves to IOmap with Outputs/Inputs in sequential order (legacy SOEM way).
int ec_config_overlap_map_group (void *pIOmap, uint8 group)
 Map all PDOs in one group of slaves to IOmap with Outputs/Inputs overlapping.
int ec_config (uint8 usetable, void *pIOmap)
 Enumerate / map and init all slaves.
int ec_config_overlap (uint8 usetable, void *pIOmap)
 Enumerate / map and init all slaves.
int ec_recover_slave (uint16 slave, int timeout)
 Recover slave.
int ec_reconfig_slave (uint16 slave, int timeout)
 Reconfigure slave.
int ecx_config_init (ecx_contextt *context, uint8 usetable)
 Enumerate and init all slaves.
int ecx_config_map_group (ecx_contextt *context, void *pIOmap, uint8 group)
 Map all PDOs in one group of slaves to IOmap with Outputs/Inputs in sequential order (legacy SOEM way).
int ecx_config_overlap_map_group (ecx_contextt *context, void *pIOmap, uint8 group)
 Map all PDOs in one group of slaves to IOmap with Outputs/Inputs overlapping.
int ecx_recover_slave (ecx_contextt *context, uint16 slave, int timeout)
 Recover slave.
int ecx_reconfig_slave (ecx_contextt *context, uint16 slave, int timeout)
 Reconfigure slave.

Detailed Description

Headerfile for ethercatconfig.c.

Definition in file ethercatconfig.h.

Function Documentation

int ec_config ( uint8  usetable,
void *  pIOmap 
)

Enumerate / map and init all slaves.

Parameters:
[in]usetable= TRUE when using configtable to init slaves, FALSE otherwise
[out]pIOmap= pointer to IOmap
Returns:
Workcounter of slave discover datagram = number of slaves found

Definition at line 1637 of file ethercatconfig.c.

int ec_config_init ( uint8  usetable )

Enumerate and init all slaves.

Parameters:
[in]usetable= TRUE when using configtable to init slaves, FALSE otherwise
Returns:
Workcounter of slave discover datagram = number of slaves found
See also:
ecx_config_init

Definition at line 1578 of file ethercatconfig.c.

int ec_config_map ( void *  pIOmap )

Map all PDOs from slaves to IOmap with Outputs/Inputs in sequential order (legacy SOEM way).

Parameters:
[out]pIOmap= pointer to IOmap
Returns:
IOmap size

Definition at line 1615 of file ethercatconfig.c.

int ec_config_map_group ( void *  pIOmap,
uint8  group 
)

Map all PDOs in one group of slaves to IOmap with Outputs/Inputs in sequential order (legacy SOEM way).

Parameters:
[out]pIOmap= pointer to IOmap
[in]group= group to map, 0 = all groups
Returns:
IOmap size
See also:
ecx_config_map_group

Definition at line 1591 of file ethercatconfig.c.

int ec_config_overlap ( uint8  usetable,
void *  pIOmap 
)

Enumerate / map and init all slaves.

Parameters:
[in]usetable= TRUE when using configtable to init slaves, FALSE otherwise
[out]pIOmap= pointer to IOmap
Returns:
Workcounter of slave discover datagram = number of slaves found

Definition at line 1654 of file ethercatconfig.c.

int ec_config_overlap_map ( void *  pIOmap )

Map all PDOs from slaves to IOmap with Outputs/Inputs overlapping.

NOTE: Must use this for TI ESC when using LRW.

Parameters:
[out]pIOmap= pointer to IOmap
Returns:
IOmap size

Definition at line 1626 of file ethercatconfig.c.

int ec_config_overlap_map_group ( void *  pIOmap,
uint8  group 
)

Map all PDOs in one group of slaves to IOmap with Outputs/Inputs overlapping.

NOTE: Must use this for TI ESC when using LRW.

Parameters:
[out]pIOmap= pointer to IOmap
[in]group= group to map, 0 = all groups
Returns:
IOmap size
See also:
ecx_config_overlap_map_group

Definition at line 1604 of file ethercatconfig.c.

int ec_reconfig_slave ( uint16  slave,
int  timeout 
)

Reconfigure slave.

Parameters:
[in]slave= slave to reconfigure
[in]timeout= local timeout f.e. EC_TIMEOUTRET3
Returns:
Slave state
See also:
ecx_reconfig_slave

Definition at line 1684 of file ethercatconfig.c.

int ec_recover_slave ( uint16  slave,
int  timeout 
)

Recover slave.

Parameters:
[in]slave= slave to recover
[in]timeout= local timeout f.e. EC_TIMEOUTRET3
Returns:
>0 if successful
See also:
ecx_recover_slave

Definition at line 1672 of file ethercatconfig.c.

int ecx_config_init ( ecx_contextt *  context,
uint8  usetable 
)

Enumerate and init all slaves.

Parameters:
[in]context= context struct
[in]usetable= TRUE when using configtable to init slaves, FALSE otherwise
Returns:
Workcounter of slave discover datagram = number of slaves found

Definition at line 308 of file ethercatconfig.c.

int ecx_config_map_group ( ecx_contextt *  context,
void *  pIOmap,
uint8  group 
)

Map all PDOs in one group of slaves to IOmap with Outputs/Inputs in sequential order (legacy SOEM way).

Parameters:
[in]context= context struct
[out]pIOmap= pointer to IOmap
[in]group= group to map, 0 = all groups
Returns:
IOmap size

Definition at line 1160 of file ethercatconfig.c.

int ecx_config_overlap_map_group ( ecx_contextt *  context,
void *  pIOmap,
uint8  group 
)

Map all PDOs in one group of slaves to IOmap with Outputs/Inputs overlapping.

NOTE: Must use this for TI ESC when using LRW.

Parameters:
[in]context= context struct
[out]pIOmap= pointer to IOmap
[in]group= group to map, 0 = all groups
Returns:
IOmap size

Definition at line 1330 of file ethercatconfig.c.

int ecx_reconfig_slave ( ecx_contextt *  context,
uint16  slave,
int  timeout 
)

Reconfigure slave.

Parameters:
[in]context= context struct
[in]slave= slave to reconfigure
[in]timeout= local timeout f.e. EC_TIMEOUTRET3
Returns:
Slave state

Definition at line 1523 of file ethercatconfig.c.

int ecx_recover_slave ( ecx_contextt *  context,
uint16  slave,
int  timeout 
)

Recover slave.

Parameters:
[in]context= context struct
[in]slave= slave to recover
[in]timeout= local timeout f.e. EC_TIMEOUTRET3
Returns:
>0 if successful

Definition at line 1460 of file ethercatconfig.c.

Generated on Tue Jul 12 2022 18:21:13 by  doxygen 1.7.2