RSeries astromech firmware
MarcduinoSerial< BUFFER_SIZE > Class Template Reference

#include <core/Marcduino.h>

+ Inheritance diagram for MarcduinoSerial< BUFFER_SIZE >:
+ Collaboration diagram for MarcduinoSerial< BUFFER_SIZE >:

Public Member Functions

 MarcduinoSerial (HardwareSerial &serial, AnimationPlayer &player)
 
 MarcduinoSerial (Stream *stream, AnimationPlayer &player)
 
 MarcduinoSerial (AnimationPlayer &player)
 
void setStream (Stream *stream, Stream *outStream=nullptr)
 
virtual void animate ()
 Subclasses must implement this function to run through a single frame of animation/activity. More...
 
- Public Member Functions inherited from AnimatedEvent
 AnimatedEvent ()
 Default Constructor. More...
 
void setLoopDoneCallback (AnimatedLoopDone loopProc)
 

Additional Inherited Members

- Static Public Member Functions inherited from AnimatedEvent
static void process ()
 Calls animate() for each created AnimatedEvent subclass. More...
 

Constructor & Destructor Documentation

◆ MarcduinoSerial() [1/3]

template<uint16_t BUFFER_SIZE = 64>
MarcduinoSerial< BUFFER_SIZE >::MarcduinoSerial ( HardwareSerial &  serial,
AnimationPlayer player 
)
inline

◆ MarcduinoSerial() [2/3]

template<uint16_t BUFFER_SIZE = 64>
MarcduinoSerial< BUFFER_SIZE >::MarcduinoSerial ( Stream *  stream,
AnimationPlayer player 
)
inline

◆ MarcduinoSerial() [3/3]

template<uint16_t BUFFER_SIZE = 64>
MarcduinoSerial< BUFFER_SIZE >::MarcduinoSerial ( AnimationPlayer player)
inline

Member Function Documentation

◆ animate()

template<uint16_t BUFFER_SIZE = 64>
virtual void MarcduinoSerial< BUFFER_SIZE >::animate ( )
inlinevirtual

Subclasses must implement this function to run through a single frame of animation/activity.

Subclasses should not call delay() or otherwise block.

Implements AnimatedEvent.

◆ setStream()

template<uint16_t BUFFER_SIZE = 64>
void MarcduinoSerial< BUFFER_SIZE >::setStream ( Stream *  stream,
Stream *  outStream = nullptr 
)
inline

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