Skip to content

Commit b5a710d

Browse files
committed
Fixed markdownlint errors
1 parent 40653b0 commit b5a710d

File tree

5 files changed

+40
-22
lines changed

5 files changed

+40
-22
lines changed

usermods/Temperature/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,23 @@ All parameters can be configured at runtime via the Usermods settings page, incl
3535

3636
## Change Log
3737

38-
2020-09-12
38+
2020-09-12
39+
3940
* Changed to use async non-blocking implementation
4041
* Do not report erroneous low temperatures to MQTT
4142
* Disable plugin if temperature sensor not detected
4243
* Report the number of seconds until the first read in the info screen instead of sensor error
4344

4445
2021-04
46+
4547
* Adaptation for runtime configuration.
4648

4749
2023-05
50+
4851
* Rewrite to conform to newer recommendations.
4952
* Recommended @blazoncek fork of OneWire for ESP32 to avoid Sensor error
5053

5154
2024-09
55+
5256
* Update OneWire to version 2.3.8, which includes stickbreaker's and garyd9's ESP32 fixes:
53-
blazoncek's fork is no longer needed
57+
blazoncek's fork is no longer needed

usermods/readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
### Usermods
1+
# Usermods
22

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

55
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!
66

77
In order for other people to be able to have fun with your usermod, please keep these points in mind:
88

9-
- Create a folder in this folder with a descriptive name (for example `usermod_ds18b20_temp_sensor_mqtt`)
10-
- Include your custom files
11-
- If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one needs to take
12-
- Create a pull request!
13-
- If your feature is useful for the majority of WLED users, I will consider adding it to the base code!
9+
* Create a folder in this folder with a descriptive name (for example `usermod_ds18b20_temp_sensor_mqtt`)
10+
* Include your custom files
11+
* If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one needs to take
12+
* Create a pull request!
13+
* If your feature is useful for the majority of WLED users, I will consider adding it to the base code!
1414

1515
While I do my best to not break too much, keep in mind that as WLED is updated, usermods might break.
1616
I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.

usermods/sht/readme.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,43 @@
11
# SHT
2+
23
Usermod to support various SHT i2c sensors like the SHT30, SHT31, SHT35 and SHT85
34

45
## Requirements
5-
* "SHT85" by Rob Tillaart, v0.2 or higher: https://github.com/RobTillaart/SHT85
6+
7+
* "SHT85" by Rob Tillaart, v0.2 or higher: <https://github.com/RobTillaart/SHT85>
68

79
## Usermod installation
810

911
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`.
1012

1113
ESP32:
12-
```
14+
15+
```ini
1316
[env:custom_esp32dev_usermod_sht]
1417
extends = env:esp32dev
1518
custom_usermods = ${env:esp32dev.custom_usermods} sht
1619
```
1720

1821
ESP8266:
19-
```
22+
23+
```ini
2024
[env:custom_d1_mini_usermod_sht]
2125
extends = env:d1_mini
2226
custom_usermods = ${env:d1_mini.custom_usermods} sht
2327
```
2428

2529
## MQTT Discovery for Home Assistant
30+
2631
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.
2732

2833
### Publishing readings via MQTT
34+
2935
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.
3036

3137
## Configuration
38+
3239
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:
40+
3341
* SHT-Type:
3442
* What it does: Select the SHT sensor type you want to use
3543
* Possible values: SHT30, SHT31, SHT35, SHT85
@@ -44,8 +52,11 @@ Navigate to the "Config" and then to the "Usermods" section. If you compiled WLE
4452
* Default: Disabled
4553

4654
## Change log
55+
4756
2022-12
57+
4858
* First implementation.
4959

5060
## Credits
51-
ezcGman | Andy: Find me on the Intermit.Tech (QuinLED) Discord server: https://discord.gg/WdbAauG
61+
62+
ezcGman | Andy: Find me on the Intermit.Tech (QuinLED) Discord server: <https://discord.gg/WdbAauG>

usermods/usermod_v2_four_line_display_ALT/readme.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This usermod could be used in compination with `usermod_v2_rotary_encoder_ui_ALT
55
## Functionalities
66

77
Press the encoder to cycle through the options:
8+
89
* Brightness
910
* Speed
1011
* Intensity
@@ -35,15 +36,15 @@ These options are configurable in Config > Usermods
3536

3637
* `enabled` - enable/disable usermod
3738
* `type` - display type in numeric format
38-
* 1 = I2C SSD1306 128x32
39-
* 2 = I2C SH1106 128x32
40-
* 3 = I2C SSD1306 128x64 (4 double-height lines)
41-
* 4 = I2C SSD1305 128x32
42-
* 5 = I2C SSD1305 128x64 (4 double-height lines)
43-
* 6 = SPI SSD1306 128x32
44-
* 7 = SPI SSD1306 128x64 (4 double-height lines)
45-
* 8 = SPI SSD1309 128x64 (4 double-height lines)
46-
* 9 = I2C SSD1309 128x64 (4 double-height lines)
39+
* 1 = I2C SSD1306 128x32
40+
* 2 = I2C SH1106 128x32
41+
* 3 = I2C SSD1306 128x64 (4 double-height lines)
42+
* 4 = I2C SSD1305 128x32
43+
* 5 = I2C SSD1305 128x64 (4 double-height lines)
44+
* 6 = SPI SSD1306 128x32
45+
* 7 = SPI SSD1306 128x64 (4 double-height lines)
46+
* 8 = SPI SSD1309 128x64 (4 double-height lines)
47+
* 9 = I2C SSD1309 128x64 (4 double-height lines)
4748
* `pin` - GPIO pins used for display; SPI displays can use SCK, MOSI, CS, DC & RST
4849
* `flip` - flip/rotate display 180°
4950
* `contrast` - set display contrast (higher contrast may reduce display lifetime)
@@ -53,12 +54,12 @@ These options are configurable in Config > Usermods
5354
* `showSeconds` - Show seconds on the clock display
5455
* `i2c-freq-kHz` - I2C clock frequency in kHz (may help reduce dropped frames, range: 400-3400)
5556

56-
5757
### PlatformIO requirements
5858

5959
Note: the Four Line Display usermod requires the libraries `U8g2` and `Wire`.
6060

6161
## Change Log
6262

6363
2021-10
64+
6465
* First public release

usermods/usermod_v2_rotary_encoder_ui_ALT/readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This usermod supports the UI of the `usermod_v2_rotary_encoder_ui_ALT`.
55
## Functionalities
66

77
Press the encoder to cycle through the options:
8+
89
* Brightness
910
* Speed
1011
* Intensity
@@ -39,4 +40,5 @@ No special requirements.
3940
## Change Log
4041

4142
2021-10
43+
4244
* First public release

0 commit comments

Comments
 (0)