SerialGC.h

Go to the documentation of this file.

// Copyright (C) David Ellis
// This file is part of VLCB-Arduino project on https://github.com/SvenRosvall/VLCB-Arduino
// Licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
// The full licence can be found at: http://creativecommons.org/licenses/by-nc-sa/4.0/
 
#pragma once
 
// header files
#include <Arduino.h>
#include <Stream.h>
#include <Controller.h>
#include <CanTransport.h>
#include <GridConnect.h>
 
namespace VLCB
{
 
  // constants
 
  // grid connect should be 28 characters maximum
  static const int RXBUFFERSIZE = 30;

  class SerialGC : public CanTransport
  {
  public:
    SerialGC(Stream& _serial = Serial) : serial(_serial) {}
    bool begin();
 
    virtual bool available() override;
    virtual CANFrame getNextCanFrame() override;
    virtual bool sendCanFrame(CANFrame *frame) override;
    virtual void reset() override;
    virtual byte getHardwareType() { return CAN_HW_SERIAL; };
 
    virtual unsigned int receiveCounter() override { return receivedCount; }
    virtual unsigned int transmitCounter() override { return transmitCount; }
    virtual unsigned int receiveBufferSize() override { return RXBUFFERSIZE; }
    virtual unsigned int transmitBufferSize() override { return RXBUFFERSIZE; }
    virtual unsigned int receiveErrorCounter() override { return receiveErrorCount; }
    virtual unsigned int transmitErrorCounter() override { return transmitErrorCount; }
    virtual unsigned int receiveBufferUsage() override { return 0; };
    virtual unsigned int transmitBufferUsage() override { return 0; };
    virtual unsigned int receiveBufferPeak() override { return 0; };
    virtual unsigned int transmitBufferPeak() override { return 0; };
    virtual unsigned int errorStatus() override { return 0; }
 
  private:
    Stream& serial;
  
    char rxBuffer[RXBUFFERSIZE]; // Define a byte array to store the incoming data
    char txBuffer[RXBUFFERSIZE]; // Define a byte array to store the outgoing data
    CANFrame rxCANFrame;
 
    unsigned int receivedCount = 0;
    unsigned int transmitCount = 0;
    unsigned int receiveErrorCount = 0;
    unsigned int transmitErrorCount = 0;
 
    void debugCANMessage(CANFrame frame);
 
  };
 
}