HardwareGPIO_FIR.h

#pragma once
/*
  HardwareGPIO_FIR.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
*/
#ifdef USE_FIRMATA
#include "HardwareGPIO.h"
#include "FirmataTransport.h"
#include <map>
#include <memory>
#include <mutex>
 
namespace arduino {
 
class HardwareGPIO_FIRMATA : public HardwareGPIO {
 public:
  HardwareGPIO_FIRMATA() = default;
  ~HardwareGPIO_FIRMATA();
 
  bool begin(Stream &stream);
 
  bool begin(FirmataTransport &transport);
 
  void end();
 
  void pinMode(pin_size_t pinNumber, PinMode pinMode) override;
  void digitalWrite(pin_size_t pinNumber, PinStatus status) override;
  PinStatus digitalRead(pin_size_t pinNumber) override;
  int analogRead(pin_size_t pinNumber) override;
  void analogReference(uint8_t mode) override;
  void analogWrite(pin_size_t pinNumber, int value) override;
  void analogWriteFrequency(pin_size_t pinNumber, uint32_t frequency);
  void tone(uint8_t _pin, unsigned int frequency,
            unsigned long duration = 0) override;
  void noTone(uint8_t _pin) override;
  unsigned long pulseIn(uint8_t pin, uint8_t state,
                        unsigned long timeout = 1000000L) override;
  unsigned long pulseInLong(uint8_t pin, uint8_t state,
                            unsigned long timeout = 1000000L) override;
  void analogWriteResolution(uint8_t bits) override;
 
  operator bool() { return is_open; }
 
 protected:
  FirmataTransport *transport_ = nullptr;              // non-owning
  std::unique_ptr<FirmataTransport> owned_transport_;   // set by begin(Stream&)
  bool is_open = false;
 
  std::mutex state_mutex_;
  std::map<pin_size_t, PinMode> pin_modes_;
  std::map<pin_size_t, PinStatus> pin_states_;
  std::map<pin_size_t, int> analog_values_;
  std::map<uint8_t, bool> digital_reporting_enabled_;
  std::map<pin_size_t, bool> analog_reporting_enabled_;
 
  void handleDigitalMessage(const FirmataDigitalMessage &msg);
  void handleAnalogMessage(const FirmataAnalogMessage &msg);
 
  void enableDigitalReporting(pin_size_t pinNumber);
  void enableAnalogReporting(pin_size_t pinNumber);
 
  static uint8_t toFirmataPinMode(PinMode mode);
};
 
}  // namespace arduino
 
#endif  // USE_FIRMATA