Skip to content

Commit eb376d2

Browse files
RobTillaartRobTillaart
committed
0.1.0 I2C_LCD
1 parent 380fb0b commit eb376d2

File tree

17 files changed

+917
-0
lines changed

17 files changed

+917
-0
lines changed

‎libraries/I2C_LCD/.arduino-ci.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
platforms:
2+
rpipico:
3+
board: rp2040:rp2040:rpipico
4+
package: rp2040:rp2040
5+
gcc:
6+
features:
7+
defines:
8+
- ARDUINO_ARCH_RP2040
9+
warnings:
10+
flags:
11+
12+
packages:
13+
rp2040:rp2040:
14+
url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
15+
16+
compile:
17+
# Choosing to run compilation tests on 2 different Arduino platforms
18+
platforms:
19+
- uno
20+
# - due
21+
# - zero
22+
# - leonardo
23+
- m4
24+
- esp32
25+
- esp8266
26+
# - mega2560
27+
- rpipico
28+

‎libraries/I2C_LCD/.github/FUNDING.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: RobTillaart
4+

‎libraries/I2C_LCD/.github/workflows/arduino-lint.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
name: Arduino-lint
3+
4+
on: [push, pull_request]
5+
jobs:
6+
lint:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v3
10+
- uses: arduino/arduino-lint-action@v1
11+
with:
12+
library-manager: update
13+
compliance: strict

‎libraries/I2C_LCD/.github/workflows/arduino_test_runner.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Arduino CI
3+
4+
on: [push, pull_request]
5+
6+
jobs:
7+
runTest:
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v3
12+
- uses: ruby/setup-ruby@v1
13+
with:
14+
ruby-version: 2.6
15+
- run: |
16+
gem install arduino_ci
17+
arduino_ci.rb

‎libraries/I2C_LCD/.github/workflows/jsoncheck.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: JSON check
2+
3+
on:
4+
push:
5+
paths:
6+
- '**.json'
7+
pull_request:
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- name: json-syntax-check
15+
uses: limitusus/json-syntax-check@v1
16+
with:
17+
pattern: "\\.json$"
18+

‎libraries/I2C_LCD/CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Change Log I2C_LCD
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/).
7+
8+
9+
## [0.1.0] - 2023-12-16
10+
- initial version
11+
- goal is to optimize footprint & performance
12+

‎libraries/I2C_LCD/I2C_LCD.cpp

Lines changed: 251 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,251 @@
1+
//
2+
// FILE: I2C_LCD.cpp
3+
// AUTHOR: [email protected]
4+
// VERSION: 0.1.0
5+
// DATE: 2023-12-16
6+
// PUPROSE: Arduino library for I2C_LCD
7+
// URL: https://github.com/RobTillaart/I2C_LCD
8+
9+
10+
#include "I2C_LCD.h"
11+
12+
13+
// TODO redo simplify names shorter
14+
// or keep them compatible?
15+
#define I2C_LCD_CLEARDISPLAY 0x01
16+
#define I2C_LCD_RETURNHOME 0x02
17+
#define I2C_LCD_ENTRYMODESET 0x04
18+
#define I2C_LCD_DISPLAYCONTROL 0x08
19+
#define I2C_LCD_CURSORSHIFT 0x10
20+
#define I2C_LCD_FUNCTIONSET 0x20
21+
#define I2C_LCD_SETCGRAMADDR 0x40
22+
#define I2C_LCD_SETDDRAMADDR 0x80
23+
24+
#define I2C_LCD_ENTRYRIGHT 0x00
25+
#define I2C_LCD_ENTRYLEFT 0x02
26+
#define I2C_LCD_ENTRYSHIFTINCREMENT 0x01
27+
#define I2C_LCD_ENTRYSHIFTDECREMENT 0x00
28+
29+
#define I2C_LCD_DISPLAYON 0x04
30+
#define I2C_LCD_DISPLAYOFF 0x00
31+
#define I2C_LCD_CURSORON 0x02
32+
#define I2C_LCD_CURSOROFF 0x00
33+
#define I2C_LCD_BLINKON 0x01
34+
#define I2C_LCD_BLINKOFF 0x00
35+
36+
#define I2C_LCD_DISPLAYMOVE 0x08
37+
#define I2C_LCD_CURSORMOVE 0x00
38+
#define I2C_LCD_MOVERIGHT 0x04
39+
#define I2C_LCD_MOVELEFT 0x00
40+
41+
#define I2C_LCD_8BITMODE 0x10
42+
#define I2C_LCD_4BITMODE 0x00
43+
#define I2C_LCD_2LINE 0x08
44+
#define I2C_LCD_1LINE 0x00
45+
#define I2C_LCD_5x10DOTS 0x04
46+
#define I2C_LCD_5x8DOTS 0x00
47+
48+
49+
I2C_LCD::I2C_LCD(uint8_t address, TwoWire * wire)
50+
{
51+
_address = address;
52+
_wire = wire;
53+
}
54+
55+
56+
void I2C_LCD::config (uint8_t address, uint8_t enable, uint8_t readwrite, uint8_t registerselect,
57+
uint8_t data4, uint8_t data5, uint8_t data6, uint8_t data7,
58+
uint8_t backlight)
59+
{
60+
if (_address != address) return; // compatible
61+
_enable = ( 1 << enable);
62+
_readWrite = ( 1 << readwrite);
63+
_registerSelect = ( 1 << registerselect);
64+
_dataPin[0] = ( 1 << data4);
65+
_dataPin[1] = ( 1 << data5);
66+
_dataPin[2] = ( 1 << data6);
67+
_dataPin[3] = ( 1 << data7);
68+
_backLight = ( 1 << backlight);
69+
70+
_pinsInOrder = ((data4 < data5) && (data5 < data6) && (data6 < data7));
71+
}
72+
73+
74+
void I2C_LCD::begin(uint8_t cols, uint8_t rows)
75+
{
76+
_cols = cols;
77+
_rows = rows;
78+
79+
// ALL LOW.
80+
_wire->beginTransmission(_address);
81+
_wire->write(0x00);
82+
_wire->endTransmission();
83+
84+
// wait for 50 ms
85+
delay(50);
86+
87+
// Force 4 bit mode // todo timing...
88+
write4bits(0x03);
89+
delay(5);
90+
write4bits(0x03);
91+
delay(1);
92+
write4bits(0x03);
93+
delay(1);
94+
write4bits(0x02);
95+
delay(1);
96+
97+
// set "two" lines LCD - always a 20 x 4 for now.
98+
sendCommand(I2C_LCD_FUNCTIONSET | I2C_LCD_2LINE);
99+
}
100+
101+
102+
void I2C_LCD::setBacklight(bool on)
103+
{
104+
if (on) display(); // todo fix for real.
105+
else noDisplay();
106+
}
107+
108+
109+
void I2C_LCD::display()
110+
{
111+
sendCommand(I2C_LCD_DISPLAYCONTROL | I2C_LCD_DISPLAYON );
112+
}
113+
114+
115+
void I2C_LCD::noDisplay()
116+
{
117+
sendCommand(I2C_LCD_DISPLAYCONTROL | I2C_LCD_DISPLAYOFF);
118+
}
119+
120+
121+
void I2C_LCD::clear()
122+
{
123+
sendCommand(I2C_LCD_CLEARDISPLAY);
124+
delay(2);
125+
}
126+
127+
128+
void I2C_LCD::home()
129+
{
130+
sendCommand(I2C_LCD_RETURNHOME);
131+
delay(2);
132+
}
133+
134+
135+
void I2C_LCD::setCursor(uint8_t col, uint8_t row)
136+
{
137+
uint8_t startpos[4] = { 0x00, 0x40, 0x14, 0x54 };
138+
sendCommand(I2C_LCD_SETDDRAMADDR | (startpos[row] + col) );
139+
}
140+
141+
142+
size_t I2C_LCD::write(uint8_t c)
143+
{
144+
sendData(c); // add timestamp..
145+
return 1;
146+
};
147+
148+
149+
//////////////////////////////////////////////////////////
150+
//
151+
// PRIVATE
152+
//
153+
154+
// TODO merge these two
155+
// optimize 95% identical.
156+
void I2C_LCD::sendCommand(uint8_t value)
157+
{
158+
uint8_t MSN = _backLight;
159+
uint8_t LSN = MSN;
160+
161+
// pins are in the right order.
162+
// TODO determine a flag and
163+
if (_pinsInOrder)
164+
{
165+
MSN |= value & 0xF0;
166+
LSN |= value << 4;
167+
}
168+
else
169+
{
170+
uint8_t tmp = value >> 4;
171+
for ( uint8_t i = 0; i < 4; i++ )
172+
{
173+
if ( tmp & 0x01 ) MSN |= _dataPin[i];
174+
tmp >>= 1;
175+
}
176+
tmp = value & 0x0F;
177+
for ( uint8_t i = 0; i < 4; i++ )
178+
{
179+
if ( tmp & 0x01 ) LSN |= _dataPin[i];
180+
tmp >>= 1;
181+
}
182+
}
183+
184+
_wire->beginTransmission(_address);
185+
_wire->write(MSN | _enable);
186+
_wire->write(MSN);
187+
_wire->write(LSN | _enable);
188+
_wire->write(LSN);
189+
_wire->endTransmission();
190+
}
191+
192+
193+
void I2C_LCD::sendData(uint8_t value)
194+
{
195+
uint8_t MSN = _registerSelect | _backLight;
196+
uint8_t LSN = MSN;
197+
198+
// if pins are in the right order speed up.
199+
// todo determine a flag in config.
200+
if (_pinsInOrder)
201+
{
202+
MSN |= value & 0xF0;
203+
LSN |= value << 4;
204+
}
205+
else
206+
{
207+
uint8_t tmp = value >> 4;
208+
for ( uint8_t i = 0; i < 4; i++ )
209+
{
210+
if ( tmp & 0x01 ) MSN |= _dataPin[i];
211+
tmp >>= 1;
212+
}
213+
tmp = value & 0x0F;
214+
for ( uint8_t i = 0; i < 4; i++ )
215+
{
216+
if ( tmp & 0x01 ) LSN |= _dataPin[i];
217+
tmp >>= 1;
218+
}
219+
}
220+
221+
_wire->beginTransmission(_address);
222+
_wire->write(MSN | _enable);
223+
_wire->write(MSN);
224+
_wire->write(LSN | _enable);
225+
_wire->write(LSN);
226+
_wire->endTransmission();
227+
}
228+
229+
230+
// really needed for setup
231+
void I2C_LCD::write4bits(uint8_t value)
232+
{
233+
uint8_t cmd = _backLight;
234+
235+
for ( uint8_t i = 0; i < 4; i++ )
236+
{
237+
if ( value & 0x01 ) cmd |= _dataPin[i];
238+
value >>= 1;
239+
}
240+
241+
_wire->beginTransmission(_address);
242+
_wire->write(cmd | _enable);
243+
// _wire->endTransmission();
244+
// _wire->beginTransmission(_address);
245+
_wire->write(cmd);
246+
_wire->endTransmission();
247+
}
248+
249+
250+
// -- END OF FILE --
251+

0 commit comments

Comments
 (0)