ff_serial::Serial Class Reference

#include <serial.h>

Inheritance diagram for ff_serial::Serial:

Public Member Functions
	Serial (SerialReadCallback cb_read)
void	SetTimeoutCallback (SerialTimeoutCallback cb, uint32_t ms=1000)
void	SetShutdownCallback (SerialShutdownCallback cb)
virtual	~Serial ()
bool	Open (const std::string &port_name, unsigned int baud_rate, boost::asio::serial_port_base::parity option_parity=boost::asio::serial_port_base::parity(boost::asio::serial_port_base::parity::none), boost::asio::serial_port_base::character_size option_csize=boost::asio::serial_port_base::character_size(8), boost::asio::serial_port_base::flow_control option_flow=boost::asio::serial_port_base::flow_control(boost::asio::serial_port_base::flow_control::none), boost::asio::serial_port_base::stop_bits option_stop=boost::asio::serial_port_base::stop_bits(boost::asio::serial_port_base::stop_bits::one))
bool	IsOpen ()
void	Close ()
size_t	Write (const uint8_t *data, size_t size)
void	SetResetPinState (SerialResetPinState state)

Protected Member Functions
void	ReadStart ()
void	ReadStop (const boost::system::error_code &error, size_t bytes)
void	TimeoutCallback (const boost::system::error_code &error)

Constructor & Destructor Documentation

Serial()

ff_serial::Serial::Serial ( SerialReadCallback  cb_read )

explicit

~Serial()

ff_serial::Serial::~Serial ( )

virtual

Member Function Documentation

Close()

void ff_serial::Serial::Close

(

)

IsOpen()

bool ff_serial::Serial::IsOpen

(

)

Open()

bool ff_serial::Serial::Open	(	const std::string &	port_name,
		unsigned int	baud_rate,
		boost::asio::serial_port_base::parity	option_parity = boost::asio::serial_port_base::parity(            boost::asio::serial_port_base::parity::none),
		boost::asio::serial_port_base::character_size	option_csize = boost::asio::serial_port_base::character_size(8),
		boost::asio::serial_port_base::flow_control	option_flow = boost::asio::serial_port_base::flow_control(            boost::asio::serial_port_base::flow_control::none),
		boost::asio::serial_port_base::stop_bits	option_stop = boost::asio::serial_port_base::stop_bits(            boost::asio::serial_port_base::stop_bits::one)
	)

ReadStart()

void ff_serial::Serial::ReadStart ( )

protected

ReadStop()

void ff_serial::Serial::ReadStop ( const boost::system::error_code &  error, size_t  bytes  )

protected

SetResetPinState()

void ff_serial::Serial::SetResetPinState

(

SerialResetPinState

state

)

SetShutdownCallback()

void ff_serial::Serial::SetShutdownCallback

(

SerialShutdownCallback

cb

)

SetTimeoutCallback()

void ff_serial::Serial::SetTimeoutCallback	(	SerialTimeoutCallback	cb,
		uint32_t	ms = 1000
	)

TimeoutCallback()

void ff_serial::Serial::TimeoutCallback ( const boost::system::error_code &  error )

protected

Write()

size_t ff_serial::Serial::Write	(	const uint8_t *	data,
		size_t	size
	)

---

The documentation for this class was generated from the following files:

• hardware/ff_serial/include/ff_serial/serial.h
• hardware/ff_serial/src/serial.cc