This library is meant to simplify the display of UPT measurements on supported boards (see below).
This library is part of Sensirion Unified Prototyping Toolkit (UPT). A set of libraries aiming to simplify the creation of environment monitoring devices.
A simple example about how to use the library is provided in basicUsage.ino.
The library has been designed for Lilygo T-Display S3 but could be used with other display/board combo.
Some more references and documentation will be added in the future. Feel free to contribute with your findings as well.
Here is the list of supported and tested displays:
| Board | UserSetup | Remarks / Necessary changes |
|---|---|---|
| Lilygo T-Display S3 | Setup206_LilyGo_T_Display_S3 | Our target device |
| Lilygo TTGO T-Display | Setup25_TTGO_T_Display | Requires loading smaller fonts |
| Lilygo T-embed | Setup210_LilyGo_T_Embed_S3 | Requires raising pin 46 to high on setup |
For the time being, the library comes with a limited set of functionalities.
2 orientations are available: portrait and landscape.
The used orientation can be selected on initialization using the UptDisplay::init method.
The measurements are displayed in a grid with a legend on the bottom. The tiling supports between 1 and 8 signals, but more than 6 signals tend to look crowded on the hardware we use.
This method will wipe and redraw the whole screen (background + values). It should be called on first draw.
This method will only wipe the values and the legend. The background will remain. It should be called to refresh the values in order to minimize unpleasant refresh artifacts.
This method will print the given text on a blank screen.
This method will print an information screen composed of an image and a list of key/value pairs. It can be used to show configuration alongside with a logo (or QR code) for example.
See the dedicated example.
The UPT-Display library depends on the great work done by the TFT_eSPI library.
After installation of the dependency, the right screen configuration needs to be selected using the User_Setup_Select.h.
I.e. for Lilygo T-Display S3 (our target board), the line #include <User_Setups/Setup206_LilyGo_T_Display_S3.h> needs to be uncommented.
Please refer to the documentation of the TFT_eSPI library for the most up-to-date installation instructions.
The font used is LiberationSans you can generate and define your own font header files using instructions from TFT_eSPI.
The font files are generated by Processing IDE using a sketch included in the library Tools folder of eSPI_TFT lib.
You will find the required charset configuration below.
The base character set required is:
0x0021, 0x007E, //Basic Latin, 128, 128, Latin (52), Common (76 characters)
the following extra characters are also needed:
static final int[] specificUnicodes = {
0x002B, // -
0x002D, // +
0x002E, // .
0x00B0, 0x00BA, // °
0x002F, // /
0x0025, // %
0x0028, // (
0x0029, // )
0x00B2, // ²
0x00B3, // ³
0x003A, // :
0x00B5, // µ
}
The font selection can be overwritten using #define UPT_DISPLAY_FONT_CONFIG as it is done in DefaultFont.h.
The easiest is to make a copy of DefaultFont.h (e.g., name it MyFont.h) and include it in your main script.
In your custom font header file, you can then redefine all the required sizes as follows:
#include "yourFont10.h"
...
#define UPT_DISPLAY_FONT_SMALL yourFont10
#define UPT_DISPLAY_FONT_MEDIUM yourFont12
#define UPT_DISPLAY_FONT_LARGE yourFont26
#define UPT_DISPLAY_FONT_XLARGE yourFont38