modules::protocol Namespace Reference

The MMU communication protocol implementation and related stuff. More...

Classes
struct	RequestMsg
	A request message - requests are being sent by the printer into the MMU. More...
struct	ResponseMsg
	A response message - responses are being sent from the MMU into the printer as a response to a request message. More...
struct	ResponseCommandStatus
	Combined commandStatus and its value into one data structure (optimization purposes) More...
class	Protocol

Enumerations
enum class	RequestMsgCodes : uint8_t {   unknown = 0 , Query = 'Q' , Tool = 'T' , Load = 'L' ,   Mode = 'M' , Unload = 'U' , Reset = 'X' , Finda = 'P' ,   Version = 'S' , Button = 'B' , Eject = 'E' , Write = 'W' ,   Cut = 'K' , FilamentType = 'F' , FilamentSensor = 'f' , Home = 'H' ,   Read = 'R' }
	Definition of request message codes.
enum class	ResponseMsgParamCodes : uint8_t {   unknown = 0 , Processing = 'P' , Error = 'E' , Finished = 'F' ,   Accepted = 'A' , Rejected = 'R' , Button = 'B' }
	Definition of response message parameter codes.
enum class	DecodeStatus : uint_fast8_t { MessageCompleted , NeedMoreData , Error }
	Message decoding return values. More...

Detailed Description

See description of the new protocol in the MMU 2021 doc

Enumeration Type Documentation

DecodeStatus

enum modules::protocol::DecodeStatus : uint_fast8_t

strong

Enumerator
MessageCompleted	message completed and successfully lexed
NeedMoreData	message incomplete yet, waiting for another byte to come
Error	input character broke message decoding