WLED/usermods
Rolf 746a8badac
Animated Staircase Usermod (#1763)
* Initial version of the PIR Staircase wipe up/down.

* Add pulldown reminder

* Workaround for missing D6 and D7 definitions on esp32dev

* Add pinouts for d1 mini (esp8266 and esp32) and NodeMCU (and Arduino)

* These IO pins on all these boards... NodeMCU and d1_mini esp32 supported. The others? Fingers crossed.

* Changed to not collide with led strip pins

* PIR on GPIO 15 and 16 on esp32 d1 mini

* Removed PIN number ifdefs, it is impossible to match all boards

* Settings in flash, info and API

* Update README.md

* Small doc changes

* Improved README

* Fixed error in reading configuration

* Add API documentation

* Documentation and code cleanup

* Add enable/disable to API settings

* Restore segment state when disabling plugin

* Add debounce

* Set segments in animation mode

* Set segments in animation mode

* Add support for HR04 sensors

* Add preliminary description for  using an HR04 sensor

* Fixed typenumber and linked to datasheet

* Moved config away from defines to prevent user error

* Trigger Sensors through API

* Rename scripts folder so that it's name doesn't clash with the `pio` command (prevents platformIO in VSCode to work properly on Mac)

* Bugfix for detection problems

* Separated config from code

* Renamed Signal to Trigger pin

* Filename adjusted

* Clarifications and additions to README

* Fixed references to pio scripts

* Fixed API trigger bug

* Adjustments to README.md

* More efficient use of flash cycles, better naming

* Bugfix: bottom sensor was not read properly

* Renamed to Animated_Staircase

* Add note on ultrasonic sensor and esp32

* Better naming of defines

* Bugfix: Swipe down started with two steps.

* Removed upload port in nodemcuv2 section

Co-authored-by: Rolf <rolf@phobos.local>
Co-authored-by: Rolf <>
2021-02-25 09:52:48 +01:00
..
Animated_Staircase Animated Staircase Usermod (#1763) 2021-02-25 09:52:48 +01:00
battery_keypad_controller [ImgBot] Optimize images (#1238) 2020-10-09 12:48:19 +02:00
blynk_relay_control Avoid name collision. Fix wled instance access in ino. 2020-03-28 08:45:20 -04:00
BME280_v2 Added PR message to BME280 usermod as readme 2020-12-26 00:57:39 +01:00
buzzer create "buzzer" WLED usermod 2020-12-14 20:50:48 -05:00
DHT DHT22/DHT11 humidity/temperature sensor usermod (#1719) 2021-02-13 01:21:13 +01:00
Enclosure_with_OLED_temp_ESP07 [ImgBot] Optimize images (#1238) 2020-10-09 12:48:19 +02:00
esp32_multistrip added CanShow function to fix build errors 2020-12-12 07:58:25 -06:00
ESP32_TouchBrightnessControl Upload TouchBrightnessControl Usermod for ESP32 (#1183) 2020-09-16 21:21:26 +02:00
EXAMPLE_v2 Usermod callbacks for custom settings 2020-11-11 15:50:15 +01:00
Fix_unreachable_netservices_v2 Update usermods: FixUnreachableNetServices and PIRsensorSwitch (#1448) 2020-12-10 01:28:42 +01:00
mpu6050_imu Added link for video and blog 2020-06-21 17:32:39 -07:00
mqtt_switch_v2 Add options for inverted switches and default values. 2020-11-01 18:08:30 +01: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 Update usermods: FixUnreachableNetServices and PIRsensorSwitch (#1448) 2020-12-10 01:28:42 +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
quinled_digquad_preassembled_unofficial_v0.1 A build file and README for the QuinLED-Dig-Quad Preassembled (#1643) 2021-01-13 00:11:43 +01: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
sensors_to_mqtt Usermod SensorsToMqtt: Add bmp280+ccs811+si7021 sensors to wled and publish them via MQTT to Home Assistant (#1588) 2020-12-29 19:35:59 +01:00
ssd1306_i2c_oled_u8g2 OLED contrast set to 10 2020-01-06 12:41:03 -05:00
stairway_wipe_basic create stairway-wipe-for-usermod-v2 (#1359) 2020-11-23 01:00:02 +01:00
Temperature Mulipin select compiles 2021-01-21 01:21:16 +01:00
TTGO-T-Display TTGO T-Display Usermod Updates (#1565) 2020-12-27 19:33:51 +01:00
usermod_v2_auto_save Rotary Encoder, Four Line Display, and Auto Save Usermods (#1722) 2021-02-09 17:15:43 +01:00
usermod_v2_four_line_display Create the sorted index of modes and palettes at startup (#1741) 2021-02-18 00:28:01 +01:00
usermod_v2_mode_sort Create the sorted index of modes and palettes at startup (#1741) 2021-02-18 00:28:01 +01:00
usermod_v2_rotary_encoder_ui Create the sorted index of modes and palettes at startup (#1741) 2021-02-18 00:28:01 +01: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 :)