PinFlasher.h

Go to the documentation of this file.

#ifndef _PIN_FLASHER_H_
#define _PIN_FLASHER_H_
/*
   PinFlasher.h
   by Matthew Ford,  2021/12/06
   (c)2021 Forward Computing and Control Pty. Ltd.
   NSW, Australia  www.forward.com.au
   This code may be freely used for both private and commerical use.
   Provide this copyright is maintained.
*/
#include <Arduino.h>
#include "millisDelay.h"
extern const int PIN_ON;
extern const int PIN_OFF;
 
 
class PinFlasher: protected millisDelay {
  public:
    PinFlasher(int pin = -1, bool invert = false);
    
    ~PinFlasher(); // sets pin back to input
    
    void update();
 
    void setPin(int pin);
 
    void setOnOff(unsigned long onOff_ms);
 
    
    void setOnAndOff(unsigned long on_ms, unsigned long off_ms);
 
    bool invertOutput();
    
  protected:
    virtual void setOutput();
    int io_pin; // initially -1, not set
    bool io_pin_on;//initially false/ off;
    bool outputInverted; // initially false, not inverted, i.e. off is LOW, on is HIGH
 
  private:
    unsigned long on_len_ms; // initially 0, off
    unsigned long off_len_ms; // initially 0, off
    bool pinModeSet; // initially false, pinMode(io_pin, OUTPUT) is deferred to the
    // first setOutput() call so the constructor does not touch hardware during
    // static initialization of global PinFlasher objects
};
 
#endif