From b0f3a111aca0bc3521b27d2a1bdab166691a40e7 Mon Sep 17 00:00:00 2001 From: Bander <46300268+xZetsubou@users.noreply.github.com> Date: Tue, 28 Nov 2023 00:41:58 +0300 Subject: [PATCH] update docs --- documentation/docs/cloud_api.md | 14 +++++++------- documentation/docs/configure_add_device.md | 4 ++-- documentation/docs/installation.md | 4 ++-- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/documentation/docs/cloud_api.md b/documentation/docs/cloud_api.md index ddf056701..0fa769b6e 100644 --- a/documentation/docs/cloud_api.md +++ b/documentation/docs/cloud_api.md @@ -3,7 +3,7 @@ The Tuya integration integrates all Powered by Tuya devices you have added to the Tuya Smart and Tuya Smart Life apps. !!! note - LocalTuya utilizes the cloud to gather your device's data, making the configuration of devices much simpler. + LocalTuya uses the cloud to obtain your device's data, making the configuration of devices much simpler. ## Configuration of the Tuya IoT Platform @@ -67,27 +67,27 @@ Click the created project to enter the `Project Overview` page and get the `Auth -??? info "1004: sign invalid" +??? failure "1004: sign invalid" Incorrect Access ID or Access Secret. Please refer to the **Configuration** part above. -??? info "1106: permission deny" +??? failure "1106: permission deny" - 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/docs/iot/Platform_Configuration_smarthome?id=Kamcgamwoevrx#title-3-Link%20devices%20by%20app%20account){target="_blank"}. - Incorrect username or password: Enter the correct account and password of the Tuya Smart or Smart Life app in the **Account** and **Password** fields (social login, which the Tuya Smart app allows, may not work, and thus should be avoided for use with the Home Assistant integration). 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 country. You must select the region of your account of the Tuya Smart app or Smart Life app. -??? info "1100: param is empty" +??? failure "1100: param is empty" Empty parameter of username or app. Please fill the parameters refer to the **Configuration** part above. -??? info "2406: skill id invalid" +??? failure "2406: skill id invalid" - Make sure you use the **Tuya Smart** or **SmartLife** app account to log in. Also, choose the right data center endpoint related to your country region. For more details, please check [Country Regions and Data Center](https://github.com/tuya/tuya-home-assistant/blob/main/docs/regions_dataCenters.md). - Your cloud project on the [Tuya IoT Development Platform](https://iot.tuya.com) should be created after May 25, 2021. Otherwise, you need to create a new project. - This error can often be resolved by unlinking the app from the project (`Devices` tab > `Link Tuya App Account` > `Unlink`) and [relinking it again](#link-devices-by-app-account). -??? info "28841105: No permissions. This project is not authorized to call this API" +??? failure "28841105: No permissions. This project is not authorized to call this API" Some APIs are not authorized, please [Subscribe](https://developer.tuya.com/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-2-Subscribe%20to%20APIs){target="_blank"} then [Authorize](https://developer.tuya.com/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-3-Grant%20a%20project%20access%20to%20API%20calls){target="_blank"}. The following APIs must be subscribed for this tutorial: - Device Status Notification @@ -104,7 +104,7 @@ Click the created project to enter the `Project Overview` page and get the `Auth - IoT Data Analytics -??? info "28841002: No permissions. Your subscription to cloud development plan has expired" +??? failure "28841002: No permissions. Your subscription to cloud development plan has expired" Your subscription to Tuya cloud development **IoT Core Service** resources has expired, please [extend it](https://iot.tuya.com/cloud/products/detail?abilityId=1442730014117204014){target="_blank"} in `Cloud` > `Cloud Services` > `IoT Core` > `My Subscriptions` tab > `Subscribed Resources` > `IoT Core` > `Extend Trial Period`. ## Document source diff --git a/documentation/docs/configure_add_device.md b/documentation/docs/configure_add_device.md index 701757b4d..01dbe8653 100644 --- a/documentation/docs/configure_add_device.md +++ b/documentation/docs/configure_add_device.md @@ -11,7 +11,7 @@ !!! danger "Important" Before adding any device, ensure that `Smart Life` and `Tuya Smart` apps are closed on your phones. Devices shouldn't be added to different local integrations as __some__ Tuya devices can only accept one local connection at a time. -After setting up the integration, you can now manage your devices by `adding` or `editing`
+After setting up the integration, you can now manage your devices by `adding` or `editing` them.
Go to hub `Configure` (1) a menu will show up (2) Choose `Add new device` { .annotate } @@ -20,7 +20,7 @@ Go to hub `Configure` (1) a menu will show up (2) Choose `Add new device` !!! Note "Discovery" - By default, `LocalTuya` includes a discovery feature that scans for Tuya devices within the local network, listing them in the config flow. However, this function requires the Home Assistant machine to be connected to the same network as the Tuya devices and might not function across different subnets, + By default, `LocalTuya` includes a discovery feature that scans for Tuya devices within the local network and lists them in the config flow. However, this function requires Home Assistant to be connected to the same network as the Tuya devices and to have the same subnets. 1. Selecting `Add new device` will display a new page with the listed discovered devices (1)
Select the device you wish to configure, then click on `Submit`. {.annotate} diff --git a/documentation/docs/installation.md b/documentation/docs/installation.md index c5d314730..45b00620e 100644 --- a/documentation/docs/installation.md +++ b/documentation/docs/installation.md @@ -17,7 +17,7 @@ If you haven't added the repository to `HACS`. a. Go to the [integration page](https://my.home-assistant.io/redirect/integrations/){target=_blank} in HA and click on `ADD INTEGRATION` in the bottom right corner. - b. [MY: Add Integration](https://my.home-assistant.io/redirect/config_flow_start/?domain=localtuya){target=_blank} + b. Or use [MY: Add Integration](https://my.home-assistant.io/redirect/config_flow_start/?domain=localtuya){target=_blank}

2. Adding a new hub will introduce you to this configuration page (1)
@@ -27,6 +27,6 @@ If you haven't added the repository to `HACS`. a. If you prefer not to set up the cloud API, check `Disable Cloud API?` - b. If you've set up a 'cloud' account, you should have all the necessary information + b. If you've set up a `cloud` account, you should have all the necessary information
[Get authentication data](cloud_api.md/#get-authorization-data).