Merge branch 'main' of https://github.com/make-all/tuya-local

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,69 @@
+name: Bug report
+description: Report a bug with the integration or an existing device
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This form is for reporting bugs with the integration or existing devices. Bug reports should be detailed with log messages or device diagnostics to help developers determine what is going wrong.
+
+        If you have a question, or are unsure if what you observe is really a bug, consider using [Discussions](https://github.com/make-all/tuya-local/discussions) instead.
+
+        If you are reporting an unsupported device, please use the **New Device** reporting template instead, which will guide you on the information required to make sure your request is not put into the "too hard" pile.
+
+        If you are intending to create a pull request, an issue is not required, but please clearly describe the reason for your PR in the description of the PR.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        A clear and concise description of the bug you are experiencing.
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      description: |
+        List any steps you need to take to reproduce this problem.
+      placeholder: 1. Perform the ___ action...
+    validations:
+      required: false
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: |
+        A clear and concise description of what you expected.
+      placeholder: The device should...
+    validations:
+      required: false
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: |
+        Please add additional context such as logs or device diagnostics here to help the developers understand what exactly is happening under the covers.
+        Logs can be viewed under `Settings / System / Logs`
+        Diagnostics can be downloaded from `Settings / Devices & Services / 1 device` under the relevant device.
+
+        If applicable, you can also add screenshots to explain your problem.
+    validations:
+      required: false
+  - type: checkboxes
+    id: confirm
+    attributes:
+      label: Confirmation
+      description: |
+        Please select if the following are applicable
+      options:
+        - label: I am sure this is a bug, or improvement that is well enough described that it can be implemented
+          required: true
+        - label: |
+            If this is for a specific device, the device config is mentioned above, or diagnostics are included.
+          required: true
+        - label: This is not requesting addition of a new device
+          required: true
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/new-device.yaml

@@ -6,13 +6,9 @@ body:
   - type: markdown
     attributes:
       value: |
-        This form is for reporting a **New Device**.  If you are looking for
-        general help, including cases where you do not see anything in the log,
-        see [Discussions](https://github.com/make-all/tuya-local/discussions).
+        This form is for reporting a **New Device**.  If you are looking for general help, including cases where you do not see anything in the log, see [Discussions](https://github.com/make-all/tuya-local/discussions).
 
-        Thank you for reporting your unsupported device. Please provide as
-        much information as you can. Because the developers are busy, new
-        device requests will be prioritised as follows:
+        Thank you for reporting your unsupported device. Please provide as much information as you can. Because the developers are busy, new device requests will be prioritised as follows:
 
           1. Pull requests
           2. Issues with logs and QueryThingsDataModel API results or equivalent
@@ -24,9 +20,8 @@ body:
     attributes:
       label: Log message
       description: |
-        Please paste the Warning level log message containing a dps list
-        which is output when you attempt to add the device and are presented
-        with a list of non-matching devices.
+        From the Home Assistant log (Settings / System /Log), please paste the Warning level log message containing a dps list which is output when you attempt to add the device and are presented with a list of non-matching devices.
+        Alternatively, if you already added the device, you can turn on debug logging for a minute or so, and find a message in the log from your device which has `full_poll: true` as part of the message.
       placeholder: Reports without logs will be immediately closed
       render: text
     validations:
@@ -36,11 +31,8 @@ body:
     attributes:
       label: DPS information
       description: |
-        Preferred data is QueryThingsDataModel API result from iot.tuya.com
-        If you do not have access to iot.tuya.com, but have other ways of
-        obtaining dps information, the minimum info required is the numeric
-        dp id, name/description, data type, and for settable dps, the range
-        for numeric dps, and the list of possible values for enum dps.
+        Preferred data is QueryThingsDataModel API result from iot.tuya.com (under Cloud / API Explorer / Device Control)
+        If you do not have access to iot.tuya.com, but have other ways of obtaining dps information, the minimum info required is the numeric dp id, name/description, data type, and for settable dps, the range for numeric values, and the list of possible values for enum values. If you cannot obtain this info, there is no way for us to support you, as only owners of devices have access to the data about them.
       render: text
     validations:
       required: true
@@ -49,9 +41,8 @@ body:
     attributes:
       label: Product ID
       description: |
-        The product ID or productKey for the device. You can get this
-        from the same iot.tuya.com API functions that provide the local key
-        or from `tinytuya scan` or other tools doing local discovery
+        The product ID or productKey for the device.
+        You can get this from the same iot.tuya.com API functions that provide the local key or from `tinytuya scan` or other tools doing local discovery
   - type: input
     id: productname
     attributes:
@@ -62,6 +53,4 @@ body:
     attributes:
       label: Information about how the device functions
       description: |
-        Put any additional information here.  Remember the developers are not
-        familiar with your device, so any explanations of how it functions,
-        links to manuals or even marketing webpages are useful.
+        Put any additional information here.  Remember the developers are not familiar with your device, so any explanations of how it functions, links to manuals or even marketing webpages are useful.

.vscode/settings.json

@@ -4,7 +4,7 @@
   "editor.formatOnType": true,
   "files.eol": "\n",
   "files.trimTrailingWhitespace": true,
-  "files.insertFinalNewline": true,  
+  "files.insertFinalNewline": true,
   "python.linting.pylintEnabled": true,
   "python.linting.enabled": true,
   "python.formatting.provider": "black",