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.