diff --git a/README.md b/README.md index 8656d6e1..aa0cf9bf 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,7 @@ The website: [pikvm.org](https://pikvm.org). Also check out [the documentation]( # Features -* Can be made based on **Raspberry Pi 2**, **3**, **4** and **Zero2W**; - * *Raspberry Pi 5 is not supported right now. It doesn't have GPU video encoders, therefore, there is no point in using it for PiKVM, it will not give any performance boost for this case. The Pi 5 is a great device, just not suitable for PiKVM.* +* Can be made based on **Raspberry Pi 2**, **Pi 3**, **Pi 4**, **Pi 5** and **Zero2W**; * **FullHD video** using advanced **HDMI-to-CSI bridge** or **USB dongle**; * [Proven](https://docs.pikvm.org/latency) lowest **35-50ms H.264 latency** among all KVMs on the market; * WebRTC, H.264-over-HTTP and MJPEG video; @@ -93,7 +92,7 @@ All of them uses our common open source software stack. |--------------------------------------------------------------------|:-----------:|:-----------:|---|:--------:|---|:----------:|:----------:| | | | | | | | | | | **Plug and Play out of box!** | ✅ | ✅ | | ✅ | | DIY | DIY | -| Base Raspberry unit | CM4
Included! | CM4
Included! | | RPi4
Included! | | RPi4
Zero2W | RPi3
RPi2
Zero2W | +| Base Raspberry unit | CM4
Included! | CM4
Included! | | RPi4
Included! | | RPi5
RPi4
Zero2W | RPi3
RPi2
Zero2W | || || |
⭐ ⭐ ⭐ **VIDEO** ⭐ ⭐ ⭐
| **V4 Plus** | **V4 Mini** | | **V3** | | **DIY V2** | **DIY V1** | @@ -160,7 +159,7 @@ All of them uses our common open source software stack. * **Keyboard and mouse** Mouse usage works directly in the browser. The keyboard emulator supports displaying the state of the keyboard LEDs. * **Mass Storage Drive** - On the Raspberry Pi 4 and Zero2W, PiKVM can emulate a virtual CD/DVD or Flash Drive. A live image can be uploaded to boot the attached server. + On the Raspberry Pi 4, 5 and Zero2W, PiKVM can emulate a virtual CD/DVD or Flash Drive. A live image can be uploaded to boot the attached server. * **ATX power management** With a very simple circuit that can be assembled on a breadboard, the power button of the attached server can be controlled using the ATX button headers on the motherboard. * **Security** @@ -202,7 +201,7 @@ All of them uses our common open source software stack. # DIY Getting Started PiKVM supports several different DIY platforms. Now available: **V2** and **V1**. -* **Recommended**: **V2** is the most powerful implementation for **Raspberry Pi 4** and **Zero2W** supporting all of the features of PiKVM including the **Mass Storage Drive**. **It's also the easiest to make**. +* **Recommended**: **V2** is the most powerful implementation for **Raspberry Pi 4**, **Pi 5** and **Zero2W** supporting all of the features of PiKVM including the **Mass Storage Drive**. **It's also the easiest to make**. * **V1** was designed to work with **Raspberry Pi 2** and **3** that do not have USB emulation port and requires a few more components for a basic implementation. It also does not support the Mass Storage Drive feature. The full list of parts is at the very beginning according to the assembly instructions for the corresponding platform. @@ -212,7 +211,7 @@ So, again, in short: * **DIY PiKVM V2:** * [Here are the instructions and a complete list of components](https://docs.pikvm.org/v2). - * Requires Raspberry Pi 4 or Zero 2 W. + * Requires Raspberry Pi 4 (recommended), Pi 5 or Zero 2 W. * Supports H.264 (for recommended CSI capture). * Supports CD/DVD and Flash Drive (mass storage) emulation. * It is recommended as a simpler and more feature-rich way compared to V1. diff --git a/docs/_diy_setup_video_usb.md b/docs/_diy_setup_video_usb.md index 3a06109c..4fbd44ba 100644 --- a/docs/_diy_setup_video_usb.md +++ b/docs/_diy_setup_video_usb.md @@ -6,8 +6,8 @@ search: Connect USB dongle to exactly this port. It is bound in the software so the OS does not confuse the video device with something else. -| Raspberry Pi 2 and 3 | Raspberry Pi 4 | -|----------------------|----------------| +| Raspberry Pi 2, 3 and 5 | Raspberry Pi 4 | +|-------------------------|----------------| | | | There are many revisions of the Raspberry Pi boards and you may come across one that we haven't tested. diff --git a/docs/building_os.md b/docs/building_os.md index c86748f2..ecc4ccee 100644 --- a/docs/building_os.md +++ b/docs/building_os.md @@ -34,6 +34,7 @@ Docker must work in privileged mode. * Choose the board: * `BOARD=rpi4` for Raspberry Pi 4. + * `BOARD=rpi5` * `BOARD=zero2w` * `BOARD=rpi3` * `BOARD=rpi2` @@ -43,7 +44,7 @@ Docker must work in privileged mode. * `PLATFORM=v4plus-hdmi` for PiKVM V4 Plus. * `PLATFORM=v3-hdmi` for RPi4 and PiKVM V3 HAT. * `PLATFORM=v2-hdmi` for RPi3a+/RPi4 or Zero2W with HDMI-CSI bridge. - * `PLATFORM=v2-hdmiusb` for RPi4 with HDMI-USB dongle. + * `PLATFORM=v2-hdmiusb` for RPi4 and RPi5 with HDMI-USB dongle. * `PLATFORM=v1-hdmi` for RPi2 or 3b+ with HDMI-CSI bridge and the Pico HID. * `PLATFORM=v1-hdmiusb` for RPi2 or 3b+ with HDMI-USB dongle and the Pico HID. diff --git a/docs/faq.md b/docs/faq.md index 700422ae..f3a4a64c 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -14,12 +14,6 @@ If you run into any issues you can check this page which will list common errors See here: https://pikvm.org/download -??? question "Can PiKVM work on Raspberry Pi 5?" - - * Not now, but it will. Pi5 does not support hardware video encoding so there is no any reason to use it for PiKVM. - * RPi5 is not compatible with PiKVM V3 HAT due to the difference in form factor with RPi4. - - ??? question "Can I connect multiple servers to a single PiKVM?" Yes, but it requires additional work to set up. See [this page](multiport.md). diff --git a/docs/flashing_os.md b/docs/flashing_os.md index c59940f2..d983e911 100644 --- a/docs/flashing_os.md +++ b/docs/flashing_os.md @@ -31,6 +31,11 @@ Download the appropriate SD card image. Select it based on the board, platform, !!! abstract "DIY PiKVM V2 Platform" + * **Raspberry Pi 5** + * HDMI-CSI bridge is not supported due to lack of hardware image encoders on Pi 5. + * [For HDMI-USB dongle](https://files.pikvm.org/images/v2-hdmiusb-rpi5/aarch64/v2-hdmiusb-rpi5-aarch64-latest.img.xz) + - [*sha1*](https://files.pikvm.org/images/v2-hdmiusb-rpi5/aarch64/v2-hdmiusb-rpi5-aarch64-latest.img.xz.sha1) + * **Raspberry Pi 4** *64-bit* * [For HDMI-CSI bridge](https://files.pikvm.org/images/v2-hdmi-rpi4/aarch64/v2-hdmi-rpi4-aarch64-latest.img.xz) - [*sha1*](https://files.pikvm.org/images/v2-hdmi-rpi4/aarch64/v2-hdmi-rpi4-aarch64-latest.img.xz.sha1) diff --git a/docs/multiport.md b/docs/multiport.md index da800a16..e97e8389 100644 --- a/docs/multiport.md +++ b/docs/multiport.md @@ -17,7 +17,7 @@ If you need to connect multiple hosts to a single PiKVM, then the best way to do * True Plug-n-Play with no need for override.yaml setups and complete control via Web UI. * Multifunctional RGB LEDs with beacon mode and customizable color schemes. * Firmware update directly from PiKVM and ready for future hardware extensions. -* Compatible with V4 Plus, V3 and DIY devices based on Pi2-Pi4 except Zero and V4 Mini. +* Compatible with V4 Plus, V3 and DIY devices based on Pi2-Pi5 except Zero and V4 Mini. And now the best part: **the switches can be chained!** Need four ports? Get a PiKVM Switch. As your server fleet expands to eight, simply add another switch and link it to the first one. @@ -67,6 +67,6 @@ Limitations: * [This loop capture device](https://www.amazon.com/gp/product/B08B346353) * v3 HAT v3.3 (Kickstarter model and later) also takes care of the back power issue * Mass Storage Device (MSD) workaround (will not work OOB) - * RPi4 OTG needs to be in the KB port for mouse and KB funtionality, ZeroW is required and needs to be connected to the HUB port for MSD functionality - ✔**KNOWN WORKING**✔ + * RPi4 and RPi5 OTG needs to be in the KB port for mouse and KB funtionality, ZeroW is required and needs to be connected to the HUB port for MSD functionality - ✔**KNOWN WORKING**✔ * AIMOS 4/8-port: See [here](https://github.com/pikvm/pikvm/issues/371) - Advanced soldering required - allows use of GPIO menu to change input by cycling * AIMOS 8-port: See [here](https://github.com/749/PiKVM-AIMOS-AM-KVM803-UART-Mod) - Advanced soldering required - allows use of GPIO menu to change input directly diff --git a/docs/v2.md b/docs/v2.md index 65de5b1f..b3105bc6 100644 --- a/docs/v2.md +++ b/docs/v2.md @@ -19,13 +19,17 @@ description: Getting started with PiKVM V2 *It makes no sense to buy a Pi 4 with more memory than 2Gb, since PiKVM software uses very few resources.* * ... or [Raspberry Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/).
*Compact and cheap, but not so reliable solution because of lack of the wired Ethernet.* + * ... or [Raspberry Pi 5](https://www.raspberrypi.com/products/raspberry-pi-5/).
+ *RPi5 doesn't have hardware video encoders, so it is impossible to use HDMI-CSI bridge with and, + as well as H.264 encoding. Only HDMI-USB dongle is supported, and only with heavy MJPEG video. + We recommend to choose Raspberry Pi 4 or Zero 2 as a base board.* * *... Raspberry Pi 5 is not supported right now. It doesn't have GPU video encoders, therefore, there is no point in using it for PiKVM, it will not give any performance boost for this case. The Pi 5 is a great device, just not suitable for PiKVM.* 3. **Video capture device:** * **[✮ ✮ ✮ HDMI-CSI bridge based on TC358743 chip](https://www.amazon.com/waveshare-HDMI-CSI-Camera-Adapter/dp/B08TR7R6RL).
- *Supports H.264 video encoding, automatic resolution selection and the lowest possible latency.* + *Supports H.264 video encoding, automatic resolution selection and the lowest possible latency. Raspberry Pi 5 does not support this.* * ... or [HDMI-USB dongle](https://www.amazon.com/Capture-Streaming-Broadcasting-Conference-Teaching/dp/B09FLN63B3) (not available for Pi Zero 2).
*Only heavy MJPEG video, no resolution detection, big latency compared to HDMI-CSI. Some users report hardware problems: the dongle may not work in the BIOS or simply stop working after a while. @@ -33,7 +37,7 @@ description: Getting started with PiKVM V2 4. **Board-specific: Power supply, USB connectivity, etc.** - ??? success "✮ ✮ ✮ Raspberry Pi 4" + ??? success "✮ ✮ ✮ Raspberry Pi 4 or Pi 5" On a Raspberry Pi 4 only the USB-C port that receives power is capable of acting as a USB Device. The other USB ports are capable only of acting as USB Hosts. @@ -158,7 +162,7 @@ description: Getting started with PiKVM V2 PiKVM V2 requires several items available separately: -- Ethernet cable **(Raspberry Pi 4 only)** +- Ethernet cable **(Raspberry Pi 4 and Pi 5 only)** - HDMI cable Let's connect all the wires before you power up the device. @@ -167,7 +171,7 @@ Let's connect all the wires before you power up the device. 2. Using the Y-cable, connect the Pi's OTG port to the USB on the target host. -3. **Raspberry Pi 4**: connect **Ethernet** to the network, e.g., to the WiFI router. +3. **Raspberry Pi 4** and **Pi 5**: connect **Ethernet** to the network, e.g., to the WiFI router. 4. ??? example "Connect the ATX controller if you built it"