Related Manuals for GigaDevice Semiconductor GD32VW553
Summary of Contents for GigaDevice Semiconductor GD32VW553
- Page 1 GigaDevice Semiconductor Inc. GD32VW553 Basic Commands User Guide Application Note AN153 Revision 1.0 (Nov.2023)
-
Page 2: Table Of Contents
AN153 GD32VW553 Basic Commands User Guide Table of Contents Table of Contents ......................2 List of Figures ........................ 4 List of Tables ........................6 Basic user commands ..................7 1.1. help ..........................7 1.2. reboot ........................... 8 1.3. tasks ..........................8 1.4. - Page 3 AN153 GD32VW553 Basic Commands User Guide 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.
-
Page 4: List Of Figures
AN153 GD32VW553 Basic Commands User Guide 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. - Page 5 AN153 GD32VW553 Basic Commands User Guide 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.
-
Page 6: List Of Tables
AN153 GD32VW553 Basic Commands User Guide List of Tables Table 2-1. Revision history ........................ 44... -
Page 7: Basic User Commands
AN153 GD32VW553 Basic Commands User Guide 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. -
Page 8: Reboot
AN153 GD32VW553 Basic Commands User Guide reboot 1.2. 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. -
Page 9: Sys_Ps
AN153 GD32VW553 Basic Commands User Guide Figure 1-3. free command sys_ps 1.5. 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;... -
Page 10: Wi-Fi
AN153 GD32VW553 Basic Commands User Guide Figure 1-5. cpu_stats command Wi-Fi 1.7. This section introduces Wi-Fi related commands. wifi_open 1.7.1. 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. -
Page 11: Wifi_Debug
AN153 GD32VW553 Basic Commands User Guide wifi_debug 1.7.3. 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. wifi_scan 1.7.4. The command has no option. The development board cannot be in softap mode when the command is executed. -
Page 12: Wifi_Connect_Bssid
AN153 GD32VW553 Basic Commands User Guide 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. -
Page 13: Wifi_Auto_Conn
AN153 GD32VW553 Basic Commands User Guide wifi_auto_conn 1.7.9. 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. -
Page 14: Wifi_Monitor
AN153 GD32VW553 Basic Commands User Guide 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. -
Page 15: Wifi_Ap
AN153 GD32VW553 Basic Commands User Guide wifi_ap 1.7.13. 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. -
Page 16: Wifi_Mac_Addr
AN153 GD32VW553 Basic Commands User Guide Figure 1-12. wifi_set_ip command wifi_mac_addr 1.7.17. 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. -
Page 17: Figure 1-14. Ping Stop Command
AN153 GD32VW553 Basic Commands User Guide 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... -
Page 18: Join_Group
AN153 GD32VW553 Basic Commands User Guide join_group 1.9. 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: ... -
Page 19: Iperf3 -C
AN153 GD32VW553 Basic Commands User Guide 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.[Options] -
Page 20: Iperf3 Stop
AN153 GD32VW553 Basic Commands User Guide 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. -
Page 21: Iperf -H
AN153 GD32VW553 Basic Commands User Guide iperf -h 1.11.1. As shown in Figure 1-16. iperf -h command, the serial port will print out the options related to the iperf command. Figure 1-16. iperf -h command iperf -s [options] 1.11.2. ... -
Page 22: Iperf Exit
AN153 GD32VW553 Basic Commands User Guide <host> on the default port 5001. All other options are default values. iperf -c <host> -u Enable an iperf3 client, and make a UDP connection with the server whose IP address is <host> on the default port 5001. All other options are default values. -
Page 23: Ble
AN153 GD32VW553 Basic Commands User Guide at the same time and can have different values; the -u option must be used by the server and client at the same time. For example: iperf -s -p 5004 -i 1 //TCP iperf -s -p 5004 -i 1 –u //UDP iperf -c 192.168.1.104 -l 1460 -p 5004 -i 2 -t 20 -S 0xe0... -
Page 24: Ble_Enable
AN153 GD32VW553 Basic Commands User Guide Figure 1-18. ble_help command (msdk_ffd configuration) ble_enable 1.12.2. This command has no option. ble_enable is used to enable BLE. The execution of other BLE related commands takes effect only when BLE is enabled. After the development board is started correctly, BLE is enabled by default, so this command does not need to be executed. -
Page 25: Ble_Disable
AN153 GD32VW553 Basic Commands User Guide Figure 1-19. ble_enable command ble_disable 1.12.3. This command has no option. ble_disable can be used to disable BLE. After BLE is disabled, some commands such as ble_adv, ble_scan, and ble_conn cannot be executed. The BLE software and hardware will be reset after this command is executed, and then BLE... -
Page 26: Ble_Courier_Wifi
AN153 GD32VW553 Basic Commands User Guide This command is used to configure the power save function of BLE which is enabled by default. When ps mode is 1, the power save mode is enabled. When nothing of BLE is being processed or adv/scan/connection interval is greater than 5 ms, BLE core will be able to enter the sleep mode to save power. -
Page 27: Ble_Adv
AN153 GD32VW553 Basic Commands User Guide ble_adv 1.12.6. Usage: ble_adv <adv type> This command is used to enable advertising so that local device can be found and connected by other BLE devices. The advertising type can be set to legacy advertising (scannable connectable undirected), extended advertising (connectable undirected), or periodic advertising (undirected periodic) through adv type parameter. -
Page 28: Ble_Adv_Restart
AN153 GD32VW553 Basic Commands User Guide Figure 1-24. ble_adv_stop command ble_adv_restart 1.12.8. Usage: ble_adv_restart <adv idx> adv idx: advertising index, which can be obtained from the log of executing the ble_adv command This command is used to restart advertising which is in stopped state. In the following two scenarios, the advertising can be restarted through ble_adv_restart : 1. -
Page 29: Ble_Scan
AN153 GD32VW553 Basic Commands User Guide ble_scan 1.12.9. This command has no option. This command can only be used in msdk_ffd configuration. This command is used to enable BLE scan procedure, which will remove the information scanned last time and print out information of the devices scanned this time, including the device address, device address type, rssi, name, dev idx, etc. -
Page 30: Ble_Sync
AN153 GD32VW553 Basic Commands User Guide This command can only be used in msdk_ffd configuration. This command is used to query the latest scanned devices and device index and device address will be displayed. As shown in Figure 1-28. ble_list_scan_devs command 错误... -
Page 31: Ble_Sync_Cancel
AN153 GD32VW553 Basic Commands User Guide Figure 1-29. ble_sync command ble_sync_cancel 1.12.13. This command has no option. This command can only be used in msdk_ffd configuration. When sync is created but unestablished, this command can be used to cancel the operation. -
Page 32: Ble_Sync_Ctrl
AN153 GD32VW553 Basic Commands User Guide Figure 1-31. ble_sync_terminate command ble_sync_ctrl 1.12.15. Usage: ble_sync_ctrl <sync idx> <report> sync idx needs to be obtained from the log of successful establishment of sync through the ble_sync command. This command can only be used in msdk_ffd configuration. -
Page 33: Ble_Conn
AN153 GD32VW553 Basic Commands User Guide Figure 1-32. ble_sync_ctrl command ble_conn 1.12.16. Usage: ble_conn <dev idx> dev idx needs to be obtained from the scan list. This command can only be used in msdk_ffd configuration. This command is used to initiate a connection. Before executing this command, ble_scan should be used to get dev idx in the scanned list. -
Page 34: Ble_Cancel_Conn
AN153 GD32VW553 Basic Commands User Guide Figure 1-33. ble_conn command ble_cancel_conn 1.12.17. This command has no option. This command can only be used in msdk_ffd configuration. This command is used to cancel an unestablished connection after the ble_conn command is executed. If the connection is successfully established and needs to be disconnected, execute the ble_disconn command. -
Page 35: Ble_List_Sec_Devs
AN153 GD32VW553 Basic Commands User Guide This command is used by the device to disconnect the established connection. As shown in Figure 1-35. ble_disconn command 错误 未找到引用源。 , a prompt will be printed after ble_disconn is executed. Figure 1-35. ble_disconn command ble_list_sec_devs 1.12.19. -
Page 36: Ble_Set_Auth
AN153 GD32VW553 Basic Commands User Guide This command is used to remove the bond information of the device. If the device is in the connected state, the connection will be disconnected, and then the bond information will be removed. The corresponding content in flash will also be removed. -
Page 37: Ble_Pair
AN153 GD32VW553 Basic Commands User Guide Figure 1-38. ble_set_auth command ble_pair 1.12.22. Usage: ble_pair <conn idx> When the device establishes a connection successfully, conn idx will be printed. For example, it can be obtained from the ble_conn log. -
Page 38: Ble_Passkey
AN153 GD32VW553 Basic Commands User Guide ble_passkey 1.12.23. Usage: ble_passkey <conn idx> <passkey> When the device establishes a connection successfully, conn idx will be printed. For example, it can be obtained from the ble_conn log. This command is used to input the passkey (6-digit number) during pairing procedure. The passkey must be the same with the one in the peer device to make sure pairing is successful. -
Page 39: Ble_Compare
AN153 GD32VW553 Basic Commands User Guide ble_compare 1.12.25. Usage: ble_compare <conn idx> <result> When the device establishes a connection successfully, conn idx will be printed. For example, it can be obtained from the ble_conn log. This command is used to determine whether the temporary keys generated at both sides are the same during the pairing with the specified device connected. -
Page 40: Ble_Peer_Ver
AN153 GD32VW553 Basic Commands User Guide Figure 1-43. ble_peer_feat command ble_peer_ver 1.12.27. Usage: ble_peer_ver <conn idx> When the device establishes a connection successfully, conn idx will be printed. For example, it can be obtained from the ble_conn log. -
Page 41: Ble_Param_Update
AN153 GD32VW553 Basic Commands User Guide Figure 1-45. ble_get_rssi command ble_param_update 1.12.29. Usage: ble_param_update <conn idx> <interval> <latency> <supv tout> <ce len> When the device establishes a connection successfully, conn idx will be printed. For example, it can be obtained from the ble_conn log. -
Page 42: Ble_Get_Phy
AN153 GD32VW553 Basic Commands User Guide Figure 1-47. ble_set_phy command ble_get_phy 1.12.31. Usage: ble_get_phy <conn idx> When the device establishes a connection successfully, conn idx will be printed. For example, it can be obtained from the ble_conn log. -
Page 43: Figure 1-49. Ble_Set_Pkt_Size Command
AN153 GD32VW553 Basic Commands User Guide As shown in Figure 1-49. ble_set_pkt_size command 错误 未找到引用源。 , a prompt will be printed after ble_set_pkt_size is executed. Figure 1-49. ble_set_pkt_size command... -
Page 44: Revision History
AN153 GD32VW553 Basic Commands User Guide Revision history Table 2-1. Revision history Revision No. Description Date Initial release Dec.5, 2023... - Page 45 Important Notice This document is the property of GigaDevice Semiconductor Inc. and its subsidiaries (the "Company"). This document, including any product of the Company described in this document (the “Product”), is owned by the Company under the intellectual property laws and treaties of the People’s Republic of China and other jurisdictions worldwide.
Need help?
Do you have a question about the GD32VW553 and is the answer not in the manual?
Questions and answers