Skip to content

Commit c9fda4a

Browse files
update readme + correction DEMO.ino
1 parent f5ad84f commit c9fda4a

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
* [Overview](#overview)
1010
* [Installation](#installation)
1111
* [Dependency](#dependency)
12+
* [Documentation](#documentation)
1213
* [Software](#software)
1314
* [Examples](#examples)
1415
* [SPI](#spi)
@@ -32,7 +33,7 @@ C++ Library for a ST7735 TFT SPI LCD for the Arduino Eco-system.
3233
5. Advanced frame buffer mode included.
3334
6. Bitmaps supported: 1, 8 and 16 bit.
3435
7. Hardware & software SPI options
35-
8. Code commented for 'doxygen' API generation tool.
36+
8. [Project url link](https://github.com/gavinlyonsrepo/ST7735_LTSM)
3637

3738
## Installation
3839

@@ -45,7 +46,14 @@ the graphics, bitmaps, and font methods as well as font data and bitmap test dat
4546
where the user sets options(debug, advanced graphics and frame buffer mode).
4647
When you install 'ST7735_LTSM' with Arduino IDE. It should install 'display16_LTSM' as well after
4748
a prompt, if it does not you have to install it same way as 'ST7735_LTSM'.
48-
The 'display16_LTSM' project and readme is at [URL github link](https://github.com/gavinlyonsrepo/display16_LTSM)
49+
The 'display16_LTSM' project and readme is at [URL github link.](https://github.com/gavinlyonsrepo/display16_LTSM)
50+
'display16_LTSM' is also written by author of this library.
51+
52+
## Documentation
53+
54+
Code is commented for the 'doxygen' API generation tool.
55+
Documents on fonts, bitmaps and graphics can be found at
56+
the dependency 'display16_LTSM' repository, [URL github link](https://github.com/gavinlyonsrepo/display16_LTSM)
4957

5058
## Software
5159

@@ -132,20 +140,23 @@ Connections as setup in HELLO_WORLD.ino test file.
132140
5. Backlight on/off control is left to user.
133141

134142

135-
## Tested
143+
## Tested
144+
145+
Tested with both software and hardware SPI on:
146+
147+
- **ESP32**
148+
- **Arduino UNO R4 Minima**
149+
*Frame buffer example is not supported on this board.*
136150

137-
Tested (1-2) on following MCUs both software and hardware SPI,
151+
Compiled only (not fully hardware-tested) on:
138152

139-
1. ESP32
140-
2. UNO Minima R4 (Exception : Frame buffer example will not work here)
153+
- **Arduino UNO**
154+
- **ESP8266**
155+
- **STM32 “Blue Pill”**
141156

142-
Complied only on these 3-5. Note : many low RAM MCU will
143-
not work if a lot of fonts and bitmaps are used. In addition 'Frame Buffer mode requires
144-
Dynamic memory to hold a frame buffer. See dependency readme for more details.
157+
> Some examples on low-RAM MCUs will fail( insufficient memory ), numerous fonts and bitmap data are included.
158+
> Frame buffer mode requires sufficient dynamic memory for the buffer — see the README in display16_LTSM for details.
145159
146-
3. Arduino UNO & NANO v3
147-
4. ESP8266
148-
5. STM32 "blue pill"
149160

150161

151162
## Output

examples/DEMOS/DEMOS.ino

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,12 @@ void arcGauge(uint16_t countLimit)
101101
drawGaugeMarkers(x, y, radius, 150, 390, 1.3);
102102
drawGaugeMarkers(x, y, radius, 165, 375, 1.1);
103103
// Initialize random generator , optional
104-
// randomSeed(analogRead(A0));
104+
// randomSeed(analogRead(A0));
105105
while (count++ < countLimit)
106106
{
107107
int step = random(-10, 11); // Arduino built-in RNG
108108
currentValue += step;
109-
// Manual clamp
110-
if (currentValue < minValue) currentValue = minValue;
111-
if (currentValue > maxValue) currentValue = maxValue;
109+
currentValue = constrain(currentValue, minValue, maxValue);
112110
myTFT.setCursor(10, 100);
113111
if (oldValue != currentValue) {
114112
drawPointer(currentValue, oldValue, x, y, radius, myTFT.C_GREEN, myTFT.C_BLACK);

0 commit comments

Comments
 (0)