Improve NanoKVM Pro docs

This commit is contained in:
BuGu
2025-10-18 03:12:25 +08:00
parent db46b93c55
commit f178a6a6c2
6 changed files with 60 additions and 20 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

View File

@@ -193,20 +193,22 @@ curl -L -o nanokvm_pro_1.0.10.tar.gz https://cdn.sipeed.com/nanokvm/pro/pikvm_1.
sudo apt install ./*1.0.10*
```
## How to Use Serial Ports
## How to Use the Serial Port
NanoKVM Pro provides two available serial ports, UART1/UART2 (the ATX version does not expose them due to bracket specifications, retaining only internal pads).
NanoKVM Pro provides two sets of available serial ports: UART1/UART2. (Note: The ATX version, limited by the standard bracket size, does not have these ports externally exposed; only the internal solder pads are retained.)
* Connect to other serial terminal devices:
The interface definition diagram for the Desk version is as follows:
![](./../../../assets/NanoKVM/pro/extended/UART.png)
```shell
# Use UART1 at 115200 baud rate on the web terminal, exit with Ctrl+A+Q
picocom -b 115200 /dev/ttyS1
# Use UART2 at 115200 baud rate on the web terminal, exit with Ctrl+A+Q
# picocom -b 115200 /dev/ttyS2
```
- Using the Serial Terminal via the Web Interface
* Send serial commands only:
**Requires firmware version 1.1.5 or higher**
Navigate to: Web Menu Bar -> Terminal -> Serial Terminal. Here, you can configure the serial port number, baud rate, and other options.
![](./../../../assets/NanoKVM/pro/extended/UART-2.png)
- Send serial commands only:
```shell
# Set ttyS1 to 115200 baud rate

View File

@@ -7,6 +7,11 @@ update:
author: zepan
content:
- initial docs
- date: 2025-10-18
version: v0.2
author: bugu
content:
- improve docs
---
## Introduction
@@ -57,7 +62,10 @@ Currently, the USB secondary screen feature only supports Windows systems.
9. When re-enabling, some systems may require reinstalling the USB driver.
## Custom Display
The NanoKVM-Pro's small screen uses standard framebuffer drivers. Users can utilize `/dev/fb0` to implement custom screen display operations.
> Note: This feature requires the NanoKVM-Desk application to be updated to version `1.1.5` or higher.
NanoKVM Desk introduces a user-defined APP function in version `1.1.5`. By long-pressing the screen/knob and switching to the fourth page, you can view all APPs. Three demo apps are pre-installed by default: `coin`, `conway`, and `hello`.
[hello.py](../../../assets/NanoKVM/pro/lcd/hello.py)
[conway.py](../../../assets/NanoKVM/pro/lcd/conway.py)
@@ -71,4 +79,14 @@ The NanoKVM-Pro's small screen uses standard framebuffer drivers. Users can util
<div style="display: grid; grid-template-columns: 1fr 1fr; gap: 10px;">
<video playsinline controls muted preload src="../../../assets/NanoKVM/pro/lcd/pao.mp4"></video>
<video playsinline controls muted preload src="../../../assets/NanoKVM/pro/lcd/coin.mp4"></video>
</div>
</div>
### How to Build Your Own Application
NanoKVM Desk will search for all folders in the system's `/userapp` directory and use the folder names as APP names. It is recommended to keep folder names under 8 characters.
In the `User APP` interface, when you click on a user-defined application, the system will attempt to launch a Python application named `main.py` inside the corresponding folder.
At this point, the small screen uses the standard FB driver, allowing users to utilize `/dev/fb0` to implement custom screen display operations.
Clicking the screen or pressing the knob will exit the application.

View File

@@ -144,14 +144,16 @@ sudo apt install ./*1.0.10*
NanoKVM Pro 提供两组可用串口 UART1/UART2ATX版本受限挡板规范尺寸没有引出仅保留内部焊盘
- 外接其他串口终端设备
Desk 版本接口定义示意图如下:
![](./../../../assets/NanoKVM/pro/extended/UART.png)
```shell
# 网页终端使用 UART1 以 115200 波特率打开串口使用Ctrl+A+Q退出
picocom -b 115200 /dev/ttyS1
# 网页终端使用 UART2 以 115200 波特率打开串口使用Ctrl+A+Q退出
# picocom -b 115200 /dev/ttyS2
```
- 网页端使用串口终端
**需要更新至 1.1.5 版本以上**
网页菜单栏->终端->串口中断 可以设置串口号以及波特率等选项
![](./../../../assets/NanoKVM/pro/extended/UART-2.png)
- 仅发送串口指令

View File

@@ -7,6 +7,11 @@ update:
author: zepan
content:
- initial docs
- date: 2025-10-18
version: v0.2
author: bugu
content:
- improve docs
---
## 简介
@@ -55,7 +60,11 @@ NanoKVM-Pro工作时就是虚拟为显示器所以可以采集HDMI图像并
## 自定义显示
NanoKVM-Pro的小屏使用标准FB驱动用户可以使用/dev/fb0来实现自定义的屏幕显示操作。
> 注:此功能需要 NanoKVM-Desk 更新至 `1.1.5` 以及以上的应用版本
NanoKVM Desk 在`1.1.5` 版本中新增了用户自定义APP功能通过长按屏幕/旋钮切换到第四页面可以看到所有的APP默认预装三个Demo`coin``conway``hello`
[hello.py](../../../assets/NanoKVM/pro/lcd/hello.py)
[conway.py](../../../assets/NanoKVM/pro/lcd/conway.py)
[coin.py](../../../assets/NanoKVM/pro/lcd/coin.py)
@@ -70,4 +79,13 @@ NanoKVM-Pro的小屏使用标准FB驱动用户可以使用/dev/fb0来实现
<video playsinline controls muted preload src="../../../assets/NanoKVM/pro/lcd/coin.mp4"></video>
</div>
### 如何构建自己的应用
NanoKVM Desk 会在系统 `/userapp` 目录下查找所有的文件夹并将文件夹名称作为APP名称建议文件夹名小于8个字符
`User APP` 界面下点击用户自定义用户程序后将会尝试启动文件夹内名为 `main.py` 的 Python 应用
此时小屏使用标准FB驱动用户可以使用 `/dev/fb0` 来实现自定义的屏幕显示操作。
点击屏幕或按下旋钮将退出应用