Merge pull request #752 from Z2Z-GuGu/main

Update NanoKVM Doc

docs/hardware/en/kvm/NanoKVM/faq.md

@@ -2,39 +2,102 @@
 title: F&Q
 keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool
 ---
-## Abnormal repair
-+ Unable to obtain IP address
-    1. Lite users need check if there is a card inserted. The Lite version is shipped without a card by default and requires users to bring their own TF card. Follow [here]（ https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/flashing.html ）Please retry after burning the card;
-    2. Check if the network switch supports 100M connection. Some new switches do not support 100M connection. Please replace the switch and try again
-    3. Try replacing the power supply, some power supplies may cause NanoKVM to not obtain IP or affect network speed
-+ After logging into the browser interface, there is no screen
-    1. Ensure that HDMI has an output signal and unplug and plug the HDMI cable again
-    2. Enter the web terminal and execute `/etc/init.d/S95nanokvm restart` to restart the service.
-    3. If the above methods cannot restore normal operation, click on the "Check for Updates" button on the interface to update the application
-    4. The early internal testing version of Full NanoKVM used a regular ribbon cable to connect to the HDMI acquisition board, which may not detect HDMI signals due to poor contact. It can be disassembled as shown in the following figure and reconnected to the ribbon cable
-    ![](./../../../assets/NanoKVM/guide/Old_fix.png)
-+ OLED displays information normally, but cannot open web pages
-    1. Reference [here](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/updating.html#%E8%8E%B7%E5%8F%96-IP) Connection Development Board
-    2. Enter the command `rm /etc/kvm/server.yaml`
-    3. Execute `reboot` to restart the system
-+ Early beta version of Full NanoKVM ATX small board connected to the host RESET pin. When restarting NanoKVM, the host may be restarted. Please disconnect the RESET jumper
-+ Early beta version of Full NanoKVM had a current backflow issue: when the host was turned off and there was no power output from the USB, the current would backflow into the host when connected to an auxiliary power supply
-    1. Firstly, it is recommended to set the USB to maintain power supply after the host is turned off
-    2. Full version users: Use an electric soldering iron to disconnect the 5V resistor or pin short-circuit at the position shown in the figure, and only use the auxiliary power supply port for power supply
-    ![](./../../../assets/NanoKVM/guide/fix2.png)
-+ Attempt to power off and restart to solve unknown issues
-+ If there are abnormal situations such as network disconnection during the update process, it may cause the update to fail. If the old application cannot be started, please refer to the following solutions:
-    1. Reference [here](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/updating.html#%E8%8E%B7%E5%8F%96-IP) Connection Development Board
-    2. Execute `rm -r /kvmapp && cp -r /root/old/ / && mv /old/kvmapp`
-    3. Execute `reboot` to restart the system
-    4. Re burn the system
-    5. Manual update: You can download and execute Python update scripts to manually complete the update process
-        1. Download [update-nanokvm.py.zip](https://github.com/user-attachments/files/16939944/update-nanokvm.py.zip) And decompress
-        2. Execution: `python update-nanokvm.py`
-        3. Wait for the update to complete
-+ If the above methods cannot solve the exception, please raise your question in the forum, GitHub or QQ group, and we will patiently answer it
-
-## Feedback
-* MaixHub Forum：https://maixhub.com/discussion/nanokvm
-* GitHub ：https://github.com/sipeed/NanoKVM
-* QQ group: 703230713
+
+## Exception Fixes
+
+**The following solutions are based on the latest application version. If you encounter issues, please update the application first. If you cannot update via the web interface, please follow the steps below for a forced update:**
+
+1. Refer to [this link](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/updating.html#%E8%8E%B7%E5%8F%96-IP) to connect the development board.
+2. Execute: `python /etc/kvm/update-nanokvm.py`
+   > Users outside of China may experience download failures due to DNS issues. Please add `nameserver 119.29.29.29` or `nameserver 223.5.5.5` to `/etc/resolv.conf` and try again.
+   > Earlier versions of the application may not have this script file. Please download [here](https://github.com/user-attachments/files/16939944/update-nanokvm.py.zip), extract it, and grant execute permissions before trying again.
+
+### STA LED Not Flashing Normally
+
+The STA LED indicates the operating status of the NanoKVM. When functioning properly, the STA LED should flash irregularly. If the STA LED is continuously on or off, or exhibits regular intermittent extinguishing, the NanoKVM may be malfunctioning.
+
+1. If the STA LED intermittently extinguishes after powering on: The system did not detect the system on the TF card. Please check if the TF card is properly inserted and reflash the TF image.
+2. If the STA LED is off for an extended period: This is usually due to a lack of power. Please check the power supply status.
+
+   > If powered only by USB-HID, the USB power may disconnect when the computer is shut down. Please refer to relevant documentation to set USB to always supply power in the BIOS, or use auxiliary power.
+   > Connecting to an unconventional power supply may damage the NanoKVM and cause the STA LED to extinguish.
+
+3. If the STA LED remains on for an extended period without flashing: This situation generally should not occur with the official system and applications. If custom functions are configured within the NanoKVM system, there is a chance it may cause the system to freeze, leaving the STA LED lit. It is recommended to reflash the image.
+
+### Unable to Obtain IP Address
+
+1. Lite users should first check if a TF card is inserted. The Lite version is shipped without a card by default, so users need to provide their own TF card. Please follow the instructions [here](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/flashing.html) to flash the card and retry.
+2. Check if the network switch supports 100M. Some newer switches do not support 100M connections; please replace the switch and try again.
+3. The NanoKVM Cube (including NanoKVM Full and NanoKVM Lite) may be unable to obtain an IP address when connecting to certain power sources/HDMI. Please confirm the following:
+   > Disconnect all interfaces and power the device using a power bank, then connect the network cable to see if an IP can be obtained.
+   > If an IP can be obtained, reconnect HDMI/computer USB to check if the IP exists.
+   > If the IP exists only when powered by the power bank, but disappears after connecting HDMI/computer USB, this indicates the issue. Please contact customer service to purchase an isolator to resolve it.
+
+### No Display After Logging into the Browser Interface
+
+1. The controlled host may be in sleep mode; try pressing any key on the keyboard to wake it up.
+2. For PCIe versions, try clicking the reset HDMI option under the `Video` icon.
+3. For Cube versions, after opening the webpage, try unplugging and replugging the HDMI cable.
+4. Check the resolution on the OLED or enter `echo "$(cat /kvmapp/kvm/width) * $(cat /kvmapp/kvm/height)"` in the web terminal to compare it with the resolution of the controlled host. If they differ, you can manually set the resolution using `echo xxx > /kvmapp/kvm/width && echo xxx > /kvmapp/kvm/height`.
+   > If the host system is Windows, the resolution in the display settings may not match the actual resolution. Check under Advanced -> Active Signal Resolution.
+5. The early beta version of Full NanoKVM uses a standard ribbon cable to connect the HDMI capture board, which may not detect the HDMI signal due to poor contact. Please reconnect the ribbon cable as shown in the image below, or contact customer service to purchase a dedicated ribbon cable.
+  ![](./../../../assets/NanoKVM/guide/Old_fix.png)
+6. Try restarting to resolve the issue: execute `reboot` in the web terminal.
+7. If the above methods do not identify the issue, execute `cat /proc/cvitek/vi_dbg` in the web terminal.   
+> If `VIDevFPS` is 0, it indicates that the NanoKVM cannot obtain HDMI input. Check the following issues: whether the host is outputting video signals, whether the HDMI cable is damaged, and whether the Cube is an early version with poor contact.   
+> If `VIDevFPS` is non-zero and `VIFPS` is 0, it indicates that the NanoKVM is not correctly configured for HDMI parameters. The Cube can reconnect HDMI to automatically obtain settings, while PCIe can click `Reset HDMI` under the `Video` option to automatically retrieve settings.   
+> Check if `VIInImgWidth` and `VIInImgHeight` match the actual HDMI resolution. If they differ, it indicates that the NanoKVM did not automatically obtain the correct HDMI parameters; please manually configure the resolution parameters as mentioned in point 4.
+
+### OLED Displaying Information Normally, But Unable to Open Webpage
+
+1. Please force update the application.
+
+### OLED Not Lighting Up
+
+The NanoKVM Full and PCIe versions come with an OLED to display information such as IP. If the OLED does not light up, please follow these steps to troubleshoot:
+
+1. Version `2.1.4` added an OLED sleep function; pressing the BOOT button can temporarily turn on the OLED.
+2. If the STA LED is flashing abnormally, first check whether the system is booting normally, and follow the steps outlined in “STA LED Not Flashing Normally” to troubleshoot.
+3. Try a forced update or reflash the system.
+
+### HID Keyboard and Mouse Not Working
+
+1. Use the "Reset HID" function in the web interface.
+2. Check if the USB port is securely connected; you can check if the HID icon on the OLED is lit, or use `cat /sys/class/udc/4340000.usb/state` in the web terminal. If it shows not connected, it indicates a poor connection of the USB cable. Please replace the USB cable and try again.
+
+### BIOS Not Recognizing HID Keyboard and Mouse
+
+1. Some motherboard BIOS require HID keyboard and mouse devices to have a BIOS identifier. The NanoKVM can create a BIOS under /boot to enable this feature by executing `touch /boot/BIOS && restart`.
+2. Use the "Reset HID" function in the web interface.
+
+### About Memory
+
+1. The total memory (RAM) space of NanoKVM is 256MB, with a dedicated ion memory area used for video image processing. The memory viewed in user space will be less than 256MB.
+2. Firmware versions lower than 1.3.0 reserve only 128MB of memory for user space. All images from version 1.3.0 and later increase the memory size to 158MB, which is beneficial for Tailscale to run for long periods. Users in need should update the image according to the steps [here].
+3. Enable "Memory Optimization" in the settings.
+
+### Host Abnormal Restart
++ In the early beta version, when the Full NanoKVM ATX board is connected to the host's RESET pin, the host may restart when the NanoKVM is rebooted. Please disconnect the RESET jumper or contact customer service to purchase stable version accessories.
+
+### Current Backflow
++ The early beta version of the Full NanoKVM has a current backflow issue: When the host is powered off and the USB has no power output, current will flow back into the host when connecting the auxiliary power supply.
+  1. It is recommended to set the USB to remain powered after the host is shut down.
+  2. For Full version users: Use a soldering iron to disconnect the 5V resistor or header short-circuit at the indicated position in the image below, supplying power only through the auxiliary power port.
+      ![](./../../../assets/NanoKVM/guide/fix2.png)
+
+### Try Power Cycling to Solve Unknown Issues
+
+### If there are network disconnections or other abnormal situations during the update, it may lead to a failed update. Please refer to the following solutions:  
+
+1. Refer to [here](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/updating.html#%E8%8E%B7%E5%8F%96-IP) to connect the development board.  
+2. Execute `rm -r /kvmapp && cp -r /root/old/ / && mv /old/kvmapp && reboot` to restore the previous version.  
+3. Manually force the update using the method outlined above.  
+4. Reflash the system.
+
+### If the above methods do not resolve the issue, please explain the model you purchased and the encountered problems on the forum, GitHub, or QQ group, and we will patiently assist you.
+
+## Feedback Methods
+
+* MaixHub Forum: [https://maixhub.com/discussion/nanokvm](https://maixhub.com/discussion/nanokvm)
+* GitHub: [https://github.com/sipeed/NanoKVM](https://github.com/sipeed/NanoKVM)
+* QQ Group: 703230713

docs/hardware/en/kvm/NanoKVM/user_guide.md

@@ -29,6 +29,8 @@ update:
 + TYPE: Displays the transmission type, currently only supports MJPG, H264 is under development.
 + STREAM: Shows the real-time transmission frame rate. Frame difference detection is enabled by default (transmission stops when the screen is static). When the screen is static, FPS shows 0.
 + QUALITY: Shows compression quality, ranging from 50-100%, default is 80%.
++ The main interface provides an OLED sleep function to prevent screen burn-in; a short press of the BOOT button can turn the OLED off or on.
++ After applying version `2.1.4`, the OLED automatic sleep feature has been added: After setting the sleep time in the settings, the OLED will automatically enter sleep mode after the specified time. Pressing the BOOT button can temporarily wake up the OLED.
 
 ## Management Page Features
 

docs/hardware/en/kvm/NanoKVM_PCIe/quick_start.md

@@ -19,11 +19,11 @@ Note: The image above shows the NanoKVM-PCIe version with WiFi and PoE. The vers
 
 ## Interface Introduction
 
-Top View:
+![](./../../../assets/NanoKVM/unbox/PCIe_new_interface.jpg)
 
-![](./../../../assets/NanoKVM/unbox/PCIe-Interface1.png)
+The two USB-C ports on the old version of the beta hardware are reversed. Please refer to the diagram, and follow the labels on the backplate once you receive it.
 
-Side View:
+![](./../../../assets/NanoKVM/unbox/PCIe-Interface1.png)
 
 ![](./../../../assets/NanoKVM/unbox/PCIe-Interface2.png)
 

docs/hardware/en/kvm/NanoKVM_PCIe/user_guide.md

@@ -21,6 +21,7 @@ On the NanoKVM-PCIe, the OLED has two interfaces: the main interface and the WiF
 + Resolution: Displays the physical resolution of the HDMI, such as 1920x1080.
 + FPS: Shows the real-time transmission frame rate.
 + The main interface provides an OLED sleep function to prevent screen burn-in. You can short-press the BOOT button to turn the OLED off or on.
++ After applying version `2.1.4`, the OLED automatic sleep feature has been added: After setting the sleep time in the settings, the OLED will automatically enter sleep mode after the set time. Pressing the BOOT button can temporarily wake up the OLED.
 
 **WiFi Configuration Interface** (not available for versions without WiFi):
 ![](./../../../assets/NanoKVM/unbox/wifi2.jpg)

docs/hardware/en/kvm/NanoKVM_USB/faq.md

@@ -0,0 +1,37 @@
+---
+title: F&Q
+keywords: NanoKVM-USB, Lichee, PiKVM, RISCV, tool
+---
+
+## Exception Fixes
+
+### No ttyUSBx Serial Device After Opening Web Page on Linux
+
++ This may be due to a missing serial driver. Please reinstall the CH34x driver using the following steps:
+
+1. Download the driver from the WCH official website (download link: [https://www.wch.cn/download/CH341SER_LINUX_ZIP.html](https://www.wch.cn/download/CH341SER_LINUX_ZIP.html)), extract it, and navigate to the `driver` directory.
+2. Run `uname -r` to check your operating system's release version. Find the corresponding version in (this link)[https://elixir.bootlin.com/linux/v6.2/source/drivers/usb/serial/ch341.c] and copy the content into `ch341.c`.
+3. Execute the `make` command to compile the driver.
+4. Run `sudo make load` to install the driver.
+5. Replace the old driver: `cp ch341.ko /lib/modules/$(uname -r)/kernel/drivers/usb/serial/ch341.ko`.
+
++ Some Linux distributions come with `brltty`, a Braille display tool that occupies the `/dev/ttyUSB0` serial port, causing the webpage to be unable to detect it. If you are not using `brltty`, it is recommended to uninstall it with `sudo apt remove brltty`.
+
+### Unable to Open NanoKVM-USB Corresponding Serial Device After Opening Web Page
+
++ This may be due to other programs occupying the serial port. Please ensure it is not in use before trying again.
++ Linux may lack permissions to open the serial port. Execute `sudo chmod 777 /dev/ttyUSB*` in the terminal.
++ The Chrome browser may not have detected the serial port. Please refresh the webpage or restart Chrome.
++ Chrome may lack sufficient permissions. Please grant the necessary permissions.
+
+### No HDMI Loop Out
+
++ The beta version hardware only supports USB power from the HOST side. Please ensure proper power supply from the HOST side during use.
+
+### If the above methods do not resolve the issue, please describe your purchased model and the encountered problem on the forum, GitHub, or QQ group, and we will respond patiently.
+
+## Feedback Methods
+
+- [GitHub Issues](https://github.com/sipeed/NanoKVM)
+- [MaixHub Forum](https://maixhub.com/discussion/nanokvm)
+- QQ Group: 703230713

docs/hardware/en/kvm/NanoKVM_USB/quick_start.md

@@ -64,7 +64,9 @@ Once the device is selected, the web page will start to display the video image.
 
 #### Serial Port Device
 
-Click button and a list of available serial port devices will pop up. Select the device named in the format of `USB Serial`.
+Click the "Select Serial Port" button to display a list of all available serial devices, from which you can choose the corresponding serial device.
+
+> On Windows, the format is `COMx`; on macOS, it is `USB Serial`; on Linux, it is generally `/dev/ttyUSBx`.
 
 > If the browser does not support Web Serial API, the button will not be displayed and the keyboard and mouse is not available.
 

docs/hardware/en/sidebar.yaml

@@ -457,6 +457,8 @@ items:
             file: kvm/NanoKVM_USB/quick_start.md
         -   label: Development
             file: kvm/NanoKVM_USB/development.md
+        -   label: FAQ
+            file: kvm/NanoKVM_USB/faq.md
 # -   label: Maix Audio
 #     items:
 #     -   label: MA USB 16