decoder_t.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
#include "src/pins/boardInputPin.h"
 
static constexpr uint8_t TRIGGER_EDGE_NONE = 99;
 
struct interrupt_t
{
  using callback_t = void(*)(void);
 
  callback_t callback = nullptr;
  uint8_t edge = TRIGGER_EDGE_NONE;
 
  interrupt_t() = default;
  interrupt_t(callback_t _callback, uint8_t _edge)
  : callback(_callback)
  , edge(_edge)
  {
  }
 
  uint8_t attach(uint8_t pin);
 
  void detach(uint8_t pin);
 
  bool isTriggered(void) const;
 
  bool isValid(void) const
  {
    return edge!=TRIGGER_EDGE_NONE 
        && callback!=nullptr
        && _pin.isValid();
  }
 
  bool isPinHigh(void) const {
    return _pin.isPinHigh();
  }
 
  boardInputPin_t _pin;
};
 
enum class SyncStatus : uint8_t {
  None, 
  Partial,
  Full,
}; 
 
struct decoder_status_t {
  bool validTrigger; 
  bool toothAngleIsCorrect; 
  SyncStatus syncStatus; 
};
 
 
struct decoder_features_t {
  bool supports2ndDeriv : 1; 
  bool supportsSequential : 1; 
  bool hasFixedCrankingTiming : 1; 
  bool supportsPerToothIgnition : 1; 
 
  decoder_features_t(void)
    : supports2ndDeriv(false)
    , supportsSequential(false)
    , hasFixedCrankingTiming(false)
    , supportsPerToothIgnition(false)
  {}
};
 
struct decoder_t
{
  interrupt_t primary;
  interrupt_t secondary;
  interrupt_t tertiary;
 
 
  using getRPM_t = uint16_t(*)(void);
  getRPM_t getRPM;
 
 
  using getCrankAngle_t = int16_t(*)(void);
  getCrankAngle_t getCrankAngle;
 
 
  using setEndTeeth_t = void(*)(void); 
  setEndTeeth_t setEndTeeth;
 
 
  using reset_t = void(*)(void);
  reset_t reset;
 
 
  using engine_running_t = bool(*)(uint32_t);
  engine_running_t isEngineRunning;
 
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wnoexcept-type"  
  using status_fun_t = decoder_status_t(*)(void)noexcept;
#pragma GCC diagnostic pop
  status_fun_t getStatus;
 
 
  using feature_fun_t = decoder_features_t(*)(void);
  feature_fun_t getFeatures;
};