Skip to content

Commit

Permalink
update example project readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vberthiaume committed Jan 16, 2025
1 parent 12b67f1 commit f6859f4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions exampleProjects/touch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

This project is part of the Puara Framework and showcases the integration of `puara-gestures` with a touchscreen in a [Wokwi](https://wokwi.com/) simulation to detect and display touch interactions.

## Project Overview

This example project has 3 main components:
- A Wokwi `diagram.json` containing a simple circuit simulation consisting of a ILI9341 touch screen and a TinyPico ESP32 development board.
- A simple `main.cpp` which mainly initiates and update a `TinyTouch` object.
- A `TinyTouch` class, which is closely tied to the Wokwi `diagram.json`, and displays rectangles on a screen to simulate a touch array. As the screen is touched, `TinyTouch` updates its `TouchArrayGestureDetector` class member (which is part of the `puara-gesture` namespace), which calculates brush and rub gestures. The resulting total `brush` and `rub` values are printed to the terminal.

## Running the Project Using Wokwi in Visual Studio Code

1. Install [Visual Studio Code](https://code.visualstudio.com/), as well as the [PlatformIO](https://platformio.org/install/ide?install=vscode) and [Wokwi](https://docs.wokwi.com/vscode/getting-started) VS Code extensions. As part of the process you'll need to create a free [Wokwi](https://wokwi.com/) online account.
Expand Down

0 comments on commit f6859f4

Please sign in to comment.