WLED/usermods/Temperature/readme.md

# Temperature usermod

Based on the excellent `QuinLED_Dig_Uno_Temp_MQTT` by srg74 and 400killer!  
This usermod will read from an attached DS18B20 temperature sensor (as available on the QuinLED Dig-Uno)  
The temperature is displayed both in the Info section of the web UI as well as published to the `/temperature` MQTT topic if enabled.  
This usermod will be expanded with support for different sensor types in the future.

If temperature sensor is not detected during boot, this usermod will be disabled.

## Installation

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

* `USERMOD_DALLASTEMPERATURE`                      - define this to have this user mod included wled00\usermods_list.cpp
* `USERMOD_DALLASTEMPERATURE_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 20 seconds

All parameters can be configured at runtime using Usermods settings page.

## Project link

* [QuinLED-Dig-Uno](https://quinled.info/2018/09/15/quinled-dig-uno/) - Project link

### PlatformIO requirements

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


If you are not using `platformio_override.ini`, you might have to uncomment `DallasTemperature@~3.8.0`,`OneWire@~2.3.5 under` `[common]` section in `platformio.ini`:

```ini
# platformio.ini
...
[platformio]
...
; default_envs = esp07
default_envs = d1_mini
...
[common]
...
lib_deps =
  ...
  #For Dallas sensor uncomment following line
  OneWire@~2.3.5
...
```

## Change Log

2020-09-12 
* Changed to use async, non-blocking implementation
* Do not report low temperatures that indicate an error to mqtt
* Disable plugin if temperature sensor not detected
* Report the number of seconds until the first read in the info screen instead of sensor error
2021-04
* Adaptation for runtime configuration.
Added v2 usermods API 2020-05-28 02:20:02 +02:00			`# Temperature usermod`

Added Sunrise nightlight mode and more UI features - Added Sunrise nightlight mode - Added Chunchun effect - Added `LO` (live override) command to HTTP API - Added `mode` to `nl` object of JSON state API, deprecating `fade` - Added light color scheme support to web UI (click sun next to brightness slider) - Added option to hide labels in web UI (click flame icon next to intensity slider) - Added hex color input (click palette icon next to palette select) (resolves #506) - Added support for RGB sliders (need to set in localstorage) - Added support for custom background color or image (need to set in localstorage) - Added option to hide bottom tab bar in PC mode (need to set in localstorage) - Fixed transition lag with multiple segments (fixes #985) - Changed Nightlight wording (resolves #940) 2020-06-22 12:30:31 +02:00			Based on the excellent `QuinLED_Dig_Uno_Temp_MQTT` by srg74 and 400killer!
Added v2 usermods API 2020-05-28 02:20:02 +02:00			`This usermod will read from an attached DS18B20 temperature sensor (as available on the QuinLED Dig-Uno)`
			The temperature is displayed both in the Info section of the web UI as well as published to the `/temperature` MQTT topic if enabled.
			`This usermod will be expanded with support for different sensor types in the future.`

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

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`

			* `USERMOD_DALLASTEMPERATURE` - define this to have this user mod included wled00\usermods_list.cpp
			* `USERMOD_DALLASTEMPERATURE_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 20 seconds
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			`All parameters can be configured at runtime using Usermods settings page.`

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`

			`### 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`.


			If you are not using `platformio_override.ini`, you might have to uncomment `DallasTemperature@~3.8.0`,`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`
Added v2 usermods API 2020-05-28 02:20:02 +02:00			`OneWire@~2.3.5`
			`...`
			```
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`
			`* Changed to use async, non-blocking implementation`
			`* Do not report low temperatures that indicate an error to mqtt`
			`* 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`
			`* Adaptation for runtime configuration.`