Remote debugging Home Assistant with VSCode

remote_debugging_ha_vscode.md

Prerequisits

Local machine

• Python 3 environment
• VSCode 1.33.1 with Python 2019.3.6558
• sshfs

Remote machine

• Full development environment for Home Assistant
• ptvsd

Prepare connections

Open tunnel to remote host in the background

ssh -f -p 9922 ubuntu@your.domain.tld -L 2222:dev.home.network:22 -N

SSHFS to remote host

mkdir remote_dev

sshfs -p 2222 ubuntu@localhost: ./remote_dev

VSCode

Open tunnel to remote host in the background

ssh -f -p 9922 ubuntu@your.domain.tld -L 3000:dev.home.network:3000 -N

Remote debugger config

{
    "name": "Python (Remote Debug) HA@dev",
    "type": "python",
    "request": "attach",
            "localRoot": "${workspaceRoot}/remote_dev/home-assistant",
    "remoteRoot": "/home/ubuntu/home-assistant",
    "port": 3000,
    "secret": "my_secret",
    "host":"localhost"
}

Connecting the debugger

python -m ptvsd --host dev.home.network --port 3000 --wait venv_37/bin/hass

Debugging