fsm_slave_scan.h File Reference

EtherCAT slave scanning state machine. More...

Go to the source code of this file.

Data Structures
struct	ec_fsm_slave_scan
	Finite state machine for scanning an EtherCAT slave. More...

Typedefs
typedef struct ec_fsm_slave_scan	ec_fsm_slave_scan_t

Functions
void	ec_fsm_slave_scan_init (ec_fsm_slave_scan_t *, ec_datagram_t *, ec_fsm_slave_config_t *, ec_fsm_pdo_t *)
	Constructor.
void	ec_fsm_slave_scan_clear (ec_fsm_slave_scan_t *)
	Destructor.
void	ec_fsm_slave_scan_start (ec_fsm_slave_scan_t *, ec_slave_t *)
	Start slave scan state machine.
int	ec_fsm_slave_scan_exec (ec_fsm_slave_scan_t *)
	Executes the current state of the state machine.
int	ec_fsm_slave_scan_success (const ec_fsm_slave_scan_t *)

Detailed Description

EtherCAT slave scanning state machine.

Definition in file fsm_slave_scan.h.

Typedef Documentation

ec_fsm_slave_scan_t

typedef struct ec_fsm_slave_scan ec_fsm_slave_scan_t

See also

ec_fsm_slave_scan

Definition at line 43 of file fsm_slave_scan.h.

Function Documentation

ec_fsm_slave_scan_init()

void ec_fsm_slave_scan_init	(	ec_fsm_slave_scan_t *	fsm,
		ec_datagram_t *	datagram,
		ec_fsm_slave_config_t *	fsm_slave_config,
		ec_fsm_pdo_t *	fsm_pdo )

Constructor.

Parameters

fsm	Slave scanning state machine.
datagram	Datagram to use.
fsm_slave_config	Slave configuration state machine to use.
fsm_pdo	PDO configuration machine to use.

Definition at line 77 of file fsm_slave_scan.c.

ec_fsm_slave_scan_clear()

void ec_fsm_slave_scan_clear

(

ec_fsm_slave_scan_t *

fsm

)

Destructor.

Parameters

fsm	slave state machine

Definition at line 97 of file fsm_slave_scan.c.

ec_fsm_slave_scan_start()

void ec_fsm_slave_scan_start	(	ec_fsm_slave_scan_t *	fsm,
		ec_slave_t *	slave )

Start slave scan state machine.

Parameters

fsm	slave state machine
slave	slave to configure

Definition at line 109 of file fsm_slave_scan.c.

ec_fsm_slave_scan_exec()

int ec_fsm_slave_scan_exec

(

ec_fsm_slave_scan_t *

fsm

)

Executes the current state of the state machine.

If the state machine's datagram is not sent or received yet, the execution of the state machine is delayed to the next cycle.

Returns

false, if state machine has terminated

Parameters

fsm	slave state machine

Definition at line 141 of file fsm_slave_scan.c.

ec_fsm_slave_scan_success()

int ec_fsm_slave_scan_success

(

const ec_fsm_slave_scan_t *

fsm

)

Returns

true, if the state machine terminated gracefully

Parameters

fsm	slave state machine

Definition at line 159 of file fsm_slave_scan.c.