https://github.com/blakadder/tx-ultimate
Berry driver for Sonoff TX Ultimate switch
https://github.com/blakadder/tx-ultimate
Last synced: 6 months ago
JSON representation
Berry driver for Sonoff TX Ultimate switch
- Host: GitHub
- URL: https://github.com/blakadder/tx-ultimate
- Owner: blakadder
- License: mit
- Created: 2023-06-01T21:46:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T23:59:05.000Z (over 1 year ago)
- Last Synced: 2025-02-08T03:16:15.187Z (8 months ago)
- Language: Berry
- Size: 20.5 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Tasmota Berry driver for Sonoff TX Ultimate
[](https://ko-fi.com/S6S650JEK) 
Basic Berry driver for Sonoff TX Ultimate touch panel IC CA51F353S3.
TX Ultimate is a touch switch with RGB LEDs, haptic motor and I2S audio speaker. It is available from [Sonoff's store](https://itead.cc/product/sonoff-tx-ultimate-smart-touch-wall-switch/ref/34) in 1, 2 and 3 gang versions.
See [Tasmota templates](https://templates.blakadder.com/sonoff_T5-1C-86.html) for configuration and other features like I2S audio, LEDs, haptic feedback and Matter support.
## Functions
Quick and dirty skeleton driver. All touch events are reported to a RESULT topic. There's a beginning of a command interface which will be expanded to have calibration of the touch channels.
Touch panel is divided into 10 vertical segments or channels.
It has the following events:
- touch event with position - triggers on each touch
- short press
- long press
- multi touch - touching multiple channels at once
- swipe left and right - has starting and ending coordinate
- dash - shorter than swipe, usually moving from one channel to the adjacent one
Shown in console and in MQTT as:
```
tele/tasmota/RESULT = {"TXUltimate":{"Action":"Touch","Channel":3}}
tele/tasmota/RESULT = {"TXUltimate":{"Action":"Multi"}}
tele/tasmota/RESULT = {"TXUltimate":{"Action":"Short","Channel":4}}
tele/tasmota/RESULT = {"TXUltimate":{"Action":"Long","Channel":4}}
tele/tasmota/RESULT = {"TXUltimate":{"Action":"Swipe left","From":0,"To":252}}
```
## Serial Protocol
| Field | Length (Byte) | Explanation
| --- | --- | ---
| Frame Header | 2 | 0xaa55
| Version | 1 | 0x01 |
| Opcode | 1 | Specific command type |
| Data Length | 1 | Data Length 0-64
| Data | N | |
| Checksum | 2 | CRC16 | CRC-16/CCITT-FALSE checksum starting from the version byte
Explanation:
All Data larger than one byte are transmitted in big-endian mode.
In general, a command-response synchronization mechanism is used, where the sender expects to receive a response packet corresponding to the sent command. If the sender does not receive a correct response packet within the specified timeout, it will trigger a timeout transmission.
## Thanks to
Would not be possible without the help of [smarthomeyourself.de](https://smarthomeyourself.de/) and his [esphome custom component](https://github.com/SmartHome-yourself/sonoff-tx-ultimate-for-esphome/)