Changes

Jump to navigation Jump to search

X680

5,048 bytes added, 17 June
[[File:RJ45-PINOUT.png]]
==User Manual=====Hardware connection Connection & installation Video===
Refer to: https://youtu.be/ukHCz1RsFx4
{{#ev:youtube|https://youtu.be/ukHCz1RsFx4}}
[[File:HDMI-OUT-INFO-1.jpg|700px|X680 HDMI port info]]
 
==User Manual==
[http://about:blank PiKVM] is a Free and Open Source Software that is released under the GPLv3 license. The Operating System (OS) image provided here is solely for the purpose of hardware testing. For commercial use, it is advised to directly contact the developers of PiKVM.
 
The development of this software would not be possible without the financial backing of the community. Contributions play a vital role in sustaining and advancing the project. If you wish to contribute, you can visit the PiKVM donation page at https://pikvm.org/donate/. Your support is greatly appreciated and will help in the continuous development and improvement of this software.
===OS Download & Installation===
1. Firstly, need prepair a micro sd card, a minimum 16 32/64 Gb class 10 memory card is recommended. If you use a CM4 with eMMC, you don't need a micro sd card.
2. Download an appropriate OS image for the PiKVM, the url link is https://pikvm.org/download/ or click [https://files.pikvm.org/images/v3-hdmi-rpi4-box-latest.img.xz this one] to download it. (Please use the '''V3 Pre-Assembled''' OS image)
===Flash OS image===
:1. You can use Raspberry Pi Imager to Flash or the following alternatives tools::* [https://etcher.balena.io/ balenaEtcher]: The application runs on Windows, MacOS, and Ubuntu operating systems.:* [https://i-win32diskimager.com/ Win32 Disk Imager]: This imaging software is designed for Windows machines.:2. Flash OS image to a microSD memory card by following [https://docs.pikvm.org/flashing_os the simple instructions] or [https://www.raspberrypi.com/documentation/computers/getting-started.html#installing-the-operating-system Official installation tutorial]
2:3. Refer to [[#How to flash OS onto the eMMC of CM4? (CM4 with eMMC)?]] if you use the CM4 shield with eMMC.
3:4. Then power the device, then open explore to login the pikvm web ui.
* How to flash OS onto the eMMC of CM4? (CM4 with eMMC)?
:1. Short nBOOT Pin, refer to the picture below. :[[File:X680-IMG-5615-3.jpg|500px]] :2. Connect CM4 USB port with a Type-A to Type-B cable to your computer as follow: :[[File:X680-IMG-5546-3.jpg|500px]] :3. Power the device via PWR DC Jack with 5V Power adaper :4. Then rerfer to [https://www.jeffgeerling.com/blog/2020/how-flash-raspberry-pi-os-compute-module-4-emmc-usbboot this tutorial] to flash raspberry pi OS
[[File:X680-IMG-5615-35.jpg|500px]]Remove the jumper of nBOOT after flashing is complete, then restart your device;
2. Connect :'''PS:If you use CM4 USB port with a Type-A to Type-B cable to your computer as follow:eMMC, then SD card cannot be used.'''
[[File===Configuring the PiKVM OS===* '''Login web UI''':X680-IMG-5546-3Access to PiKVM Web Interface via any browser with the URL '''https://pikvm/''' OR '''https://IP''' address of your ipkvm/, the default user and password is admin/admin* '''Log into PiKVM and open Terminal program'''* '''Switch to 'root' user ''':<pre>su root</pre>:then type the password, and the default password is 'root' also.jpg|500px]]* '''Switch OS to writable mode''':<pre>rw</pre>
* '''Enable RTC''' ('''Only for X680 V1.3''' because v1.3use the ds1307 chip, Please skip this step if you X680 V1. Power 5 using the device via PWR DC Jack same chip pcf8563 with 5V Power adaperpikvm official product):1. Due to different RTC chips with official PiKVM hardware, you still need to '''configure RTC''' to make RTC work normally.
4. Then rerfer to [https://www2.jeffgeerlingInsert the '''C1220''' button battery.com/blog/2020/how-flash-raspberry-pi-os-compute-module-4-emmc-usbboot this tutorial] to flash raspberry pi OSrun the following command in web terminal window:
5:3. Remove Edit the jumper of nBOOT after flashing is complete/boot/config.txt file, and change line <code>dtoverlay=i2c-rtc,pcf8563</code> to <code>dtoverlay=i2c-rtc, then restart your ds1307</code> (due to use the different RTC chip).:<pre>sudo nano /boot/config.txt</pre>:Then save & '''reboot''' the device;
'''PS:If you use CM4 with eMMC:Test & setting RTC, then SD card cannot be used.'''write&read the time of Raspberry Pi to RTC DS1307<dd><pre>date sudo hwclock -w sudo hwclock -r</pre></dd>
===*'''Enable RTC ===OLED display'''Due :Run the following command in web terminal window to different RTC chips with official enable OLED display::<pre>systemctl enable --now kvmd-oled kvmd-oled-reboot kvmd-oled-shutdown </pre>:If you are using <code>PiKVM hardwareOS V3 Pre-Assembled</code>, the OLED configuration is already pre-installed, you still need can ignore this step.: Rotate the OLED display by 180 degrees (Optional):<pre>nano /usr/bin/kvmd-oled</pre>:Change the line: return {"height": 64, "rotate": '''2'''} to return {"height": 64, "rotate": '''configure RTC0''' to make RTC work normally.}, then save & exit
Firstly, insert the * '''C1220Enable pikvm hdmi audio''' button battery. run the following command in web terminal window:Refer to [[Enable pikvm hdmi audio]]
1. * '''How to switch to target computers/servers''root' user su rootthen type the password, :The IP KVM (X680) Switch supports direct switching through buttons on front panel and hotkey through keyboard connected to the default password is 'root' special USB 1.1 port. it alsosupports remote hotkey switching between computers for easy monitoring.
2. Switch OS :'''Computers/Servers Switching'''::Press to writable mode rw3. Edit the select PC1/PC2/bootPC3/configPC4 through buttons on front panel.txt file, and change line <code>dtoverlay=i2c-rtc,pcf8563</code> to <code>dtoverlay=i2c-rtc,ds1307</code> (due to use the different RTC chip)corresponding LED located on the right of the button will be on if a PC is selected. sudo nano /boot/configthe PC1 will be automatically selected when power applied or restored.txtThen save & '''reboot''' the device;
4:'''Hotkey switching''':* Keyboard must be connected to USB1.Test & setting RTC1 port (Marked with an icon of keyboard):* Press the "Ctrl" twice quickly, write&read then immediately press "1" to switch to PC1:* Press the time of Raspberry Pi "Ctrl" twice quickly, then immediately press "2" to switch to RTC DS1307PC2 date:* Press the "Ctrl" twice quickly, then immediately press "3" to switch to PC3 sudo hwclock -w sudo hwclock -r:* Press the "Ctrl" twice quickly, then immediately press "4" to switch to PC4
5. Swith OS :'''Remote hotkey switching''':* Access to PiKVM web interface and log in:* Press the "Ctrl" twice quickly, then immediately press "1" to switch to PC1:* Press the "Ctrl" twice quickly, then immediately press "2" to switch to PC2:* Press the "Ctrl" twice quickly, then immediately press "3" to switch to PC3:* Press the "Ctrl" twice quickly, then immediately press "4" to switch to readonly modePC4 ro:* If your mouse cursor is not in the area of the PiKVM web interface, it is not functional
===Enable OLED display===*How to boot from NVME SSD?Run :1.Prepare the following command in web terminal window '''Win32 Disk Imager tool''' first, download and install it, refer to enable OLED display: rw systemctl enable --now kvmd-oled roIf you are using <code>PiKVM OS V3 Pre-Assembled<https://code>, the OLED configuration is already pre-installed, you can ignore this stepsourceforge.net/projects/win32diskimager/
===Enable pikvm hdmi audio===Refer :2. Insert NVME SSD into the '''USB to NVME ssd adapter''' or [[Enable pikvm hdmi audioX876]]
===How :3. Connect '''USB to NVME SSD adapter''' or [[X876]] to switch target computers/servers===The IP KVM (X680) Switch supports direct switching computer through buttons on front panel and hotkey through keyboard connected to the special USB 1.1 port. it also supports remote hotkey switching between computers for easy monitoringA cable, then a USB drive can be recognized in computer.
====Computers/Servers Switching====Press to :4. Open '''Win32 Disk Imager''' tool, then select PC1/PC2/PC3/PC4 through buttons on front panel. the corresponding LED located on the right of the '''PiKVM os image file''' and '''USB drive''', then click '''Write''' button will be on if a PC is selected. the PC1 will be automatically selected when power applied or restored.
====Hotkey switching====* Keyboard must be connected to USB1:5.1 port (Marked with an icon of keyboard)* Press Wait a few minutes for the "Ctrl" twice quickly, then immediately press "1" write process to switch to PC1* Press the "Ctrl" twice quickly, then immediately press "2" to switch to PC2* Press the "Ctrl" twice quickly, then immediately press "3" to switch to PC3* Press the "Ctrl" twice quickly, then immediately press "4" to switch to PC4complete.
====Remote hotkey switching====* Access to PiKVM web interface and log in* Press the "Ctrl" twice quickly, then immediately press "1" to switch to PC1* Press the "Ctrl" twice quickly, then immediately press "2" to switch to PC2* Press the "Ctrl" twice quickly, then immediately press "3" to switch to PC3* Press :6. Insert NMVE SSD into the "Ctrl" twice quicklyX680, then immediately press "4" to switch to PC4* If your mouse cursor is not in the area of the PiKVM web interface, it is not functional===How to boot from NVME SSD?===1.Prepare power on (must remove the '''Win32 Disk Imager tool''' first, download and install it, refer to:https://sourceforge.net/projects/win32diskimager/micro sd card firstly)
2*'''Mass Storage Drive''':Refer to: https://docs.pikvm.org/msd/* '''Check Video Output''':<pre>ls /dev/video0</pre>: Run the above command, if you see anything such as '''/dev/video0''' other than '''file not found''', then it’s available* <span class="tb_red">'''To support max resolution 1920x1080 60Hz''' (for '''V1. Insert NVME SSD into 5''' only)</span>:<pre>nano /boot/config.txt</pre>:Change the line7 from '''dtoverlay=tc358743'''USB to NVME ssd adapter''' or [[X876]]dtoverlay=tc358743,<span class="tb_red">4lane=1</span>''':Save and exit by hitting '''CTRL + X''', answering '''Y''' and hitting Enter when prompted.
3:'''Editing the EDID''':<pre>nano /etc/kvmd/tc358743-edid.hex</pre>:Delete existing EDID data, then copy and paste below new EDID data<dd><pre>00FFFFFFFFFFFF0052628888008888881C150103800000780AEE91A3544C99260F505400000001010101010101010101010101010101011D007251D01E206E285500C48E2100001E8C0AD08A20E02D10103E9600138E2100001E000000FC00546F73686962612D4832430A20000000FD003B3D0F2E0F1E0A202020202020014F020323454F041303021211012021A23C3D3E1F102309070766030C00300080E3007F8C8C0AD08A20E02D10103E9600C48E210000188C0AD08A20E02D10103E9600138E210000188C0AA01451F01600267C4300138E21000098000000000000000000000000000000000000000000000000000000000000000000000000000087</pre></dd>:Save and exit by hitting CTRL + X, answering Y and hitting Enter when prompted. Connect * <span class="tb_red">'''USB Adding UI elements to NVME SSD adaptercontrol the KVM switch''' (for '''V1.5''' or [[X876]] to computer through USB A cable, then a USB drive can be recognized in computeronly)</span>:Edit the file: /etc/kvmd/override.yaml and include the following:<dd><pre>kvmd: gpio: scheme: button1: pin: 16 # GPIO pin number for PC1 mode: output switch: false pulse: delay: 1 max_delay: 2 button2: pin: 26 # GPIO pin number for PC2 mode: output switch: false pulse: delay: 1 max_delay: 2 button3: pin: 11 # GPIO pin number for PC3 mode: output switch: false pulse: delay: 1 max_delay: 2 button4: pin: 17 # GPIO pin number for PC4 mode: output switch: false pulse: delay: 1 max_delay: 2
4. Open '''Win32 Disk Imager''' tool, then select view: header: title: Switches # The menu title table: # The menu items are rendered in the form of a table of text labels and controls - ["#X680 IPKVM Switch"] # Text starting with the '''PiKVM os image file''' sharp symbol will be a label - [] # creates a horizontal separator and '''USB drive'''starts a new table - ["#PC1-XXXXX:", button1] # Text label for PC1, one button with text "Click" - ["#PC2-XXXXX:", button2] # Text label for PC2, one button with text "Click" - ["#PC3-XXXXX:", button3] # Text label for PC3, one button with text "Click" - ["#PC4-XXXXX:", button4] # Text label for PC4, then click '''Write''' one buttonwith text "Click"</pre></dd>:As follows
:[[File:X680v1.5-setting2. Wait a few minutes for the write process to complete.png|800px]]
6:Save and exit by hitting CTRL + X, answering Y and hitting Enter when prompted. Insert NMVE SSD into the X680, then power on (must remove the micro sd card firstly)
===Mass Storage Drive===:Then restart the kvmd service with the coomand:Refer to: https:<pre>systemctl restart kvmd<//docs.pikvm.org/msd/pre>
==FAQ==

Navigation menu