Skip to content

1. Manual Installation

Jump to bottom
Dustin Watts edited this page Apr 21, 2022 · 1 revision

Steps for installing FreeTouchDeck

  1. Maybe a bit obvious but just in case: Install the Arduino IDE and install the Arduino-ESP32 core (you can find it here: https://github.com/espressif/arduino-esp32) FreeTouchDeck has been tested with Arduino-ESP32 core version 1.0.4 and 1.0.5 RC1.

  2. Install the following libraries:

Since version 0.9.11 the next step is no longer necessary! You can still edit this if you want but if you do not edit the config before uploading, if you start the configurator and it can't connect to an Access Point it will start one. You can then enter the configurator and edit you wifi settings in there.

  1. Open /data/config/wificonfig.json and set your WiFi credentials. You will also need to specify if you want FreeTouchDeck to connect to your WiFi network (WIFI_STA) or if you want to start in Access Point (WIFI_AP) mode. When specifying the mode, it is important that you use capital letters! You can change the network configuration through the a serial connection which is describe here: WiFi-and-Internet

Wifi Settings
Save and close wificonfig.json.

  1. Open the FreeTouchDeck.ino sketch. If you are using a capacitive touch version of the ILI9488, this line: Using Capacitive Touch
    If you are going to use Deep Sleep you need to uncomment the line where is says " Uncomment the define below if you want to use SLEEP...". If you are using a piezo buzzer for some audio feedback, you need to uncomment the line where is says "Uncomment the define below if you want to use a piezo buzzer...":
    FreeTouchDeck Set Screen Size If needed, change the width and height to match that of your screen:
    FreeTouchDeck Set Screen Size

  2. Before compiling and uploading the FreeTouchDeck.ino sketch, you will have to edit the user_setup.h file included with the TFT_eSPI library. This can be found in your Arduino skechtbook folder under "libraries". If you have not renamed the TFT_eSPI library folder, the file user_setup.h can be found in TFT_eSPI-master. Here you will have to uncomment the lines that apply to your hardware configuration.

Because the TFT_eSPI default User_Setup.h may change with different versions I recommend to copy and paste the contents (overwrite everything) of the example setup from this library. You can find it in the user_setup.h Examplesfolder

But if you want to do it manually, you will have to config the User_setup.h for your needs. For example: if you have a TFT with an ILI9488 driver, you will have to uncomment that line under Section 1. Make sure all the other drivers are commented out! Define Driver

The next section is Section 2. This also depends on what hardware you are using. For example, for an ESP32 you'll have to uncomment the correct #define(s) under EDIT THE PIN NUMBERS IN THE LINES FOLLOWING TO SUIT YOUR ESP32 SETUP. Define ESP
PAY ATTENTION! Even if resistive touch is not used, the TOUCH_CS in TFT_eSPI pin has to be defined! It can be a random unused pin.

Also, if your TFT has the blacklight control pin available you will have to uncomment the lines found under #define TFT_BL and #define TFT_BACKLIGHT_ON.
Define BackLight

"Section 3" can be left alone.

  1. This is a large sketch, so we need to make room for it. The default partitioning scheme is not big enough. Under "Tools / Partion Scheme" there are, depending on your board, a few options. Select the option that says something like "NO OTA (2MB APP/2MB SPIFFS)" The important bit here is that there is enough room for the firmware as well as for all the files in the data folder. Select Large APP

  2. Upload the contents of the "data" folder to the ESP32 SPIFFS using "ESP Sketch Data Upload" tool that can be found here: https://github.com/me-no-dev/arduino-esp32fs-plugin ESP Sketch Data

  3. Upload the sketch.

After that, you can now customize the FreeTouchDeck. In the main menu the bottom right icon ("settings") takes you to the settings page. Then the top left ("Wifi") puts FreeTouchDeck in to configuration mode. Now you can go to http://freetouchdeck.local and change the button functions to your liking. Here you will also find some general configuration settings like colours that are being used and the logos for the home screen.

How to use the Configurator ->

Need help?

You can join my Discord server where I have a dedicated #freetouchdeck channel. https://discord.gg/RE3XevS

Welcome

Install using the Web Installer (Recommended!)

Manual Installation

First Boot

How to use the configurator

Creating a logo

Modify a Stream Deck image

BLE and WiFi

WiFi and Internet

Clone this wiki locally