dominic/Tactility
1
0
Fork 0
mirror of https://github.com/ByteWelder/Tactility.git synced 2026-02-18 02:43:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Tactility/README.md
Ken Van Hoeylandt ed2d0cc78a
Move FreeRTOSConfig.h to app-sim (#17) 
* Move FreeRTOSConfig.h to app-sim

* improved docs

* updated ideas.md and removed finished todos
2024-01-22 00:27:17 +01:00

3.3 KiB
Raw Blame History

Overview

Tactility is a front-end application platform for ESP32. It is mainly intended for touchscreen devices. It provides an application framework that is based on code from the Flipper Zero project.

Status: Alpha

Tactility shown on a Lilygo T-Deck device and on PC

Tactility features:

  • A hardware abstraction layer
  • UI capabilities (via LVGL)
  • An application platform that can run apps and services
  • PC app support to speed up development for ESP32 apps

Requirements:

  • ESP32 (any?) with a display (connected via SPI or I2C)
  • esp-idf 5.1.2 or a newer v5.1.x

Technologies

UI is created with lvgl via esp_lvgl_port.

LCD and input drivers are based on esp_lcd and esp_lcd_touch.

Supported Hardware

Devices

Predefined configurations are available for:

  • Yellow Board: 2.4" with capacitive touch (2432S024C) (see AliExpress 1, 2)
  • LilyGo T-Deck (see lilygo.cc, AliExpress)
  • (more will follow)

Other configurations can be supported, but they require you to set up the drivers yourself:

Guide

Build environment setup

Ensure you have esp-idf 5.1.2 installed, then select the correct device:

Copy the sdkconfig.board.YOUR_BOARD into sdkconfig. Use sdkconfig.defaults if you are setting up a custom board.

Building firmware

You can run idf.py flash monitor, but there are some helpers available too:

./build.sh - build the ESP-IDF or the PC version of Tactility (*) ./build.sh -p /dev/ttyACM0 - optional: you can pass on extra parameters for esp-idf builds ./run.sh - Does flash and monitor for ESP-IDF and simply builds and starts it for PC

The build scripts will detect if ESP-IDF is available. They will adapter if you ran ${IDF_PATH}/export.sh.

Development

Directories explained:

  • app-esp: The ESP32 application example
  • app-sim: The PC/simulator application example
  • boards: Contains ESP modules with drivers
  • tactility: The main application platform code (src/)
  • tactility-esp: ESP-specific application code (e.g. wifi app and service)
  • tactility-core: Core functionality regarding threads, stdlib, etc. (src/)
  • libs: Contains a mix of regular libraries and ESP modules

Until there is proper documentation, here are some pointers:

License

GNU General Public License Version 3