admin/homeassistant-tuya-ipc-terminal-addon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: refactor to a home assistant addon repo

Browse Source
This commit is contained in:
kvanzuijlen 2025-06-29 23:34:15 +02:00
parent a69ce680c2
commit a4e653e468
No known key found for this signature in database
GPG Key ID: F6E2BB1491382385
10 changed files with 154 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
README.md
View File

@ -1,124 +1,35 @@
# Home Assistant Add-on: Tuya IPC Terminal # kvanzuijlen hassio addons repository
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Expose your Tuya-based security cameras as standard RTSP streams within your local network.
This addon builds on the awesome work of @seydx on [Tuya IPC Terminal](https://github.com/seydx/tuya-ipc-terminal)
and makes integration with Home Assistant a little bit easier.
## About
This addon integrates the tuya-ipc-terminal application into Home Assistant. It authenticates with your Tuya account,
discovers your compatible IP cameras, and creates a local RTSP stream for each one.
This allows you to use your Tuya cameras with any RTSP-compatible software, including Home Assistant's camera
integrations, VLC, Frigate, or other NVR systems, without relying on cloud-based P2P connections for viewing.
## Features
- **Local RTSP Streams**: Keeps video traffic on your local network for lower latency and improved privacy.
- **Simple Authentication**: Uses a one-time QR code login process with your Tuya/Smart Life mobile app.
- **Auto-Discovery**: Automatically discovers and refreshes your camera list on startup.
- **Wide Compatibility**: Works with any RTSP-compatible client or NVR software.
## Installation ## Installation
### Automatic [![Add repository on my Home Assistant][repository-badge]][repository-url]
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL If you want to do add the repository manually, please follow the procedure highlighted in the
pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg) [Home Assistant website](https://home-assistant.io/hassio/installing_third_party_addons). Use the following URL to add
](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fkvanzuijlen%2Fhomeassistant-tuya-ipc-terminal-addon) this repository: https://github.com/ankermgmt/ankermgmt-hassio-addons
1. Click on the button above (see the official [docs](https://my.home-assistant.io/) for more information) ## Add-on provided by this repository
2. Click Add - [tuya-ipc-terminal](tuya-ipc-terminal/): Expose your Tuya-based security cameras as standard RTSP streams within your local network.
3. Close the dialog and refresh the page. The "Tuya IPC Terminal" addon will now appear in the store.
4. Click on the "Tuya IPC Terminal" addon and then click Install.
### Manual ![Version](https://img.shields.io/badge/dynamic/yaml?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fkvanzuijlen%2Fhassio-addons%2Fmaster%2Ftuya-ipc-terminal%2Fconfig.yaml)
![aarch64][aarch64-badge]
![amd64][amd64-badge]
![armhf][armhf-badge]
![armv7][armv7-badge]
![i386][i386-badge]
1. Navigate to your Home Assistant instance. ## Support
2. Go to Settings > Add-ons > Add-on Store. Got questions?
3. Click the 3-dots menu in the top-right corner and select Repositories.
4. Add the URL of this repository and click Add.
5. Close the dialog and refresh the page. The "Tuya IPC Terminal" addon will now appear in the store.
6. Click on the "Tuya IPC Terminal" addon and then click Install.
## Configuration You have several options to get them answered:
### Step 1: Add-on Options - The Home Assistant [Community Forum][forum].
- This repository issues list
Before starting the addon, you must configure it with your Tuya account details. [aarch64-badge]: https://img.shields.io/badge/aarch64--green.svg?logo=arm
1. On the addon page, go to the Configuration tab. [amd64-badge]: https://img.shields.io/badge/amd64--green.svg?logo=amd
2. Set the following options: [armhf-badge]: https://img.shields.io/badge/armhf--green.svg?logo=arm
- **TUYA_EMAIL**: The email address associated with your Tuya Smart or Smart Life account. [armv7-badge]: https://img.shields.io/badge/armv7--green.svg?logo=arm
- **TUYA_REGION**: The cloud region your account is registered in. Common values are: [i386-badge]: https://img.shields.io/badge/i386--green.svg?logo=intel
- eu-central [forum]: https://community.home-assistant.io/
- eu-east [repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
- us-west [repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fkvanzuijlen%2Fhassio-addons
- us-east
- china
- india
- See [this list](https://github.com/seydx/tuya-ipc-terminal#-authentication-management)
3. Click Save.
### Step 2: First-Time Authentication (QR Code)
The addon uses a one-time QR code process to securely log into your account. This QR will be valid for 20 seconds,
after which the addon will need to be restarted.
1. Open the Tuya or Smart Life app on your smartphone.
2. Click Start to run the addon for the first time.
3. Go to the addon's Log tab on your desktop/laptop or another separate device.
4. The logs will refresh, and you will see a large QR code appear.
5. In the app, go to your profile tab and then find the Scan button (usually in the top-right corner).
6. Scan the QR code displayed in the addon logs.
7. Confirm the login on your phone.
8. The addon will automatically detect the successful login and proceed. On success, it creates a `.tuya-data` folder in
9. the `/addon_configs/966623c8_tuya_ipc_terminal` directory to store authentication tokens, so you only need to do this once.
### Step 3: Finding Your Camera Streams
Once authentication is complete, the addon will start the RTSP server and list the URLs for your cameras.
1. Look at the logs again. After the authentication messages, you will see entries for each camera, like this:
```log
22:53:35.138 INF Available endpoints:
22:53:35.139 INF rtsp://localhost:8554/Front_Door_Cam (Front Door Cam)
22:53:35.139 INF rtsp://localhost:8554/Backyard_Cam (Backyard Cam)
22:53:35.139 INF RTSP server is running. Press Ctrl+C to stop.
```
2. Copy the RTSP URL for the camera you wish to add to Home Assistant or another client.
## Usage in Home Assistant
The easiest way to add your camera to the Home Assistant dashboard is by using the Generic Camera integration.
1. Go to Settings > Devices & Services.
2. Click Add Integration and search for Generic Camera.
3. Fill out the configuration:
- Stream Source URL: Paste the RTSP URL you copied from the addon logs.
- Authentication: Select None, as authentication is not required for the local stream.
4. Click Submit, and your camera feed should now be available as an entity in Home Assistant.
Other ways to add your camera to Home Assistant are via integrations like Frigate or MotionEye.
## Re-authenticating
If your authentication token expires or you change your password, you may need to re-authenticate.
1. Stop the Tuya IPC Terminal addon.
2. Use the File editor, Samba, or Terminal addon to access your Home Assistant configuration files.
3. Navigate to the `/addon_configs/966623c8_tuya_ipc_terminal` directory.
4. Delete the entire `.tuya-data` folder.
5. Start the Tuya IPC Terminal addon again and follow the QR code authentication steps from above.
## Troubleshooting
- QR Code Expired: The authentication process has a 20 second timeout. Be ready to scan the QR code as soon as it
appears in the logs. If you miss it, simply restart the addon to generate a new one.
- No Cameras Found:
- Verify that your cameras are online and visible in your Tuya Smart/Smart Life app.
- Double-check that the `TUYA_EMAIL` and `TUYA_REGION` in the addon configuration are correct.
- RTSP Stream Not Working:
- Ensure the RTSP URL is correct.
- Verify that port `8554` is correctly mapped in the addon's Network configuration section.
- Check the addon logs for any error messages related to the RTSP server.
- See the [Tuya IPC Terminal docs](https://github.com/seydx/tuya-ipc-terminal#-complete-documentation)

3
repository.yaml Normal file
View File

@ -0,0 +1,3 @@
name: "HA Add-on: Tuya IPC Terminal"
url: "https://github.com/kvanzuijlen/homeassistant-tuya-ipc-terminal-addon"
maintainer: "kvanzuijlen"

0
Dockerfile → tuya-ipc-terminal/Dockerfile
View File

125
tuya-ipc-terminal/README.md Normal file
View File

@ -0,0 +1,125 @@
# Home Assistant Add-on: Tuya IPC Terminal
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Expose your Tuya-based security cameras as standard RTSP streams within your local network.
This addon builds on the awesome work of @seydx on [Tuya IPC Terminal](https://github.com/seydx/tuya-ipc-terminal)
and makes integration with Home Assistant a little bit easier.
## About
This addon integrates the tuya-ipc-terminal application into Home Assistant. It authenticates with your Tuya account,
discovers your compatible IP cameras, and creates a local RTSP stream for each one.
This allows you to use your Tuya cameras with any RTSP-compatible software, including Home Assistant's camera
integrations, VLC, Frigate, or other NVR systems, without relying on cloud-based P2P connections for viewing.
## Features
- **Local RTSP Streams**: Keeps video traffic on your local network for lower latency and improved privacy.
- **Simple Authentication**: Uses a one-time QR code login process with your Tuya/Smart Life mobile app.
- **Auto-Discovery**: Automatically discovers and refreshes your camera list on startup.
- **Wide Compatibility**: Works with any RTSP-compatible client or NVR software.
## Installation
### Automatic
[![Add repository on my Home Assistant][repository-badge]][repository-url]
1. Click on the button above (see the official [docs](https://my.home-assistant.io/) for more information)
2. Click Add
3. Close the dialog and refresh the page. The "Tuya IPC Terminal" addon will now appear in the store.
4. Click on the "Tuya IPC Terminal" addon and then click Install.
### Manual
1. Navigate to your Home Assistant instance.
2. Go to Settings > Add-ons > Add-on Store.
3. Click the 3-dots menu in the top-right corner and select Repositories.
4. Add the URL of this repository and click Add.
5. Close the dialog and refresh the page. The "Tuya IPC Terminal" addon will now appear in the store.
6. Click on the "Tuya IPC Terminal" addon and then click Install.
## Configuration
### Step 1: Add-on Options
Before starting the addon, you must configure it with your Tuya account details.
1. On the addon page, go to the Configuration tab.
2. Set the following options:
- **TUYA_EMAIL**: The email address associated with your Tuya Smart or Smart Life account.
- **TUYA_REGION**: The cloud region your account is registered in. Common values are:
- eu-central
- eu-east
- us-west
- us-east
- china
- india
- See [this list](https://github.com/seydx/tuya-ipc-terminal#-authentication-management)
3. Click Save.
### Step 2: First-Time Authentication (QR Code)
The addon uses a one-time QR code process to securely log into your account. This QR will be valid for 20 seconds,
after which the addon will need to be restarted.
1. Open the Tuya or Smart Life app on your smartphone.
2. Click Start to run the addon for the first time.
3. Go to the addon's Log tab on your desktop/laptop or another separate device.
4. The logs will refresh, and you will see a large QR code appear.
5. In the app, go to your profile tab and then find the Scan button (usually in the top-right corner).
6. Scan the QR code displayed in the addon logs.
7. Confirm the login on your phone.
8. The addon will automatically detect the successful login and proceed. On success, it creates a `.tuya-data` folder in
9. the `/addon_configs/f1032797_tuya_ipc_terminal` directory to store authentication tokens, so you only need to do this once.
### Step 3: Finding Your Camera Streams
Once authentication is complete, the addon will start the RTSP server and list the URLs for your cameras.
1. Look at the logs again. After the authentication messages, you will see entries for each camera, like this:
```log
22:53:35.138 INF Available endpoints:
22:53:35.139 INF rtsp://localhost:8554/Front_Door_Cam (Front Door Cam)
22:53:35.139 INF rtsp://localhost:8554/Backyard_Cam (Backyard Cam)
22:53:35.139 INF RTSP server is running. Press Ctrl+C to stop.
```
2. Copy the RTSP URL for the camera you wish to add to Home Assistant or another client.
## Usage in Home Assistant
The easiest way to add your camera to the Home Assistant dashboard is by using the Generic Camera integration.
1. Go to Settings > Devices & Services.
2. Click Add Integration and search for Generic Camera.
3. Fill out the configuration:
- Stream Source URL: Paste the RTSP URL you copied from the addon logs.
- Authentication: Select None, as authentication is not required for the local stream.
4. Click Submit, and your camera feed should now be available as an entity in Home Assistant.
Other ways to add your camera to Home Assistant are via integrations like Frigate or MotionEye.
## Re-authenticating
If your authentication token expires or you change your password, you may need to re-authenticate.
1. Stop the Tuya IPC Terminal addon.
2. Use the File editor, Samba, or Terminal addon to access your Home Assistant configuration files.
3. Navigate to the `/addon_configs/f1032797_tuya_ipc_terminal` directory.
4. Delete the entire `.tuya-data` folder.
5. Start the Tuya IPC Terminal addon again and follow the QR code authentication steps from above.
## Troubleshooting
- QR Code Expired: The authentication process has a 20 second timeout. Be ready to scan the QR code as soon as it
appears in the logs. If you miss it, simply restart the addon to generate a new one.
- No Cameras Found:
- Verify that your cameras are online and visible in your Tuya Smart/Smart Life app.
- Double-check that the `TUYA_EMAIL` and `TUYA_REGION` in the addon configuration are correct.
- RTSP Stream Not Working:
- Ensure the RTSP URL is correct.
- Verify that port `8554` is correctly mapped in the addon's Network configuration section.
- Check the addon logs for any error messages related to the RTSP server.
- See the [Tuya IPC Terminal docs](https://github.com/seydx/tuya-ipc-terminal#-complete-documentation)
[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fkvanzuijlen%2Fhomeassistant-tuya-ipc-terminal-addon

0
build.yaml → tuya-ipc-terminal/build.yaml
View File

0
config.yaml → tuya-ipc-terminal/config.yaml
View File

0
icon.png → tuya-ipc-terminal/icon.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.2 KiB

After

Width:  |  Height:  |  Size: 1.2 KiB

0
logo.png → tuya-ipc-terminal/logo.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.2 KiB

After

Width:  |  Height:  |  Size: 1.2 KiB

0
run.sh → tuya-ipc-terminal/run.sh
View File

0
tuya_auth_qr.exp → tuya-ipc-terminal/tuya_auth_qr.exp
View File