decoder_t.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
#include <Arduino.h>
 
static constexpr uint8_t TRIGGER_EDGE_NONE = 99;
// Just in case
static_assert(TRIGGER_EDGE_NONE != LOW, "LOW edge value conflict");
static_assert(TRIGGER_EDGE_NONE != HIGH, "HIGH edge value conflict");
static_assert(TRIGGER_EDGE_NONE != RISING, "RISING edge value conflict");
static_assert(TRIGGER_EDGE_NONE != FALLING, "FALLING edge value conflict");
static_assert(TRIGGER_EDGE_NONE != CHANGE, "CHANGE edge value conflict");
 
struct interrupt_t
{
  using callback_t = void(*)(void);
 
  callback_t callback = nullptr;
  uint8_t edge = TRIGGER_EDGE_NONE;
 
  void attach(uint8_t pin) const
  {
    detach(pin);
    if (isValid())
    {
      attachInterrupt(digitalPinToInterrupt(pin), callback, edge);
    }
  }  
 
  void detach(uint8_t pin) const
  {
    detachInterrupt( digitalPinToInterrupt(pin) );
  }  
 
  bool isValid(void) const
  {
    return edge!=TRIGGER_EDGE_NONE && callback!=nullptr;
  }
};
 
 
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;
 
 
  using status_fun_t = decoder_status_t(*)(void);
  status_fun_t getStatus;
 
 
  using feature_fun_t = decoder_features_t(*)(void);
  feature_fun_t getFeatures;
};