Update KVM Doc

This commit is contained in:
Z2Z-GuGu
2024-07-04 19:13:28 +08:00
parent 60bccce002
commit 96b41ab63b
16 changed files with 234 additions and 54 deletions

View File

@@ -366,10 +366,12 @@ items:
file: kvm/NanoKVM/1_intro.md
- label: Unboxing Experience
file: kvm/NanoKVM/2_unbox.md
- label: User Guide
file: kvm/NanoKVM/3_user_guide.md
- label: Update Firmware
file: kvm/NanoKVM/3_firmware.md
file: kvm/NanoKVM/4_firmware.md
- label: FAQ
file: kvm/NanoKVM/4_faq.md
file: kvm/NanoKVM/5_faq.md
# - label: Maix Audio
# items:
# - label: MA USB 16

View File

@@ -10,12 +10,24 @@ update:
---
## 简介
Lichee NanoKVM 是基于 LicheeRV Nano 的 IP-KVM 产品,继承了 LicheeRV Nano的极致体积 和 强大功能。
Lichee NanoKVM分为两个版本
![](./../assets/NanoKVM/1_intro/NanoKVM_3.jpg)
Lichee NanoKVM 是基于 LicheeRV Nano 的 IP-KVM 产品,继承了 LicheeRV Nano 的极致体积 和 强大功能。
NanoKVM 包含一个 HDMI 输入接口,可以被电脑识别为显示器,捕捉电脑画面;一个 USB2.0 接口连接电脑主机可被识别为键盘鼠标触摸板等HID设备同时使用TF卡多余存储空间挂载为一个U盘设备全系标配一个百兆网口用于视频和控制信号等的网络传输。另外Full版还带有ATX电源控制接口USB-C形态方便远程控制和查看主机开关机状态Full 版外壳下还带一个 OLED 显示屏,用于显示本机 IP 和 KVM 相关状态。
为满足用户不同需求NanoKVM 提供两个版本:
NanoKVM Lite 为基础版配置,适合 具有一定DIY能力的个人用户 和 有批量需求的企业用户。
NanoKVM Full 为完整版配置,带精致外壳和完整配件,内置开机即用的系统镜像卡,推荐个人用户购买。
![](./../assets/NanoKVM/1_intro/NanoKVM_1.jpg)
## 使用场景
+ 服务器管理:用于实时监控服务器,获取服务器运行状态,并对其加以控制;
+ 远程桌面、开关机NanoKVM 摆脱主机必须联网和系统软件的限制,作为主机外置硬件,直接提供远程控制的功能;
+ 远程装机NanoKVM模拟U盘设备可挂载装机镜像安装系统也可进入BISO对电脑设置
+ 远程串口Full内测版暂未引出至接口NanoKVM引出两组串口可配合IPMI使用用户可自行拓展更多配件
+ 更多玩法功能将在后续开放(如直播推流机),敬请期待
## 参数
@@ -26,8 +38,8 @@ NanoKVM Full 为完整版配置,带精致外壳和完整配件,内置开机
| 视频编码 | MJPEG, H264(developing) | MJPEG, H264(developing) | MJPEG, H264 |
| 视频延迟 | 90230ms | 90230ms | 100230ms |
| UEFI/BIOS | ✓ | ✓ | ✓ |
| 模拟USB键鼠 <br>Virtual HID | ✓ | ✓ | ✓ |
| 模拟USB存储 <br> Virtual CD-ROM | ✓ | ✓ | ✓ |
| 模拟USB键鼠 | ✓ | ✓ | ✓ |
| 模拟USB存储 | ✓ | ✓ | ✓ |
| IPMI | ✓ | ✓ | ✓ |
| Wake-on-LAN | ✓ | ✓ | ✓ |
| ATX电源控制 | 无,用户可自行连接 | USB接口IO控制板 | RJ45接口IO控制板 |
@@ -49,10 +61,23 @@ NanoKVM 基于 Sipeed [LicheeRV Nano](https://wiki.sipeed.com/hardware/zh/lichee
NanoKVM Lite 由 LicheeRV Nano E 和 HDMItoCSI 小板构成NanoKVM FULL 在 NanoKVM Lite 基础上增加 NanoKVM-A/B 板和外壳。HDMItoCSI板用于转换HDMI信号NanoKVM-A 包含 OLED、ATX控制输出TypeC接口形式、辅助供电TypeC接口以及ATX开关机、复位按键NanoKVM-B 一端连接A板一端连接电脑ATX针脚用于电脑的远程开关机。
NanoKVM 镜像在LicheeRV Nano SDK 和 MaixCDK 基础上构建,可以兼容使用 LicheeRV Nano 的资料反之LicheeRV Nano 或其他 SG2002 产品无法使用KVM软件。如果您想在 LicheeRV Nano 或 MaixCam 上构建 HDMI输入相关应用请与我们联系以获得技术支持。
NanoKVM 镜像在LicheeRV Nano SDK 和 MaixCDK 基础上构建,可以兼容使用 LicheeRV Nano 的资料反之LicheeRV Nano 或其他 SG2002 产品无法使用KVM软件。如果您想在 NanoKVM 上构建 HDMI 输入相关应用,请与我们联系,以获得技术支持。
+ [HDMItoCSI 板原理图](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_RV_Nano_KVM_B_30131.pdf)
+ [NanoKVM-A 原理图](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_RV_Nano_KVM_A_30111.pdf)
+ [NanoKVM-B 原理图](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_HDMI_MIPI_31011.pdf)
+ [NanoKVM镜像下载]()
+ [NanoKVM 镜像下载](https://github.com/sipeed/NanoKVM/releases/tag/NanoKVM)
## 购买入口
[淘宝官方购买地址](https://item.taobao.com/item.htm?id=811206560480)
[速卖通购买地址]()
[预售页面](sipeed.com/nanokvm)
## 产品反馈
如果您在使用过程中有任何问题或建议,请通过以下渠道和我们反馈:
+ [Github issues](https://github.com/sipeed/NanoKVM)
+ [MaixHub 论坛](https://maixhub.com/discussion/nanokvm)
+ QQ 交流群: 703230713

View File

@@ -1,8 +1,8 @@
---
title: 开箱
title: 快速开始
keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool
update:
- date: 2024-6-21
- date: 2024-7-4
version: v0.1
author: BuGu
content:
@@ -13,15 +13,21 @@ update:
![](./../assets/NanoKVM/2_unbox/unbox_0.png)
Full版包含Nano KVM带外壳带卡、KVM-B板、USB A to C 线 *2、杜邦线
Full版包含 NanoKVM带外壳带卡、KVM-B板、USB A to C 线 *2、杜邦线
Lite版包含 NanoKVM不带外壳和TF卡 、散热片。
## 接口介绍
![](./../assets/NanoKVM/2_unbox/Interface.png)
## 接线
NanoKVM-Full版接口示意图如下
NanoKVM-Full版接口示意图如下Lite版仅包含 USB-C、HDMI和网口可以参考Full版接线。
![](./../assets/NanoKVM/2_unbox/unbox_1.png)
+ 使用一条 USB C to A 数据线连接远程主机和 NanoKVM 的 USB C 口
+ 使用一条 USB C to A 数据线连接远程主机和 NanoKVM 的 PC USB 接口
+ 一条HDMI标准尺寸连接远程主机和 NanoKVM 的 HDMI 接口
@@ -37,7 +43,11 @@ NanoKVM-Full版接口示意图如下
![](./../assets/NanoKVM/2_unbox/unbox_2.png)
## 如何获取IP地址
## 基础操作
### Lite用户烧卡请参考[烧卡方法](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/3_firmware.html)
### 如何获取IP地址
Full版NanoKVM自带OLED显示屏联网之后会在显示屏第一行显示IP地址
@@ -45,37 +55,35 @@ Full版NanoKVM自带OLED显示屏联网之后会在显示屏第一行显示IP
Lite版用户在插入镜像卡启动后可在路由器/交换机后台查看IP。用户也可按照[LicheeRV NANO](https://wiki.sipeed.com/hardware/zh/lichee/RV_Nano/5_peripheral.html#usb-rndis-%E7%BD%91%E5%8F%A3)的联网方式登录到板子,使用`ifconfig`查看`eth0`的地址
## 浏览器查看远程桌面
### 更新应用,查看远程桌面
浏览器直接输入获取的IP进入登录页面默认账号密码为admin、admin陆后就可以看到远程桌面了
浏览器直接输入获取的IP进入登录页面默认账号密码为admin、admin录后请**先检查更新**(设置 -> 检查更新),详细步骤可参考[应用升级方法](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/4_firmware.html)。
Lite版用户或Full用户重新烧卡登录后页面上无远程画面请先升级应用后刷新网页即可开始使用
![](./../assets/NanoKVM/2_unbox/unbox_6.png)
## 如何进行远程装机
### 修改账号密码
Nano KVM的 USB-C 端口除模拟键鼠设备外还模拟了一个U盘设备挂载了TF卡内的一部分存储空间用于装机等需求该U盘默认格式化为exFAT格式Full版NanoKVM内置TF卡模拟出的U盘大小约21G。
**为保障您的信息安全,请在测试功能正常后修改账号密码**
首先用户需要下载待安装的镜像(通常以.iso结尾将NanoKVM USB-C 插入电脑直接将下载好的镜像复制到U盘内可复制多个系统即可拔出。
![](./../assets/NanoKVM/2_unbox/unbox_9.png)
按上述步骤连接远程主机与Nano KVM在浏览器登录系统后点击光盘图标选中待安装的系统
### 如何进行远程装机
![](./../assets/NanoKVM/2_unbox/unbox_7.png)
请参考[ISO镜像挂载](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/3_user_guide.html)
然后点击`开机(短按)`迅速按键盘上的F11键不同主机按键可能不同请参照主机说明选择对应的系统启动。
![](./../assets/NanoKVM/2_unbox/unbox_8.png)
注:
+ 虚拟U盘也可以当作普通U盘使用常规的烧卡方式烧录镜像。
## 如何在外网访问
Todo
## 串口使用
Todo
### ATX电源控制
Full 版套餐内包含了 NanoKVM-A/B 板,用于控制和查看主机开关机状态。
+ 顶板上的 5V LED蓝色指示 NanoKVM 的供电情况;
+ PWR LED绿色为主机的电源指示
+ POWER按键作用同主机的电源按键可以控制主机的开关机
+ RESET按键用主机的重启按键开机状态下按下RESET将强制重启主机
注意:部分主板 BIOS 可能默认设置为关机 USB 断电,为确保 NanoKVM 常供电,请在 AUX-Power 接口上额外供一路5V电源。NanoKVM功耗较小需5V/0.2A的供电,第一批内测版 AUX-Power 接口不带 CC 的下拉电阻,无法使用 C-C 的 PD 充电头供电,请使用常规 5V USB 电源适配器。

View File

@@ -1,12 +0,0 @@
---
title: Firmware
keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool
update:
- date: 2024-6-21
version: v0.1
author: BuGu
content:
- Release docs
---
## 镜像烧录与升级

View File

@@ -0,0 +1,124 @@
---
title: 用户指南
keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool
update:
- date: 2024-7-4
version: v0.1
author: BuGu
content:
- Release docs
---
## 管理页面功能
![](./../assets/NanoKVM/3_user_guide/user1.png)
悬浮栏从左到右依次为图像设置、屏幕键盘、鼠标样式、镜像挂载、KVM网页终端、开机按钮、电源/HDD状态指示、设置、全屏、隐藏悬浮栏。
### 分辨率、帧率、图像质量设置
+ NanoKVM 支持 1080P、720P、600P、480P 的图像传输,在图像设置->分辨率中可以选择不同的分辨率。越大的分辨率所占用带宽越大、实时帧率越小。
+ 注:此处仅修改图像的传输大小,不会改变 HDMI 输入的图像尺寸,如需修改,请前往主机系统的设置菜单进行设置。
+ 帧率设置选项用于修改传输的最大帧率可以限制网络带宽的占用但帧率越低画面越卡请根据网络情况合理配置。Full版用户在OLED上可看到视频的实时帧率。
+ 图像质量选项可以修改画面的压缩比例,当您认为画面较卡,延迟较高时,可以适当调低图像质量。
![](./../assets/NanoKVM/3_user_guide/user2.png)
### 虚拟键鼠使用
+ NanoKVM 的 USB 接口模拟出了键鼠设备。打开浏览器页面后,系统将自动捕获键鼠输入,并将操作实时同步到 NanoKVM 连接的主机。用户可以选择隐藏鼠标或改变在画面上显示的样式。
+ 对于不方便使用键盘的用户,我们提供了屏幕键盘,点击悬浮栏的键盘图标即可唤出屏幕键盘。
![](./../assets/NanoKVM/3_user_guide/user3.png)
### ISO镜像挂载
+ Nano KVM的 USB-C 端口除模拟键鼠设备外还模拟了一个U盘设备挂载了TF卡内的一部分存储空间用于装机等需求该U盘默认格式化为exFAT格式Full版NanoKVM内置TF卡模拟出的U盘大小约21G。
首先用户需要下载待安装的镜像(通常以.iso结尾将 NanoKVM USB-C 插入电脑直接将下载好的镜像复制到U盘内可复制多个系统即可拔出。
按上述步骤连接远程主机与Nano KVM在浏览器登录系统后点击光盘图标选中待安装的系统即可实现ISO挂载
![](./../assets/NanoKVM/2_unbox/unbox_7.png)
注:
+ 虚拟U盘也可以当作普通U盘使用常规的烧卡方式烧录镜像。
+ 镜像拷入 NanoKVM 的速度受到 USB2.0 传输速度和 SG2002 写卡速度的限制可能会比较慢用户可将TF卡取出插入电脑[解除隐藏](https://jingyan.baidu.com/article/e4511cf34faece2b845eaf34.html)TF卡的第三个分区直接将镜像拷入其中。
### 网页终端
+ 用户点击悬浮栏的`Terminal`图标即可打开网页终端无需ssh直接访问 NanoKVM 系统
+ 当 NanoKVM 断网重连或系统重启后,网页终端界面会提示重新登录,账号`root`,密码`root`
![](./../assets/NanoKVM/3_user_guide/user4.png)
### 电源灯HDD灯
+ 在悬浮栏右侧有电源和硬盘图标正常情况下是灰色状态开机后电源图标变绿。Full版的ATX控制板受延长线芯数限制只引出电源、重启按键和电源灯。Lite用户可根据原理图自行扩展。
### 设置
+ 切换中英文
+ 关于NanoKVM点击打开Wiki
+ 检查更新当有可用更新时用户可点击更新约10s左右OLED上将重新刷一遍KVM状态信息此时刷新网页即可更新完成。
### 更多功能敬请期待
## 网络延迟测算
主机连接KVM和一个普通屏幕播放秒表计时视频拍照捕捉远程桌面和显示屏计算差值即可估算网络延迟。
## 串口使用
NanoKVM 基于 LicheeRV Nano 构建RVNano 核心板共有3个串口UART0默认用于输出系统log在 NanoKVM Full 版中,引出了 UART1/2用户可自行拓展功能第一批内测版仅在外壳处开孔
![](./../assets/NanoKVM/1_intro/NanoKVM_2.jpg)
点击管理页面的`Terminal`打开网页终端
图标若需使用UART请先确保对应引脚 Pinmux 正确
``` shell
devmem 0x03001068 32 0x6 # GPIOA 18 UART1 RX
devmem 0x03001064 32 0x6 # GPIOA 19 UART1 TX
devmem 0x03001070 32 0x2 # GPIOA 28 UART2 TX
devmem 0x03001074 32 0x2 # GPIOA 29 UART2 RX
```
串口使用方法如下:
``` shell
stty -F /dev/ttyS1 115200 # 设置UART1波特率为115200
stty -F /dev/ttyS1 raw # 设置tty为RAW模式
echo -n UUU > /dev/ttyS1 # 发送 UUU(0x55 0x55 0x55)
hexdump -C /dev/ttyS1 # 以HEX格式显示收到的数据
```
## IPMI使用
Todo
## 外网远程访问
Todo
## WOLwake-on-lan
Todo
## 异常恢复
+ 登录浏览器界面后,无画面
1. 进入网页终端,执行 `/etc/init.d/S95webkvm restart` 重启服务。
2. 如果上述方式无法恢复正常,点击界面上的检查更新,更新应用
+ 更新过程中如果出现断网等异常情况,可能导致更新失败,若旧应用也无法启动时,请参照以下解决方法:
1. 使用 SSH 连接 NanoKVM如 `ssh root@192.168.1.2`,密码为 `root`
2. 执行 `rm -r /kvmapp && cp -r /root/old/ / && mv /old /kvmapp`
3. 执行 `reboot` 重启系统
+ 尝试断电重启解决未知问题
+ 若上述方法不能解决异常请在论坛或QQ群提出您的问题我们会耐心解答

View File

@@ -0,0 +1,29 @@
---
title: Firmware
keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool
update:
- date: 2024-6-21
version: v0.1
author: BuGu
content:
- Release docs
---
## 镜像烧录与升级
NanoKVM 有两种升级模式,一种是常规的应用升级,在浏览器操作即可;若功能涉及到底层镜像修改则需重新烧卡。
### 应用升级
在浏览器页面内点击设置->检查更新->立即更新
等待约10s后OLED重新刷出KVM状态信息刷新网页即可完成更新
### 镜像烧录
Lite版NanoKVM默认不带TF卡出货需要自行准备一张8G以上的TF卡Full版默认带一张32G TF卡超出8G的部分将自动创建exFAT分区用于虚拟U盘的挂载
Full版NanoKVM自带TF卡可上电即用如后续涉及到镜像升级同样可以参考以下描述
使用烧卡软件烧录TF卡这里建议使用[Etcher](https://etcher.balena.io/)进行烧录
镜像下载地址:https://github.com/sipeed/NanoKVM/releases/tag/NanoKVM

View File

@@ -9,4 +9,6 @@ update:
- Release docs
---
## Todo
* MaixHub 论坛https://maixhub.com/discussion/nanokvm
* GitHub https://github.com/sipeed/NanoKVM
* QQ group: 703230713

Binary file not shown.

After

Width:  |  Height:  |  Size: 174 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 263 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 299 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@@ -383,14 +383,16 @@ items:
items:
- label: Lichee Nano KVM
items:
- label: Introduction
- label: 简介
file: kvm/NanoKVM/1_intro.md
- label: Unboxing Experience
- label: 快速开始
file: kvm/NanoKVM/2_unbox.md
- label: Update Firmware
file: kvm/NanoKVM/3_firmware.md
- label: 用户指南
file: kvm/NanoKVM/3_user_guide.md
- label: 应用更新&固件烧录
file: kvm/NanoKVM/4_firmware.md
- label: FAQ
file: kvm/NanoKVM/4_faq.md
file: kvm/NanoKVM/5_faq.md
# - label: Maix Audio
# items:
# - label: MA USB 16