mirror of
https://github.com/sipeed/sipeed_wiki.git
synced 2026-09-11 00:22:49 -05:00
update PiKVM doc and method for flashing using SD card
This commit is contained in:
916BGAI
@@ -14,34 +14,89 @@ update:
|
||||
- Add new feature description
|
||||
---
|
||||
|
||||
## Switching to PiKVM
|
||||
## System Framework Switching
|
||||
|
||||
In addition to running the NanoKVM framework, NanoKVM Pro is also compatible with the PiKVM software framework. You can switch between them as needed.
|
||||
In addition to running the NanoKVM framework, NanoKVM Pro is fully compatible with the PiKVM software framework. You can flexibly switch between them based on your usage requirements.
|
||||
|
||||
### Switching to PiKVM
|
||||
### Switching from NanoKVM to PiKVM
|
||||
|
||||
By default, the NanoKVM Pro uses the NanoKVM framework. You can switch to PiKVM in `Settings` -> `About` -> `Switch Device`.
|
||||
NanoKVM Pro ships with the NanoKVM framework by default. Follow these steps to switch:
|
||||
|
||||
|
||||
1. Navigate to `Settings` → `About` → `Switch Device`
|
||||
|
||||
After clicking, the system will automatically restart and boot into the PiKVM framework. This process takes about 30 seconds. If it does not switch automatically for a long time, please refresh the webpage manually.
|
||||
|
||||
|
||||
|
||||
2. After clicking the switch button, the system will automatically restart and boot into the PiKVM framework (takes approximately 30 seconds). If it doesn't switch automatically after a long time, please manually refresh the webpage
|
||||
|
||||
The default username and password for the PiKVM framework are also `admin`, `admin`. However, the two platforms use their own usernames and passwords, which are not unified. It is strongly recommended to change them after logging in.
|
||||
|
||||
|
||||
|
||||
3. The default account and password under the PiKVM framework are also `admin` / `admin`
|
||||
|
||||
> Some functions in the PiKVM framework require the use of a web terminal, such as Wi-Fi configuration and Tailscale setup.
|
||||
> When updating NanoKVM, the PiKVM framework will be updated simultaneously.
|
||||
|
||||
|
||||
### Switching to NanoKVM
|
||||
**Important Notes:**
|
||||
> - The two platforms manage accounts and passwords independently and do not synchronize. It is strongly recommended to change the default password immediately after logging in
|
||||
> - Some features under the PiKVM framework need to be implemented through the web terminal, such as WiFi configuration, Tailscale configuration, etc.
|
||||
> - When the NanoKVM system updates, the PiKVM framework will also be updated synchronously
|
||||
|
||||
Switching back from the PiKVM system to NanoKVM is equally simple. Just go to `Options` -> `Switch to NanoKVM` and click `Switch Now`.
|
||||
### PiKVM Password Management
|
||||
|
||||
|
||||
PiKVM currently does not support password modification through the web UI. You need to execute the following commands via SSH or the web terminal:
|
||||
|
||||
After clicking, the system will automatically restart and boot into the NanoKVM framework. This process takes about 30 seconds. If it does not switch automatically for a long time, please refresh the webpage manually.
|
||||
```shell
|
||||
# Change Linux system user password
|
||||
passwd root
|
||||
|
||||
# Change KVM login password
|
||||
kvmd-htpasswd set admin
|
||||
|
||||
# User management commands
|
||||
kvmd-htpasswd add <user> # Add new user and set password
|
||||
kvmd-htpasswd list # Display user list
|
||||
kvmd-htpasswd del <user> # Delete user
|
||||
```
|
||||
|
||||
For more usage methods, please refer to [PiKVM Official Documentation - Authentication](https://docs.pikvm.org/auth/).
|
||||
|
||||
### Configuring WiFi Network
|
||||
|
||||
PiKVM currently does not support WiFi configuration through the web UI and LCD screen. You can choose one of the following methods:
|
||||
|
||||
**Method 1: Switch to NanoKVM Framework for Configuration (Recommended)**
|
||||
- After switching to the NanoKVM framework, use the web interface or LCD screen to configure WiFi, then switch back to the PiKVM framework
|
||||
|
||||
**Method 2: Command Line Configuration**
|
||||
- Execute the following commands via SSH or web terminal:
|
||||
|
||||
```shell
|
||||
# Connect to open network (no password)
|
||||
/kvmcomm/scripts/wifi.sh connect_start <SSID>
|
||||
|
||||
# Connect to encrypted network (requires password)
|
||||
/kvmcomm/scripts/wifi.sh connect_start <SSID> <PASSWORD>
|
||||
|
||||
# Disconnect WiFi connection
|
||||
/kvmcomm/scripts/wifi.sh connect_stop
|
||||
```
|
||||
|
||||
### Configuring Tailscale Network
|
||||
|
||||
PiKVM currently does not support Tailscale configuration through the web UI. Please use the NanoKVM framework to configure Tailscale, then switch back to the PiKVM framework.
|
||||
|
||||
### Switching from PiKVM Back to NanoKVM
|
||||
|
||||
Switching from the PiKVM system back to NanoKVM is equally simple:
|
||||
|
||||
1. Navigate to `Options` → `Switch to NanoKVM`
|
||||
2. Click the `Switch Now` button
|
||||
|
||||
|
||||
|
||||
3. The system will automatically restart and boot into the NanoKVM framework (takes approximately 30 seconds). If it doesn't switch automatically after a long time, please manually refresh the webpage
|
||||
|
||||
### More Features
|
||||
|
||||
For more features, please refer to the [PiKVM Official Documentation](https://docs.pikvm.org/).
|
||||
|
||||
## SSH & mDNS
|
||||
|
||||
@@ -114,9 +169,9 @@ Since NanoKVM-Pro can emulate a display, capture screen content, and features a
|
||||
In the UI, simply select **HDMI** as the video output source to display the captured video feed on the small screen.
|
||||
|
||||
When used as a desktop accessory, this feature can serve as a:
|
||||
- Mini secondary monitor
|
||||
- System performance monitor
|
||||
- Video thumbnail player
|
||||
- Mini secondary monitor
|
||||
- System performance monitor
|
||||
- Video thumbnail player
|
||||
and more.
|
||||
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ The resolution list in the host display settings is determined by the host, EDID
|
||||
|
||||
### HDMI Icon Lit on NanoKVM Screen but No Video Displayed in Web Interface
|
||||
|
||||
NanoKVM-Pro supports video capture and loop-out functions. When only capturing video, it reports a maximum resolution of 4K30FPS to the host by default. When a loop-out display is connected, it reports a common resolution list.
|
||||
NanoKVM-Pro supports video capture and loop-out functions. When only capturing video, it reports a maximum resolution of 4K30FPS to the host by default. When a loop-out display is connected, it reports a common resolution list.
|
||||
For the default resolution and frame rate list, please refer to [here](https://wiki.sipeed.com/hardware/en/kvm/NanoKVM_Pro/extended.html#How-to-Modify-EDID).
|
||||
|
||||
When connected through video adapters or docking stations, the reported capabilities may change (e.g., reporting 4K60FPS capture support, which may cause capture failure). In such cases, adjust the display settings in the host system:
|
||||
@@ -145,9 +145,28 @@ AXDL is an official burning tool provided by Aixin, designed for burning AXP for
|
||||
- The burning process will start automatically, wait for the progress bar to complete.
|
||||
- Wait until the prompt indicates that burning was successful; the entire process is complete.
|
||||
|
||||
### SD Card Flashing
|
||||
|
||||
The NanoKVM Pro Desk supports writing an image from an SD card to the internal eMMC to restore or update the system. Note: this only supports flashing an image from an SD card to the internal eMMC; the device cannot boot directly from the SD card.
|
||||
|
||||
#### Preparation
|
||||
- Prepare an SD card with at least 8 GB capacity.
|
||||
- Download the latest NanoKVM Pro SD image from the [NanoKVM Pro Releases](https://github.com/sipeed/NanoKVM-Pro/releases) page (the image is usually provided in a zip archive). Extract the archive and locate the `img` file.
|
||||
- Prepare a flashing tool such as `balenaEtcher`, `Rufus`, or use the command-line `dd`.
|
||||
- Prepare a USB card reader to connect the SD card.
|
||||
|
||||
#### Flashing Steps
|
||||
1. Use `balenaEtcher` or `dd` to write the `img` file to the SD card (see the "USB Burning" section above for details on writing images).
|
||||
2. Insert the flashed SD card into the NanoKVM Pro's SD card slot.
|
||||
3. Disconnect power from the NanoKVM Pro Desk.
|
||||
4. Press and hold the NanoKVM Pro Desk `User` button, then connect power.
|
||||
5. When the orange LED starts flashing steadily, the device is writing the image from the SD card to the internal eMMC.
|
||||
6. After flashing completes, the orange LED will stay solid, indicating success.
|
||||
7. Disconnect power, remove the SD card, and reconnect power. The device will boot the new system from internal eMMC.
|
||||
|
||||
## Desk Version LCD Not Lighting Up
|
||||
|
||||
This may be caused by a loose FPC cable connection of the LCD during transportation.
|
||||
This may be caused by a loose FPC cable connection of the LCD during transportation.
|
||||
Click [here](https://wiki.sipeed.com/nanokvmpro-lcd) to view the issue and repair details.
|
||||
|
||||
## Appearance Issues
|
||||
|
||||
@@ -14,34 +14,89 @@ update:
|
||||
- Add new feature description
|
||||
---
|
||||
|
||||
## 切换至PiKVM
|
||||
## 系统框架切换
|
||||
|
||||
NanoKVM Pro除运行 NanoKVM 框架外还适配了PiKVM软件框架。您可以根据需求切换使用
|
||||
NanoKVM Pro 除运行 NanoKVM 框架外，还完全适配了 PiKVM 软件框架。您可以根据使用需求灵活切换。
|
||||
|
||||
### 切换至PiKVM
|
||||
### 从 NanoKVM 切换至 PiKVM
|
||||
|
||||
NanoKVM Pro 出厂默认使用 NanoKVM 框架，可以在`设置`->`关于`->`切换设备`
|
||||
NanoKVM Pro 出厂默认运行 NanoKVM 框架。切换步骤如下：
|
||||
|
||||
|
||||
1. 进入 `设置` → `关于` → `切换设备`
|
||||
|
||||
点击后系统将自动重启，并启动为PiKVM框架。此过程约30s，如果长时间不自动切换，请手动刷新网页。
|
||||
|
||||
|
||||
|
||||
2. 点击切换按钮后，系统将自动重启并启动 PiKVM 框架（约需 30 秒）。如长时间未自动切换，请手动刷新网页
|
||||
|
||||
PiKVM框架下默认帐号密码也是`admin`，`admin`，但两个平台下使用各自的帐号与密码，并不统一，强烈建议登陆后修改。
|
||||
|
||||
|
||||
|
||||
3. PiKVM 框架下的默认账号密码同样为 `admin` / `admin`
|
||||
|
||||
> PiKVM框架下部分功能需要借助网页终端实现：如WiFi配网、Tailscale配置
|
||||
> NanoKVM更新时，PiKVM框架将同步更新
|
||||
|
||||
|
||||
### 切换至NanoKVM
|
||||
**注意事项：**
|
||||
> - 两个平台各自独立管理账号与密码，互不同步，强烈建议登录后立即修改默认密码
|
||||
> - PiKVM 框架下的部分功能需要通过网页终端实现，如 WiFi 配网、Tailscale 配置等
|
||||
> - NanoKVM 系统更新时，PiKVM 框架会同步更新
|
||||
|
||||
从PiKVM系统切换回NanoKVM同样简单，只需在`Options`->`Switch to NanoKVM`点击`Switch Now`即可
|
||||
### PiKVM 密码管理
|
||||
|
||||
|
||||
PiKVM 目前不支持通过网页端 WebUI 修改密码，需要通过 SSH 或网页终端执行以下命令：
|
||||
|
||||
点击后系统将自动重启，并启动为NanoKVM框架。此过程约30s，如果长时间不自动切换，请手动刷新网页
|
||||
```shell
|
||||
# 修改 Linux 系统用户密码
|
||||
passwd root
|
||||
|
||||
# 修改 KVM 登录密码
|
||||
kvmd-htpasswd set admin
|
||||
|
||||
# 用户管理命令
|
||||
kvmd-htpasswd add <user> # 添加新用户并设置密码
|
||||
kvmd-htpasswd list # 显示用户列表
|
||||
kvmd-htpasswd del <user> # 删除用户
|
||||
```
|
||||
|
||||
更多使用方法请参考 [PiKVM 官方文档 - 认证管理](https://docs.pikvm.org/auth/)。
|
||||
|
||||
### 配置 WiFi 网络
|
||||
|
||||
PiKVM 目前不支持通过网页端 WebUI 和 LCD 屏幕配置 WiFi。您可以选择以下任一方式：
|
||||
|
||||
**方式一：切换到 NanoKVM 框架配置（推荐）**
|
||||
- 切换至 NanoKVM 框架后使用网页端或 LCD 屏幕配置 WiFi，再切换回 PiKVM 框架
|
||||
|
||||
**方式二：使用命令行配置**
|
||||
- 通过 SSH 或网页终端执行以下命令：
|
||||
|
||||
```shell
|
||||
# 连接到开放网络（无密码）
|
||||
/kvmcomm/scripts/wifi.sh connect_start <SSID>
|
||||
|
||||
# 连接到加密网络（需要密码）
|
||||
/kvmcomm/scripts/wifi.sh connect_start <SSID> <PASSWORD>
|
||||
|
||||
# 断开 WiFi 连接
|
||||
/kvmcomm/scripts/wifi.sh connect_stop
|
||||
```
|
||||
|
||||
### 配置 Tailscale 网络
|
||||
|
||||
PiKVM 目前不支持通过网页端 WebUI 配置 Tailscale。请使用 NanoKVM 框架配置 Tailscale，再切换回 PiKVM 框架。
|
||||
|
||||
### 从 PiKVM 切换回 NanoKVM
|
||||
|
||||
从 PiKVM 系统切换回 NanoKVM 同样简单：
|
||||
|
||||
1. 进入 `Options` → `Switch to NanoKVM`
|
||||
2. 点击 `Switch Now` 按钮
|
||||
|
||||
|
||||
|
||||
3. 系统将自动重启并启动 NanoKVM 框架（约需 30 秒）。如长时间未自动切换，请手动刷新网页
|
||||
|
||||
### 更多功能
|
||||
|
||||
更多功能请参考 [PiKVM 官方文档](https://docs.pikvm.org/)。
|
||||
|
||||
## SSH & mDNS
|
||||
|
||||
@@ -271,9 +326,9 @@ NanoKVM-Pro针对延迟进行了较大改进，任意分辨率下端到端延迟
|
||||
> 实测表明选择不同帧率，对端到端的延迟影响不大，也就是说，1080P120和1080P30的延迟几乎一致。
|
||||
| 视频模式 | 端到端延迟 |
|
||||
|--------------|---------|
|
||||
| Direct H264 | 100ms |
|
||||
| WebRTC H264 | 100ms |
|
||||
| MJPEG | 100~150ms|
|
||||
| Direct H264 | 100ms |
|
||||
| WebRTC H264 | 100ms |
|
||||
| MJPEG | 100~150ms|
|
||||
|
||||
注意，我们使用"端到端"延迟来体现用户实际感知的延迟：
|
||||
从用户在本地浏览器窗口移动鼠标，到 浏览器中远程桌面鼠标开始移动的延迟。
|
||||
|
||||
@@ -144,6 +144,25 @@ AXDL 是爱芯官方推出的镜像烧录工具，可以烧录 AXP 格式的系
|
||||
- 烧录将自动开始，等待进度条完成
|
||||
- 直到提示烧录成功，整个过程完成
|
||||
|
||||
### SD 卡烧录
|
||||
|
||||
NanoKVM Pro Desk 支持通过 SD 卡将镜像写入内置 eMMC 来恢复或更新系统。注意：目前仅支持将镜像从 SD 卡烧录到内置 eMMC，设备不能直接从 SD 卡启动。
|
||||
|
||||
#### 准备工作
|
||||
- 准备一张容量至少 8 GB 的 SD 卡。
|
||||
- 下载最新的 [NanoKVM Pro SD 镜像](https://github.com/sipeed/NanoKVM-Pro/releases)（通常为 zip 压缩包），解压后取出其中的 `img` 文件。
|
||||
- 准备烧录工具（如 `balenaEtcher`、`Rufus` 或使用命令行的 `dd`）。
|
||||
- 准备一个 USB 读卡器以连接 SD 卡。
|
||||
|
||||
#### 烧录步骤
|
||||
1. 使用 `balenaEtcher` 或 `dd` 将 `img` 镜像写入 SD 卡（具体写入方法参照上文“USB 烧录”部分）。
|
||||
2. 将写好镜像的 SD 卡插入 NanoKVM Pro 的 SD 卡槽。
|
||||
3. 断开 NanoKVM Pro Desk 的电源。
|
||||
4. 按住 NanoKVM Pro Desk 的 `User` 按键，同时接通电源。
|
||||
5. 当橙色 LED 开始匀速闪烁时，表示开始将 SD 卡中的镜像烧录到内置 eMMC。
|
||||
6. 烧录完成后，橙色 LED 由闪烁变为常亮，表示烧录成功。
|
||||
7. 断开电源并取出 SD 卡，重新接通电源后设备将从内置 eMMC 自动启动新系统。
|
||||
|
||||
## Desk版本LCD不亮
|
||||
|
||||
这可能是由于运输过程中LCD的FPC排线松动导致。
|
||||
|
||||
Reference in New Issue
Block a user