KVMD-ARMBIAN 项目技术文档

KVMD-ARMBIAN 项目技术文档

kvmd-armbian KVMD For Armbian Install Script 项目地址: https://gitcode.com/gh_mirrors/kv/kvmd-armbian

1. 安装指南

1.1 硬件要求

• 支持OTG功能的电视盒子或ARM开发板：
  • 测试设备包括：Phicomm N1（Amlogic s905d）、MXQ Pro 4K（RK322x）、TQC A01（Allwinner H6）。
  • 如果使用ARM开发板，可以移除GPIO补丁以启用GPIO功能。
• 视频捕捉设备：
  • HDMI转USB适配器（淘宝30元，速卖通10美元）。
  • 注意：便宜的HDMI转USB适配器通常使用物理USB2.0端口，但假冒的USB3.0（USB 5GBPS，USB3.2GEN1）版本支持720P 60FPS，而USB2.0版本仅支持720P 30FPS。
• USB-A到USB-A线缆：
  • 建议切断USB线缆的电源线，以避免OTG断开连接。

1.2 软件要求

• Armbian系统：
  • 推荐使用Debian Bullseye版本。
  • 如果内核不支持OTG，需要构建一个启用OTG功能的内核。

1.3 安装步骤

1. 刷入Armbian系统：

   • 为你的电视盒子刷入Armbian Debian系统（推荐Bullseye版本）。
   • 如果内核不支持OTG，需要构建一个启用OTG功能的内核。

2. 修改DTB文件：

   • 修改DTB文件以启用OTG功能。将OTG USB端口的dr_mode从host改为peripheral。
   • 如果使用RK322x系列芯片（如RK3228A、RK3228B、RK3229），可以使用dtb/4.4/rk332x-box.dtb。

3. 克隆项目并安装：

   • 克隆项目：

     git clone https://github.com/xe5700/kvmd-armbian.git
     cd kvmd-armbian
     

   • 运行安装脚本：

     ./install.sh
     

   • 如果安装速度很慢，可以使用install-mirror.sh来加速安装。

4. 重启并再次运行安装脚本：

   • 重启系统后再次运行install.sh或install-mirror.sh。
   • 安装完成后即可使用。

2. 项目使用说明

2.1 启动与配置

• 安装完成后，系统会自动启动PiKVM服务。
• 可以通过浏览器访问PiKVM的Web界面进行配置和管理。

2.2 常见问题

• OTG断开连接：
  • 如果OTG频繁断开连接，建议切断USB线缆的电源线。
• 视频捕捉设备不支持高帧率：
  • 使用便宜的HDMI转USB适配器时，可能只支持720P 30FPS。

3. 项目API使用文档

3.1 API概述

• 该项目提供了一系列API接口，用于控制和管理PiKVM服务。
• API接口可以通过HTTP请求进行调用，返回JSON格式的数据。

3.2 常用API

• 获取系统状态：

  • 请求方式：GET
  • URL：/api/system/status
  • 返回示例：

    {
      "status": "running",
      "version": "2.0"
    }
    

• 重启服务：

  • 请求方式：POST
  • URL：/api/system/restart
  • 返回示例：

    {
      "message": "Service restarted successfully"
    }
    

4. 项目安装方式

4.1 自动安装

• 使用提供的install.sh或install-mirror.sh脚本进行自动安装。
• 安装脚本会自动下载并配置所需的软件包和依赖。

4.2 手动安装

• 如果自动安装失败，可以手动下载并安装所需的软件包和依赖。
• 具体步骤可以参考项目Wiki中的详细说明。

---

通过以上步骤，您可以顺利安装并使用KVMD-ARMBIAN项目，实现非Raspberry Pi设备上的PiKVM功能。

kvmd-armbian KVMD For Armbian Install Script 项目地址: https://gitcode.com/gh_mirrors/kv/kvmd-armbian