CANSHIELD.h

Go to the documentation of this file.

// Copyright (C) Sven Rosvall (sven@rosvall.ie)
// 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
 
#include <Arduino.h>
#include <LEDUserInterface.h>
 
#include "CAN2515.h"
 
namespace VLCB
{
class CANSHIELD
{
public:
#ifdef ARDUINO_ARCH_RP2040
  // If this is an RPi Pico then this file shall be compilable but this class shall not be instantiatable.
  // The RPi Pico has a different SPI class and a different way to set the SPI pins. This is why this class
  // is not useful for use with RPi Pico.
  CANSHIELD() = delete;
#endif
  
  static byte getGreenLedPin();
  static byte getYellowLedPin();
  static byte getSwitchPin();

  static void setupLEDUserInterface(VLCB::LEDUserInterface & ledUserInterface);

  bool begin();

  CanTransport *getCanTransport()
  {
    return &can2515;
  }
  
  CAN2515 *getCAN2515()
  {
    return &can2515;
  }
 
  bool hasCanErrors();

  CAN2515 can2515;
};
 
}