Public Member Functions | |
| void | fetch (const std::chrono::milliseconds &timeout) |
| wait for data and process it More... | |
| virtual void | write (const std::string &data)=0 |
| raw write some bytes More... | |
| virtual grbl::ErrorCode | send (const std::string &cmd, std::function< bool(const std::string &)> msg={}, const std::chrono::milliseconds &timeout=defaultSendTimeout) |
| send a command wait for reply More... | |
| virtual grbl::ErrorCode | sendRealtime (const std::string &cmd, std::function< bool(const std::string &)> msg={}, const std::chrono::milliseconds &timeout=defaultSendTimeout) |
| send a realtime-command wait for reply More... | |
| virtual void | wake ()=0 |
| wake thread waiting for input | |
| virtual void | read ()=0 |
| fill LineBuffer with incoming bytes | |
| virtual bool | wait (const std::chrono::milliseconds &timeout)=0 |
| wait for input More... | |
| virtual bool | takeLine (std::string &line) |
| consume line from buffer More... | |
Public Attributes | |
| ccut::Signal< std::string > | dataSignal |
Static Public Attributes | |
| static const std::chrono::milliseconds | defaultSendTimeout |
Protected Attributes | |
| ccut::LineBuffer | m_buffer |
Detailed Description
Definition at line 43 of file GrblDeviceBase.hpp.
Member Function Documentation
◆ fetch()
| void GrblDeviceBase::fetch | ( | const std::chrono::milliseconds & | timeout | ) |
wait for data and process it
- Parameters
-
timeout wait timeout @emits dataSignal for each line received
- Exceptions
-
Exception(IO) on IO error
Definition at line 42 of file GrblDeviceBase.cpp.
◆ send()
|
virtual |
send a command wait for reply
- Parameters
-
[in] cmd command to send [in] [msg] message handler (for commands with replies) [in] [timeout] command timeout
- Returns
- 0 on success, error-code on error (device specific)
callback function must return true if line has been processed
callback function may throw grbl::ErrorCode to stop processing grbl::ErrorCode::Ok may be used to properly exit
Reimplemented in grbl::MGrblDeviceWrapper.
Definition at line 56 of file GrblDeviceBase.cpp.
◆ sendRealtime()
|
virtual |
send a realtime-command wait for reply
- Parameters
-
[in] cmd command to send [in] [msg] message handler [in] [timeout] command timeout
- Returns
- 0 on success, error-code on error (device specific)
callback function must return true if line has been processed
callback function may throw grbl::ErrorCode to stop processing grbl::ErrorCode::Ok may be used to properly exit
this method is slightly different from send, it won't append carriage return and not parse any "ok" or "error" messages.
Reimplemented in grbl::MGrblDeviceWrapper.
Definition at line 122 of file GrblDeviceBase.cpp.
◆ takeLine()
|
virtual |
consume line from buffer
- Parameters
-
[out] line data line
- Returns
- true if a line was fetched
Reimplemented in mgrbl::MGrblSim.
Definition at line 167 of file GrblDeviceBase.cpp.
◆ wait()
|
pure virtual |
wait for input
- Parameters
-
timeout wait timeout
- Returns
- true if data is available
- Exceptions
-
Exception(IO) on IO error
Implemented in mgrbl::MGrblSim, grbl::MGrblDeviceWrapper, grbl::GrblSim, and edge::EdgeGrblDeviceBase.
◆ write()
|
pure virtual |
raw write some bytes
- Parameters
-
[in] data bytes to write
Implemented in mgrbl::MGrblSim, grbl::MGrblDeviceWrapper, grbl::GrblSim, and edge::EdgeGrblDeviceBase.
The documentation for this class was generated from the following files:
- /builds/mro/controls/sambuca/sambuca-motion-lib/src/util/grbl/GrblDeviceBase.hpp
- /builds/mro/controls/sambuca/sambuca-motion-lib/src/util/grbl/GrblDeviceBase.cpp
