4
0
Эх сурвалжийг харах

add link to device config README

Added link to device configuation README and cleaned up the layout
blakadder 2 жил өмнө
parent
commit
78dc46cd6c
1 өөрчлөгдсөн 7 нэмэгдсэн , 14 устгасан
  1. 7 14
      README.md

+ 7 - 14
README.md

@@ -35,30 +35,23 @@ easier to set up using that as an alternative.
 
 ## Device support
 
-Note that devices sometimes get firmware upgrades, or incompatible
-versions are sold under the same model name, so it is possible that
-the device will not work despite being listed. 
+Note that devices sometimes get firmware upgrades, or incompatible versions are sold under the same model name, so it is possible that the device will not work despite being listed. 
 
-Battery powered devices such as door and window sensors, smoke alarms
-etc which do not use a hub will be impossible to support locally, due
-to the power management that they need to do to get acceptable battery
-life.  Currently hubs are also unsupported, but this is being worked
-on.
+Battery powered devices such as door and window sensors, smoke alarms etc which do not use a hub will be impossible to support locally, due to the power management that they need to do to get acceptable battery
+life.  Currently hubs are also unsupported, but this is being worked on.
 
 A list of currently supported devices can be found in the [DEVICES.md](https://github.com/make-all/tuya-local/blob/main/DEVICES.md) file.
 
-If your device is not listed, you can find the information required to add a
-configuration for it in the following locations:
+Documentation on building a device configuration file is in [/custom_components/tuya_local/devices/README.md](https://github.com/make-all/tuya-local/blob/main/custom_components/tuya_local/devices/README.md) 
 
-1. When attempting to add the device, if it is not supported, you will either get a message saying the device cannot be recognised at all, or you will be offered a list of devices (maybe a list of length 1) that are partial matches, often simple switch is among them.  You can cancel the process at this point, and look in the Home Assistant log - there should be a message there containing the current data points (dps) returned by the device.
-
-2. If you have signed up for iot.tuya.com to get your local key, you should also have access to the API Explorer under "Cloud".  Under "Device Control" there is a function called "Query Things Data Model", which returns the dp_id in addition to range information that is needed for integer and enum data types.
+If your device is not listed, you can find the information required to add a configuration for it in the following locations:
 
+1. When attempting to add the device, if it is not supported, you will either get a message saying the device cannot be recognised at all, or you will be offered a list of devices (maybe a list of length 1) that are partial matches, often simple switch is among them.  You can cancel the process at this point, and look in the Home Assistant log - there should be a message there containing the current data points (dps) returned by the device.
+2. If you have signed up for [iot.tuya.com](https://iot.tuya.com/) to get your local key, you should also have access to the API Explorer under "Cloud". Under "Device Control" there is a function called "Query Things Data Model", which returns the dp_id in addition to range information that is needed for integer and enum data types.
 3. By following the method described at the link below, you can find information for all the data points supported by your device, including those not listed by the API explorer method above and those that are only returned under specific conditions. Ignore the requirement for a Tuya Zigbee gateway, that is for Zigbee devices, and this integration does not currently support devices connected via a gateway, but the non-Zigbee/gateway specific parts of the procedure apply also to WiFi devices.
 
 https://www.zigbee2mqtt.io/advanced/support-new-devices/03_find_tuya_data_points.html
 
-
 If you file an issue to request support for a new device, please include the following information:
 
 1. Identification of the device, such as model and brand name.