jeans/WLED
jeans/WLED
1
0
Fork 0
mirror of https://github.com/wled/WLED.git synced 2025-07-19 16:56:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed markdownlint errors

Browse Source
This commit is contained in:
srg74 2025-05-11 12:19:03 -04:00
parent 40653b0d6f
commit b5a710dbe4
5 changed files with 40 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
usermods/Temperature/readme.md
View File

@ -35,19 +35,23 @@ All parameters can be configured at runtime via the Usermods settings page, incl
## Change Log ## Change Log
2020-09-12 2020-09-12
* Changed to use async non-blocking implementation * Changed to use async non-blocking implementation
* Do not report erroneous low temperatures to MQTT * Do not report erroneous low temperatures to MQTT
* Disable plugin if temperature sensor not detected * Disable plugin if temperature sensor not detected
* Report the number of seconds until the first read in the info screen instead of sensor error * Report the number of seconds until the first read in the info screen instead of sensor error
2021-04 2021-04
* Adaptation for runtime configuration. * Adaptation for runtime configuration.
2023-05 2023-05
* Rewrite to conform to newer recommendations. * Rewrite to conform to newer recommendations.
* Recommended @blazoncek fork of OneWire for ESP32 to avoid Sensor error * Recommended @blazoncek fork of OneWire for ESP32 to avoid Sensor error
2024-09 2024-09
* Update OneWire to version 2.3.8, which includes stickbreaker's and garyd9's ESP32 fixes: * Update OneWire to version 2.3.8, which includes stickbreaker's and garyd9's ESP32 fixes:
blazoncek's fork is no longer needed blazoncek's fork is no longer needed

12
usermods/readme.md
View File

@ -1,4 +1,4 @@
### Usermods # Usermods
This folder serves as a repository for usermods (custom `usermod.cpp` files)! This folder serves as a repository for usermods (custom `usermod.cpp` files)!
@ -6,11 +6,11 @@ If you have created a usermod you believe is useful (for example to support a pa
In order for other people to be able to have fun with your usermod, please keep these points in mind: 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`) * Create a folder in this folder with a descriptive name (for example `usermod_ds18b20_temp_sensor_mqtt`)
- Include your custom files * 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 * 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! * Create a pull request!
- If your feature is useful for the majority of WLED users, I will consider adding it to the base code! * 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. 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. I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.

19
usermods/sht/readme.md
View File

@ -1,35 +1,43 @@
# SHT # SHT
Usermod to support various SHT i2c sensors like the SHT30, SHT31, SHT35 and SHT85 Usermod to support various SHT i2c sensors like the SHT30, SHT31, SHT35 and SHT85
## Requirements ## Requirements
* "SHT85" by Rob Tillaart, v0.2 or higher: https://github.com/RobTillaart/SHT85
* "SHT85" by Rob Tillaart, v0.2 or higher: <https://github.com/RobTillaart/SHT85>
## Usermod installation ## Usermod installation
Simply copy the below block (build task) to your `platformio_override.ini` and compile WLED using this new build task. Or use an existing one, add the custom_usermod `sht`. Simply copy the below block (build task) to your `platformio_override.ini` and compile WLED using this new build task. Or use an existing one, add the custom_usermod `sht`.
ESP32: ESP32:
```
```ini
[env:custom_esp32dev_usermod_sht] [env:custom_esp32dev_usermod_sht]
extends = env:esp32dev extends = env:esp32dev
custom_usermods = ${env:esp32dev.custom_usermods} sht custom_usermods = ${env:esp32dev.custom_usermods} sht
``` ```
ESP8266: ESP8266:
```
```ini
[env:custom_d1_mini_usermod_sht] [env:custom_d1_mini_usermod_sht]
extends = env:d1_mini extends = env:d1_mini
custom_usermods = ${env:d1_mini.custom_usermods} sht custom_usermods = ${env:d1_mini.custom_usermods} sht
``` ```
## MQTT Discovery for Home Assistant ## MQTT Discovery for Home Assistant
If you're using Home Assistant and want to have the temperature and humidity available as entities in HA, you can tick the "Add-To-Home-Assistant-MQTT-Discovery" option in the usermod settings. If you have an MQTT broker configured under "Sync Settings" and it is connected, the mod will publish the auto discovery message to your broker and HA will instantly find it and create an entity each for the temperature and humidity. If you're using Home Assistant and want to have the temperature and humidity available as entities in HA, you can tick the "Add-To-Home-Assistant-MQTT-Discovery" option in the usermod settings. If you have an MQTT broker configured under "Sync Settings" and it is connected, the mod will publish the auto discovery message to your broker and HA will instantly find it and create an entity each for the temperature and humidity.
### Publishing readings via MQTT ### Publishing readings via MQTT
Regardless of having MQTT discovery ticked or not, the mod will always report temperature and humidity to the WLED MQTT topic of that instance, if you have a broker configured and it's connected. Regardless of having MQTT discovery ticked or not, the mod will always report temperature and humidity to the WLED MQTT topic of that instance, if you have a broker configured and it's connected.
## Configuration ## Configuration
Navigate to the "Config" and then to the "Usermods" section. If you compiled WLED with `-D USERMOD_SHT`, you will see the config for it there: Navigate to the "Config" and then to the "Usermods" section. If you compiled WLED with `-D USERMOD_SHT`, you will see the config for it there:
* SHT-Type: * SHT-Type:
* What it does: Select the SHT sensor type you want to use * What it does: Select the SHT sensor type you want to use
* Possible values: SHT30, SHT31, SHT35, SHT85 * Possible values: SHT30, SHT31, SHT35, SHT85
@ -44,8 +52,11 @@ Navigate to the "Config" and then to the "Usermods" section. If you compiled WLE
* Default: Disabled * Default: Disabled
## Change log ## Change log
2022-12 2022-12
* First implementation. * First implementation.
## Credits ## Credits
ezcGman | Andy: Find me on the Intermit.Tech (QuinLED) Discord server: https://discord.gg/WdbAauG
ezcGman | Andy: Find me on the Intermit.Tech (QuinLED) Discord server: <https://discord.gg/WdbAauG>

21
usermods/usermod_v2_four_line_display_ALT/readme.md
View File

@ -5,6 +5,7 @@ This usermod could be used in compination with `usermod_v2_rotary_encoder_ui_ALT
## Functionalities ## Functionalities
Press the encoder to cycle through the options: Press the encoder to cycle through the options:
* Brightness * Brightness
* Speed * Speed
* Intensity * Intensity
@ -35,15 +36,15 @@ These options are configurable in Config > Usermods
* `enabled` - enable/disable usermod * `enabled` - enable/disable usermod
* `type` - display type in numeric format * `type` - display type in numeric format
* 1 = I2C SSD1306 128x32 * 1 = I2C SSD1306 128x32
* 2 = I2C SH1106 128x32 * 2 = I2C SH1106 128x32
* 3 = I2C SSD1306 128x64 (4 double-height lines) * 3 = I2C SSD1306 128x64 (4 double-height lines)
* 4 = I2C SSD1305 128x32 * 4 = I2C SSD1305 128x32
* 5 = I2C SSD1305 128x64 (4 double-height lines) * 5 = I2C SSD1305 128x64 (4 double-height lines)
* 6 = SPI SSD1306 128x32 * 6 = SPI SSD1306 128x32
* 7 = SPI SSD1306 128x64 (4 double-height lines) * 7 = SPI SSD1306 128x64 (4 double-height lines)
* 8 = SPI SSD1309 128x64 (4 double-height lines) * 8 = SPI SSD1309 128x64 (4 double-height lines)
* 9 = I2C SSD1309 128x64 (4 double-height lines) * 9 = I2C SSD1309 128x64 (4 double-height lines)
* `pin` - GPIO pins used for display; SPI displays can use SCK, MOSI, CS, DC & RST * `pin` - GPIO pins used for display; SPI displays can use SCK, MOSI, CS, DC & RST
* `flip` - flip/rotate display 180° * `flip` - flip/rotate display 180°
* `contrast` - set display contrast (higher contrast may reduce display lifetime) * `contrast` - set display contrast (higher contrast may reduce display lifetime)
@ -53,7 +54,6 @@ These options are configurable in Config > Usermods
* `showSeconds` - Show seconds on the clock display * `showSeconds` - Show seconds on the clock display
* `i2c-freq-kHz` - I2C clock frequency in kHz (may help reduce dropped frames, range: 400-3400) * `i2c-freq-kHz` - I2C clock frequency in kHz (may help reduce dropped frames, range: 400-3400)
### PlatformIO requirements ### PlatformIO requirements
Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`. Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`.
@ -61,4 +61,5 @@ Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`.
## Change Log ## Change Log
2021-10 2021-10
* First public release * First public release

2
usermods/usermod_v2_rotary_encoder_ui_ALT/readme.md
View File

@ -5,6 +5,7 @@ This usermod supports the UI of the `usermod_v2_rotary_encoder_ui_ALT`.
## Functionalities ## Functionalities
Press the encoder to cycle through the options: Press the encoder to cycle through the options:
* Brightness * Brightness
* Speed * Speed
* Intensity * Intensity
@ -39,4 +40,5 @@ No special requirements.
## Change Log ## Change Log
2021-10 2021-10
* First public release * First public release