WLED/usermods
Maximilian Mewes f04c9d101e
Added usermod "battery status basic" (#2127)
* added usermod battery_status_basic

* test.. something is wrong

* Squashed commit of the following:

commit 0f845527c53f838e2c68d50ec3e9d6c68c4cee46
Author: itCarl <mewes.maximilian@gmx.de>
Date:   Tue Aug 10 18:35:15 2021 +0200

    updated readme and added image showing info modal

commit 055579fcf71796519d00566452030f31798121d0
Author: itCarl <mewes.maximilian@gmx.de>
Date:   Mon Aug 9 20:53:07 2021 +0200

    small map function fix

commit 811614cf9e73f4731acb234d0d210a7b19565e9a
Author: itCarl <mewes.maximilian@gmx.de>
Date:   Mon Aug 9 19:35:21 2021 +0200

    updated ui

commit cadf2e23b7
Author: itCarl <mewes.maximilian@gmx.de>
Date:   Mon Aug 9 16:07:32 2021 +0200

    added usermod battery_status_basic

* updated readme, changed USERMOD_BATTERY_MIN_VOLTAGE default to 2.6 volt

* fixed readme image file naming

* added usermod settings for runtime changes

* fixed copy and paste mistake

* undo ui changes

* reworked addToJsonInfo() to make it compatible with the standard Info page.

* removed images from readme

* added ESP32 support

* updated readme
2021-08-20 20:42:46 +02:00
..
Animated_Staircase Renamed `NOTIFIER_CALL_MODE_` to `CALL_MODE_` 2021-07-09 18:54:28 +02:00
Artemis_reciever
BME280_v2
DHT
ESP32_TouchBrightnessControl
EXAMPLE_v2
EleksTube_IPS
Enclosure_with_OLED_temp_ESP07
Fix_unreachable_netservices_v2
JSON_IR_remote
PIR_sensor_mqtt_v1
PIR_sensor_switch Added PIR option to trigger only if WLED is off. 2021-07-23 18:43:51 +02:00
QuinLED_Dig_Uno_Temp_MQTT
RTC
SN_Photoresistor
ST7789_display
TTGO-T-Display
Temperature
UserModv2_SunRiseAndSet
VL53L0X_gestures
Wemos_D1_mini+Wemos32_mini_shield
battery_keypad_controller Renamed `NOTIFIER_CALL_MODE_` to `CALL_MODE_` 2021-07-09 18:54:28 +02:00
battery_status_basic Added usermod "battery status basic" (#2127) 2021-08-20 20:42:46 +02:00
blynk_relay_control
buzzer
esp32_multistrip
mpu6050_imu
mqtt_switch_v2
multi_relay
photoresistor_sensor_mqtt_v1
project_cars_shiftlight
quinled_digquad_preassembled_unofficial_v0.1
rgb-rotary-encoder New usermod: Support for RGB Rotary Encoder Board (#2068) 2021-07-09 20:25:35 +02:00
rotary_encoder_change_effect Renamed `NOTIFIER_CALL_MODE_` to `CALL_MODE_` 2021-07-09 18:54:28 +02:00
sensors_to_mqtt
ssd1306_i2c_oled_u8g2
stairway_wipe_basic Renamed `NOTIFIER_CALL_MODE_` to `CALL_MODE_` 2021-07-09 18:54:28 +02:00
usermod_rotary_brightness_color Renamed `NOTIFIER_CALL_MODE_` to `CALL_MODE_` 2021-07-09 18:54:28 +02:00
usermod_v2_auto_save
usermod_v2_four_line_display Rotary Encoder Compilation fix. (#2085) 2021-07-20 13:41:30 +02:00
usermod_v2_mode_sort
usermod_v2_rotary_encoder_ui Rotary Encoder Compilation fix. (#2085) 2021-07-20 13:41:30 +02:00
word-clock-matrix Renamed `NOTIFIER_CALL_MODE_` to `CALL_MODE_` 2021-07-09 18:54:28 +02:00
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 :)