@sstar/boardlinker_agent

BoardLinker Agent - 为嵌入式开发提供板卡硬件访问服务的 gRPC 服务器。

功能特性

• 板卡 UART 通信: 支持多会话串口管理和数据传输
• 文件传输: 支持 Host 与 Agent 之间的双向文件传输
• 固件烧录: 支持 ISP 方式的固件恢复和升级
• SSH 隧道: 支持 SSH 远程访问和端口转发
• TFTP 服务: 内置 TFTP 服务器用于镜像传输
• NFS 同步: 支持 NFS 文件系统同步
• Web 管理界面: 内置 Web UI 用于配置和监控
• 插件系统: 支持通过插件扩展功能

安装

# 全局安装
npm install -g @sstar/boardlinker_agent

# 或使用 pnpm
pnpm add -g @sstar/boardlinker_agent

使用

启动 Agent

# 直接启动
boardlinker

# 带调试信息启动
boardlinker -d

# 启动但不自动打开浏览器
boardlinker --no-open

环境变量配置

Agent 支持通过环境变量进行配置：

| 变量名 | 说明 | 默认值 | |--------|------|--------| | BOARDLINKER_GRPC_PORT | gRPC 服务器端口 | 10000 | | BOARDLINKER_WEB_HOST | Web 服务器主机地址 | 0.0.0.0 | | BOARDLINKER_WEB_PORT | Web 服务器端口 | 8080 | | BOARDLINKER_TFTP_DIR | TFTP 文件服务目录 | ~/.local/board_linker/agent_files | | BOARDLINKER_TFTP_TTL_HOURS | TFTP 文件保存时间（小时） | 24 | | BOARDLINKER_BOARD_UART_PORT | 板卡串口设备路径 | 自动检测 | | BOARDLINKER_BOARD_UART_BAUD | 板卡串口波特率 | 115200 | | BOARDLINKER_LOG_LEVEL | 日志级别 | DEBUG |

配置文件

Agent 启动后会创建配置文件：~/.config/board_linker/agent.json

{
  "agent": {
    "id": "agent",
    "version": "0.1.0",
    "pairCode": "xxx-xxx-xxx",
    "startupTime": "2024-01-01T00:00:00.000Z"
  },
  "endpoint": {
    "grpc": {
      "host": "127.0.0.1",
      "port": 10000,
      "scheme": "grpc"
    },
    "web": {
      "host": "127.0.0.1",
      "port": 8080
    }
  }
}

Web 管理界面

Agent 启动后会自动打开浏览器访问 Web 管理界面（可通过 --no-open 禁用）。

默认地址：http://127.0.0.1:8080

与 Host 配合使用

Agent 需要与 @sstar/boardlinker_host 配合使用才能完整发挥功能：

# 终端 1: 启动 Agent
boardlinker

# 终端 2: 启动 Host
npx @sstar/boardlinker_host

系统要求

• Node.js >= 18.0.0
• 支持 macOS、Linux、Windows

许可证

MIT