arduino_remote.py

import os
import subprocess
from fabric import Connection

# Configuration variables
ARDUINO_PATH = "/path/to/your/arduino/sketches"
ARDUINO_CLI = "/path/to/arduino-cli"
SSH_CMD = "ssh your-vps ssh -p 2222 -i /path/to/.ssh/solveit your-user@localhost"
LIB_PATH = "/path/to/Arduino/libraries"
PORT = ''
FQBN = ''

def detect_board() -> tuple[str, str]:
    """Detect connected Arduino board and return its port and FQBN.

    Queries the remote workstation via SSH to list connected Arduino boards,
    then parses the output to find the port (e.g., /dev/ttyUSB0) and
    Fully Qualified Board Name (e.g., arduino:avr:uno).

    Also updates the global PORT and FQBN variables as a side effect.

    Returns:
        A tuple of (port, fqbn) strings. Empty strings if no board detected.
    """
    global PORT, FQBN
    result = subprocess.check_output(
        f'{SSH_CMD} "{ARDUINO_CLI} board list"',
        shell=True,
        text=True
    )
    lines = result.strip().split('\n')
    if len(lines) > 1:
        parts = lines[1].split()
        for part in parts:
            if part.startswith('/dev/'):
                PORT = part
            elif part.count(':') >= 2:
                FQBN = part

    print(f"Detected: {PORT} {FQBN}")
    return PORT, FQBN


def create_sketch(name: str, code: str) -> None:
    """Create an Arduino sketch file locally in /tmp.

    Writes the provided code to a .ino file that can then be sent
    to the remote workstation for compilation and upload.

    Args:
        name: Sketch name (used as filename, without .ino extension)
        code: The Arduino C++ code to write to the file
    """
    with open(f'/tmp/{name}.ino', 'w') as f:
        f.write(code)
    print(f"Created /tmp/{name}.ino")


def send_sketch(name: str) -> None:
    """Transfer a sketch from /tmp to the remote workstation.

    Creates the sketch directory on the remote workstation if needed,
    then copies the local .ino file via SSH.

    Args:
        name: Sketch name (matching the local file in /tmp)
    """
    os.system(f'{SSH_CMD} "mkdir -p {ARDUINO_PATH}/{name}"')
    os.system(f'cat /tmp/{name}.ino | {SSH_CMD} "bash -c \'cat > {ARDUINO_PATH}/{name}/{name}.ino\'"')
    print(f"Sent {name}.ino to workstation")


def compile_sketch(name: str) -> None:
    """Compile an Arduino sketch on the remote workstation.

    Args:
        name: Sketch name (must already exist on the workstation)
    """
    os.system(f'{SSH_CMD} "{ARDUINO_CLI} compile --fqbn {FQBN} {ARDUINO_PATH}/{name}/{name}.ino"')
    print(f"Compiled {name}.ino")


vps = Connection('your-vps-user@your-vps-hostname', connect_kwargs={"key_filename": "/path/to/.ssh/id_ed25519"})
workstation = Connection('your-workstation-user@localhost', port=2222, gateway=vps)

def install_lib(lib_name: str) -> bool:
    """Install an Arduino library on the remote workstation.

    Args:
        lib_name: Name of the library to install (e.g., "Servo", "FastLED")

    Returns:
        True if installation succeeded, False otherwise
    """
    result = workstation.run(f'{ARDUINO_CLI} lib install "{lib_name}"', warn=True)
    if result.ok:
        print(f"✓ Installed library: {lib_name}")
    else:
        print(f"✗ Failed to install: {lib_name}")
    return result.ok


def compile_lib_sketch(name: str) -> None:
    """Compile an Arduino sketch that uses external libraries.

    Like compile_sketch, but includes the custom library path.

    Args:
        name: Sketch name (must already exist on the workstation)
    """
    os.system(f'{SSH_CMD} "{ARDUINO_CLI} --libraries {LIB_PATH} compile --fqbn {FQBN} {ARDUINO_PATH}/{name}/{name}.ino"')
    print(f"Compiled {name}.ino")


def upload_sketch(name: str) -> None:
    """Upload a compiled sketch to the connected Arduino board.

    Args:
        name: Sketch name (must be compiled on the workstation already)
    """
    os.system(f'{SSH_CMD} "{ARDUINO_CLI} upload -p {PORT} --fqbn {FQBN} {ARDUINO_PATH}/{name}/{name}.ino"')
    print(f"Uploaded {name}.ino")