SyncLed.h

Go to the documentation of this file.

 
#ifndef SyncLed_h
#define SyncLed_h
// Arduino compiles everything in the src folder even if not included so it causes and error for the nano if this is not included.
#if defined(ARDUINO_TEENSY36)  || defined(ARDUINO_TEENSY41)
#include "Arduino.h"
#include "Board.h"
#include "config.h"
//#include "IntervalTimer.h"
 
// Define the on and off state of the LED.  This is handy for if you are using a P Channel MOSFET where low is on.
//#define SYNC_LED_ON_STATE HIGH
//#define SYNC_LED_OFF_STATE LOW
 
// const unsigned int SYNC_HALF_PERIOD_US = 125000;  // half blink period in micro seconds
// const unsigned int SYNC_START_STOP_HALF_PERIOD_US = 4 * SYNC_HALF_PERIOD_US; // Half blink period for the begining and end of the sequence.  This is usually longer so it is easy to identify.
 
 
class SyncLed
{
  public:
    // Constructors one you can set the default LED State
    SyncLed(int pin, int sync_start_stop_half_period_us, int sync_half_period_us);
    SyncLed(int pin, int sync_start_stop_half_period_us, int sync_half_period_us, int default_led_state);
    SyncLed(int pin, int sync_start_stop_half_period_us, int sync_half_period_us, int default_led_state, int led_default_state_pin);  // This isn't a great way of overloading but with high and low being int instead of bool I don't have a great alternative
    
    void trigger();  
    
    void update_led(); // Changes the LED State to the current state
    
    void update_periods(int sync_start_stop_half_period_us, int sync_half_period_us);  // Used if you need to change the periods after initialization
    
    bool handler();  
    
    void set_default_state(int new_default);   
    
    bool get_led_is_on(); // 
   
    bool get_is_blinking();
    
    
    
  private:
    
    
    void _blink_start_stop();   
    
    void _blink(); 
    
    void _default_state();  
   
    volatile int _led_state;  
    int _led_is_on; 
    volatile int _current_sync_period; 
    volatile bool _do_blink ; 
    volatile bool _do_start_stop_sequence; 
    bool _is_blinking; 
    int _pin;  
    int _default_led_state;  
    int _led_default_state_pin;  
    int _sync_start_stop_half_period_us;  
    int _sync_half_period_us;  
    volatile unsigned int _state_change_count ; 
    unsigned int _num_start_stop_blinks;  
    int _last_state_change_timestamp_us; 
};
#endif
#endif