diff --git a/README.md b/README.md index 2a4e135..1935768 100644 --- a/README.md +++ b/README.md @@ -6,42 +6,77 @@ NanoKVM ![](https://wiki.sipeed.com/hardware/assets/NanoKVM/introduce/NanoKVM_3.png)

- Quick Start - | - Hardware + 🚀 Quick Start + | + 🛠️ Hardware Details + | + 💾 Firmware Releases

English | [中文](./README_ZH.md) | [日本語](./README_JA.md) -> Your NanoKVM is powered by [RISC-V](https://en.wikipedia.org/wiki/RISC-V)! -> If you have any issues or suggestions, creating issue here, or tell us with [MaixHub Discussion](https://maixhub.com/discussion/nanokvm). +## 🌟 What is NanoKVM? -## Introduction +NanoKVM is a series of compact, open-source IP-KVM devices. Built upon the LicheeRV Nano (RISC-V), NanoKVM allows you to remotely access and control computers as if you were sitting right in front of them – perfect for managing servers, embedded systems, or any headless machine. -Lichee NanoKVM is an IP-KVM product based on LicheeRV Nano, inheriting the extreme size and powerful features of LicheeRV Nano. +## 📦 Product Family -The Lichee NanoKVM is now available in three versions: +We offer several NanoKVM versions to suit your needs: -* NanoKVM-Cube Lite is a basic configuration that is suitable for individual users with certain DIY capabilities and enterprise users with bulk requirements. +* **NanoKVM-Cube Lite:** A barebones kit for DIY enthusiasts and enterprise users needing bulk deployment. +* **NanoKVM-Cube Full:** A complete package with a sleek case, accessories, and a pre-flashed system SD card. Ready to use out-of-the-box, ideal for individual users. +* **NanoKVM-PCIe:** A unique form factor with a PCIe bracket for internal chassis mounting, drawing power directly from a PCIe slot. And add optional WiFi and PoE functions. -* NanoKVM-Cube Full is a full version with a sophisticated case and complete accessories, as well as a built-in system mirror card that is ready to use at boot, and is recommended for individual users. +### 🚀 NanoKVM-Pro: The 4K Powerhouse -* NanoKVM-PCle is a new form with a built-in PCle baffle that can be fixed inside the chassis. NanoKVM-PCle adds optional WiFi and PoE functions based on NanoKVM-Cube; it has its own PCle slot and can draw power from the motherboard PCle slot; in addition, the wired connection (ETH) is also more stable, meeting more professional needs. +Based on popular demand, we've upgraded NanoKVM to the **NanoKVM-Pro**: + +* **Resolution Upgrade:** From 1080P to stunning **4K@30fps / 2K@60fps**. +* **Network Upgrade:** Blazing fast **GbE + PoE + WiFi 6** (up from 100M Ethernet). +* **Latency Upgrade:** Encoder accelerated latency reduced from 100-150ms to **50-100ms**. + +> The NanoKVM-Pro is now available for pre-sale! [Click here for product details](https://sipeed.com/nanokvm/pro).
-![NanoKVM-Cube](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_1.jpg) - -![NanoKVM-PCIe](https://wiki.sipeed.com/hardware/assets/NanoKVM/introduce/NanoKVM-PCIe.png) +![NanoKVM Product Family](https://cdn.sipeed.com/public/nanokvm-products.jpg)
-> For users concerned about security, you can read this issue: [#301](https://github.com/sipeed/NanoKVM/issues/301). You will find explanations addressing all security concerns. -> GitHub, as an open and transparent platform, provides a space for discussing so-called "backdoor" concerns. Open-source makes products more secure! +## 🛠️ Technical Specifications -## Project Structure +| Product | NanoKVM-Pro | NanoKVM (Cube/PCIe) | GxxKVM | JxxKVM | +|------------------- |-------------------------------------- |---------------------------------- |----------------------------------- |------------------------------------ | +| Core | AX631 2xA53 1.5G | SG2002 1xC906 1.0G | RV1126 4xA7 1.5G | RV1106 1xA7 1.2G | +| Memory & Storage | 1G LPDDR4X + 32G eMMC | 256M DDR3 + 32G microSD | 1G DDR3 + 8G eMMc | 256M DDR3 + 16G eMMC | +| System | NanoKVM / PiKVM | NanoKVM | GxxKVM | JxxKVM | +| Resolution | 4K@30fps / 2K@60fps | 1080P@60fps | 4K@30fps / 2K@60fps | 1080P@60fps | +| HDMI Loopout | 4K loopout | x | x | x | +| Video Encoding | MJPEG / H.264 / H.265 | MJPEG / H264 | MJPEG / H264 | MJPEG / H264 | +| Audio Transmit | ✓ | x | ✓ | x | +| UEFI / BIOS | ✓ | ✓ | ✓ | ✓ | +| Emulated USB Keyboard & Mouse | ✓ | ✓ | ✓ | ✓ | +| Emulated USB ISO | ✓ | ✓ | ✓ | ✓ | +| IPMI | ✓ | ✓ | ✓ | x | +| Wake-on-LAN | ✓ | ✓ | ✓ | ✓ | +| Web Terminal | ✓ | ✓ | ✓ | ✓ | +| Serial Terminal | 3 channels | 2 channels | x | 1 channel | +| Custom Scripts | ✓ | ✓ | x | x | +| Storage | 32G eMMC 300MB/s | 32G MicroSD 12MB/s | 8G eMMC 120MB/s | 8G eMMC 60MB/s | +| Ethernet | 1000M | 100M | 1000M | 100M | +| PoE | Optional | Optional | x | x | +| WiFi | Optional WiFi6 | Optional WiFi6 | x | x | +| ATX Power Control | ✓ | ✓ | Extra $15 | Extra $10 | +| Display | 1.47" 320x172 LCD / 0.96" 128x64 OLED | 0.96" 128x64 OLED | - | 1.68" 280x240 | +| More Features | Sync LED Strip / Smart Assistant | - | - | - | +| Power Consumption | 0.4A@5V | 0.2A@5V | 0.4A@5V | 0.2A@5V | +| Power Input | USB-C or PoE | USB-C | USB-C | USB-C | +| Dimensions | 65x65x26mm | 40x36x36mm | 80x60x17.5mm | 60x43x(24~31)mm | +| Price | ~~$79~~ $69 ATX / ~~$89~~ $79 Desk | $25 Lite / $50 Full(with ATX) | $89 no ATX / $102 with ATX | $69 no ATX / $79 with ATX | + +## 📂 Project Structure ``` shell ├── kvmapp # APP update package @@ -58,33 +93,7 @@ The Lichee NanoKVM is now available in three versions: ├── ... ``` -## Tech Specs - -| Products | NanoKVM (Lite) | NanoKVM (Full) | PiKVM V4 | -|------------------- |-------------------------------------- |---------------------------------- |----------------------------------- | -| Compute Units | LicheeRV Nano(RISCV) | LicheeRV Nano(RISCV) | CM4 (ARM) | -| Resolution | 1080P @ 60fps | 1080P @ 60fps | 1080P @ 60fps | -| Video encoding | MJPEG, H264 | MJPEG, H264 | MJPEG, H264 | -| Video delay | 90~230ms | 90~230ms | 100~230ms | -| UEFI/BIOS | ✓ | ✓ | ✓ | -| Virtual HID | ✓ | ✓ | ✓ | -| Virtual CD-ROM | ✓ | ✓ | ✓ | -| IPMI | ✓ | ✓ | ✓ | -| Wake-on-LAN | ✓ | ✓ | ✓ | -| ETH | 100M/10M | 100M/10M | 1000M/100M/10M | -| ATX power control | None,Users can connect by their own | USB interface IO control board | RJ-45 interface IO control board | -| OLED | None,Users can connect by their own | 128x64 0.96" white | 128x32 0.91" white | -| UART | 2 | 2 | 1 | -| TF Card | None | ✓ | ✓ | -| Expansion | None | PoE | WiFi/LTE | -| Power consumption | 0.2A@5V | 0.2A@5V | Peak 2.6A@5V | -| Power input | PC USB can be powered | PC USB or auxiliary power supply | DC 5V 3A power supply is required | -| Cooling | Silent fanless | Silent fanless | Fan cooling | -| Size | 23x37x15mm ~1/30 PiKVM V4 size | 40x36x36mm ~1/7 PiKVM V4 size | 120x68x44mm | - -![NanoKVM PCB Pinout](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_2.jpg) - -## Hardware platform NanoKVM +## 🔩 Hardware Platform (NanoKVM Cube/PCIe) NanoKVM is based on Sipeed [LicheeRV Nano](https://wiki.sipeed.com/hardware/zh/lichee/RV_Nano/1_intro.html),you can find specifications, schematics, and dimensional drawings [here](http://cn.dl.sipeed.com/shareURL/LICHEE/LicheeRV_Nano). @@ -98,58 +107,33 @@ Note: Out of the 256MB memory in SG2002, 158MB is currently allocated for the mu * [NanoKVM-B Schematic](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_RV_Nano_KVM_B_30131.pdf) * [NanoKVM img](https://github.com/sipeed/NanoKVM/releases/tag/NanoKVM) -## Roadmap +![NanoKVM PCB Pinout](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_2.jpg) -**Enhancements:** +## 🤝 Contributing -* [x] Refactor the HDMI module and remove the libmaixcam_lib.so dependency -* [x] Disable SSH by default and add an enable/disable toggle in the web UI -* [x] Disable Tailscale by default and add an enable/disable toggle in the web UI -* [x] Add JWT configuration options to the configuration file -* [x] Secure password storage with bcrypt +We welcome contributions! Here's how you can help: -**Distribution:** +1. Fork the repository. +2. Create a feature branch. +3. Commit your changes. +4. Push to the branch. +5. Open a Pull Request. -* [x] Distribute applications via GitHub -* [x] Implement integrity checks for online updates -* [ ] Support offline updates +Please keep your pull requests small and focused to facilitate easier review and merging. -**Bug Fixes:** +> 🎁 **Contributors who submit high-quality Pull Requests may receive a NanoKVM Cube, PCIe, or Pro as a token of our appreciation!** -* [x] Fix the DNS issue -* [x] Fix the CSRF vulnerability - -**Features** - -* [ ] [79](https://github.com/sipeed/NanoKVM/issues/79) Support Zerotier -* [ ] [99](https://github.com/sipeed/NanoKVM/issues/99) Support WireGuard -* [ ] [249](https://github.com/sipeed/NanoKVM/issues/249) Add Mouse Jiggler - -## Contributing - -1. Fork the repository -2. Create a feature branch -3. Commit your changes -4. Push to the branch -5. Create a Pull Request - -Thanks for your interest in contributing to NanoKVM! - -Please keep your pull requests small and focused. This will make it easier to review and merge. - -> Developers who have contributed high-quality Pull Requests will receive a NanoKVM Cube, PCIe, or Pro as a token of our appreciation. - -## Where to buy +## 🛒 Where to Buy * [Aliexpress(global except USA&Russia)](https://www.aliexpress.com/item/1005007369816019.html) * [淘宝](https://item.taobao.com/item.htm?id=811206560480) -* [Preorder (anyother country that not support in Aliexpress or Taobao)](https://sipeed.com/nanokvm) +* [Preorder (any other country that not support in Aliexpress or Taobao)](https://sipeed.com/nanokvm) -## Community +## 💬 Community & Support * [MaixHub Discussion](https://maixhub.com/discussion/nanokvm) * QQ group: 703230713 -## License +## 📜 License This project is licensed under the GPL-3.0 License - see the LICENSE file for details. diff --git a/README_ZH.md b/README_ZH.md index c2e2ad1..48a73e8 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -6,39 +6,77 @@ NanoKVM ![](https://wiki.sipeed.com/hardware/assets/NanoKVM/introduce/NanoKVM_3.png)

- Quick Start - | - Hardware + 🚀 快速开始 + | + 🛠️ 硬件信息 + | + 💾 固件发布

[English](./README.md) | 中文 | [日本語](./README_JA.md) -> Your NanoKVM Power by RISC-V ! -> 如果您在使用过程中有任何问题或建议,请在这里提交 issue, 或在 [MaixHub Discussion](https://maixhub.com/discussion/nanokvm)告诉我们. +## 🌟 NanoKVM 是什么? -## 简介 +NanoKVM 是一系列紧凑型开源 IP-KVM 设备。NanoKVM 基于 LicheeRV Nano (RISC-V) 构建,让您能够身临其境般的远程访问和控制计算机,是管理服务器、嵌入式系统或任何无头设备的理想之选。 -Lichee NanoKVM 是基于 LicheeRV Nano 的 IP-KVM 产品,继承了 LicheeRV Nano的极致体积 和 强大功能。 +## 📦 产品系列 -Lichee NanoKVM 目前有三个版本: +我们提供多种 NanoKVM 版本以满足您的需求: -* NanoKVM-Cube Lite 为基础版配置,适合 具有一定DIY能力的个人用户 和 有批量需求的企业用户。 -* NanoKVM-Cube Full 为完整版配置,带精致外壳和完整配件,内置开机即用的系统镜像卡,推荐个人用户购买。 -* NanoKVM-PCle 为全新形态,内置 PCle 挡板,可固定在机箱内部。NanoKVM-PCle 在 NanoKVM-Cube 基础上增加了可选的 WiFi 和 PoE 功能;拥有自家的 PCle 插槽,可从主板 PCle 插槽取电;另外有线连接(ETH)也更加稳定,满足更多专业需求。 +* **NanoKVM-Cube Lite**:为 DIY 爱好者和需要批量部署的企业用户提供的准系统套件。 +* **NanoKVM-Cube Full**:包含外壳、配件以及预装系统 SD 卡的完整套装。开箱即用,非常适合个人用户。 +* **NanoKVM-PCIe**:独特的外形设计,配备 PCIe 支架,可安装在机箱内部,并直接从 PCIe 插槽供电。可选配 WiFi 和 PoE 功能。 + +### 🚀 NanoKVM-Pro + +根据大众的需求,我们将 NanoKVM 升级到了 **NanoKVM-Pro**: + +* **分辨率升级**:从 1080P 升级到 **4K@30fps / 2K@60fps**。 +* **网络升级**:从百兆网口升级到超快的 **GbE + WiFi 6**。 +* **延迟升级**:编码器加速延迟从 100-150 毫秒减少到 **50-100 毫秒**。 + +> NanoKVM-Pro 现已开启预售![点击此处查看产品详情](https://sipeed.com/nanokvm/pro)。
-![NanoKVM-Cube](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_1.jpg) - -![NanoKVM-PCIe](https://wiki.sipeed.com/hardware/assets/NanoKVM/introduce/NanoKVM-PCIe.png) +![NanoKVM Product Family](https://cdn.sipeed.com/public/nanokvm-products.jpg)
-> 对于关注安全的用户,可以阅读此问题 [#301](https://github.com/sipeed/NanoKVM/issues/301),您会找到有关所有安全问题的解释。GitHub 作为一个开放和透明的平台,为讨论所谓的“后门”担忧提供了空间。开源使产品更加安全! +## 🛠️ 技术规格 -## 项目结构 +| 产品 | NanoKVM-Pro | NanoKVM (Cube/PCIe) | GxxKVM | JxxKVM | +|------------------- |-------------------------------------- |---------------------------------- |----------------------------------- |------------------------------------ | +| 核心 | AX631 2xA53 1.5G | SG2002 1xC906 1.0G | RV1126 4xA7 1.5G | RV1106 1xA7 1.2G | +| 内存&存储 | 1G LPDDR4X + 32G eMMC | 256M DDR3 + 32G microSD | 1G DDR3 + 8G eMMc | 256M DDR3 + 16G eMMC | +| 系统 | NanoKVM / PiKVM | NanoKVM | GxxKVM | JxxKVM | +| 分辨率 | 4K@30fps / 2K@60fps | 1080P@60fps | 4K@30fps / 2K@60fps | 1080P@60fps | +| HDMI 环出 | 4K 环出 | x | x | x | +| 视频编码 | MJPEG / H.264 / H.265 | MJPEG / H264 | MJPEG / H264 | MJPEG / H264 | +| 音频输出 | ✓ | x | ✓ | x | +| UEFI / BIOS | ✓ | ✓ | ✓ | ✓ | +| 模拟 USB 键鼠 | ✓ | ✓ | ✓ | ✓ | +| 模拟 USB ISO | ✓ | ✓ | ✓ | ✓ | +| IPMI | ✓ | ✓ | ✓ | x | +| 局域网唤醒 | ✓ | ✓ | ✓ | ✓ | +| 网页终端 | ✓ | ✓ | ✓ | ✓ | +| 串口终端 | 3 channels | 2 channels | x | 1 channel | +| 用户脚本 | ✓ | ✓ | x | x | +| 存储 | 32G eMMC 300MB/s | 32G MicroSD 12MB/s | 8G eMMC 120MB/s | 8G eMMC 60MB/s | +| 网口 | 1000M | 100M | 1000M | 100M | +| PoE | 可选 | 可选 | x | x | +| WiFi | 可选 WiFi6 | 可选 WiFi6 | x | x | +| ATX 电源控制 | ✓ | ✓ | ✓ | ✓ | +| 显示屏 | 1.47" 320x172 LCD / 0.96" 128x64 OLED | 0.96" 128x64 OLED | - | 1.68" 280x240 | +| 特色功能 | LED 同步灯带 / 智能助手 | - | - | - | +| 功耗 | 0.4A@5V | 0.2A@5V | 0.4A@5V | 0.2A@5V | +| 电源输入 | USB-C or PoE | USB-C | USB-C | USB-C | +| 尺寸 | 65x65x26mm | 40x36x36mm | 80x60x17.5mm | 60x43x(24~31)mm | +| 价格 | ~~$79~~ $69 ATX / ~~$89~~ $79 Desk | $25 Lite / $50 Full(带ATX) | $89 无ATX / $102 带ATX | $69 无ATX / $79 带ATX | + +## 📂 项目结构 ``` shell ├── kvmapp # APP更新包 @@ -59,33 +97,7 @@ Lichee NanoKVM 目前有三个版本: └── CHANGELOG.md ``` -## 参数 - -| 产品 | NanoKVM (Lite) | NanoKVM (Full) | PiKVM V4 | -| --- | --- | --- | --- | -| 计算单元 | LicheeRV Nano(RISCV) | LicheeRV Nano(RISCV) | CM4 (ARM) | -| 分辨率 | 1080P @ 60fps | 1080P @ 60fps | 1080P @ 60fps | -| 视频编码 | MJPEG, H264 | MJPEG, H264 | MJPEG, H264 | -| 视频延迟 | 90~230ms | 90~230ms | 100~230ms | -| UEFI/BIOS | ✓ | ✓ | ✓ | -| 模拟USB键鼠 | ✓ | ✓ | ✓ | -| 模拟USB存储 | ✓ | ✓ | ✓ | -| IPMI | ✓ | ✓ | ✓ | -| Wake-on-LAN | ✓ | ✓ | ✓ | -| ETH | 100M/10M | 100M/10M | 1000M/100M/10M | -| ATX电源控制 | 无,用户可自行连接 | USB接口IO控制板 | RJ45接口IO控制板 | -| OLED显示 | 无,用户可自行扩展 | 128x64 0.96" white | 128x32 0.91" white | -| 外接串口 | 2路 | 2路 | 1路 | -| TF卡 | 无,用户自备 | 有,开机即用 | 有 | -| 扩展配件 | 无 | PoE | WiFi/LTE | -| 功耗 | 0.2A@5V | 0.2A@5V | Peak 2.6A@5V | -| 电源输入 | PC USB即可供电 | PC USB即可供电
也支持额外辅助供电 | 需要DC 5V 3A供电 | -| 散热 | 静音无风扇 | 静音无风扇 | 需要风扇主动散热 | -| 尺寸 | 23x37x15mm
~1/30 PiKVM V4 体积 | 40x36x36mm
~1/7 PiKVM V4 体积 | 120x68x44mm | - -![](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_2.jpg) - -## NanoKVM 硬件平台 +## 🔩 硬件平台(NanoKVM Cube/PCIe) NanoKVM 基于 Sipeed [LicheeRV Nano](https://wiki.sipeed.com/hardware/zh/lichee/RV_Nano/1_intro.html) 核心板搭建,这部分硬件的规格书、原理图、尺寸图等均可在这里找到:[点击这里](http://cn.dl.sipeed.com/shareURL/LICHEE/LicheeRV_Nano) @@ -99,13 +111,29 @@ NanoKVM 镜像在LicheeRV Nano SDK 和 MaixCDK 基础上构建,可以兼容使 * [NanoKVM-B 原理图](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_HDMI_MIPI_31011.pdf) * [NanoKVM 镜像下载](https://github.com/sipeed/NanoKVM/releases/tag/NanoKVM) -## 购买渠道 +![NanoKVM PCB Pinout](https://wiki.sipeed.com/hardware/zh/kvm/assets/NanoKVM/1_intro/NanoKVM_2.jpg) + +## 🤝 贡献代码 + +我们十分欢迎任何人来贡献代码!您可以通过以下方式提供帮助: + +1. Fork 本仓库. +2. 创建一个分支. +3. 提交你的代码. +4. 推送代码到分支. +5. 创建一个PR. + +请保持你的 PR 尽量简单且集中,以便于更轻松地审查和合并。 + +> 🎁 **提交高质量 PR 的贡献者可能会收到 NanoKVM Cube、PCIe 或 Pro 作为感谢礼物!** + +## 🛒 购买渠道 * [Aliexpress(全球,除了美国和俄罗斯)](https://www.aliexpress.com/item/1005007369816019.html) * [淘宝](https://item.taobao.com/item.htm?id=811206560480) * [Preorder (其它不支持淘宝和速卖通的国家)](https://sipeed.com/nanokvm) -## 社区 +## 💬 社区 * [MaixHub Discussion](https://maixhub.com/discussion/nanokvm) * QQ group: 703230713