U2HTS

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 16 Open GitHub ↗

USB to HID touchscreen based on Raspberry Pi RP2 MCUs

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# U2HTS
USB HID multitouch touchscreen based on Raspberry Pi RP2 MCUs.  
`U2HTS` stands for **U**SB **2** **H**ID **T**ouch**S**creen.  
**Note**: This project is still under heavy developments. Pull requests and issues are welcome.  
[zh_CN(简体中文)](./README_zh.md)

# Features
- Support multitouch up to 255 tps
- Support I2C & SPI buses
- Support detect touch controller
- Support change touchscreen orientation
- Support read touch controller configuration
- Support switch config in runtime via key
- Support indicates system status by LED patterns
- Support persistent config

# Touch controllers
See [U2HTS touch controllers](https://github.com/U2HTS/u2hts_touch_controllers/blob/main/README.md)

# Configs
| Config | Invert X axis | Invert Y axis | Swap X Y axes |
| --- | --- | --- | --- |
| 1 | N | N | N |
| 2 | Y | N | Y |
| 3 | Y | Y | N |
| 4 | N | Y | Y |

# LED pattern decode
If the LED blinks in a looping pattern and the host does not recognize the device, that means a error.   
| Blink count | Error |
| --- | --- |
| 1 | No slave detected on I2C bus |
| 2 | No compatible controller found |
| 3 | Required parameters not configured |
| 4 | Failed to initialise controller |
| 5 | Controller config invalid |
  
When in configuration mode, the LED stays on. Pressing the button once will make the LED blink `n` times, indicating that it has switched to configuration number `n`.

# Key
*Enter config mode*: long press (>1 sec)  
*Rotate config*: short click

After a idle time (~5s) system will apply new config (and save to flash if `U2HTS_ENABLE_PERSISTENT_CONFIG` enabled).

# Config
| Config | Name | Value |
| --- | --- | --- |
| Controller name | `controller` | refer `Touch controllers` section |
| Bus type | `bus_type` | refer [u2hts_core.h](https://github.com/U2HTS/u2hts_core/blob/main/u2hts_core.h), default `UB_I2C` |
| Invert X axis | `x_invert` | 0/1 |
| Invert Y axis | `y_invert` | 0/1 |
| Swap X&Y axis | `x_y_swap` | 0/1 |
| X coordinate offset | `x_offset` | -32768-32767 |
| Y coordinate offset | `y_offset` | -32768-32767 |
| Polling mode | `polling_mode` | 0/1 |
| Report delay | `report_delay` | uint32_t, default 0 |
| Interrupt trigger type | `irq_type` | refer [u2hts_core.h](https://github.com/U2HTS/u2hts_core/blob/main/u2hts_core.h) |
| Custom Controller Configuration | `custom_controller_config` | string, max length is 512 by default |
 
These values must be configured when using an controller that does NOT support read config:
| Config | Name | Value |
| --- | --- | --- |
| Max touch points | `max_tps` | up to 10 |
| X axis max | `x_max` | 65535 |
| Y axis max | `y_max` | 65535 |

Drivers will set the default values of bus configuration, but you can also override them(**Note: Once override enabled then all config entrys in corrsponding bus config must be configured**):
| Config | Name | Value |
| --- | --- | --- |
| Override I2C config | `override_i2c_config` | 0/1 |
| I2C slave address | `i2c_addr` | 7-bit device address |
| I2C Speed | `i2c_speed` | uint32_t |
| Override SPI config | `override_spi_config` | 0/1 |
| SPI Speed | `spi_speed` | uint32_t |
| SPI CPHA | `spi_cpha` | 0/1 |
| SPI CPOL | `spi_cpol` | 0/1 |

# Custom Controller Configuration
If a controller requires additional parameters for configuration, the configuration can be written as key-value pairs into [custom_controller_config](https://github.com/U2HTS/u2hts_core/blob/main/u2hts_core.h), and then retrieved within the controller driver.  
The configuration format is `xxx.yyy=zzz`, with multiple configuration items separated by spaces, such as `aaa.bbb=ccc foo.bar=yum`.  
The maximum length of `custom_controller_config` and the maximum key length are defined in [u2hts_core.h](https://github.com/U2HTS/u2hts_core/blob/main/u2hts_core.h#L38).  
See [dummy_test.c](https://github.com/U2HTS/u2hts_touch_controllers/blob/main/dummy_test.c) for examples.

# Ports
| MCU | Key | Persistent config | LED | 
| --- | --- | --- | --- |
| RP2040/RP2350 | Y | Y | Y |
| [STM32F070F6](https://github.com/U2HTS/U2HTS_F070F6) | Y | Y | Y |
| CH32X033F8 | Y | Y | Y |
| [CH32V003J4M6](https://github.com/U2HTS/U2HTS_V003J4) | N | N | N |

# RP2 Circuit
`u2hts_rp2.h`: 
```c
#ifndef PICO_DEFAULT_I2C_SDA_PIN
#define U2HTS_I2C_SDA 4
#else
#define U2HTS_I2C_SDA PICO_DEFAULT_I2C_SDA_PIN
#endif

#ifndef PICO_DEFAULT_I2C_SCL_PIN
#define U2HTS_I2C_SCL 5
#else
#define U2HTS_I2C_SCL PICO_DEFAULT_I2C_SCL_PIN
#endif

#ifndef U2HTS_TP_INT
#define U2HTS_TP_INT 2
#endif

#ifndef U2HTS_TP_RST
#define U2HTS_TP_RST 3
#endif

#ifndef U2HTS_USR_KEY
#define U2HTS_USR_KEY 6
#endif
```
No external pull-up/pull-down resistors are required.

# RP2 Config
Touchscreen config can be easily changed using `picotool` without rebuild of firmware on RP2 platforms.
Example：
```bash
picotool config -s x_invert 1 build/U2HTS.uf2
picotool load -f build/U2HTS.uf2
```

# RP2 Build
## VSCode Extension
Install `VS code` and `Raspberry Pi Pico` extension, import this repository, then build.
## GitHub action
Fork this repository to your account.  
Click `Actions` page, click `enable workflow`.  
Click `Build firmware` on the left，click `Run workflow`.  
Wait until build complete and grab the artifacts.  
## Manual
```bash
sudo apt install gcc-arm-none-eabi libnewlib-dev libnewlib-arm-none-eabi ninja-build cmake
git clone https://github.com/U2HTS/U2HTS.git --recursive --depth 1
cd U2HTS
PICO_SDK_FETCH_FROM_GIT=1 PICO_SDK_FETCH_FROM_GIT_TAG=2.3.0 cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=MinSizeRel
cmake --build build
```
# RP2 FreeRTOS
*Note：RP2 FreeRTOS support is experimental.*
```bash
PICO_SDK_FETCH_FROM_GIT=1 PICO_SDK_FETCH_FROM_GIT_TAG=2.3.0 cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=MinSizeRel -DU2HTS_ENABLE_FREERTOS=ON
cmake --build build
```

U2HTS

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README