Merge pull request #711 from Z2Z-GuGu/main

Update KVM Docs
sipeed · Sep 10, 2024 · d91b51a · d91b51a
2 parents 3ec61aa + 91f67f1
commit d91b51a
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 33 deletions.
diff --git a/docs/hardware/en/kvm/NanoKVM/introduction.md b/docs/hardware/en/kvm/NanoKVM/introduction.md
@@ -20,7 +20,7 @@ update:
 
 The Lichee NanoKVM is an IP-KVM product based on the LicheeRV Nano, inheriting its compact size and powerful features.
 
-NanoKVM includes an HDMI input interface that can be recognized as a monitor by a computer, capturing the computer's screen. It has a USB 2.0 interface to connect to the computer host, recognized as HID devices like keyboard, mouse, and touchpad, and uses extra storage space on the TF card, mounted as a USB flash drive. It comes with a 100 Mbps Ethernet port for video and control signal transmission. Additionally, the Full version features an ATX power control interface (USB-C form) for remote control and monitoring of the host's power status. Under the Full version's shell, there is an OLED display for showing the device's IP and KVM-related status.
+NanoKVM includes an HDMI input interface that can be recognized as a monitor by a computer, capturing the computer's screen. It has a USB 2.0 interface to connect to the computer host, recognized as HID devices like keyboard, mouse, and touchpad, and uses extra storage space on the Micro SD card, mounted as a USB flash drive. It comes with a 100 Mbps Ethernet port for video and control signal transmission. Additionally, the Full version features an ATX power control interface (USB-C form) for remote control and monitoring of the host's power status. Under the Full version's shell, there is an OLED display for showing the device's IP and KVM-related status.
 
 To meet different user needs, NanoKVM is available in two versions:
 - **NanoKVM Lite**: Basic version suitable for DIY enthusiasts and enterprises with bulk requirements.
@@ -39,31 +39,30 @@ To meet different user needs, NanoKVM is available in two versions:
 
 ## Specifications
 
-| Product                     | NanoKVM (Lite)                      | NanoKVM (Full)                                  | PiKVM V4                        |
-| --------------------------- | ----------------------------------- | ----------------------------------------------- | ------------------------------- |
-| Computing Unit              | LicheeRV Nano (RISCV)               | LicheeRV Nano (RISCV)                           | CM4 (ARM)                       |
-| Resolution                  | 1080P @ 60fps                       | 1080P @ 60fps                                   | 1080P, 1200P @ 60fps            |
-| Video Encoding              | MJPEG, H264 (WIP)                   | MJPEG, H264 (WIP)                               | MJPEG, H264                     |
-| Video Latency               | 90-230ms                            | 90-230ms                                        | 100-230ms                       |
-| UEFI/BIOS                   | ✓                                   | ✓                                               | ✓                               |
-| Emulated USB Keyboard/Mouse | ✓                                   | ✓                                               | ✓                               |
-| Emulated USB Storage        | ✓                                   | ✓                                               | ✓                               |
-| IPMI                        | ✓                                   | ✓                                               | ✓                               |
-| Wake-on-LAN                 | ✓                                   | ✓                                               | ✓                               |
-| Tailscale                   | ✓                                   | ✓                                               | ✓                               |
-| WebSSH                      | ✓                                   | ✓                                               | ✓                               |
-| Custom Scripts              | ✓                                   | ✓                                               | ✓                               |
-| RTC                         | -                                   | -                                               | ✓                               |
-| Ethernet                    | 10/100MbE                           | 10/100MbE                                       | 10/100/1GbE                     |
-| ATX Power Control           | None, user-configurable             | USB interface IO control board                  | RJ45 interface IO control board |
-| OLED Display                | None, user-expandable               | 128x64 0.96" white                              | 128x32 0.91" white              |
-| Serial Terminal             | 2 channels                          | 2 channels                                      | 1 channel                       |
-| TF Card                     | None, user-provided                 | Included, ready to use                          | Included                        |
-| Expansion Accessories       | None                                | WiFi or PoE                                     | WiFi/LTE, PoE                   |
-| Power Consumption           | 0.2A@5V                             | 0.2A@5V                                         | Peak 2.6A@5V                    |
-| Power Input                 | Powered by PC USB                   | Powered by PC USB <br> Supports auxiliary power | Requires DC 5V 3A               |
-| Cooling                     | Silent, fanless                     | Silent, fanless                                 | Requires active fan cooling     |
-| Dimensions                  | 23x37x15mm <br> ~1/30 PiKVM V4 size | 40x36x36mm <br> ~1/7 PiKVM V4 size              | 120x68x44mm                     |
+| Product | NanoKVM (Lite) | NanoKVM (Full) | PiKVM V4 |
+| --- | --- | --- | --- |
+| Computing Unit | LicheeRV Nano (RISCV) | LicheeRV Nano (RISCV) | CM4 (ARM) |
+| Resolution | 1080P @ 60fps | 1080P @ 60fps | 1080P @ 60fps |
+| Video Encoding | MJPEG, H264 (WIP) | MJPEG, H264 (WIP) | MJPEG, H264 |
+| Video Latency | 90-230ms | 90-230ms | 100-230ms |
+| UEFI/BIOS | ✓ | ✓ | ✓ |
+| Emulated USB Keyboard/Mouse | ✓ | ✓ | ✓ |
+| Emulated USB Storage | ✓ | ✓ | ✓ |
+| IPMI | ✓ | ✓ | ✓ |
+| Wake-on-LAN | ✓ | ✓ | ✓ |
+| Tailscale | ✓ | ✓ | ✓ |
+| WebSSH | ✓ | ✓ | ✓ |
+| Custom Scripts | ✓ | ✓ | - |
+| ETH | 100M/10M | 100M/10M | 1000M/100M/10M |
+| ATX Power Control | None, user-configurable | USB interface IO control board | RJ45 interface IO control board |
+| OLED Display | None, user-expandable | 128x64 0.96" white | 128x32 0.91" white |
+| Serial Terminal | 2 channels | 2 channels | - |
+| Micro SD Card | None, user-provided | Included, ready to use | Included |
+| Expansion Accessories | None | WiFi or PoE | WiFi/LTE |
+| Power Consumption | 0.2A@5V | 0.2A@5V | Peak 2.6A@5V |
+| Power Input | Powered by PC USB | Powered by PC USB <br> Supports auxiliary power | Requires DC 5V 3A |
+| Cooling | Silent, fanless | Silent, fanless | Requires active fan cooling |
+| Dimensions | 23x37x15mm <br> ~1/30 PiKVM V4 size | 40x36x36mm <br> ~1/7 PiKVM V4 size | 120x68x44mm |
 
 ## NanoKVM Hardware and Software Resources
 
@@ -80,7 +79,7 @@ NanoKVM Lite consists of the LicheeRV Nano E and HDMItoCSI board, while NanoKVM
 ## Purchase Links
 
 [Official Taobao Store](https://item.taobao.com/item.htm?id=811206560480)
-[AliExpress Store]()
+[AliExpress Store](https://www.aliexpress.com/item/1005007369816019.html)
 [Pre-sale Page](https://sipeed.com/nanokvm)
 
 ## Product Feedback
@@ -89,4 +88,4 @@ If you encounter any issues or have suggestions, please contact us through the f
 
 + [Github Issues](https://github.com/sipeed/NanoKVM)
 + [MaixHub Forum](https://maixhub.com/discussion/nanokvm)
-+ QQ Group: 703230713
++ QQ Group: 703230713
diff --git a/docs/hardware/en/kvm/NanoKVM/quick_start.md b/docs/hardware/en/kvm/NanoKVM/quick_start.md
@@ -23,7 +23,7 @@ The Full version includes NanoKVM (with case, with card), KVM-B board, 2 USB A t
 
 ![](./../../../assets/NanoKVM/unbox/lite_ubox.png)
 
-The Lite version includes NanoKVM (without case and TF card) and a heatsink.
+The Lite version includes NanoKVM (without case and Micro SD card) and a heatsink.
 
 ## Interface Introduction
 
@@ -65,6 +65,8 @@ The wiring diagram for the NanoKVM-Full version is as follows. The Lite version
 
   ![](./../../../assets/NanoKVM/unbox/new-ATX-B.png)
 
+  > Note: The KVM-B board with version number 30132 cannot be directly connected to the pin header on the board with the built-in 9-pin bus header of the chassis, and must be connected with the included male to female cable according to the figure above.
+
   The wiring diagram for the internal test version of the KVM-B board and the host's 9-pin interface is shown below. The double-row headers are interconnected, allowing the connection of the case's power button and Power LED to the other row.
 
   ![](./../../../assets/NanoKVM/unbox/old-ATX-B.png)
@@ -74,7 +76,7 @@ The wiring diagram for the NanoKVM-Full version is as follows. The Lite version
 
 ### Update Image
 
-> **The Lite version requires preparing a TF card and flashing the image before use!**
+> **The Lite version requires preparing a Micro SD card and flashing the image before use!**
 
 The Full version comes with a pre-flashed image and can skip this step.
 

diff --git a/docs/hardware/en/kvm/NanoKVM/user_guide.md b/docs/hardware/en/kvm/NanoKVM/user_guide.md
@@ -68,10 +68,12 @@ Next, start the installation process by clicking `Power On (Short Press)` and qu
 Note:
 
 + The virtual USB drive feature is enabled by default. If not needed, it can be disabled by clicking `Settings` -> `Virtual USB Drive`.
++ Please eject the original 21G virtual USB flash drive on the host before mounting the image to avoid data loss.
 + The virtual USB drive can also be used as a regular USB drive. If no image is selected in the web interface, the entire 21GB virtual USB drive will be mounted by default.
 + Users can also use the conventional card burning method to burn images, though it's not recommended.
 + The speed of copying images to NanoKVM is limited by USB2.0 transfer speed and SG2002 card writing speed, which may be slow. Users can remove the TF card, insert it into the computer, [unlock the hidden](https://jingyan.baidu.com/article/e4511cf34faece2b845eaf34.html) third partition of the TF card, and directly copy the images into it.
 + The virtual USB drive is also mounted to the `/data` directory of NanoKVM, allowing users to read and write to this partition directly from the NanoKVM terminal.
++ Canceling the virtual USB flash drive operation in the settings will force the USB flash drive to eject the USB flash drive, please eject the USB flash drive safely before setting it up to avoid data loss.
 
 ### Web Terminal
 
@@ -188,4 +190,6 @@ For further assistance and support, visit the NanoKVM [official website](https:/
 
 ---
 
+> Note: The TF card described in this article is a microSD card
+
 End of User Guide.
diff --git a/docs/hardware/zh/kvm/NanoKVM/introduction.md b/docs/hardware/zh/kvm/NanoKVM/introduction.md
@@ -54,10 +54,11 @@ NanoKVM Full 为完整版配置，带精致外壳和完整配件，内置开机
 | Tailscale | ✓ | ✓ | ✓ |
 | WebSSH | ✓ | ✓ | ✓ |
 | 自定义脚本 | ✓ | ✓ | - |
+| ETH | 100M/10M | 100M/10M | 1000M/100M/10M |
 | ATX电源控制 | 无，用户可自行连接 | USB接口IO控制板 | RJ45接口IO控制板 |
 | OLED显示 | 无，用户可自行扩展 | 128x64 0.96" white | 128x32 0.91" white |
 | 串口终端 | 2路 | 2路 | - |
-| TF卡 | 无，用户自备 | 有，开机即用 | 有 |
+| Micro SD卡 | 无，用户自备 | 有，开机即用 | 有 |
 | 扩展配件 | 无 | WiFi 或 PoE | WiFi/LTE |
 | 功耗 | 0.2A@5V | 0.2A@5V | Peak 2.6A@5V |
 | 电源输入 | PC USB即可供电 | PC USB即可供电 <br> 也支持额外辅助供电 | 需要DC 5V 3A供电 |
@@ -80,7 +81,7 @@ NanoKVM Lite 由 LicheeRV Nano E 和 HDMItoCSI 小板构成，NanoKVM FULL 在 N
 ## 购买入口
 
 [淘宝官方购买地址](https://item.taobao.com/item.htm?id=811206560480)
-[速卖通购买地址]()
+[速卖通购买地址](https://www.aliexpress.com/item/1005007369816019.html)
 [预售页面](https://sipeed.com/nanokvm)
 
 ## 产品反馈

diff --git a/docs/hardware/zh/kvm/NanoKVM/quick_start.md b/docs/hardware/zh/kvm/NanoKVM/quick_start.md
@@ -65,10 +65,12 @@ NanoKVM-Full版接口示意图如下，Lite版仅包含 USB-C、HDMI和网口，
 
   ![](./../../../assets/NanoKVM/unbox/new-ATX-B.png)
 
+  > 注:版本号为30132的KVM-B板不能用机箱自带9-Pin排母直接连接板上的排针,需按照上图使用附赠的公对母排线连接
+
   内测版KVM-B板与主机9针接口连线如下图，双排排针上下联通，另一排可连接机箱的开机按键、Power LED 等接口
 
   ![](./../../../assets/NanoKVM/unbox/old-ATX-B.png)
-  ![](./../../../assets/NanoKVM/unbox/old-ATX-B-w.png)
+  ![](./../../../assets/NanoKVM/unbox/old-ATX-B-w.png)  
 
 ## 更新
 

diff --git a/docs/hardware/zh/kvm/NanoKVM/user_guide.md b/docs/hardware/zh/kvm/NanoKVM/user_guide.md
@@ -68,10 +68,12 @@ update:
 注：
 
 + 虚拟U盘功能默认打开，如果不需要可通过点击`设置`->`虚拟U盘`关闭。
++ 请先在主机上安全弹出原有的21G虚拟U盘后再挂载镜像,以免数据丢失
 + 虚拟U盘也可以当作普通U盘使用，web界面未选中任何镜像时，默认挂载整个21G的虚拟U盘。
 + 用户也可使用常规的烧卡方式烧录镜像，不推荐
 + 镜像拷入 NanoKVM 的速度受到 USB2.0 传输速度和 SG2002 写卡速度的限制，可能会比较慢，用户可将TF卡取出，插入电脑，[解除隐藏](https://jingyan.baidu.com/article/e4511cf34faece2b845eaf34.html)TF卡的第三个分区，直接将镜像拷入其中。
 + 虚拟U盘同时挂载到NanoKVM的 `/data` 目录，用户可在 NanoKVM 终端内直接读写该分区
++ 设置中的取消虚拟U盘操作将强制弹出U盘,请先安全弹出U盘后再设置,以免数据丢失
 
 ### 网页终端