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

update

Browse Source
pull/1302/head
Maxim Devaev 3 weeks ago
parent c7269faaa3
commit dd36a3c86c
5 changed files with 61 additions and 36 deletions
Show Stats Download Patch File Download Diff File

23
docs/audio.md
Unescape Escape View File

@ -29,7 +29,11 @@ old user configurations that were created before audio support was added.
on the V3 HAT board and have not deleted or commented the `dtoverlay=tc358743-audio`
line in `/boot/config.txt`. Return everything as it was, if you changed it.
2. Add and add the following lines to `/etc/kvmd/janus/janus.plugin.ustreamer.jcfg` if they missing:
2. Update OS and reboot:
{!_update_os.md!}
3. Add the following lines to `/etc/kvmd/janus/janus.plugin.ustreamer.jcfg` if they missing:
```
audio: {
@ -38,16 +42,16 @@ old user configurations that were created before audio support was added.
}
```
3. Enable the Basic Audio support in the [EDID](edid.md) in the `/etc/kvmd/tc358743-edid.hex`:
4. Enable the Basic Audio support in the [EDID](edid.md) in the `/etc/kvmd/tc358743-edid.hex`:
```console
[root@pikvm ~]$ kvmd-edidconf --set-audio=yes
[root@pikvm ~]# kvmd-edidconf --set-audio=yes
```
4. Reboot the device:
5. Reboot the device:
```
[root@pikvm ~]$ reboot
```console
[root@pikvm ~]# reboot
```
@ -87,14 +91,9 @@ The video stream will restart and you should start hearing sounds from the targe
-----
## Troubleshooting
* If the target host does not detect the HDMI audio sink,
[try an alternative EDID](https://github.com/pikvm/pikvm/issues/764).
The problem will be fixed soon.
* If the browser does not play sound or does not show audio slider, try a different browser
and/or incognito mode without extensions. Google Chrome works best.
* Check the log: `journalctl -u kvmd-janus`.
* If nothing helped, please report about the problem [here](https://discord.gg/bpmXfz5) (preferred)
or [here](https://github.com/pikvm/pikvm/issues).
* If nothing helped, please report about the problem [to our support](https://discord.gg/bpmXfz5)

55
docs/edid.md
Unescape Escape View File

@ -21,14 +21,15 @@ You can also apply the new EDID without rebooting to make sure it works:
* Switch filesystem to RO-mode: `ro`.
-----
## Default EDID
If you need to restore the default EDID you can easily do this with `kvmd-edidconf`, for example:
```console
# rw
# kvmd-edidconf --import-preset=v4plus
# reboot
[root@pikvm ~]# rw
[root@pikvm ~]# kvmd-edidconf --import-preset=v4plus
[root@pikvm ~]# reboot
```
Available options: `v0`, `v1`, `v2`, `v3`, `v4mini` and `v4plus`.
@ -36,6 +37,7 @@ Also defaults edid can be found locally on your PiKVM: `/usr/share/kvmd/configs.
or in the [kvmd repo](https://github.com/pikvm/kvmd/blob/master/configs/kvmd/edid).
-----
## Force 1080p by defailt on PiKVM V0+
PiKVM V3 (or DIY V0-V2) has a hardware limit of 50Hz for 1080p mode, and this is a less common frequency than 60Hz.
@ -43,12 +45,13 @@ Therefore, on V3, the default mode is 720p. Some OS (like Proxmox) may not work
so you can force 1080p resolution by default:
```console
# rw
# kvmd-edidconf --import-preset=v3.1080p-by-default # Or, for example, v1.1080p-by-default
# reboot
[root@pikvm ~]# rw
[root@pikvm ~]# kvmd-edidconf --import-preset=v3.1080p-by-default # Or, for example, v1.1080p-by-default
[root@pikvm ~]# reboot
```
-----
## Disable 1920x1200 on PiKVM V4
PiKVM V4 supports the advanced capture mode of 1920x1200. If it bothers you
@ -56,12 +59,13 @@ PiKVM V4 supports the advanced capture mode of 1920x1200. If it bothers you
you can easily disable it and use only 1920x1080:
```console
# rw
# kvmd-edidconf --import-preset=v4plus.no-1920x1200 # Or v4mini.no-1920x1200
# reboot
[root@pikvm ~]# rw
[root@pikvm ~]# kvmd-edidconf --import-preset=v4plus.no-1920x1200 # Or v4mini.no-1920x1200
[root@pikvm ~]# reboot
```
-----
## Other EDID examples for PiKVM V4
PiKVM V4 can mimic many physical monitors. You can find the appropriate EDID in [this database](https://github.com/linuxhw/EDID) and import its HEX code to PiKVM. Choose something with a maximum resolution of 1920x1080 or 1920x1200.
@ -131,6 +135,7 @@ PiKVM V4 can mimic many physical monitors. You can find the appropriate EDID in
```
-----
## EDID examples for PiKVM V2+
Copy the contents into a file, for example `/root/edid.hex`, then follow the same steps as above.
@ -196,6 +201,7 @@ Copy the contents into a file, for example `/root/edid.hex`, then follow the sam
```
-----
## Editing EDID
To edit the EDID, it is best to use third-party utilities, such as the recommended advanced
@ -208,35 +214,44 @@ So, to tune EDID on PiKVM, use the following steps:
1. Switch filesystem to RW-mode: `rw`.
2. Export the system edid to the binary file `myedid.bin`:
```
```console
# kvmd-edidconf --export-bin=/root/myedid.bin
```
3. Copy this file to your PC with the editor. Use SCP, Putty or something like that. Open this binary file in the editor and change the necessary parameters. Edit, save and copy it back to PiKVM.
4. Convert the binary file to the HEX and test it:
```
# kvmd-edidconf --import=/root/myedid.bin --edid=/root/myedid.hex --apply
```console
[root@pikvm ~]# kvmd-edidconf --import=/root/myedid.bin --edid=/root/myedid.hex --apply
```
5. If everything works fine, install the new EDID file into the system:
```
# cp /root/myedid.hex /etc/kvmd/tc358743-edid.hex
```console
[root@pikvm ~]# cp /root/myedid.hex /etc/kvmd/tc358743-edid.hex
```
6. Alternative to step (4) and (5): if you are confident in your abilities, you can immediately install the new `myedit.bin` into the system and apply it instantly, without the need to use the temporary `myedid.hex`:
```
# kvmd-edidconf --import=/root/myedid.bin --apply
```console
[root@pikvm ~]# kvmd-edidconf --import=/root/myedid.bin --apply
```
7. Switch filesystem to RO-mode: `ro`.
The `kvmd-edidconfig` utility has the ability to change some simple parameters without using an external editor. For example you can change the vendor, model name and enable [HDMI audio](audio.md) on the PiKVM virtual display:
```console
[root@pikvm ~]# kvmd-edidconf --set-mfc-id=LNX --set-monitor-name=PiKVM --set-audio=1
[root@pikvm ~]# reboot
```
# kvmd-edidconf --set-mfc-id=LNX --set-monitor-name=PiKVM --set-audio=1
# reboot
```
!!! note
Windows cache's drivers and registry settings so changing the monitor name is not enough, you will also need to change the product ID and/or the serial number along with the monitor name:
`# kvmd-edidconf --set-monitor-name=TOSHIBA --set-mfc-id=TTP --set-product-id=34953 --set-serial=2290649089 --apply`
```console
[root@pikvm ~]# kvmd-edidconf --set-monitor-name=TOSHIBA --set-mfc-id=TTP --set-product-id=34953 --set-serial=2290649089 --apply
```

12
docs/pass.md
Unescape Escape View File

@ -6,15 +6,23 @@ Thus, PiKVM does not interfere with the normal operation of the display and pass
the video signal through itself until you need remote access via PiKVM
In this case, PiKVM directs the video stream to the Web UI or VNC.
!!! tip "Beta version"
This feature is in beta, so it requires manual activation.
!!! info
* The passthrough feature supports a screen resolution **up to 1920x1200** pixels.
* Other PiKVM devices besides V4 Plus do not support the passthrough due to hardware limitations.
This is shown more clearly below:
<img src="pass.png" />
-----
## Setting up the passthrough
@ -30,7 +38,7 @@ This is shown more clearly below:
# rw
```
3. Add these lines to `/boot/config.txt`:
3. Make sure that you have these lines in `/boot/config.txt`, add them if not:
```ini
dtoverlay=vc4-kms-v3d
@ -45,7 +53,6 @@ This is shown more clearly below:
forever: true
cmd_append:
- "--format=rgb24"
- "--buffers=8"
- "--encoder=cpu"
- "--v4p"
```
@ -75,6 +82,7 @@ disable the 1920x1200 mode on PiKVM itself:
# reboot
```
-----
## Current limitations

4
docs/v4.md
Unescape Escape View File

@ -66,7 +66,9 @@
7. 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.
8. Explore the features of PiKVM using the site's table of contents and have fun!
8. **If you are using PiKVM V4 Plus, check out its new exclusive feature: [HDMI Passthrough](pass.md)!**
9. Explore the features of PiKVM using the site's table of contents and have fun!
-----

3
mkdocs.yml
Unescape Escape View File

@ -76,9 +76,10 @@ nav:
- "Setting up Wi-Fi": wifi.md
- "Let's Encrypt certificates": letsencrypt.md
- "Video":
- "Tuning HDMI EDID": edid.md
- "HDMI passthrough": pass.md
- "H.264 / WebRTC": webrtc.md
- "Working with video": video.md
- "Tuning HDMI EDID": edid.md
- "HDMI audio": audio.md
- "Peripheral devices":
- "Keyboard & mouse":

Write Preview
Loading…
Cancel
Save