Add NanoKVM logo customization

This commit is contained in:
BuGu
2026-03-27 15:26:13 +08:00
parent 1b451157f9
commit cc7cf5761f
4 changed files with 76 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

View File

@@ -16,6 +16,44 @@ update:
In addition to implementing KVM functionality, NanoKVM has opened up some data for secondary development by users. This document describes the purpose of this data and the considerations for development.
## Customizing Logo
> Note: This feature is supported in NanoKVM application versions `v2.3.6` and above.
NanoKVM supports custom logo display, which can be shown simultaneously on the OLED screen and the Web management interface. The OLED screen displays low-resolution monochrome binary images, while the Web interface displays high-resolution color images.
### Step 1: Generate Logo File
![](../../../assets/NanoKVM/guide/logo1.png)
1. Download the [Logo Generation Python Script](https://github.com/sipeed/NanoKVM/tree/main/tools/logo_generator)
2. Install dependencies:
```bash
pip install Pillow numpy textual
```
3. Prepare a logo image that is close to square and obtain its file path
4. Execute the script to generate the logo file:
```bash
python logo_generator.py /path/to/your_logo.png
```
5. Select the display language (currently only Chinese and English are supported)
6. The terminal interface will display the OLED simulation effect. Adjust the contrast to achieve the desired display effect
7. Fine-tune: Click "Invert" to generate a white-background logo, or click "Pixel" to control individual pixel states
8. Click the "Export" button to generate `logo.bin` and `logo.ico` files in the current directory; click "Exit" after completion
### Step 2: Upload Logo File
1. Upload the `logo.bin` and `logo.ico` files to the `/boot` directory of NanoKVM:
- Using SCP command:
```bash
scp logo.bin logo.ico root@xxx.xxx.xxx.xxx:/boot
```
The default login password is `root`. If you have modified the Web management interface password, please use the modified password for authentication.
- Alternatively, via TF card: Copy the files to the `boot` partition of the TF card, and NanoKVM will automatically read them during boot
2. Reboot the NanoKVM device for the changes to take effect
![](../../../assets/NanoKVM/guide/logo2.jpg)
## Obtaining Streaming Related Data
Streaming and image parameters are located in the `/kvmapp/kvm` folder.

View File

@@ -16,6 +16,44 @@ update:
NanoKVM除实现KVM功能外还开放了一些数据,用于用户的二次开发,此文档用于描述这些数据的作用,以及开发的注意事项
## 更换 Logo
> 注:此功能仅在 NanoKVM `v2.3.6` 及以上版本的应用程序中支持。
NanoKVM 支持自定义 Logo 显示,可在 OLED 屏幕和 Web 管理界面中同时展示。其中OLED 屏幕显示低分辨率的黑白二值图像Web 界面显示高分辨率的彩色图像。
### 步骤一:生成 Logo 文件
![](../../../assets/NanoKVM/guide/logo1.png)
1. 下载 [Logo 生成 Python 脚本](https://github.com/sipeed/NanoKVM/tree/main/tools/logo_generator)
2. 安装依赖库:
```bash
pip install Pillow numpy textual
```
3. 准备一张接近正方形的 Logo 图片,并获取其文件路径
4. 执行脚本生成 Logo 文件:
```bash
python logo_generator.py /path/to/your_logo.png
```
5. 选择显示语言(当前仅支持中文和英文)
6. 终端界面将显示 OLED 模拟效果,可通过调整对比度使显示效果符合预期
7. 进行微调:点击"反转"可生成白底 Logo点击"像素"可单独控制每个像素点的亮灭状态
8. 点击"导出"按钮,将在当前目录下生成 `logo.bin` 和 `logo.ico` 两个文件;完成后点击"退出"
### 步骤二:上传 Logo 文件
1. 将 `logo.bin` 和 `logo.ico` 文件上传至 NanoKVM 的 `/boot` 目录:
- 通过 SCP 命令上传:
```bash
scp logo.bin logo.ico root@xxx.xxx.xxx.xxx:/boot
```
默认登录密码为 `root`。如已修改 Web 管理界面密码,请使用修改后的密码进行认证。
- 或通过 TF 卡方式:将文件复制到 TF 卡的 `boot` 分区NanoKVM 开机时将自动读取
2. 重启 NanoKVM 设备,使配置生效
![](../../../assets/NanoKVM/guide/logo2.jpg)
## 获取推流相关数据
推流和图像参数位于/kvmapp/kvm文件夹下