This commit is contained in:
Maxim Devaev 2025-03-25 03:01:42 +02:00
parent b6bad8e46b
commit 0ce5dc5f19
15 changed files with 94 additions and 4 deletions

View File

@ -13,5 +13,5 @@ jobs:
with:
python-version: 3.x
# We're using the own fork of markdown-include because of indention
- run: pip install mkdocs-material mkdocs-video mkdocs-redirects markdown==3.3.7 git+https://github.com/pikvm/markdown-include
- run: pip install mkdocs-material mkdocs-video mkdocs-redirects mkdocs-glightbox git+https://github.com/pikvm/markdown-include
- run: mkdocs gh-deploy --force

View File

@ -30,6 +30,10 @@ li.md-nav__item--section > label.md-nav__link {
position: unset;
}*/
.md-nav__toggle~.md-nav>.md-nav__list {
margin-left: 15px;
}
.md-sidebar.md-sidebar--secondary {
padding-top: 10px;
}

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
* Ensure that you are using the right [OS image](flashing_os.md) for your platform
by running the following command: `pacman -Q | grep kvmd-platform`.

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
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.

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
With this part, you will be able to remotely turn on, turn off and restart your computer!
* *x4* MOSFET relays [OMRON G3VM-61A1](https://www.digikey.com/products/en?keywords=G3VM-61A1)

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
Insert the flexible flat cable of the HDMI-CSI bridge into the narrow white connector on the Raspberry Pi
(the closest one to big USB sockets). It is labeled `CAMERA`. To insert you need to open the connector first.
On the Raspberry Pi side you can gently lift the black part up and a little bit sideways:

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
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 |

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
To control the power, two display LEDs (power and HDD activity) and two buttons (power and reset) are provided
on the front panel of the computer case. They are connected by wires to pins on the motherboard.

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
!!! info "PiKVM + Multiport Switches compatibility"
Please note that this switch requires a USB port for control. The following devices can provide this:

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
??? danger "✮ ✮ ✮ CHANGE THE PASSWORDS! ✮ ✮ ✮"
PiKVM comes with the following default passwords:

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
To upload the firmware to Pico HID, you can use any computer with a USB port.
1. [Download](https://github.com/pikvm/kvmd/releases) the latest release of the firmware. The file is called `pico-hid.uf2`.

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
* *x1* [Raspberry Pi Pico board](https://www.raspberrypi.com/products/raspberry-pi-pico/) with soldered pins. Pico 2 is not supported right now.
* *x1* USB-A to Micro-USB cable.

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
??? example "Updating PiKVM OS"
To update, run following commands under the `root` user:

View File

@ -1,3 +1,9 @@
---
search:
exclude: true
---
!!! info "USB limitations"
Each emulated USB device consumes a limited hardware resource called **endpoints**.

View File

@ -20,8 +20,9 @@ theme:
logo: _assets/logo.png
favicon: _assets/favicon.ico
name: material
palette:
accent: pink
# palette:
# primary: black
# accent: black
font:
text: "arial, sans-serif"
code: monospace
@ -29,7 +30,7 @@ theme:
- navigation.indexes
- navigation.sections
- navigation.top
- navigation.tracking
# - navigation.tracking
- navigation.expand
- search.highlight
- search.share
@ -46,6 +47,7 @@ markdown_extensions:
- pymdownx.details
- pymdownx.superfences
- pymdownx.magiclink
- pymdownx.blocks.caption
- toc:
permalink: true
- codehilite:
@ -65,6 +67,18 @@ plugins:
"4g.md": "modem.md"
"usb_dynamic.md": "usb.md"
"webrtc.md": "video.md"
- glightbox:
touchNavigation: false
loop: false
slide_effect: slide
width: 95%
height: auto
zoomable: true
auto_caption: false
caption_position: bottom
background: white
shadow: true
manual: false
nav:
- "Device guides":