diff --git a/docs/atx_board.md b/docs/atx_board.md new file mode 100644 index 0000000..eabb49d --- /dev/null +++ b/docs/atx_board.md @@ -0,0 +1,59 @@ +# ATX control board + +To manage the power of your computer, you will need to install an ATX adapter board inside the case and connect it to the motherboard. + +!!! warning "Apple's Mac computers are not ATX compatible as they lack the needed ATX headers, this is ONLY compatible with PC servers and desktops." + +1. Connect the rainbow wires as follows to the board. Optionally print [the mounting plate](stl/atx/index.md){target=_blank} for the PCI slot on a 3D-printer. Assemble everything like on pictures below. Secure wires in any convenient way (we used soft ties). + + ??? example + + + + + + +2. Find the pins on the motherboard responsible for connecting the buttons and LEDs of the front panel of the case. Usually wires and connectors on the motherboard have designations. If you're not sure, check the documentation on your motherboard. + + ??? example + + + + +3. Place the ATX board nearby and, focusing on the signatures, connect the male pins to the female pin of the front panel wires, observing the polarity (the polarity is indicated on the ATX board). + + ??? example + + +4. Repeat the procedure with the female pin of the ATX board by connecting them to the motherboard connector. Check the documentation on your motherboard. + + ??? example + + +5. Install the ATX board into the PCI slot of the case and fix it with a screw, or use a different mounting method at your discretion. + + ??? example + + + + +6. Arrange the wires in a way that is convenient for you and fix them if necessary. + + ??? example + + +7. Connect the ATX board to PiKVM using a [straight Ethernet cable](https://www.home-network-help.com/straight.html). 2 pair/4 wire will NOT work, must be a 4 pair/8 wire. + + ??? example + + + +## Pinout + +??? note "ATX RJ-45 pinout" + The pinout of the RJ-45 connector is the same on the AT and ATX adapter. + + + +??? note "ATX LED wiring example" + diff --git a/docs/v3/atx_board_1.jpg b/docs/atx_board/atx_board_1.jpg similarity index 100% rename from docs/v3/atx_board_1.jpg rename to docs/atx_board/atx_board_1.jpg diff --git a/docs/v3/atx_board_10.jpg b/docs/atx_board/atx_board_10.jpg similarity index 100% rename from docs/v3/atx_board_10.jpg rename to docs/atx_board/atx_board_10.jpg diff --git a/docs/v3/atx_board_2.jpg b/docs/atx_board/atx_board_2.jpg similarity index 100% rename from docs/v3/atx_board_2.jpg rename to docs/atx_board/atx_board_2.jpg diff --git a/docs/v3/atx_board_3.jpg b/docs/atx_board/atx_board_3.jpg similarity index 100% rename from docs/v3/atx_board_3.jpg rename to docs/atx_board/atx_board_3.jpg diff --git a/docs/v3/atx_board_4.jpg b/docs/atx_board/atx_board_4.jpg similarity index 100% rename from docs/v3/atx_board_4.jpg rename to docs/atx_board/atx_board_4.jpg diff --git a/docs/v3/atx_board_5.jpg b/docs/atx_board/atx_board_5.jpg similarity index 100% rename from docs/v3/atx_board_5.jpg rename to docs/atx_board/atx_board_5.jpg diff --git a/docs/v3/atx_board_6.jpg b/docs/atx_board/atx_board_6.jpg similarity index 100% rename from docs/v3/atx_board_6.jpg rename to docs/atx_board/atx_board_6.jpg diff --git a/docs/v3/atx_board_7.jpg b/docs/atx_board/atx_board_7.jpg similarity index 100% rename from docs/v3/atx_board_7.jpg rename to docs/atx_board/atx_board_7.jpg diff --git a/docs/v3/atx_board_8.jpg b/docs/atx_board/atx_board_8.jpg similarity index 100% rename from docs/v3/atx_board_8.jpg rename to docs/atx_board/atx_board_8.jpg diff --git a/docs/v3/atx_board_9.jpg b/docs/atx_board/atx_board_9.jpg similarity index 100% rename from docs/v3/atx_board_9.jpg rename to docs/atx_board/atx_board_9.jpg diff --git a/docs/v3/atx_led.jpg b/docs/atx_board/atx_led.jpg similarity index 100% rename from docs/v3/atx_led.jpg rename to docs/atx_board/atx_led.jpg diff --git a/docs/v3/rj45.jpg b/docs/atx_board/rj45.jpg similarity index 100% rename from docs/v3/rj45.jpg rename to docs/atx_board/rj45.jpg diff --git a/docs/building_os.md b/docs/building_os.md index 70ebae1..ba0649f 100644 --- a/docs/building_os.md +++ b/docs/building_os.md @@ -1,6 +1,6 @@ # Building the OS -!!! warning "ZeroW reached EOL and is no longer supported, the last image it can be found [here](https://files.pikvm.org/images/v2-hdmi-zerow-latest.img.xz)" +!!! warning "ZeroW reached End-Of-Life and is no longer supported, the last image it can be found [here](https://files.pikvm.org/images/v2-hdmi-zerow-latest.img.xz)" The PiKVM OS is based on Arch Linux ARM and contains all the required packages and configs for it to work. To build the OS you will need x86_64 Linux machine with: @@ -31,7 +31,9 @@ Docker must be enabled in privileged mode. * Choose the board: `BOARD=rpi4` for Raspberry Pi 4 or `BOARD=zerow`, `BOARD=rpi2`, `BOARD=rpi3` for other options. * Choose the platform: - * `PLATFORM=v3-hdmi` for RPi4 and PiKVM v3 HAT. + * `PLATFORM=v4mini-hdmi` for PiKVM V4 Mini. + * `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=v0-hdmi` for RPi2 or 3b+ with HDMI-CSI bridge and Arduino HID. diff --git a/docs/flashing_os.md b/docs/flashing_os.md index ee9aa59..35b06f7 100644 --- a/docs/flashing_os.md +++ b/docs/flashing_os.md @@ -8,7 +8,10 @@ Download the appropriate SD card image. Select it based on the board, platform, and the video capture device you are using: -* **V3 HAT (Patron, Kickstarter, Pre-Assembled and future editions)** +* **PiKVM V4** + * [PiKVM V4 Mini](https://files.pikvm.org/images/v4mini-hdmi-rpi4-latest.img.xz) - [*sha1*](https://files.pikvm.org/images/v4mini-hdmi-rpi4-latest.img.xz.sha1) + * [PiKVM V4 Plus](https://files.pikvm.org/images/v4plus-hdmi-rpi4-latest.img.xz) - [*sha1*](https://files.pikvm.org/images/v4plus-hdmi-rpi4-latest.img.xz.sha1) +* **PiKVM V3** * [PiKVM V3 HAT BOX Image (Raspberry Pi 4) OLED/FAN preactivated](https://files.pikvm.org/images/v3-hdmi-rpi4-box-latest.img.xz) - [*sha1*](https://files.pikvm.org/images/v3-hdmi-rpi4-box-latest.img.xz.sha1) * [PiKVM V3 HAT DIY Assembly (Raspberry Pi 4)](https://files.pikvm.org/images/v3-hdmi-rpi4-latest.img.xz) - [*sha1*](https://files.pikvm.org/images/v3-hdmi-rpi4-latest.img.xz.sha1) * **DIY - Raspberry Pi 4, V2 platform:** diff --git a/docs/v3.md b/docs/v3.md index ed2e81e..f76b609 100644 --- a/docs/v3.md +++ b/docs/v3.md @@ -1,4 +1,4 @@ -# PiKVM v3 HAT +# PiKVM V3 HAT @@ -18,17 +18,17 @@ * Please review the back of the box. All parts are required before the HAT is fully functional. * The USB-C bridge is located in with the ATX end which includes a pink foam spacer. * Please assemble the HAT onto the RPi and test all of the parts before installing in the case, it's easier to install in the case than to dissasemble it. - * If going from a v2 to a v3, the splitter is **no longer needed**. + * If going from a V2 to a V3, the splitter is **no longer needed**. -??? note "For pre-assembled v3" - * If going from a v2 to a v3, the splitter is built in and is **no longer needed**. +??? note "For pre-assembled V3" + * If going from a V2 to a V3, the splitter is built in and is **no longer needed**. ## Basic setup -If you have a kit without a metal case, you can use our free 3D printing case drawing: [v3.3](stl/v3.3/index.md){target=_blank} for the Kickstarter/Store model, [v3.2](stl/v3.2/index.md){target=_blank} for the pre-release. +If you have a kit without a metal case, you can use our free 3D printing case drawing: [V3.3](stl/v3.3/index.md){target=_blank} for the Kickstarter/Store model, [V3.2](stl/v3.2/index.md){target=_blank} for the pre-release. -!!! warning "Please use the v3 image, v2 image is not compatible" +!!! warning "Please use the V3 image, V2 image is not compatible" 1. **[Flash the memory card.](flashing_os.md){target=_blank}** @@ -50,13 +50,13 @@ If you have a kit without a metal case, you can use our free 3D printing case dr |-----------|------------| | | | - * **HDMI input** and **USB emulation** port must be connected to the computer. **ATX** too, but it's optional, [read below](#atx-connection). There should be no USB hub between PiKVM and the computer, as some UEFI/BIOS cannot detect them at the boot stage. On the HDMI the HAT, like the CSI bridge, supports 1080p50Hz or 720p60Hz or lower. + * **HDMI input** and **USB emulation** port must be connected to the computer. [**ATX** too](atx_board.md), but it's optional. There should be no USB hub between PiKVM and the computer, as some UEFI/BIOS cannot detect them at the boot stage. On the HDMI the HAT, like the CSI bridge, supports 1080p50Hz or 720p60Hz or lower. * Connect **Ethernet** to the network and **USB power** to the Raspberry Pi power supply. 4. **Carefully read [the "First steps" guide](first_steps.md){target=_blank}** - how to find a device on the network, how to log in there, change passwords, and so on. **Follow the steps described there and come back here**. -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, BOX image is N/A)" +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 @@ -65,14 +65,7 @@ If you have a kit without a metal case, you can use our free 3D printing case dr # ro ``` -6. ??? note "If you want your OLED to display a different temperature type - please expand" - If you want the temperature to be displayed in Fahreneit on the OLED and you do not want to update the whole system, then you will need to do this first after going to root (Pre-Assembled units can skip the first part): - ``` - # rw - # pacman -Syy - # pacman -S kvmd-oled - # systemctl enable --now kvmd-oled kvmd-oled-reboot kvmd-oled-shutdown - ``` +6. ??? note "Using Fahrenheit instead of Celsius on the OLED" ``` # mkdir -p /etc/systemd/system/kvmd-oled.service.d ``` @@ -80,7 +73,7 @@ If you have a kit without a metal case, you can use our free 3D printing case dr ```ini [Service] ExecStart= - ExecStart=/usr/bin/kvmd-oled --height=32 --clear-on-exit --fahrenheit + 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 pikvm. @@ -100,52 +93,7 @@ If you have a kit without a metal case, you can use our free 3D printing case dr ## ATX connection -To manage the power of your computer, you will need to install an ATX adapter board inside the case and connect it to the motherboard. - -!!! warning "Apple's Mac computers are not ATX compatible as they lack the needed ATX headers, this is ONLY compatible with PC servers and desktops." - -1. Connect the rainbow wires as follows to the board. Optionally print [the mounting plate](stl/atx/index.md){target=_blank} for the PCI slot on a 3D-printer. Assemble everything like on pictures below. Secure wires in any convenient way (we used soft ties). - - ??? example - - - - - - -2. Find the pins on the motherboard responsible for connecting the buttons and LEDs of the front panel of the case. Usually wires and connectors on the motherboard have designations. If you're not sure, check the documentation on your motherboard. - - ??? example - - - - -3. Place the ATX board nearby and, focusing on the signatures, connect the male pins to the female pin of the front panel wires, observing the polarity (the polarity is indicated on the ATX board). - - ??? example - - -4. Repeat the procedure with the female pin of the ATX board by connecting them to the motherboard connector. Check the documentation on your motherboard. - - ??? example - - -5. Install the ATX board into the PCI slot of the case and fix it with a screw, or use a different mounting method at your discretion. - - ??? example - - - - -6. Arrange the wires in a way that is convenient for you and fix them if necessary. - - ??? example - - -7. Connect the ATX board to PiKVM using a [straight Ethernet cable](https://www.home-network-help.com/straight.html). 2 pair/4 wire will NOT work, must be a 4 pair/8 wire. - - ??? example - +[See here](atx_board.md). ## IO ports and jumpers @@ -153,7 +101,7 @@ To manage the power of your computer, you will need to install an ATX adapter bo ??? note "See the diagram" - 1. **ATX controller** interface (power on/off, reboot control, PWR and HDD ACT LEDs). + 1. [**ATX controller** interface](atx_board.md) (power on/off, reboot control, PWR and HDD ACT LEDs). 2. **HDMI reset** jumper. Connects GPIO 17 and RESET pin to HDMI capture chip. Currently not used, don't touch it. 3. **SPI and GPIO** for the custom extension boards. 4. **Audio capture** jumpers. Connects I2S pins 18, 19, 20 to HDMI capture chip. @@ -199,16 +147,8 @@ To manage the power of your computer, you will need to install an ATX adapter bo * **USB breaker** - `GPIO 5` - Can't be used for any other purposes. -??? note "ATX RJ-45 pinout" - The pinout of the RJ-45 connector is the same on the AT and ATX adapter. - - - -??? note "ATX LED wiring example" - - ## Known issues and limitations * The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~20-24 FPS for 1080p over LAN**. -* There may be **compatibility** issues with some motherboards (such as **HP** or **DELL**) which are the same as those that exist with PiKVM v2. Not everything is perfect, but if you have already used PiKVM v2 - our new v3 will work perfectly and please you. If there is no image from the BIOS, you can fine-tune the HDMI settings, but it is possible that the Mass Storage devices will not be available in the BIOS. -* Pre-release v3.2 board (NOT Kickstarter/Store edition) doesn't have HDMI backpowering workaround jumper. +* There may be **compatibility** issues with some motherboards (such as **HP** or **DELL**) which are the same as those that exist with PiKVM V2. Not everything is perfect, but if you have already used PiKVM V2 - our new V3 will work great and please you. If there is no image from the BIOS, you can fine-tune the HDMI settings, but it is possible that the Mass Storage devices will not be available in the BIOS. +* Pre-release V3.2 board (NOT Kickstarter/Store edition) doesn't have HDMI backpowering workaround jumper. diff --git a/docs/v4.md b/docs/v4.md new file mode 100644 index 0000000..5720091 --- /dev/null +++ b/docs/v4.md @@ -0,0 +1,31 @@ +# PiKVM V4 Mini & Plus + + + +* [PiKVM V4 Mini Datasheet PDF](v4mini_datasheet.pdf) +* [PiKVM V4 Plus Datasheet PDF](v4plus_datasheet.pdf) + + +## Installation requirements + +TODO + + +## Basic setup + +TODO + + +## ATX connection + +[See here](atx_board.md). + + +## IO ports and jumpers + +TODO + + +## Known issues and limitations +* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~20-24 FPS for 1080p over LAN**. +* There may be **compatibility** issues with some motherboards (such as **HP** or **DELL**) which are the same as those that exist with PiKVM V2. Not everything is perfect, but if you have already used PiKVM V2 - our new V4 will work great and please you. If there is no image from the BIOS, you can fine-tune the HDMI settings, but it is possible that the Mass Storage devices will not be available in the BIOS. diff --git a/docs/v4/overview.jpg b/docs/v4/overview.jpg new file mode 100644 index 0000000..e1fcfee Binary files /dev/null and b/docs/v4/overview.jpg differ diff --git a/docs/v4/v4mini_datasheet.pdf b/docs/v4/v4mini_datasheet.pdf new file mode 100644 index 0000000..42456f5 Binary files /dev/null and b/docs/v4/v4mini_datasheet.pdf differ diff --git a/docs/v4/v4plus_datasheet.pdf b/docs/v4/v4plus_datasheet.pdf new file mode 100644 index 0000000..0f6af10 Binary files /dev/null and b/docs/v4/v4plus_datasheet.pdf differ diff --git a/mkdocs.yml b/mkdocs.yml index 4b0385c..947ebe6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,7 +60,8 @@ plugins: nav: - "Getting started": - - "PiKVM v3 HAT guide": v3.md +# - "PiKVM V4 guide": v4.md + - "PiKVM V3 HAT guide": v3.md - "First steps": first_steps.md - "Authentication": auth.md - "FAQ": faq.md