-
Notifications
You must be signed in to change notification settings - Fork 59
/
Copy pathSFE_MicroOLED.cpp
1387 lines (1186 loc) · 36.4 KB
/
SFE_MicroOLED.cpp
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
/******************************************************************************
SFE_MicroOLED.cpp
Main source code for the MicroOLED Arduino Library
Jim Lindblom @ SparkFun Electronics
October 26, 2014
https://github.com/sparkfun/Micro_OLED_Breakout/tree/master/Firmware/Arduino/libraries/SFE_MicroOLED
Modified by:
Emil Varughese @ Edwin Robotics Pvt. Ltd.
July 27, 2015
https://github.com/emil01/SparkFun_Micro_OLED_Arduino_Library/
This file defines the hardware interface(s) for the Micro OLED Breakout. Those
interfaces include SPI, I2C and a parallel bus.
Development environment specifics:
Arduino 1.0.5
Arduino Pro 3.3V
Micro OLED Breakout v1.0
This code was heavily based around the MicroView library, written by GeekAmmo
(https://github.com/geekammo/MicroView-Arduino-Library), and released 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 <http://www.gnu.org/licenses/>.
******************************************************************************/
#include <Arduino.h>
#if defined(ARDUINO_ARCH_MBED)
// ARDUINO_ARCH_MBED (APOLLO3 v2) does not support or require pgmspace.h / PROGMEM
#elif defined(__AVR__) || defined(__arm__) || defined(__ARDUINO_ARC__)
#include <avr/pgmspace.h>
#else
#include <pgmspace.h>
#endif
#include <SFE_MicroOLED.h>
#ifndef _BV
#define _BV(x) (1 << x)
#endif
// This fixed ugly GCC warning "only initialized variables can be placed into program memory area"
#if defined(__AVR__)
#undef PROGMEM
#define PROGMEM __attribute__((section(".progmem.data")))
#endif
// Add header of the fonts here.
// Fonts that aren't included the section below are excluded by the compiler.
#include "util/font5x7.h" // Font 0
#include "util/font8x16.h" // Font 1
#include "util/7segment.h" // Font 2
#include "util/fontlargenumber.h" // Font 3
#include "util/fontlargeletter31x48.h" // Font 4 (excluded by default - see below)
#define MAXFONTS 5 // Do not change this line - except when _adding_ new fonts
// To save flash memory, change these to zeros for the fonts you want to exclude.
// In particular, the 31x48 font is handy, but uses a big
// chunk of flash memory - about 7k. It is excluded by default.
//
// If you are compiling the code using your own makefile, you can use compiler flags to include
// or exclude individual fonts. E.g.: -DINCLUDE_FONT_LARGELETTER=1 or -DINCLUDE_FONT_LARGENUMBER=0
#ifndef INCLUDE_FONT_5x7
#define INCLUDE_FONT_5x7 1 // Change this to 0 to exclude the 5x7 font
#endif
#ifndef INCLUDE_FONT_8x16
#define INCLUDE_FONT_8x16 1 // Change this to 0 to exclude the 8x16 font
#endif
#ifndef INCLUDE_FONT_7SEG
#define INCLUDE_FONT_7SEG 1 // Change this to 0 to exclude the seven segment font
#endif
#ifndef INCLUDE_FONT_LARGENUMBER
#define INCLUDE_FONT_LARGENUMBER 1 // Change this to 0 to exclude the large number font
#endif
#ifndef INCLUDE_FONT_LARGELETTER
#define INCLUDE_FONT_LARGELETTER 0 // Change this to 1 to include the large letter font
#endif
// Add the font name as declared in the header file.
// Exclude as many as possible to conserve FLASH memory.
const unsigned char *MicroOLED::fontsPointer[] = {
#if INCLUDE_FONT_5x7
font5x7,
#else
NULL,
#endif
#if INCLUDE_FONT_8x16
font8x16,
#else
NULL,
#endif
#if INCLUDE_FONT_7SEG
sevensegment,
#else
NULL,
#endif
#if INCLUDE_FONT_LARGENUMBER
fontlargenumber,
#else
NULL,
#endif
#if INCLUDE_FONT_LARGELETTER
fontlargeletter31x48
#else
NULL
#endif
};
/** \brief MicroOLED screen buffer.
Page buffer 64 x 48 divided by 8 = 384 bytes
Page buffer is required because in SPI mode, the host cannot read the SSD1306's GDRAM of the controller. This page buffer serves as a scratch RAM for graphical functions. All drawing function will first be drawn on this page buffer, only upon calling display() function will transfer the page buffer to the actual LCD controller's memory.
*/
static uint8_t screenmemory[] = {
/* LCD Memory organised in 64 horizontal pixel and 6 rows of byte
B B .............B -----
y y .............y \
t t .............t \
e e .............e \
0 1 .............63 \
\
D0 D0.............D0 \
D1 D1.............D1 / ROW 0
D2 D2.............D2 /
D3 D3.............D3 /
D4 D4.............D4 /
D5 D5.............D5 /
D6 D6.............D6 /
D7 D7.............D7 ----
*/
//SparkFun Electronics LOGO
// ROW0, BYTE0 to BYTE63
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xE0, 0xF8, 0xFC, 0xFE, 0xFF, 0xFF, 0xFF, 0xFF,
0xFF, 0xFF, 0xFF, 0x0F, 0x07, 0x07, 0x06, 0x06, 0x00, 0x80, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
// ROW1, BYTE64 to BYTE127
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x81, 0x07, 0x0F, 0x3F, 0x3F, 0xFF, 0xFF, 0xFF,
0xFF, 0xFF, 0xFF, 0xFF, 0xFE, 0xFE, 0xFC, 0xFC, 0xFC, 0xFE, 0xFF, 0xFF, 0xFF, 0xFC, 0xF8, 0xE0,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
// ROW2, BYTE128 to BYTE191
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFC,
0xFE, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xF1, 0xE0, 0xE0, 0xE0, 0xE0, 0xE0, 0xF0, 0xFD, 0xFF,
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
// ROW3, BYTE192 to BYTE255
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x7F, 0x3F, 0x1F, 0x07, 0x01,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
// ROW4, BYTE256 to BYTE319
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x7F, 0x3F, 0x1F, 0x1F, 0x0F, 0x0F, 0x0F, 0x0F,
0x0F, 0x0F, 0x0F, 0x0F, 0x07, 0x07, 0x07, 0x03, 0x03, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
// ROW5, BYTE320 to BYTE383
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
0x7F, 0x3F, 0x1F, 0x0F, 0x07, 0x03, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
/** \brief MicroOLED Constructor -- I2C - leaving the address currently undefined
Setup the MicroOLED class, assuming that the I2C address will be defined later.
*/
MicroOLED::MicroOLED(uint8_t rst)
{
// Assign each of the parameters to a private class variable.
rstPin = rst;
moled_interface = MOLED_MODE_I2C; // Set interface to I2C
moled_i2c_address = I2C_ADDRESS_UNDEFINED; // Flag that the I2C address is undefined
}
/** \brief MicroOLED Constructor -- SPI Mode
Setup the MicroOLED class, configure the display to be controlled via a
SPI interface.
*/
MicroOLED::MicroOLED(uint8_t rst, uint8_t dc, uint8_t cs)
{
// Assign each of the parameters to a private class variable.
rstPin = rst;
dcPin = dc;
csPin = cs;
moled_interface = MOLED_MODE_SPI; // Set interface mode to SPI
//_spiPort will be initialized by spiSetup
}
/** \brief MicroOLED Constructor -- I2C Mode
Setup the MicroOLED class, configure the display to be controlled via a
I2C interface.
*/
MicroOLED::MicroOLED(uint8_t rst, uint8_t dc)
{
rstPin = rst; // Assign reset pin to private class variable
moled_interface = MOLED_MODE_I2C; // Set interface to I2C
// Set the I2C Address based on whether DC is high (1) or low (0).
// The pin is pulled low by default, so if it's not explicitly set to
// 1, just default to 0.
if (dc == 1)
moled_i2c_address = I2C_ADDRESS_SA0_1;
else
moled_i2c_address = I2C_ADDRESS_SA0_0;
//_i2cPort will be initialized by i2cSetup
}
/** \brief MicroOLED Constructor -- Parallel Mode
Setup the MicroOLED class, configure the display to be controlled via a
parallel interface.
*/
MicroOLED::MicroOLED(uint8_t rst, uint8_t dc, uint8_t cs, uint8_t wr, uint8_t rd,
uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3,
uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7)
{
moled_interface = MOLED_MODE_PARALLEL; // Set to parallel mode
// Assign pin parameters to private class variables.
rstPin = rst;
dcPin = dc;
csPin = cs;
wrPin = wr;
rdPin = rd;
dPins[0] = d0;
dPins[1] = d1;
dPins[2] = d2;
dPins[3] = d3;
dPins[4] = d4;
dPins[5] = d5;
dPins[6] = d6;
dPins[7] = d7;
}
/** \brief Initialisation of MicroOLED Library.
Setup for the chosen interface then send initialisation commands to the SSD1306 controller inside the OLED.
*/
boolean MicroOLED::begin()
{
// Set up the selected interface:
if (moled_interface == MOLED_MODE_SPI)
spiSetup();
else if (moled_interface == MOLED_MODE_I2C)
i2cSetup();
else if (moled_interface == MOLED_MODE_PARALLEL)
parallelSetup();
else //if (moled_interface == MOLED_MODE_UNDEFINED)
return (false);
// Trap if the user instantiated with MicroOLED oled(PIN_RESET) and then called
// .begin instead of .begin(uint8_t deviceAddress, TwoWire &wirePort)
if ((moled_interface == MOLED_MODE_I2C) && (moled_i2c_address == I2C_ADDRESS_UNDEFINED))
{
if (_printDebug == true)
{
_debugPort->println(F("begin: error! deviceAddress is I2C_ADDRESS_UNDEFINED!"));
_debugPort->println(F("begin: Did you forget to call .begin(uint8_t deviceAddress, TwoWire &wirePort)?"));
}
return (false);
}
beginCommon();
return (true);
}
/** \brief Initialisation of MicroOLED Library.
Setup IO pins for the SPI interface then send initialisation commands to the SSD1306 controller inside the OLED.
*/
boolean MicroOLED::begin(SPIClass &spiPort)
{
// Set up the selected interface:
spiSetup(spiPort);
beginCommon();
return (true);
}
/** \brief Initialisation of MicroOLED Library.
Setup IO pins for the I2C interface then send initialisation commands to the SSD1306 controller inside the OLED.
*/
boolean MicroOLED::begin(uint8_t deviceAddress, TwoWire &wirePort)
{
// Set up the selected interface:
i2cSetup(deviceAddress, wirePort);
beginCommon();
return (true);
}
/** \brief Initialisation of MicroOLED Library - common to all begin methods. PRIVATE.
Setup IO pins for the chosen interface then send initialisation commands to the SSD1306 controller inside the OLED.
*/
void MicroOLED::beginCommon()
{
// default 5x7 font
setFontType(0);
setColor(WHITE);
setDrawMode(NORM);
setCursor(0, 0);
// Display reset routine
pinMode(rstPin, OUTPUT); // Set RST pin as OUTPUT
digitalWrite(rstPin, HIGH); // Initially set RST HIGH
delay(5); // VDD (3.3V) goes high at start, lets just chill for 5 ms
digitalWrite(rstPin, LOW); // Bring RST low, reset the display
delay(10); // wait 10ms
digitalWrite(rstPin, HIGH); // Set RST HIGH, bring out of reset
// Display Init sequence for 64x48 OLED module
command(DISPLAYOFF); // 0xAE
command(SETDISPLAYCLOCKDIV); // 0xD5
command(0x80); // the suggested ratio 0x80
command(SETMULTIPLEX); // 0xA8
command(0x2F);
command(SETDISPLAYOFFSET); // 0xD3
command(0x0); // no offset
command(SETSTARTLINE | 0x0); // line #0
command(CHARGEPUMP); // enable charge pump
command(0x14);
command(NORMALDISPLAY); // 0xA6
command(DISPLAYALLONRESUME); // 0xA4
command(SEGREMAP | 0x1);
command(COMSCANDEC);
command(SETCOMPINS); // 0xDA
command(0x12);
command(SETCONTRAST); // 0x81
command(0x8F);
command(SETPRECHARGE); // 0xd9
command(0xF1);
command(SETVCOMDESELECT); // 0xDB
command(0x40);
command(DISPLAYON); //--turn on oled panel
clear(ALL); // Erase hardware memory inside the OLED controller to avoid random data in memory.
}
//Calling this function with nothing sets the debug port to Serial
//You can also call it with other streams like Serial1, SerialUSB, etc.
void MicroOLED::enableDebugging(Stream &debugPort)
{
_debugPort = &debugPort;
_printDebug = true;
}
/** \brief Send the display a command byte
Send a command via SPI, I2C or parallel to SSD1306 controller.
For SPI we set the DC and CS pins here, and call spiTransfer(byte)
to send the data. For I2C and Parallel we use the write functions
defined in hardware.cpp to send the data.
*/
void MicroOLED::command(uint8_t c)
{
if (moled_interface == MOLED_MODE_SPI)
{
digitalWrite(dcPin, LOW);
; // DC pin LOW for a command
spiTransfer(c); // Transfer the command byte
}
else if (moled_interface == MOLED_MODE_I2C)
{
// Write to our address, make sure it knows we're sending a
// command:
i2cWrite(moled_i2c_address, I2C_COMMAND, c);
}
else if (moled_interface == MOLED_MODE_PARALLEL)
{
// Write the byte to our parallel interface. Set DC LOW.
parallelWrite(c, LOW);
}
}
/** \brief Send the display a data byte
Send a data byte via SPI, I2C or parallel to SSD1306 controller.
For SPI we set the DC and CS pins here, and call spiTransfer(byte)
to send the data. For I2C and Parallel we use the write functions
defined in hardware.cpp to send the data.
*/
void MicroOLED::data(uint8_t c)
{
if (moled_interface == MOLED_MODE_SPI)
{
digitalWrite(dcPin, HIGH); // DC HIGH for a data byte
spiTransfer(c); // Transfer the data byte
}
else if (moled_interface == MOLED_MODE_I2C)
{
// Write to our address, make sure it knows we're sending a
// data byte:
i2cWrite(moled_i2c_address, I2C_DATA, c);
}
else if (moled_interface == MOLED_MODE_PARALLEL)
{
// Write the byte to our parallel interface. Set DC HIGH.
parallelWrite(c, HIGH);
}
}
/** \brief Set SSD1306 page address.
Send page address command and address to the SSD1306 OLED controller.
*/
void MicroOLED::setPageAddress(uint8_t add)
{
add = 0xb0 | add;
command(add);
return;
}
/** \brief Set SSD1306 column address.
Send column address command and address to the SSD1306 OLED controller.
*/
void MicroOLED::setColumnAddress(uint8_t add)
{
command((0x10 | (add >> 4)) + 0x02);
command((0x0f & add));
return;
}
/** \brief Clear screen buffer or SSD1306's memory.
To clear GDRAM inside the LCD controller, pass in the variable mode = ALL and to clear screen page buffer pass in the variable mode = PAGE.
*/
void MicroOLED::clear(uint8_t mode)
{
// uint8_t page=6, col=0x40;
if (mode == ALL)
{
for (int i = 0; i < 8; i++)
{
setPageAddress(i);
setColumnAddress(0);
if (moled_interface == MOLED_MODE_I2C)
{
uint8_t zeros[0x80];
memset(zeros, 0, 0x80);
i2cWriteMultiple(moled_i2c_address, (uint8_t *)&zeros, 0x80);
}
else
{
for (int j = 0; j < 0x80; j++)
{
data(0);
}
}
}
}
else
{
memset(screenmemory, 0, 384); // (64 x 48) / 8 = 384
//display();
}
}
/** \brief Clear or replace screen buffer or SSD1306's memory with a character.
To clear GDRAM inside the LCD controller, pass in the variable mode = ALL with c character and to clear screen page buffer, pass in the variable mode = PAGE with c character.
*/
void MicroOLED::clear(uint8_t mode, uint8_t c)
{
//uint8_t page=6, col=0x40;
if (mode == ALL)
{
for (int i = 0; i < 8; i++)
{
setPageAddress(i);
setColumnAddress(0);
if (moled_interface == MOLED_MODE_I2C)
{
uint8_t zeros[0x80];
memset(zeros, c, 0x80);
i2cWriteMultiple(moled_i2c_address, (uint8_t *)&zeros, 0x80);
}
else
{
for (int j = 0; j < 0x80; j++)
{
data(c);
}
}
}
}
else
{
memset(screenmemory, c, 384); // (64 x 48) / 8 = 384
display();
}
}
/** \brief Invert display.
The WHITE color of the display will turn to BLACK and the BLACK will turn to WHITE.
*/
void MicroOLED::invert(boolean inv)
{
if (inv)
command(INVERTDISPLAY);
else
command(NORMALDISPLAY);
}
/** \brief Set contrast.
OLED contract value from 0 to 255. Note: Contrast level is not very obvious.
*/
void MicroOLED::contrast(uint8_t contrast)
{
command(SETCONTRAST); // 0x81
command(contrast);
}
/** \brief Transfer display memory.
Bulk move the screen buffer to the SSD1306 controller's memory so that images/graphics drawn on the screen buffer will be displayed on the OLED.
*/
void MicroOLED::display(void)
{
uint8_t i, j;
for (i = 0; i < 6; i++)
{
setPageAddress(i);
setColumnAddress(0);
if (moled_interface == MOLED_MODE_I2C)
{
i2cWriteMultiple(moled_i2c_address, (uint8_t *)&screenmemory[i * 0x40], 0x40);
}
else
{
for (j = 0; j < 0x40; j++)
{
data(screenmemory[i * 0x40 + j]);
}
}
}
}
/** \brief Override Arduino's Print.
Arduino's print overridden so that we can use uView.print().
*/
size_t MicroOLED::write(uint8_t c)
{
if (c == '\n')
{
cursorY += fontHeight;
cursorX = 0;
}
else if (c == '\r')
{
// skip
}
else
{
drawChar(cursorX, cursorY, c, foreColor, drawMode);
cursorX += fontWidth + 1;
if ((cursorX > (LCDWIDTH - fontWidth)))
{
cursorY += fontHeight;
cursorX = 0;
}
}
return 1;
}
/** \brief Set cursor position.
MicroOLED's cursor position to x,y.
*/
void MicroOLED::setCursor(uint8_t x, uint8_t y)
{
cursorX = x;
cursorY = y;
}
/** \brief Draw pixel.
Draw pixel using the current fore color and current draw mode in the screen buffer's x,y position.
*/
void MicroOLED::pixel(uint8_t x, uint8_t y)
{
pixel(x, y, foreColor, drawMode);
}
/** \brief Draw pixel with color and mode.
Draw color pixel in the screen buffer's x,y position with NORM or XOR draw mode.
*/
void MicroOLED::pixel(uint8_t x, uint8_t y, uint8_t color, uint8_t mode)
{
if ((x >= LCDWIDTH) || (y >= LCDHEIGHT))
return;
if (mode == XOR)
{
if (color == WHITE)
screenmemory[x + (y / 8) * LCDWIDTH] ^= _BV((y % 8));
}
else
{
if (color == WHITE)
screenmemory[x + (y / 8) * LCDWIDTH] |= _BV((y % 8));
else
screenmemory[x + (y / 8) * LCDWIDTH] &= ~_BV((y % 8));
}
}
/** \brief Draw line.
Draw line using current fore color and current draw mode from x0,y0 to x1,y1 of the screen buffer.
*/
void MicroOLED::line(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1)
{
line(x0, y0, x1, y1, foreColor, drawMode);
}
/** \brief Draw line with color and mode.
Draw line using color and mode from x0,y0 to x1,y1 of the screen buffer.
*/
void MicroOLED::line(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, uint8_t color, uint8_t mode)
{
if (_printDebug == true)
{
_debugPort->print(F("line: line coords: ("));
_debugPort->print(x0);
_debugPort->print(F(","));
_debugPort->print(y0);
_debugPort->print(F(") ("));
_debugPort->print(x1);
_debugPort->print(F(","));
_debugPort->print(y1);
_debugPort->println(F(")"));
}
uint8_t steep = abs(y1 - y0) > abs(x1 - x0);
if (steep)
{
swapOLED(&x0, &y0);
swapOLED(&x1, &y1);
if (_printDebug == true)
_debugPort->println(F("line: line is steep"));
}
if (x0 > x1)
{
swapOLED(&x0, &x1);
swapOLED(&y0, &y1);
if (_printDebug == true)
_debugPort->println(F("line: x0 > x1"));
}
// if (_printDebug == true)
// {
// _debugPort->print(F("line: line coords: ("));
// _debugPort->print(x0);
// _debugPort->print(F(","));
// _debugPort->print(y0);
// _debugPort->print(F(") ("));
// _debugPort->print(x1);
// _debugPort->print(F(","));
// _debugPort->print(y1);
// _debugPort->println(F(")"));
// }
uint8_t dx, dy;
dx = x1 - x0;
dy = abs(y1 - y0);
if (_printDebug == true)
{
_debugPort->print(F("line: dx: "));
_debugPort->print(dx);
_debugPort->print(F(" dy: "));
_debugPort->println(dy);
}
if ((dx == 0) && (dy == 0))
{
if (_printDebug == true)
_debugPort->print(F("line: zero length!"));
pixel(x0, y0, color, mode);
return;
}
int8_t err = dx / 2;
int8_t ystep;
if (_printDebug == true)
{
_debugPort->print(F("line: err: "));
_debugPort->println(err);
}
if (y0 < y1)
{
ystep = 1;
}
else
{
ystep = -1;
}
if (_printDebug == true)
{
_debugPort->print(F("line: ystep: "));
_debugPort->println(ystep);
}
for (; x0 <= x1; x0++)
{
if (steep)
{
pixel(y0, x0, color, mode);
if (_printDebug == true)
{
_debugPort->print(F("line: steep pixel: ("));
_debugPort->print(y0);
_debugPort->print(F(","));
_debugPort->print(x0);
_debugPort->println(F(")"));
}
}
else
{
pixel(x0, y0, color, mode);
if (_printDebug == true)
{
_debugPort->print(F("line: pixel: ("));
_debugPort->print(x0);
_debugPort->print(F(","));
_debugPort->print(y0);
_debugPort->println(F(")"));
}
}
err -= dy;
if (err < 0)
{
y0 += ystep;
err += dx;
}
}
}
/** \brief Draw horizontal line.
Draw horizontal line using current fore color and current draw mode from x,y to x+width,y of the screen buffer.
*/
void MicroOLED::lineH(uint8_t x, uint8_t y, uint8_t width)
{
line(x, y, x + width, y, foreColor, drawMode);
}
/** \brief Draw horizontal line with color and mode.
Draw horizontal line using color and mode from x,y to x+width,y of the screen buffer.
*/
void MicroOLED::lineH(uint8_t x, uint8_t y, uint8_t width, uint8_t color, uint8_t mode)
{
line(x, y, x + width, y, color, mode);
}
/** \brief Draw vertical line.
Draw vertical line using current fore color and current draw mode from x,y to x,y+height of the screen buffer.
*/
void MicroOLED::lineV(uint8_t x, uint8_t y, uint8_t height)
{
line(x, y, x, y + height, foreColor, drawMode);
}
/** \brief Draw vertical line with color and mode.
Draw vertical line using color and mode from x,y to x,y+height of the screen buffer.
*/
void MicroOLED::lineV(uint8_t x, uint8_t y, uint8_t height, uint8_t color, uint8_t mode)
{
line(x, y, x, y + height, color, mode);
}
/** \brief Draw rectangle.
Draw rectangle using current fore color and current draw mode from x,y to x+width,y+height of the screen buffer.
*/
void MicroOLED::rect(uint8_t x, uint8_t y, uint8_t width, uint8_t height)
{
rect(x, y, width, height, foreColor, drawMode);
}
/** \brief Draw rectangle with color and mode.
Draw rectangle using color and mode from x,y to x+width,y+height of the screen buffer.
*/
void MicroOLED::rect(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t color, uint8_t mode)
{
uint8_t tempHeight;
lineH(x, y, width, color, mode);
lineH(x, y + height - 1, width, color, mode);
tempHeight = height - 2;
// skip drawing vertical lines to avoid overlapping of pixel that will
// affect XOR plot if no pixel in between horizontal lines
if (tempHeight < 1)
return;
lineV(x, y + 1, tempHeight, color, mode);
lineV(x + width - 1, y + 1, tempHeight, color, mode);
}
/** \brief Draw filled rectangle.
Draw filled rectangle using current fore color and current draw mode from x,y to x+width,y+height of the screen buffer.
*/
void MicroOLED::rectFill(uint8_t x, uint8_t y, uint8_t width, uint8_t height)
{
rectFill(x, y, width, height, foreColor, drawMode);
}
/** \brief Draw filled rectangle with color and mode.
Draw filled rectangle using color and mode from x,y to x+width,y+height of the screen buffer.
*/
void MicroOLED::rectFill(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t color, uint8_t mode)
{
// TODO - need to optimise the memory map draw so that this function will not call pixel one by one
for (int i = x; i < x + width; i++)
{
lineV(i, y, height, color, mode);
}
}
/** \brief Draw circle.
Draw circle with radius using current fore color and current draw mode at x,y of the screen buffer.
*/
void MicroOLED::circle(uint8_t x0, uint8_t y0, uint8_t radius)
{
circle(x0, y0, radius, foreColor, drawMode);
}
/** \brief Draw circle with color and mode.
Draw circle with radius using color and mode at x,y of the screen buffer.
*/
void MicroOLED::circle(uint8_t x0, uint8_t y0, uint8_t radius, uint8_t color, uint8_t mode)
{
//TODO - find a way to check for no overlapping of pixels so that XOR draw mode will work perfectly
int8_t f = 1 - radius;
int8_t ddF_x = 1;
int8_t ddF_y = -2 * radius;
int8_t x = 0;
int8_t y = radius;
pixel(x0, y0 + radius, color, mode);
pixel(x0, y0 - radius, color, mode);
pixel(x0 + radius, y0, color, mode);
pixel(x0 - radius, y0, color, mode);
while (x < y)
{
if (f >= 0)
{
y--;
ddF_y += 2;
f += ddF_y;
}
x++;
ddF_x += 2;
f += ddF_x;
pixel(x0 + x, y0 + y, color, mode);
pixel(x0 - x, y0 + y, color, mode);
pixel(x0 + x, y0 - y, color, mode);
pixel(x0 - x, y0 - y, color, mode);
pixel(x0 + y, y0 + x, color, mode);
pixel(x0 - y, y0 + x, color, mode);
pixel(x0 + y, y0 - x, color, mode);
pixel(x0 - y, y0 - x, color, mode);
}
}
/** \brief Draw filled circle.
Draw filled circle with radius using current fore color and current draw mode at x,y of the screen buffer.
*/
void MicroOLED::circleFill(uint8_t x0, uint8_t y0, uint8_t radius)
{
circleFill(x0, y0, radius, foreColor, drawMode);
}
/** \brief Draw filled circle with color and mode.
Draw filled circle with radius using color and mode at x,y of the screen buffer.
*/
void MicroOLED::circleFill(uint8_t x0, uint8_t y0, uint8_t radius, uint8_t color, uint8_t mode)
{
// TODO - - find a way to check for no overlapping of pixels so that XOR draw mode will work perfectly
int8_t f = 1 - radius;
int8_t ddF_x = 1;
int8_t ddF_y = -2 * radius;
int8_t x = 0;
int8_t y = radius;
// Temporary disable fill circle for XOR mode.
if (mode == XOR)
return;
for (uint8_t i = y0 - radius; i <= y0 + radius; i++)
{
pixel(x0, i, color, mode);
}
while (x < y)
{
if (f >= 0)
{
y--;
ddF_y += 2;
f += ddF_y;
}
x++;
ddF_x += 2;
f += ddF_x;
for (uint8_t i = y0 - y; i <= y0 + y; i++)
{
pixel(x0 + x, i, color, mode);
pixel(x0 - x, i, color, mode);
}
for (uint8_t i = y0 - x; i <= y0 + x; i++)
{
pixel(x0 + y, i, color, mode);
pixel(x0 - y, i, color, mode);
}
}
}
/** \brief Get LCD height.
The height of the LCD return as byte.
*/
uint8_t MicroOLED::getLCDHeight(void)
{
return LCDHEIGHT;
}
/** \brief Get LCD width.
The width of the LCD return as byte.
*/
uint8_t MicroOLED::getLCDWidth(void)
{
return LCDWIDTH;
}
/** \brief Get font width.
The cucrrent font's width return as byte.
*/
uint8_t MicroOLED::getFontWidth(void)