From c3d0dfbbe14f24adf88f26e8bedf599102577c99 Mon Sep 17 00:00:00 2001 From: Bander <46300268+xZetsubou@users.noreply.github.com> Date: Sat, 11 Nov 2023 05:10:10 +0300 Subject: [PATCH] adjust images paths --- .github/workflows/mdocs.yaml | 1 - docs/auto_configure.md | 6 +++--- docs/cloud_api.md | 2 +- docs/index.md | 2 +- docs/installation.md | 26 +++++++++++++------------- 5 files changed, 18 insertions(+), 19 deletions(-) diff --git a/.github/workflows/mdocs.yaml b/.github/workflows/mdocs.yaml index 766e5f85f..acf47b883 100644 --- a/.github/workflows/mdocs.yaml +++ b/.github/workflows/mdocs.yaml @@ -14,7 +14,6 @@ jobs: name: "Deploy documentation" runs-on: ubuntu-latest steps: - - name: "Checkout" uses: actions/checkout@v4 diff --git a/docs/auto_configure.md b/docs/auto_configure.md index cf6d7a864..9872a7bb1 100644 --- a/docs/auto_configure.md +++ b/docs/auto_configure.md @@ -4,7 +4,7 @@ Localtuya can disocver you device entities if cloud is enable because the featur By known the `category` we use that to get all the possible entities from stored data.
Data stored in `/localtuya/core/tuya_devices` (1) {.annotate} -1. Files named with entity type

![](/images/dev/tuya_devices_dir.png) +1. Files named with entity type

![](images/dev/tuya_devices_dir.png) ??? info "DPCodes data" All known `Codes` are stored in `base.py` in `DPCode Class`.
@@ -19,8 +19,8 @@ By known the `category` we use that to get all the possible entities from stored Inside downloaded `txt file`, in `cloud_data object` look for your `device -> dps_data` -1. ![](/images/dev/device_diagnostics.png) -2. ![](/images/dev/entry_diagnostics.png) +1. ![](images/dev/device_diagnostics.png) +2. ![](images/dev/entry_diagnostics.png) __Now that we know the device `category` and `Codes` we can start add the entities.__ diff --git a/docs/cloud_api.md b/docs/cloud_api.md index aac49c343..2fb85ba52 100644 --- a/docs/cloud_api.md +++ b/docs/cloud_api.md @@ -47,7 +47,7 @@ This is a separate account from the one you made for the app. You cannot log in Click the created project to enter the `Project Overview` page and get the `Authorization Key`. You will need these for setting up the integration. in the next step. -![](/images/tuya_iot_overview.png) +![](images/tuya_iot_overview.png) `Data center region`: Choose the country you picked when signing up. diff --git a/docs/index.md b/docs/index.md index f22d58590..f92095d5f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ LocalTuya is [HomeAssistant](https://www.home-assistant.io/) integration allows by clicking on `configure` (1) { .annotate } - 1. ![](/images/configure.png) + 1. ![](images/configure.png) !!! info "Cloud API" LocalTuya uses cloud only to get devices data and fill the required fields for you. diff --git a/docs/installation.md b/docs/installation.md index 4ce9d3c4f..e103e85b7 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -19,7 +19,7 @@ Assuming you add the repository and Installed Integration from [Overview](index. 2. When adding new hub config page will show up (1)
{ .annotate } - 1. ![](/images/init.png) + 1. ![](images/init.png) a. If you don't want to setup cloud api check `Disable Cloud API?` and skip to [ADD Devices](#add-new-device) @@ -34,8 +34,8 @@ After setting up the integration you can now manage your devices `ADD` and `EDIT By click on `Configure` (1) a menu will show up, Choose your (2) { .annotate } -1. ![](/images/configure.png) -2. ![](/images/options.png) +1. ![](images/configure.png) +2. ![](images/options.png) ### Add new device @@ -50,7 +50,7 @@ By click on `Configure` (1) a menu will show up, Choose your (2) Choose the device to configure and click on `submit`. {.annotate} - 1. If device is on configured `Tuya account` ID will be replaced with the name if not will remain with `xxx (ip)`

![](/images/opt_add_devices.png) + 1. If device is on configured `Tuya account` ID will be replaced with the name if not will remain with `xxx (ip)`

![](images/opt_add_devices.png) 2. `Configure device`: Fill the fields that still missing and is `required`
@@ -109,12 +109,12 @@ This option will pretty much works for everyone but it more advanced. Each `platform` has different configuretion fields.

{.annotate} - 1. ![](/images/opt_configure_entity.png) + 1. ![](images/opt_configure_entity.png) 2. Configre `Switch` (1). All the fields can be changed later except for `ID` {.annotate} - 1. ![](/images/opt_configure_switch_ex.png) + 1. ![](images/opt_configure_switch_ex.png) !!! tip annotate "`DP` fields (1)" DP fields will show all the `DP IDs` of the device and the value of that `DP` `[Code only shows if cloud setup]`
@@ -126,15 +126,15 @@ Each `platform` has different configuretion fields.

Sometimes Devices don't report the all `DPS`, However `localtuya` will pull them if cloud is setup.
it's only recommended to use this `DPs` for button platform --> - 1. ![](/images/dps_list_ex.png) - 2. `DP 1` Switch 1 is `OFF` `[1st gang]`
`DP 2` Switch 2 is `OFF` `[2nd gang]`
`DP 7` Switch 1 Timer is `0`
`DP 8` Switch 2 Timer is `0`

![](/images/dps_list_ex.png) + 1. ![](images/dps_list_ex.png) + 2. `DP 1` Switch 1 is `OFF` `[1st gang]`
`DP 2` Switch 2 is `OFF` `[2nd gang]`
`DP 7` Switch 1 Timer is `0`
`DP 8` Switch 2 Timer is `0`

![](images/dps_list_ex.png) Must of the fields are Optional but `ID` is always `Required` so from the example choosing Platform `Switch` and set `ID` to `1` to configure entity switch controls `1st Gang switch`

3. When submit first entity, `IF there is still more DP IDs not configured yet` it will ask you if you want to finish the process or add more entities (1) {.annotate} - 1. ![](/images/opt_configure_more.png) + 1. ![](images/opt_configure_more.png) !!! info "" I unchecked `Finish configuring entities` and repeated `step 2` to add another `switch` entity that controls `ID 2` <- `2nd Gang switch` @@ -150,7 +150,7 @@ Each `platform` has different configuretion fields.

!!! annotate note "" Templates will be loaded when HA starts so in order for template to show in the list restart is needed
However when you import a template you can manually type the name `my_template.yaml` (1)
- 1. ![](/images/templates.png) + 1. ![](images/templates.png) ###### Create templates There's 2 way to create templates @@ -204,13 +204,13 @@ There's 2 way to create templates Reconfigure existing device (1) works pretty much like `Add Device steps` but you can now modify old entities or add more
{.annotate} -1. ![](/images/opt_reconfigure_device.png) +1. ![](images/opt_reconfigure_device.png) #### Delete entities You can delete the entity by uncheck the entity you want to remove on `reconfigure device` (1) {.annotate} -1. ![](/images/opt_reconfigure_device_entity_check.png) +1. ![](images/opt_reconfigure_device_entity_check.png) ### Manage Cloud API account You can manage your configured Tuya CloudAPI account, or disable cloud @@ -220,4 +220,4 @@ You can manage your configured Tuya CloudAPI account, or disable cloud 2. On device info panel click on the :material-dots-vertical: and click on __delete__ ??? example "Example image" - ![](/images/delete_device.png) \ No newline at end of file + ![](images/delete_device.png) \ No newline at end of file