Changes

==User Manual=====Hardware connection Connection & installation Video===

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.

: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.

: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 :5. Remove the jumper of nBOOT after flashing is complete, then restart your device; :'''PS：If you use CM4 with eMMC, then SD card cannot be used.''' ===Configuring the PiKVM OS===* '''Login web UI''': Access 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.* '''Switch OS to writable mode''':<pre>rw</pre>

[[File:* '''Enable RTC''' ('''Only for X680-IMG-5615-V1.3''' because v1.3use the ds1307 chip, Please skip this step if you X680 V1.5 using the same chip pcf8563 with pikvm official product):1. Due to different RTC chips with official PiKVM hardware, you still need to '''configure RTC''' to make RTC work normally.jpg|500px]]

:2. Connect CM4 USB port with a Type-A to Type-B cable to your computer as followInsert the '''C1220''' button battery. run the following command in web terminal window:

[[File:X6803. Edit the /boot/config.txt file, and change line <code>dtoverlay=i2c-IMGrtc,pcf8563</code> to <code>dtoverlay=i2c-5546-3rtc,ds1307</code> (due to use the different RTC chip).:<pre>sudo nano /boot/config.jpg|500px]]txt</pre>:Then save & '''reboot''' the device;

3. Power :Test & setting RTC, write&read the device via PWR DC Jack with 5V Power adapertime of Raspberry Pi to RTC DS1307<dd><pre>date sudo hwclock -w sudo hwclock -r</pre></dd>

4. Then rerfer *'''Enable OLED display''':Run the following command in web terminal window to [httpsenable OLED display:://www.jeffgeerling.com/blog/2020/how<pre>systemctl enable -flash-raspberrynow kvmd-pioled kvmd-osoled-computereboot kvmd-moduleoled-4shutdown </pre>:If you are using <code>PiKVM OS V3 Pre-emmcAssembled</code>, the OLED configuration is already pre-usbboot installed, you can ignore this tutorial] 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 flash raspberry pi OSreturn {"height": 64, "rotate": '''0'''}, then save & exit

*How to boot from NVME SSD？:1.Prepare the '''PS：If you use CM4 with eMMC, then SD card cannot be used.Win32 Disk Imager tool'''first, download and install it, refer to:https://sourceforge.net/projects/win32diskimager/

===Enable RTC ===Due to different RTC chips with official PiKVM hardware, you still need to :2. Insert NVME SSD into the '''configure RTCUSB to NVME ssd adapter''' to make RTC work normally.or [[X876]]

Firstly, insert the :3. Connect '''C1220USB to NVME SSD adapter''' button batteryor [[X876]] to computer through USB A cable, then a USB drive can be recognized in computer. run the following command in web terminal window:

1:4. switch to Open 'root' user su root'Win32 Disk Imager''' tool, then type select the password'''PiKVM os image file''' and '''USB drive''', and the default password is then click '''Write''root' also.button

2:5. Switch OS to writable mode rw3. Edit Wait a few minutes for the /boot/config.txt file, and change line <code>dtoverlay=i2c-rtc,pcf8563</code> write process to <code>dtoverlay=i2c-rtc,ds1307</code> (due to use the different RTC chip)complete. sudo nano /boot/config.txtThen save & '''reboot''' the device;

4:6.Test & setting RTCInsert NMVE SSD into the X680, write&read then power on (must remove the time of Raspberry Pi to RTC DS1307 date sudo hwclock -w sudo hwclock -rmicro sd card firstly)

*'''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.5''' only)</span>:<pre>nano /boot/config. Swith OS txt</pre>:Change the line7 from '''dtoverlay=tc358743''' to readonly mode'''dtoverlay=tc358743,<span class="tb_red">4lane=1</span>''' ro:Save and exit by hitting '''CTRL + X''', answering '''Y''' and hitting Enter when prompted.

===Enable OLED display===:'''Editing the EDID''':<pre>nano /etc/kvmd/tc358743-edid.hex</pre>Run the following command in web terminal window to enable OLED display:Delete existing EDID data, then copy and paste below new EDID data<dd><pre>00FFFFFFFFFFFF0052628888008888881C150103800000780AEE91A3544C99260F505400000001010101010101010101010101010101011D007251D01E206E285500C48E2100001E8C0AD08A20E02D10103E9600138E2100001E000000FC00546F73686962612D4832430A20000000FD003B3D0F2E0F1E0A202020202020014F020323454F041303021211012021A23C3D3E1F102309070766030C00300080E3 rw007F8C8C0AD08A20E02D10103E9600C4 systemctl enable --now kvmd-oled 8E210000188C0AD08A20E02D10103E9600138E210000188C0AA01451F01600267C4300138E210000980000000000000000000000000000000000000000000000 ro00000000000000000000000000000087If you are using <code/pre>PiKVM OS V3 Pre-Assembled</codedd>:Save and exit by hitting CTRL + X, answering Y and hitting Enter when prompted.* <span class="tb_red">'''Adding UI elements to control the OLED configuration is already KVM switch''' （for '''V1.5''' only)</span>:Edit the file: /etc/kvmd/override.yaml and include the following:<dd><pre-installed, you can ignore this step.>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

===Enable pikvm hdmi audio=== view:Refer to 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 sharp symbol will be a label - [] # creates a horizontal separator and starts a new table - [Enable pikvm hdmi audio"#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>:As follows

===How to switch target computers/servers===The IP KVM (X680) Switch supports direct switching through buttons on front panel and hotkey through keyboard connected to the special USB 1:[[File:X680v1.1 port. it also supports remote hotkey switching between computers for easy monitoring5-setting2.png|800px]]

====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. the PC1 will be automatically selected :Save and exit by hitting CTRL + X, answering Y and hitting Enter when power applied or restoredprompted.

====Hotkey switching====* Keyboard must be connected to USB1.1 port (Marked :Then restart the kvmd service with an icon of keyboard)* 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 PC3coomand:* Press the "Ctrl" twice quickly, then immediately press "4" to switch to PC4:<pre>systemctl restart kvmd</pre>

====Remote hotkey switching====* Access to PiKVM web interface and log in* Press the "Ctrl" twice quickly, then immediately press "1" '''How to switch to PC1target computers/servers'''* Press the "Ctrl" twice quickly, then immediately press "2" to switch :The IP KVM (X680) Switch supports direct switching through buttons on front panel and hotkey through keyboard connected 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？===special USB 1.1port.Prepare the '''Win32 Disk Imager tool''' first, download and install it, refer to:https://sourceforgealso supports remote hotkey switching between computers for easy monitoring.net/projects/win32diskimager/

2. Insert NVME SSD into the :'''USB to NVME ssd adapterComputers/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. the PC1 will be automatically selected when power applied or [[X876]]restored.

3. Connect :'''USB to NVME SSD adapterHotkey switching''' or [[X876]] :* Keyboard must be connected to USB1.1 port (Marked with an icon of keyboard):* Press the "Ctrl" twice quickly, then immediately press "1" to switch to PC1:* Press the "Ctrl" twice quickly, then immediately press "2" to computer through USB A cableswitch to PC2:* Press the "Ctrl" twice quickly, then a USB drive can be recognized in computer.immediately press "3" to switch to PC3:* Press the "Ctrl" twice quickly, then immediately press "4" to switch to PC4

4. Open :'''Win32 Disk ImagerRemote hotkey switching''' tool:* 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 select 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 os image file''' and '''USB drive'''web interface, then click '''Write''' buttonit is not functional

5. Wait a few minutes :''' Switching hosts in the Web UI''' (only for the write process to complete<span class="tb-red">V1.5</span>）

6:To switch between hosts, enter the KVM UI and click the "Switches" menu. Insert NMVE SSD into Click the X680, then power on (must remove the micro sd card firstly)buttons.

===Mass Storage Drive===Refer to: https[[File://docsX680v1.pikvm5-setting3.org/msd/png|800px]]