EthercatHardware Class Reference

#include <ethercat_hardware.h>

Public Member Functions
void	collectDiagnostics ()
	Collects diagnotics from all devices.
	EthercatHardware (const std::string &name)
	Constructor.
void	init (char *interface, bool allow_unprogrammed)
	Initialize the EtherCAT Master Library.
void	printCounters (std::ostream &os=std::cout)
bool	publishTrace (int position, const string &reason, unsigned level, unsigned delay)
	Ask one or all EtherCAT devices to publish (motor) traces.
bool	txandrx_PD (unsigned buffer_size, unsigned char *buffer, unsigned tries)
	Send process data.
void	update (bool reset, bool halt)
	Send most recent motor commands and retrieve updates. This command must be run at a sufficient rate or else the motors will be disabled.
	~EthercatHardware ()
	Destructor.
Public Attributes
pr2_hardware_interface::HardwareInterface *	hw_
Private Member Functions
EthercatDevice *	configSlave (EtherCAT_SlaveHandler *sh)
void	publishDiagnostics ()
	Collects raw diagnostics data and passes it to diagnostics_publisher.
Static Private Member Functions
static void	changeState (EtherCAT_SlaveHandler *sh, EC_State new_state)
static void	updateAccMax (double &max, const accumulator_set< double, stats< tag::max, tag::mean > > &acc)
Private Attributes
EtherCAT_AL *	al_
unsigned int	buffer_size_
unsigned char *	buffers_
pluginlib::ClassLoader < EthercatDevice >	device_loader_
EthercatHardwareDiagnostics	diagnostics_
EthercatHardwareDiagnosticsPublisher	diagnostics_publisher_
EtherCAT_Master *	em_
bool	halt_motors_
string	interface_
ros::Time	last_published_
ros::Time	last_reset_
unsigned	max_pd_retries_
	Max number of times to retry sending process data before halting motors.
ros::Time	motor_last_published_
realtime_tools::RealtimePublisher < std_msgs::Bool >	motor_publisher_
struct netif *	ni_
ros::NodeHandle	node_
unsigned int	num_slaves_
EthercatOobCom *	oob_com_
unsigned char *	prev_buffer_
unsigned int	reset_state_
EthercatDevice **	slaves_
unsigned char *	this_buffer_
unsigned	timeout_
	Timeout (in microseconds) to used for sending/recieving packets once in realtime mode.

Detailed Description

Definition at line 198 of file ethercat_hardware.h.

Constructor & Destructor Documentation

EthercatHardware::EthercatHardware ( const std::string & name )

Constructor.

Definition at line 66 of file ethercat_hardware.cpp.

EthercatHardware::~EthercatHardware ( )

Destructor.

Definition at line 77 of file ethercat_hardware.cpp.

Member Function Documentation

void EthercatHardware::changeState	(	EtherCAT_SlaveHandler *	sh,
		EC_State	new_state
	)			`[static, private]`

Definition at line 102 of file ethercat_hardware.cpp.

void EthercatHardware::collectDiagnostics ( )

Collects diagnotics from all devices.

Definition at line 729 of file ethercat_hardware.cpp.

EthercatDevice * EthercatHardware::configSlave ( EtherCAT_SlaveHandler * sh ) [private]

Definition at line 693 of file ethercat_hardware.cpp.

void EthercatHardware::init	(	char *	interface,
		bool	allow_unprogrammed
	)

Initialize the EtherCAT Master Library.

Parameters:

	interface	The socket interface that is connected to the EtherCAT devices (e.g., eth0)
	allow_unprogrammed	A boolean indicating if the driver should treat the discovery of unprogrammed boards as a fatal error. Set to 'true' during board configuration, and set to 'false' otherwise.

Definition at line 119 of file ethercat_hardware.cpp.

void EthercatHardware::printCounters ( std::ostream & os = std::cout )

Definition at line 764 of file ethercat_hardware.cpp.

void EthercatHardware::publishDiagnostics ( ) [private]

Collects raw diagnostics data and passes it to diagnostics_publisher.

Definition at line 666 of file ethercat_hardware.cpp.

bool EthercatHardware::publishTrace	(	int	position,
		const string &	reason,
		unsigned	level,
		unsigned	delay
	)

Ask one or all EtherCAT devices to publish (motor) traces.

Parameters:

	position	device ring position to publish trace for. Use -1 to trigger all devices.
	reason	Message to put in trace as reason.
	level	Level to put in trace (aka ERROR=2, WARN=1, OK=0)
	delay	Publish trace after delay cyles. For 1kHz realtime loop 1cycle = 1ms.

Returns:: Return true if device supports publishing trace. False, if not. If all devices are triggered, returns true if any device publishes trace.

Definition at line 806 of file ethercat_hardware.cpp.