From e3ca5316e8d0d907d01e882a176ca98251197346 Mon Sep 17 00:00:00 2001 From: BuGu <62454025+Z2Z-GuGu@users.noreply.github.com> Date: Fri, 29 Aug 2025 10:40:06 +0800 Subject: [PATCH 1/2] Add English document for NanoKVM Pro --- docs/hardware/en/kvm/NanoKVM_Pro/atx_start.md | 90 ++++++++++++++ .../hardware/en/kvm/NanoKVM_Pro/desk_start.md | 3 + docs/hardware/en/kvm/NanoKVM_Pro/extended.md | 110 +++++++++++++++++ docs/hardware/en/kvm/NanoKVM_Pro/faq.md | 115 ++++++++++++++++++ .../en/kvm/NanoKVM_Pro/introduction.md | 89 ++++++++++++++ docs/hardware/en/kvm/NanoKVM_Pro/ws2812.md | 3 + docs/hardware/en/sidebar.yaml | 14 +++ docs/hardware/zh/kvm/NanoKVM_Pro/atx_start.md | 2 +- docs/hardware/zh/kvm/NanoKVM_Pro/extended.md | 2 +- .../zh/kvm/NanoKVM_Pro/introduction.md | 2 +- 10 files changed, 427 insertions(+), 3 deletions(-) create mode 100644 docs/hardware/en/kvm/NanoKVM_Pro/atx_start.md create mode 100644 docs/hardware/en/kvm/NanoKVM_Pro/desk_start.md create mode 100644 docs/hardware/en/kvm/NanoKVM_Pro/extended.md create mode 100644 docs/hardware/en/kvm/NanoKVM_Pro/faq.md create mode 100644 docs/hardware/en/kvm/NanoKVM_Pro/introduction.md create mode 100644 docs/hardware/en/kvm/NanoKVM_Pro/ws2812.md diff --git a/docs/hardware/en/kvm/NanoKVM_Pro/atx_start.md b/docs/hardware/en/kvm/NanoKVM_Pro/atx_start.md new file mode 100644 index 00000000..8b4ace2f --- /dev/null +++ b/docs/hardware/en/kvm/NanoKVM_Pro/atx_start.md @@ -0,0 +1,90 @@ +--- +title: ATX Getting Started Guide +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool, PCIe +update: + - date: 2025-8-26 + version: v0.1 + author: BuGu + content: + - Release docs +--- + +## Unboxing + +### NanoKVM-ATX Unboxing List + + + + +The NanoKVM-ATX includes: ++ NanoKVM-ATX host with full-height PCIe bracket + OLED *1; ++ HDMI cable 150cm *1; ++ HDMI cable 50cm *1; ++ USB Type A to Type C 100cm *2; ++ 4Pin internal USB cable 40cm *1; ++ ATX-9Pin split power switch cable 30+30cm *1; ++ Small Phillips screwdriver *1; ++ Antenna *1 (WiFi version only); + +## Interface Definition + + + +## Wiring + +1. Connect the power. The NanoKVM-Pro has slightly higher power requirements, and some motherboard USB ports may not provide sufficient current. To ensure the proper operation of the NanoKVM-Pro, it is strongly recommended to use an external power supply of 5V 1A or higher (actual power consumption is about 3W). + + + +2. Connect the USB-HID interface: + + ATX version: can use either internal case wiring or external USB-C connection. + + + +> For the first batch of ATX version users who choose the internal wiring option, it is recommended to cut the red wire (only powered externally) to prevent NanoKVM malfunctions caused by insufficient power from the motherboard's 9Pin USB. + + + + + +3. Use an Ethernet cable to connect the router/switch to the NanoKVM-Pro. If there is no wired network, this step can be skipped; Wi-Fi can be configured after powering on (requires purchasing the WiFi version). + + + +4. Connect HDMI-IN. If the motherboard has only one video port and an external display is needed, connect HDMI-OUT to your display. + + + +> Note that NanoKVM-Pro supports a maximum capture of 4K30FPS. The built-in HDMI splitter actively reads the resolution and frame rate of the external display and provides a common mode list to the host. +> If you connect a 4K60FPS display, the computer will recognize it as a maximum supported 4K30 display (limited by the capture device; you can turn off capture to allow 4K60 direct output to the monitor). +> If you connect a 1080P display, the computer will recognize it as a maximum 1080P display (limited by the loop-out display). +5. (Optional) Connect the ATX power control interface. + + + +## Internal Network Access + +### Connecting to the Network + +1. If using a wired connection, after powering on, the KVM will obtain an IP address assigned by the router's DHCP, and this step can be skipped. +2. Wi-Fi Connection + + The ATX version can configure the network via OLED. The steps are as follows: + 1. Connect to the NanoKVM-ATX's AP: Long press the USR button, and the KVM will release a Wi-Fi signal (AP). The OLED will display this IP information, allowing you to scan the QR code for quick connection. + 2. Log in to the webpage to enter the Wi-Fi account and password: After connecting to Wi-Fi, the OLED will display the webpage link. You can manually enter the URL or scan the QR code for quick access to the webpage for configuration. +3. If needed, you can also connect via USB-NCM. + +### Accessing the Page + +1. For the ATX version: After connecting to the network, the OLED will display the local IP address (E IP is the IP obtained from the wired network; W IP is the IP obtained from the Wi-Fi network, automatically switching display by default). +2. Use a computer on the same internal network to input the IP address in a browser (Chrome is recommended) to access the page. + +> It is normal to see this warning. NanoKVM-Pro has enabled HTTPS for enhanced security and uses a self-signed SSL certificate. +3. The default initial account is `admin`, and the password is `admin`. It is strongly recommended to change the account password immediately. +4. Check if the image, keyboard/mouse, and power buttons are functioning correctly. + + + +## Remote Connection + +1. NanoKVM-Pro comes pre-installed with the Tailscale application, allowing you to log in with your Tailscale account in the web settings. All devices logged into Tailscale will automatically join the same virtual internal network environment, assigning each device a `100.xxx.xxx.xxx` IP, which can be used to remotely access and control your host. +2. Other remote networking tools: NanoKVM-Pro is based on Ubuntu and can install applications via `apt`, such as ZeroTier. Please follow the official instructions to install related applications. \ No newline at end of file diff --git a/docs/hardware/en/kvm/NanoKVM_Pro/desk_start.md b/docs/hardware/en/kvm/NanoKVM_Pro/desk_start.md new file mode 100644 index 00000000..cc5c7516 --- /dev/null +++ b/docs/hardware/en/kvm/NanoKVM_Pro/desk_start.md @@ -0,0 +1,3 @@ +# NanoKVM-Desk Getting Started Guide + +Coming Soon \ No newline at end of file diff --git a/docs/hardware/en/kvm/NanoKVM_Pro/extended.md b/docs/hardware/en/kvm/NanoKVM_Pro/extended.md new file mode 100644 index 00000000..6d2df939 --- /dev/null +++ b/docs/hardware/en/kvm/NanoKVM_Pro/extended.md @@ -0,0 +1,110 @@ +--- +title: Advanced Applications +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool, PCIe +update: + - date: 2025-8-26 + version: v0.1 + author: + content: + - Release docs +--- + +## Switching to PiKVM + +In addition to running the NanoKVM framework, NanoKVM Pro is also compatible with the PiKVM software framework. You can switch between them as needed. + +### Switching to PiKVM + +By default, the NanoKVM Pro uses the NanoKVM framework. You can switch to PiKVM in `Settings` -> `About` -> `Switch Device`. + + + +After clicking, the system will automatically restart and boot into the PiKVM framework. This process takes about 30 seconds. If it does not switch automatically for a long time, please refresh the webpage manually. + + + +The default username and password for the PiKVM framework are also `admin`, `admin`. However, the two platforms use their own usernames and passwords, which are not unified. It is strongly recommended to change them after logging in. + + + +> Some functions in the PiKVM framework require the use of a web terminal, such as Wi-Fi configuration and Tailscale setup. +> When updating NanoKVM, the PiKVM framework will be updated simultaneously. + +### Switching to NanoKVM + +Switching back from the PiKVM system to NanoKVM is equally simple. Just go to `Options` -> `Switch to NanoKVM` and click `Switch Now`. + + + +After clicking, the system will automatically restart and boot into the NanoKVM framework. This process takes about 30 seconds. If it does not switch automatically for a long time, please refresh the webpage manually. + +## SSH + +To ensure security, SSH is disabled by default on the NanoKVM Pro. If you need SSH access or want to preview a new version, you can enable SSH by going to `Settings` -> `Device`. + +The default username is `root` and the password is `sipeed`. If you change the web account password under the NanoKVM framework, the SSH password will be updated accordingly. + +## Updates + +NanoKVM Pro will periodically push new application versions that include new features and bug fixes. You can update the application version in `Settings` -> `Check for Updates`. + + + +After clicking download, the new application installation package will be automatically downloaded, which includes `kvmcomm_x.x.x_arm64.deb`, `nanokvmpro_x.x.x_arm64.deb`, and `pikvm_x.x.x_arm64.deb`: ++ `kvmcomm_x.x.x_arm64.deb` is responsible for driving the shared hardware in the NanoKVM and PiKVM frameworks; ++ `nanokvmpro_x.x.x_arm64.deb` is the NanoKVM application software; ++ `pikvm_x.x.x_arm64.deb` is the PiKVM application software. + +Enabling the preview update feature will allow you to access the latest experimental application, which usually includes updated features but may lack stability. It is recommended to enable SSH before downloading preview updates. + +You can also download specific versions and install them manually. + +```shell +# Example of downloading version 1.0.10 +# Download files +curl -L -o nanokvm_pro_1.0.10.tar.gz https://cdn.sipeed.com/nanokvm/pro/kvmcomm_1.0.10_arm64.deb +curl -L -o nanokvm_pro_1.0.10.tar.gz https://cdn.sipeed.com/nanokvm/pro/nanokvmpro_1.0.10_arm64.deb +curl -L -o nanokvm_pro_1.0.10.tar.gz https://cdn.sipeed.com/nanokvm/pro/pikvm_1.0.10_arm64.deb + +sudo apt install ./*1.0.10* +``` + +## How to Use Serial Ports + +NanoKVM Pro provides two available serial ports, UART1/UART2 (the ATX version does not expose them due to bracket specifications, retaining only internal pads). + ++ Connect to other serial terminal devices: +```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 +``` ++ Send serial commands only: +```shell +# Set ttyS1 to 115200 baud rate +stty -F /dev/ttyS1 115200 + +# Send hexadecimal data 0x11, 0x22, 0x33 +echo -n -e '\x11\x22\x33' > /dev/ttyS1 +``` + +## How to Modify EDID + +EDID (Extended Display Identification Data) is a set of data provided by a display device to the host, including device information, resolution and frame rate lists, color characteristics, audio capabilities, etc. The host adjusts the display settings based on the received EDID. + +NanoKVM Pro supports modifying the EDID exposed by the virtual display. You can clone the EDID from a monitor or write your own EDID to achieve specific screen ratios, refresh rates, or color characteristics. + +> Modifying the EDID may risk improper display functionality. Please proceed with caution. If issues arise, restore the default EDID. + +Writing method: + +```shell +# 1. Prepare the EDID file, typically 256 bytes, and scp it to the system +ls -l /root/customize.bin +# -rw-r--r-- 1 1000 1000 256 Aug 19 14:44 /root/customize.bin +# 2. Write the EDID +cat /root/customize.bin > /proc/lt6911_info/edid +# 3. Restore the default EDID: +cat /kvmcomm/edid/e18.bin > /proc/lt6911_info/edid +``` \ No newline at end of file diff --git a/docs/hardware/en/kvm/NanoKVM_Pro/faq.md b/docs/hardware/en/kvm/NanoKVM_Pro/faq.md new file mode 100644 index 00000000..94ede7fd --- /dev/null +++ b/docs/hardware/en/kvm/NanoKVM_Pro/faq.md @@ -0,0 +1,115 @@ +# F&Q + +## Updating to Solve Issues + +NanoKVM Pro will periodically update applications, and some issues may have been resolved in newer versions. Therefore, please try updating the application first. + +## Green LED Flashing + +The green LED is the power indicator for NanoKVM Pro. If a power supply with insufficient capacity is connected, the green LED may fail to start due to unstable voltage. Please disconnect all power sources and replace the power supply. + +## Image Burning Methods + +### USB Burning + +NanoKVM Pro supports restoring or updating the system via USB image burning. + +#### Preparation + +- Prepare a USB data cable +- Download the latest NanoKVM Pro image file +- Prepare a burning tool (such as balenaEtcher, Rufus, or the dd command) + +#### Burning Steps + +1. **Download the Image and Burning Tool** + - Visit the [NanoKVM Pro Release Page](https://github.com/sipeed/NanoKVM-Pro/releases/latest) to download the latest image file. + - Download and install the burning tool [balenaEtcher](https://etcher.balena.io/). + +2. **Enter Burning Mode** + - Use the USB data cable to connect the NanoKVM Pro's HID interface to your computer. + - Press and hold the User button on the NanoKVM, then power it on (or press the Reset button while powered on) until the orange LED turns off. + - The device will then enter burning mode, and the orange LED will start flashing again. Check if your computer recognizes the new disk device. + +
+ Windows Recognizing Device
+
+ Linux Recognizing Device
+
+
+
+