Wled_Fan_Controller/usermods
Arthur Suzuki 4de6656bc4
new usermod hooks "onUdpPacket"
this new hooks will help you implement new and custom protocols in
usermods.
I've provided an example (see usermods/udp_name_sync).
The example will help you share the main segment name across different
WLED instances.
The segment name can be useful to sync with some effects like GIF
image or scrolling text.

If you define new packet format in your usermod, make sure it will
either not collide with already used version of wled udp packet :
- 0 is for udp sync
- 1 is for AudioReactive data
- 2 is for udp_name_sync :)

Also, the onUdpPacket will override "parseNotification" if it returns "true".
Have fun!
2025-08-21 01:00:22 +02:00
..
ADS1115_v2 Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
AHT10_v2 Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
Analog_Clock Merge pull request #4658 from wled/layers 2025-06-01 12:28:11 +02:00
Animated_Staircase Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
Artemis_reciever
audioreactive Merge pull request #4690 from Arcitec/ar-agc-control 2025-06-14 21:17:01 +01:00
Battery Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
battery_keypad_controller Merge branch 'master' into merge-master 2022-02-20 22:24:11 +01:00
BH1750_v2 Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
BME68X_v2 Add libArchive to other usermods 2025-05-06 22:38:33 -04:00
BME280_v2 Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
boblight Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
buzzer Update buzzer to default to 21 if GPIO 32 is not defined 2025-06-28 14:45:13 +01:00
Cronixie Merge pull request #4658 from wled/layers 2025-06-01 12:28:11 +02:00
deep_sleep Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
DHT Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
EleksTube_IPS Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
Enclosure_with_OLED_temp_ESP07 usermods: Fix MQTT checks 2025-01-19 22:19:30 +00:00
EXAMPLE Add libArchive to other usermods 2025-05-06 22:38:33 -04:00
Fix_unreachable_netservices_v2 Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
INA226_v2 Add libArchive to other usermods 2025-05-06 22:38:33 -04:00
Internal_Temperature_v2 Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
JSON_IR_remote Spelling check by @wthomson (#2940) 2022-12-10 16:12:55 +01:00
LD2410_v2 Typo correction (#4756) 2025-07-03 20:00:53 +02:00
LDR_Dusk_Dawn_v2 Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
MAX17048_v2 Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
mpu6050_imu Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
multi_relay Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
MY9291 Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
photoresistor_sensor_mqtt_v1 update links to point to the new repo 2025-02-15 20:07:41 +01:00
PIR_sensor_switch Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
pixels_dice_tray Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
pov_display usermods: Remove #pragma once from cpps 2025-01-17 00:50:02 +00:00
project_cars_shiftlight Fixed markdownlint errors #2 2025-05-11 12:49:32 -04:00
PWM_fan Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
pwm_outputs Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
quinled-an-penta Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
RelayBlinds Multiupdate 2024-02-09 22:15:29 +01:00
rgb-rotary-encoder Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
rotary_encoder_change_effect
RTC Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
sd_card Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
sensors_to_mqtt Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
seven_segment_display Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
seven_segment_display_reloaded usermods/*/setup_deps.py: Check lib_deps for deps 2025-05-24 22:18:22 -04:00
sht Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
Si7021_MQTT_HA Fix deps for Si7021_MQTT_HA 2025-06-28 15:11:40 +01:00
smartnest Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
SN_Photoresistor Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
ST7789_display Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
stairway_wipe_basic Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
Temperature Fixed markdownlint errors 2025-05-11 12:19:03 -04:00
TetrisAI_v2 Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
TTGO-T-Display update links to point to the new repo 2025-02-15 20:07:41 +01:00
udp_name_sync new usermod hooks "onUdpPacket" 2025-08-21 01:00:22 +02:00
user_fx bugfixes: grouping and missing libArchive (#4718) 2025-06-09 17:41:53 +02:00
usermod_rotary_brightness_color Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
usermod_v2_animartrix Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
usermod_v2_auto_save Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
usermod_v2_brightness_follow_sun Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
usermod_v2_four_line_display_ALT Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
usermod_v2_HttpPullLightControl Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
usermod_v2_klipper_percentage Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
usermod_v2_ping_pong_clock Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
usermod_v2_RF433 Add libArchive to other usermods 2025-05-06 22:38:33 -04:00
usermod_v2_rotary_encoder_ui_ALT Merge pull request #4658 from wled/layers 2025-06-01 12:28:11 +02:00
usermod_v2_word_clock Merge pull request #4669 from willmmiles/4597-usermods-not-building 2025-05-26 22:41:45 -04:00
VL53L0X_gestures Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
Wemos_D1_mini+Wemos32_mini_shield Merge branch 'main' into 0_15 2024-02-06 14:47:20 +01:00
wireguard Fix incorrect json value in all usermods 2025-03-28 21:35:37 -04:00
wizlights Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
word-clock-matrix Revert "Usermods: Remove libArchive" 2025-05-06 22:12:01 -04:00
platformio_override.usermods.ini use extreme_partitions 2025-06-28 14:03:06 +01:00
readme.md Fixed markdownlint errors 2025-05-11 12:19:03 -04:00

Usermods

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

If you have created a usermod 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 needs to take
  • 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 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 :)