WLED/usermods/PIR_sensor_switch

PIR sensor switch

This usermod-v2 modification allows the connection of a PIR sensor to switch on the LED strip when motion is detected. The switch-off occurs ten minutes after no more motion is detected.

Story:

I use the PIR Sensor to automatically turn on the WLED analog clock in my home office room when I am there. The LED strip is switched using a relay to keep the power consumption low when it is switched off.

Webinterface

The info page in the web interface shows the items below

• the state of the sensor. By clicking on the state the sensor can be deactivated/activated. Changes persist after a reboot. I recommend to deactivate the sensor before an OTA update and activate it again afterwards.
• the remaining time of the off timer.

JSON API

The usermod supports the following state changes:

JSON key	Value range	Description
PIRenabled	bool	Deactivdate/activate the sensor
PIRoffSec	60 to 43200	Off timer seconds

Changes also persist after a reboot.

Sensor connection

My setup uses an HC-SR501 sensor, a HC-SR505 should also work.

The usermod uses GPIO13 (D1 mini pin D7) for the sensor signal. This example page describes how to connect the sensor.

Use the potentiometers on the sensor to set the time-delay to the minimum and the sensitivity to about half, or slightly above.

Usermod installation

1. Copy the file usermod_PIR_sensor_switch.h to the wled00 directory.
2. Register the usermod by adding #include "usermod_PIR_sensor_switch.h" in the top and registerUsermod(new PIRsensorSwitch()); in the bottom of usermods_list.cpp.

Example usermods_list.cpp:

#include "wled.h"
/*
 * Register your v2 usermods here!
 *   (for v1 usermods using just usermod.cpp, you can ignore this file)
 */

/*
 * Add/uncomment your usermod filename here (and once more below)
 * || || ||
 * \/ \/ \/
 */
//#include "usermod_v2_example.h"
//#include "usermod_temperature.h"
//#include "usermod_v2_empty.h"
#include "usermod_PIR_sensor_switch.h"

void registerUsermods()
{
  /*
   * Add your usermod class name here
   * || || ||
   * \/ \/ \/
   */
  //usermods.add(new MyExampleUsermod());
  //usermods.add(new UsermodTemperature());
  //usermods.add(new UsermodRenameMe());
  usermods.add(new PIRsensorSwitch());

}

API to enable/disable the PIR sensor from outside. For example from another usermod.

The class provides the static method PIRsensorSwitch* PIRsensorSwitch::GetInstance() to get a pointer to the usermod object.

To query or change the PIR sensor state the methods bool PIRsensorEnabled() and void EnablePIRsensor(bool enable) are available.

There are two options to get access to the usermod instance:

1. Include usermod_PIR_sensor_switch.h before you include the other usermod in `usermods_list.cpp'

or

2. Use #include "usermod_PIR_sensor_switch.h" at the top of the usermod.h where you need it.

Example usermod.h :

#include "wled.h"

#include "usermod_PIR_sensor_switch.h"

class MyUsermod : public Usermod {
  //...

  void togglePIRSensor() {
    if (PIRsensorSwitch::GetInstance() != nullptr) {
      PIRsensorSwitch::GetInstance()->EnablePIRsensor(!PIRsensorSwitch::GetInstance()->PIRsensorEnabled());
    }
  }
  //...
};

Have fun - @gegu