Changes

Jump to navigation Jump to search

X680

4,996 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]]
[[File:X680-IMG-5615-3.jpg|500px]]Power the device via PWR DC Jack with 5V Power adaper
2:4. Then rerfer to [https://www. Connect CM4 USB port with a Typejeffgeerling.com/blog/2020/how-flash-raspberry-pi-os-compute-A to Typemodule-4-emmc-B cable usbboot this tutorial] to your computer as follow:flash raspberry pi OS
[[File:X680-IMG-5546-35.jpg|500px]]Remove the jumper of nBOOT after flashing is complete, then restart your device;
3:'''PS:If you use CM4 with eMMC, then SD card cannot be used. Power the device via PWR DC Jack with 5V Power adaper'''
4. Then rerfer ===Configuring the PiKVM OS===* '''Login web UI''': Access to [PiKVM Web Interface via any browser with the URL '''https://www.jeffgeerling.compikvm/''' OR '''https://blogIP''' address of your ipkvm/2020, the default user and password is admin/how-flash-raspberry-pi-os-compute-module-4-emmc-usbboot this tutorial] admin* '''Log into PiKVM and open Terminal program'''* '''Switch to flash raspberry pi 'root' user ''':<pre>su root</pre>:then type the password, and the default password is 'root' also.* '''Switch OSto writable mode''':<pre>rw</pre>
* '''Enable RTC''' ('''Only for X680 V1.3''' because v1.3 use the ds1307 chip, Please skip this step if you X680 V1.5using the same chip pcf8563 with pikvm official product):1. Remove the jumper of nBOOT after flashing is completeDue to different RTC chips with official PiKVM hardware, then restart your device;you still need to '''configure RTC''' to make RTC work normally.
:2. Insert the '''PS:If you use CM4 with eMMC, then SD card cannot be used.C1220'''button battery. run the following command in web terminal window:
:3. Edit the /boot/config.txt file, and change line <code>dtoverlay=i2c-rtc,pcf8563</code> to <code>dtoverlay==Enable RTC ===Due i2c-rtc,ds1307</code> (due to use the different RTC chips with official PiKVM hardware, you still need to chip).:<pre>sudo nano /boot/config.txt</pre>:Then save & '''configure RTCreboot''' to make RTC work normally.the device;
Firstly:Test & setting RTC, insert write&read the '''C1220''' button battery. run the following command in web terminal window:time of Raspberry Pi to RTC DS1307<dd><pre>date sudo hwclock -w sudo hwclock -r</pre></dd>
1. switch to *'''Enable OLED display''root' user su root:Run the following command in web terminal window to enable OLED display::<pre>systemctl enable --now kvmd-oled kvmd-oled-reboot kvmd-oled-shutdown </pre>then type :If you are using <code>PiKVM OS V3 Pre-Assembled</code>, the passwordOLED configuration is already pre-installed, and you can ignore this step.: Rotate the OLED display by 180 degrees (Optional):<pre>nano /usr/bin/kvmd-oled</pre>:Change the default password is line: return {"height": 64, "rotate": '''2'''} to return {"height": 64, "rotate": '''0''root' also.}, then save & exit
2. Switch OS to writable mode rw3. Edit the /boot/config.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). sudo nano /boot/config.txtThen save & * '''rebootEnable pikvm hdmi audio''' the device;:Refer to [[Enable pikvm hdmi audio]]
4.Test & setting RTC, write&read the time of Raspberry Pi * '''How to RTC DS1307switch target computers/servers''' date sudo hwclock -w sudo hwclock -r:The IP KVM (X680) Switch supports direct switching 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 monitoring.
5:'''Computers/Servers Switching'''::Press to select PC1/PC2/PC3/PC4 through buttons on front panel. the corresponding LED located on the right of the button will be on if a PC is selected. Swith OS to readonly mode rothe PC1 will be automatically selected when power applied or restored.
===Enable OLED display===:'''Hotkey switching'''Run :* Keyboard must be connected to USB1.1 port (Marked with an icon of keyboard):* Press the following command in web terminal window "Ctrl" twice quickly, then immediately press "1" to enable OLED displayswitch to PC1:* Press the "Ctrl" twice quickly, then immediately press "2" to switch to PC2 rw:* Press the "Ctrl" twice quickly, then immediately press "3" to switch to PC3 systemctl enable --now kvmd-oled roIf you are using <code>PiKVM OS V3 Pre-Assembled</code>, :* Press the OLED configuration is already pre-installed"Ctrl" twice quickly, you can ignore this step.then immediately press "4" to switch to PC4
===Enable pikvm hdmi audio===:'''Remote hotkey switching'''Refer :* Access to [[Enable pikvm hdmi audio]]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 PC4:* If your mouse cursor is not in the area of the PiKVM web interface, it is not functional
===*How to switch target computers/servers===boot from NVME SSD?The IP KVM (X680) Switch supports direct switching through buttons on front panel and hotkey through keyboard connected to the special USB :1.1 port. Prepare the '''Win32 Disk Imager tool''' first, download and install it also supports remote hotkey switching between computers for easy monitoring, refer to:https://sourceforge.net/projects/win32diskimager/
====Computers/Servers Switching====Press to select PC1/PC2/PC3/PC4 through buttons on front panel:2. Insert NVME SSD into the corresponding LED located on the right of the button will be on if a PC is selected. the PC1 will be automatically selected when power applied '''USB to NVME ssd adapter''' or restored.[[X876]]
====Hotkey switching====* Keyboard must be connected to USB1:3.1 port (Marked with an icon of keyboard)* Press the "Ctrl" twice quickly, then immediately press "1" Connect '''USB to switch NVME SSD adapter''' or [[X876]] to PC1* Press the "Ctrl" twice quicklycomputer through USB A cable, 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 PC4a USB drive can be recognized in computer.
====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 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 the Open '''Win32 Disk Imager ''' tool, then select the '''PiKVM os image file''' first, download and install it'''USB drive''', refer to:https://sourceforge.net/projects/win32diskimager/then click '''Write''' button
2:5. Insert NVME SSD into Wait a few minutes for the '''USB write process to NVME ssd adapter''' or [[X876]]complete.
3:6. Connect '''USB to NVME Insert NMVE SSD adapter''' or [[X876]] to computer through USB A cableinto the X680, then a USB drive can be recognized in computer.power on (must remove the micro sd card firstly)
4*'''Mass Storage Drive''':Refer to: https://docs.pikvm. Open org/msd/* '''Check Video Output''':<pre>ls /dev/video0</pre>: Run the above command, if you see anything such as '''/dev/video0''' other than '''Win32 Disk Imagerfile not found''' tool, then select it’s available* <span class="tb_red">'''To support max resolution 1920x1080 60Hz''' (for '''V1.5''' only)</span>:<pre>nano /boot/config.txt</pre>:Change the line7 from '''PiKVM os image filedtoverlay=tc358743''' to '''dtoverlay=tc358743,<span class="tb_red">4lane=1</span>''' :Save and exit by hitting '''USB driveCTRL + X''', then click answering '''WriteY''' buttonand hitting Enter when prompted.
:'''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.* <span class="tb_red">'''Adding UI elements to control the KVM switch''' (for '''V1.5''' only)</span>:Edit the file: /etc/kvmd/override. Wait a few minutes 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 the write process to complete.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
6. Insert NMVE SSD into view: header: title: Switches # The menu title table: # The menu items are rendered in the form of a table of text labels and controls - ["#X680IPKVM Switch"] # Text starting with the sharp symbol will be a label - [] # creates a horizontal separator and 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, one button with text "Click"</pre></dd>:Save and exit by hitting CTRL + X, then power on (must remove the micro sd card firstly)answering Y and hitting Enter when prompted.
===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