-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy paththumbyGrayscale.py
1384 lines (1250 loc) · 47.8 KB
/
thumbyGrayscale.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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Thumby grayscale library
# https://github.com/Timendus/thumby-grayscale
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from utime import sleep_ms, ticks_diff, ticks_ms, sleep_us
from machine import Pin, SPI, idle, mem32
import _thread
from os import stat
from math import sqrt, floor
from array import array
from thumbyButton import buttonA, buttonB, buttonU, buttonD, buttonL, buttonR
from thumbyHardware import HWID
from sys import modules
__version__ = '4.0.2-hemlock'
emulator = None
try:
import emulator
except ImportError:
pass
class Sprite:
@micropython.native
def __init__(self, width, height, bitmapData, x = 0, y=0, key=-1, mirrorX=False, mirrorY=False):
self.width = width
self.height = height
self.bitmapSource = bitmapData
self.bitmapByteCount = width*(height//8)
if(height%8):
self.bitmapByteCount+=width
self.frameCount = 1
self.currentFrame = 0
self._shaded = False
self._usesFile = False
if isinstance(bitmapData, (tuple, list)):
if (len(bitmapData) != 2) or (type(bitmapData[0]) != type(bitmapData[1])):
raise ValueError('bitmapData must be a bytearray, string, or tuple of two bytearrays or strings')
self._shaded = True
if isinstance(bitmapData[0], str):
self._usesFile = True
if stat(bitmapData[0])[6] != stat(bitmapData[1])[6]:
raise ValueError('Sprite files must match in size')
self.bitmap = (bytearray(self.bitmapByteCount), bytearray(self.bitmapByteCount))
self.files = (open(bitmapData[0],'rb'),open(bitmapData[1],'rb'))
self.files[0].readinto(self.bitmap[0])
self.files[1].readinto(self.bitmap[1])
self.frameCount = stat(bitmapData[0])[6] // self.bitmapByteCount
elif isinstance(bitmapData[0], bytearray):
if len(bitmapData[0]) != len(bitmapData[1]):
raise ValueError('Sprite bitplanes must match in size')
self.frameCount = len(bitmapData[0]) // self.bitmapByteCount
self.bitmap = [
memoryview(bitmapData[0])[0:self.bitmapByteCount],
memoryview(bitmapData[1])[0:self.bitmapByteCount]
]
else:
raise ValueError('bitmapData must be a bytearray, string, or tuple of two bytearrays or strings')
elif isinstance(bitmapData, str):
self._usesFile = True
self.bitmap = bytearray(self.bitmapByteCount)
self.file = open(bitmapData,'rb')
self.file.readinto(self.bitmap)
self.frameCount = stat(bitmapData)[6] // self.bitmapByteCount
elif isinstance(bitmapData, bytearray):
self.bitmap = memoryview(bitmapData)[0:self.bitmapByteCount]
self.frameCount = len(bitmapData) // self.bitmapByteCount
else:
raise ValueError('bitmapData must be a bytearray, string, or tuple of two bytearrays or strings')
self.x = x
self.y = y
self.key = key
self.mirrorX = mirrorX
self.mirrorY = mirrorY
@micropython.native
def getFrame(self):
return self.currentFrame
@micropython.native
def setFrame(self, frame):
if(frame >= 0 and (self.currentFrame is not frame % (self.frameCount))):
self.currentFrame = frame % (self.frameCount)
offset=self.bitmapByteCount*self.currentFrame
if self._shaded:
if self._usesFile:
self.files[0].seek(offset)
self.files[1].seek(offset)
self.files[0].readinto(self.bitmap[0])
self.files[1].readinto(self.bitmap[1])
else:
self.bitmap[0] = memoryview(self.bitmapSource[0])[offset:offset+self.bitmapByteCount]
self.bitmap[1] = memoryview(self.bitmapSource[1])[offset:offset+self.bitmapByteCount]
else:
if self._usesFile:
self.file.seek(offset)
self.file.readinto(self.bitmap)
else:
self.bitmap = memoryview(self.bitmapSource)[offset:offset+self.bitmapByteCount]
# Thread state variables for managing the Grayscale Thread
_THREAD_STOPPED = const(0)
_THREAD_RUNNING = const(1)
_THREAD_STOPPING = const(2)
# Indexes into the multipurpose state array, accessing a particular status
_ST_THREAD = const(0)
_ST_COPY_BUFFS = const(1)
_ST_PENDING_CMD = const(2)
_ST_INVERT = const(3)
# Various display devices will run at naturally different clock
# frequencies. This paramater allows for variance by adjusting the
# timings to match the different devices.
_ST_CALIBRATOR = const(4)
# Newer models of the Thumby which started appearing in late 2022
# used a different OLED manufacturer, which has a subtly different
# design, and which gives nuanced differences to behaviours around the
# hardware trick used to keep the display in sync with each subframe.
# Unfortunately, it has a much lower maximum nominal clock frequency
# which causes a noticable strobing. Fortunately, it can trap
# the row counter much more effectively, and can thus greatly reduce the
# size of the offscreen capture area, along with the strobing.
# 0: Basic - Standard 17 row capture area with full row capture per subframe,
# each subframe has its own contrast value.
# 1: OLED2 - Reduced row capture areas with primary row capture after subframe 2,
# only enough row capture after subframe 0 to cleanly change brightness,
# and only enough offscreen buffer (without row capture) after
# subframe 1 to cleanly change the mux. Subframe 2 and 3 share the same
# brightness.
# 2: Dither - Like basic, but dark gray is dithered across subframe 1 and 2,
# which share the same brightness. May have more motion artifacts but
# less strobing on dark gray.
# 3: Bright - OLED2 style subframe layering but with basic timings
# for brighter whites on high brightness. May have some artifacts
# on hard lines between light and dark gray but less strobing on white.
# 4: OLED2-dither - Like OLED2 but light gray dithered across both bright
# subframes.
_ST_MODE = const(5)
# Timing parameters for each mode
_params = bytearray([
# time_pre
75, 75, 75,
90, 90, 0,
75, 75, 75,
75, 75, 75,
90, 90, 0,
75, 75, 75,
# time_end
56, 56, 56,
44, 42, 48,
56, 56, 56,
56, 56, 56,
44, 42, 48,
56, 56, 56,
# offset
47, 47, 47,
60, 62, 56,
47, 47, 47,
47, 47, 47,
60, 62, 56,
47, 47, 47,
# mux
56, 56, 56,
43, 41, 47,
56, 56, 56,
56, 56, 56,
43, 41, 47,
56, 56, 56])
# Screen display size constants
_WIDTH = const(72)
_HEIGHT = const(40)
_BUFF_SIZE = const((_HEIGHT // 8) * _WIDTH)
_BUFF_INT_SIZE = const(_BUFF_SIZE // 4)
class Grayscale:
# BLACK and WHITE is 0 and 1 to be compatible with the standard Thumby API
BLACK = 0
WHITE = 1
DARKGRAY = 2
LIGHTGRAY = 3
def __init__(self):
self._spi = SPI(0, sck=Pin(18), mosi=Pin(19))
self._dc = Pin(17)
self._cs = Pin(16)
self._res = Pin(20)
self._spi.init(baudrate=100 * 1000 * 1000, polarity=0, phase=0)
self._res.init(Pin.OUT, value=1)
self._dc.init(Pin.OUT, value=0)
self._cs.init(Pin.OUT, value=1)
self.display = self # This acts as both the GraphicsClass and SSD1306
self.pages = _HEIGHT // 8
self.width = _WIDTH
self.height = _HEIGHT
self.max_x = _WIDTH - 1
self.max_y = _HEIGHT - 1
# Draw buffers.
# This comprises of two full buffer lengths.
# The first section contains black and white compatible
# with the display buffer from the standard Thumby API,
# and the second contains the shading to create
# offwhite (lightgray) or offblack (darkgray).
self.drawBuffer = bytearray(_BUFF_SIZE*2)
# The base "buffer" matches compatibility with the std Thumby API.
self.buffer = memoryview(self.drawBuffer)[:_BUFF_SIZE]
# The "shading" buffer adds the grayscale
self.shading = memoryview(self.drawBuffer)[_BUFF_SIZE:]
self._subframes = array('O', [bytearray(_BUFF_SIZE),
bytearray(_BUFF_SIZE), bytearray(_BUFF_SIZE)])
# We enhance the greys by modulating the brightness.
# 0x81,<val> Set Bank0 brightness value to <val>
# Use setting from thumby.cfg
self._brightness = 127
try:
with open("thumby.cfg", "r") as fh:
_, _, conf = fh.read().partition("brightness,")
b = int(conf.split(',')[0])
# Set to the relevant brightness level
if b == 0: self._brightness = 1
if b == 1: self._brightness = 28
# Otherwise, leave it at 127
except (OSError, ValueError):
pass
self._contrastSrc = bytearray(18)
self._contrast = bytearray(3)
# It's better to avoid using regular variables for thread sychronisation.
# Instead, elements of an array/bytearray should be used.
# We're using a uint32 array here, as that should hopefully further ensure
# the atomicity of any element accesses.
# [thread_state, buff_copy_gate, pending_cmd_gate, constrast_change, inverted]
self._state = array('I', [_THREAD_STOPPED,0,0,0,87,0])
self._pendingCmds = bytearray(8)
self.setFont('lib/font5x7.bin', 5, 7, 1)
self.lastUpdateEnd = 0
self.frameRate = 0
self._initEmuScreen()
# Copy draw buffer from the standard library if it's been used
if 'thumbyGraphics' in modules:
self.buffer[:] = modules['thumbyGraphics'].display.display.buffer
# Initialise the device to be capable of grayscale
self.init_display()
self.brightness(self._brightness)
# Load the grayscale timings settings or calibrate
if not emulator:
try:
with open("thumbyGS.cfg", "r") as fh:
vls = fh.read().split('\n')
for fhd in vls:
if fhd.startswith('gsV3,'):
_, _, conf = fhd.partition("timing,")
self._state[_ST_CALIBRATOR] = int(conf.split(',')[0])
_, _, conf = fhd.partition("oled,")
self._state[_ST_MODE] = int(conf.split(',')[0])
break
else:
raise ValueError()
except (OSError, ValueError):
if HWID < 2:
self._state[_ST_CALIBRATOR] = 87
self._state[_ST_MODE] = 0
else:
self.calibrate()
# allow use of 'with'
def __enter__(self):
self.enableGrayscale()
return self
def __exit__(self, type, value, traceback):
self.disableGrayscale()
@micropython.viper
def _initEmuScreen(self):
if not emulator:
return
# Register draw buffer with emulator
Pin(2, Pin.OUT) # Ready display handshake pin
emulator.screen_breakpoint(ptr16(self.drawBuffer))
self._clearEmuFunctions()
def _clearEmuFunctions(self):
# Disable device controller functions
def _disabled(*arg, **kwdarg):
pass
self.invert = _disabled
self.reset = _disabled
self.poweron = _disabled
self.poweroff = _disabled
self.init_display = _disabled
self.write_cmd = _disabled
def reset(self):
self._res(1)
sleep_us(10)
self._res(0)
sleep_us(10)
self._res(1)
sleep_us(20)
def init_display(self):
self.reset()
self._cs(0)
self._dc(0)
# initialise as usual, except with shortest pre-charge
# periods and highest clock frequency
# 0xae Display Off
# 0x20,0x00 Set horizontal addressing mode
# 0x40 Set display start line to 0
# 0xa1 Set segment remap mode 1
# 0xa8,39 Set multiplex ratio to 39 (will be modified)
# 0xc8 Set COM output scan direction 1
# 0xd3,0 Set display offset to 0 (will be modified)
# 0xda,0x12 Set COM pins hardware configuration: alternative config,
# disable left/right remap
# 0xd5,0xf0 Set clk div ratio = 1, and osc freq = ~530kHz (480-590)kHz
# 0xd9,0x11 Set pre-charge periods: phase 1 = 1 , phase 2 = 1
# 0xdb,0x20 Set Vcomh deselect level = 0.77 x Vcc
# 0xa4 Do not enable entire display (i.e. use GDRAM)
# 0xa6 Normal (not inverse) display (invert is simulated)
# 0x8d,0x14 Charge bump setting: enable charge pump during display on
# 0xad,0x30 Select internal 30uA Iref (max Iseg=240uA) during display on
# 0xaf Set display on
self._spi.write(bytearray([
0xae, 0x20,0x00, 0x40, 0xa1, 0xa8,39, 0xc8, 0xd3,0, 0xda,0x12,
0xd5,0xf0, 0xd9,0x11, 0xdb,0x20, 0xa4, 0xa6, 0x8d,0x14, 0xad,0x30, 0xaf]))
self._dc(1)
# Clear the entire GDRAM
zero32 = bytearray([0] * 32)
for _ in range(32):
self._spi.write(zero32)
self._dc(0)
# Set the GDRAM window
# 0x21,28,99 Set column start (28) and end (99) addresses
# 0x22,0,4 Set page start (0) and end (4) addresses0
self._spi.write(bytearray([0x21,28,99, 0x22,0,4]))
def enableGrayscale(self):
if emulator:
# Activate grayscale emulation
emulator.screen_breakpoint(1)
self.show()
return
if self._state[_ST_THREAD] == _THREAD_RUNNING:
return
# Start the grayscale timing thread and wait for it to initialise
_thread.stack_size(2048)
self._init_grayscale()
_thread.start_new_thread(self._display_thread, ())
while self._state[_ST_THREAD] != _THREAD_RUNNING:
idle()
def disableGrayscale(self):
if emulator:
# Disable grayscale emulation
emulator.screen_breakpoint(0)
self.show()
return
if self._state[_ST_THREAD] != _THREAD_RUNNING:
return
self._state[_ST_THREAD] = _THREAD_STOPPING
while self._state[_ST_THREAD] != _THREAD_STOPPED:
idle()
self._deinit_grayscale()
# Draw B/W view of current frame
self.show()
# Resume device color inversion
if self._state[_ST_INVERT]:
self.write_cmds(0xa6 | 1)
# Change back to the original (unmodulated) brightness setting
self.brightness(self._brightness)
@micropython.native
def write_cmd(self, cmd):
if isinstance(cmd, list):
cmd = bytearray(cmd)
elif not isinstance(cmd, bytearray):
cmd = bytearray([cmd])
if self._state[_ST_THREAD] == _THREAD_RUNNING:
pendingCmds = self._pendingCmds
if len(cmd) > len(pendingCmds):
# We can't just break up the longer list of commands automatically, as we
# might end up separating a command and its parameter(s).
raise ValueError('Cannot send more than %u bytes using write_cmd()' % len(pendingCmds))
i = 0
while i < len(cmd):
pendingCmds[i] = cmd[i]
i += 1
# Fill the rest of the bytearray with display controller NOPs
# This is probably better than having to create slice or a memoryview in the GPU thread
while i < len(pendingCmds):
pendingCmds[i] = 0x3e
i += 1
self._state[_ST_PENDING_CMD] = 1
while self._state[_ST_PENDING_CMD]:
idle()
else:
self._dc(0)
self._spi.write(cmd)
def poweroff(self):
self.write_cmd(0xae)
def poweron(self):
self.write_cmd(0xaf)
@micropython.viper
def invert(self, invert:int):
state = ptr32(self._state)
invert = 1 if invert else 0
state[_ST_INVERT] = invert
state[_ST_COPY_BUFFS] = 1
if state[_ST_THREAD] != _THREAD_RUNNING:
self.write_cmd(0xa6 | invert)
@micropython.viper
def show(self):
state = ptr32(self._state)
if state[_ST_THREAD] == _THREAD_RUNNING:
state[_ST_COPY_BUFFS] = 1
while state[_ST_COPY_BUFFS] != 0:
idle()
elif emulator:
mem32[0xD0000000+0x01C] = 1 << 2
else:
self._dc(1)
self._spi.write(self.buffer)
@micropython.viper
def show_async(self):
state = ptr32(self._state)
if state[_ST_THREAD] == _THREAD_RUNNING:
state[_ST_COPY_BUFFS] = 1
else:
self.show()
@micropython.native
def setFPS(self, newFrameRate):
self.frameRate = newFrameRate
@micropython.native
def update(self):
self.show()
if self.frameRate > 0:
frameTimeMs = 1000 // self.frameRate
lastUpdateEnd = self.lastUpdateEnd
frameTimeRemaining = frameTimeMs - ticks_diff(ticks_ms(), lastUpdateEnd)
while frameTimeRemaining > 1:
buttonA.update()
buttonB.update()
buttonU.update()
buttonD.update()
buttonL.update()
buttonR.update()
sleep_ms(1)
frameTimeRemaining = frameTimeMs - ticks_diff(ticks_ms(), lastUpdateEnd)
while frameTimeRemaining > 0:
frameTimeRemaining = frameTimeMs - ticks_diff(ticks_ms(), lastUpdateEnd)
self.lastUpdateEnd = ticks_ms()
@micropython.viper
def brightness(self, c:int):
if c < 1: c = 1
if c > 127: c = 127
state = ptr32(self._state)
contrastSrc = ptr8(self._contrastSrc)
# Prepare contrast for the different subframe layers:
# [---basic---, ----oled2---, ---dither--, ---oled2---, ---oled2---]
# Low (1): [ 1, 20, 50, 1, 22, 22, 1, 1, 10, ...]
# Mid (28): [13, 47, 178, 13, 120, 120, 20, 20, 138, ...]
# High (127): [28, 85, 255, 28, 255, 255, 46, 46, 255, ...]
cc = int(floor(sqrt(c<<17)))
# Basic mode
contrastSrc[0] = (cc*30>>12)-1
contrastSrc[1] = (cc*72>>12)+14
c3 = (cc*340>>12)+20
contrastSrc[2] = c3 if c3 < 255 else 255
# OLED2 mode
contrastSrc[3] = (cc*30>>12)-1
contrastSrc[4] = (cc*257>>12)
contrastSrc[5] = (cc*257>>12)
# Dither mode
contrastSrc[6] = (cc*50>>12)-3
contrastSrc[7] = (cc*50>>12)-3
c3 = (cc*340>>12)-20
contrastSrc[8] = c3 if c3 < 255 else 255
# OLED2 mode / basic timing
contrastSrc[9] = contrastSrc[3]
contrastSrc[10] = contrastSrc[4]
contrastSrc[11] = contrastSrc[5]
# OLED2 mode / dithered
contrastSrc[12] = contrastSrc[3]
contrastSrc[13] = contrastSrc[4]
contrastSrc[14] = contrastSrc[5]
# OLED2 mode / basic timing / dithered
contrastSrc[15] = contrastSrc[3]
contrastSrc[16] = contrastSrc[4]
contrastSrc[17] = contrastSrc[5]
if state[_ST_THREAD] != _THREAD_RUNNING:
# Apply the brightness directly to the display or emulator
if emulator:
emulator.brightness_breakpoint(c)
else:
self.write_cmd([0x81, c])
setattr(self, '_brightness', c)
@micropython.viper
def _init_grayscale(self):
state = ptr32(self._state)
contrastSrc = ptr8(self._contrastSrc)
contrast = ptr8(self._contrast)
mode = state[_ST_MODE]
# Draw and sub-frame buffers in 32bit for fast copying
bb = ptr32(self.buffer)
bs = ptr32(self.shading)
b1 = ptr32(self._subframes[0])
b2 = ptr32(self._subframes[1])
b3 = ptr32(self._subframes[2])
d1 = int(0xAA55AA55)
d2 = int(0x55AA55AA)
# Hardware register access
sio = ptr32(0xd0000000)
spi0 = ptr32(0x4003c000)
tmr = ptr32(0x40054000)
# Update the sub-frame layers for the first frame
i = 0
inv = -1 if state[_ST_INVERT] else 0
# fast copy loop. By using using ptr32 vars we copy 3 bytes at a time.
while i < _BUFF_INT_SIZE:
v1 = bb[i] ^ inv
v2 = bs[i]
wd = v1 ^ v2
w = v1 & wd
di = ((i&3)+i)&1
di1 = (d1 if di else d2)
di2 = (d2 if di else d1)
b1[i] = wd # white || darkGray [DIM]
b2[i] = v1 # white || lightGray [MID]
b3[i] = w # white [BRIGHT]
if mode == 0:
b1[i] = v1 | v2 # white || lightGray || darkGray [DIM]
elif mode == 2:
b1[i] = v1 | (v2 & di1) # white || lightGray || dither-darkGray [DIM]
b2[i] = v1 | (v2 & di2) # white || lightGray || dither-darkGray [DIM]
elif mode >= 4:
lg = v1 & v2
b2[i] = w | (lg & di1) # white || dither-lightGray [BRIGHT]
b3[i] = w | (lg & di2) # white || dither-lightGray [BRIGHT]
i += 1
# Data Mode
while (spi0[3] & 4) == 4: i = spi0[2]
while (spi0[3] & 0x10) == 0x10: pass
while (spi0[3] & 4) == 4: i = spi0[2]
sio[5] = 1 << 17 # dc(1)
# Send the first two pages to screen, offsetting the scan line
i = 0
blitsub = ptr8(self._subframes[0])
while i < 144:
while (spi0[3] & 2) == 0: pass
spi0[2] = blitsub[i]
i += 1
# Command Mode
while (spi0[3] & 4) == 4: i = spi0[2]
while (spi0[3] & 0x10) == 0x10: pass
while (spi0[3] & 4) == 4: i = spi0[2]
sio[6] = 1 << 17 # dc(0)
# Contrast preparation
cmode = state[_ST_MODE]*3
contrast[0] = contrastSrc[cmode]
contrast[1] = contrastSrc[cmode + 1]
contrast[2] = contrastSrc[cmode + 2]
spi0[2] = 0x81; spi0[2] = contrast[0]
# Set the display offset to allow space for the captured
# row counter, and overflow area, and then reset display state.
spi0[2] = 0xae
spi0[2] = 0xd3; spi0[2] = 47
time_pre = tmr[10] + 4000
while (tmr[10] - time_pre) < 0: pass
spi0[2] = 0xa8; spi0[2] = 1 # Row resets OLED2
spi0[2] = 0xa6 # disable hardware invert
spi0[2] = 0xaf # Row resets OLED1
# GPU (Gray Processing Unit) thread function
@micropython.viper
def _display_thread(self):
# Rapidly draws 3 sub-frame layers per frame to simulate
# grayscale in a thread which runs on core1. Every sub-frame
# includes the fully lit white pixels, and only some sub-frames
# includes the gray pixels to modulate the brightness of the
# gray pixels.
# MicroPython calls which could run directly off of memory
# mapped flash are carefully avoided, as this can cause certain
# calls on core0 to crash.
# This thread uses a hardware timing trick to keep the SSD1306
# synchronised with rapid switching between white and gray pixel
# layers to simulate grayscale with minimal flicker or artifacts
# The hardware timing trick works by creating an offscreen area
# to briefly capture the row counter for long enough to be able
# to change the frame contents and release them together. This
# is done by changing the multiplex ratio (mux) to 56 giving 57
# rows instead of the normal 40.
# To match this, the display offset is set to 46, which aligns
# the 40 row frame into position of the visible area, and also
# leaves enough space to create a capture area offscreen.
# The row counter is captured in this offscreen area by setting
# multiplex ratio to 1.
# Init: set DISPLAY_OFFSET:47
# Timing Loop:
# * set MUX:1 (capture row counter)
# * draw sub-frame layer
# * wait long enough to ensure we capture the row counter.
# * set MUX:56 (release row counter)
# * wait long enoough for sub-frame layer to be drawn.
state = ptr32(self._state)
contrastSrc = ptr8(self._contrastSrc)
contrast = ptr8(self._contrast)
pendingCmds = ptr8(self._pendingCmds)
params = ptr8(_params)
mode = state[_ST_MODE]
# Draw and sub-frame buffers in 32bit for fast copying
bb = ptr32(self.buffer)
bs = ptr32(self.shading)
sf = self._subframes
b1 = ptr32(sf[0])
b2 = ptr32(sf[1])
b3 = ptr32(sf[2])
subframes = ptr32(array('L', [b1, b2, b3]))
d1 = int(0xAA55AA55)
d2 = int(0x55AA55AA)
# Hardware register access
sio = ptr32(0xd0000000)
# spi0[2] -> SPI0->DR
# spi0[3] -> SPI0->SR :
# & 2 -> & SPI_SSPSR_TNF_BITS
# & 4 -> & SPI_SSPSR_RNE_BITS
# & 0x10 -> & SPI_SSPSR_BSY_BITS
spi0 = ptr32(0x4003c000)
tmr = ptr32(0x40054000)
state[_ST_THREAD] = _THREAD_RUNNING
while state[_ST_THREAD] == _THREAD_RUNNING:
# This is the main GPU loop. We cycle through each of the 3 display
# framebuffers, sending the framebuffer data and various commands.
calib = state[_ST_CALIBRATOR]
fn = 0
while fn < 3:
mfn = mode*3+fn
time_pre = tmr[10] + params[mfn]*10
# Park Display (capture row counter offscreen)
if fn != 2 or mode != 1:
spi0[2] = 0xd3; spi0[2] = 40
spi0[2] = 0xa8; spi0[2] = 1
# Wait long enough to ensure we captured the row counter.
while (tmr[10] - time_pre) < 0: pass
# Brightness adjustment for sub-frame layer
spi0[2] = 0x81; spi0[2] = contrast[fn]
# Release Display
spi0[2] = 0xd3
spi0[2] = params[36+mfn]
spi0[2] = 0xa8
spi0[2] = params[54+mfn]
# Brightness adjustment (send twice for stability)
spi0[2] = 0x81; spi0[2] = contrast[fn]
# Data Mode
while (spi0[3] & 4) == 4: i = spi0[2]
while (spi0[3] & 0x10) == 0x10: pass
while (spi0[3] & 4) == 4: i = spi0[2]
sio[5] = 1 << 17 # dc(1)
blitsub = ptr8(subframes[fn])
i = 144
while i < 360:
if i == 216:
while (tmr[10] - (time_pre + 8*calib)) < 0: pass
if i == 288:
while (tmr[10] - (time_pre + 16*calib)) < 0: pass
while (spi0[3] & 2) == 0: pass
spi0[2] = blitsub[i]
i += 1
# Check if there's a pending frame copy required
# we only copy the paint framebuffers to the display framebuffers on
# the last frame to avoid screen-tearing artefacts
if fn == 2 and (state[_ST_COPY_BUFFS] != 0 or mode != state[_ST_MODE]):
i = 0
inv = -1 if state[_ST_INVERT] else 0
mode = state[_ST_MODE]
# fast copy loop. By using using ptr32 vars we copy 3 bytes at a time.
while i < _BUFF_INT_SIZE:
v1 = bb[i] ^ inv
v2 = bs[i]
wd = v1 ^ v2
w = v1 & wd
di = ((i&3)+i)&1
di1 = (d1 if di else d2)
di2 = (d2 if di else d1)
b1[i] = wd # white || darkGray [DIM]
b2[i] = v1 # white || lightGray [MID]
b3[i] = w # white [BRIGHT]
if mode == 0:
b1[i] = v1 | v2 # white || lightGray || darkGray [DIM]
elif mode == 2:
b1[i] = v1 | (v2 & di1) # white || lightGray || dither-darkGray [DIM]
b2[i] = v1 | (v2 & di2) # white || lightGray || dither-darkGray [DIM]
elif mode >= 4:
lg = v1 & v2
b2[i] = w | (lg & di1) # white || dither-lightGray [BRIGHT]
b3[i] = w | (lg & di2) # white || dither-lightGray [BRIGHT]
i += 1
state[_ST_COPY_BUFFS] = 0
# Copy in contrast adjustments in case they changed
cmode = mode*3
contrast[0] = contrastSrc[cmode]
contrast[1] = contrastSrc[cmode + 1]
contrast[2] = contrastSrc[cmode + 2]
blitsub = ptr8(subframes[fn+1 if fn < 2 else 0])
i = 0
while (tmr[10] - (time_pre + 24*calib)) < 0: pass
while i < 144:
if i == 72:
while (tmr[10] - (time_pre + 32*calib)) < 0: pass
while (spi0[3] & 2) == 0: pass
spi0[2] = blitsub[i]
i += 1
# Command Mode
while (spi0[3] & 4) == 4: i = spi0[2]
while (spi0[3] & 0x10) == 0x10: pass
while (spi0[3] & 4) == 4: i = spi0[2]
sio[6] = 1 << 17 # dc(0)
# Check if there are pending commands
if fn == 2 and state[_ST_PENDING_CMD] != 0:
i = 0
while i < 8:
while (spi0[3] & 2) == 0: pass
spi0[2] = pendingCmds[i]
i += 1
state[_ST_PENDING_CMD] = 0
# Wait until the row counter is between the end of the drawn
# area and the end of the multiplex ratio range.
while (tmr[10] - (time_pre + params[18+mfn]*calib)) < 0: pass
fn += 1
# Mark that we've stopped
state[_ST_THREAD] = _THREAD_STOPPED
@micropython.viper
def _deinit_grayscale(self):
spi0 = ptr32(0x4003c000)
# Reset monochrome display offset, mux rows, and page address
spi0[2] = 0xd3; spi0[2] = 0
spi0[2] = 0xa8; spi0[2] = 39
spi0[2] = 0x22; spi0[2] = 0; spi0[2] = 4
@micropython.viper
def fill(self, colour:int):
buffer = ptr32(self.buffer)
shading = ptr32(self.shading)
f1 = -1 if colour & 1 else 0
f2 = -1 if colour & 2 else 0
i = 0
while i < _BUFF_INT_SIZE:
buffer[i] = f1
shading[i] = f2
i += 1
@micropython.viper
def drawFilledRectangle(self, x:int, y:int, width:int, height:int, colour:int):
if x + width <= 0 or x >= _WIDTH or y + height <= 0 or y >= _HEIGHT:
return
if width <= 0 or height <= 0: return
if x < 0:
width += x
x = 0
if y < 0:
height += y
y = 0
x2 = x + width
y2 = y + height
if x2 > _WIDTH:
x2 = _WIDTH
width = _WIDTH - x
if y2 > _HEIGHT:
y2 = _HEIGHT
height = _HEIGHT - y
buffer = ptr8(self.buffer)
shading = ptr8(self.shading)
o = (y >> 3) * _WIDTH
oe = o + x2
o += x
strd = _WIDTH - width
c1 = colour & 1
c2 = colour & 2
v1 = 0xff if c1 else 0
v2 = 0xff if c2 else 0
yb = y & 7
ybh = 8 - yb
if height <= ybh:
m = ((1 << height) - 1) << yb
else:
m = 0xff << yb
im = 255-m
while o < oe:
if c1:
buffer[o] |= m
else:
buffer[o] &= im
if c2:
shading[o] |= m
else:
shading[o] &= im
o += 1
height -= ybh
while height >= 8:
o += strd
oe += _WIDTH
while o < oe:
buffer[o] = v1
shading[o] = v2
o += 1
height -= 8
if height > 0:
o += strd
oe += _WIDTH
m = (1 << height) - 1
im = 255-m
while o < oe:
if c1:
buffer[o] |= m
else:
buffer[o] &= im
if c2:
shading[o] |= m
else:
shading[o] &= im
o += 1
@micropython.viper
def drawRectangle(self, x:int, y:int, width:int, height:int, colour:int):
dfr = self.drawFilledRectangle
dfr(x, y, width, 1, colour)
dfr(x, y, 1, height, colour)
dfr(x, y+height-1, width, 1, colour)
dfr(x+width-1, y, 1, height, colour)
@micropython.viper
def setPixel(self, x:int, y:int, colour:int):
if x < 0 or x >= _WIDTH or y < 0 or y >= _HEIGHT:
return
o = (y >> 3) * _WIDTH + x
m = 1 << (y & 7)
im = 255-m
buffer = ptr8(self.buffer)
shading = ptr8(self.shading)
if colour & 1:
buffer[o] |= m
else:
buffer[o] &= im
if colour & 2:
shading[o] |= m
else:
shading[o] &= im
@micropython.viper
def getPixel(self, x:int, y:int) -> int:
if x < 0 or x >= _WIDTH or y < 0 or y >= _HEIGHT:
return 0
o = (y >> 3) * _WIDTH + x
m = 1 << (y & 7)
buffer = ptr8(self.buffer)
shading = ptr8(self.shading)
colour = 0
if buffer[o] & m:
colour = 1
if shading[o] & m:
colour |= 2
return colour
@micropython.viper
def drawLine(self, x0:int, y0:int, x1:int, y1:int, colour:int):
if x0 == x1:
self.drawFilledRectangle(x0, y0, 1, y1 - y0, colour)
return
if y0 == y1:
self.drawFilledRectangle(x0, y0, x1 - x0, 1, colour)
return
dx = x1 - x0
dy = y1 - y0
sx = 1
# y increment is always 1
if dy < 0:
x0,x1 = x1,x0
y0,y1 = y1,y0
dy = 0 - dy
dx = 0 - dx
if dx < 0:
dx = 0 - dx
sx = -1
x = x0
y = y0
buffer = ptr8(self.buffer)
shading = ptr8(self.shading)
o = (y >> 3) * _WIDTH + x
m = 1 << (y & 7)
im = 255-m
c1 = colour & 1
c2 = colour & 2
if dx > dy:
err = dx >> 1
x1 += 1
while x != x1:
if 0 <= x < _WIDTH and 0 <= y < _HEIGHT:
if c1:
buffer[o] |= m
else:
buffer[o] &= im
if c2:
shading[o] |= m
else:
shading[o] &= im
err -= dy
if err < 0:
y += 1
m <<= 1