Command Manual
WIZ510SSL Command Overview
WIZ510SSL provides various commands for the product’s setting and control. Each command is composed of a 2 byte alphabet character strings and all capital letters. By using these commands users can add script to the serial device or main MCU for product settings, and also can create a program for controlling the WIZ510SSL module via network.
Each command can operate read/write depending on the parameter, and there is also a read only command.
Entering the command and switching the command mode of the serial port device is done using the data UART port. The debug UART port is not supported for command entering or operation.
Identical 2-byte character strings is used for setting the product with commands via serial and Ethernet network, but there will a distinction of the sending frame form. Thus this document will cover explanations of all commands and guides for each sending methods and its form of frames.
The different command modes are as following.
-
The Configuration tool provided by WIZnet uses the identical command set to control WIZ510SSL.
-
For example, when the MC command for checking the MAC address and the VR command for checking the firmware are identical.
Abbreviations
CR | Carriage Return, moves the cursor to the far left(starting) position ('\r', 0x0D) |
---|---|
LF | Line Feed, moves the cursor to the new line below ('\n', 0x0A) |
N | Number of commands |
RW | Read / Write |
RO | Read only |
WO | Write only |
Usage of Command Set
Entering Serial Command Mode
You can use either of the two methods below to enter serial command mode.
-
1. Enter command mode using hardware trigger pin
-
Use the HW_TRIG pin of the WIZ750SR (For the EVB, HW_TRIG switch) to enter command mode.
-
Upon turning the power on, check the pin to enter command mode. Use the trigger pin to re-enter the command mode when rebooting.
-
The trigger pin should be pull-up, and operates as low active.
-
This method is used when users wish to change settings while the product operation is initiated.
-
Set the hardware trigger pin(HW_TRIG) to Low.
-
When using the EVB, place the HW_TRIG switch to Command.
-
Power on the WIZ752SR.
-
When operating in serial command mode, users can check the following message via Debug UART port.
-
SEG:AT Mode
-
Enter the Command and Parameter that needs setting via serial port[^3].
-
Switch to data transmission mode(GW mode) using EX command.
- If the switch to data transmission mode is successful, users can check the following message via Debug UART port.
-
SEG:GW Mode
-
-
-
2. Enter command mode using command mode switch code[^4]
-
Users can enter command mode using the command mode switch code provided by WIZ752SR.
-
The command mode switch codes can be used only if it is enabled in the configuration tool. (default: Enabled)
-
The command mode switch code is composed of 3-byte Hex codes, and can be changed to a different value if needed. The code only accepts Hex value. (default: Hex [2B][2B][2B][^5])
-
Check if 'Serial command mode switch code' is enabled at the configuration tool and the 3-bytes 'command mode switch code'.
-
Enter the ‘command mode switch code’ via data UART port to change modes.
-
Read below what you need to be cautious about when switching to command mode.
-
When operating in serial command mode, users can check the following message via Debug UART port.
-
SEG:AT Mode
-
Enter the Command and Parameter that needs setting via serial port.
-
Use EX command to switch to data transmission mode.
- When operating in data transmission mode, users can check the following message via Debug UART port.
-
SEG:GW Mode
-
Please be cautious when using the trigger code to switch command mode.
- There has to be a time gap of at least 500ms at the start and end of the ‘command mode switch code’ in order it to be read as switch code.
- The entering time in between each byte of the ‘3-byte command mode switch code’ has to be below 500ms.
- Do not add CR or LF at the end of the command mode switch code[^6].
- The default values of 1 and 2 above are 500ms; these values change to the timer value if the timer value of the serial data packing option is set to a certain value.
Serial Command Frame Format
You must include CR and LF at the end of each command. CR and LF must be included at the end of each commands when multiple commands are entered simultaneously.
Get Request
[2-bytes Command Code] [CR] [LF]
- Enter command without parameter.
- The response relevant to the command will return.
Set Request
[2-bytes Command Code] [Parameters] [CR] [LF]
- Enter the command and parameters you wish to set.
- There will be no particular response and the field value relevant to the command will change instantly.
- You have to use the SV command in order to save settings, and use the RT command to change IP allocation methods or other initial operation changes.
* Note: You can check the Echoback of UART command via EC command.
Command over Ethernet
Users can control or monitor WIZ510SSL via Ethernet by using the following commands. The user must use UDP or TCP client to send commands, and the port number for processing the commands is 50001.
Network information for command transmission: UDP / TCP Server : 50001 (User can send the commands by UDP / TCP Client to device)
Ethernet Command Frame Format
Two additional commands are required before sending the command code when controlling the WIZ510SSL via Ethernet. All other settings and operations are the same as when sending the serial command code via data UART port.
The two additional commands are MA and PW.
-
[MA] command
- This field shows the product’s MAC address.
- In both cases of TCP and UDP, 6-byte MAC address must be included after the 2-byte MA command.
- When users wish to broadcast only Get Request via UDP, the relevant field value can be set as the Broadcast MAC address. Users can receive responses from multiple peers. The search function of the configuration tool is implemented like this
-
[PW] command
-
Users must use UDP or TCP client because the UDP or TCP server is operating to handle the device commands.
-
Data is sent to the broadcast IP address 255.255.255.255, and data can be sent to all peers in the same network.
-
FF:FF:FF:FF:FF:FF
-
Hex 0x20 is ASCII code, which means blank.
Get Request
When sending a single command
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] [Command] [CR] [LF]
When sending multiple commands
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] ([Command] [CR] [LF]) * Number of commands
- The response for ‘get request’ will have the identical format as ‘request’ but include the parameter.
Set Request
When sending a single command
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] [Command] [Parameters] [CR] [LF]
When sending multiple commands
MA [MAC] [CR] [LF] PW [Search ID] [CR] [LF] ([Command] [Parameters] [CR] [LF]) * Number of commands
- For ‘Set Request’, there is no additional response needed for changing the product setting.
- If users want to check the modified setting, send the command without parameter at the end of the ‘Set Request frame’; in form of Set + Get Request.
Ethernet Command Examples
Example #1: UDP Get Command Frame
- When requesting MAC and local IP from multiple devices via UDP
- Search ID is not used
Request from User |
---|
Command Frame
MA [FF FF FF FF FF FF] [CR] [LF] PW [ ] [CR] [LF] MC [CR] [LF] LI [CR] [LF]
Hex code version of Command Frame
4D 41 FF FF FF FF FF FF 0D 0A 50 57 20 0D 0A 4D 43 0D 0A 4C 49 0D 0A
Response by WIZ510SSL |
---|
- The response for ‘Get Request’ has the same form as ‘Set Request’.
Command Frame
MA [00 08 DC 00 00 11] [CR] [LF] PW [ ] [CR] [LF] MC [00 08 DC 00 00 11] [CR] [LF] LI [192.168.11.2] [CR] [LF]
Hex code version of Command Frame
4D 41 00 08 DC 00 00 11 0D 0A 50 57 20 0D 0A 4D 43 00 08 DC 00 00 11 0D 0A 4C 49 31 39 32 2E 31 36 38 2E 31 31 2E 32 0D 0A
Example #2: TCP Get Command Frame
- When requesting the local IP of the device, which MAC address is 00:08:DC:00:00:11, via TCP
- Search ID is not used
Request from User |
---|
Command Frame
MA [00 08 DC 00 00 11] [CR] [LF] PW [ ] [CR] [LF] LI [CR] [LF]
Hex code version of Command Frame
4D 41 00 08 DC 00 00 11 0D 0A 50 57 20 0D 0A 4C 49 0D 0A
Response by WIZ510SSL |
---|
Command Frame
MA [00 08 DC 00 00 11] [CR] [LF] PW [ ] [CR] [LF] LI [192.168.11.2] [CR] [LF]
Hex code version of Command Frame
4D 41 00 08 DC 00 00 11 0D 0A 50 57 20 0D 0A 4C 49 31 39 32 2E 31 36 38 2E 31 31 2E 32 0D 0A
Example #3: TCP Set Command Frame
- When requesting the local IP of the device, which MAC address is 00:08:DC:00:00:11, via TCP
- If the Search ID is set to HELLO
- Or if user wishes to change the local IP to 192.168.11.5
Request from User |
---|
Command Frame
MA [00 08 DC 00 00 11] [CR] [LF] PW [HELLO] [CR] [LF] LI [192.168.11.5] [CR] [LF]
Hex code version of Command Frame
4D 41 00 08 DC 00 00 11 0D 0A 50 57 48 45 4C 4C 4F 0D 0A 4C 49 31 39 32 2E 31 36 38 2E 31 31 2E 35 0D 0A
Response by WIZ510SSL |
---|
None
When modifying the IP address format, '.'(dot, 0x2E) must be included such as the '192.168.11.5'.
Command list
- The Set command setting the applicable value will operate if the parameter is included when entering the command.
- The Get command reading the applicable value will operate if only the command is entered.
- If the ‘Read only’ sign does not appear, it means the command supports both Get / Set.
- Write only command is for controlling the product without the parameter.
- There is a basic command list and an expanded command list.
- Settings like IP allocation settings or DNS operation settings via command mode require ‘module reboot’ via RT command after the settings are saved via SV command.
-
IPv4 address forms like IP address, Gateway address, subnet mask, DNS server address, or Remote IP address.
-
Save setting, reboot, switch mode, factory reset and Etc.
-
WIZ107/108SR sync command list, excluding [UI] command
-
WIZ750SR sync command list, including [UI] command
-
WIZ510SSL exclusive command list
-
When the remote peer address is changed from IP address to domain
Basic Commands
Command | Category | Description | Type |
---|---|---|---|
MC | Device Information | MAC address | RO |
VR | ::: | Firmware version | RO |
MN | ::: | Product name | RO |
ST | ::: | Operation status | RO |
OP | Network Settings | Network operation mode | RW |
IM | ::: | IP address allocation method (Static/DHCP) | RW |
LI | ::: | Local IP address | RW |
SM | ::: | Subnet mask | RW |
GW | ::: | Gateway address | RW |
DS | ::: | DNS server address | RW |
LP | ::: | Local port number | RW |
RH | ::: | Remote host IP address / Domain | RW |
RP | ::: | Remote host port number | RW |
BR | Data UART Settings | UART Baud rate | RW |
DB | ::: | UART Data bit | RW |
PR | ::: | UART Parity bit | RW |
SB | ::: | UART Stop bit | RW |
FL | ::: | UART Flow control | RW |
EC | ::: | UART Echoback enable | RW |
PT | Serial Data Packing Options | Time delimiter | RW |
PS | ::: | Size delimiter | RW |
PD | ::: | Char delimiter | RW |
IT | Options | Inactivity timer value | RW |
CP | ::: | Connection password enable (TCP server only) | RW |
NP | ::: | Connection password (TCP server only) | RW |
SP | ::: | Search ID code | RW |
DG | ::: | Serial debug message enable | RW |
KA | ::: | TCP Keep-alive enable | RW |
KI | ::: | TCP Keep-alive initial interval | RW |
KE | ::: | TCP Keep-alive retry interval | RW |
RI | ::: | TCP Reconnection interval (TCP client only) | RW |
QU | MQTT settings | MQTT user name | RW |
QP | ::: | MQTT password | RW |
QC | ::: | MQTT client ID | RW |
QK | ::: | MQTT Keep-alive | RW |
PU | ::: | MQTT publish topic | RW |
U0 | ::: | MQTT subscribe topic 1 | RW |
U1 | ::: | MQTT subscribe topic 2 | RW |
U2 | ::: | MQTT subscribe topic 3 | RW |
QO | ::: | MQTT QoS level | RW |
RC | Certificate Settings | Root CA verify option | RW |
CE | ::: | Client certificate enable | RW |
OC | ::: | Root CA | WO |
LC | ::: | Client certificate | WO |
PK | ::: | Private key | WO |
TE | Command Mode Switch Settings | Command mode switch code enable | RW |
SS | ::: | Command mode switch code (3-bytes Hex) | RW |
EX | Device Control | Command mode exit (switch to data transfer mode) | WO |
SV | ::: | Save device setting | WO |
BA | ::: | Current firmware bank | RW |
FW | ::: | Update firmware binary | WO |
RT | ::: | Device reboot | WO |
FR | ::: | Device factory reset | WO |
Extended Commands
Command | Category | Description | Type |
---|---|---|---|
SC | Status I/O | Status pin S0 & S1 operation mode setting | RW |
S0 | ::: | Status of pin S0 (PHY link or DTR) | RO |
S1 | ::: | Status of pin S1 (TCP connect or DSR) | ::: |
Command Descriptions
Device Information
MC
-
Format:
MC[CR][LF]
-
Meaning: Check product’s MAC address
-
Command Type: Read only
-
Return Type: String
-
Return Value:
MAC address with colons(:)
-
Response
Without Parameter (Get)
- In ASCII:
MC00:08:DC:00:00:01\r\n
- In ASCII:
VR
-
Format:
VR[CR][LF]
-
Meaning: Check the product’s firmware version
-
Command Type: Read only
-
Return Type: String
-
Return Value:
Firmware version with dots(.)
⇒ Major version number . Minor version number . Maintenance version number
-
Response
Without Parameter (Get)
- In ASCII:
VR1.0.0\r\n
- In ASCII:
MN
-
Format:
MN[CR][LF]
-
Meaning: Check the product name
-
Command Type: Read only
-
Return Type: String
-
Return Value:
Device model name
⇒ Default: WIZ510SSL
-
Response
Without Parameter (Get)
- In ASCII:
MNWIZ510SSL\r\n
- In ASCII:
ST
-
Format:
ST[CR][LF]
-
Meaning: Check the product operation status
-
Command Type: Read only
-
Return Type: String
-
Return Value:
Status | Description |
---|---|
BOOT | Boot mode; Users can update the product setting and firmware. |
OPEN | Status before TCP connection is successful. |
CONNECT | Status after TCP connection is successful. |
UPGRADE | Status during firmware update or DHCP IP allocation. |
ATMODE | Serial AT command mode status. |
-
Response
Without Parameter (Get)
- In ASCII:
STATMODE\r\n
- In ASCII:
Network Settings
OP
-
Format:
OP<Parameter>[CR][LF]
-
Meaning: Product’s network operation mode
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 6)
-
Parameter / Return Value:
Parameter / Return value | Meaning | Remarks |
---|---|---|
0 | TCP Client mode | - |
1 | TCP Server mode | - |
2 | TCP Mixed mode | TCP Server / Client mixed mode |
3 | UDP mode | - |
4 | SSL TCP mode | - |
5 | MQTT mode | - |
6 | MQTTS mode | - |
-
Response
Without Parameter (Get)
- In ASCII:
OP0\r\n
With Parameter (Set)
- No response
- Change the network operation mode
- In ASCII:
IM
-
Format:
IM<Parameter>[CR][LF]
-
Meaning: Product’s IP address allocation method
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
Parameter / Return value | Meaning | Remarks |
---|---|---|
0 | Static IP | - |
1 | DHCP | Obtain an IP address automatically |
-
Response
Without Parameter (Get)
- In ASCII:
IM0\r\n
With Parameter (Set)
- No response
- Change product’s IP address allocation method
- In ASCII:
LI
-
Format:
LI<Parameter>[CR][LF]
-
Meaning: Product's IP address
-
Command Type: Read / Write
-
Parameter / Return Type: String of IPv4 address form (including dot)
-
Parameter / Return Value:
Ex> 192.168.11.2
-
Response
Without Parameter (Get)
- In ASCII:
LI192.168.11.2\r\n
With Parameter (Set)
- No response
- Change product’s IP address
- In ASCII:
SM
-
Format:
SM<Parameter>[CR][LF]
-
Meaning: Product’s subnet mask
-
Command Type: Read / Write
-
Parameter / Return Type: String of IPv4 address form (including dot)
-
Parameter / Return Value:
Ex> 255.255.255.0
-
Response
Without Parameter (Get)
- In ASCII:
SM255.255.255.0\r\n
With Parameter (Set)
- No response
- Change product’s subnet mask
- In ASCII:
GW
-
Format:
GW<Parameter>[CR][LF]
-
Meaning: Product’s gateway address
-
Command Type: Read / Write
-
Parameter / Return Type: String of IPv4 address form (including dot)
-
Parameter / Return Value:
Ex> 192.168.11.1
-
Response
Without Parameter (Get)
- In ASCII:
GW192.168.11.1\r\n
With Parameter (Set)
- No response
- Change product’s gateway address
- In ASCII:
DS
-
Format:
DS<Parameter>[CR][LF]
-
Meaning: Product’s DNS address
-
Command Type: Read / Write
-
Parameter / Return Type: String of IPv4 address form (including dot)
-
Parameter / Return Value:
Ex> 8.8.8.8
Google Public DNS (IPv4)
- 8.8.8.8
- 8.8.4.4
-
Response
Without Parameter (Get)
- In ASCII:
DS8.8.8.8\r\n
With Parameter (Set)
- No response
- Change Product’s DNS
- In ASCII:
LP
-
Format:
LP<Parameter>[CR][LF]
-
Meaning: Product’s port number
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
Ex> 5000
-
Response
Without Parameter (Get)
- In ASCII:
LP5000\r\n
With Parameter (Set)
- No response
- Change product’s port number
- In ASCII:
RH
-
Format:
RH<Parameter>[CR][LF]
-
Meaning: Product’s remote host IP address / Domain name
-
Command Type: Read / Write
-
Parameter / Return Type: String of IPv4 address form (including dot) or Domain string
-
Parameter / Return Value:
Ex> 192.168.11.3
-
Response
Without Parameter (Get)
- In ASCII:
RH192.168.11.3\r\n
With Parameter (Set)
- No response
- Change product’s remote host IP address
- In ASCII:
RP
-
Format:
RP<Parameter>[CR][LF]
-
Meaning: Product’s remote host port number
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
Ex> 5000
-
Response
Without Parameter (Get)
- In ASCII:
RP5000\r\n
With Parameter (Set)
- No response
- Change product’s remote host port number
- In ASCII:
Data UART Settings
BR
-
Format:
BR<Parameter>[CR][LF]
-
Meaning: Baud rate of serial interface (Data UART)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 13)
-
Parameter / Return Value:
Parameter / Return value | Baud rate | Remarks |
---|---|---|
0 | 300 | - |
1 | 600 | - |
2 | 1200 | - |
3 | 1800 | - |
4 | 2400 | - |
5 | 4800 | - |
6 | 9600 | - |
7 | 14400 | - |
8 | 19200 | - |
9 | 28800 | - |
10 | 38400 | - |
11 | 57600 | - |
12 | 115200 | - |
13 | 230400 | - |
14 | 460800 | - |
-
Response
Without Parameter (Get)
- In ASCII:
BR12\r\n
With Parameter (Set)
- No response
- Change baud rate of serial interface
- In ASCII:
DB
-
Format:
DB<Parameter>[CR][LF]
-
Meaning: Data bit of serial interface (Data UART)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
Parameter / Return value | Data bit | Remarks |
---|---|---|
0 | 7-bit | - |
1 | 8-bit | - |
-
Response
Without Parameter (Get)
- In ASCII:
DB1\r\n
With Parameter (Set)
- No response
- Change data bit of serial interface
- In ASCII:
PR
-
Format:
PR<Parameter>[CR][LF]
-
Meaning: Parity bit of serial interface (Data UART)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 2)
-
Parameter / Return Value:
Parameter / Return value | Parity bit | Remarks |
---|---|---|
0 | NONE | - |
1 | ODD | - |
2 | EVEN | - |
-
Response
Without Parameter (Get)
- In ASCII:
PR0\r\n
With Parameter (Set)
- No response
- Change parity bit of serial interface
- In ASCII:
SB
-
Format:
SB<Parameter>[CR][LF]
-
Meaning: Stop bit of serial interface (Data UART)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
Parameter / Return value | Stop bit | Remarks |
---|---|---|
0 | 1-bit | - |
1 | 2-bit | - |
-
Response
Without Parameter (Get)
- In ASCII:
SB0\r\n
With Parameter (Set)
- No response
- Change stop bit of serial interface
- In ASCII:
FL
-
Format:
FL<Parameter>[CR][LF]
-
Meaning: Flow control of serial interface (Data UART) / (RS-232/TTL interface only)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 4)
-
Parameter / Return Value:
Parameter / Return value | Flow control | Remarks |
---|---|---|
0 | NONE | - |
1 | XON/XOFF | Software flow control |
2 | RTS/CTS | Hardware flow control |
3 | RTS on TX | Hardware flow control |
4 | RTS on TX(invert) | Hardware flow control |
-
Response
Without Parameter (Get)
- In ASCII:
FL0\r\n
With Parameter (Set)
- No response
- Change flow control of serial interface
- In ASCII:
EC
-
Format:
EC<Parameter>[CR][LF]
-
Meaning: UART Echoback function enable (Data UART port)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
0: Not used(Disabled) 1: Used(Enabled)
If this option is enabled, the received serial data becomes Echoback via serial port (Data UART). This function can be used to check what the user enters via serial command mode.
-
Response
Without Parameter (Get)
- In ASCII:
EC0\r\n
With Parameter (Set)
- No response
- Change whether UART echoback function enabled or not.
- In ASCII:
Serial Data Packing Options
PT
-
Format:
PT<Parameter>[CR][LF]
-
Meaning: Data packing of serial interface (Data UART) – Time delimiter
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
0: Not used 1 ~ 65535: Data packing time (Unit: millisecond)
-
Response
Without Parameter (Get)
- In ASCII:
PT0\r\n
With Parameter (Set)
- None
- Change the time delimiter value of serial data packing
- In ASCII:
PS
-
Format:
PS<Parameter>[CR][LF]
-
Meaning: Data packing of serial interface (Data UART) – Data size delimiter
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 255)
-
Parameter / Return Value:
0: Not used 1 ~ 255: Data packing size (Unit: byte)
- The received serial data is collected until the designated time is lapsed and will be sent all together via Ethernet. This time starts counting when receiving the serial data stop, and if additional serial data is received before the designated time is lapsed, the count restarts.
- The received serial data is collected until the designated data length is reached and will be sent all together via Ethernet.
-
Response
Without Parameter (Get)
- In ASCII:
PS0\r\n
With Parameter (Set)
- None
- Change the data size of serial data packing
- In ASCII:
PD
-
Format:
PD<Parameter>[CR][LF]
-
Meaning: Data packing of serial interface (Data UART) - designated character delimiter
-
Command Type: Read / Write
-
Parameter / Return Type: 1-byte Character (Hex only)
-
Parameter / Return Value:
00: Not used Other: Designated character
The designated character is not included in data.
-
Response
Without Parameter (Get)
- In ASCII:
PD00\r\n
With Parameter (Set)
-
None
-
Change designated character delimiter of serial data packing
- The received serial data is collected until the designated character is received and will be sent all together via Ethernet.
- In ASCII:
Options
IT
-
Format:
IT<Parameter>[CR][LF]
-
Meaning: Inactivity timer value for TCP connection close when there is no data exchange
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
0: Not used 1 ~ 65535: Inactivity timer value (Unit: second)
If the timer is active, the TCP connection closes when there is no data exchange. The timer restarts when there is an Ethernet data exchange before reaching entered inactivity timer value.
-
Response
Without Parameter (Get)
- In ASCII:
IT0\r\n
With Parameter (Set)
- No response
- Change inactivity timer value
- In ASCII:
CP
-
Format:
CP<Parameter>[CR][LF]
-
Meaning: TCP connection password enable (TCP server mode only)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
0: Not used(Disabled) 1: Used(Enabled)
This option is only when the product is operating as TCP server. If this option is active, the TCP client wishing to connect to the device must send first the TCP connection password and confirmation for actual data to be transmitted.
-
Response
Without Parameter (Get)
- In ASCII:
CP0\r\n
With Parameter (Set)
- No response
- Change whether TCP connection password enabled or not.
- In ASCII:
NP
-
Format:
NP<Parameter>[CR][LF]
-
Meaning: TCP connection password (TCP server mode only)
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 8-bytes)
-
Parameter / Return Value: Default: None(Null)
This option is applicable only when product is operating as TCP server. The password can be maximum of 8 characters.
-
Response
Without Parameter (Get)
- In ASCII:
NP\r\n
With Parameter (Set)
- No response
- Change TCP connection password
- In ASCII:
SP
-
Format:
SP<Parameter>[CR][LF]
-
Meaning: Search identification code
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 8-bytes)
-
Parameter / Return Value: Default: None(Null)
If this option is active, only the products with matching ID are found via product search by configuration tool. Search ID code can be maximum of 8 characters.
-
Response
Without Parameter (Get)
- In ASCII:
SP\r\n
With Parameter (Set)
- No response
- Change search ID code
- In ASCII:
DG
-
Format:
DG<Parameter>[CR][LF]
-
Meaning: Serial debug message enable (Debug UART port)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
0: Not used(Disabled) 1: Used(Enabled)
If this option is active, the product setting or error message will output via Debug UART port.
-
Response
Without Parameter (Get)
- In ASCII:
DG1\r\n
With Parameter (Set)
- No response
- Change whether serial debug message enabled or not.
- In ASCII:
KA
-
Format:
KA<Parameter>[CR][LF]
-
Meaning: Keep-alive packet transmit enable for checking TCP connection established
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
0: Not used(Disabled) 1: Used(Enabled)
If this option is active, the keep-alive packet is sent to the TCP connection peer according to the designated interval(KI / KE). If there is no response from the peer, the TCP connection will close and the socket will initialize (socket open).
-
Response
Without Parameter (Get)
- In ASCII:
KA1\r\n
With Parameter (Set)
- No response
- Change whether keep-alive packet transmit enabled or not.
- In ASCII:
KI
-
Format:
KI<Parameter>[CR][LF]
-
Meaning: Initial TCP keep-alive packet transmission interval value
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
0: Not used 1 ~ 65535: Initial Keep-alive packet transmission interval (Unit: millisecond)
The keep-alive packet is sent to the TCP connection peer according to the designated packet transmission interval. Keep-alive packet transmission becomes active only when at least one Ethernet data transmission has been made.
-
Response
Without Parameter (Get)
- In ASCII:
KI7000\r\n
With Parameter (Set)
- No response
- Change initial keep-alive packet transmission interval value
- In ASCII:
KE
-
Format:
KE<Parameter>[CR][LF]
-
Meaning: TCP Keep-alive packet transmission retry interval value
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
0: Not used 1 ~ 65535: Keep-alive packet transmission retry interval (Unit: millisecond)
After the first keep-alive packet transmission is done, the next keep-alive packet is sent to the TCP connection peer according to the designated packet transmission interval. Keep-alive packet transmission becomes active only when at least one Ethernet data transmission has been made.
-
Response
Without Parameter (Get)
- In ASCII:
KE5000\r\n
With Parameter (Set)
- No response
- Change keep-alive packet transmission retry interval value
- In ASCII:
RI
-
Format:
RI<Parameter>[CR][LF]
-
Meaning: TCP client reconnection interval value (TCP client only)
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
0: Not used 1 ~ 65535: TCP client reconnection interval (Unit: millisecond)
If the TCP connection between the server is not successful during TCP client mode, the interval value between the next connection attempt is set.
-
Response
Without Parameter (Get)
- In ASCII:
RI3000\r\n
With Parameter (Set)
- No response
- Change TCP client reconnection interval value
- In ASCII:
MQTT Settings
QU
-
Format:
QU<Parameter>[CR][LF]
-
Meaning: MQTT user name used in the broker authentication
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 128-bytes)
-
Parameter / Return Value: Default: None(Null)
-
Response
Without Parameter (Get)
- In ASCII:
QU\r\n
With Parameter (Set)
- No response
- Change MQTT user name
- In ASCII:
QP
-
Format:
QP<Parameter>[CR][LF]
-
Meaning: MQTT password used in the broker authentication
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 128-bytes)
-
Parameter / Return Value: Default: None(Null)
-
Response
Without Parameter (Get)
- In ASCII:
QU\r\n
With Parameter (Set)
- No response
- Change MQTT password
- In ASCII:
QC
-
Format:
QC<Parameter>[CR][LF]
-
Meaning: MQTT client ID connected to the broker
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 128-bytes)
-
Parameter / Return Value: Default: None(Null)
-
Response
Without Parameter (Get)
- In ASCII:
QC\r\n
With Parameter (Set)
- No response
- Change MQTT client ID
- In ASCII:
QK
-
Format:
QK<Parameter>[CR][LF]
-
Meaning: MQTT Keep-alive time setting with the broker
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 65535)
-
Parameter / Return Value:
Ex> 0
The unit of input number is millisecond(ms)
-
Response
Without Parameter (Get)
- In ASCII:
QK0\r\n
With Parameter (Set)
- No response
- Change MQTT Keep-alive time
- In ASCII:
PU
-
Format:
PU<Parameter>[CR][LF]
-
Meaning: MQTT publish topic
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 128-bytes)
-
Parameter / Return Value: Default: None(Null)
-
Response
Without Parameter (Get)
- In ASCII:
PU\r\n
With Parameter (Set)
- No response
- Change MQTT publish topic
- In ASCII:
U0
-
Format:
U0<Parameter>[CR][LF]
-
Meaning: MQTT subscribe topic 1
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 128-bytes)
-
Parameter / Return Value: Default: None(Null)
-
Response
Without Parameter (Get)
- In ASCII:
U0\r\n
With Parameter (Set)
- No response
- Change MQTT subscribe topic
- In ASCII:
U1
-
Format:
U1<Parameter>[CR][LF]
-
Meaning: MQTT subscribe topic 2
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 128-bytes)
-
Parameter / Return Value: Default: None(Null)
-
Response
Without Parameter (Get)
- In ASCII:
U1\r\n
With Parameter (Set)
- No response
- Change MQTT subscribe topic
- In ASCII:
U2
-
Format:
U2<Parameter>[CR][LF]
-
Meaning: MQTT subscribe topic 3
-
Command Type: Read / Write
-
Parameter / Return Type: String (up to 128-bytes)
-
Parameter / Return Value: Default: None(Null)
-
Response
Without Parameter (Get)
- In ASCII:
U2\r\n
With Parameter (Set)
- No response
- Change MQTT subscribe topic
- In ASCII:
QO
-
Format:
QO<Parameter>[CR][LF]
-
Meaning: MQTT QoS level
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 2)
-
Parameter / Return Value:
Return value | Meaning | Remarks |
---|---|---|
0 | QoS0 | - |
1 | QoS1 | - |
2 | QoS2 | - |
-
Response
Without Parameter (Get)
- In ASCII:
QO0\r\n
With Parameter (Set)
- No response
- Change MQTT QoS level
- In ASCII:
Certificate Settings
RC
-
Format:
RC<Parameter>[CR][LF]
-
Meaning: SSL client Root CA verify option
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 ~ 2)
-
Parameter / Return Value:
Return value | Meaning | Remarks |
---|---|---|
0 | Client Root CA verify none | - |
1 | Client Root CA verify optional | - |
2 | Client Root CA verify required | - |
-
Response
Without Parameter (Get)
- In ASCII:
RC0\r\n
With Parameter (Set)
- No response
- Change SSL client Root CA verify option
- In ASCII:
CE
-
Format:
CE<Parameter>[CR][LF]
-
Meaning: SSL client certificate enable option
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
Return value | Meaning | Remarks |
---|---|---|
0 | Client certificate disable | - |
1 | Client certificate enable | - |
-
Response
Without Parameter (Get)
- In ASCII:
CE0\r\n
With Parameter (Set)
- No response
- Change client certificate enable option
- In ASCII:
OC
-
Format:
OC[CR][LF]<Parameter>[CR][LF]
-
Meaning: SSL client Root CA
-
Command Type: Write only
-
Parameter / Return Type: String (up to 2048-bytes)
-
Parameter / Return Value: Default: None(Null)
Possible to also input the client Root CA using the file transfer function of the terminal program.
-
Response
Without Parameter
- No response
- Change SSL client Root CA
LC
-
Format:
LC[CR][LF]<Parameter>[CR][LF]
-
Meaning: SSL client certificate
-
Command Type: Write only
-
Parameter / Return Type: String (up to 2048-bytes)
-
Parameter / Return Value: Default: None(Null)
Possible to also input the client certificate using the file transfer function of the terminal program.
-
Response
Without Parameter
- No response
- Change SSL client certificate
PK
-
Format:
PK[CR][LF]<Parameter>[CR][LF]
-
Meaning: SSL private key
-
Command Type: Write only
-
Parameter / Return Type: String (up to 2048-bytes)
-
Parameter / Return Value: Default: None(Null)
Possible to also input the private key using the file transfer function of the terminal program.
-
Response
Without Parameter
- No response
- Change SSL private key
Command Mode Switch Settings
TE
-
Format:
TE<Parameter>[CR][LF]
-
Meaning: Serial command mode switch code enable
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
0: Not used(Disabled) 1: Used(Enabled)
This function must be active in order to enter serial command mode via 3-byte command mode switch code.
-
Response
Without Parameter (Get)
- In ASCII:
TE1\r\n
With Parameter (Set)
- No response
- Change weather command mode switch code enabled or not
- In ASCII:
SS
-
Format:
SS<Parameter>[CR][LF]
-
Meaning: Serial command mode switch code
-
Command Type: Read / Write
-
Parameter / Return Type: String (3-byte hex only)
-
Parameter / Return Value: Default: 0x2B 0x2B 0x2B
The command mode switch code must be composed of 3-byte(3 characters) hex code.
-
Response
Without Parameter (Get)
- In ASCII:
SS2B2B2B\r\n
With Parameter (Set)
- No response
- Change command mode switch code
- In ASCII:
Device Control
EX
-
Format:
EX[CR][LF]
-
Meaning: Command mode exit
-
Command Type: Write only (Control)
-
Parameter / Return: None
-
Response
Without Parameter
- No response
- Command mode exit and switch to data transmission mode
While the serial debug message is being used, the following mode switch message will output via Data/Debug UART ports once the switch to data transmission mode is successful.
> SEG:GW Mode
SV
-
Format:
SV[CR][LF]
-
Meaning: Save changed settings
-
Command Type: Write only (Control)
-
Parameter / Return: None
-
Response
Without Parameter
- No response
- Save changed settings
BA
-
Format:
BA<Parameter>[CR][LF]
-
Meaning: Current flash bank
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
Return value | Meaning | Remarks |
---|---|---|
0 | Bank 0 | - |
1 | Bank 1 | - |
-
Response
Without Parameter (Get)
- In ASCII:
BA0\r\n
With Parameter (Set)
- No response
- Change Current flash bank
- In ASCII:
RT
-
Format:
RT[CR][LF]
-
Meaning: Device reboot
-
Command Type: Write only (Control)
-
Parameter / Return: None
-
Response
Without Parameter
- No response
- All operations are closed and device reboot
While the serial debug message is being used, the following message will output via data UART
> REBOOT
FR
-
Format:
FR[CR][LF]
-
Meaning: Device factory reset
-
Command Type: Write only (Control)
-
Parameter / Return: None
-
Response
Without Parameter
- No response
- Reset to device factory default setting
The device’s default setting values can be found at WIZ510SSL Factory Settings The device reboots after factory reset, like RT command. While the serial debug message is being used, the following message will output via data UART.
> REBOOT
Status I/O
SC
-
Format:
SC<Parameter_0><Parameter_1>[CR][LF]
-
Meaning: Set status I/O pin S0(PA_10) and S1(PA_01) operation mode
-
Command Type: Read / Write
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
-
Parameter_0 (upper byte)
Parameter / Return value | Meaning | Remarks |
---|---|---|
0 | PHY link status | Default |
1 | DTR | Data Terminal Ready (RS-232/TTL only) |
- Parameter_1 (lower byte)
Parameter / Return value | Meaning | Remarks |
---|---|---|
0 | TCP connection status | Default |
1 | DSR | Data Set Ready (RS-232/TTL only) |
-
Response
Without Parameter (Get)
- In ASCII: (Connection Status)
SC00\r\n
- In ASCII: (DTR / DSR)
SC11\r\n
With Parameter (Set)
- No response
- Change status I/O pins operation mode
- In ASCII: (Connection Status)
S0
-
Format:
S0<Parameter>[CR][LF]
-
Meaning: Status I/O pin S0(PA_10) value
-
Command Type: Read only
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
-
When operating via PHY link status pin
Return value | Meaning | Remarks |
---|---|---|
0 | PHY link up | - |
1 | PHY link down | - |
- When operating via DTR(Data Terminal Ready) pin
- Signal that the device communication is ready (RS-232, Output)
- Connects with peer device's DSR pin
Return value | Meaning | Remarks |
---|---|---|
0 | The device is not ready | - |
1 | The device ready for communications | - |
-
Response
Without Parameter (Get)
- In ASCII:
S00\r\n
- In ASCII:
S1
-
Format:
S1<Parameter>[CR][LF]
-
Meaning: Status I/O pin S1(PA_01) value
-
Command Type: Read only
-
Parameter / Return Type: Number (0 / 1)
-
Parameter / Return Value:
-
When operating via TCP connection status pin
- TCP server / client / mixed mode only
Return value | Meaning | Remarks |
---|---|---|
0 | TCP connection established | - |
1 | TCP disconnected | - |
- When operating via DSR(Data Set Ready) pin
- Signal detect that the peer device communication is ready (RS-232, Input)
- Connect with peer device's DTR pin
Return value | Meaning | Remarks |
---|---|---|
0 | The peer device is not ready | - |
1 | The peer device ready for communications | - |
-
Response
Without Parameter (Get)
- In ASCII:
S10\r\n
- In ASCII: