feat: add Renode emulator, nvim-dap debugging, and backup collision fix

- Add Renode installation (AUR/deb) with arduino-sim helper script supporting STM32F4, RP2040, and nRF52840 (USB HID) platforms - Add nvim-dap + nvim-dap-ui with GDB remote adapter for Renode debugging - Add debug keybindings under <leader>d prefix - Fix backup_config() path collisions when multiple sources share a basename (e.g. ~/.config/nvim and ~/.local/share/nvim) - Strip NvChad starter's nvim-lspconfig block that conflicts with native vim.lsp.config, preserving configs/lazy.lua - Update step counts from 11 to 12 (TOTAL_STEPS 12→13, 13→14 on WSL) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-10 15:23:57 +02:00
parent 7021c915e6
commit b512d41dc8
13 changed files with 203 additions and 20 deletions
--- a/install.sh
+++ b/install.sh
@@ -82,6 +82,7 @@ source "$SCRIPT_DIR/lib/zellij.sh"
 source "$SCRIPT_DIR/lib/neovim.sh"
 source "$SCRIPT_DIR/lib/yazi.sh"
 source "$SCRIPT_DIR/lib/arduino.sh"
+source "$SCRIPT_DIR/lib/renode.sh"
 source "$SCRIPT_DIR/lib/git.sh"
 source "$SCRIPT_DIR/lib/scaffold.sh"
 source "$SCRIPT_DIR/lib/shell-config.sh"
@@ -104,6 +105,8 @@ echo "    arduino-new my-project uno    # scaffold a project"
 echo "    adev                          # launch Arduino workspace"
 echo "    <leader>av                    # compile in Neovim"
 echo "    <leader>au                    # upload in Neovim"
+echo "    arduino-sim build/fw.elf      # simulate with Renode"
+echo "    <leader>ds                    # attach debugger to Renode"
 echo "    theme                         # switch colorscheme"
 echo ""
 warn "A reboot is recommended to apply all changes (shell, groups, PATH)."
--- a/lib/arduino.sh
+++ b/lib/arduino.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 7: Arduino CLI + board cores

-step "9/11 — Installing Arduino CLI + board cores"
+step "9/12 — Installing Arduino CLI + board cores"

 if $IS_ARCH; then
  $PKG_INSTALL arduino-cli
--- a/lib/common.sh
+++ b/lib/common.sh
@@ -13,7 +13,7 @@ NC='\033[0m'
 VERBOSE=true
 LOG_FILE="/tmp/archduino-install.log"
 CURRENT_STEP=0
-TOTAL_STEPS=12
+TOTAL_STEPS=13

 info() { echo -e "${GREEN}[✓]${NC} $1"; }
 warn() { echo -e "${YELLOW}[!]${NC} $1"; }
@@ -39,7 +39,7 @@ draw_progress() {
 }

 begin_quiet_mode() {
-  $IS_WSL && TOTAL_STEPS=13
+  $IS_WSL && TOTAL_STEPS=14
  : >"$LOG_FILE"

  # Save real terminal to fd 3/4, redirect everything else to log
@@ -82,9 +82,12 @@ BACKUP_DIR="$HOME/.config/archduino/backups/$(date +%Y%m%d_%H%M%S)"
 backup_config() {
  local src="$1"
  [[ ! -e "$src" ]] && return 0
-  mkdir -p "$BACKUP_DIR"
-  cp -a "$src" "$BACKUP_DIR/"
-  info "Backed up $(basename "$src") → $BACKUP_DIR/"
+  # Use parent path to avoid collisions when different sources share a basename
+  # e.g. ~/.config/nvim and ~/.local/share/nvim both have basename "nvim"
+  local dest="$BACKUP_DIR${src#"$HOME"}"
+  mkdir -p "$(dirname "$dest")"
+  cp -a "$src" "$dest"
+  info "Backed up ${src/#"$HOME"/\~} → ${dest/#"$HOME"/\~}"
 }

 # ── TLS workaround ───────────────────────────────────────────────
--- a/lib/fonts.sh
+++ b/lib/fonts.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 2: Nerd Font installation

-step "2/11 — Installing Nerd Font"
+step "2/12 — Installing Nerd Font"

 FONT_DIR="$HOME/.local/share/fonts/NerdFonts"
 FONT_NAME="JetBrainsMono"
--- a/lib/git.sh
+++ b/lib/git.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 8: Git + Lazygit

-step "10/11 — Setting up Git + Lazygit"
+step "11/12 — Setting up Git + Lazygit"

 if $IS_ARCH; then
  $PKG_INSTALL lazygit
--- a/lib/neovim.sh
+++ b/lib/neovim.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Steps 5+6: Neovim + NvChad

-step "6/11 — Installing Neovim (latest)"
+step "6/12 — Installing Neovim (latest)"

 NVIM_NEEDED=true
 if command -v nvim &>/dev/null; then
@@ -21,7 +21,7 @@ if $NVIM_NEEDED; then
  info "Neovim installed: $(nvim --version | head -1)"
 fi

-step "7/11 — Setting up NvChad"
+step "7/12 — Setting up NvChad"

 NVIM_CFG="$HOME/.config/nvim"
 NVCHAD_FRESH=false
@@ -29,7 +29,7 @@ MIGRATED_PLUGINS_DIR="/tmp/archduino-migrated-plugins"
 rm -rf "$MIGRATED_PLUGINS_DIR"

 # Files managed by Archduino or LazyVim-specific — skip during migration
-SKIP_PLUGINS="gruvbox.lua|theme.lua|lsp.lua|arduino.lua|lspconfig.lua"
+SKIP_PLUGINS="gruvbox.lua|theme.lua|lsp.lua|arduino.lua|lspconfig.lua|dap.lua"

 # ── Detect existing config ──────────────────────────────────────
 if [[ -d "$NVIM_CFG/lua" ]]; then
@@ -94,6 +94,11 @@ if $NVCHAD_FRESH; then
  info "NvChad starter cloned"
 fi

+# ── Strip starter's nvim-lspconfig block (we use native vim.lsp) ─
+# Also remove configs/ dir — we don't use the legacy lspconfig setup
+sed -i '/neovim\/nvim-lspconfig/,/},/d' "$NVIM_CFG/lua/plugins/init.lua"
+rm -f "$NVIM_CFG/lua/configs/lspconfig.lua" "$NVIM_CFG/lua/configs/conform.lua"
+
 # ── Restore migrated plugins ─────────────────────────────────────
 if [[ -d "$MIGRATED_PLUGINS_DIR" ]] && ls "$MIGRATED_PLUGINS_DIR"/*.lua &>/dev/null; then
  mkdir -p "$NVIM_CFG/lua/plugins"
@@ -165,8 +170,67 @@ vim.lsp.enable("clangd")
 return {}
 LUA

-# Clean up legacy configs/lspconfig.lua if present
-rm -f "$NVIM_CFG/lua/configs/lspconfig.lua"
+# ── DAP (debug adapter) — for Renode GDB remote debugging ──────
+cat >"$NVIM_CFG/lua/plugins/dap.lua" <<'LUA'
+return {
+  {
+    "mfussenegger/nvim-dap",
+    keys = { "<leader>d" },
+    config = function()
+      local dap = require("dap")
+
+      -- GDB remote adapter (connects to Renode's GDB server)
+      dap.adapters.gdb_remote = {
+        type = "executable",
+        command = vim.fn.executable("arm-none-eabi-gdb") == 1
+          and "arm-none-eabi-gdb"
+          or "gdb-multiarch",
+        args = { "-i", "dap" },
+      }
+
+      -- Default debug configurations for Arduino/embedded
+      dap.configurations.c = {
+        {
+          name = "Attach to Renode (GDB :3333)",
+          type = "gdb_remote",
+          request = "attach",
+          target = "localhost:3333",
+          cwd = "${workspaceFolder}",
+          program = function()
+            return vim.fn.input("ELF path: ", vim.fn.getcwd() .. "/build/", "file")
+          end,
+        },
+      }
+      dap.configurations.cpp = dap.configurations.c
+      dap.configurations.arduino = dap.configurations.c
+
+      -- Breakpoint signs
+      vim.fn.sign_define("DapBreakpoint", { text = "●", texthl = "DiagnosticError" })
+      vim.fn.sign_define("DapStopped", { text = "▶", texthl = "DiagnosticOk", linehl = "DiffAdd" })
+    end,
+  },
+  {
+    "rcarriga/nvim-dap-ui",
+    dependencies = { "mfussenegger/nvim-dap", "nvim-neotest/nvim-nio" },
+    keys = { "<leader>du" },
+    config = function()
+      local dapui = require("dapui")
+      dapui.setup()
+
+      -- Auto open/close UI on debug sessions
+      local dap = require("dap")
+      dap.listeners.after.event_initialized["dapui_config"] = function() dapui.open() end
+      dap.listeners.before.event_terminated["dapui_config"] = function() dapui.close() end
+      dap.listeners.before.event_exited["dapui_config"] = function() dapui.close() end
+    end,
+  },
+  {
+    "nvim-neotest/nvim-nio",
+    lazy = true,
+  },
+}
+LUA
+

 # ── Keymaps ─────────────────────────────────────────────────────
 cat >"$NVIM_CFG/lua/mappings.lua" <<'LUA'
@@ -180,6 +244,15 @@ map("n", "<leader>av", "<cmd>ArduinoVerify<cr>", { desc = "Arduino Verify (compi
 map("n", "<leader>au", "<cmd>ArduinoUpload<cr>", { desc = "Arduino Upload" })
 map("n", "<leader>as", "<cmd>ArduinoSerial<cr>", { desc = "Arduino Serial Monitor" })
 map("n", "<leader>ai", "<cmd>ArduinoInfo<cr>", { desc = "Arduino Board Info" })
+
+-- Debug (DAP)
+map("n", "<leader>ds", function() require("dap").continue() end, { desc = "Debug Start/Continue" })
+map("n", "<leader>db", function() require("dap").toggle_breakpoint() end, { desc = "Debug Toggle Breakpoint" })
+map("n", "<leader>dn", function() require("dap").step_over() end, { desc = "Debug Step Over" })
+map("n", "<leader>di", function() require("dap").step_into() end, { desc = "Debug Step Into" })
+map("n", "<leader>do", function() require("dap").step_out() end, { desc = "Debug Step Out" })
+map("n", "<leader>dx", function() require("dap").terminate() end, { desc = "Debug Terminate" })
+map("n", "<leader>du", function() require("dapui").toggle() end, { desc = "Debug UI Toggle" })
 LUA

-info "NvChad configured ($THEME_DISPLAY_NAME + Arduino + LSP)"
+info "NvChad configured ($THEME_DISPLAY_NAME + Arduino + LSP + DAP)"
--- a/lib/packages.sh
+++ b/lib/packages.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 1: Base packages

-step "1/11 — Installing base packages"
+step "1/12 — Installing base packages"

 if $IS_ARCH; then
  sudo pacman -Syu --noconfirm
--- a/lib/renode.sh
+++ b/lib/renode.sh
@@ -0,0 +1,104 @@
+#!/bin/bash
+# Step 10: Renode emulator for Arduino simulation with USB HID support
+
+step "10/12 — Installing Renode emulator"
+
+# gdb-multiarch is needed for nvim-dap to connect to Renode's GDB server
+if $IS_ARCH; then
+  if ! command -v renode &>/dev/null; then
+    info "Installing Renode from AUR..."
+    yay -S --needed --noconfirm renode-bin
+  else
+    info "Renode already installed"
+  fi
+  $PKG_INSTALL arm-none-eabi-gdb
+else
+  if ! command -v renode &>/dev/null; then
+    info "Installing Renode..."
+    RENODE_VERSION=$(curl -ks "https://api.github.com/repos/renode/renode/releases/latest" | jq -r '.tag_name' | sed 's/^v//')
+    curl -ksSLo /tmp/renode.deb "https://github.com/renode/renode/releases/download/v${RENODE_VERSION}/renode_${RENODE_VERSION}_amd64.deb"
+    sudo apt install -y /tmp/renode.deb
+    rm -f /tmp/renode.deb
+  else
+    info "Renode already installed"
+  fi
+  $PKG_INSTALL gdb-multiarch
+fi
+info "Renode installed: $(renode --version 2>/dev/null | head -1 || echo 'OK')"
+
+# ── Renode helper script ─────────────────────────────────────────
+# Provides a quick way to launch Renode with a GDB server for a firmware ELF
+cat >~/.local/bin/arduino-sim <<'SIMSCRIPT'
+#!/bin/bash
+set -euo pipefail
+
+usage() {
+  echo "Usage: arduino-sim <firmware.elf> [platform]"
+  echo ""
+  echo "Launch Renode with a GDB server for debugging firmware."
+  echo "Connect nvim-dap or gdb to localhost:3333"
+  echo ""
+  echo "Platforms:"
+  echo "  stm32f4    STM32F4 Discovery  (default)"
+  echo "  rp2040     Raspberry Pi Pico"
+  echo "  nrf52840   nRF52840 (USB HID capable)"
+  echo ""
+  echo "Example:"
+  echo "  arduino-sim build/firmware.elf nrf52840"
+  exit 1
+}
+
+[[ $# -lt 1 ]] && usage
+
+ELF="$1"
+PLATFORM="${2:-stm32f4}"
+
+[[ ! -f "$ELF" ]] && echo "Error: $ELF not found" && exit 1
+
+# Map platform to Renode machine definition
+case "$PLATFORM" in
+  stm32f4)
+    RENODE_PLATFORM="platforms/boards/stm32f4_discovery.repl"
+    MACHINE="STM32F4_Discovery"
+    ;;
+  rp2040)
+    RENODE_PLATFORM="platforms/cpus/rp2040.repl"
+    MACHINE="RP2040"
+    ;;
+  nrf52840)
+    RENODE_PLATFORM="platforms/cpus/nrf52840.repl"
+    MACHINE="nRF52840"
+    ;;
+  *)
+    echo "Unknown platform: $PLATFORM"
+    usage
+    ;;
+esac
+
+# Generate a temporary Renode script
+RESC=$(mktemp /tmp/renode-XXXXXX.resc)
+cat >"$RESC" <<EOF
+using sysbus
+
+mach create "$MACHINE"
+machine LoadPlatformDescription @$RENODE_PLATFORM
+
+sysbus LoadELF @$(realpath "$ELF")
+
+machine StartGdbServer 3333
+
+showAnalyzer sysbus.uart0 Antmicro.Renode.Analyzers.LoggingUartAnalyzer
+
+start
+EOF
+
+echo "Starting Renode ($MACHINE) with GDB server on :3333"
+echo "Connect debugger:  nvim → <leader>ds  or  gdb → target remote :3333"
+echo ""
+
+renode --disable-xwt "$RESC"
+rm -f "$RESC"
+SIMSCRIPT
+chmod +x ~/.local/bin/arduino-sim
+
+info "Renode simulation helper created (arduino-sim)"
--- a/lib/scaffold.sh
+++ b/lib/scaffold.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 9: Project scaffolding tool + templates

-step "11/11 — Creating project scaffolding tool"
+step "12/12 — Creating project scaffolding tool"

 mkdir -p ~/.local/bin ~/.config/archduino/templates

--- a/lib/starship.sh
+++ b/lib/starship.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 3: Starship prompt

-step "4/11 — Installing Starship"
+step "4/12 — Installing Starship"

 if $IS_ARCH; then
  $PKG_INSTALL starship
--- a/lib/yazi.sh
+++ b/lib/yazi.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 8: Yazi file manager

-step "8/11 — Installing Yazi"
+step "8/12 — Installing Yazi"

 if $IS_ARCH; then
  $PKG_INSTALL yazi ffmpegthumbnailer p7zip poppler
--- a/lib/zellij.sh
+++ b/lib/zellij.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 4: Zellij terminal multiplexer

-step "5/11 — Installing Zellij"
+step "5/12 — Installing Zellij"

 if $IS_ARCH; then
  $PKG_INSTALL zellij
--- a/lib/zsh.sh
+++ b/lib/zsh.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 # Step 2: Zsh + Oh My Zsh + plugins

-step "3/11 — Setting up Zsh"
+step "3/12 — Setting up Zsh"

 if [[ ! -d "$HOME/.oh-my-zsh" ]]; then
  RUNZSH=no KEEP_ZSHRC=yes CHSH=no sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended ||