48958cc638
Update readme.md for rgb-rotary-encoder usermod |
||
|---|---|---|
| .. | ||
| ADS1115_v2 | ||
| AHT10_v2 | ||
| Analog_Clock | ||
| Animated_Staircase | ||
| Artemis_reciever | ||
| BH1750_v2 | ||
| BME68X_v2 | ||
| BME280_v2 | ||
| Battery | ||
| Cronixie | ||
| DHT | ||
| EXAMPLE_v2 | ||
| EleksTube_IPS | ||
| Enclosure_with_OLED_temp_ESP07 | ||
| Fix_unreachable_netservices_v2 | ||
| INA226_v2 | ||
| Internal_Temperature_v2 | ||
| JSON_IR_remote | ||
| LD2410_v2 | ||
| LDR_Dusk_Dawn_v2 | ||
| MAX17048_v2 | ||
| MY9291 | ||
| PIR_sensor_switch | ||
| PWM_fan | ||
| RTC | ||
| RelayBlinds | ||
| SN_Photoresistor | ||
| ST7789_display | ||
| Si7021_MQTT_HA | ||
| TTGO-T-Display | ||
| Temperature | ||
| TetrisAI_v2 | ||
| VL53L0X_gestures | ||
| Wemos_D1_mini+Wemos32_mini_shield | ||
| audioreactive | ||
| battery_keypad_controller | ||
| boblight | ||
| buzzer | ||
| deep_sleep | ||
| mpu6050_imu | ||
| mqtt_switch_v2 | ||
| multi_relay | ||
| photoresistor_sensor_mqtt_v1 | ||
| pixels_dice_tray | ||
| pov_display | ||
| project_cars_shiftlight | ||
| pwm_outputs | ||
| quinled-an-penta | ||
| rgb-rotary-encoder | ||
| rotary_encoder_change_effect | ||
| sd_card | ||
| sensors_to_mqtt | ||
| seven_segment_display | ||
| seven_segment_display_reloaded | ||
| sht | ||
| smartnest | ||
| stairway_wipe_basic | ||
| usermod_rotary_brightness_color | ||
| usermod_v2_HttpPullLightControl | ||
| usermod_v2_animartrix | ||
| usermod_v2_auto_save | ||
| usermod_v2_four_line_display_ALT | ||
| usermod_v2_klipper_percentage | ||
| usermod_v2_ping_pong_clock | ||
| usermod_v2_rotary_encoder_ui_ALT | ||
| usermod_v2_word_clock | ||
| wireguard | ||
| wizlights | ||
| word-clock-matrix | ||
| readme.md | ||
readme.md
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.mdoutlining 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 :)