pir.h

Go to the documentation of this file.

#pragma once
 
#include "fl/stl/stdint.h"
 
#include "fl/sensors/digital_pin.h"
#include "fl/ui/ui.h"
#include "fl/math/time_alpha.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
 
// A passive infrared sensor common on amazon.
// For best results set the PIR to maximum sensitive and minimum delay time before retrigger.
// Instantiating this class will create a ui UIButton when
// compiling using the FastLED web compiler.
class PirLowLevel {
  public:
    PirLowLevel(int pin) FL_NO_EXCEPT;
    bool detect() FL_NO_EXCEPT;
    operator bool() FL_NO_EXCEPT { return detect(); }
 
  private:
 
    DigitalPin mPin;
};
 
// An passive infrared sensor that incorporates time to allow for latching and transitions fx. This is useful
// for detecting motion and the increasing the brightness in response to motion.
// Example:
//   #define PIR_LATCH_MS 15000  // how long to keep the PIR sensor active after a trigger
//   #define PIR_RISING_TIME 1000  // how long to fade in the PIR sensor
//   #define PIR_FALLING_TIME 1000  // how long to fade out the PIR sensor
//   Pir pir(PIN_PIR, PIR_LATCH_MS, PIR_RISING_TIME, PIR_FALLING_TIME);
//   void loop() {
//      uint8_t bri = pir.transition(millis());
//      FastLED.setBrightness(bri * brightness.as<float>());
//   }
 
class Pir {
public:
    Pir(int pin,
                u32 latchMs     = 5000,
                u32 risingTime  = 1000,
                u32 fallingTime = 1000,
                const char* button_name = nullptr) FL_NO_EXCEPT;

    bool detect(u32 now) FL_NO_EXCEPT;

    u8 transition(u32 now) FL_NO_EXCEPT;

    void activate(u32 now) FL_NO_EXCEPT { mRamp.trigger(now); }
 
private:
    PirLowLevel        mPir;
    TimeRamp  mRamp;
    bool       mLastState = false;
    UIButton mButton;
    
};
 
} // namespace fl