Skip to content

Network Configuration Command Set ​

Wired network ​

Set the wired network information set_NetIP ​

  • Input parameter
ParameterTypeDescription
ipstringNetwork address.
netmaskstringSubnet mask.
gwstringGateway address.

WARNING

After the command is issued, if the setting is successful, the robotic arm's buzzer will beep once. The user should then manually restart the robotic arm.

  • Code demo

Input

Note: set the Ethernet port with the following configurations: IP address 192.168.1.18, subnet mask 255.255.255.0, and gateway 192.168.1.1.

json
{"command":"set_NetIP","ip":"192.168.1.18","netmask":"255.255.255.0","gw":"192.168.1.1"}

Output

IP address successfully configured:

json
{
    "command": "set_NetIP",
    "status": true
}

IP address configuration failed:

json
{
    "command": "set_NetIP",
    "status": false
}

Get the wired network information get_wired_net ​

  • Input parameter
ParameterTypeDescription
get_wired_netstringGet the wired network card information. If the wired network is not connected, invalid data will be returned.
  • Output parameter
ParameterTypeDescription
ipstringNetwork address.
maskstringSubnet mask.
macstringmac address.
gwstringGateway address.
  • Code demo

Input

Get the wired network information.

json
{"command":"get_wired_net"}

Output

json
{
    "command": "get_wired_net",
    "mask": "255.255.255.0",
    "ip": "192.168.1.18",
    "gw": "192.168.1.1",
    "mac": "11:22:33:44:55:66"
}

WiFi network ​

Get the WiFi network information get_wifi_net ​

  • Input parameter
ParameterTypeDescription
get_wifi_netstringGet the WiFi network information.
  • Output parameter
ParameterTypeDescription
ipstringNetwork address.
maskstringSubnet mask.
macstringmac address.
modestringap: hotspot mode, sta: connected mode.
ssidstringSet or default WiFi name.
passwordstringSet or default WiFi password.
channelintAvailable only in AP mode, which is the physical channel number that identifies a WiFi hotspot.
  • Code demo

Input

Get the WiFi network information.

json
{"command":"get_wifi_net"}

Output

json
{
    "command": "get_wifi_net",
    "mode": "ap",
    "mask": "255.255.255.0",
    "ip": "192.168.1.18",
    "mac": "11:22:33:44:55:66",
    "ssid": "realman_ap",
    "password": "12345678",
    "channel": 6
}

Set the WiFi OFF set_wifi_close ​

Set the WiFi OFF, and it will be enabled after the restart.

  • Input parameter
ParameterTypeDescription
set_wifi_closestringSet the WiFi OFF.
  • Code demo

Input

Set the WiFi OFF.

json
{"command":"set_wifi_close"}

Output

Setting succeeded:

json
{
    "command": "set_wifi_close",
    "wifi_close_state": true
}

Setting failed:

json
{
    "command": "set_wifi_close",
    "wifi_close_state": false
}

Set the WiFi APset_wifi_ap ​

Set the WiFi AP, but there is no return response. After the setting is successful, the buzzer sounds. The WiFi AP mode is enabled after the manual restart of the controller.

  • Input parameter
ParameterTypeDescription
set_wifi_apstringSet the WiFi AP.
  • Code demo

Input

Set the WiFi AP as follows: WiFi name: robot; access password: 12345678

json
{"command":"set_wifi_ap","wifi_name":"robot","password":"12345678"}

Set the WiFi STA set_wifi_sta ​

Set the WiFi STA, but there is no return response. After the setting is successful, the buzzer sounds. The WiFi STA mode is enabled after the manual restart of the controller.

  • Input parameter
ParameterTypeDescription
set_wifi_stastringSet the WiFi STA.
  • Code demo

Input

Set the WiFi STA as follows: target router name: robot; router password: 12345678.

json
{"command":"set_wifi_sta","router_name":"robot","password":"12345678"}

Restore the network ​

Restore network settings set_net_default ​

Restore the network to default factory settings. The settings will take effect after a manual restart.

  • Input parameter
ParameterTypeDescription
set_net_defaultstringConfigure the network to factory settings.
  • Code demo

Input

Network reset to default settings

json
{"command":"set_net_default"}

Output

Setting succeeded

json
{
    "command": "set_net_default",
    "net_default_state": true
}

Setting failed:

json
{
    "command": "set_net_default",
    "net_default_state": false
}

Others ​

The second-generation controller is no longer maintained. Its instruction documentation is provided for historical reference only and will not be updated. To view it, see Second-Generation Controller Instruction Set.