diff --git a/README.md b/README.md index c63a26a9..a730a94b 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,11 @@ This is a 3.5" USB-C display that shows as a serial port once connected. It cannot be seen by the operating system as a monitor but picture can be displayed on it. A Windows-only software is [available here](https://translate.google.com/translate?sl=auto&u=https://gitee.com/emperg/usblcd/raw/master/dev0/realse.ini) to manage this display. -This software allows creating themes to display your computer sensors on the display, but does not offer a simple way to display custom pictures. +This software allows creating themes to display your computer sensors on the screen, but does not offer a simple way to display custom pictures or text. This Python script has been created to do some simple operations on this display like : - **Display custom picture** +- **Display text** - Clear the screen (blank) - Turn the screen on/off - Display soft reset diff --git a/main.py b/main.py index d6e7a52a..a6418a88 100644 --- a/main.py +++ b/main.py @@ -1,78 +1,184 @@ +#!/usr/bin/env python3 +# A simple Python manager for "Turing Smart Screen" 3.5" IPS USB-C display +# https://github.com/mathoudebine/turing-smart-screen-python + +import os +import signal import struct +from datetime import datetime from time import sleep import serial # Install pyserial : pip install pyserial -from PIL import Image # Install PIL or Pillow +from PIL import Image, ImageDraw, ImageFont # Install PIL or Pillow # Set your COM port e.g. COM3 for Windows, /dev/ttyACM0 for Linux... -COM_PORT = "/dev/ttyACM1" +COM_PORT = "/dev/ttyACM0" # COM_PORT = "COM5" -def SendReg(ser, reg, x, y, ex, ey): +DISPLAY_WIDTH = 320 +DISPLAY_HEIGHT = 480 + + +class Command: + RESET = 101 + CLEAR = 102 + SCREEN_OFF = 108 + SCREEN_ON = 109 + SET_BRIGHTNESS = 110 + DISPLAY_BITMAP = 197 + + +def SendReg(ser, cmd, x, y, ex, ey): byteBuffer = bytearray(6) byteBuffer[0] = (x >> 2) byteBuffer[1] = (((x & 3) << 6) + (y >> 4)) byteBuffer[2] = (((y & 15) << 4) + (ex >> 6)) byteBuffer[3] = (((ex & 63) << 2) + (ey >> 8)) byteBuffer[4] = (ey & 255) - byteBuffer[5] = reg + byteBuffer[5] = cmd ser.write(bytes(byteBuffer)) def Reset(ser): - SendReg(ser, 101, 0, 0, 0, 0) + SendReg(ser, Command.RESET, 0, 0, 0, 0) def Clear(ser): - SendReg(ser, 102, 0, 0, 0, 0) + SendReg(ser, Command.CLEAR, 0, 0, 0, 0) def ScreenOff(ser): - SendReg(ser, 108, 0, 0, 0, 0) + SendReg(ser, Command.SCREEN_OFF, 0, 0, 0, 0) def ScreenOn(ser): - SendReg(ser, 109, 0, 0, 0, 0) + SendReg(ser, Command.SCREEN_ON, 0, 0, 0, 0) def SetBrightness(ser, level): - # Level : 0 (bright) - 255 (darkest) - SendReg(ser, 110, level, 0, 0, 0) + # Level : 0 (brightest) - 255 (darkest) + SendReg(ser, Command.SET_BRIGHTNESS, level, 0, 0, 0) -def PrintImage(ser, image): - im = Image.open(image) - image_height = im.size[1] - image_width = im.size[0] +def DisplayPILImage(ser, image, x, y): + image_height = image.size[1] + image_width = image.size[0] - SendReg(ser, 197, 0, 0, image_width - 1, image_height - 1) + SendReg(ser, Command.DISPLAY_BITMAP, x, y, x + image_width - 1, y + image_height - 1) - pix = im.load() + pix = image.load() + line = bytes() for h in range(image_height): - line = bytes() for w in range(image_width): - if w < image_width: - R = pix[w, h][0] >> 3 - G = pix[w, h][1] >> 2 - B = pix[w, h][2] >> 3 + R = pix[w, h][0] >> 3 + G = pix[w, h][1] >> 2 + B = pix[w, h][2] >> 3 - rgb = (R << 11) | (G << 5) | B - line += struct.pack('H', rgb) + rgb = (R << 11) | (G << 5) | B + line += struct.pack('H', rgb) + + # Send image data by multiple of DISPLAY_WIDTH bytes + if len(line) >= DISPLAY_WIDTH*4: + ser.write(line) + line = bytes() + + # Write last line if needed + if len(line) > 0: ser.write(line) sleep(0.01) # Wait 10 ms after picture display +def DisplayBitmap(ser, bitmap_path, x=0, y=0): + image = Image.open(bitmap_path) + DisplayPILImage(ser, image, x, y) + + +def DisplayText(ser, text, x=0, y=0, + font="roboto/Roboto-Regular.ttf", + font_size=20, + font_color=(0, 0, 0), + background_color=(255, 255, 255), + background_image=None): + # Convert text to bitmap using PIL and display it + # Provide the background image path to display text with transparent background + + if background_image is None: + # A text bitmap is created with max width/height by default : text with solid background + text_image = Image.new('RGB', (DISPLAY_WIDTH, DISPLAY_HEIGHT), background_color) + else: + # The text bitmap is created from provided background image : text with transparent background + text_image = Image.open(background_image) + + # Draw text with specified color & font + font = ImageFont.truetype("./res/fonts/" + font, font_size) + d = ImageDraw.Draw(text_image) + d.text((x, y), text, font=font, fill=font_color) + + # Crop text bitmap to keep only the text + text_width, text_height = d.textsize(text, font=font) + text_image = text_image.crop(box=(x, y, min(x + text_width, DISPLAY_WIDTH), min(y + text_height, DISPLAY_HEIGHT))) + + DisplayPILImage(ser, text_image, x, y) + + +stop = False + if __name__ == "__main__": - ser = serial.Serial(COM_PORT, 115200, timeout=1, rtscts=1) + + def sighandler(signum, frame): + global stop + stop = True + + # Set the signal handlers, to send a complete frame to the LCD before exit + signal.signal(signal.SIGINT, sighandler) + signal.signal(signal.SIGTERM, sighandler) + is_posix = os.name == 'posix' + if is_posix: + signal.signal(signal.SIGQUIT, sighandler) + + # Do not change COM port settings unless you know what you are doing + lcd_comm = serial.Serial(COM_PORT, 115200, timeout=1, rtscts=1) # Clear screen (blank) - Clear(ser) + Clear(lcd_comm) # Set brightness to max value - SetBrightness(ser, 0) + SetBrightness(lcd_comm, 0) # Display sample picture - PrintImage(ser, "res/example.png") - - ser.close() + DisplayBitmap(lcd_comm, "res/example.png") + + # Display sample text + DisplayText(lcd_comm, "Basic text", 50, 100) + + # Display custom text with solid background + DisplayText(lcd_comm, "Custom italic text", 5, 150, + font="roboto/Roboto-Italic.ttf", + font_size=30, + font_color=(0, 0, 255), + background_color=(255, 255, 0)) + + # Display custom text with transparent background + DisplayText(lcd_comm, "Transparent bold text", 5, 300, + font="roboto/Roboto-Bold.ttf", + font_size=30, + font_color=(255, 255, 255), + background_image="res/example.png") + + # Display text that overflows + DisplayText(lcd_comm, "Text overflow!", 5, 430, + font="roboto/Roboto-Bold.ttf", + font_size=60, + font_color=(255, 255, 255), + background_image="res/example.png") + + # Display the current time as fast as possible + while not stop: + DisplayText(lcd_comm, str(datetime.now().time()), 160, 2, + font="roboto/Roboto-Bold.ttf", + font_size=20, + font_color=(255, 0, 0), + background_image="res/example.png") + + lcd_comm.close() diff --git a/res/fonts/roboto/LICENSE.txt b/res/fonts/roboto/LICENSE.txt new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/res/fonts/roboto/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/res/fonts/roboto/Roboto-Black.ttf b/res/fonts/roboto/Roboto-Black.ttf new file mode 100644 index 00000000..43a00e0d Binary files /dev/null and b/res/fonts/roboto/Roboto-Black.ttf differ diff --git a/res/fonts/roboto/Roboto-BlackItalic.ttf b/res/fonts/roboto/Roboto-BlackItalic.ttf new file mode 100644 index 00000000..5082cdc4 Binary files /dev/null and b/res/fonts/roboto/Roboto-BlackItalic.ttf differ diff --git a/res/fonts/roboto/Roboto-Bold.ttf b/res/fonts/roboto/Roboto-Bold.ttf new file mode 100644 index 00000000..37424579 Binary files /dev/null and b/res/fonts/roboto/Roboto-Bold.ttf differ diff --git a/res/fonts/roboto/Roboto-BoldItalic.ttf b/res/fonts/roboto/Roboto-BoldItalic.ttf new file mode 100644 index 00000000..e85e7fb9 Binary files /dev/null and b/res/fonts/roboto/Roboto-BoldItalic.ttf differ diff --git a/res/fonts/roboto/Roboto-Italic.ttf b/res/fonts/roboto/Roboto-Italic.ttf new file mode 100644 index 00000000..c9df607a Binary files /dev/null and b/res/fonts/roboto/Roboto-Italic.ttf differ diff --git a/res/fonts/roboto/Roboto-Light.ttf b/res/fonts/roboto/Roboto-Light.ttf new file mode 100644 index 00000000..0e977514 Binary files /dev/null and b/res/fonts/roboto/Roboto-Light.ttf differ diff --git a/res/fonts/roboto/Roboto-LightItalic.ttf b/res/fonts/roboto/Roboto-LightItalic.ttf new file mode 100644 index 00000000..3ad14fa7 Binary files /dev/null and b/res/fonts/roboto/Roboto-LightItalic.ttf differ diff --git a/res/fonts/roboto/Roboto-Medium.ttf b/res/fonts/roboto/Roboto-Medium.ttf new file mode 100644 index 00000000..e89b0b79 Binary files /dev/null and b/res/fonts/roboto/Roboto-Medium.ttf differ diff --git a/res/fonts/roboto/Roboto-MediumItalic.ttf b/res/fonts/roboto/Roboto-MediumItalic.ttf new file mode 100644 index 00000000..a5a41d3d Binary files /dev/null and b/res/fonts/roboto/Roboto-MediumItalic.ttf differ diff --git a/res/fonts/roboto/Roboto-Regular.ttf b/res/fonts/roboto/Roboto-Regular.ttf new file mode 100644 index 00000000..3d6861b4 Binary files /dev/null and b/res/fonts/roboto/Roboto-Regular.ttf differ diff --git a/res/fonts/roboto/Roboto-Thin.ttf b/res/fonts/roboto/Roboto-Thin.ttf new file mode 100644 index 00000000..7d084aed Binary files /dev/null and b/res/fonts/roboto/Roboto-Thin.ttf differ diff --git a/res/fonts/roboto/Roboto-ThinItalic.ttf b/res/fonts/roboto/Roboto-ThinItalic.ttf new file mode 100644 index 00000000..c1733896 Binary files /dev/null and b/res/fonts/roboto/Roboto-ThinItalic.ttf differ