semf
semf::CommunicationHardwareAsynchronous Class Reference

This interface standardized the read and write interface for asynchronous hardware, like UART or CAN. More...

#include <communicationhardwareasynchronous.h>

Inheritance diagram for semf::CommunicationHardwareAsynchronous:
Inheritance graph
Collaboration diagram for semf::CommunicationHardwareAsynchronous:
Collaboration graph

Public Member Functions

virtual ~CommunicationHardwareAsynchronous ()=default
 
Type type () const override
 Returns the hardware type. More...
 
void setFrame (Frame frame) final
 Sets the selected usage of start and stop condition. More...
 
- Public Member Functions inherited from semf::CommunicationHardware
virtual ~CommunicationHardware ()=default
 
virtual void init ()=0
 
virtual void deinit ()=0
 
virtual Type type () const =0
 Returns the hardware type. More...
 
virtual void setFrame (Frame frame)=0
 Sets the selected usage of start and stop condition. More...
 
- Public Member Functions inherited from semf::app::Communication
virtual ~Communication ()=default
 
virtual void write (const uint8_t data[], size_t dataSize)=0
 For writing data, dataWritten signal will be emitted after successful write. More...
 
virtual void read (uint8_t buffer[], size_t bufferSize)=0
 For reading data, dataAvailable signal will be emitted after successful read. More...
 
virtual void stopRead ()=0
 
virtual void stopWrite ()=0
 
virtual bool isBusyReading () const =0
 Communication hardware is busy reading at the moment. More...
 
virtual bool isBusyWriting () const =0
 Communication hardware is busy writing at the moment. More...
 

Additional Inherited Members

- Public Types inherited from semf::CommunicationHardware
enum class  Type { SynchronousMaster = 1 , SynchronousSlave , Asynchronous }
 
enum class  Frame : uint8_t { First = 0x01 , Next = 0x08 , Last = 0x10 , FirstAndLast = 0x11 }
 
- Public Attributes inherited from semf::app::Communication
Signal dataWritten
 
Signal dataAvailable
 
Signal writeStopped
 
Signal readStopped
 
Signal< Errorerror
 

Detailed Description

This interface standardized the read and write interface for asynchronous hardware, like UART or CAN.

Definition at line 21 of file communicationhardwareasynchronous.h.

Constructor & Destructor Documentation

◆ ~CommunicationHardwareAsynchronous()

virtual semf::CommunicationHardwareAsynchronous::~CommunicationHardwareAsynchronous ( )
virtualdefault

Member Function Documentation

◆ setFrame()

void semf::CommunicationHardwareAsynchronous::setFrame ( Frame  frame)
inlinefinalvirtual

Sets the selected usage of start and stop condition.

Attention
Does not impact asynchronous bus systems and will be ignored.
Parameters
frameframe mode

Implements semf::CommunicationHardware.

Definition at line 36 of file communicationhardwareasynchronous.h.

◆ type()

Type semf::CommunicationHardwareAsynchronous::type ( ) const
inlineoverridevirtual

Returns the hardware type.

Returns
Hardware type.

Implements semf::CommunicationHardware.

Definition at line 26 of file communicationhardwareasynchronous.h.