VLCB
Loading...
Searching...
No Matches
VLCB::SerialGC Class Reference

Implementation of the Transport interface class to support the gridconnect protocol over serial connection. More...

#include <SerialGC.h>

Inheritance diagram for VLCB::SerialGC:
VLCB::CanTransport VLCB::Transport

Public Member Functions

 SerialGC (Stream &_serial=Serial)
bool begin ()
virtual bool available () override
 Check if an incoming CAN frame is available on the CAN bus.
virtual CANFrame getNextCanFrame () override
virtual bool sendCanFrame (CANFrame *frame) override
 send a CANMessage message in GridConnect format
virtual void reset () override
 reset
virtual byte getHardwareType ()
virtual unsigned int receiveCounter () override
virtual unsigned int transmitCounter () override
virtual unsigned int receiveBufferSize () override
virtual unsigned int transmitBufferSize () override
virtual unsigned int receiveErrorCounter () override
virtual unsigned int transmitErrorCounter () override
virtual unsigned int receiveBufferUsage () override
virtual unsigned int transmitBufferUsage () override
virtual unsigned int receiveBufferPeak () override
virtual unsigned int transmitBufferPeak () override
virtual unsigned int errorStatus () override

Detailed Description

Implementation of the Transport interface class to support the gridconnect protocol over serial connection.

Constructor & Destructor Documentation

◆ SerialGC()

VLCB::SerialGC::SerialGC ( Stream & _serial = Serial)
inline

Member Function Documentation

◆ begin()

bool VLCB::SerialGC::begin ( )

◆ available()

bool VLCB::SerialGC::available ( )
overridevirtual

Check if an incoming CAN frame is available on the CAN bus.

Implements VLCB::CanTransport.

◆ getNextCanFrame()

CANFrame VLCB::SerialGC::getNextCanFrame ( )
overridevirtual

get the available CANMessage must call available first to ensure there is something to get

Implements VLCB::CanTransport.

◆ sendCanFrame()

bool VLCB::SerialGC::sendCanFrame ( CANFrame * frame)
overridevirtual

send a CANMessage message in GridConnect format

Implements VLCB::CanTransport.

◆ reset()

void VLCB::SerialGC::reset ( )
overridevirtual

reset

Implements VLCB::Transport.

◆ getHardwareType()

virtual byte VLCB::SerialGC::getHardwareType ( )
inlinevirtual

Get the hardware type of the concrete transport class.

Reimplemented from VLCB::CanTransport.

◆ receiveCounter()

virtual unsigned int VLCB::SerialGC::receiveCounter ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ transmitCounter()

virtual unsigned int VLCB::SerialGC::transmitCounter ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ receiveBufferSize()

virtual unsigned int VLCB::SerialGC::receiveBufferSize ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ transmitBufferSize()

virtual unsigned int VLCB::SerialGC::transmitBufferSize ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ receiveErrorCounter()

virtual unsigned int VLCB::SerialGC::receiveErrorCounter ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ transmitErrorCounter()

virtual unsigned int VLCB::SerialGC::transmitErrorCounter ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ receiveBufferUsage()

virtual unsigned int VLCB::SerialGC::receiveBufferUsage ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ transmitBufferUsage()

virtual unsigned int VLCB::SerialGC::transmitBufferUsage ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ receiveBufferPeak()

virtual unsigned int VLCB::SerialGC::receiveBufferPeak ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ transmitBufferPeak()

virtual unsigned int VLCB::SerialGC::transmitBufferPeak ( )
inlineoverridevirtual

Implements VLCB::Transport.

◆ errorStatus()

virtual unsigned int VLCB::SerialGC::errorStatus ( )
inlineoverridevirtual

Implements VLCB::Transport.

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