WLED/usermods
rawframe 1ecbaf2c7f
Create PIR_Highlight_Standby
* Rawframe edit:
 * - TESTED ON WLED VS.0.10.1 - WHERE ONLY PRESET 16 SAVES SEGMENTS - some macros may not be needed if this changes.
 * - Code has been modified as my usage changed, as such it has poor use of functions vs if thens, but feel free to change it for me :)
 * 
 * Edited to SWITCH between two lighting scenes/modes : STANDBY and HIGHLIGHT
 * 
 * Usage:
 *  - Standby is the default mode and Highlight is activated when the PIR detects activity.
 *  - PIR delay now set to same value as Nightlight feature on boot but otherwise controlled as normal.
 *  - Standby and Highlight brightness can be set on the fly (default values set on boot via macros calling presets).
 *  - Macros are used to set Standby and Highlight states (macros can load saved presets etc).
 * 
 *    - Macro short button press   =  Highlight state default (used on boot only and sets default brightness).
 *    - Macro double button press  =  Standby state default   (used on boot only and sets default brightness).
 *    - Macro long button press    =  Highlight state         (after boot).
 *    - Macro 16                   =  Standby state           (after boot).
 *
 *    ! It is advised not to set 'Apply preset at boot' or a boot macro (that activates a preset) as we will call our own macros on boot.
 * 
 *  - When the strip is off before PIR activates the strip will return to off for Standby mode, and vice versa.
 *  - When the strip is turned off while in Highlight mode, it will return to standby mode. (This behaviour could be changed easily if for some reason you wanted the lights to go out when the pir is activated).
 *  - Macros can be chained so you could do almost anything, such as have standby mode also turn on the nightlight function with a new time delay.
 * 
 * Segment Notes:
 * - It's easier to save the segment selections in preset than apply via macro while we a limited to preset 16. (Ie, instead of selecting sections at the point of activating standby/highlight modes). 
 * - Because only preset 16 saves segments, for now we are having to use additional macros to control segments where they are involved. Macros can be chained so this works but it would be better if macros also accepted json-api commands. (Testing http api segment behaviour of SS with SB left me a little confused).
 * 
 * Future:
 *  - Maybe a second timer/timetable that turns on/off standby mode also after set inactivity period / date & times. For now this can be achieved others ways so may not be worth eating more processing power.
2020-10-08 23:42:32 +01:00
..
battery_keypad_controller fix lint issues 2020-03-15 12:43:09 +01:00
blynk_relay_control Avoid name collision. Fix wled instance access in ino. 2020-03-28 08:45:20 -04:00
Enclosure_with_OLED_temp_ESP07 Added BME280 sensor (#850) 2020-04-15 23:52:10 +02:00
ESP32_TouchBrightnessControl Upload TouchBrightnessControl Usermod for ESP32 (#1183) 2020-09-16 21:21:26 +02:00
EXAMPLE_v2 Fix filetype in usermod documentation 2020-08-07 16:06:54 +02:00
Fix_unreachable_netservices_v2 Usermods: PIR sensor switch, v2 unreachable net services 2020-06-14 12:54:35 +02:00
Fix_unreachable_webserver Usermod: fix unreachable network services 2020-05-24 10:07:00 +02:00
mpu6050_imu Added link for video and blog 2020-06-21 17:32:39 -07:00
photoresistor_sensor_mqtt_v1 photoresister sensor usermod 2020-07-16 23:29:06 +08:00
PIR_sensor_mqtt_v1 Use MQTT_TOPIC 2020-07-17 00:54:52 +08:00
PIR_sensor_switch Create PIR_Highlight_Standby 2020-10-08 23:42:32 +01:00
project_cars_shiftlight make PCARS usermod compatible with WLED > 0.10.0 2020-08-30 21:27:52 +02:00
QuinLED_Dig_Uno_Temp_MQTT QuinLED mod update 2020-04-08 09:18:26 -04:00
rotary_encoder_change_brightness Create usermode_rotary_set.h 2020-06-07 19:25:58 +02:00
rotary_encoder_change_effect Refactor callMode (#702) 2020-02-22 16:17:32 +01:00
ssd1306_i2c_oled_u8g2 OLED contrast set to 10 2020-01-06 12:41:03 -05:00
stairway_wipe_basic Avoid name collision. Fix wled instance access in ino. 2020-03-28 08:45:20 -04:00
Temperature Async temperature usermod (#1178) 2020-09-13 19:26:27 +02:00
TTGO-T-Display Updated Readme.md file (#965) 2020-06-05 14:22:03 +02:00
UserModv2_SunRiseAndSet couple of bug fixes 2020-08-09 21:58:27 -04:00
Wemos_D1_mini+Wemos32_mini_shield Updated Wemos shield usermod (#880) 2020-04-30 23:40:14 +02:00
word-clock-matrix design updates (#1112) 2020-08-25 10:33:47 +02:00
readme.md Added v2 usermods API 2020-05-28 02:20:02 +02:00

Usermods

This folder serves as a repository for usermods (custom usermod.cpp files)!

If you have created an usermod that you believe is useful (for example to support a particular sensor, display, feature...), feel free to contribute by opening a pull request!

In order for other people to be able to have fun with your usermod, please keep these points in mind:

  • Create a folder in this folder with a descriptive name (for example usermod_ds18b20_temp_sensor_mqtt)
  • Include your custom files
  • If your usermod requires changes to other WLED files, please write a readme.md outlining the steps one has to take to use the usermod
  • Create a pull request!
  • If your feature is useful for the majority of WLED users, I will consider adding it to the base code!

While I do my best to not break too much, keep in mind that as WLED is being updated, usermods might break.
I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.

For new usermods, I would recommend trying out the new v2 usermod API, which allows installing multiple usermods at once and new functions! You can take a look at EXAMPLE_v2 for some documentation and at Temperature for a completed v2 usermod!

Thank you for your help :)