You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: usermods/readme.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
###Usermods
1
+
# Usermods
2
2
3
3
This folder serves as a repository for usermods (custom `usermod.cpp` files)!
4
4
5
5
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!
6
6
7
7
In order for other people to be able to have fun with your usermod, please keep these points in mind:
8
8
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!
14
14
15
15
While I do my best to not break too much, keep in mind that as WLED is updated, usermods might break.
16
16
I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.
Copy file name to clipboardExpand all lines: usermods/sht/readme.md
+15-4Lines changed: 15 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,43 @@
1
1
# SHT
2
+
2
3
Usermod to support various SHT i2c sensors like the SHT30, SHT31, SHT35 and SHT85
3
4
4
5
## 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>
6
8
7
9
## Usermod installation
8
10
9
11
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`.
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.
27
32
28
33
### Publishing readings via MQTT
34
+
29
35
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.
30
36
31
37
## Configuration
38
+
32
39
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
+
33
41
* SHT-Type:
34
42
* What it does: Select the SHT sensor type you want to use
35
43
* Possible values: SHT30, SHT31, SHT35, SHT85
@@ -44,8 +52,11 @@ Navigate to the "Config" and then to the "Usermods" section. If you compiled WLE
44
52
* Default: Disabled
45
53
46
54
## Change log
55
+
47
56
2022-12
57
+
48
58
* First implementation.
49
59
50
60
## 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>
0 commit comments