Archives
/
pikvm
mirror of https://github.com/pikvm/pikvm
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update

Browse Source
pull/1140/head
Maxim Devaev 8 months ago
parent acc763bb5c
commit d576c6f00b
5 changed files with 104 additions and 61 deletions
Show Stats Download Patch File Download Diff File

30
docs/_diy_first_launch.md
Unescape Escape View File

@ -1,17 +1,26 @@
1. Connect the USB and HDMI cables to the target host,
check the correctness of the ATX connection if you have made this option.
1. Double-check the correct assembly of the device, and make sure that you have connected
all the necessary cables to the host: USB, HDMI and ATX.
2. [Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank}
and insert it to Raspberry Pi.
3. Turn on PiKVM using a power supply. Wait ~5 minutes.
3. Turn on PiKVM using a power supply. Wait ~5 minutes.<br>
Do not turn off the device until it's fully booted for the first time.
4. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}** -
how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
4. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}.**<br>
It describes how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
**Follow the steps described there and come back to this page.**
5. ??? note "Note for the HDMI-USB dongle"
5. **Just reminding again:**
{!_passwd.md!}
6. Try to manage the computer using PiKVM with the Web Interface.<br>
Make sure that you get an image and both keyboard and mouse are working.
If something doesn't work, check out our [FAQ](faq.md) (it's really useful).
If nothing helped, you can get support in our [Discord chat](https://discord.gg/bpmXfz5).
7. ??? note "Note for the HDMI-USB dongle"
Many USB video capture devices tell the server's video card that the HDMI cable is supposedly disconnected.
This may lead to the fact that if you boot the server without an active stream, the server will not detect
@ -36,14 +45,7 @@
[root@pikvm ~]# systemctl restart kvmd
```
6. **Just reminding again:**
{!_passwd.md!}
7. **Try to manage the computer using PiKVM with the Web Interface.**<br>
Make sure that you get an image and both keyboard and mouse are working.
If something doesn't work, check out our [FAQ](faq.md) (it's really useful).
If nothing helped, you can get support in our [Discord chat](https://discord.gg/bpmXfz5).
* Check that everything is working.
8. Configure access to PiKVM from the Internet using [port forwarding](https://docs.pikvm.org/port_forwarding)
or [Tailscale VPN](https://docs.pikvm.org/tailscale), if you need it.

52
docs/v1.md
Unescape Escape View File

@ -8,28 +8,45 @@
-----
## Required parts
1. **Raspberry Pi board**
* **✮ ✮ ✮ [Raspberry Pi 3](https://www.raspberrypi.com/products/raspberry-pi-3-model-b/)**.<br>
1. **MicroSD card minimum 8Gb class 10.**
2. **[Official USB-Micro Power Supply](https://www.amazon.com/Capture-Streaming-Broadcasting-Conference-Teaching/dp/B09FLN63B3)**.
3. **Raspberry Pi board:**
* **[✮ ✮ ✮ Raspberry Pi 3](https://www.raspberrypi.com/products/raspberry-pi-3-model-b/)**.<br>
* ... or [Raspberry Pi 2](https://www.raspberrypi.com/products/raspberry-pi-3-model-b/).<br>
*Does not support H.264 even with HDMI-CSI bridge.*
* ... or [Raspberry Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/).<br>
*Compact and cheap, but not so reliable solution because of lack of the wired Ethernet.
Note that the better way to use Pi Zero is making [PiKVM V2](v2.md) - it supports more USB features.*
2. **MicroSD card minimum 8Gb class 10**
3. **Video capture device**
* **✮ ✮ ✮ [HDMI-CSI bridge based on TC358743 chip](https://www.amazon.de/Waveshare-Raspberry-Supports-Backward-Compatible/dp/B092HVP926/)**.<br>
4. **Video capture device:**
* **[✮ ✮ ✮ HDMI-CSI bridge based on TC358743 chip](https://www.amazon.de/Waveshare-Raspberry-Supports-Backward-Compatible/dp/B092HVP926/)**.<br>
*Supports H.264 video encoding on Raspberry Pi 3, automatic resolution selection and the lowest possible latency.*
* ... or [HDMI-USB dongle](https://www.amazon.com/Capture-Streaming-Broadcasting-Conference-Teaching/dp/B09FLN63B3).<br>
*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.
It's a black box, and no one knows what's inside it. If you have problems with it, it will not be possible to fix them.*
4. **[Official USB-Micro Power Supply](https://www.amazon.com/Capture-Streaming-Broadcasting-Conference-Teaching/dp/B09FLN63B3)**.
5. **The Pico HID Keyboard & mouse emulator**
5. **The Pico HID Keyboard & mouse emulator:**
{!_diy_parts_pico_hid.md!}
6. **Optional features**
6. **Board-specific parts:**
!!! success "✮ ✮ ✮ "Nothing special for Raspberry Pi 2 or 3"
??? note "Raspberry Pi Zero 2 W"
??? note "✮ ✮ ✮ HDMI-CSI bridge"
* *x1* [Raspberry Pi Zero Camera Cable](https://www.amazon.com/Arducam-Raspberry-Camera-Ribbon-Extension/dp/B085RW9K13). *Not compatible with Auvidea B101*.
??? note "... or HDMI-USB dongle"
* *x1* USB-A socket to USB-Micro adapter (female-male).
7. **Optional features:**
??? success "✮ ✮ ✮ ATX controller to manage the target host's power"
@ -50,7 +67,7 @@
-----
## Setting up the hardware
1. **Video capture device**
1. **Video capture device:**
??? success "✮ ✮ ✮ HDMI-CSI bridge"
@ -58,9 +75,16 @@
??? note "... or HDMI-USB dongle"
{!_diy_setup_video_usb.md!}
??? note "Raspberry Pi 2 & 3"
{!_diy_setup_video_usb.md!}
??? note "Raspberry Pi Zero 2 W"
Connect the USB dongle to USB-to-Micro adapter, and connect it to the USB port marked as `USB` (not `PWR`)
on the Pi Zero board.
2. **The Pico HID and ATX controller**
2. **The Pico HID and ATX controller:**
Connect all the parts according to this scheme:
@ -80,7 +104,7 @@
??? example "Electrical schematic diagram for advanced users"
<img src="../pico_hid/basic_scheme.png" />
3. **[Flash firmware to the Pico HID](pico_hid.md)**
3. **[Flash firmware to the Pico HID.](pico_hid.md)**
-----

18
docs/v2.md
Unescape Escape View File

@ -8,18 +8,18 @@
-----
## Required parts
1. **Raspberry Pi board**
* **✮ ✮ ✮ [Raspberry Pi 4 2Gb](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/)**.<br>
1. **MicroSD card minimum 16Gb class 10.**
2. **Raspberry Pi board:**
* **[✮ ✮ ✮ Raspberry Pi 4 2Gb](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/)**.<br>
*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/).<br>
*Compact and cheap, but not so reliable solution because of lack of the wired Ethernet.*
2. **MicroSD card minimum 16Gb class 10**
3. **Video capture device**
* **✮ ✮ ✮ [HDMI-CSI bridge based on TC358743 chip](https://www.amazon.de/Waveshare-Raspberry-Supports-Backward-Compatible/dp/B092HVP926/)**.<br>
3. **Video capture device:**
* **[✮ ✮ ✮ HDMI-CSI bridge based on TC358743 chip](https://www.amazon.de/Waveshare-Raspberry-Supports-Backward-Compatible/dp/B092HVP926/)**.<br>
*Supports H.264 video encoding, automatic resolution selection and the lowest possible latency.*
* ... or [HDMI-USB dongle](https://www.amazon.com/Capture-Streaming-Broadcasting-Conference-Teaching/dp/B09FLN63B3).<br>
* ... or [HDMI-USB dongle](https://www.amazon.com/Capture-Streaming-Broadcasting-Conference-Teaching/dp/B09FLN63B3) (not available for Pi Zero 2).<br>
*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.
It's a black box, and no one knows what's inside it. If you have problems with it, it will not be possible to fix them.*
@ -59,7 +59,7 @@
* *x1* [Raspberry Pi Zero Camera Cable](https://www.amazon.com/Arducam-Raspberry-Camera-Ribbon-Extension/dp/B085RW9K13). *Not compatible with Auvidea B101*.
* *x1* [Official USB-Micro Power Supply](https://www.amazon.com/Capture-Streaming-Broadcasting-Conference-Teaching/dp/B09FLN63B3).
5. **Optional features**
5. **Optional features:**
??? success "✮ ✮ ✮ ATX controller to manage the target host's power"
@ -77,7 +77,7 @@
-----
## Setting up the hardware
1. **Video capture device**
1. **Video capture device:**
??? success "✮ ✮ ✮ HDMI-CSI bridge"

26
docs/v3.md
Unescape Escape View File

@ -53,29 +53,35 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
* Connect **Ethernet** to the network and **USB power** to the Raspberry Pi power supply.
4. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}** -
how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
4. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}.**<br>
It describes how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
**Follow the steps described there and come back to this page.**
5. ??? note "If your kit includes the OLED display and/or the fan, you'll need to turn them on (this is only needed for the older V3 image for the HAT, in the box image everything is enabled by default)"
Log in to PiKVM and run these commands:
```
# rw
# systemctl enable --now kvmd-oled kvmd-oled-reboot kvmd-oled-shutdown
# systemctl enable --now kvmd-fan
# ro
```console
[root@pikvm ~]# rw
[root@pikvm ~]# systemctl enable --now kvmd-oled kvmd-oled-reboot kvmd-oled-shutdown
[root@pikvm ~]# systemctl enable --now kvmd-fan
[root@pikvm ~]# ro
```
6. ??? note "Using Fahrenheit instead of Celsius on the OLED"
```console
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
Create file `touch or nano /etc/systemd/system/kvmd-oled.service.d/override.conf`:
```ini
[Service]
ExecStart=
ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
```
And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
7. **Just reminding again:**
@ -93,7 +99,7 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
10. !!! warning "IO ports and other things"
**Before using GPIO** pins to control a relay, KVM switch, or anything else, be sure to [check the HAT pinout](#io-ports-and-jumpers). Many ports are busy with internal functions. Before using them for your own use, you must disable them, otherwise you may damage the device.
11. **You can also try the experimental [audio forwarding](audio.md){target=_blank}**.
11. Enable [audio forwarding](audio.md){target=_blank} if you want.
12. Configure access to PiKVM from the Internet using [port forwarding](https://docs.pikvm.org/port_forwarding)
or [Tailscale VPN](https://docs.pikvm.org/tailscale), if you need it.

39
docs/v4.md
Unescape Escape View File

@ -31,29 +31,34 @@
!!! warning
Do not block the ventilation holes on the sides of the device. This is especially important for the V4 Plus, which has an active cooling.
2. Wait until PiKVM starts and shows a greeting on the built-in display. Do not turn off the device until it's fully booted for the first time.
2. Wait until PiKVM starts and shows a greeting on the built-in display.<br>
Do not turn off the device until it's fully booted for the first time.
3. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}** -
how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
3. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}.**<br>
It describes how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
**Follow the steps described there and come back to this page.**
4. ??? note "Using Fahrenheit instead of Celsius on the OLED"
```console
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
# mkdir -p /etc/systemd/system/kvmd-oled.service.d
```
Create file `touch or nano /etc/systemd/system/kvmd-oled.service.d/override.conf`:
```ini
[Service]
ExecStart=
ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
```
And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
5. **Just reminding again:**
{!_passwd.md!}
6. **Try to manage the computer using PiKVM with the Web Interface.**<br>
6. Try to manage the computer using PiKVM with the Web Interface.<br>
Make sure that you get an image and both keyboard and mouse are working.
If something doesn't work, check out our [FAQ](faq.md) (it's really useful).
If nothing helped, you can get support in our [Discord chat](https://discord.gg/bpmXfz5).
@ -119,19 +124,25 @@ It supports USB 3.0, but by default it only works with USB 2.0 devices due to en
To enable USB 3.0, it is required to flash the USB controller firmware. It's very easy:
1. Install the package `flashrom-pikvm`:
```console
[root@pikvm ~]# rw
[root@pikvm ~]# pacman -Syu
[root@pikvm ~]# pacman -S flashrom-pikvm
```
# rw
# pacman -Syu
# pacman -S flashrom-pikvm
```
2. Flash the firmware: `usb3` for USB 3.0 support, or `default` for the default USB 2.0-only firmware:
```console
[root@pikvm ~]# flashrom-vl805 usb3
```
# flashrom-vl805 usb3
```
3. Perform the soft reboot:
```console
[root@pikvm ~]# reboot
```
# reboot
```
4. After the soft reboot, perform **reboot by power** (unplug and plug again the power cable).

Write Preview
Loading…
Cancel
Save