-
Notifications
You must be signed in to change notification settings - Fork 3
/
sh1107.py
423 lines (381 loc) · 16.7 KB
/
sh1107.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
# MicroPython SH1107 OLED driver, I2C interfaces
# tested with Raspberry Pi Pico and adafruit 1.12 inch QWIC OLED display
# sh1107 driver v319
__version__ = "v319"
__repo__ = "https://github.com/peter-l5/SH1107"
#
# The MIT License (MIT)
#
# Copyright (c) 2016 Radomir Dopieralski (@deshipu),
# 2017-2021 Robert Hammelrath (@robert-hh)
# 2021 Tim Weber (@scy)
# 2022-2023 Peter Lumb (peter-l5)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
#
# Sample code sections for RaspberryPi Pico pin assignments
# ------------ SPI ------------------
# Pin Map SPI
# - 3v3 - xxxxxx - Vcc
# - G - xxxxxx - Gnd
# - D7 - GPIO 15 - TX / MOSI fixed
# - D5 - GPIO 14 - SCK / Sck fixed
# - D8 - GPIO 13 - CS (optional, if the only connected device)
# - D2 - GPIO 21 - DC [Data/Command]
# - D1 - GPIO 20 - Res [reset]
#
# spi1 = SPI(1, baudrate=10_000_000, sck=Pin(14), mosi=Pin(15), miso=Pin(12))
# display = sh1107.SH1107_SPI(128, 128, spi1, Pin(21), Pin(20), Pin(13))
# display.sleep(False)
# display.fill(0)
# display.text('SH1107', 0, 0, 1)
# display.text('driver', 0, 8, 1)
# display.show()
#
# --------------- I2C ------------------
#
# reset PIN is not needed in some implementations
# Pin Map I2C
# - 3v3 - xxxxxx - Vcc
# - G - xxxxxx - Gnd
# - D2 - GPIO 5 - SCK / SCL
# - D1 - GPIO 4 - DIN / SDA
# - D0 - GPIO 16 - Res
# - G - xxxxxx CS
# - G - xxxxxx D/C
#
# using hardware I2C
# from machine import Pin, I2C
# import sh1107
#
# i2c0 = I2C(0, scl=Pin(5), sda=Pin(4), freq=400000)
# display = sh1107.SH1107_I2C(128, 128, i2c0, address=0x3d, rotate=90)
# display.sleep(False)
# display.fill(0)
# display.text('SH1107', 0, 0, 1)
# display.text('driver', 0, 8, 1)
# display.show()
__version__ = "v317"
__repo__ = "https://github.com/peter-l5/SH1107"
## SH1107 module code
from micropython import const
import time
# import extended framebuffer if available)
try:
import framebuf2 as framebuf
_fb_variant = 2
except:
import framebuf
_fb_variant = 1
print("SH1107: framebuf is ", ("standard" if _fb_variant ==1 else "extended") )
# a few register definitions with SH1107 data sheet reference numbers
_LOW_COLUMN_ADDRESS = const(0x00) # 1. Set Column Address 4 lower bits (POR = 00H)
_HIGH_COLUMN_ADDRESS = const(0x10) # 2. Set Column Address 4 higher bits (POR = 10H)
_MEM_ADDRESSING_MODE = const(0x20) # 3. Set Memory addressing mode
# 0x20 horizontal addressing; 0x21 vertical addressing
_SET_CONTRAST = const(0x8100) # 4. Set Contrast Control (double byte command)
_SET_SEGMENT_REMAP = const(0xa0) # 5. Set Segment Re-map: (A0H - A1H)
_SET_MULTIPLEX_RATIO = const(0xA800) # 6. Set Multiplex Ratio: (Double Bytes Command)
# duty = 1/64 [3f] or 128 [7f] (POR)
_SET_NORMAL_INVERSE = const(0xa6) # 8. Set Normal/Reverse Display: (A6H -A7H)
_SET_DISPLAY_OFFSET = const(0xD300) # 9. Set Display Offset: (Double Bytes Command)
# second byte may need amending for some displays
# some 128x64 displays (eg Adafruit feather wing 4650)
# require 0xD360
_SET_DC_DC_CONVERTER_SF = const(0xad81) # 10. Set DC-DC Setting (set charge pump enable)
# Set DC-DC enable (a=0:disable; a=1:enable)
# 0xad81 is POR value and may be needed for 128x64 displays
_SET_DISPLAY_OFF = const(0xae) # 11. Display OFF/ON: (AEH - AFH)
_SET_DISPLAY_ON = const(0xaf) # 11. Display OFF/ON: (AEH - AFH)
_SET_PAGE_ADDRESS = const(0xB0) # 12. Set Page Address (using 4 low bits)
_SET_SCAN_DIRECTION = const(0xC0) # 13. Set Common Output Scan Direction: (C0H - C8H)
_SET_DISP_CLK_DIV = const(0xD550) # 14. Set the frequency of the internal display clocks (DCLKs).
# 0x50 is the POR value
_SET_DIS_PRECHARGE = const(0xD922) # 15. Set the duration of the pre-charge period. The interval is counted in number of DCLK
# 0x22 is default POR value
_SET_VCOM_DSEL_LEVEL = const(0xDB35) # 16. This command is to set the common pad output voltage level at deselect stage.
# POR value 0x35 (0.77 * Vref)
_SET_DISPLAY_START_LINE = const(0xDC00) # 17. Set Display Start Line (double byte command)
class SH1107(framebuf.FrameBuffer):
def __init__(self, width, height, external_vcc, delay_ms=200, rotate=0):
self.width = width
self.height = height
self.external_vcc = external_vcc
self.delay_ms = delay_ms
self.flip_flag = False
self.rotate90 = rotate == 90 or rotate == 270
self.rotate = rotate
self.inverse = False
if self.rotate90:
self.width, self.height = self.height, self.width
self.pages = self.height // 8
self.row_width = self.width // 8
self.bufsize = self.pages * self.width
self.displaybuf = bytearray(self.bufsize)
self.displaybuf_mv = memoryview(self.displaybuf)
self.pages_to_update = 0
self._is_awake = False
if self.rotate90:
super().__init__(self.displaybuf, self.width, self.height,
framebuf.MONO_VLSB)
else:
super().__init__(self.displaybuf, self.width, self.height,
framebuf.MONO_HMSB)
self.init_display()
def init_display(self):
multiplex_ratio = 0x7F if (self.height == 128) else 0x3F
self.reset()
self.poweroff()
self.fill(0)
self.write_command((_SET_MULTIPLEX_RATIO | multiplex_ratio).to_bytes(2,"big"))
self.write_command((_MEM_ADDRESSING_MODE | (0x00 if self.rotate90 else 0x01)).to_bytes(1,"big"))
self.write_command(_SET_PAGE_ADDRESS.to_bytes(1,"big")) # set page address to zero
self.write_command(_SET_DC_DC_CONVERTER_SF.to_bytes(2,"big"))
self.write_command(_SET_DISP_CLK_DIV.to_bytes(2,"big"))
self.write_command(_SET_VCOM_DSEL_LEVEL.to_bytes(2,"big"))
self.write_command(_SET_DIS_PRECHARGE.to_bytes(2,"big"))
self.contrast(0)
self.invert(0)
# requires a call to flip() for setting up
self.flip(self.flip_flag)
self.poweron()
def poweron(self):
self.write_command(_SET_DISPLAY_ON.to_bytes(1,"big"))
self._is_awake = True
time.sleep_ms(self.delay_ms) # SH1107 datasheet recommends a delay in power on sequence
def poweroff(self):
self.write_command(_SET_DISPLAY_OFF.to_bytes(1,"big"))
self._is_awake = False
def sleep(self, value=True):
if value == True:
self.poweroff()
else:
self.poweron()
@property
def is_awake(self) -> bool:
return self._is_awake
def flip(self, flag=None, update=True):
if flag is None:
flag = not self.flip_flag
if self.height == 128 and self.width == 128:
row_offset = 0x00
elif self.rotate90:
row_offset = 0x60
else:
row_offset = 0x20 if (self.rotate == 180) ^ flag else 0x60
remap = 0x00 if (self.rotate in (90, 180)) ^ flag else 0x01
direction = 0x08 if (self.rotate in (180, 270)) ^ flag else 0x00
self.write_command((_SET_DISPLAY_OFFSET | row_offset).to_bytes(2,"big"))
self.write_command((_SET_SEGMENT_REMAP | remap ).to_bytes(1,"big") )
self.write_command((_SET_SCAN_DIRECTION | direction ).to_bytes(1,"big") )
self.flip_flag = flag
if update:
self.show(True) # full update
def display_start_line(self, value):
"""
17. Set Display Start Line:（Double Bytes Command）
valid values are 0 (Power on /Reset) to 127 (x00-x7F)
"""
self.write_command((_SET_DISPLAY_START_LINE | (value & 0x7F)).to_bytes(2,"big"))
def contrast(self, contrast):
"""
4. contrast can be between 0 (low), 0x80 (POR) and 0xff (high)
the segment current increases with higher values
"""
self.write_command((_SET_CONTRAST | (contrast & 0xFF)).to_bytes(2,"big"))
def invert(self, invert=None):
if invert == None:
invert = not self.inverse
self.write_command((_SET_NORMAL_INVERSE | (invert & 1)).to_bytes(1,"big"))
self.inverse = invert
def show(self, full_update: bool = False):
# _start = time.ticks_us()
(w, p, db_mv) = (self.width, self.pages, self.displaybuf_mv)
current_page = 1
if full_update:
pages_to_update = (1 << p) - 1
else:
pages_to_update = self.pages_to_update
if self.rotate90:
buffer_3Bytes = bytearray(3)
buffer_3Bytes[1] = _LOW_COLUMN_ADDRESS
buffer_3Bytes[2] = _HIGH_COLUMN_ADDRESS
for page in range(p):
if pages_to_update & current_page:
buffer_3Bytes[0] = _SET_PAGE_ADDRESS | page
self.write_command(buffer_3Bytes)
page_start = w * page
self.write_data(db_mv[page_start : page_start + w])
current_page <<= 1
else:
row_bytes = w // 8
buffer_2Bytes = bytearray(2)
for start_row in range(0, p * 8, 8):
if pages_to_update & current_page:
for row in range(start_row, start_row + 8):
buffer_2Bytes[0] = row & 0x0f # low column (low col. cmd is 0x00)
buffer_2Bytes[1] = _HIGH_COLUMN_ADDRESS | (row >> 4)
self.write_command(buffer_2Bytes)
slice_start = row * row_bytes
self.write_data(db_mv[slice_start : slice_start + row_bytes])
current_page <<= 1
self.pages_to_update = 0
# print("screen update used ", (time.ticks_us() - _start) / 1000, "ms")
def pixel(self, x, y, c=None):
if c is None:
return super().pixel(x, y)
else:
super().pixel(x, y , c)
page = y // 8
self.pages_to_update |= 1 << page
def text(self, text, x, y, c=1):
super().text(text, x, y, c)
self.register_updates(y, y + 7)
def line(self, x0, y0, x1, y1, c):
super().line(x0, y0, x1, y1, c)
self.register_updates(y0, y1)
def hline(self, x, y, w, c):
super().hline(x, y, w, c)
self.register_updates(y)
def vline(self, x, y, h, c):
super().vline(x, y, h, c)
self.register_updates(y, y + h - 1)
def fill(self, c):
super().fill(c)
self.pages_to_update = (1 << self.pages) - 1
def blit(self, fbuf, x, y, key=-1, palette=None):
super().blit(fbuf, x, y, key, palette)
self.register_updates(y, y + self.height)
def scroll(self, x, y):
# my understanding is that scroll() does a full screen change
super().scroll(x, y)
self.pages_to_update = (1 << self.pages) - 1
# rect() and fill_rect() amended to be compatible with new rect() method
# from latest micropython as well as 1.20.0 and previous versions
def fill_rect(self, x, y, w, h, c):
try:
super().fill_rect(x, y, w, h, c)
except:
super().rect(x, y, w, h, c, f=True)
self.register_updates(y, y + h - 1)
def rect(self, x, y, w, h, c, f=None):
if f == None or f == False:
super().rect(x, y, w, h, c)
else:
try:
super().rect(x, y, w, h, c, f)
except:
super().fill_rect(x, y, w, h, c)
self.register_updates(y, y + h - 1)
def ellipse(self, x, y, xr, yr, c, *args, **kwargs):
super().ellipse(x, y, xr, yr, c, *args, **kwargs)
self.register_updates(y - yr, y + yr)
def poly(self, *args, **kwargs):
super().poly(*args, **kwargs)
self.pages_to_update = (1 << self.pages) - 1
# conditionally define optimisations for framebuf extension if loaded
if _fb_variant == 2:
def large_text(self, s, x, y, m, c=1, r=0, *args, **kwargs):
try:
super().large_text(s, x, y, m, c, r, *args, **kwargs)
except:
raise Exception("extended framebuffer v206+ required")
h = (8 * m) * (1 if r is None or r % 360 // 90 in (0, 2) else len(s))
self.register_updates(y, y + h - 1)
def circle(self, x, y, radius, c, f:bool = None):
super().circle(x, y, radius, c, f)
self.register_updates(y-radius, y+radius)
def triangle(self, x0, y0, x1, y1, x2, y2, c, f: bool = None):
super().triangle(x0, y0, x1, y1, x2, y2, c, f)
self.register_updates(min(y0, y1, y2), max(y0, y1, y2))
def register_updates(self, y0, y1=None):
y1 = min((y1 if y1 is not None else y0), self.height - 1)
# this function takes the top and optional bottom address of the changes made
# and updates the pages_to_change list with any changed pages
# that are not yet on the list
start_page = y0 // 8
end_page = (y1 // 8) if (y1 is not None) else start_page
# rearrange start_page and end_page if coordinates were given from bottom to top
if start_page > end_page:
start_page, end_page = end_page, start_page
# ensure that start and end page values for update are non-negative (-ve is off-screen)
if end_page >= 0:
if start_page < 0:
start_page = 0
for page in range(start_page, end_page + 1):
self.pages_to_update |= 1 << page
def reset(self, res):
if res is not None:
res(1)
time.sleep_ms(1) # sleep for 1 millisecond
res(0)
time.sleep_ms(20) # sleep for 20 milliseconds
res(1)
time.sleep_ms(20) # sleep for 20 milliseconds
class SH1107_I2C(SH1107):
def __init__(self, width, height, i2c, res=None, address=0x3d,
rotate=0, external_vcc=False, delay_ms=200):
self.i2c = i2c
self.address = address
self.res = res
if res is not None:
res.init(res.OUT, value=1)
super().__init__(width, height, external_vcc, delay_ms, rotate)
def write_command(self, command_list):
self.i2c.writeto(self.address, b"\x00" + command_list)
def write_data(self, buf):
self.i2c.writevto(self.address, (b"\x40", buf))
def reset(self):
super().reset(self.res)
class SH1107_SPI(SH1107):
def __init__(self, width, height, spi, dc, res=None, cs=None,
rotate=0, external_vcc=False, delay_ms=0):
dc.init(dc.OUT, value=0)
if res is not None:
res.init(res.OUT, value=0)
if cs is not None:
cs.init(cs.OUT, value=1)
self.spi = spi
self.dc = dc
self.res = res
self.cs = cs
super().__init__(width, height, external_vcc, delay_ms, rotate)
def write_command(self, cmd):
if self.cs is not None:
self.cs(1)
self.dc(0)
self.cs(0)
self.spi.write(cmd)
self.cs(1)
else:
self.dc(0)
self.spi.write(cmd)
def write_data(self, buf):
if self.cs is not None:
self.cs(1)
self.dc(1)
self.cs(0)
self.spi.write(buf)
self.cs(1)
else:
self.dc(1)
self.spi.write(buf)
def reset(self):
super().reset(self.res)