Skip to content

Installation

Jump to bottom
venice1200 edited this page Dec 7, 2023 · 157 revisions

💥 MiSTer Install & Update Script for the USB-Version 💥

🤘 ojaksch created The Updater for installation and updating tty2oled scripts, firmware and pictures 🤘
ℹ️ With the new INI File (see below) you can use the Updater for all Versions (USB, SD/Standard).

Installation

  1. Setup your ESP
    See Arduino IDE Settings & Electrical for more details.
    If you are new to Arduino check the Arduino HowTo for Windows as well.
    See Testing for an "HowTo" test your Display from the Arduino IDE.
    💥The Updater released at the 2021-11-26 is able to upload the firmware onto your tty2oled device.💥

  2. Run the command
    wget https://raw.githubusercontent.com/venice1200/MiSTer_tty2oled/main/update_tty2oled.sh -O /media/fat/Scripts/update_tty2oled.sh
    from the MiSTer's command line (F9) or from an SSH Session to download the tty2oled Updater to the MiSTer's Script Folder.
    🙂 "update_all" includes the Option (Menu/Misc) to download the Updater as well 🙂.

  3. After the Updater Script is downloaded, start it from the MiSTer's Script Menu, the MiSTer's command line (F9) or an SSH Session running the command /media/fat/Scripts/update_tty2oled.sh.

  4. The Updater asks an few questions which you can answer using a keyboard or a gamepad. All needed files and pictures are downloaded to the right places and the correct permissions are set.

  5. If you want/need set your own tty2oled configuration Options. Check the "INI File" Section below.

  6. Run the Updater from time to time to check for new pictures, script & tty2oled firmware updates.

INI File

The Updater Script uses the INI File /media/fat/tty2oled/tty2oled-system.ini.
The INI File is downloaded by the Updater/Installer Script automatically if you start it for the first time.
The INI File contains variables and options.

If you want/need to override the default values (see below Options) in /media/fat/tty2oled/tty2oled-system.ini,
add and set your preferred options and values into the file /media/fat/tty2oled/tty2oled-user.ini.
If you like to enable an Option which is disabled by default add OPTIONX="yes" to your tty2oled-user.ini file.
If you like to disable an Option which is enabled by default add OPTIONX="no" to your tty2oled-user.ini file.

System/User INI File Options:

  • Option TTYDEV="/dev/ttyXXX
    This is the communication Interface used by the MiSTer.
    Set to TTYDEV="/dev/ttyUSBx" if your Microcontroller uses a CP210x or CH34x USB-Serial Chip <= default
    Set to TTYDEV="/dev/ttyACMx" if your Microcontroller uses a CH9102 USB-Serial Chip
    See also https://github.com/venice1200/MiSTer_tty2oled/wiki/Troubleshooting#serial-port

  • Option USBMODE="yes/no"
    Set to yes for the USB Version (Pictures are downloaded automatically to the MiSTer) <= default
    Set to no for all other Versions (SD/Standard, Pictures have to be organized by yourself)

  • Option OVERWRITE_PICTURE="yes/no" (renamed from "OVERWRITE")
    Set to yes and old pictures will be overwritten with new ones <= default
    Set to no and old pictures will not be overwritten

  • Option USE_TEXT_PICTURE="yes/no" (INI v1.1)
    Set to yes for downloading Text-Based Pictures
    Set to no for skipping the download of Text-Based Pictures <= default

  • Option CONTRAST="0..255" (INI v1.2)
    Set your Display's Contrast.
    Value from "0..255" for USB and SD Version <= default: 100

  • Option USE_US_PICTURE="yes/no" (INI v1.3)
    Set to yes for downloading US Pictures
    Set to no for skipping the download of US Pictures <= default

  • Option ROTATE="yes/no" (INI v1.4)
    Set to yes for Display Rotation by 180 degress
    Set to no for no Rotation <= default

  • Option SCRIPT_UPDATE="yes/no" (INI v1.4)
    Set to yes if you want to enable updates of the tty2oled scripts done by the "Updater" <= default
    Set to no for no script updates
    This option let's you stay at your actual script version.
    An script update may need your ESP to be updated as well.

  • Option USE_GSC_PICTURE="yes/no" (INI v1.8)
    Set to yes if you want to use the Grayscale Version of the Pictures <= default
    Set to no for no Greyscale Pictures usage

  • Option USE_RANDOM_ALT="yes/no" (INI v1.8)
    Set to yes and there're xxx_alt* pictures, they'll be diced <= default
    Set to no for no xxx_alt* Picture Support

  • Option TTY2OLED_UPDATE="yes/no" (INI v1.9)
    Set to yes if you want to enable updates of the tty2oled firmware done by the "Updater" <= default
    Set to no for no firmware updates
    This option let's you stay at your actual firmware version.

  • Option SCREENSAVER="yes/no" (INI v2.0)
    Set to yes if you want to enable the tty2oled ScreenSaver.
    Set to no for no ScreenSaver functionality <= default
    The Core-Logo is shown for the Time of the Value SCREENSAVER_START and then
    the ScreenSaver Logo is jumping around with the Interval of SCREENSAVER_IVAL.

  • DEPRECATED Option SCREENSAVER_LEVEL="1..15" (INI v2.0)
    Set the ScreenSaver Color-Level. Value from 1 to 15 <= default:1

  • Option SCREENSAVER_IVAL="5..600" (INI v2.0)
    Set the ScreenSaver Jumping-Interval.
    Value from 5 to 600 (in Seconds) <= default:10

  • Option SCREENSAVER_START="10..600" (INI v2.0)
    Set the ScreenSaver Start-Time. Value from 10 to 600 (in Seconds) <= default:60

  • Option SCREENSAVER_SCREEN_TTY2OLED="yes/no" (INI v2.4)
    Enable/Disable the Screensaver "Screen" which shows the tty2oled Logo <= default:yes

  • Option SCREENSAVER_SCREEN_MISTER="yes/no" (INI v2.4)
    Enable/Disable the Screensaver "Screen" which shows the MiSTer Logo <= default:yes

  • Option SCREENSAVER_SCREEN_CORE="yes/no" (INI v2.4)
    Enable/Disable the Screensaver "Screen" which shows the Core Logo <= default:yes

  • Option SCREENSAVER_SCREEN_TIME="yes/no" (INI v2.4)
    Enable/Disable the Screensaver "Screen" which shows the Time <= default:yes

  • Option SCREENSAVER_SCREEN_DATE="yes/no" (INI v2.4)
    Enable/Disable the Screensaver "Screen" which shows the Date <= default:yes

  • Option SCREENSAVER_SCREEN_STARS="yes/no" (INI 2.5)
    Enable/Disable the Animated Screensaver "Stars" <= default:no

  • Option SCREENSAVER_SCREEN_TOAST="yes/no" (INI 2.6 & Testing FW)
    Enable/Disable the Animated Screensaver "Toaster" <= default:no

  • Option Transition="-1/0/1..23" (INI v2.3)
    Set the Picture-Transition Effect.
    "-1" (default) = Random Effect, "0" = no Effect, "1.." = the chosen Effect.
    Available Effects: https://github.com/venice1200/MiSTer_tty2oled/wiki/Command_v2#transition-effect-list

  • Option SLEEPMODEDELAY="0..999" (INI 2.7)
    Delay in [s] after the Sleepmodefile is deleted and the next picture is shown " <= default:2

Testing/Optional

  • OPTIONAL Option TTY2OLED_FW_TESTING="yes/no"
    You need to add this Option manually to your /media/fat/tty2oled/tty2oled-user.ini File!
    Set to TTY2OLED_FW_TESTING="yes" if you want to enable the Testing Firmware for your tty2oled device.
    Set to TTY2OLED_FW_TESTING="no" or remove the complete line for stable firmware.
    ❗ Be aware, the testing firmware can be unstable! ❗

Report Problems

Report Problems in the Forum's Add-On Thread.

License: GPL v3 XBMs

👾 tty2oled logo 👾

🏚️ >>Start here<<
💥 MiSTer Installation & Update 💥
⌚ History (Updates & Notes)
🔧 Realizing / How does it work
🔌 Electrical / PCB's / Tested Hardware
✏️ Arduino HowTo for Windows
📝 Arduino IDE Settings
📡 OTA (Wireless) Arduino Update
💬 CMD Mode (Greyscale/Adafruit GFX)
💬 Old CMD Mode (Monochrome/U8G2)
🖼️ Build Greyscale Pictures (GSC)
🔨 Testing / Troubleshooting
📂 Files and Folders in this Repository
🖼️ Gallery
📯 Cardware
🔗 Credits and Links

📜 Picture to Core Translation List

Clone this wiki locally