lba.gitea/WLED
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
cf48ad06ed
WLED/usermods/Temperature/readme.md

63 lines
2.3 KiB
Markdown
Raw Normal View History

Added v2 usermods API
2020-05-28 02:20:02 +02:00
# Temperature usermod
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org>
2022-12-10 16:12:55 +01:00
Based on the excellent `QuinLED_Dig_Uno_Temp_MQTT` usermod by srg74 and 400killer!
Reads an attached DS18B20 temperature sensor (as available on the QuinLED Dig-Uno)
Temperature is displayed in both the Info section of the web UI as well as published to the `/temperature` MQTT topic, if enabled.
May be expanded with support for different sensor types in the future.
Added v2 usermods API
2020-05-28 02:20:02 +02:00
Async temperature usermod (#1178) * Change Temperature usermod to use async reading to avoid blocking * Fix comparison on wait time * Add * Simplify logic in the loop method * Optimize calls to minimize latency, inform user how long till first measurement * disable usermod if sensor not found * Added debug statements on init, update readme * fix spelling error of celsius
2020-09-13 19:26:27 +02:00
If temperature sensor is not detected during boot, this usermod will be disabled.
Temperature usermod rewrite
2023-05-11 17:33:09 +02:00
Maintained by @blazoncek
Added v2 usermods API
2020-05-28 02:20:02 +02:00
## Installation
Async temperature usermod (#1178) * Change Temperature usermod to use async reading to avoid blocking * Fix comparison on wait time * Add * Simplify logic in the loop method * Optimize calls to minimize latency, inform user how long till first measurement * disable usermod if sensor not found * Added debug statements on init, update readme * fix spelling error of celsius
2020-09-13 19:26:27 +02:00
Copy the example `platformio_override.ini` to the root directory. This file should be placed in the same directory as `platformio.ini`.
### Define Your Options
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org>
2022-12-10 16:12:55 +01:00
* `USERMOD_DALLASTEMPERATURE` - enables this user mod wled00/usermods_list.cpp
Temperature usermod rewrite
2023-05-11 17:33:09 +02:00
* `USERMOD_DALLASTEMPERATURE_MEASUREMENT_INTERVAL` - number of milliseconds between measurements, defaults to 60000 ms (60s)
Added v2 usermods API
2020-05-28 02:20:02 +02:00
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org>
2022-12-10 16:12:55 +01:00
All parameters can be configured at runtime via the Usermods settings page, including pin, temperature in degrees Celsius or Farenheit and measurement interval.
User configurable usermods. - Utilizing addToConfig() & readFromConfig() - UM configuration Settings page - MQTT support for usermods - A few sample usermods including rewritten Temparature and new Multi-Relay
2021-05-07 12:41:39 +02:00
Added v2 usermods API
2020-05-28 02:20:02 +02:00
## Project link
* [QuinLED-Dig-Uno](https://quinled.info/2018/09/15/quinled-dig-uno/) - Project link
Updated usermod readme and usability enhancements.
2021-05-17 12:52:27 +02:00
* [Srg74-WLED-Wemos-shield](https://github.com/srg74/WLED-wemos-shield) - another great DIY WLED board
Added v2 usermods API
2020-05-28 02:20:02 +02:00
### PlatformIO requirements
Async temperature usermod (#1178) * Change Temperature usermod to use async reading to avoid blocking * Fix comparison on wait time * Add * Simplify logic in the loop method * Optimize calls to minimize latency, inform user how long till first measurement * disable usermod if sensor not found * Added debug statements on init, update readme * fix spelling error of celsius
2020-09-13 19:26:27 +02:00
If you are using `platformio_override.ini`, you should be able to refresh the task list and see your custom task, for example `env:d1_mini_usermod_dallas_temperature_C`.
Updated usermod readme and usability enhancements.
2021-05-17 12:52:27 +02:00
If you are not using `platformio_override.ini`, you might have to uncomment `OneWire@~2.3.5 under` `[common]` section in `platformio.ini`:
Added v2 usermods API
2020-05-28 02:20:02 +02:00
```ini
# platformio.ini
...
[platformio]
...
; default_envs = esp07
default_envs = d1_mini
...
[common]
...
Updated readme.md Updated readme.md because currenly the DallasTemperature and Onewire are under `lib_deps`.
2021-03-30 11:45:48 +02:00
lib_deps =
Added v2 usermods API
2020-05-28 02:20:02 +02:00
...
User configurable usermods. - Utilizing addToConfig() & readFromConfig() - UM configuration Settings page - MQTT support for usermods - A few sample usermods including rewritten Temparature and new Multi-Relay
2021-05-07 12:41:39 +02:00
#For Dallas sensor uncomment following line
Temperature usermod rewrite
2023-05-11 17:33:09 +02:00
OneWire@~2.3.7
# ... or you may want to use following with ESP32
; https://github.com/blazoncek/OneWire.git # fixes Sensor error on ESP32...
Added v2 usermods API
2020-05-28 02:20:02 +02:00
```
Async temperature usermod (#1178) * Change Temperature usermod to use async reading to avoid blocking * Fix comparison on wait time * Add * Simplify logic in the loop method * Optimize calls to minimize latency, inform user how long till first measurement * disable usermod if sensor not found * Added debug statements on init, update readme * fix spelling error of celsius
2020-09-13 19:26:27 +02:00
## Change Log
2020-09-12
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org>
2022-12-10 16:12:55 +01:00
* Changed to use async non-blocking implementation
* Do not report erroneous low temperatures to MQTT
Async temperature usermod (#1178) * Change Temperature usermod to use async reading to avoid blocking * Fix comparison on wait time * Add * Simplify logic in the loop method * Optimize calls to minimize latency, inform user how long till first measurement * disable usermod if sensor not found * Added debug statements on init, update readme * fix spelling error of celsius
2020-09-13 19:26:27 +02:00
* Disable plugin if temperature sensor not detected
Updated readme.md Updated readme.md because currenly the DallasTemperature and Onewire are under `lib_deps`.
2021-03-30 11:45:48 +02:00
* Report the number of seconds until the first read in the info screen instead of sensor error
User configurable usermods. - Utilizing addToConfig() & readFromConfig() - UM configuration Settings page - MQTT support for usermods - A few sample usermods including rewritten Temparature and new Multi-Relay
2021-05-07 12:41:39 +02:00
2021-04
Spelling check by @wthomson (#2940) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org>
2022-12-10 16:12:55 +01:00
* Adaptation for runtime configuration.
Temperature usermod rewrite
2023-05-11 17:33:09 +02:00
2023-05
* Rewrite to conform to newer recommendations.
* Recommended @blazoncek fork of OneWire for ESP32 to avoid Sensor error
Reference in New Issue Copy Permalink