diff --git a/source/_integrations/tuya.markdown b/source/_integrations/tuya.markdown index 4bde7b5cbeb..2af5f30bee1 100644 --- a/source/_integrations/tuya.markdown +++ b/source/_integrations/tuya.markdown @@ -3,7 +3,6 @@ title: Tuya description: Instructions on how to setup the Tuya hub within Home Assistant. ha_category: - Climate - - Cover - Fan - Light - Scene @@ -26,103 +25,112 @@ ha_platforms: The Tuya integration allows integrating all Powered by Tuya devices you have added to the Tuya Smart and Tuya Smart Life apps. This integration is officially maintained by Tuya. -{% include integrations/config_flow.md %} - ## Supported platforms + - **Climate**: Air conditioner, heater, thermostat. -- **Cover**: Curtain, curtain switch. - **Fan**: Fan, air purifier, humidifier, dehumidifier. - **Light**: Light, light strip, ambient light, light string, humidifier's light, Ceiling light. - **Scene**: Smart scene. - **Switch**: Switch, socket, power strip, smart kettle, breaker, pet water feeder, air purifier, diffuser. -## Quick installation and startup +## Configure the Tuya IoT Platform -### Configure on the Tuya IoT Platform +### Prerequisites -#### Prerequisites +- You have created an account for [Tuya Smart or Smart Life app](https://developer.tuya.com/en/docs/iot/tuya-smart-app-smart-life-app-advantages?id=K989rqa49rluq#title-1-Download). +- You have created a [Tuya IoT Platform account](https://iot.tuya.com/) -You have created an account for [Tuya Smart or Smart Life app](https://developer.tuya.com/en/docs/iot/tuya-smart-app-smart-life-app-advantages?id=K989rqa49rluq#title-1-Download). +### Create a project -#### Create a project +1. Log in to the [Tuya IoT Platform](https://iot.tuya.com/). +1. In the left navigation bar, click **Cloud** > **Projects**. +1. On the page that appears, click **Create**. +1. In the **Create Project** dialog box, configure **Project Name**, **Description**, **Industry**, and **Availability Zone**. In the **Development Method** field, select **Smart Home PaaS** from the dropdown list. Select all available zones. + ![](/images/integrations/tuya/image_001.png) +1. Click **Create** to continue project configuration. +1. In **Configuration Wizard**, select **Device status notification** API. (**Note:** **Smart Home PaaS** API has been selected as default.) + ![](/images/integrations/tuya/image_002.png) +1. Click **Authorize**. -**1.** Log in to the [Tuya IoT Platform](https://iot.tuya.com/). - -**2.** In the left navigation bar, click **Cloud** > **Projects**. - -**3.** On the page that appears, click **Create**. - -**4.** In the **Create Project** dialog box, configure **Project Name**, **Description**, **Industry**, and **Availability Zone**. In the **Development Method** field, select **Smart Home PaaS** from the dropdown list. Select all available zones. - -![](/images/integrations/tuya/image_001.png) - -**5.** Click **Create** to continue project configuration. - -**6.** In **Configuration Wizard**, select **Device status notification** API. - > **Note:** **Smart Home PaaS** API has been selected as default. - -![](/images/integrations/tuya/image_002.png) - -**7.** Click **Authorize**. - -#### Get authorization key +### Get authorization key Click the created project to enter the **Project Overview** page and get the **Authorization Key** used to make API calls. ![](/images/integrations/tuya/image_003.png) -#### Link devices by app account +### Link devices by app account Link devices by your app account and copy the **Device ID** in the **Device List** to the clipboard for specifying `device_id` later. -**1.** Navigate to the **Devices** tab. +1. Navigate to the **Devices** tab. +1. Click **Link Tuya App Account** > **Add App Account**. + ![](/images/integrations/tuya/image_004.png) +1. Scan the QR code that appears using the **Tuya Smart** app or **Smart Life** app. + ![](/images/integrations/tuya/image_005.png) +1. Click **Confirm** on your **Tuya Smart** or **Smart Life** app. +1. Navigate to the **Device List** tab. You can find the devices that have been added through your **Tuya Smart** or **Smart Life** account. + ![](/images/integrations/tuya/image_006.png) -**2.** Click **Link Tuya App Account** > **Add App Account**. -![](/images/integrations/tuya/image_004.png) - -**3.** Scan the QR code that appears using the **Tuya Smart** app or **Smart Life** app. -![](/images/integrations/tuya/image_005.png) - -**4.** Click **Confirm** on your **Tuya Smart** or **Smart Life** app. - -**5.** Navigate to the **Device List** tab. You can find the devices that have been added through your **Tuya Smart** or **Smart Life** account. -![](/images/integrations/tuya/image_006.png) - -### Install the Tuya Home Assistant integration - -#### Install the Tuya integration - -In **Configuration** > **Integrations** > **ADD INTEGRATION**, search for the keyword **Tuya** and select it for installation. -![](/images/integrations/tuya/image_007.png) - -#### Enter your Tuya credential - -In the Tuya Integration window, select **Smart Home PaaS** and click **SUBMIT**. +{% include integrations/config_flow.md %} ![](/images/integrations/tuya/image_008.png) -See the following table and enter your Tuya credential. +{% configuration_basic %} + Region: + description: Choose the Tuya IoT region to use. -| Field | Description | -| ------- | -------- | -| Access ID and Access Secret| Go to your cloud project on [Tuya IoT Platform](https://iot.tuya.com/). Find the **Access ID** and **Access Secret** on the **Project Overview** tab.| -| Mobile App | Must select the one you used to link devices on the Tuya IoT Platform. | -| Country Code | The country you select on logging in to Tuya Smart or Smart Life app.| -| Account | Tuya Smart or Smart Life app account. | -| Password | The password of your app account. | + "Tuya IoT Access ID": + description: Go to your cloud project on [Tuya IoT Platform](https://iot.tuya.com/). Find the **Access ID** under [Authorization Key](#get-authorization-key) on the **Project Overview** tab. -

The app mentioned in the table must be the one you used to link devices on the Tuya IoT Platform.

+ "Tuya IoT Access Secret": + description: Go to your cloud project on [Tuya IoT Platform](https://iot.tuya.com/). Find the **Access Secret** under [Authorization Key](#get-authorization-key) on the **Project Overview** tab. + + Account: + description: Tuya Smart or Smart Life app account. + + Password: + description: The password of your app account. + +{% endconfiguration_basic %} ## Error codes and troubleshooting -|Error Code|Error Message|Troubleshooting| -|:----|:--------|:------------------------------| -|1004| sign invalid| Incorrect Access ID or Access Secret. Please refer to [Tuya credential table](https://github.com/tuya/tuya-home-assistant/wiki/Install-Tuya-v2?_source=d10de34623e3daca5b02e3c31528a0c4#3-enter-your-tuya-credential). -|1106|permission deny|| -|1100|param is empty| Empty parameter of username or app. Fill the parameters refer to [Tuya credential table](https://github.com/tuya/tuya-home-assistant/wiki/Install-Tuya-v2?_source=d10de34623e3daca5b02e3c31528a0c4#3-enter-your-tuya-credential). -|2017|schema does not exist| Incorrect app selected. Select the app you used to link devices in the cloud project.| -| 2406 | skill id invalid | Make sure that your cloud project on the [Tuya IoT Platform](https://iot.tuya.com/cloud/) should be created after May 25, 2021. Otherwise, you need to create a new project or migrate data to a new project. For more information, see [Operation on the Tuya IoT Platform](https://developer.tuya.com/en/docs/iot/migrate-from-an-older-version?id=Kamee9wtbd00b#title-3-Operation%20on%20the%20Tuya%20IoT%20Platform).| -| 28841105 |No permissions. This project is not authorized to call this API| Some APIs are not authorized, please [Subscribe](https://developer.tuya.com/en/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-2-Subscribe%20to%20cloud%20products) then [Authorize](https://developer.tuya.com/en/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-3-Authorize%20projects%20to%20call%20the%20cloud%20product). The following APIs must be subscribed for this tutorial: | +{% configuration_basic %} + +"1004:sign invalid": + description: Incorrect Access ID or Access Secret. Please refer to [Tuya credential table](https://github.com/tuya/tuya-home-assistant/wiki/Install-Tuya-v2?_source=d10de34623e3daca5b02e3c31528a0c4#3-enter-your-tuya-credential). + +"1106:permission deny": + description: >- + - App account not linked with cloud project: On the [Tuya IoT Platform](https://iot.tuya.com/cloud/), you have linked devices by using Tuya Smart or Smart Life app in your cloud project. For more information, see [Link devices by app account](https://developer.tuya.com/en/docs/iot/Platform_Configuration_smarthome?id=Kamcgamwoevrx&_source=7a356dd493196a01bb9021b7680a2a45#title-3-Link%20devices%20by%20app%20account). + + - Incorrect username or password: Enter the correct account and password of the Tuya Smart or Smart Life app in the **Account** and **Password** fields. Note that the app account depends on which app (Tuya Smart or Smart Life) you used to link devices on the [Tuya IoT Platform](https://iot.tuya.com/cloud/). + + - Incorrect availability zone: See [Availability Zone](https://github.com/tuya/tuya-home-assistant/wiki/Tuya-IoT-Platform-Configuration-Guide-Using-Smart-Home-PaaS#region--available-zone-correspondence) and select the correct availability zone. + +"1100:param is empty": + description: Empty parameter of username or app. Fill the parameters refer to [Tuya credential table](https://github.com/tuya/tuya-home-assistant/wiki/Install-Tuya-v2?_source=d10de34623e3daca5b02e3c31528a0c4#3-enter-your-tuya-credential). + +"2406:skill id invalid": + description: Make sure that your cloud project on the [Tuya IoT Platform](https://iot.tuya.com/cloud/) should be created after May 25, 2021. Otherwise, you need to create a new project or migrate data to a new project. For more information, see [Operation on the Tuya IoT Platform](https://developer.tuya.com/en/docs/iot/migrate-from-an-older-version?id=Kamee9wtbd00b#title-3-Operation%20on%20the%20Tuya%20IoT%20Platform). + +"28841105:No permissions. This project is not authorized to call this API": + description: > + Some APIs are not authorized, please [Subscribe](https://developer.tuya.com/en/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-2-Subscribe%20to%20cloud%20products) then [Authorize](https://developer.tuya.com/en/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-3-Authorize%20projects%20to%20call%20the%20cloud%20product). The following APIs must be subscribed for this tutorial: + + - Authorization + + - Smart Home Devices Management + + - Smart Home Family Management + + - Smart Home Scene Linkage + + - Smart Home Data Service + + - Device status notification + +{% endconfiguration_basic %} ## Related Documents diff --git a/source/images/integrations/tuya/image_008.png b/source/images/integrations/tuya/image_008.png index 322c82c7869..c44814dddaa 100644 Binary files a/source/images/integrations/tuya/image_008.png and b/source/images/integrations/tuya/image_008.png differ