JeVois
1.20
JeVois Smart Embedded Machine Vision Toolkit
|
|
#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.
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... | |
void | writeString (std::string const &str) override |
Write a string, using the line termination convention of serial::linestyle. More... | |
void | fileGet (std::string const &abspath) |
Send a file from the local microSD to the host computer. More... | |
void | filePut (std::string const &abspath) |
Receive a file from the host and write it to the local microSD. More... | |
void | flush (void) |
Flush all inputs. More... | |
UserInterface::Type | type () const override |
Return our port type, here Hard or USB. More... | |
![]() | |
UserInterface (std::string const &instance) | |
Constructor. More... | |
virtual | ~UserInterface () |
Destructor. More... | |
virtual void | writeString (std::string const &prefix, std::string const &str) |
Write a string, with a prefix prepended. More... | |
![]() | |
Component (std::string const &instance) | |
Constructor. More... | |
virtual | ~Component () |
Virtual destructor for safe inheritance. More... | |
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... | |
Engine * | engine () const |
Get a handle to our Engine, or throw if we do not have an Engine as root ancestor. More... | |
bool | initialized () const |
Has this component been initialized yet? More... | |
const std::string & | className () const |
The class name of this component. More... | |
const std::string & | instanceName () const |
The instance name of this component. More... | |
template<typename T > | |
std::vector< std::string > | setParamVal (std::string const ¶mdescriptor, T const &val) |
Set a parameter value. More... | |
template<typename T > | |
void | setParamValUnique (std::string const ¶mdescriptor, 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 ¶mdescriptor) const |
Get parameter(s) value(s) by descriptor. More... | |
template<typename T > | |
T | getParamValUnique (std::string const ¶mdescriptor) const |
Get a parameter value, simple version assuming only one parameter match. More... | |
std::vector< std::string > | setParamString (std::string const ¶mdescriptor, std::string const &val) |
Set a parameter value, by string. More... | |
void | setParamStringUnique (std::string const ¶mdescriptor, 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 ¶mdescriptor) const |
Get a parameter value, by string. More... | |
std::string | getParamStringUnique (std::string const ¶mdescriptor) const |
Get a parameter value by string, simple version assuming only one parameter match. More... | |
void | freezeParam (std::string const ¶mdescriptor) |
Freeze a parameter, by name, see ParameterBase::freeze() More... | |
void | unFreezeParam (std::string const ¶mdescriptor) |
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... | |
virtual void | paramInfo (std::shared_ptr< UserInterface > s, std::map< std::string, std::string > &categs, bool skipFrozen, std::string const &cname="", std::string const &pfx="") |
Get machine-oriented descriptions of all parameters. More... | |
void | foreachParam (std::function< void(std::string const &compname, ParameterBase *p)> func, std::string const &cname="") |
Run a function on every param we hold. More... | |
template<typename T > | |
std::shared_ptr< DynamicParameter< T > > | addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ParameterCategory const &category) |
Add a new parameter after the Component has already been constructed. More... | |
template<typename T , template< typename > class ValidValuesSpec> | |
std::shared_ptr< DynamicParameter< T > > | addDynamicParameter (std::string const &name, std::string const &description, T const &defaultValue, ValidValuesSpec< T > const &validValuesSpec, ParameterCategory const &category) |
Add a new parameter after the Component has already been constructed. More... | |
template<typename T > | |
void | setDynamicParameterCallback (std::string const &name, std::function< void(T const &)> cb, bool callnow=true) |
Register a callback with a previously created dynamic parameter. More... | |
void | removeDynamicParameter (std::string const &name) |
Remove a previously added dynamic parameter. More... | |
void | setPath (std::string const &path) |
Assign a filesystem path to this component. More... | |
std::filesystem::path | absolutePath (std::filesystem::path const &path="") |
If given path is relative (not starting with /), prepend the Component path to it. More... | |
![]() | |
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... | |
![]() | |
virtual void | preInit () |
Called before all sub-Components are init()ed. More... | |
virtual void | preUninit () |
Called before all sub-Components are uninit()ed. More... | |
![]() | |
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_DECLARE_PARAMETER (drop, bool, "Silently drop write data when write buffer is full. Useful to " "avoid blocking when writing messages to serial-over-USB port and the host is " "not listening to it. Note that even when drop is false, we will still drop " "data after repeated attempts to send it, and will report an error (as opposed to " "silently dropping when drop is true).", true, 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 | |
![]() | |
enum | Type { Type::Hard, Type::USB, Type::Stdio, Type::GUI } |
Enum for the interface type. More... | |
jevois::Serial::Serial | ( | std::string const & | instance, |
UserInterface::Type | type | ||
) |
void jevois::Serial::fileGet | ( | std::string const & | abspath | ) |
Send a file from the local microSD to the host computer.
abspath should be the full absolute path of the file. The port will be locked during the entire transaction.
Definition at line 419 of file Serial.C.
References jevois::to_string().
Referenced by jevois::Engine::parseCommand().
void jevois::Serial::filePut | ( | std::string const & | abspath | ) |
Receive a file from the host and write it to the local microSD.
abspath should be the full absolute path of the file. The port will be locked during the entire transaction.
Definition at line 443 of file Serial.C.
References jevois::split(), and jevois::stringStartsWith().
Referenced by jevois::Engine::parseCommand().
void jevois::Serial::flush | ( | void | ) |
|
overrideprotectedvirtual |
Called after all sub-Components are init()ed.
Reimplemented from jevois::Component.
|
overrideprotectedvirtual |
Called after all sub-Components are uninit()ed.
Reimplemented from jevois::Component.
Definition at line 200 of file Serial.C.
References LERROR.
|
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 262 of file Serial.C.
References jevois::imu::get(), and SERFATAL.
void jevois::Serial::sendBreak | ( | void | ) |
void jevois::Serial::setBlocking | ( | bool | blocking, |
std::chrono::milliseconds const & | timeout | ||
) |
void jevois::Serial::toggleDTR | ( | std::chrono::milliseconds const & | dur | ) |
|
overridevirtual |
Return our port type, here Hard or USB.
Implements jevois::UserInterface.
|
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 316 of file Serial.C.
References jevois::imu::get().
|
related |
Parameter.
|
related |
Parameter.
|
related |
Parameter.
|
related |
Parameter.
|
related |
Parameter.
|
related |
Parameter.
|
related |
Parameter.
|
related |
Parameter.
|
related |
Enum for Parameter.
|
related |
Enum for Parameter.