HardwareSetupFIR.h

#pragma once
/*
  HardwareSetupFIR.h
  Copyright (c) 2025 Phil Schatzmann. All right reserved.
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#if defined(USE_FIRMATA) && !defined(SKIP_HARDWARE_SETUP)
#include "FirmataTransport.h"
#include "HardwareGPIO_FIR.h"
#include "HardwareI2C_FIR.h"
#include "HardwareSPI_FIR.h"
 
namespace arduino {
 
class HardwareSetupFIRMATA : public I2CSource, public SPISource, public GPIOSource {
 public:
  HardwareSetupFIRMATA() = default;
 
  explicit HardwareSetupFIRMATA(uint8_t spiDeviceId, int8_t spiCsPin = -1)
      : spi(spiDeviceId, spiCsPin) {}
 
  ~HardwareSetupFIRMATA() { end(); }
 
  bool begin(Stream &stream, bool asDefault = true) {
    Logger.info("Using Firmata hardware interfaces");
    is_default_objects_active = asDefault;
 
    transport.begin(stream);
    bool gpio_ok = gpio.begin(transport);
    bool i2c_ok = i2c.begin(transport);
    bool spi_ok = spi.begin(transport);
 
    // define the global hardware interfaces
    if (asDefault) {
      Logger.warning("GPIO, I2C, SPI set up for Firmata");
      GPIO.setGPIO(&gpio);
      SPI.setSPI(&spi);
      Wire.setI2C(&i2c);
    }
 
    return gpio_ok && i2c_ok && spi_ok;
  }
 
  void end() {
    if (is_default_objects_active) {
      GPIO.setGPIO(nullptr);
      SPI.setSPI(nullptr);
      Wire.setI2C(nullptr);
    }
    gpio.end();
    i2c.end();
    spi.end();
    transport.end();
  }
 
  HardwareGPIO_FIRMATA *getGPIO() { return &gpio; }
  HardwareI2C_FIRMATA *getI2C() { return &i2c; }
  HardwareSPI_FIRMATA *getSPI() { return &spi; }
 
 protected:
  FirmataTransport transport;
  HardwareGPIO_FIRMATA gpio;
  HardwareI2C_FIRMATA i2c;
  HardwareSPI_FIRMATA spi;
  bool is_default_objects_active = false;
};
 
static HardwareSetupFIRMATA FIRMATA;
 
}  // namespace arduino
 
#endif