oneil1987/TX-Ultimate-Easy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor changes as suggested by CodeRabbitAI

Browse Source
This commit is contained in:
Edward Firmo
2024-12-27 10:20:24 +01:00
parent 0779279d44
commit ebd8a5432a
1 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -128,8 +128,12 @@ Follow these steps to get your TX Ultimate device up and running with ESPHome.
You can also use a specific version tag for better control over updates: You can also use a specific version tag for better control over updates:
```yaml ```yaml
ref: v[![version]][version] # Using specific version for controlled updates ref: v2024.12.2 # Using specific version for controlled updates
``` ```
> [!NOTE]
> [Click here](https://github.com/edwardtfn/TX-Ultimate-Easy/tags) for a full list of versions available
5. Click "Save" and then "Install" 5. Click "Save" and then "Install"
### 3. Device Flashing ### 3. Device Flashing
@@ -171,9 +175,9 @@ We recommend using [ESPHome Web](https://web.esphome.io) for the simplest experi
- TX → RX - TX → RX
- RX → TX - RX → TX
4. Put device in flash mode: 4. Put device in flash mode:
- Connect the BOOT pin to GND using a jumper wire - Temporarily connect the BOOT pin to GND using a jumper wire
- Power up the device (keeping BOOT connected to GND) - While holding BOOT to GND, power up the device
- Remove the BOOT to GND connection - After device powers up (wait a couple of seconds), remove the BOOT to GND connection
5. Visit [ESPHome Web](https://web.esphome.io) 5. Visit [ESPHome Web](https://web.esphome.io)
6. Connect to your device and flash the firmware 6. Connect to your device and flash the firmware
7. After successful flash, device will restart and be ready for OTA updates 7. After successful flash, device will restart and be ready for OTA updates
@@ -196,8 +200,9 @@ through the ESPHome dashboard in your ESPHome add-on.
After successful flashing: After successful flashing:
1. Ensure your device and Home Assistant are on the same network 1. Ensure your device and Home Assistant are on the same network
2. Device should be automatically discovered within a couple of minutes 2. Device should be automatically discovered within 1-2 minutes
3. Accept the discovery notification to add device 3. Accept the discovery notification in Home Assistant to add device
Note: If discovery takes longer than 5 minutes, proceed to troubleshooting steps
4. Device will appear in your Home Assistant Devices dashboard 4. Device will appear in your Home Assistant Devices dashboard
#### Troubleshooting Integration #### Troubleshooting Integration
@@ -230,6 +235,9 @@ If the device isn't discovered automatically:
- Haptic feedback - Haptic feedback
- Audio feedback - Audio feedback
> [!NOTE]
> Some changes may require a device restart
## Usage ## Usage
After installation, you can: After installation, you can:
@@ -285,10 +293,11 @@ Note: For proper tracking and resolution:
This project builds upon the work of several amazing projects and contributors: This project builds upon the work of several amazing projects and contributors:
<!-- markdownlint-disable MD013 -->
- [SmartHome yourself - SONOFF TX Ultimate for ESPHome](https://github.com/SmartHome-yourself/sonoff-tx-ultimate-for-esphome) - [SmartHome yourself - SONOFF TX Ultimate for ESPHome](https://github.com/SmartHome-yourself/sonoff-tx-ultimate-for-esphome)
- [Un loco y su tecnología - Sonoff TX Ultimate with ESPHome](https://www.youtube.com/watch?v=58v8oqSQgXQ) - [Un loco y su tecnología - Sonoff TX Ultimate with ESPHome](https://www.youtube.com/watch?v=58v8oqSQgXQ)
- [@PxPert](https://github.com/PxPert) - - [@PxPert](https://github.com/PxPert) - [Sonoff TX Ultimate and Voice Assistant](https://community.home-assistant.io/t/sonoff-tx-ultimate-and-voice-assistant/682214?u=edwardtfn)
[Sonoff TX Ultimate and Voice Assistant](https://community.home-assistant.io/t/sonoff-tx-ultimate-and-voice-assistant/682214?u=edwardtfn) <!-- markdownlint-enable MD013 -->
Special thanks to all contributors and community members who help make this project better. Special thanks to all contributors and community members who help make this project better.