Need-Help: development environment

[AlexanderLanin]

I need some help with the development environment. In the end we could document how to do this, so this ticket has real benefit :-)

• Option: Studio Code Server Addon Pro: Super Easy Con:

  • No git integration (and completely different structure)
  • Not all VS-Code extensions available
  • No access to home assistant code (e.g. base classes, parameters of called functions, ...)

• Option: Terminal & SSH Addon + Local VS Code instance connected via SSH Pro: all extensions available (e.g. GitHub Copilot) Con:

  • Python not available (no linter, no auto formatting)
  • Different structure in git
  • No access to home assistant code (e.g. base classes, parameters of called functions, ...)

• Option: work on branch and reload integration in home assistant via HACS (not yet attempted)

• Option: work locally and copy files via bash script over SSH (not yet attempted. Sounds promising!)

Is there some more clever way? Since home assistant core seems to have a full development environment ready to use...

[alangibson]

I tend to use "work on branch and reload integration in home assistant via HACS" even though it is slow. It's only practical when you know the HA api well enough that you can be reasonably sure what you did will work when you load it up in HA.

Finding the optimal way to do it is way down on my mental TODO list. I just haven't had time for it.

[AlexanderLanin]

I've followed up on option 4. It's not perfect, but actually better than the others. Here is what I'm running as update_ha.sh:

#!/bin/bash
set -euo pipefail

echo "Running code analysis..."
ruff .
mypy .

echo "Copying files to home assistant..."

# ToDo: skip __pycache__ folders
# See e.g. https://stackoverflow.com/questions/15121337/recursively-use-scp-but-excluding-some-folders
rm -rf custom_components/sungrow/__pycache__
rm -rf custom_components/sungrow/core/__pycache__

scp -r custom_components/sungrow/ root@homeassistant.local:/root/homeassistant/custom_components || {
  echo "Error: Failed to copy files."
  echo "* Do you have ssh addon running in home assistant?"
  echo "* Did you configure it for remote access?"
  echo "* Did you add your ssh key to the authorized_keys? (run: eval `ssh-agent` and ssh- ssh-add)"
  echo "* Can you connect via ssh? (run: ssh root@homeassistant.local)"
  exit 1
}

echo "Restarting home assistant..."
ssh root@homeassistant.local "ha core restart"

echo "Tailing log... Press Ctrl+C to exit."
ssh root@homeassistant.local "tail -f /root/homeassistant/home-assistant.log"

I'm using the Terminal & SSH Add-On in HA. But I cannot find the instruction of what I had to do to configure remote access. Basically, what you need is a key pair as documented very nicely in https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent Then you configure Terminal & SSH -> authorized_keys with the content of id_ed25519.pub