AtCore  1.0.72
AtCore is a API to manage the serial connection between the computer and 3D Printers.
Classes | Public Slots | Signals | Public Member Functions | Properties | Private Attributes | List of all members
IFirmware Class Referenceabstract

The IFirmware class Base Class for Firmware Plugins. More...

#include <ifirmware.h>

Inheritance diagram for IFirmware:
AprinterPlugin GrblPlugin MarlinPlugin RepetierPlugin SmoothiePlugin SprinterPlugin TeacupPlugin

Classes

struct  IFirmwarePrivate
 The IFirmwarePrivate struct. More...
 

Public Slots

void checkCommand (const QByteArray &lastMessage)
 call Validate Command More...
 

Signals

void readyForCommand (void)
 emit when firmware is ready for a command More...
 

Public Member Functions

 IFirmware ()
 
void init (AtCore *parent)
 
 ~IFirmware () override
 
virtual bool isSdSupported () const =0
 Check for plugin support of sd cards. More...
 
virtual QString name () const =0
 Virtual name to be reimplemented by Firmware plugin. More...
 
virtual void validateCommand (const QString &lastMessage)
 Virtual validateCommand to filter commands from messages. More...
 
virtual QByteArray translate (const QString &command)
 Virtual translate to be reimplemented by Firmwareplugin. More...
 
AtCorecore () const
 AtCore Parent of the firmware plugin. More...
 

Properties

QString name
 
bool sdSupport
 

Private Attributes

IFirmwarePrivated
 

Detailed Description

The IFirmware class Base Class for Firmware Plugins.

Constructor & Destructor Documentation

◆ IFirmware()

IFirmware::IFirmware ( )

◆ ~IFirmware()

IFirmware::~IFirmware ( )
override

Member Function Documentation

◆ checkCommand

void IFirmware::checkCommand ( const QByteArray &  lastMessage)
slot

call Validate Command

Parameters
lastMessagelast message from printer

◆ core()

AtCore * IFirmware::core ( ) const

AtCore Parent of the firmware plugin.

Returns

◆ init()

void IFirmware::init ( AtCore parent)

◆ isSdSupported()

virtual bool IFirmware::isSdSupported ( ) const
pure virtual

Check for plugin support of sd cards.

Returns
True if firmware plugin supports sd cards.

Implemented in TeacupPlugin, SprinterPlugin, SmoothiePlugin, RepetierPlugin, MarlinPlugin, GrblPlugin, and AprinterPlugin.

◆ name()

virtual QString IFirmware::name ( ) const
pure virtual

Virtual name to be reimplemented by Firmware plugin.

Return the name the firmware the plugin is for

Returns
Firmware Name

Implemented in TeacupPlugin, SprinterPlugin, SmoothiePlugin, RepetierPlugin, MarlinPlugin, GrblPlugin, and AprinterPlugin.

◆ readyForCommand

void IFirmware::readyForCommand ( void  )
signal

emit when firmware is ready for a command

◆ translate()

QByteArray IFirmware::translate ( const QString &  command)
virtual

Virtual translate to be reimplemented by Firmwareplugin.

Translate common commands to firmware specific command.

Parameters
commandCommand command to translate
Returns
firmware specific translated command

Reimplemented in TeacupPlugin, and GrblPlugin.

◆ validateCommand()

void IFirmware::validateCommand ( const QString &  lastMessage)
virtual

Virtual validateCommand to filter commands from messages.

Parameters
lastMessagelast Message from printer

Reimplemented in RepetierPlugin, MarlinPlugin, and GrblPlugin.

Member Data Documentation

◆ d

IFirmwarePrivate* IFirmware::d
private

Property Documentation

◆ name

QString IFirmware::name
read

◆ sdSupport

bool IFirmware::sdSupport
read

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