Add documentation for customizing USB VID/PID on NanoKVM

This commit is contained in:
BuGu
2026-03-31 14:52:43 +08:00
parent f679b90f67
commit 8cae1244ad
2 changed files with 78 additions and 0 deletions

View File

@@ -54,6 +54,45 @@ NanoKVM supports custom logo display, which can be shown simultaneously on the O
![](../../../assets/NanoKVM/guide/logo2.jpg)
## Modifying USB VID/PID
NanoKVM supports customizing the Vendor ID (VID) and Product ID (PID) of USB devices. You can modify these parameters by creating specific configuration files.
### Procedure
1. Create configuration files:
- Modify VID: Create the `usb.vid` file in the `/boot` directory and write a 4-digit hexadecimal VID
- Modify PID: Create the `usb.pid` file in the `/boot` directory and write a 4-digit hexadecimal PID
**There are two methods to create the files:**
**Method 1: Create via Web Terminal or SSH Login**
Directly execute the following commands in the NanoKVM web terminal or after logging in via SSH:
```bash
echo "0x3346" > /boot/usb.vid
echo "0x1009" > /boot/usb.pid
```
**Method 2: Create via TF Card**
If the TF card is easily removable, insert it into your computer and create the `usb.vid` and `usb.pid` files directly in the `boot` partition, writing the corresponding values.
2. Reboot the NanoKVM device for the changes to take effect
3. **Restore Default VID/PID**: Delete the `/boot/usb.vid` and `/boot/usb.pid` files, then reboot the device to restore the default VID/PID.
### Verify Changes
After modification, you can verify the VID/PID changes using the `lsusb` command:
```bash
$ lsusb
Bus 003 Device 089: ID 3346:1009 sipeed NanoKVM
```
> Note: After modifying the VID/PID, the host may require reinstallation of the driver. Ensure that you use legitimate VID/PID combinations to avoid conflicts with existing devices.
## Obtaining Streaming Related Data
Streaming and image parameters are located in the `/kvmapp/kvm` folder.

View File

@@ -54,6 +54,45 @@ NanoKVM 支持自定义 Logo 显示,可在 OLED 屏幕和 Web 管理界面中
![](../../../assets/NanoKVM/guide/logo2.jpg)
## 修改 USB VID/PID
NanoKVM 支持自定义 USB 设备的 Vendor ID (VID) 和 Product ID (PID)。您可以通过创建特定的配置文件来修改这些参数。
### 操作步骤
1. 创建配置文件:
- 修改 VID在 `/boot` 目录下创建 `usb.vid` 文件写入四位十六进制的VID
- 修改 PID在 `/boot` 目录下创建 `usb.pid` 文件写入四位十六进制的PID
**创建文件的方法有以下两种:**
**方法一:通过网页终端或 SSH 登录后创建**
直接在 NanoKVM 的网页终端或通过 SSH 登录后,执行以下命令:
```bash
echo "0x3346" > /boot/usb.vid
echo "0x1009" > /boot/usb.pid
```
**方法二:通过 TF 卡创建**
如果方便取下 TF 卡,可以将 TF 卡插入电脑,在 `boot` 分区中直接创建 `usb.vid` 和 `usb.pid` 文件,并写入对应的值。
2. 重启 NanoKVM 设备,修改将立即生效
3. **恢复默认 VID/PID**:删除 `/boot/usb.vid` 和 `/boot/usb.pid` 两个文件,然后重启设备即可恢复默认的 VID/PID。
### 验证效果
修改完成后,可以通过 `lsusb` 命令验证 VID/PID 是否生效:
```bash
$ lsusb
Bus 003 Device 089: ID 3346:1009 sipeed NanoKVM
```
> 注意VID/PID 修改后,主机可能需要重新安装驱动程序。请确保使用合法的 VID/PID 组合,避免与现有设备冲突。
## 获取推流相关数据
推流和图像参数位于/kvmapp/kvm文件夹下