-
Notifications
You must be signed in to change notification settings - Fork 11
Installation
π€ 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).
-
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.π₯ -
Run the command
wget https://github.com/raw/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 π. -
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
. -
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.
-
If you want/need set your own tty2oled configuration Options. Check the "INI File" Section below.
-
Run the Updater from time to time to check for new pictures, script & tty2oled firmware updates.
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 toTTYDEV="/dev/ttyUSBx"
if your Microcontroller uses a CP210x or CH34x USB-Serial Chip <= default
Set toTTYDEV="/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 toyes
for the USB Version (Pictures are downloaded automatically to the MiSTer) <= default
Set tono
for all other Versions (SD/Standard, Pictures have to be organized by yourself) -
Option
OVERWRITE_PICTURE="yes/no"
(renamed from "OVERWRITE")
Set toyes
and old pictures will be overwritten with new ones <= default
Set tono
and old pictures will not be overwritten -
Option
USE_TEXT_PICTURE="yes/no"
(INI v1.1)
Set toyes
for downloading Text-Based Pictures
Set tono
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 toyes
for downloading US Pictures
Set tono
for skipping the download of US Pictures <= default -
Option
ROTATE="yes/no"
(INI v1.4)
Set toyes
for Display Rotation by 180 degress
Set tono
for no Rotation <= default -
Option
SCRIPT_UPDATE="yes/no"
(INI v1.4)
Set toyes
if you want to enable updates of the tty2oled scripts done by the "Updater" <= default
Set tono
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 toyes
if you want to use the Grayscale Version of the Pictures <= default
Set tono
for no Greyscale Pictures usage -
Option
USE_RANDOM_ALT="yes/no"
(INI v1.8)
Set toyes
and there're xxx_alt* pictures, they'll be diced <= default
Set tono
for no xxx_alt* Picture Support -
Option
TTY2OLED_UPDATE="yes/no"
(INI v1.9)
Set toyes
if you want to enable updates of the tty2oled firmware done by the "Updater" <= default
Set tono
for no firmware updates
This option let's you stay at your actual firmware version. -
Option
SCREENSAVER="yes/no"
(INI v2.0)
Set toyes
if you want to enable the tty2oled ScreenSaver.
Set tono
for no ScreenSaver functionality <= default
The Core-Logo is shown for the Time of the ValueSCREENSAVER_START
and then
the ScreenSaver Logo is jumping around with the Interval ofSCREENSAVER_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
-
OPTIONAL Option
TTY2OLED_FW_TESTING="yes/no"
You need to add this Option manually to your/media/fat/tty2oled/tty2oled-user.ini
File!
Set toTTY2OLED_FW_TESTING="yes"
if you want to enable the Testing Firmware for your tty2oled device.
Set toTTY2OLED_FW_TESTING="no"
or remove the complete line for stable firmware.
β Be aware, the testing firmware can be unstable! β
Report Problems in the Forum's Add-On Thread.
πΎ πΎ
ποΈ >>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