README.md

TX Ultimate Easy

	TX Ultimate Easy provides custom ESPHome firmware for Sonoff TX Ultimate devices. Our project focuses on user-friendly configuration through the Home Assistant UI, eliminating the need for manual YAML editing. Whether you're new to home automation or an experienced user, TX Ultimate Easy makes it simple to manage your device.

Integration with Home Assistant

TX Ultimate Easy exposes your device's components (sensors, touch panel, relays, etc.) to Home Assistant, allowing you to:

• Monitor sensor states and values
• Control device components through the Home Assistant UI
• Use device triggers and states in your Home Assistant automations and scripts
• Configure device behavior through Home Assistant's service calls

All automation capabilities are handled through Home Assistant's native automation system - this project focuses on providing reliable device integration rather than implementing its own automation tools.

Key Features

• Home Assistant UI Configuration: Manage all device settings directly through the Home Assistant interface
• Zero YAML Knowledge Required: After initial setup, no manual YAML editing needed
• Flexible Light Control: Customize LED behavior and effects
• Touch Panel Support: Full support for touch gestures and multi-touch capabilities
• Advanced Automations: Create complex automations using Home Assistant's powerful automation engine
• BLE Proxy Support: Optional Bluetooth Low Energy proxy functionality
• Audio Feedback: Built-in speaker support for audible feedback
• Haptic Feedback: Vibration motor support for tactile feedback

Hardware Support

• Compatible with all Sonoff TX Ultimate variants:
  • EU format (Square, T5-xC-86)
  • US format (Rectangle, T5-xC-120)
  • 1/2/3/4 gang versions

Prerequisites

Before getting started, ensure you have:

1. A Sonoff TX Ultimate device
2. Home Assistant installation
3. ESPHome add-on installed in Home Assistant
4. Basic knowledge of Home Assistant

Installation

Detailed installation instructions coming soon. The process will include:

1. Initial ESPHome setup
2. Device flashing
3. Home Assistant integration
4. Basic configuration

Usage

After installation, you can:

1. Configure your device through Home Assistant UI
2. Customize touch behaviors
3. Set up LED patterns and effects
4. Create automations
5. Enable optional features like BLE proxy

Configuration Options

TX Ultimate Easy offers extensive configuration options:

• Touch panel sensitivity and gestures
• LED colors, patterns, and behaviors
• Relay modes and functions
• Audio and haptic feedback settings
• Network and connectivity options

Contributing

We welcome contributions from the community! Here's how you can help:

1. Fork the repository
2. Create a feature branch from dev
3. Make your changes
4. Submit a pull request targeting the dev branch

Please ensure your code follows our standards:

• Passes all lint checks (YAML, C++, Markdown)
• Includes appropriate documentation
• Follows existing code style

All pull requests should be made against the dev branch. We don't accept pull requests directly to main as it's reserved for stable releases.

Support and Community

Need help? Here are your options:

• Bug Reports & Feature Requests: Use GitHub Issues for all bug reports and feature requests
• Community Chat: Join our Discord Server for discussions and community interaction
• Support the Project: Consider supporting through Buy Me a Coffee

Note: For proper tracking and resolution, all bug reports and feature requests must be submitted through GitHub Issues, not Discord. The Issues page can be found at: Issues · edwardtfn/TX-Ultimate-Easy

Acknowledgments

This project builds upon the work of several amazing projects and contributors:

• SmartHome yourself - SONOFF TX Ultimate for ESPHome
• Un loco y su tecnología - Sonoff TX Ultimate with ESPHome

Special thanks to all contributors and community members who help make this project better.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---