/
adafruit-pitft.py
955 lines (865 loc) · 38.4 KB
/
adafruit-pitft.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
"""
Adafruit PiTFT Installer Script
(C) Adafruit Industries, Creative Commons 3.0 - Attribution Share Alike
Written in Python by Melissa LeBlanc-Williams for Adafruit Industries
"""
import time
import os
try:
import click
except ImportError:
raise RuntimeError("The library 'Click' was not found. To install, try typing: pip3 install Click")
try:
from adafruit_shell import Shell
except ImportError:
raise RuntimeError("The library 'adafruit_shell' was not found. To install, try typing: pip3 install adafruit-python-shell")
shell = Shell()
shell.group = 'PITFT'
__version__ = "3.9.0"
"""
This is the main configuration. Displays should be placed in the order
they are to appear in the menu.
"""
config = [
{
"type": "28r",
"menulabel": "PiTFT 2.4\", 2.8\" or 3.2\" resistive (240x320)",
"product": "2.8\" resistive, PID 1601",
"kernel_upgrade": False,
"touchscreen": {
"identifier": "STMPE Touchscreen Calibration",
"product": "stmpe",
"transforms": {
"0": "0.988809 -0.023645 0.060523 -0.028817 1.003935 0.034176 0 0 1",
"90": "0.014773 -1.132874 1.033662 1.118701 0.009656 -0.065273 0 0 1",
"180": "-1.115235 -0.010589 1.057967 -0.005964 -1.107968 1.025780 0 0 1",
"270": "-0.033192 1.126869 -0.014114 -1.115846 0.006580 1.050030 0 0 1",
},
"overlay_params": {
"0": None,
"90": "touch-swapxy,touch-invx",
"180": "touch-invx,touch-invy",
"270": "touch-swapxy,touch-invy",
},
},
"overlay": "dtoverlay=pitft28-resistive,rotate={pitftrot},speed=64000000,fps=30",
"overlay_drm_option": "drm",
"force_x11": True,
"calibrations": {
"0": "4232 11 -879396 1 5786 -752768 65536",
"90": "33 -5782 21364572 4221 35 -1006432 65536",
"180": "-4273 61 16441290 4 -5772 21627524 65536",
"270": "-9 5786 -784608 -4302 19 16620508 65536",
},
"width": 320,
"height": 240,
},
{
"type": "22",
"menulabel": "PiTFT 2.2\" no touch",
"product": "2.2\" no touch",
"kernel_upgrade": False,
"overlay": "dtoverlay=pitft22,rotate={pitftrot},speed=64000000,fps=30",
"overlay_drm_option": "drm",
"width": 320,
"height": 240,
},
{
"type": "28c",
"menulabel": "PiTFT 2.8\" capacitive touch",
"product": "2.8\" capacitive, PID 1983",
"kernel_upgrade": False,
"touchscreen": {
"identifier": "FocalTech Touchscreen Calibration",
"product": "EP0110M09",
"transforms": {
"0": "-1 0 1 0 -1 1 0 0 1",
"90": "0 1 0 -1 0 1 0 0 1",
"180": "1 0 0 0 1 0 0 0 1",
"270": "0 -1 1 1 0 0 0 0 1",
},
"overlay_params": {
"0": "touch-invx,touch-invy",
"90": "touch-swapxy,touch-invy",
"180": None,
"270": "touch-swapxy,touch-invx",
},
},
"overlay": "dtoverlay=pitft28-capacitive,rotate={pitftrot},speed=64000000,fps=30",
"overlay_drm_option": "drm",
"force_x11": True,
"calibrations": "320 65536 0 -65536 0 15728640 65536",
"width": 320,
"height": 240,
},
{
"type": "35r",
"menulabel": "PiTFT 3.5\" resistive touch",
"product": "3.5\" Resistive",
"kernel_upgrade": False,
"touchscreen": {
"identifier": "STMPE Touchscreen Calibration",
"product": "stmpe",
"transforms": {
"0": "-1.098388 0.003455 1.052099 0.005512 -1.093095 1.026309 0 0 1",
"90": "-0.000087 1.094214 -0.028826 -1.091711 -0.004364 1.057821 0 0 1",
"180": "1.102807 0.000030 -0.066352 0.001374 1.085417 -0.027208 0 0 1",
"270": "0.003893 -1.087542 1.025913 1.084281 0.008762 -0.060700 0 0 1",
},
"overlay_params": {
"0": None,
"90": "touch-swapxy,touch-invx",
"180": "touch-invx,touch-invy",
"270": "touch-swapxy,touch-invy",
},
},
"overlay": "dtoverlay=pitft35-resistive,rotate={pitftrot},speed=20000000,fps=20",
"overlay_drm_option": "drm",
"force_x11": True,
"calibrations": {
"0": "5724 -6 -1330074 26 8427 -1034528 65536",
"90": "5 8425 -978304 -5747 61 22119468 65536",
"180": "-5682 -1 22069150 13 -8452 32437698 65536",
"270": "3 -8466 32440206 5703 -1 -1308696 65536",
},
"width": 480,
"height": 320,
"x11_scale": 1.5,
},
{
"type": "st7789_240x240",
"menulabel": "PiTFT Mini 1.3\" or 1.54\" display",
"product": "1.54\" or 1.3\" no touch",
"kernel_upgrade": True,
"kernel_module": "fb_st7789v",
"overlay_src": "overlays/minipitft13-overlay.dts",
"overlay_dest": "{boot_dir}/overlays/drm-minipitft13.dtbo",
"overlay": "dtoverlay=drm-minipitft13,rotate={pitftrot},fps=60",
"use_kms": True,
"mipi_data": {
"command_bin": "adafruit_st7789_drm",
"gpio": "dc-gpio=25,backlight-gpio=22",
"viewport": {
"0": "width=240,height=240",
"90": "width=240,height=240,x-offset=80",
"180": "width=240,height=240,y-offset=80",
"270": "width=240,height=240",
},
},
"width": 240,
"height": 240,
"fbcp_rotations": {
"0": "0",
"90": "1",
"180": "2",
"270": "3",
},
},
{
"type": "st7789_240x320",
"menulabel": "ST7789V 2.0\" no touch",
"product": "2.0\" no touch",
"kernel_upgrade": True,
"kernel_module": "fb_st7789v",
"overlay_src": "overlays/st7789v_240x320-overlay.dts",
"overlay_dest": "{boot_dir}/overlays/drm-st7789v_240x320.dtbo",
"overlay": "dtoverlay=drm-st7789v_240x320,rotate={pitftrot},fps=30",
"use_kms": True,
"mipi_data": {
"command_bin": "adafruit_st7789_drm",
"gpio": "dc-gpio=25,backlight-gpio=22",
"viewport": {
"0": "width=320,height=240",
"90": "width=240,height=320",
"180": "width=320,height=240",
"270": "width=240,height=320",
},
},
"width": 320,
"height": 240,
},
{
"type": "st7789_240x135",
"menulabel": "MiniPiTFT 1.14\" display",
"product": "1.14\" no touch",
"kernel_upgrade": True,
"kernel_module": "fb_st7789v",
"overlay_src": "overlays/minipitft114-overlay.dts",
"overlay_dest": "{boot_dir}/overlays/drm-minipitft114.dtbo",
"overlay": "dtoverlay=drm-minipitft114,rotate={pitftrot},fps=60",
"use_kms": True,
"mipi_data": {
"command_bin": "adafruit_st7789_drm",
"gpio": "dc-gpio=25,backlight-gpio=22",
"viewport": {
"0": "width=136,height=240,x-offset=52,y-offset=40",
"90": "width=240,height=136,y-offset=52,x-offset=40",
"180": "width=136,height=240,x-offset=52,y-offset=40",
"270": "width=240,height=136,y-offset=52,x-offset=40",
},
},
"rotations": {
"0": None,
"90": "90",
"180": None,
"270": "270",
},
"width": 240,
"height": 135,
"fbcp_rotations": {
"0": "3",
"90": "2",
"180": "1",
"270": "0",
},
},
{
"type": "st7789v_bonnet_240x240",
"menulabel": "BrainCraft HAT or 1.3\" TFT Bonnet + Joystick",
"product": "1.3\" Joystick",
"kernel_upgrade": True,
"kernel_module": "fb_st7789v",
"overlay_src": "overlays/tftbonnet13-overlay.dts",
"overlay_dest": "{boot_dir}/overlays/drm-tftbonnet13.dtbo",
"overlay": "dtoverlay=drm-tftbonnet13,rotate={pitftrot},fps=60",
"use_kms": True,
"mipi_data": {
"command_bin": "adafruit_st7789_drm",
"gpio": "dc-gpio=25,backlight-gpio=26",
"viewport": {
"0": "width=240,height=240",
"90": "width=240,height=240,x-offset=80",
"180": "width=240,height=240,y-offset=80",
"270": "width=240,height=240",
},
},
"width": 240,
"height": 240,
"fbcp_rotations": {
"0": "0",
"90": "1",
"180": "2",
"270": "3",
},
},
]
# default rotations
fbcp_rotations = {
"0": "1",
"90": "0",
"180": "3",
"270": "2",
}
# default mipi data
mipi_data = {
"speed": 40000000,
"spi": "spi0-0",
}
PITFT_ROTATIONS = ("90", "180", "270", "0")
UPDATE_DB = False
SYSTEMD = None
REMOVE_KERNEL_PINNING = False
pitft_config = None
pitftrot = None
auto_reboot = None
wayland = False
is_bullseye = False
def warn_exit(message):
shell.warn(message)
shell.exit(1)
def uninstall_cb(ctx, param, value):
if not value or ctx.resilient_parsing:
return
uninstall()
def print_version(ctx, param, value):
if not value or ctx.resilient_parsing:
return
print("Adafruit PiTFT Helper v{}".format(__version__))
shell.exit(1)
def progress(ellipsis_count):
for i in range(ellipsis_count):
print("...", end='')
time.sleep(1)
print("")
def sysupdate():
global UPDATE_DB
if not UPDATE_DB:
print("Updating apt indexes...", end='')
progress(3)
if not shell.run_command('sudo apt update', suppress_message=True):
warn_exit("Apt failed to update indexes! Try running 'sudo apt update' manually.")
if not shell.run_command('sudo apt-get update', suppress_message=True):
warn_exit("Apt failed to update indexes! Try running 'sudo apt-get update' manually.")
print("Reading package lists...")
progress(3)
UPDATE_DB = True
return True
############################ Sub-Scripts ############################
def is_wayland():
username = os.environ["SUDO_USER"]
output = shell.run_command("loginctl show-session $(loginctl | grep $(whoami) | awk '{print $1}') -p Type | grep wayland", suppress_message=True, return_output=True, run_as_user=username).strip()
return len(output) > 0
def softwareinstall():
print("Installing Pre-requisite Software...This may take a few minutes!")
if not shell.run_command("apt-get install -y libts0", suppress_message=True):
if not shell.run_command("apt-get install -y tslib"):
if not shell.run_command("apt-get install -y libts-dev"):
warn_exit("Apt failed to install TSLIB!")
if not shell.run_command("apt-get install -y bc fbi git python3-dev python3-pip python3-smbus python3-spidev evtest libts-bin device-tree-compiler libraspberrypi-dev build-essential python3-evdev"):
warn_exit("Apt failed to install software!")
return True
def uninstall_bootconfigtxt():
"""Remove any old flexfb/fbtft stuff"""
if shell.pattern_search(f"{boot_dir}/config.txt", "adafruit-pitft-helper"):
print(f"Already have an adafruit-pitft-helper section in {boot_dir}/config.txt.")
print("Removing old section...")
shell.run_command(f"cp {boot_dir}/config.txt {boot_dir}/configtxt.bak")
shell.pattern_replace(f"{boot_dir}/config.txt", '\n# --- added by adafruit-pitft-helper.*?\n# --- end adafruit-pitft-helper.*?\n', multi_line=True)
return True
def uninstall_etc_modules():
"""Remove any old flexfb/fbtft stuff"""
shell.run_command('rm -f /etc/modprobe.d/fbtft.conf')
shell.pattern_replace("/etc/modules", 'spi-bcm2835')
shell.pattern_replace("/etc/modules", 'flexfb')
shell.pattern_replace("/etc/modules", 'fbtft_device')
return True
def use_mipi_driver(config = None):
"""Check if MIPI Overlay is Present"""
if not config:
config = pitft_config
if not "mipi_data" in config:
return False
if not shell.exists(f"{boot_dir}/overlays/mipi-dbi-spi.dtbo"):
return False
return True
def is_kernel_upgrade_required(config = None):
"""Check if kernel upgrade is required"""
if not config:
config = pitft_config
if not config['kernel_upgrade']:
return False
# Only upgrade Kernel if MIPI Driver is not an option
if use_mipi_driver(config):
return False
return True
def install_drivers():
"""Compile display driver and overlay if required"""
if "overlay_src" in pitft_config and "overlay_dest" in pitft_config:
print("Compiling Device Tree Overlay")
destination = pitft_config['overlay_dest'].format(boot_dir=boot_dir)
shell.run_command("dtc --warning no-unit_address_vs_reg -I dts -O dtb -o {dest} {src}".format(dest=destination, src=pitft_config['overlay_src']))
if use_mipi_driver():
mipi_data.update(pitft_config['mipi_data'])
if not compile_display_fw():
shell.bail("Unable to compile MIPI firmware")
if is_kernel_upgrade_required():
print("############# UPGRADING KERNEL ###############")
print("Updating packages...")
if not shell.run_command("sudo apt-get update", suppress_message=True):
warn_exit("Apt failed to update itself!")
print("Upgrading packages...")
if not shell.run_command("sudo apt-get -y upgrade"):
warn_exit("Apt failed to install software!")
print("Installing Kernel Headers. This may take a few minutes...")
if not shell.run_command("apt-get install -y raspberrypi-kernel-headers", suppress_message=True):
warn_exit("Apt failed to install software!")
# If the kernel was upgraded, a build folder should exist once it has been loaded
module = pitft_config['kernel_module']
if not shell.isdir(f"/lib/modules/{shell.release()}/build"):
warn_exit(f"Kernel headers build folder for {shell.release()}, not found. Please reboot now and re-run script!")
print("Compiling and installing display driver...")
shell.pushd("st7789_module")
if not shell.run_command("make"):
warn_exit("Apt failed to compile ST7789V drivers!")
shell.run_command(f"mv /lib/modules/{shell.release()}/kernel/drivers/staging/fbtft/{module}.ko.xz /lib/modules/{shell.release()}/kernel/drivers/staging/fbtft/{module}.BACK.xz")
shell.run_command(f"xz -v2 {module}.ko")
shell.run_command(f"mv {module}.ko.xz /lib/modules/{shell.release()}/kernel/drivers/staging/fbtft/{module}.ko.xz")
shell.popd()
return True
def update_configtxt(rotation_override=None, tinydrm_install=False):
"""update /boot/config.txt (or equivalent folder) with appropriate values"""
uninstall_bootconfigtxt()
uninstall_etc_modules()
overlay_key = "overlay"
overlay = pitft_config[overlay_key]
if "{pitftrot}" in overlay:
rotation = str(rotation_override) if rotation_override is not None else pitftrot
overlay = overlay.format(pitftrot=rotation)
if use_mipi_driver():
# Mipi Driver does not work if hdmi_force_hotplug=1 is present
shell.pattern_replace(f"{boot_dir}/config.txt", "hdmi_force_hotplug=1", "hdmi_force_hotplug=0")
# Use the MIPI Overlay instead
overlay = f"dtoverlay=mipi-dbi-spi,{mipi_data['spi']},speed=40000000"
overlay += f"\ndtparam=compatible={mipi_data['command_bin']}\\0panel-mipi-dbi-spi"
viewport = ""
if mipi_data['viewport'][pitftrot] is not None:
viewport = mipi_data['viewport'][pitftrot]
overlay += f"\ndtparam={viewport}"
if "gpio" in mipi_data:
overlay += f"\ndtparam={mipi_data['gpio']}"
if tinydrm_install and "overlay_drm_option" in pitft_config:
overlay += "," + pitft_config["overlay_drm_option"]
if tinydrm_install: # Wayland ignores X11 Transformations, so use params instead
if "overlay_params" in pitft_config and pitftrot in pitft_config["overlay_params"] and pitft_config["overlay_params"][pitftrot] is not None:
overlay += "," + pitft_config["overlay_params"][pitftrot]
shell.write_text_file(f"{boot_dir}/config.txt", """
# --- added by adafruit-pitft-helper {date} ---
[all]
hdmi_force_hotplug=1 # required for cases when HDMI is not plugged in!
dtparam=spi=on
dtparam=i2c1=on
dtparam=i2c_arm=on
{overlay}
# --- end adafruit-pitft-helper {date} ---
""".format(date=shell.date(), overlay=overlay))
return True
def update_udev():
shell.write_text_file("/etc/udev/rules.d/95-touchmouse.rules", """
SUBSYSTEM=="input", ATTRS{name}=="touchmouse", ENV{DEVNAME}=="*event*", SYMLINK+="input/touchscreen"
""", append=False)
shell.write_text_file("/etc/udev/rules.d/95-ftcaptouch.rules", """
SUBSYSTEM=="input", ATTRS{name}=="EP0110M09", ENV{DEVNAME}=="*event*", SYMLINK+="input/touchscreen"
SUBSYSTEM=="input", ATTRS{name}=="generic ft5x06*", ENV{DEVNAME}=="*event*", SYMLINK+="input/touchscreen"
""", append=False)
shell.write_text_file("/etc/udev/rules.d/95-stmpe.rules", """
SUBSYSTEM=="input", ATTRS{name}=="*stmpe*", ENV{DEVNAME}=="*event*", SYMLINK+="input/touchscreen"
""", append=False)
return True
def compile_display_fw():
command_src = "mipi/panel.txt"
# We could just copy the file to panel.txt, edit that, then remove it after
shell.copy(f"mipi/{mipi_data['command_bin']}.txt", command_src)
# Make sure each of the lines with "# rotation" starts with exactly 1 # and no more
shell.pattern_replace(command_src, "^#*(.*?# rotation.*?$)", "#\\1")
# Uncomment the one for the rotation we are going for
shell.pattern_replace(command_src, "^#(.*?# rotation " + pitftrot + ".*?$)", "\\1")
# Download the mipi-dbi-cmd script if it doesn't exist
if not shell.exists("mipi-dbi-cmd"):
shell.run_command("wget https://raw.githubusercontent.com/notro/panel-mipi-dbi/main/mipi-dbi-cmd")
shell.run_command("chmod +x mipi-dbi-cmd")
# Run the mipi-dbi-script and output directly to the /lib/firmware folder
shell.run_command(f"./mipi-dbi-cmd /lib/firmware/{mipi_data['command_bin']}.bin mipi/panel.txt")
shell.remove(command_src)
return True
def update_pointercal():
if "calibrations" in pitft_config:
if isinstance(pitft_config["calibrations"], dict):
shell.write_text_file("/etc/pointercal", pitft_config["calibrations"][pitftrot])
else:
shell.write_text_file("/etc/pointercal", pitft_config["calibrations"])
return True
def install_console():
print("Set up main console turn on")
if not shell.pattern_search(f"{boot_dir}/cmdline.txt", 'fbcon=map:10 fbcon=font:VGA8x8'):
print(f"Updating {boot_dir}/cmdline.txt")
shell.pattern_replace(f"{boot_dir}/cmdline.txt", "rootwait", "rootwait fbcon=map:10 fbcon=font:VGA8x8")
else:
print(f"{boot_dir}/cmdline.txt already updated")
print("Turning off console blanking")
# pre-stretch this is what you'd do:
if shell.exists("/etc/kbd/config"):
shell.pattern_replace("/etc/kbd/config", "BLANK_TIME=.*", "BLANK_TIME=0")
# as of stretch....
# removing any old version
shell.pattern_replace("/etc/rc.local", '# disable console blanking.*')
shell.pattern_replace("/etc/rc.local", 'sudo sh -c "TERM=linux setterm -blank.*')
shell.pattern_replace("/etc/rc.local", '^exit 0', "# disable console blanking on PiTFT\\nsudo sh -c \"TERM=linux setterm -blank 0 >/dev/tty0\"\\nexit 0")
shell.reconfig("/etc/default/console-setup", "^.*FONTFACE.*$", "FONTFACE=\"Terminus\"")
shell.reconfig("/etc/default/console-setup", "^.*FONTSIZE.*$", "FONTSIZE=\"6x12\"")
print("Setting raspi-config to boot to console w/o login...")
shell.chdir(target_homedir)
shell.run_command("raspi-config nonint do_boot_behaviour B2")
# remove fbcp
shell.pattern_replace("/etc/rc.local", "^.*fbcp.*$")
return True
def uninstall_console():
print(f"Removing console fbcon map from {boot_dir}/cmdline.txt")
shell.pattern_replace(f"{boot_dir}/cmdline.txt", 'rootwait fbcon=map:10 fbcon=font:VGA8x8', 'rootwait')
print("Screen blanking time reset to 10 minutes")
if shell.exists("/etc/kbd/config"):
shell.pattern_replace(f"{boot_dir}/cmdline.txt", 'BLANK_TIME=0', 'BLANK_TIME=10')
shell.pattern_replace("/etc/rc.local", '^# disable console blanking.*')
shell.pattern_replace("/etc/rc.local", '^sudo sh -c "TERM=linux.*')
return True
def install_fbcp():
global fbcp_rotations
print("Installing cmake...")
if not shell.run_command("apt-get --yes --allow-downgrades --allow-remove-essential --allow-change-held-packages install cmake", suppress_message=True):
warn_exit("Apt failed to install software!")
print("Downloading rpi-fbcp...")
shell.pushd("/tmp")
shell.run_command("curl -sLO https://github.com/adafruit/rpi-fbcp/archive/master.zip")
print("Uncompressing rpi-fbcp...")
shell.run_command("rm -rf /tmp/rpi-fbcp-master")
if not shell.run_command("unzip master.zip", suppress_message=True):
warn_exit("Failed to uncompress fbcp!")
shell.chdir("rpi-fbcp-master")
shell.run_command("mkdir build")
shell.chdir("build")
print("Building rpi-fbcp...")
shell.write_text_file("../CMakeLists.txt", "\nset (CMAKE_C_FLAGS \"-std=gnu99 ${CMAKE_C_FLAGS}\")")
if not shell.run_command("cmake ..", suppress_message=True):
warn_exit("Failed to cmake fbcp!")
if not shell.run_command("make", suppress_message=True):
warn_exit("Failed to make fbcp!")
print("Installing rpi-fbcp...")
shell.run_command("install fbcp /usr/local/bin/fbcp")
shell.popd()
shell.run_command("rm -rf /tmp/rpi-fbcp-master")
if "fbcp_rotations" in pitft_config:
fbcp_rotations = pitft_config['fbcp_rotations']
# Start fbcp in the appropriate place, depending on init system:
if SYSTEMD:
# Add fbcp to /etc/rc.local:
print("We have sysvinit, so add fbcp to /etc/rc.local...")
if shell.pattern_search("/etc/rc.local", "fbcp"):
# fbcp already in rc.local, but make sure correct:
shell.pattern_replace("/etc/rc.local", "^.*fbcp.*$", "/usr/local/bin/fbcp \&")
else:
# Insert fbcp into rc.local before final 'exit 0':
shell.pattern_replace("/etc/rc.local", "^exit 0", "/usr/local/bin/fbcp \&\\nexit 0")
else:
# Install fbcp systemd unit, first making sure it's not in rc.local:
uninstall_fbcp_rclocal()
print("We have systemd, so install fbcp systemd unit...")
if not install_fbcp_unit():
shell.bail("Unable to install fbcp unit file")
shell.run_command("sudo systemctl enable fbcp.service")
# if there's X11 installed...
if shell.exists("/etc/lightdm"):
print("Setting raspi-config to boot to desktop w/o login...")
shell.run_command("raspi-config nonint do_boot_behaviour B4")
# Disable overscan compensation (use full screen):
shell.run_command("raspi-config nonint do_overscan 1")
# Set up HDMI parameters:
print("Configuring boot/config.txt for forced HDMI")
shell.reconfig(f"{boot_dir}/config.txt", "^.*hdmi_force_hotplug.*$", "hdmi_force_hotplug=1")
shell.reconfig(f"{boot_dir}/config.txt", "^.*hdmi_group.*$", "hdmi_group=2")
shell.reconfig(f"{boot_dir}/config.txt", "^.*hdmi_mode.*$", "hdmi_mode=87")
# Don't use the 3D driver if we're on X11, unless the display specifically uses kms
if (is_bullseye or not wayland) and ("use_kms" not in pitft_config or not pitft_config["use_kms"]):
shell.pattern_replace(f"{boot_dir}/config.txt", "^[^#]*dtoverlay=vc4-kms-v3d.*$", "#dtoverlay=vc4-kms-v3d")
shell.pattern_replace(f"{boot_dir}/config.txt", "^[^#]*dtoverlay=vc4-fkms-v3d.*$", "#dtoverlay=vc4-fkms-v3d")
# if there's X11 installed...
scale = 1
if shell.exists("/etc/lightdm"):
if "x11_scale" in pitft_config:
scale = pitft_config["x11_scale"]
else:
scale = 2
WIDTH = int(pitft_config['width'] * scale)
HEIGHT = int(pitft_config['height'] * scale)
shell.reconfig(f"{boot_dir}/config.txt", "^.*hdmi_cvt.*$", "hdmi_cvt={} {} 60 1 0 0 0".format(WIDTH, HEIGHT))
try:
default_orientation = int(list(fbcp_rotations.keys())[list(fbcp_rotations.values()).index("0")])
except ValueError:
default_orientation = 90
if fbcp_rotations[pitftrot] == "0":
# dont rotate HDMI on default orientation
shell.reconfig(f"{boot_dir}/config.txt", "^.*display_hdmi_rotate.*$", "")
else:
display_rotate = fbcp_rotations[pitftrot]
shell.reconfig(f"{boot_dir}/config.txt", "^.*display_hdmi_rotate.*$", "display_hdmi_rotate={}".format(display_rotate))
# Because we rotate HDMI we have to 'unrotate' the TFT by overriding pitftrot!
if not update_configtxt(default_orientation):
shell.bail(f"Unable to update {boot_dir}/config.txt")
return True
def update_wayfire_settings():
# Set the scale factor for Wayland, which is the reciprocal of the X11 scale factor
if "x11_scale" in pitft_config:
scale = 1/pitft_config["x11_scale"]
else:
scale = 0.5
device_name = "SPI-1"
wayfire_config = f"{target_homedir}/.config/wayfire.ini"
# Remove any existing settings previously added by this script
shell.pattern_replace(wayfire_config, '\n# --- added by adafruit-pitft-helper.*?\n# --- end adafruit-pitft-helper.*?\n', multi_line=True)
date = shell.date()
shell.write_text_file(wayfire_config, f"""
# --- added by adafruit-pitft-helper {date} ---
[output:{device_name}]
scale = {scale}
# --- end adafruit-pitft-helper {date} ---
""")
shell.pattern_replace(target_homedir, "^.*[output:SPI-1].*$", "hdmi_force_hotplug=0")
def install_fbcp_unit():
shell.write_text_file("/etc/systemd/system/fbcp.service",
"""[Unit]
Description=Framebuffer copy utility for PiTFT
After=network.target
[Service]
Type=simple
ExecStartPre=/bin/sleep 10
ExecStart=/usr/local/bin/fbcp
[Install]
WantedBy=multi-user.target
""", append=False)
return True
def uninstall_fbcp():
uninstall_fbcp_rclocal()
# Enable overscan compensation
shell.run_command("sudo systemctl disable fbcp.service")
# Set up HDMI parameters:
shell.run_command("raspi-config nonint do_overscan 0")
print("Configuring boot/config.txt for default HDMI")
shell.reconfig(f"{boot_dir}/config.txt", "^.*hdmi_force_hotplug.*$", "hdmi_force_hotplug=0")
shell.pattern_replace(f"{boot_dir}/config.txt", "^.*#.*dtoverlay=vc4-kms-v3d.*$", "dtoverlay=vc4-kms-v3d")
shell.pattern_replace(f"{boot_dir}/config.txt", "^.*#.*dtoverlay=vc4-fkms-v3d.*$", "dtoverlay=vc4-fkms-v3d")
shell.pattern_replace(f"{boot_dir}/config.txt", '^hdmi_group=2.*$')
shell.pattern_replace(f"{boot_dir}/config.txt", '^hdmi_mode=87.*$')
shell.pattern_replace(f"{boot_dir}/config.txt", '^hdmi_cvt=.*$')
if not wayland and not is_bullseye:
print("Restoring Wayland as default display manager...")
disable_wayland(False)
return True
def uninstall_fbcp_rclocal():
"""Remove fbcp from /etc/rc.local:"""
print("Remove fbcp from /etc/rc.local, if it's there...")
shell.pattern_replace("/etc/rc.local", '^.*fbcp.*$')
return True
def update_xorg(tinydrm_install=False):
if "touchscreen" in pitft_config:
transform_setting = pitft_config["touchscreen"]["transforms"][pitftrot]
if not tinydrm_install and "old_transforms" in pitft_config["touchscreen"]:
transform_setting = pitft_config["touchscreen"]["old_transforms"][pitftrot]
transform = f"Option \"TransformationMatrix\" \"{transform_setting}\""
shell.write_text_file("/usr/share/X11/xorg.conf.d/20-calibration.conf", """
Section "InputClass"
Identifier "{identifier}"
MatchProduct "{product}"
MatchDevicePath "/dev/input/event*"
Driver "libinput"
{transform}
EndSection
""".format(
identifier=pitft_config["touchscreen"]["identifier"],
product=pitft_config["touchscreen"]["product"],
transform=transform
),
append=False,
)
return True
def get_config_types():
types = []
for item in config:
types.append(item["type"])
return types
def get_config(type):
for item in config:
if item["type"] == type:
return item
return None
def uninstall():
shell.info("Uninstalling PiTFT")
uninstall_bootconfigtxt()
uninstall_console()
uninstall_fbcp()
uninstall_fbcp_rclocal()
uninstall_etc_modules()
success()
def success():
global auto_reboot
shell.info("Success!")
print("""
Settings take effect on next boot.
""")
if auto_reboot is None:
auto_reboot = shell.prompt("REBOOT NOW?", default="y")
if not auto_reboot:
print("Exiting without reboot.")
shell.exit()
print("Reboot started...")
shell.reboot()
shell.exit()
def disable_wayland(disable):
if is_bullseye:
return
if disable:
print("Using X11 instead of Wayland")
if not shell.run_command("sudo raspi-config nonint do_wayland W1"):
shell.bail("Unable to disable Wayland")
else:
print("Using Wayland instead of X11")
if not shell.run_command("sudo raspi-config nonint do_wayland W1"):
shell.bail("Unable to enable Wayland")
####################################################### MAIN
target_homedir = "/home/pi"
username = os.environ["SUDO_USER"]
user_homedir = os.path.expanduser(f"~{username}")
if shell.isdir(user_homedir):
target_homedir = user_homedir
boot_dir = "/boot/firmware"
if not shell.exists(boot_dir) or not shell.isdir(boot_dir):
boot_dir = "/boot"
if shell.get_raspbian_version() == "bullseye":
is_bullseye = True
@click.command()
@click.option('-v', '--version', is_flag=True, callback=print_version, expose_value=False, is_eager=True, help="Print version information")
@click.option('-u', '--user', nargs=1, default=target_homedir, type=str, help="Specify path of primary user's home directory", show_default=True)
@click.option('--display', nargs=1, default=None, help="Specify a display option (1-{}) or type {}".format(len(config), get_config_types()))
@click.option('--rotation', nargs=1, default=None, type=int, help="Specify a rotation option (1-4) or degrees {}".format(tuple(sorted([int(x) for x in PITFT_ROTATIONS]))))
@click.option('--install-type', nargs=1, default=None, type=click.Choice(['mirror', 'fbcp', 'console', 'uninstall']), help="Installation Type")
@click.option('--reboot', nargs=1, default=None, type=click.Choice(['yes', 'no']), help="Specify whether to reboot after the script is finished")
@click.option('--boot', nargs=1, default=boot_dir, type=str, help="Specify the boot directory", show_default=True)
def main(user, display, rotation, install_type, reboot, boot):
global target_homedir, pitft_config, pitftrot, auto_reboot, boot_dir, wayland
shell.clear()
if user != target_homedir:
target_homedir = user
print(f"Homedir = {target_homedir}")
if boot != boot_dir:
if shell.isdir(boot):
boot_dir = boot
print(f"Boot dir = {boot_dir}")
else:
print(f"{boot} not found or not a directory. Using {boot_dir} instead.")
wayland = is_wayland()
print(("Wayland" if wayland else "X11") + " Detected")
if is_bullseye:
print("Bullseye Detected")
print()
# "mirror" will be the new install type, but keep fbcp for backwards compatibility
if install_type == "fbcp":
install_type = "mirror"
print("""This script downloads and installs
PiTFT Support using userspace touch
controls and a DTO for display drawing.
one of several configuration files.
Run time of up to 5 minutes. Reboot required!
""")
if reboot is not None:
auto_reboot = reboot.lower() == 'yes'
if install_type == "uninstall":
uninstall()
def select_display(config, interactive=False):
global pitft_config, wayland
print(("Wayland" if wayland else "X11") + " Detected")
pitft_config = config
print("Display Type: {}".format(pitft_config["menulabel"]))
if is_kernel_upgrade_required():
print("WARNING! WILL UPGRADE YOUR KERNEL TO LATEST")
if "force_x11" in pitft_config and pitft_config["force_x11"] and wayland:
if not interactive or shell.prompt("This display works better with X11, but Wayland is currently running. Use X11 instead? (Recommended)", default="y"):
disable_wayland(True)
wayland = False
if display in [str(x) for x in range(1, len(config) + 1)]:
select_display(config[int(display) - 1])
elif display in get_config_types():
select_display(get_config(display))
else:
# Build menu from config
selections = []
for item in config:
option = "{} ({}x{})".format(item['menulabel'], item['width'], item['height'])
if is_kernel_upgrade_required(item):
option += " - WARNING! WILL UPGRADE YOUR KERNEL TO LATEST"
selections.append(option)
selections.append("Uninstall PiTFT")
selections.append("Quit without installing")
PITFT_SELECT = shell.select_n("Select configuration:", selections)
if PITFT_SELECT == len(config) + 2:
shell.exit(1)
if PITFT_SELECT == len(config) + 1:
uninstall()
select_display(config[PITFT_SELECT - 1], True)
if rotation is not None and 1 <= rotation <= 4:
pitftrot = PITFT_ROTATIONS[rotation - 1]
shell.info("Rotation: {}".format(pitftrot))
elif str(rotation) in PITFT_ROTATIONS:
pitftrot = str(rotation)
shell.info("Rotation: {}".format(pitftrot))
else:
PITFT_ROTATE = shell.select_n(
"Select rotation:", (
"90 degrees (landscape)",
"180 degrees (portrait)",
"270 degrees (landscape)",
"0 degrees (portrait)"
))
pitftrot = PITFT_ROTATIONS[PITFT_ROTATE - 1]
if 'rotations' in pitft_config and isinstance(pitft_config['rotations'], dict) and pitftrot in pitft_config['rotations'] and pitft_config['rotations'][pitftrot] is None:
shell.bail("""Unfortunately {rotation} degrees for the {display} is not working at this time. Please
restart the script and choose a different orientation.""".format(rotation=pitftrot, display=pitft_config["menulabel"]))
if REMOVE_KERNEL_PINNING:
# Checking if kernel is pinned
if shell.exists('/etc/apt/preferences.d/99-adafruit-pin-kernel'):
shell.warn("WARNING! Script detected your system is currently pinned to an older kernel. The pin will be removed and your system will be updated.")
if not shell.prompt("Continue?"):
shell.exit()
shell.remove('/etc/apt/preferences.d/99-adafruit-pin-kernel')
# check init system (technique borrowed from raspi-config):
shell.info('Checking init system...')
if shell.run_command("which systemctl", suppress_message=True) and shell.run_command("systemctl | grep '\-\.mount'", suppress_message=True):
SYSTEMD = True
print("Found systemd")
elif os.path.isfile("/etc/init.d/cron") and not os.path.islink("/etc/init.d/cron"):
SYSTEMD = False
print("Found sysvinit")
else:
shell.bail("Unrecognised init system")
if shell.grep("boot", "/proc/mounts"):
print("/boot is mounted")
else:
print("/boot must be mounted. if you think it's not, quit here and try: sudo mount /dev/mmcblk0p1 /boot")
if shell.prompt("Continue?"):
print("Proceeding.")
else:
shell.bail("Aborting.")
if not shell.isdir(target_homedir):
shell.bail("{} must be an existing directory (use -u /home/foo to specify)".format(target_homedir))
shell.info("System update")
if not sysupdate():
shell.bail("Unable to apt-get update")
shell.info("Installing Python libraries & Software...")
if not softwareinstall():
shell.bail("Unable to install software")
if "overlay_src" in pitft_config and "overlay_dest" in pitft_config:
shell.info("Installing display drivers and device tree overlay...")
if not install_drivers():
shell.bail("Unable to install display drivers")
shell.info(f"Updating {boot_dir}/config.txt...")
if not update_configtxt(tinydrm_install=wayland):
shell.bail(f"Unable to update {boot_dir}/config.txt")
if "touchscreen" in pitft_config:
shell.info("Updating SysFS rules for Touchscreen...")
if not update_udev():
shell.bail("Unable to update /etc/udev/rules.d")
shell.info("Updating TSLib default calibration...")
if not update_pointercal():
shell.bail("Unable to update /etc/pointercal")
# ask for console access
if install_type == "console" or (install_type is None and shell.prompt("Would you like the console to appear on the PiTFT display?")):
shell.info("Updating console to PiTFT...")
if not uninstall_fbcp():
shell.bail("Unable to uninstall fbcp")
if not install_console():
shell.bail("Unable to configure console")
else:
shell.info("Making sure console doesn't use PiTFT")
if not uninstall_console():
shell.bail("Unable to configure console")
mirror_prompt = "Would you like the HDMI display to mirror to the PiTFT display?"
if wayland:
# With wayland, PiTFT shows up as an additional display rather than a mirror
mirror_prompt = "Would you like the to use the PiTFT as a desktop display?"
if install_type == "mirror" or (install_type is None and shell.prompt(mirror_prompt)):
if wayland:
shell.info("Updating Wayland desktop settings...")
update_wayfire_settings()
else:
shell.info("Adding FBCP support...")
if not install_fbcp():
shell.bail("Unable to configure fbcp")
if shell.exists("/etc/lightdm"):
shell.info("Updating Desktop Touch calibration...")
if not update_xorg(tinydrm_install=wayland):
shell.bail("Unable to update calibration")
else:
if not uninstall_fbcp():
shell.bail("Unable to uninstall fbcp")
success()
# Main function
if __name__ == "__main__":
shell.require_root()
shell.check_kernel_userspace_mismatch()
main()