JeVois  1.0
JeVois Smart Embedded Machine Vision Toolkit
jevois::Serial Class Reference

#include <jevois/Core/Serial.H>

Interface to a serial port.

This class is thread-safe. Concurrent read and write (which do not seem to be supported by the O.S. or hardware) are serialized through the use of a mutex in the Serial class.

Definition at line 76 of file Serial.H.

Inheritance diagram for jevois::Serial:
Collaboration diagram for jevois::Serial:

Public Member Functions

 Serial (std::string const &instance, UserInterface::Type type)
 Constructor. More...
 
virtual ~Serial ()
 destructor More...
 
void setBlocking (bool blocking, std::chrono::milliseconds const &timeout)
 Set the access to blocking or not. More...
 
void toggleDTR (std::chrono::milliseconds const &dur)
 Set the DTR mode off momentarily. More...
 
void sendBreak (void)
 transmit continuous stream of zero-valued bits for specific duration. More...
 
bool readSome (std::string &str) override
 Read some bytes if available, and return true and a string when one is complete. More...
 
std::string readString ()
 Read a string, using the line termination convention of serial::linestyle. More...
 
void writeString (std::string const &str) override
 Write a string, using the line termination convention of serial::linestyle. More...
 
int read (void *buffer, const int nbytes)
 Attempt to read up to nbytes from serial port into the buffer. More...
 
void write (void const *buffer, const int nbytes)
 Write bytes to the port. More...
 
void flush (void)
 Flush all inputs. More...
 
UserInterface::Type type () const override
 Return our port type, here Hard or USB. More...
 
- Public Member Functions inherited from jevois::UserInterface
 UserInterface (std::string const &instance)
 Constructor. More...
 
virtual ~UserInterface ()
 Destructor. More...
 
- Public Member Functions inherited from jevois::Component
 Component (std::string const &instance)
 Constructor. More...
 
virtual ~Component ()
 Virtual destructor for safe inheritance. More...
 
template<>
std::shared_ptr< ComponentgetSubComponent (std::string const &instance) const
 
template<class Comp , typename... Args>
std::shared_ptr< Comp > addSubComponent (std::string const &instance, Args &&...args)
 Pseudo-constructor: construct and add another component as a subcomponent of this one. More...
 
template<class Comp >
void removeSubComponent (std::shared_ptr< Comp > &component)
 Remove a sub-Component from this Component, by shared_ptr. More...
 
void removeSubComponent (std::string const &instance, bool warnIfNotFound=true)
 Remove a sub-Component from this Component, by instance name. More...
 
template<class Comp = jevois::Component>
std::shared_ptr< Comp > getSubComponent (std::string const &instance) const
 Get a sub-component by instance name. More...
 
bool isTopLevel () const
 Returns true if this component is top-level, i.e., its parent is jevois::Manager. More...
 
bool initialized () const
 Has this component been initialized yet? More...
 
std::string const & className () const
 The class name of this component. More...
 
std::string const & instanceName () const
 The instance name of this component. More...
 
template<typename T >
std::vector< std::string > setParamVal (std::string const &paramdescriptor, T const &val)
 Set a parameter value. More...
 
template<typename T >
void setParamValUnique (std::string const &paramdescriptor, T const &val)
 Set a parameter value, simple version assuming only one parameter match. More...
 
template<typename T >
std::vector< std::pair< std::string, T > > getParamVal (std::string const &paramdescriptor) const
 Get parameter(s) value(s) by descriptor. More...
 
template<typename T >
getParamValUnique (std::string const &paramdescriptor) const
 Get a parameter value, simple version assuming only one parameter match. More...
 
std::vector< std::string > setParamString (std::string const &paramdescriptor, std::string const &val)
 Set a parameter value, by string. More...
 
void setParamStringUnique (std::string const &paramdescriptor, std::string const &val)
 Set a parameter value by string, simple version assuming only one parameter match. More...
 
std::vector< std::pair< std::string, std::string > > getParamString (std::string const &paramdescriptor) const
 Get a parameter value, by string. More...
 
std::string getParamStringUnique (std::string const &paramdescriptor) const
 Get a parameter value by string, simple version assuming only one parameter match. More...
 
void freezeParam (std::string const &paramdescriptor)
 Freeze a parameter, by name, see ParameterBase::freeze() More...
 
void unFreezeParam (std::string const &paramdescriptor)
 Unfreeze a parameter, by name, see ParameterBase::unFreeze() More...
 
void freezeAllParams ()
 Freeze all parameters. More...
 
void unFreezeAllParams ()
 Unfreeze all parameters. More...
 
std::string descriptor () const
 Get our full descriptor (including all parents) as [Instancename]:[...]:[...]. More...
 
void setParamsFromFile (std::string const &filename)
 Set some parameters from a file. More...
 
std::istream & setParamsFromStream (std::istream &is, std::string const &absfile)
 Set some parameters from an open stream. More...
 
void setPath (std::string const &path)
 Assign a filesystem path to this component. More...
 
std::string absolutePath (std::string const &path="")
 If given path is relative (not starting with /), prepend the Component path to it. More...
 
- Public Member Functions inherited from jevois::ParameterRegistry
virtual ~ParameterRegistry ()
 Virtual destructor for safe inheritance. More...
 

Protected Member Functions

void postInit () override
 Called after all sub-Components are init()ed. More...
 
void postUninit () override
 Called after all sub-Components are uninit()ed. More...
 
- Protected Member Functions inherited from jevois::Component
virtual void preInit ()
 Called before all sub-Components are init()ed. More...
 
virtual void preUninit ()
 Called before all sub-Components are uninit()ed. More...
 
- Protected Member Functions inherited from jevois::ParameterRegistry
void addParameter (ParameterBase *const param)
 The Parameter class uses this method to register itself on construction with its owning Component. More...
 
void removeParameter (ParameterBase *const param)
 The Parameter class uses this method to un-register itself on destruction with its owning Component. More...
 
void callbackInitCall ()
 For all parameters that have a callback which has never been called, call it with the default param value. More...
 

Related Functions

(Note that these are not member functions.)

 JEVOIS_DECLARE_PARAMETER (devname, std::string,"Device file name","", ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (baudrate, unsigned int,"Baudrate", 115200,{110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200, 230400, 460800, 921600, 1000000, 1152000, 1500000, 2000000, 2500000, 3000000, 3500000, 4000000}, ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (format, std::string,"Data format","8N1", boost::regex("^[5-8][NEO][12]$"), ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (flowsoft, bool,"Use soft (XON/XOFF) flow control", false, ParamCateg)
 Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (flowhard, bool,"Use hard (RTS/CTS) flow control", false, ParamCateg)
 Parameter. More...
 
 JEVOIS_DEFINE_ENUM_CLASS (LineStyle,(LF)(CR)(CRLF)(Zero)(Sloppy))
 Enum for Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (linestyle, LineStyle,"End of line style: LF is for 0x0a [\\n] CR is for 0x0d [\\r] ""CRLF is for 0x0d 0x0a [\\r\\n] Zero is for 0x00 [\\0] Sloppy accepts any of ""CR, LF, CRLF, 0xd0 (issued by some keyboards instead of Return), and Zero as input ""and issues CRLF in outputs.", LineStyle::Sloppy, LineStyle_Values, ParamCateg)
 Parameter. More...
 
 JEVOIS_DEFINE_ENUM_CLASS (TerminalMode,(Plain)(VT100))
 Enum for Parameter. More...
 
 JEVOIS_DECLARE_PARAMETER (mode, TerminalMode,"Terminal emulation mode for input", TerminalMode::Plain, TerminalMode_Values, ParamCateg)
 Parameter. More...
 

Additional Inherited Members

- Public Types inherited from jevois::UserInterface
enum  Type { Type::Hard, Type::USB, Type::Stdio }
 Enum for the interface type. More...
 

Constructor & Destructor Documentation

jevois::Serial::Serial ( std::string const &  instance,
UserInterface::Type  type 
)

Constructor.

Definition at line 26 of file Serial.C.

jevois::Serial::~Serial ( void  )
virtual

destructor

Definition at line 380 of file Serial.C.

Member Function Documentation

void jevois::Serial::flush ( void  )

Flush all inputs.

Definition at line 371 of file Serial.C.

References LDEBUG.

void jevois::Serial::postInit ( )
overrideprotectedvirtual

Called after all sub-Components are init()ed.

Reimplemented from jevois::Component.

Definition at line 31 of file Serial.C.

References LFATAL, and LINFO.

void jevois::Serial::postUninit ( )
overrideprotectedvirtual

Called after all sub-Components are uninit()ed.

Reimplemented from jevois::Component.

Definition at line 155 of file Serial.C.

References LERROR.

int jevois::Serial::read ( void *  buffer,
const int  nbytes 
)

Attempt to read up to nbytes from serial port into the buffer.

Parameters
bufferholds bytes after read
nbytesnumber of bytes to attempt to read
Returns
0 on a timeout, -1 on error, number of bytes actually read on a success

Definition at line 216 of file Serial.C.

bool jevois::Serial::readSome ( std::string &  str)
overridevirtual

Read some bytes if available, and return true and a string when one is complete.

This would usually only make sense to use in non-blocking mode.

Implements jevois::UserInterface.

Definition at line 228 of file Serial.C.

std::string jevois::Serial::readString ( )

Read a string, using the line termination convention of serial::linestyle.

No line terminator is included in the read string that is returned. This would normally only make sense to use when the port is in blocking mode, as it throws if trying to chars until the end of line marker but none is available.

Definition at line 281 of file Serial.C.

void jevois::Serial::sendBreak ( void  )

transmit continuous stream of zero-valued bits for specific duration.

Definition at line 207 of file Serial.C.

void jevois::Serial::setBlocking ( bool  blocking,
std::chrono::milliseconds const &  timeout 
)

Set the access to blocking or not.

Default is non-blocking. If blocking, can also specify a timeout (rounded to tenth of seconds)

Definition at line 167 of file Serial.C.

References LFATAL.

void jevois::Serial::toggleDTR ( std::chrono::milliseconds const &  dur)

Set the DTR mode off momentarily.

Definition at line 188 of file Serial.C.

References LFATAL.

jevois::UserInterface::Type jevois::Serial::type ( ) const
overridevirtual

Return our port type, here Hard or USB.

Implements jevois::UserInterface.

Definition at line 384 of file Serial.C.

void jevois::Serial::write ( void const *  buffer,
const int  nbytes 
)

Write bytes to the port.

Parameters
bufferbegin writing from the location buffer.
nbytesnumber of bytes to write

Definition at line 337 of file Serial.C.

void jevois::Serial::writeString ( std::string const &  str)
overridevirtual

Write a string, using the line termination convention of serial::linestyle.

No line terminator should be included in the string, writeString() will add one.

Implements jevois::UserInterface.

Definition at line 320 of file Serial.C.

Friends And Related Function Documentation

JEVOIS_DECLARE_PARAMETER ( devname  ,
std::string  ,
"Device file name"  ,
""  ,
ParamCateg   
)
related
JEVOIS_DECLARE_PARAMETER ( baudrate  ,
unsigned  int,
"Baudrate"  ,
115200  ,
{110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200, 230400, 460800, 921600, 1000000, 1152000, 1500000, 2000000, 2500000, 3000000, 3500000, 4000000}  ,
ParamCateg   
)
related
JEVOIS_DECLARE_PARAMETER ( format  ,
std::string  ,
"Data format"  ,
"8N1"  ,
boost::  regex"^[5-8][NEO][12]$",
ParamCateg   
)
related
JEVOIS_DECLARE_PARAMETER ( flowsoft  ,
bool  ,
"Use soft (XON/XOFF) flow control"  ,
false  ,
ParamCateg   
)
related
JEVOIS_DECLARE_PARAMETER ( flowhard  ,
bool  ,
"Use hard (RTS/CTS) flow control"  ,
false  ,
ParamCateg   
)
related
JEVOIS_DECLARE_PARAMETER ( linestyle  ,
LineStyle  ,
"End of line style: LF is for 0x0a CR is for 0x0d ""CRLF is for 0x0d 0x0a Zero is for 0x00 Sloppy accepts any of ""  CR[\\n][\\r][\\r\\n][\\0],
LF  ,
CRLF  ,
0xd0(issued by some keyboards instead of Return)  ,
and Zero as input""and issues CRLF in outputs."  ,
LineStyle::Sloppy  ,
LineStyle_Values  ,
ParamCateg   
)
related
JEVOIS_DECLARE_PARAMETER ( mode  ,
TerminalMode  ,
"Terminal emulation mode for input"  ,
TerminalMode::Plain  ,
TerminalMode_Values  ,
ParamCateg   
)
related
JEVOIS_DEFINE_ENUM_CLASS ( LineStyle  ,
(LF)(CR)(CRLF)(Zero)(Sloppy)   
)
related

Enum for Parameter.

JEVOIS_DEFINE_ENUM_CLASS ( TerminalMode  ,
(Plain)(VT100)   
)
related

Enum for Parameter.


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