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
BME280_v2
DHT
ESP32_TouchBrightnessControl
EXAMPLE_v2
Enclosure_with_OLED_temp_ESP07
Fix_unreachable_netservices_v2
PIR_sensor_mqtt_v1
PIR_sensor_switch
QuinLED_Dig_Uno_Temp_MQTT
TTGO-T-Display
Temperature
UserModv2_SunRiseAndSet
Wemos_D1_mini+Wemos32_mini_shield
battery_keypad_controller
blynk_relay_control
buzzer
esp32_multistrip
mpu6050_imu
mqtt_switch_v2
photoresistor_sensor_mqtt_v1
project_cars_shiftlight
quinled_digquad_preassembled_unofficial_v0.1
rotary_encoder_change_brightness
rotary_encoder_change_effect
sensors_to_mqtt
ssd1306_i2c_oled_u8g2
stairway_wipe_basic
usermod_v2_auto_save
usermod_v2_four_line_display
usermod_v2_mode_sort
usermod_v2_rotary_encoder_ui
word-clock-matrix
readme.md

readme.md

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 :)