GigaDevice Semiconductor GD32VW553 User manual

GigaDevice Semiconductor Inc.
GD32VW553 Basic Commands User Guide
Application Note
AN153
Revision 1.0
(Nov.2023)

AN153
GD32VW553 Basic Commands User Guide
2
Table of Contents
Table of Contents ...........................................................................................................2
List of Figures ................................................................................................................4
List of Tables ..................................................................................................................6
1. Basic user commands..........................................................................................7
1.1. help............................................................................................................................... 7
1.2. reboot ........................................................................................................................... 8
1.3. tasks ............................................................................................................................. 8
1.4. free................................................................................................................................ 8
1.5. sys_ps .......................................................................................................................... 9
1.6. cpu_stats...................................................................................................................... 9
1.7. Wi-Fi ........................................................................................................................... 10
1.7.1. wifi_open............................................................................................................................... 10
1.7.2. wifi_close .............................................................................................................................. 10
1.7.3. wifi_debug..............................................................................................................................11
1.7.4. wifi_scan ................................................................................................................................11
1.7.5. wifi_concurrent.......................................................................................................................11
1.7.6. wifi_connect ...........................................................................................................................11
1.7.7. wifi_connect_bssid................................................................................................................ 12
1.7.8. wifi_disconnect...................................................................................................................... 12
1.7.9. wifi_auto_conn ...................................................................................................................... 13
1.7.10. wifi_status ............................................................................................................................. 13
1.7.11. wifi_monitor........................................................................................................................... 14
1.7.12. wifi_ps ................................................................................................................................... 14
1.7.13. wifi_ap................................................................................................................................... 15
1.7.14. wifi_ap_adv ........................................................................................................................... 15
1.7.15. wifi_stop_ap .......................................................................................................................... 15
1.7.16. wifi_set_ip ............................................................................................................................. 15
1.7.17. wifi_mac_addr....................................................................................................................... 16
1.8. ping............................................................................................................................. 16
1.9. join_group.................................................................................................................. 18
1.10. iperf3 ....................................................................................................................... 18
1.10.1. iperf3 -h................................................................................................................................. 18
1.10.2. iperf3 -s [options] .................................................................................................................. 18
1.10.3. iperf3 -c <host> [options] ...................................................................................................... 19
1.10.4. iperf3 stop ............................................................................................................................. 20

AN153
GD32VW553 Basic Commands User Guide
3
1.10.5. iperf3 test example ............................................................................................................... 20
1.11. iperf ......................................................................................................................... 20
1.11.1. iperf -h................................................................................................................................... 21
1.11.2. iperf -s [options] .................................................................................................................... 21
1.11.3. iperf -c <host> [options] ........................................................................................................ 21
1.11.4. iperf exit ................................................................................................................................ 22
1.11.5. iperf2 test example ............................................................................................................... 22
1.12. BLE.......................................................................................................................... 23
1.12.1. ble_help ................................................................................................................................ 23
1.12.2. ble_enable ............................................................................................................................ 24
1.12.3. ble_disable............................................................................................................................ 25
1.12.4. ble_ps ................................................................................................................................... 25
1.12.5. ble_courier_wifi ..................................................................................................................... 26
1.12.6. ble_adv ................................................................................................................................. 27
1.12.7. ble_adv_stop......................................................................................................................... 27
1.12.8. ble_adv_restart ..................................................................................................................... 28
1.12.9. ble_scan................................................................................................................................ 29
1.12.10. ble_scan_stop ................................................................................................................... 29
1.12.11. ble_list_scan_devs............................................................................................................ 29
1.12.12. ble_sync ............................................................................................................................ 30
1.12.13. ble_sync_cancel ............................................................................................................... 31
1.12.14. ble_sync_terminate........................................................................................................... 31
1.12.15. ble_sync_ctrl ..................................................................................................................... 32
1.12.16. ble_conn............................................................................................................................ 33
1.12.17. ble_cancel_conn ............................................................................................................... 34
1.12.18. ble_disconn ....................................................................................................................... 34
1.12.19. ble_list_sec_devs.............................................................................................................. 35
1.12.20. ble_remove_bond ............................................................................................................. 35
1.12.21. ble_set_auth...................................................................................................................... 36
1.12.22. ble_pair ............................................................................................................................. 37
1.12.23. ble_passkey ...................................................................................................................... 38
1.12.24. ble_encrypt........................................................................................................................ 38
1.12.25. ble_compare ..................................................................................................................... 39
1.12.26. ble_peer_feat .................................................................................................................... 39
1.12.27. ble_peer_ver ..................................................................................................................... 40
1.12.28. ble_get_rssi....................................................................................................................... 40
1.12.29. ble_param_update ............................................................................................................ 41
1.12.30. ble_set_phy....................................................................................................................... 41
1.12.31. ble_get_phy....................................................................................................................... 42
1.12.32. ble_set_pkt_size ............................................................................................................... 42
2. Revision history..................................................................................................44

AN153
GD32VW553 Basic Commands User Guide
4
List of Figures
Figure 1-1. help command................................................................................................................... 7
Figure 1-2. tasks command ................................................................................................................. 8
Figure 1-3. free command.................................................................................................................... 9
Figure 1-4. sys_ps command .............................................................................................................. 9
Figure 1-5. cpu_stats command ....................................................................................................... 10
Figure 1-6. wifi_scan command .........................................................................................................11
Figure 1-7. Wifi_connect command.................................................................................................. 12
Figure 1-8. wifi_status command ..................................................................................................... 13
Figure 1-9. wifi_monitor command................................................................................................... 14
Figure 1-10. wifi_ps command .......................................................................................................... 14
Figure 1-11. wifi_ap command .......................................................................................................... 15
Figure 1-12. wifi_set_ip command.................................................................................................... 16
Figure 1-13. ping command............................................................................................................... 17
Figure 1-14. ping stop command ...................................................................................................... 17
Figure 1-15. iperf3 -h command ........................................................................................................ 18
Figure 1-16. iperf -h command .......................................................................................................... 21
Figure 1-17. ble_help command (msdk configuration) .................................................................. 23
Figure 1-18. ble_help command (msdk_ffd configuration)............................................................ 24
Figure 1-19. ble_enable command ................................................................................................... 25
Figure 1-20. ble_disable command .................................................................................................. 25
Figure 1-21. ble_ps command........................................................................................................... 26
Figure 1-22. ble_courier_wifi command........................................................................................... 26
Figure 1-23. ble_adv command......................................................................................................... 27
Figure 1-24. ble_adv_stop command ............................................................................................... 28
Figure 1-25. ble_adv_restart command ........................................................................................... 28
Figure 1-26. ble_scan command....................................................................................................... 29
Figure 1-27. ble_scan_stop command ............................................................................................. 29
Figure 1-28. ble_list_scan_devs command ..................................................................................... 30
Figure 1-29. ble_sync command....................................................................................................... 31
Figure 1-30. ble_sync_cancel command ......................................................................................... 31
Figure 1-31. ble_sync_terminate command .................................................................................... 32
Figure 1-32. ble_sync_ctrl command ............................................................................................... 33
Figure 1-33. ble_conn command ...................................................................................................... 34
Figure 1-34. ble_cancel_conn command ......................................................................................... 34
Figure 1-35. ble_disconn command ................................................................................................. 35
Figure 1-36. ble_list_sec_devs command ....................................................................................... 35
Figure 1-37. ble_remove_bond command ....................................................................................... 36
Figure 1-38. ble_set_auth command ................................................................................................ 37
Figure 1-39. ble_pair command ........................................................................................................ 37
Figure 1-40. ble_passkey command................................................................................................. 38

AN153
GD32VW553 Basic Commands User Guide
5
Figure 1-41. ble_encrypt command .................................................................................................. 38
Figure 1-42. ble_compare command ................................................................................................ 39
Figure 1-43. ble_peer_feat command............................................................................................... 40
Figure 1-44. ble_peer_ver command ................................................................................................ 40
Figure 1-45. ble_get_rssi command ................................................................................................. 41
Figure 1-46. ble_param_update command ...................................................................................... 41
Figure 1-47. ble_set_phy command ................................................................................................. 42
Figure 1-48. ble_get_phy command ................................................................................................. 42
Figure 1-49. ble_set_pkt_size command ......................................................................................... 43

AN153
GD32VW553 Basic Commands User Guide
6
List of Tables
Table 2-1. Revision history ................................................................................................................ 44

AN153
GD32VW553 Basic Commands User Guide
7
1. Basic user commands
Connect the test machine to the development board through a USB cable. Open the UART
tool, and connect it to the correct COM port. After powering on and starting the development
board correctly, issue a command through the UART tool, and the development board can
complete the corresponding operation according to the command content.
In this manual, < > after the command indicates that the option is required, and [ ] indicates
that the option is optional. Note that the commands are strictly case-sensitive.
1.1. help
The command has no option.
As shown in Figure 1-1. help command, the help command lists all commands supported
by the development board.
Note: View BLE related commands through the ble_help command.
Figure 1-1. help command

AN153
GD32VW553 Basic Commands User Guide
8
1.2. reboot
The command has no option.
After the command is executed, the development board will restart and the serial port will print
the start information. The command has a similar function as that of the reset button.
1.3. tasks
The command has no option.
After the command is executed, task-related information, including the status, priority,
remaining minimum stack space for the task since task creation, task No., and the base
address of the stack used by the task, will be printed, as shown in Figure 1-2. tasks
command.
Figure 1-2. tasks command
1.4. free
The command has no option.
After the command is executed, heap related information, including remaining heap, used
heap, maximum used heap, maximum available heap, and the address and size of each
available mem block, will be printed, as shown in Figure 1-3. free command.

AN153
GD32VW553 Basic Commands User Guide
9
Figure 1-3. free command
1.5. sys_ps
Figure 1-4. sys_ps command
Figure 1-4. sys_ps command shows how to use the command. There are three modes:
Leave blank: No settings. Only print the current CPU power save mode;
0: Disable CPU power save.
1: Enable CPU power save. The mode is deep sleep. When the CPU is idle, it automatically
enters the deep sleep mode, and then it can be automatically woken up by wifi/ble or actively
woken up by a uart rx event.
1.6. cpu_stats
The command has no option.
After this command is executed, the CPU usage of each task will be printed, including running
time. as shown in Figure 1-5. cpu_stats command.

AN153
GD32VW553 Basic Commands User Guide
10
Figure 1-5. cpu_stats command
1.7. Wi-Fi
This section introduces Wi-Fi related commands.
1.7.1. wifi_open
The command has no option.
This command is used to enable WiFi functions. Other WiFi-related commands can be
executed provided that WiFi is enabled. After the development board is started correctly, WiFi
is enabled by default, so this command is unnecessarily executed to repeatedly enable WiFi.
This command generally works with wifi_close by enabling WiFi after it is turned off by
wifi_close. If WiFi is enabled, the serial port will give a prompt.
1.7.2. wifi_close
The command has no option.
wifi_close can turn off WiFi, but in this case, some commands, such as wifi_scan and
wifi_connect, can not be executed.
The command has different execution results for different conditions of the development
board:
If the development board is connected to AP, the command will disconnect them and
then turn off WiFi.
If the development board is not connected to AP, the command will directly turn off WiFi.
If the development board in softAP mode is connected to sta, the command will
disconnect them and then turn off WiFi.
If the development board in softAP mode is not connected to sta, the command will
directly turn off WiFi.
If WiFi is turned off, the serial port will give a prompt.

AN153
GD32VW553 Basic Commands User Guide
11
1.7.3. wifi_debug
Usage: wifi_debug <0 or 1>
This command is used to control the printing of WiFi debug logs. 0 means printing is disabled,
while 1 means printing is enabled.
1.7.4. wifi_scan
The command has no option. The development board cannot be in softap mode when the
command is executed.
After the command is executed, AP information scanned by the development board, including
RSSI, channel, BSSID, SSID, and encryption method, will be printed, as shown in Figure 1-6.
wifi_scan command.
Figure 1-6. wifi_scan command
1.7.5. wifi_concurrent
Usage: wifi_concurrent [0 or 1]
This command is used to control enabling of wifi concurrent mode. 0 means the mode is
disabled, while 1 means the mode is enabled. When this option is not set, the current enabled
state is printed only.
This command can not be executed until the macro CFG_WIFI_CONCURRENT in
MSDK\macsw\export\ wlan_config.h file is opened.
1.7.6. wifi_connect
Usage: wifi_connect <SSID> [PASSWORD]

AN153
GD32VW553 Basic Commands User Guide
12
The command is used to connect to an AP. The development board cannot be in softap mode
when the command is executed.
wifi_connect <SSID>
It is used to connect to an unencrypted AP.
wifi_connect <SSID> <PASSWORD>
It is used to connect to an encrypted AP.
The connection process is as shown in Figure 1-7. Wifi_connect command, and the serial
port prints out the connection process information. If the wifi_connect command is executed
after the AP is connected, the development board will first disconnect from the original AP and
then connect to the new AP.
Figure 1-7. Wifi_connect command
1.7.7. wifi_connect_bssid
Usage: wifi_connect_bssid <BSSID> [PASSWORD]
This command is similar to the wifi_connect command, executed by using the same method.
The only difference is that SSID in the option is modified to BSSID.
1.7.8. wifi_disconnect
The command has no option.
After the command is executed, the development board will disconnect from the AP. If the
execution is successful, the serial port will print the following information:
MAC: deauth send
MGMT: disconnect complete

AN153
GD32VW553 Basic Commands User Guide
13
1.7.9. wifi_auto_conn
Usage: wifi_auto_conn [0 or 1]
This command is used to set automatic connection to AP upon startup or not. 0 means no
automatic connection, while 1 means automatic connection. When this option is not set, the
current settings are printed only.
If automatic connection is set, when AP is successfully connected again, AP information will
be saved in flash; however, if AP is repeatedly connected, the AP successfully connected last
will be recoded as valid AP. Rebooted development board will be automatically connected to
AP according to AP information in flash. If AP is not connected after automatic connection is
set, rebooted development board will not be automatically connected to AP.
1.7.10. wifi_status
The command has no option.
After the command is executed, the serial port will print the Wi-Fi status of the current
development board.
Wi-Fi currently has three modes: SoftAP, MONITOR, and STATION. The information printed
by the command in different modes is different, as shown in Figure 1-8. wifi_status
command.
Figure 1-8. wifi_status command

AN153
GD32VW553 Basic Commands User Guide
14
This first line shows MAC address of the current Wi-Fi device; the second line shows the
mode of the current Wi-Fi device, one of the above three modes.
In AP mode, the status, SSID, channel, encryption method, and IP address will be displayed.
If any devices are connected to this AP, the information of these devices, including the MAC
address and IP address, will also be displayed, and multiple devices will be sorted in
sequence.
In STATION mode, WIFI Status indicates whether the current Wi-Fi device is connected to
the AP; Connected means connected, and Disconnected means disconnected. If it is
connected, the SSID, BSSID, and channel of the AP will be displayed.
1.7.11. wifi_monitor
Usage: wifi_monitor stop | start <channel>
Figure 1-9. wifi_monitor command shows how to use the command. The wifi_monitor start
<channel> command is used to start the monitor mode, and the monitoring channel needs to
be specified; the wifi_monitor stop command is used to close the monitor mode and switch to
the station mode.
Figure 1-9. wifi_monitor command
1.7.12. wifi_ps
Usage: wifi_ps <mode>
Figure 1-10. wifi_ps command
Figure 1-10. wifi_ps command shows how to use the command. There are three modes:
0: Disable power save;
1: Enable power save. The mode is Normal mode, and the Wi-Fi module will always be in
power save mode;
2: Enable power save. The mode is Dynamic mode, and the Wi-Fi module will decide whether
to enter or exit the power save mode based on the wifi TX/RX traffic;

AN153
GD32VW553 Basic Commands User Guide
15
1.7.13. wifi_ap
Usage: wifi_ap <ssid> <password> <channel> [-a <akm>[,<akm 2>]] [-hide <hide_ap>]
The command is used to enable or disable the softap mode. Figure 1-11. wifi_ap command
shows how to use the command.
Figure 1-11. wifi_ap command
ssid does not support Chinese characters. When "NULL" is filled in the password, it means
that an open AP is enabled, and the -a configuration will be ignored. In addition, if an
encrypted AP is enabled and the -a option is not configured to specify the encryption method,
the default is wpa2 encryption.
1.7.14. wifi_ap_adv
This command is executed by using the same method as that for the wifi_ap command.
1.7.15. wifi_stop_ap
The command has no option. After the command is executed, the Softap mode will stop and
switch to the station mode. If the execution is successful, the serial port will print the following
information:
SoftAP successfully stoped!
1.7.16. wifi_set_ip
Usage: wifi_set_ip dhcp |<ip_addr> <gate_way>
The command is used to manually set a static IP address or automatically get an IP address
through DHCP in station mode. It can also set the IP address and gateway in softap mode.
Figure 1-12. wifi_set_ip command shows how to use the command.

AN153
GD32VW553 Basic Commands User Guide
16
Figure 1-12. wifi_set_ip command
1.7.17. wifi_mac_addr
Usage: wifi_mac_addr [xx:xx:xx:xx:xx:xx]
This command is used to set temporary mac address of WiFi, which will become invalid after
reboot or power-down reboot.
When this option is not set, the current mac address is printed only.
1.8. ping
Usage: ping <target_ip | stop> [-n count] [-l size] [-i interval] [-t total time]
The command is used to perform the ping test.
The target_ip is a peer address. IPv4 is in a format of <ipv4_addr>, while IPv6 is in a format
of <-6 ipv6_addr> (provided that Ipv6 is enabled).
In the parameters of the command, count indicates the number of ping packets; size indicates
the packet length, in bytes; interval indicates the packet sending interval, in milliseconds; total
time indicates the total running time, in seconds. By default, count is 5, size is 120, interval is
10, and total time is not used; if the total time option is used, the count and interval options
do not work; interval defaults to 1000 ms, and count will be equal to the total time value.
Figure 1-13. ping command shows how to use the ping command.

AN153
GD32VW553 Basic Commands User Guide
17
Figure 1-13. ping command
ping stop
This command is used to stop the ping test, as shown in Figure 1-14. ping stop command,
Figure 1-14. ping stop command

AN153
GD32VW553 Basic Commands User Guide
18
1.9. join_group
Usage: join_group <group ip eg:224.0.0.5>
The development board must be connected to the AP before the command is executed. After
the command is executed, the development board will join a multicast group, such as:
join_group 224.0.0.5
During this period, sniffer can be used to capture the IGMP protocol packet sent by the
development board after the command is executed.
1.10. iperf3
The iperf3 command uses iperf3 for network speed test.
1.10.1. iperf3 -h
As shown in Figure 1-15. iperf3 -h command, the serial port will print out the options related
to the iperf3 command.
Figure 1-15. iperf3 -h command
1.10.2. iperf3 -s [options]
iperf3 -s
Enable an iperf3 server to listen to TCP/UDP data on port 5201 by default. Other options are
default values.
-p <port>

AN153
GD32VW553 Basic Commands User Guide
19
Set the port that the server listens on. The port range is 0-65535, and the default is 5201.
For example: iperf3 -s -p 5003
The server listens on port 5003.
-i <interval>
Set the period of the test results printed by the serial port (Interval column), in seconds, with
a range of 0.1-60 and 0. When it is set to 0, it means that no periodic report is printed and
only the final test results are output. The default is 4.
For example: iperf3 -s -i 0.5,
The period of the test results printed by the serial port is 0.5 s.
1.10.3. iperf3 -c <host> [options]
iperf3 -c <host>
Enable an iperf3 client, and make a TCP connection with the server whose IP address is
<host> on the default port 5201. All other options are default values.
-u
Enable an iperf client, and make a UDP connection with the server whose IP address is <host>
on the default port 5201. The -u option is usually used with the -b option to specify the data
bandwidth to be sent.
-p <port>
Set the client connection port, which must be the same as the port that the server listens on.
-i <interval>
The -i option settings are the same as those on the server.
-b <bandwidth/number>
The unit of bandwidth is bits/sec and the format is data[KMG]. For example, 50K, 50k or
50000 means that the bandwidth is set to 50 Kbits/sec; when bandwidth is 0, it means that
there is no limit. The default in UDP mode is 1 Mbit/sec, and there is no limit for tcp connection.
When "/number" is not added after bandwidth, iperf3 will calculate the number of data packets
that need to be sent per second to reach the specified bandwidth based on the length of each
data packet, and then send each data packet at an average interval.
For example: iperf3 -c 192.168.3.132 -u -b 200k
When "/number" is added after bandwidth, the system enters the burst mode, and iperf3 will
continuously send the specified number of data packets at one time without interval, but there
is an even interval between the batches.
For example: iperf3 -c 192.168.3.132 -u -b 200k/60
-t <time>

AN153
GD32VW553 Basic Commands User Guide
20
Set the data transmission time, in seconds. The default value is 10.
-l <length>
Set the length of the read and write buffer, in bytes; the format is: data[KMG], the same as
the -n option. It is recommended to set this value to 1472 in UDP mode and 1460 in TCP
mode.
-S <QOS value>
Set the QOS service type of the outstack packet. The number range is 0-255, and
hexadecimal (0x prefix), octal (0 prefix), and decimal can be used, such as 0x16 == 026 ==
22.
1.10.4. iperf3 stop
The command is used to stop the iperf3 test.
1.10.5. iperf3 test example
Connect the development board and test machine to the same AP, and then view the IP
address of the development board.
-Use the wifi_connect command to connect the development board to the AP, and
use the wifi_status command to view the IP address.
The test machine opens the iperf3 command window and starts the test.
-The server first executes the command: iperf3 -s -p <port> -i <interval>
-The client then executes the command: iperf3 -c <host> -l <length> -p <port> -i
<interval> -u -b <bandwidth/number> -t <time>
-The -l, -p, -i, -u, -b, and -t options are optional. The -p option must be used by the
server and client at the same time and have the same value; the -i option does not
need to be used by the server and client at the same time and can have different
values;
-For example:
-iperf3 -s -p 5004 -i 1
-iperf3 -c 192.168.1.104 -l 1460 -p 5004 -i 2 -t 20 //TCP
-iperf3 -c 192.168.1.104 -l 1472 -p 5004 -i 4 -t 30 -u -b 50M //UDP
After the server executes the command, the print information is displayed in the window,
telling us that the server is enabled and listening on the corresponding port. After the
client executes the command, the test machine and development board will print the test
information at the same time.
1.11. iperf
The iperf command calls iperf2 to perform network speed test. iperf runs in TCP mode by
default, and the UDP mode must be specified through the -u option. The relevant options of
the command (case-sensitive) are as follows.