b33e28835d
* UM QuinLED-An-Penta: First version * UM QuinLED-An-Penta: Made OLED seconds a setting; small improvements * UM QuinLED-An-Penta: Fixed unique ID * Merge branch 'master' of https://github.com/Aircoookie/WLED * UM QuinLED-An-Penta: Fixed config loading * UM QuinLED-An-Penta: Replaced ledcRead() with calculating the percentage * UM QuinLED-An-Penta: Fixed temp sensor readings * UM QuinLED-An-Penta: Removing OLED bus clk setting * UM QuinLED-An-Penta: ETH support, lots of OLED improvements
69 lines
3.5 KiB
Markdown
69 lines
3.5 KiB
Markdown
# QuinLED-An-Penta
|
|
The (un)official usermod to get the best out of the QuinLED-An-Penta, like using the OLED and the SHT30 temperature/humidity sensor.
|
|
|
|
## Requirements
|
|
* "u8gs" by olikraus, v2.28 or higher: https://github.com/olikraus/u8g2
|
|
* "SHT85" by Rob Tillaart, v0.2 or higher: https://github.com/RobTillaart/SHT85
|
|
|
|
## 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 and add the buildflag `-D QUINLED_AN_PENTA`.
|
|
|
|
ESP32 (**without** ethernet):
|
|
```
|
|
[env:custom_esp32dev_usermod_quinled_an_penta]
|
|
extends = env:esp32dev
|
|
build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32 -D QUINLED_AN_PENTA
|
|
lib_deps = ${esp32.lib_deps}
|
|
olikraus/U8g2@~2.28.8
|
|
robtillaart/SHT85@~0.2.0
|
|
```
|
|
|
|
ESP32 (**with** ethernet):
|
|
```
|
|
[env:custom_esp32dev_usermod_quinled_an_penta]
|
|
extends = env:esp32dev
|
|
build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_Ethernet -D WLED_USE_ETHERNET -D QUINLED_AN_PENTA
|
|
lib_deps = ${esp32.lib_deps}
|
|
olikraus/U8g2@~2.28.8
|
|
robtillaart/SHT85@~0.2.0
|
|
```
|
|
|
|
## Some words about the (optional) OLED
|
|
This mod has been optimized for an SSD1306 driven 128x64 OLED. Using a smaller OLED or an OLED using a different driver will result in unexpected results.
|
|
I highly recommend using these "two color monochromatic OLEDs", which have the first 16 pixels in a different color than the other 48, e.g. a yellow/blue OLED.
|
|
Also note, you need to have an **SPI** driven OLED, **not i2c**!
|
|
|
|
### My OLED flickers after some time, what should I do?
|
|
That's a tricky one: During development I saw that the OLED sometimes starts to "bug out" / flicker and won't work anymore. This seems to be caused by the high PWM interference the board produces. It seems to loose it's settings and then doesn't know how to draw anymore. Turns out the only way to fix this is to call the libraries `begin()` method again which will re-initialize the display.
|
|
If you're facing this issue, you can enable a setting I've added which will call the `begin()` roughly every 60 seconds between a page change. This will make the page change take ~500ms, but will fix the display.
|
|
|
|
## Configuration
|
|
Navigate to the "Config" and then to the "Usermods" section. If you compiled WLED with `-D QUINLED_AN_PENTA`, you will see the config for it there:
|
|
* Enable-OLED:
|
|
* What it does: Enabled the optional SPI driven OLED that can be mounted to the 7-pin female header
|
|
* Possible values: Enabled/Disabled
|
|
* Default: Disabled
|
|
* OLED-Use-Progress-Bars:
|
|
* What it does: Toggle between showing percentage numbers or a progress-bar-like visualization for overall brightness and each LED channels brightness level
|
|
* Possible values: Enabled/Disabled
|
|
* Default: Disabled
|
|
* OLED-Flip-Screen-180:
|
|
* What it does: Flips the screen 180° / upside-down
|
|
* Possible values: Enabled/Disabled
|
|
* Default: Disabled
|
|
* OLED-Seconds-Per-Page:
|
|
* What it does: Defines how long the OLED should stay on one page in seconds before changing to the next
|
|
* Possible values: Enabled/Disabled
|
|
* Default: 10
|
|
* OLED-Fix-Bugged-Screen:
|
|
* What it does: Enable this if your OLED flickers after some time. For more info read above under ["My OLED flickers after some time, what should I do?"](#My-OLED-flickers-after-some-time-what-should-I-do)
|
|
* Possible values: Enabled/Disabled
|
|
* Default: Disabled
|
|
* Enable-SHT30-Temp-Humidity-Sensor:
|
|
* What it does: Enabled the onboard SHT30 temperature and humidity sensor
|
|
* Possible values: Enabled/Disabled
|
|
* Default: Disabled
|
|
|
|
## Change log
|
|
2021-10
|
|
* First implementation. |