Browse Source

README: Restore "Finding your Device ID and Local Key" section

Other links within and outside this file point to this anchor point,
so it needs to be maintained.

Make the specific methods of finding the details into subsections of the
original header.

Issue #1100
Jason Rumney 2 years ago
parent
commit
1f4008fb2c
1 changed files with 13 additions and 11 deletions
  1. 13 11
      README.md

+ 13 - 11
README.md

@@ -308,7 +308,9 @@ mode they are in, but are set to readonly so that you cannot accidentally
 switch the thermostat to the wrong mode from HA.
 
 
-## Finding your device ID and local key at the Tuya Developer Portal
+## Finding your device ID and local key
+
+### Tuya IoT developer portal
 
 The easiest way to find your local key is with the Tuya Developer portal.
 If you have previously configured the built in Tuya cloud integration, or
@@ -336,16 +338,7 @@ command line Tuya client like tuyaapi/cli or
 to scan your network for Tuya devices to find the IP address and also automate
 the above process of connecting to the portal and getting the local key.
 
-## Connecting to devices via hubs
-
-If your device connects via a hub (eg. battery powered water timers) you have to provide the following info when adding a new device:
-
-- Device id (uuid): this is the **hub's** device id
-- IP address or hostname: the **hub's** IP address or hostname
-- Local key: the **hub's** local key
-- Sub device id: the **actual device you want to control's** `node_id`. Note this `node_id` differs from the device id, you can find it with tinytuya as described below.
-
-## Finding device ids and local keys with tinytuya
+### Finding device ids and local keys with tinytuya
 
 You can use this component's underlying library [tinytuya](https://github.com/jasonacox/tinytuya) to scan for devices in your network and find the required information about them. In particular, you need to use this procedure to obtain the `node_id` value required to connect to hub-dependent devices.
 
@@ -380,6 +373,15 @@ In the `devices.json` file you will everything you need to add your device:
 - "node_id": the sub-device id. You need this for hub-dependent devices
 - "mapping": in the unfortunate case your device is not [yet supported](DEVICES.md), this key contains a description of all the datapoints reported by the device, type and expected values. You are more than welcome to create a new device specification following [the guidelines](custom_components/tuya_local/devices/README.md) and submitting a PR.
 
+## Connecting to devices via hubs
+
+If your device connects via a hub (eg. battery powered water timers) you have to provide the following info when adding a new device:
+
+- Device id (uuid): this is the **hub's** device id
+- IP address or hostname: the **hub's** IP address or hostname
+- Local key: the **hub's** local key
+- Sub device id: the **actual device you want to control's** `node_id`. Note this `node_id` differs from the device id, you can find it with tinytuya as described below.
+
 ## Next steps
 
 1. This component is mostly unit-tested thanks to the upstream project, but there are a few more to complete. Feel free to use existing specs as inspiration and the Sonar Cloud analysis to see where the gaps are.