From 1033955ee1b26527f27727459a8a1152dc15dfb0 Mon Sep 17 00:00:00 2001
From: Oncleben31 <oncleben31@users.noreply.github.com>
Date: Thu, 14 Jan 2021 11:02:47 +0100
Subject: [PATCH] Prepare and explain how to step by step debugging (#51)

---
 .devcontainer/README.md          | 17 ++++++++++++++++
 .devcontainer/configuration.yaml |  3 +++
 .vscode/launch.json              | 35 ++++++++++++++++++++++++++++++++
 3 files changed, 55 insertions(+)
 create mode 100644 .vscode/launch.json

diff --git a/.devcontainer/README.md b/.devcontainer/README.md
index 60458f6..bd429de 100644
--- a/.devcontainer/README.md
+++ b/.devcontainer/README.md
@@ -41,3 +41,20 @@ Run Home Assistant on port 9123 | Launch Home Assistant with your custom compone
 Run Home Assistant configuration against /config | Check the configuration.
 Upgrade Home Assistant to latest dev | Upgrade the Home Assistant core version in the container to the latest version of the `dev` branch.
 Install a specific version of Home Assistant | Install a specific version of Home Assistant core in the container.
+
+### Step by Step debugging
+
+With the development container,
+you can test your custom component in Home Assistant with step by step debugging.
+
+You need to modify the `configuration.yaml` file in `.devcontainer` folder
+by uncommenting the line:
+
+```yaml
+# debugpy:
+```
+
+Then launch the task `Run Home Assistant on port 9123`, and launch the debbuger
+with the existing debugging configuration `Python: Attach Local`.
+
+For more information, look at [the Remote Python Debugger integration documentation](https://www.home-assistant.io/integrations/debugpy/).
diff --git a/.devcontainer/configuration.yaml b/.devcontainer/configuration.yaml
index 88b970d..743c10a 100644
--- a/.devcontainer/configuration.yaml
+++ b/.devcontainer/configuration.yaml
@@ -4,3 +4,6 @@ logger:
   default: info
   logs:
     custom_components.integration_blueprint: debug
+
+# If you need to debug uncommment the line below (doc: https://www.home-assistant.io/integrations/debugpy/)
+# debugpy:
diff --git a/.vscode/launch.json b/.vscode/launch.json
new file mode 100644
index 0000000..555a62b
--- /dev/null
+++ b/.vscode/launch.json
@@ -0,0 +1,35 @@
+{
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+      {
+        // Example of attaching to local debug server
+        "name": "Python: Attach Local",
+        "type": "python",
+        "request": "attach",
+        "port": 5678,
+        "host": "localhost",
+        "pathMappings": [
+          {
+            "localRoot": "${workspaceFolder}",
+            "remoteRoot": "."
+          }
+        ]
+      },
+      {
+        // Example of attaching to my production server
+        "name": "Python: Attach Remote",
+        "type": "python",
+        "request": "attach",
+        "port": 5678,
+        "host": "homeassistant.local",
+        "pathMappings": [
+          {
+            "localRoot": "${workspaceFolder}",
+            "remoteRoot": "/usr/src/homeassistant"
+          }
+        ]
+      }
+    ]
+  }
+  
\ No newline at end of file