Manual Version

Disclaimer

While every effort has been made to ensure accuracy in this document, errors or omissions may still exist. Users should carefully assess its applicability; we reserve the right to make revisions at any time and do not guarantee the validity of content from previous versions. For the latest product information, please regularly visit the official website of LCSC Dev Boards for updated materials. The copyright and final interpretation of this document belong to Shenzhen JLC Technology Group Co.,Ltd. Please take note of this disclaimer and assess the risks independently when making decisions. We are not responsible for any issues arising from the use of this document. Thank you for your understanding and support.

1. Electerm

During our development work, we often use terminal tools, such as connecting to virtual machines via SSH, or using serial connections to connect to development boards for printing logs and entering debug commands. Therefore, having a convenient tool can greatly improve our productivity. Here, I recommend an open-source tool called Electerm.

Open Source Repository: https://github.com/electerm/electerm
GitHub Download Link: https://github.com/electerm/electerm/releases
Official Website Download Link: https://electerm.html5beta.com/

1. Download

This example shows how to install Electerm on Windows 10. First, go to the GitHub download page: https://github.com/electerm/electerm/releases
Download electerm-1.28.4-win-x64-installer.exe

Double-click to start the installation and keep clicking Next to proceed.

To use Electerm to connect to a virtual machine, ensure that SSH service is installed and running on the virtual machine.

1.1 Install SSH Service on the Virtual Machine

If it's already installed, you can skip this step.

To install the SSH service, run the following commands:

apt-get update

sudo apt-get install openssh-client
sudo apt-get install openssh-server

To start the SSH service, run:

/etc/init.d/ssh start
# This message indicates that the service started successfully:
[] Starting ssh (via systemctl): ssh.service.

To check if the service is running, use:

sudo ps -e | grep ssh

Finally, check the IP address of the virtual machine.

root@wucaicheng-virtual-machine:/home/wucaicheng# ifconfig
ens33: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 192.168.20.129  netmask 255.255.255.0  broadcast 192.168.20.255
        inet6 fe80::dfc7:1050:ebe5:632c  prefixlen 64  scopeid 0x20<link>
        ether 00:0c:29:e6:57:8a  txqueuelen 1000  (Ethernet)
        RX packets 21658081  bytes 32767560390 (32.7 GB)
        RX errors 21125  dropped 21141  overruns 0  frame 0
        TX packets 1771567  bytes 102577817 (102.5 MB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
        device interrupt 19  base 0x2000

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        inet6 ::1  prefixlen 128  scopeid 0x10<host>
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 659  bytes 92550 (92.5 KB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 659  bytes 92550 (92.5 KB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

1.2 Create a New SSH Connection

1. Add a new connection.

2. Enter the IP address of the device you want to connect to, but ensure the device has the SSH service running.

3. Enter the username.

4. Enter the username.

5. Enter the username.

SSH connection successful.

Note: The device you're connecting to must have the SSH service running, and ensure that you can successfully ping its IP from your Windows 10 machine. If you can't ping the device, check if you're on the same local network and whether the firewall is blocking the connection.

2. Serial Port Terminal Use

2.1 Essential for Serial Debugging

WARNING

📌 Important: Please check if your USB-to-serial module supports a baud rate of 1500000 or higher, because the serial baud rate for the LCSC Taishan-RK3566-Linux Dev Board is 1500000. Be aware of this!!

If you have a LCSC Sky Star Dev Board, congratulations! You can directly use it as a USB-to-serial tool, which perfectly supports serial debugging for the LCSC Taishan-RK3566-Linux Dev Board.

Sky Star GD32-DAPLink Tutorial (Click to See 🚀)

Serial connections are very convenient for us, and the LCSC Taishan-RK3566-Linux Dev Board has reserved a Debug interface for this purpose.

This interface is a GH1.25 4P terminal connector and the four pins are:GND、TX、RX和VCC.

So, we need to buy a GH1.25 4P terminal cable (single-headed). You can search for it on Taobao and purchase it, as the single-ended cable can be connected to DuPont wires, saving some hassle.

Click to Buy🚀

Note: This shop is not affiliated with LCSC. Be aware of it before you make a purchase.

Here is the method for making the cable, as shown in the image below:

At this point, many of you might wonder: The terminal has 4 pins, so why does the DuPont wire only have 3 pins?

This is because during the design of the LCSC Taishan-RK3566-Linux Dev Board, we directly connected the Debug port's VCC to 5V, so there's no need to connect the VCC power line. We only need to connect the TX, RX, and GND lines.

We insert one side of the terminal connector into the LCSC Taishan-RK3566-Linux Dev Board Debug serial port, and the other side of the three DuPont wires connects to the USB-to-serial module. With this, the initial setup for serial debugging is complete.

2.2 Software Usage

1. Create a new connection.
2. Select Serial Connection.
3. Choose your virtual serial port. In my case, it is COM33.
4. Select the correct baud rate. If the baud rate is incorrect, you may experience garbled text or failure to display. The correct baud rate for the Taishan development board is 1500000.

Successfully printed logs.

2. MoBaXterm

WARNING

📌 Official download address: https://mobaxterm.mobatek.net/download.html

For the Chinese version, you can search online, as there are many tutorials available.

1. Serial Debugging

1.1 Essential for Serial Debugging

DANGER

📌 Important: Please check if your USB-to-serial module supports a baud rate of 1500000 or higher, because the serial baud rate for the LCSC Taishan-RK3566-Linux Dev Board is 1500000. Be aware of this!!

If you have a LCSC Sky Star Dev Board, congratulations! You can directly use it as a USB-to-serial tool, which perfectly supports serial debugging for the LCSC Taishan-RK3566-Linux Dev Board.

Sky Star GD32-DAPLink Tutorial (Click to See 🚀)

Serial connections are very convenient for us, and the LCSC Taishan-RK3566-Linux Dev Board has reserved a Debug interface for this purpose.

This interface is a GH1.25 4P terminal interface, and the 4 pins are: GND、TX、RX和VCC.

Therefore, we need to purchase GH1.25 4P terminal wires (single-head) which you can directly search for and buy on Taobao. The single-ended wire can connect to DuPont wires, which saves us some trouble.

Click 🚀

This store has no cooperation with LCSC. Please be aware.

The setup method is shown in the image below:

At this point, many people may wonder: the terminal clearly has 4 pins, why do the DuPont wires only have three pins?

This is because, when designing the Taishan board, we connected the Debug port's VCC directly to 5V, so there's no need to connect the VCC power line. We only need the TX, RX, and GND wires.

We insert one side of the terminal connector into the LCSC Taishan-RK3566-Linux Dev Board Debug serial port, and the other side of the three DuPont wires connects to the USB-to-serial module. With this, the initial setup for serial debugging is complete.

1.2 Software Usage

Right-click and open the MoBaXterm software as an administrator, and you'll see this interface:

Click on Session, then select Serial.

Choose the COM port number; here, it's COM29.

Click on the baud rate and directly input: 1500000 (note that you shouldn't click the dropdown on the right because 1500000 is not in the options, so just type it in).

Click settings to configure (follow the setup as shown in the image below):

Then click OK:

A blank window will appear:

At this point, you can press Enter to start using it:

2. SSH

2.1 Introduction

SSH is a commonly used method for remote debugging. The Taishan-RK3566 development board offers multiple network connection methods, including but not limited to: USB shared networking, extended Ethernet connections, and Wi-Fi connections, etc.

UUSB Shared Networking Tutorial Document:

2.2 SSH Installation

WARNING

📌 Note: SSH installation must be performed in an environment with network access.

Update apt-get

sudo apt-get update

Install SSH client

sudo apt-get install openssh-client

Install SSH server

sudo apt-get install openssh-server

Check if installation is complete

ps -e|grep ssh

If sshd and ssh-agent appear, it means both the server and client are up and running.

If sshd is missing, it means the SSH service has not been started or installed.

If ssh-agent is missing, and the installation was successful, you can use the following command:

eval ssh-agent

Then check again, and you'll see that the missing ssh-agent has appeared.

2.3 SSH File Configuration

Use the following command to open the sshd_config file:

vim /etc/ssh/sshd_config

Remove the # before Port, then set your desired port number. It is recommended not to use a port number less than 6000!

In this case, we will modify the port to 8080. The default port is: 22 If you don't change the port, the system will use the default port.

After opening the file, find the line indicated by the arrow and remove the #at the beginning.

If this line is not present, add it manually!

Once you've made the changes, restart SSH to apply the configuration:

sudo /etc/init.d/ssh restart

The restart will be successful.

2.4 Check IP Address

After connecting Ubuntu to the network, enter the following command to check the local IP address:

sudo ifconfig

Only usb0 has the inet option. The IP address above is: 192.168.137.190 (remember this IP as it will be used for remote SSH login).

Note:

• Depending on your connection method, the network interface may differ. I am using USB network sharing, so the network interface shown is usb0.
• The IP address for the lo interface is: 127.0.0.1, which is the local loopback address. It does not provide external network connectivity and is only used for local debugging. There is a lot of information online about loopback addresses.

2.5 Using the Software

Next, click on the session and then click SSH.

Enter the IP address of the Taishan board and change the port to 8080.

Note: The IP address and port number are mentioned in the previous documentation.

Click OK.

A confirmation window will pop up. Click Agree.

It may not pop up, in which case you can ignore it.

Enter the username: root, then press Enter.

Then enter the password: lckfb.

Note: The password will not be visible.

After pressing Enter, a pop-up will appear asking whether to save the password (choose according to your preference).

Choose not to save.

This will successfully establish the SSH remote connection.