From e96694eb3b5b78fd7955bcc49e49f2fffc2ab798 Mon Sep 17 00:00:00 2001 From: jadnewiznet Date: Wed, 23 Oct 2024 10:36:44 +0900 Subject: [PATCH] W55RP20-S2E Document/sidebar --- .../W55RP20-S2E/Config-tool-Guide-en.md | 355 +++ .../W55RP20-S2E/Config-tool-Guide-kr.md | 360 +++ .../W55RP20-S2E/Web_Config_Guide_EN.md | 112 + .../W55RP20-S2E/Web_Config_Guide_KO.md | 104 + .../W55RP20/W55RP20-S2E/command-manual-en.md | 2786 +++++++++++++++++ .../W55RP20/W55RP20-S2E/command-manual-kr.md | 2763 ++++++++++++++++ .../W55RP20-S2E/factory-rst-guide-en.md | 96 + .../W55RP20-S2E/factory-rst-guide-kr.md | 97 + .../W55RP20-S2E/firmware-update-guide-en.md | 167 + .../W55RP20-S2E/firmware-update-guide-kr.md | 162 + .../W55RP20-S2E/modbus-connection-guide-en.md | 116 + .../W55RP20-S2E/modbus-connection-guide-kr.md | 117 + .../W55RP20-S2E/mqtt-connection-guide-en.md | 405 +++ .../W55RP20-S2E/mqtt-connection-guide-kr.md | 404 +++ .../{W55RP20-S2E.md => overview-[EN].md} | 12 +- .../W55RP20-S2E/ssl-connection-guide-en.md | 153 + .../W55RP20-S2E/ssl-connection-guide-kr.md | 147 + sidebars.js | 48 +- 18 files changed, 8377 insertions(+), 27 deletions(-) create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-en.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-kr.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_EN.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_KO.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-en.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-kr.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-en.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-kr.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-en.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-kr.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-en.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-kr.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-en.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-kr.md rename docs/Product/ioNIC/W55RP20/W55RP20-S2E/{W55RP20-S2E.md => overview-[EN].md} (97%) create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-en.md create mode 100644 docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-kr.md diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-en.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-en.md new file mode 100644 index 0000000000..8536a9bd85 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-en.md @@ -0,0 +1,355 @@ +--- +id: Config-tool-Guide-en +title: Config tool Guide +date: 2024-10-04 +keywords: [wiznet, w55rp20,w232n datasheet, hardwired tcp/ip,serial-to-ethernet, w5500, rp2040] +description: W232N is a industrial serial to Ethernet module using the W55RP20 +--- + +## Overview + +This documentation provides detailed usage of the Config-tool. + +## Config tool support list and downloads + +Wiznet Configuration tool is a configuration tool that allows you to **search, change settings, upload firmware**, and more for products on the network. + +* [**Supported Devices List**](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI#support-devices) + +The Configuration Tool is publicly available on Github under the name WIZnet-S2E-Tool-GUI on the +WIZnet page on Github under the name WIZnet-S2E-Tool-GUI, and the latest version of the executable can be downloaded from the release page of that repository. + +Built on Python, it runs on any OS. + + - **Github repository: [WIZnet-S2E-Tool-GUI Github repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI)** + - **Download the latest version: [WIZnet-S2E-Tool-GUI Github repository: Release](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases)** + + +## Configuration Tool Layout + +After installing and running the program, you can see the following launch screen. + +| | +| ------------------------------------------------------------------------- | +| ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/configuration_tool_layout.png) | +| Figure: **Configuration Tool Layout** | + +The Settings program can be divided by function, as shown in the image above. + +### ① Top side Icon Menu + +- Located at the top of the Configuration tool, you can search for products,upload firmware,restart,initialize, etc. + + | | + | ---------------------------------------------------------------------------- | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/menu_icons.png) | + | Figure: **Icon Menu** | + +- #### 1) Device Search + + - Search for connected devices on the same network. + - You can search by UDP Broadcast (search for modules in the network, multiple module products can be searched) and TCP Unicast (search for a single module). + - **Device search using the network uses TCP/UDP port 50001**. If a firewall or antivirus program is blocking that port, device search might fail. + - In these cases, we recommend disabling your firewall or antivirus program before testing. + - If you are using multiple network adapters, packet forwarding might fail depending on the network interface metric priority.
Disable all but one network adapter you are using in your OS settings and test again.
When using a virtual machine (VM) such as VMware or Virtual Box, this situation can be caused by a 'virtual Ethernet adapter' created for the VM's networking.
Disable virtual machines (VMs) such as VMware or Virtual Box, or search for TCP Unicast. + +- #### 2) Apply Settings + + - Save the changed settings and apply them to the device. + - If the setting change is successful, it is reflected in the Configuration tool. + - The product automatically reboots after the action is complete. + +- #### 3) Firmware Upload + + **Never power off during a firmware upload** + **This can cause the product to malfunction** + + - Select the firmware binary file provided by Wiznet to update the product firmware. + - The product will automatically reboot after the operation is complete. + - After successful firmware upload, you can see the following message pop up. + + | | + | ----------------------------------------------------------------------------------------- | + | ![](/img/products/wiz750sr/guiconfigtoolmanual/gui_configtool_firmwareupload_success.png) | + | Figure: **Popup Message - Firmware Upload Successfully** | + + - **The ability to upload device firmware over the network uses TCP port 50002.** If the port is blocked by a firewall or antivirus program, the device firmware upload might fail.
+ In these cases, we recommend disabling your firewall or antivirus program before testing. + - When updating the firmware, the PC on which Config-tool is running must match the IP band of the device.
+When using DHCP mode (automatic IP assignment), configure your PC and the product to receive IP assignments from the same router.
+When using Static mode (direct IP assignment), set it up like this example
+ex) Device IP : 192.168.**11**.2
+PC IP: 192.168.**11**.3 (another IP address in the same Class C private IP band)
+ - If you have performed an upload with incorrect firmware, we cannot guarantee the normal operation of the product. + + +- #### 4) Reset Device + - Restarts the selected device. + +- #### 5) Factory Reset + - Resets the device's settings to the factory default values. + - The device automatically reboots after the operation is completed. + +- #### 6) Save Config + - Saves all current settings of the selected device to a file. + - This can be useful when environmental changes require reconfiguration or when applying the current settings to another device. + +- #### 7) Load Config + - Loads the settings from a file saved by the Save Config function. + - After loading, press the "Apply Settings" button to apply these settings to the device. + +- #### 8) Exit + - Exits the Configuration tool. + +### ② Network Interface configuration + + - If you use multiple types of network adapters, you'll see a list of adapters and the bands they're using, and you can choose which network band to use based on your environment.
+ + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/network_adapters.png) | + | Figure: **Network adapters** | + + + +### ③ Searched Device List + + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/device_list.png) | + | Figure: **Device List** | + + - A list of devices found through the Search function is displayed. + - Searched results shows the number of devices found. + - Each device is identified by its MAC address and device name. + - Click a found device to select it. + +### ④ Search ID code & Search method + + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/w232n/Search_ID.png) | + | Figure: **Search ID code & Search method** | + +- Search ID code + - If a search identification code is set, then this is where you enter the code. + - The same code must be entered when searching for a product to be displayed in the product list. +- Search method + - Select a product search method. + - The default value is UDP broadcast. + - UDP broadcast can search for modules in the network, and multiple module products can be searched. + - TCP unicast uses a specific device's IP and port 50001 to discover only one device.
When used in conjunction with your router's port forwarding feature, you can discover devices and change settings from the outside local network. + +### ⑤ Status bar + + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/w232n/status.png) | + | Figure: **Status bar** | + + - Displays the process and results of a search action.
If there are multiple devices, the MAC addresses of the devices you select are displayed together. + - When performing a firmware update, a progress bar is displayed alongside it. + +### ⑥ General options + + - Viewing and changing product details settings + - Configure with Preferences Basic settings / Options / MQTT Options / Certificate Manager tab (as of W232N) + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/basic_settings_tab.png) | + | Figure: **Basic settings Tab** | + + #### 1) Device information + + - Type shows the name of the selected device, Version shows the **version of the firmware** of the device. + + #### 2) Search identification code + + - **Scope and delimiter: a string of up to 8 bytes** + - Default: Null (Not use) + - The Search identification code is an option for identification when searching for products. + - If this option is set, then the same code that is set when searching for a product must be entered to appear in the list of discovered devices. + + #### 3) Network configuration + + - **Static** (default) + - Select Static IP address assignment mode. When you select this option, the Local IP, Subnet mask, Gateway, and DNS server fields are enabled for entry.
You can set both a public IP address and a private IP address. + - If you're using a TCP client or TCP mixed mode, a DNS address must be set if the remote destination host to which you want to forward data is a domain name rather than an IP address. + - **DHCP** + - This is a way to get an IP address automatically through a DHCP server built into a router (NAT Router).
It is common to assign a private IP address from the router's dynamic IP assignment range, but it is also possible to assign a public IP address. + - The DHCP server side assigns both the IP address and gateway address, subnet mask, and DNS address, so you don't need to do any configuration. + + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/options_tab.png) | + | Figure: **Options Tab** | + + #### 1) TCP Timeout + - You can set the TCP retransmission retry count. + - Value: 1~255 + + #### 2) Status pin + - Enable the flow control functions DTR, DSR. + + #### 3) Serial debug + - When this option is set, the Debug UART will output information about the product and error conditions. + - The serial setting for the Debug UART is fixed at **921600-8-N-1:None**. + - When the **Enable with Data** option is set, you can monitor Serial to Ethernet (S2E) or Ethernet to Serial (E2S) data. + #### 4) Serial command mode + - When checked, switch from data transmission mode (GW mode) to serial command mode (AT mode) when receiving a command mode switch code during serial data, Default: Enabled + - In serial command mode, you can change and monitor various settings of the product using 2-byte serial commands (AT CMD). + - When you change to serial command mode, any existing TCP connections are disconnected. + - Trigger code + - Entering the set trigger code as serial data enters AT mode + - Default: [2B][2B][2B] (+++) + - The value of each byte recognizes only HEX codes. + + #### 5) Connection password(TCP server mode only) + - 최대 8-byte string + - Default: Null(not ues) + - Connection password can only be enabled in TCP server mode (also possible when connecting as a TCP Server in TCP mixed mode). + - If the TCP client does not send the connection password within 5s after connecting to the device, the TCP connection is automatically disconnected. + + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/mqtt_options_tab.png) | + | Figure: **MQTT Options Tab** | + + #### 1) MQTT Credentials + - User name, Passworkd + - MAX 128 + - Can be set to blank + + #### 2) MQTT Option + - Clinet ID + - MAX 128 + - Can be set to blank but not recommend + - Keep Alive + - Can be set from 0 to 65535 + - Set to 0 when not in use + - QoS + - 0,1,2 selectable + + #### 3) MQTT Topics + - Publish Topic + - MAX 128 + - Subscribe Topic + - MAX 128 + - subscribe topics up to 3 + + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/certificate_manager_tab.png) | + | Figure: **Certificate Tab** | + + #### 1) Root CA + - Option : None, Optional, Verify Three options to choose from + - Load File : Load a pre-saved Root CA file + - Save to device: Save the imported file to your device + + #### 2) Client Certificate + - Enable check box : Enable on check + - Load File : Load a pre-saved Root CA file + - Save to device: Save the imported file to your device + + #### 3) Private Key + - Load File : Load a pre-saved Root CA file + - Save to device: Save the imported file to your device + +### ⑦ channel options + +| | +| ------------------------------------------------------------------------------------ | +| ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/channel_tab.png) | +| Figure: **Channel Tab** | + + #### 1) Status & Serial Interface + - Status + - BOOT : This is the boot entry state and allows you to update the product's settings and firmware. + - OPEN : The state before a TCP connection is established + - CONNECT : TCP connection established + - UPGRATE : Updating firmware or assigning DHCP IPs + - ATMODE : Serial AT Command Mode Status + - UDP : UDP Mode Status + - Serial Interface + - The type of serial interface + + #### 2) Operation mode + - Set the device's network behavior mode + - Choose from four modes to fit your application and goals: TCP client mode, TCP server mode (default), mixed TCP client/server mode, and UDP mode + - TCP Client + - Attempts a TCP connection to the specified destination (TCP server) and communicates with the connected TCP server if the connection succeeds. + - TCP Server + - Listens for connection requests from TCP clients and establishes a TCP connection when a client connection request is received, allowing data to be sent/received on a successful connection. + - TCP MIX + - When operating as a TCP server and waiting for a connection from a TCP client after setting up, when serial data is input,
it exits the TCP server mode and switches to TCP client mode and attempts to connect to the entered remote host IP and port to establish a TCP connection
If data transmission or reception is not made within the set time (Inactivity timer) after the TCP connection, the device disconnects from the TCP server and operates in TCP server mode, which is the initial operating state of TCP MIX mode.
+ ![](/img/products/w232n/TCP_MIX.png) + - UDP + - 1:1 UDP mode + - Communicate to the set remote destination host address (domain name) and port number. + - 1:N UDP Boradcast + - If you set the remote host IP to 192.168.x.255, you can boardcast data to devices in the 192.168.x band that have an open remote port set on the device. + - 1:N UDP Response mode + - Available when Remote host IP is set to 0.0.0.0 + - Can send data to the destination from which it was sent
The destination address changes to the new destination address when data is received from another destination + - It can be utilized in applications that send data from multiple UDP destinations, to which a serial device responds. + #### 3) Local port, Remote host / Port + - Local port + - Ports the device opens + - Remote host + - The IP of the destination that the device connects to when it's a client, which is the IP of the server. + - Remote port + - The port of the destination to which the connection is made when Dabais is the client, i.e., the port opened by the server. + #### 4) Serial Options + - Baud Rate + - surpport 300, 600, 1200, 1800, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, 115200(default), 230400 + - Data bit + - surpport 7, 8(default) + - Parity + - surpport NONE(default), ODD, EVEN + - Stop Bit + - surpport 1(default), 2 + - Flow Control + - NONE(default): not use flow control + - XON/XOFF: Software flow control + - CTS/RTS: Hardware flow control + #### 5) Serial data packing condition + - Various serial data packing options so that serial data can be collected and transmitted according to user's conditions
When utilized, user command frames or cyclic data that need to be sent at once can be collected and sent. + - Application priority is Character => Size => Timer and can be set to overlap + - Timer + - 0~65535(ms), Default is 0 (unused) + - Buffer data for a specified time and send it all at once + - Size + - 0~255(byte), Default is 0 (unused) + - Stores data in a buffer until the specified data size is reached, then sends it all at once + - Character + - 1-byte Character(Hex code), Default is 0 (unused) + - Stores data in a buffer until the specified character is entered, and then sends it all at once, including the specified character, when the specified character is in the data.
If the buffer size is exceeded, send only data excluding the specified characters. + #### 6) Timer interval + - Inactivity timer + - 0 ~ 65535(s), Default is 0 (unused) + - When the Inactivity timer is set, it terminates the connection after a specified amount of time without sending data since the last data transfer. + - UDP does not apply + - Reconnection interval + - 0 ~ 65535(ms), Default is 3000 (3 seconds applied) + - The Re-connection interval determines the interval between TCP connection retries for TCP client behavior (including TCP clients in a TCP mix). + - This option is required for reconnection attempts if a TCP connection attempt fails. + - It must be set to at least 1 ms. + + #### 7) TCP Keep-alive interval +- When this option is checked, keep-alive packets are sent when the product is operating in TCP mode (including TCP Server, TCP Client, and TCP MIX) to maintain connectivity. +- If there is no response to the keepalive packet, the TCP connection is closed. (Socket close / disconnect) +- The device starts sending keepalive packets after it has sent at least one Ethernet packet. +- Since Ethernet network equipment cannot detect a physical disconnection of remote equipment, it is recommended that you enable this option so that you can terminate the TCP connection in problem situations.
In particular, when operating in TCP server mode, if you do not have a setting to send keepalive packets, you may find yourself in a situation where you are unable to terminate an existing connection if the remote device performs a shutdown/reconnect during a physical disconnect for some reason. + - Initial interval + - 0 ~ 65535(ms), Default is 7000 (7 seconds applied) + - Interval before sending the first keepalive packet + - Retry intercal + - 0 ~ 65535(ms), Default is 5000 (7 seconds applied) + - The interval between sending each keepalive packet + #### 8) Timeout + - 0 ~ 60000(ms), Default is 2000 (2 seconds applied) + - Raise a timeout if no SSL response by a specified time + - Works only in SSL TCP client mode + + \ No newline at end of file diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-kr.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-kr.md new file mode 100644 index 0000000000..abb051094e --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-kr.md @@ -0,0 +1,360 @@ +--- +id: Config-tool-Guide-kr +title: Config tool Guide-[KR] +date: 2024-08-06 +keywords: [wiznet, w55rp20,w232n datasheet, hardwired tcp/ip,serial-to-ethernet, w5500, rp2040] +description: W232N is a industrial serial to Ethernet module using the W55RP20 +--- + +## 개요 + +본 문서는 Config-tool의 자세한 사용법에 대한 내용입니다. + +## Config tool 지원 목록 및 다운로드 + +위즈네트 Configuration tool은 네트워크 상에서 제품의 **검색, 설정 변경, 펌웨어 업로드** 등을 지원하는 설정 툴 입니다. +* [**WIZnet-S2E-Tool-GUI 지원 장치 목록**](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI#support-devices) + +Configuration Tool은 WIZnet-S2E-Tool-GUI라는 이름으로 Github의 +WIZnet 페이지 내에 공개되어 있으며, 최신 버전의 실행 파일은 해당 repository의 release 페이지에서 다운로드 +할 수 있습니다. +Python 기반으로 제작되어 OS 종류에 관계 없이 실행 가능합니다. + + - **Github repository: [WIZnet-S2E-Tool-GUI Github repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI)** + - **최신 버전 다운로드: [WIZnet-S2E-Tool-GUI Github repository: Release](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases)** + + +## Configuration Tool Layout + +프로그램을 설치하여 실행하면 다음과 같은 실행 화면을 확인 할 수 있습니다. + +| | +| ------------------------------------------------------------------------- | +| ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/configuration_tool_layout.png) | +| Figure: **Configuration Tool Layout** | + +설정 프로그램은 위 그림과 같이 기능 별로 나눌 수 있습니다. + +### ① 상단 Icon Menu + + +- Configuration tool 상단에 위치하며, 제품의 검색 / 펌웨어 업로드 / 재시작 / 초기화 등을 수행 할 수 +있습니다. + + | | + | ---------------------------------------------------------------------------- | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/menu_icons.png) | + | Figure: **Icon Menu** | + +- #### 1) Device Search + + - 동일 네트워크 상에 연결된 장치를 검색합니다. + - UDP Broadcast(망 내 모듈 검색, 다수의 모듈 제품 검색 가능) 및 TCP Unicast(단일 모듈 검색)로 검색이 가능합니다. + - **네트워크를 이용한 W232N 장치 검색 기능은 TCP/UDP 포트 50001번을 이용**합니다. 만약 방화벽이나 백신 프로그램에서 해당 포트를 차단하고 있을 경우, 장치 검색에 실패할 수 있습니다. + - 이러한 경우, 방화벽이나 백신 프로그램의 동작을 해제 하신 후 테스트 해 보시기를 권장합니다. + - 여러 개의 네트워크 어댑터를 사용하는 경우, 네트워크 인터페이스 메트릭(Metric) 우선 순위에 따라 패킷 전달에 오류가 발생 할 수 있습니다.
OS 설정에서 사용 중인 하나의 네트워크 어댑터를 제외한 나머지를 비 활성화 후 다시 테스트 바랍니다.
이러한 상황은 VMware 혹은 Virtual Box 등의 가상머신(VM) 사용 시, VM의 네트워킹을 위해 생성된 '가상 이더넷 어댑터'에 의해 발생 할 수 있습니다.
VMware 혹은 Virtual Box 등의 가상머신(VM)을 비활성화 하거나 TCP Unicast로 검색하시기 바랍니다. + +- #### 2) Apply Settings + + - 변경된 설정을 저장하고 디바이스에 적용합니다. + - 성공적으로 설정 변경이 이루어진 경우 Configuration tool에 반영됩니다. + - 제품은 동작이 완료된 이후 자동으로 재시작(Reboot) 됩니다. + +- #### 3) Firmware Upload + + **펌웨어 업로드 중에는 절대 전원을 끄지 마십시오** + **제품 오동작의 원인이 될 수 있습니다.** + + - 위즈네트에서 제공하는 펌웨어 바이너리 파일을 선택하여 제품 펌웨어를 업데이트 합니다. + - 제품은 동작이 완료된 이후 자동으로 재시작(Reboot) 됩니다. + - 성공적으로 펌웨어 업로드 완료 시, 다음과 같은 메시지 팝업을 확인 할 수 있습니다. + + | | + | ----------------------------------------------------------------------------------------- | + | ![](/img/products/wiz750sr/guiconfigtoolmanual/gui_configtool_firmwareupload_success.png) | + | Figure: **Popup Message - Firmware Upload Successfully** | + + - **네트워크를 이용한 W232N 장치 펌웨어 업로드 기능은 TCP 포트 50002번을 이용**합니다. 만약 방화벽이나 백신 프로그램에서 해당 포트를 차단하고 있을 경우, 장치 펌웨어 업로드에 실패할 수 있습니다.
+ 이러한 경우, 방화벽이나 백신 프로그램의 동작을 해제 하신 후 테스트 해 보시기를 권장합니다. + - 펌웨어 업데이트 시, Config-tool이 동작 중인 PC와 디바이스의 IP 대역이 일치해야 합니다.
+DHCP 모드 (자동 IP 할당) 사용 시, PC와 제품이 동일한 공유기로부터 IP를 할당 받도록 구성 바랍니다.
+Static 모드 (직접 IP 할당) 사용 시, 다음 예와 같이 설정 바랍니다.
+예) 제품의 IP 주소: 192.168.11.2
+예) PC의 IP 주소: 192.168.11.3 (동일한 Class C 사설 IP 대역의 다른 IP 주소)
+ - 올바르지 않은 펌웨어로 업로드를 수행 한 경우, 제품의 정상 동작을 보장 할 수 없습니다. + + +- #### 4) Reset Device + + - 선택된 디바이스를 재시작(Reboot) 합니다. + +- #### 5) Factory Reset + + - 디바이스의 설정을 공장 초기 설정 값(Factory default)로 되돌립니다. + - 제품의 초기 설정 값은 아래와 같습니다. + - 제품은 동작이 완료된 이후 자동으로 재시작(Reboot) 됩니다. + +- #### 6) Save Config + + - 현재 선택된 디바이스의 모든 설정값을 파일로 저장합니다. + - 환경이 바뀌거나 현재 장치의 설정값을 다른 장치에 적용하고자 할 때 사용할 수 있습니다. + +- #### 7) Load Config + + - Save Config을 통해 저장한 파일의 설정값을 불러옵니다. + - 설정값을 불러온 뒤 Apply Settings 버튼을 눌러 설정해야 장치에 적용됩니다. + +- #### 8) Exit + + - Configuration tool을 종료합니다. + +### ② Network Interface configuration + + - 여러 종류의 네트워크 어댑터를 사용하는 경우, 어댑터 리스트와 사용 중인 대역이 표시되며, 환경에 따라 사용할 네트워크 대역을 선택할 수 있습니다.
+ + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/network_adapters.png) | + | Figure: **Network adapters** | + + + +### ③ 검색된 Device List + + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/device_list.png) | + | Figure: **Device List** | + + - Search 기능을 통해 검색된 장치의 리스트가 표시됩니다. + - Searched results에는 검색된 장치 수가 표시됩니다. + - 각각의 디바이스는 MAC 주소와 장치명으로 구분되어 표시됩니다. + - 검색된 디바이스를 클릭하여 선택합니다. + +### ④ Search ID code & Search method + + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/w232n/Search_ID.png) | + | Figure: **Search ID code & Search method** | + +- Search ID code + - 검색 ID 코드(Search identification code)가 설정된 경우 code를 입력하기 위한 부분입니다. + - 제품 검색 시 설정된 동일 코드가 입력 되어야만 제품 리스트에 표시됩니다. +- Search method + - 제품 검색 방법을 선택합니다. + - 초기 값은 UDP broadcast입니다. + - UDP broadcast는 망 내 모듈 검색, 다수의 모듈 제품 검색 가능합니다. + - TCP unicast는 특정 디바이스의 IP와 50001포트를 사용해 해당 디바이스 1대만 검색합니다.
공유기의 포트 포워딩 기능과 같이 사용하면 외부 망에서 디바이스 검색 및 세팅 변경이 가능합니다. + +### ⑤ Status bar + + | | + | ------------------------------------------------------------------------------ | + | ![](/img/products/w232n/status.png) | + | Figure: **Status bar** | + + - 검색 동작의 과정 및 결과를 표시합니다.
이 때, 장치가 다수 일 경우 사용자가 선택한 장치의 MAC 주소를 함께 표시합니다. + - 펌웨어 업데이트 수행 시, 진행 현황 표시(Progress bar)를 함께 나타냅니다. + +### ⑥ General options + + - 제품 상세 설정 확인 및 변경 + - Basic settings / Options / MQTT option / Certificate manager 탭으로 구성 (W232N 기준) + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/basic_settings_tab.png) | + | Figure: **Basic settings Tab** | + + #### 1) Device information + + - Type은 선택된 디바이스의 이름, Version은 디바이스의 **펌웨어의 버전**을 표시합니다. + + #### 2) Search identification code + + - **범위 및 구분: 최대 8-byte의 문자열** + - Default: Null (사용하지 않음) + - 검색 ID 코드(Search identification code)는 제품 검색 시 식별을 위한 옵션입니다. + - 해당 옵션이 설정되면, 제품 검색 시 설정된 동일 코드가 입력 되어야만 검색된 장치 리스트에 표시됩니다. + + #### 3) Network configuration + + - **Static** (default) + - 고정 IP 주소 할당 모드를 선택합니다. 이 옵션을 선택하면 Local IP, Subnet mask, Gateway, DNS server 필드가 입력 가능한 상태로 활성화 됩니다.
공인 IP 주소(Public IP address) 및 사설 IP 주소(Private IP address)를 모두 설정 가능 합니다. + - 만약 TCP 클라이언트나 TCP 혼합 모드를 사용하는 경우, 데이터를 전달 할 원격지 호스트가 IP 주소가 아닌 도메인 네임이라면 DNS 주소가 꼭 설정되어야 합니다. + - **DHCP** + - 공유기(NAT Router) 등에 내장된 DHCP 서버를 통해 자동으로 IP주소를 할당 받는 방법입니다.
사용자가 별도의 설정을 할 필요가 없으며 동일한 공유기를 통해 IP를 할당 받은 장치들은 서로 통신이 가능합니다.
공유기의 동적 IP 할당 범위에서 사설 IP 주소를 할당하는 경우가 일반적이나, 공인 IP 주소를 할당하는 경우도 있습니다. + - DHCP 서버 측에서 IP 주소 및 Gateway 주소, Subnet mask, DNS 주소를 모두 할당해 주기 때문에 사용자가 별도의 설정을 수행할 필요는 없습니다. + + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/options_tab.png) | + | Figure: **Options Tab** | + + #### 1) TCP Timeout + - TCP retransmission retry count 설정을 할 수 있습니다. + - Value: 1~255 + + #### 2) Status pin + - flow control 기능인 DTR, DSR 기능을 활성화 합니다. + + #### 3) Serial debug + - 해당 옵션이 설정되면 Debug UART를 통해 제품의 정보와 오류 상황 등이 출력됩니다. + - Debug UART의 시리얼 설정은 **921600-8-N-1:None**으로 고정되어 있습니다. + - **Enable with Data** 옵션 설정 시 S2E(Serial to Ethernet) 또는 E2S(Ethernet to Serial) 데이터를 모니터링 할 수 있습니다. + #### 4) Serial command mode + - 해당 옵션이 체크되면, 시리얼 데이터 중 커맨드 모드 전환 코드 수신 시 데이터 전송 모드(GW mode)에서 시리얼 커맨드 모드(AT mode)로 전환됨, Default: Enabled (사용) + - 시리얼 커맨드 모드에서는 2-byte로 구성된 시리얼 커맨드(AT CMD)를 이용하여 제품의 각종 설정 변경 및 모니터가 가능합니다. + - 시리얼 커맨드 모드로 변경되면 기존에 연결되어 있던 TCP 연결(TCP connection)이 모두 종료(disconnect)됩니다. + - Trigger code + - 설정한 Trigger code를 시리얼 데이터로 입력하면 AT mode로 진입함 + - Default: [2B][2B][2B] (+++) + - 각 byte의 값은 hex 코드만 인식합니다. + + #### 5) Connection password(TCP server mode only) + - 최대 8-byte string + - Default: Null(미사용) + - Connection password는 TCP server mode에서만 활성화 할 수 있습니다. (TCP mixed mode에서 TCP Server로 연결할 때도 가능). + - TCP client는 디바이스에 연결후 5s 이내로 설정한 Connection password를 보내지 않으면 TCP 연결이 자동으로 끊깁니다. + + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/mqtt_options_tab.png) | + | Figure: **MQTT Options Tab** | + + #### 1) MQTT Credentials + - User name, Passworkd + - 최대 128 + - 빈칸으로 설정 가능합니다 + + #### 2) MQTT Option + - Clinet ID + - 최대 128 + - 빈칸으로 설정 가능하나 권장하지 않습니다. + - Keep Alive + - 0~65535 설정 가능 + - 미사용시 0으로 설정 + - QoS + - 0,1,2 중 선택 가능 + + #### 3) MQTT Topics + - Publish Topic + - 최대 128 + - Subscribe Topic + - 최대 128 + - subscribe topics 최대 3개 + + | | + | ------------------------------------------------------------------------------------ | + | ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/certificate_manager_tab.png) | + | Figure: **Certificate Tab** | + + #### 1) Root CA + - Option : None, Optional, Verify 세 옵션중 선택 가능 + - Load File : 미리 저장한 Root CA file을 불러옴 + - Save to device : 불러온 파일을 디바이스에 저장 + + #### 2) Client Certificate + - Enable check box : 체크시 활성화 + - Load File : 미리 저장한 Root CA file을 불러옴 + - Save to device : 불러온 파일을 디바이스에 저장 + + #### 3) Private Key + - Load File : 미리 저장한 Root CA file을 불러옴 + - Save to device : 불러온 파일을 디바이스에 저장 + +### ⑦ channel options + +| | +| ------------------------------------------------------------------------------------ | +| ![](/img/products/s2e_module/wiz5xxsr-rp/configuration_tool_manual/channel_tab.png) | +| Figure: **Channel Tab** | + + #### 1) Status & Serial Interface + - Status + - BOOT : Boot 진입 상태로 제품의 설정과 펌웨어 업데이트가 가능 + - OPEN : TCP 연결 성립 이전의 상태 + - CONNECT : TCP 연결이 성립된 상태 + - UPGRATE : 펌웨어 업데이트나 DHCP IP 할당 중인 상태 + - ATMODE : 시리얼 AT 커맨드 모드 상태 + - UDP : UDP 모드 상태 + - Serial Interface + - W232N은 RS232 고정. + + #### 2) Operation mode + - 디바이스의 네트워크 동작 모드를 설정 + - TCP 클라이언트 모드, TCP 서버 모드(default), TCP 클라이언트/서버 혼용 모드, UDP 모드의 네 가지 모드 중 사용자의 응용과 목적에 맞게 선택 가능 + - TCP Client + - 지정한 목적지(TCP 서버)로 TCP 연결을 시도하고 연결 성공시 연결된 TCP 서버와 통신 가능 + - TCP Server + - TCP 클라이언트의 연결 요청을 대기(listen)하고 클라이언트의 연결 요청이 수신되면 TCP 연결을 수립하여 연결 성공시 데이터 송/수신 가능 + - TCP MIX + - 설정후 구동시 TCP 서버로 동작하고 TCP 클라이언트의 연결을 대기하고 있을 때, 시리얼 데이터가 입력되면
TCP 서버모드를 종료하고 TCP 클라이언트 모드로 전환되어 입력한 Remote host IP와 Port로 연결을 시도하여 TCP 연결 수립
TCP 연결 이후에 데이터 송수신이 설정한 시간(Inactivity timer)동안 이뤄지지 않을 경우 TCP 서버와의 연결을 끊고 디바이스는 TCP MIX 모드의 초기 구동 상태인 TCP 서버 모드로 동작함
+ ![](/img/products/w232n/TCP_MIX.png) + - UDP + - 1:1 UDP 통신 모드 + - 설정된 원격지 호스트 주소(도메인 네임) 및 포트 번호로 통신합니다. + - 1:N UDP Boradcast + - Remote host IP를 192.168.x.255로 설정하면, 디바이스에 설정된 Remote port가 열려있는 192.168.x 대역의 장비들에게 데이터를 Boardcast 할 수 있음 + - 1:N UDP 응답 모드 + - Remote host IP를 0.0.0.0으로 설정시 사용 가능 + - 데이터를 보내온 목적지로 데이터를 전송 할 수 있음
목적지 주소는 또 다른 목적지에서 데이터가 수신 될 때 새로운 목적지 주소로 변경됨 + - 다수의 UDP 목적지에서 데이터를 보내오고, 이에 시리얼 장치가 응답하는 형태의 응용에서 활용 가능합니다. + #### 3) Local port, Remote host / Port + - Local port + - 디바이스가 오픈하는 포트 + - Remote host + - 디바이스가 클라이언트일 때 연결되는 목적지(destination)의 IP 즉, 서버의 IP + - Remote port + - 다바이스가 클라이언트일 때 연결되는 목적지(destination)의 포트 즉, 서버에서 오픈한 Port + #### 4) Serial Options + - Baud Rate + - 300, 600, 1200, 1800, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, 115200(default), 230400 지원 + - Data bit + - 7, 8(default) 지원 + - Parity + - NONE(default), ODD, EVEN 지원 + - Stop Bit + - 1(default), 2 지원 + - Flow Control + - NONE(default): 흐름제어를 사용하지 않습니다. + - XON/XOFF: 소프트웨어 흐름제어 (Software flow control) + - CTS/RTS: 하드웨어 흐름제어 (Hardware flow control) + #### 5) Serial data packing condition + - 사용자의 조건에 따라 시리얼 데이터를 모아서 전송 할 수 있도록 다양한 시리얼 데이터 패킹 옵션
활용시 한번에 전송해야 할 유저 커맨드 프레임이나 주기 데이터를 모아서 전송 가능 + - 적용 우선 순위는 Character => Size => Timer 이고 중복으로 설정 가능 + - Timer + - 0~65535(ms), Default는 0(미사용) + - 지정된 시간동안 데이터를 버퍼에 저장하다가 한번에 전송 + - Size + - 0~255(byte), Default는 0(미사용) + - 지정된 데이터 크기에 도달할 때 까지 데이터를 버퍼에 저장하다가 한번에 전송 + - Character + - 1-byte 문자(Hex code), Default는 00(미사용) + - 지정된 문자가 입력 될 때 까지 데이터를 버퍼에 저장하다가 지정한 문자가 데이터로 들어오면 지정 문자를 포함하여 한번에 전송
버퍼 크기 초과 시 지정 문자를 제외한 데이터 만을 전송합니다. + #### 6) Timer interval + - Inactivity timer(비활성 타이머) + - 0 ~ 65535(s), Default는 0(미사용) + - 비활성 타이머(Inactivity timer)가 설정되면, 마지막 데이터 전송 이후 부터 데이터 전송 없이 지정된 시간 경과 후 연결을 종료합니다. + - UDP는 적용되지 않음 + - Reconnection interval(재연결 간격) + - 0 ~ 65535(ms), Default는 3000(3초 적용) + - 재연결 간격(Re-connection interval)은 TCP 클라이언트 동작(TCP MIX의 TCP 클라이언트 포함) 시, TCP 연결 재시도의 간격을 결정합니다. + - TCP 연결 시도가 실패한 경우, 재연결 시도를 위해 필요한 옵션입니다. + - 최소 1ms 이상 설정되어야 합니다. + + #### 7) TCP Keep-alive interval +- 해당 옵션이 체크되면, 제품이 TCP 모드(TCP 서버, TCP 클라이언트 및 TCP MIX 포함)로 동작 시 연결 상태 유지를 위한 연결 유지(Keep-Alive) 패킷이 전송됩니다. +- 연결 유지 패킷에 대한 응답이 없을 경우, 해당 TCP 연결은 종료됩니다. (Socket close / disconnect) +- 디바이스에서 한 번 이상 이더넷 패킷이 송신된 이후부터 연결 유지 패킷 전송이 시작됩니다. +- 이더넷 네트워크 장비는 원격지 장비의 물리적 단선을 감지 할 수 없으므로, 해당 옵션을 활성화하여 문제 상황에서 TCP 연결을 종료 할 수 있도록 설정하는 것이 좋습니다.
특히 TCP 서버 모드로 동작 할 경우, 연결 유지 패킷 전송 설정이 없다면 원격지 장비가 어떠한 이유로 물리적 단선 중에 종료/재연결을 수행했을 경우 기존 연결을 종료 할 수 없는 상황에 빠질 수 있습니다. + - Initial interval + - 0 ~ 65535(ms), Default는 7000(7초 적용) + - 최초 연결 유지 패킷을 전송하기까지의 간격 + - Retry intercal + - 0 ~ 65535(ms), Default는 5000(7초 적용) + - 매 연결 유지 패킷 전송 시 사이의 간격 + #### 8) Timeout + - 0 ~ 60000(ms), Default는 2000(2초 적용) + - 지정한 시간까지 SSL 응답이 없으면 timeout을 발생시킴 + - SSL TCP 클라이언트 모드에서만 동작함 \ No newline at end of file diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_EN.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_EN.md new file mode 100644 index 0000000000..dba37e87a9 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_EN.md @@ -0,0 +1,112 @@ +--- +id: Web_Config_Guide_EN +title: Web Server Configuration Guide +date: 2024-07-30 +--- + + + + + +----- + + + +## W232N Web Server Configuration Overview + +This document is a web server configuration guide for the W232N, an industrial Ethernet to RS232 data conversion device. + + +----- + + + +## Required Hardware and Software + + + +### Hardware + - Web Server Config Supported Devices List + - W232N + - WIZ75xSR Series + + + + + +## How to Configure in W232N Web server + + + +### Step 1: Setup the S2E to an IP in the same range as the PC + +After connecting the power and Ethernet cables to the W232N, run the Configuration Tool you downloaded from the 'Software' section above. Then, click the buttons in the order shown in the picture below to set the IP range to the same as the user's PC. + +

+ + + +### Step 2: Access the web server for configuration + +Using a web browser (e.g., Chrome), connect to the web server at port **50003** of the S2E module address you have configured. + + +

+ +| + +### Step 3: Exploring the Configuration Feature + +(1) Get W232N information + +| | +| :-------------------------------------------------------------------------------------------: | +| | +| Figure: **Click the "Get Settings" button to load the information from the W232N** | + +
+
+
+
+ +(2) Description of Fields + +| | +| :-----------------------------------------------------------------------------------------------------: | +| | +| Figure: **Device Name Field** | + +
+
+ +| | +| :-----------------------------------------------------------------------------------------------------: | +| | +| Figure: **Network Information Field for W232N** | + +
+
+ +| | +| :-----------------------------------------------------------------------------------------------------: | +| | +| Figure: **Operation Mode and Port Field for W232N** | + +
+
+ +| | +| :-------------------------------------------------------------------------------------------: | +| | +| Figure: **UART Field for W232N** | + +
+
+
+
+(3) Set W232N information + +| | +| :--------------------------------------------------------------------------------------------: | +| | +| Figure: **Click "Set Settings" and save the updated information for the W232N** | diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_KO.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_KO.md new file mode 100644 index 0000000000..c32f41aa39 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_KO.md @@ -0,0 +1,104 @@ +--- +id: Web_Config_Guide_KO +title: Web Server Configuration Guide-[KR] +date: 2024-07-30 +--- + + + + + + + +## 개요 + +본 문서는 산업용 Ethernet to RS232 데이터 변환 디바이스인 W232N의 웹서버 Config 가이드입니다. + +----- + +## 필요한 하드웨어 및 소프트웨어 + + +### 하드웨어 + + - 웹 서버 Config 지원 디바이스 목록 + - W232N + + + +## 웹 서버를 이용하여 W232N을 설정하는 방법 + + + +### 1 단계 : PC와 같은 범위의 IP로 S2E를 설정하세요. + +W232N에 전원과 이더넷 케이블을 연결한 후, 위의 '소프트웨어' 섹션에서 다운로드한 Configuration Tool을 실행하세요. 그런 다음, 아래 그림에 표시된 순서대로 버튼을 클릭하여 IP 대역을 사용자의 PC와 동일하게 설정하세요. + +

+ + + +### 2 단계 : W232N 설정을 위한 웹 서버 접속 + +웹 브라우저(예: 크롬)를 사용하여 설정한 S2E 모듈 주소의 **50003** 포트에 접속하세요. + + +

+ +| + +### 3 단계 : W232N 설정을 위한 웹 서버 구성 알아보기 + +(1) 모듈 정보 불러오기 + +| | +| :-------------------------------------------------------------------------------------------: | +| | +| 그림: **"Get Settings" 버튼을 클릭하여 W232N에서 정보를 불러오세요.** | + +
+
+
+
+ +(2) 설정 필드 설명 + +| | +| :-----------------------------------------------------------------------------------------------------: | +| | +| 그림: **디바이스 이름을 설정하는 필드입니다.** | + +
+
+ +| | +| :-----------------------------------------------------------------------------------------------------: | +| | +| 그림: **W232N의 네트워크 정보를 설정하는 필드입니다.** | + +
+
+ +| | +| :-----------------------------------------------------------------------------------------------------: | +| | +| 그림: **W232N의 Operation Mode와 포트를 설정하는 필드입니다.** | + +
+
+ +| | +| :-------------------------------------------------------------------------------------------: | +| | +| 그림: **UART를 설정하는 필드입니다.** | + +
+
+
+
+(3) 변경된 W232N의 정보를 저장하기 + +| | +| :--------------------------------------------------------------------------------------------: | +| | +| 그림: **"Set Settings" 버튼을 클릭하여 변경된 W232N의 정보를 저장하세요.** | diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-en.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-en.md new file mode 100644 index 0000000000..f1c1961857 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-en.md @@ -0,0 +1,2786 @@ +--- +id: command-manual-en +title: Command Manual +date: 2022-06-09 +--- + + + +----- + + + +## W232N AT Command Overview + +W232N 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 W232N 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. + + - [**Control Device Using Serial Command Mode**](#control-device-using-serial-command-mode) + - [**Control Device Using Ethernet Network**](#control-device-using-ethernet-network) + +1. The **Configuration tool** provided by WIZnet uses the identical command set to control W232N. + +2. For example, when the **MC** command for checking the MAC address and the **VR** command for checking the firmware are identical. + + + +### Abbreviations + +| Abbreviation | Description | +| :----------: | ---------------------------------------------------------------------------------- | +| 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 + + + +### Control Device Using 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 W232N (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 W232N. + · 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((Data UART port)). + + - Switch to data transmission mode(GW mode) using [[#ex|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** + + - Users can enter command mode using the command mode switch code provided by W232N. + - 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**\]) + +``` + - 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|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 +``` + +1. Command mode switch trigger code via Data UART port + +2. Char '+++' + +**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((Conversely, the serial command after mode switch must end with CR or LF.)). + + - 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](#sv)** command in order to save settings, and use the **[RT](#rt)** command to change IP allocation methods or other initial operation changes. + +\* Note: You can check the Echoback of UART command via **[EC](#ec)** command. + + + +----- + + + +### Control Device Using Ethernet Network + +Users can control or monitor W232N 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 W232N 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** + +1. Users must use UDP or TCP client because the UDP or TCP server is operating to handle the device commands. + +2. Data is sent to the broadcast IP address 255.255.255.255, and data can be sent to all peers in the same network. + +3. FF:FF:FF:FF:FF:FF + +4. 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 W232N | +| ----------------------- | + +1. 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 W232N | +| ----------------------- | + +**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 W232N | +| --------------------- | + + 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](#rt)** command after the settings are saved via **[SV](#sv)** command. + +1. IPv4 address forms like IP address, Gateway address, subnet mask, DNS server address, or Remote IP address. + +2. Save setting, reboot, switch mode, factory reset and Etc. + +3. WIZ107SR / WIZ108SR sync command list, excluding \[UN\], \[UI\] command + +4. WIZ750SR / WIZ750SR-1xx / WIZ750SR-12x sync command list, including \[UN\], \[UI\] command + +5. WIZ510SSL sync command list, including \[UN\], \[UI\] command + +6. W232N exclusive command list + +7. When the remote peer address is changed from IP address to domain + + + +### Basic Commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandCategoryDescriptionType
MCDevice InformationMAC addressRO
VR:::Firmware versionRO
MN:::Product nameRO
ST:::Operation statusRO
UN:::UART interface(str)RO
UI:::UART interface(code)RO
OPNetwork SettingsNetwork operation modeRW
IM:::IP address allocation method (static/DHCP)RW
LI:::Local IP addressRW
SM:::Subnet maskRW
GW:::Gateway addressRW
DS:::DNS server addressRW
LP:::Local port numberRW
RH:::Remote host IP address / DomainRW
RP:::Remote host port numberRW
BRData UART SettingsUART Baud rateRW
DB:::UART Data bitRW
PR:::UART Parity bitRW
SB:::UART Stop bitRW
FL:::UART Flow controlRW
EC:::UART Echoback enableRW
PTSerial Data Packing OptionsTime delimiterRW
PS:::Size delimiterRW
PD:::Char delimiterRW
ITOptionsInactivity timer valueRW
RI:::TCP Reconnection interval
+(TCP client only)
RW
CP:::Connection password enable (TCP server only)RW
NP:::Connection password (TCP server only)RW
SP:::Search ID codeRW
DG:::Serial debug message enableRW
KA:::TCP Keep-alive enableRW
KI:::TCP Keep-alive initial intervalRW
KE:::TCP Keep-alive retry intervalRW
SO:::SSL receive timeoutRW
QUMQTT SettingsMQTT user nameRW
QP:::MQTT passwordRW
QC:::MQTT client IDRW
QK:::MQTT Keep-aliveRW
PU:::MQTT publish topicRW
U0:::MQTT subscribe topic 1RW
U1:::MQTT subscribe topic 2RW
U2:::MQTT subscribe topic 3RW
QO:::MQTT QoS levelRW
RCCertificate SettingsRoot CA verify optionRW
CE:::Client certificate enableRW
OC:::Root CAWO
LC:::Client certificateWO
PK:::Private keyWO
TECommand Mode Switch SettingsCommand mode switch code enableRW
SS:::Command mode switch code (3-bytes Hex)RW
EXDevice ControlCommand mode exit (switch to data transfer mode)WO
SV:::Save device settingWO
UF:::Copy firmware from firmware binary bank to application bankRW
RT:::Device rebootWO
FR:::Device factory resetWO
+ + + +### Extended Commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandCategoryDescriptionType
SCStatus I/OStatus pin S0 & S1 operation mode settingRW
S0:::Status of pin S0 (PHY link or DTR)RO
S1:::Status of pin S1 (TCP connect or DSR)RO
+ + + +----- + + + +## 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` + + + +--- + +#### 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` + + + +--- + +#### MN + +--- + + - **Format:** `MN[CR][LF]` + + - **Meaning:** Check the product name + + - **Command Type:** Read only + + - **Return Type:** String + + - **Return Value:** + + Device model name + + ⇒ Default: WIZ5XXRSR-RP + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `MNWIZ5XXRSR-RP\r\n` + + + +--- + +#### 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` + + + +--- + +#### UN + +--- + + - **Format:** `UN[CR][LF]` + + - **Meaning:** Check product’s UART Interface + + - **Command Type:** Read only + + - **Return Type:** String + + - **Return Value:** + +| UART interface | Description | +| :------------: | --------------------------------------------------------------- | +| RS-232/TTL | Device supports UART input/output of RS-232C or TTL signals. | +| RS-422/485 | Device supports UART input/output of RS-422 and RS-485 signals. | + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `UNRS-232/TTL\r\n` + + + +--- + +#### UI + +--- + + - **Format:** `UI[CR][LF]` + + - **Meaning:** Check product’s UART Interface + + - **Command Type:** Read only + + - **Return Type:** String + + - **Return Value:** + +| Return value | Description | Remarks | +| :----------: | --------------------------------------------------------------- | :--------: | +| 0 | Device supports UART input/output of RS-232 or TTL signals. | RS-232/TTL | +| 1 | Device supports UART input/output of RS-422 and RS-485 signals. | RS-422/485 | + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `UI0\r\n` + + + +### Network Settings + + + +--- + +#### OP + +--- + + - **Format:** `OP[CR][LF]` + + - **Meaning:** Product’s network operation mode + + - **Command Type:** Read / Write + + - **Parameter / Return Type:** Number (0 ~ 6) + + - **Parameter / Return Value:** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter /
+Return value
MeaningRemarks
0TCP client mode-
1TCP server mode-
2TCP mixed modeTCP server / client mixed mode
3UDP mode-
4SSL TCP client mode-
5MQTT client mode-
6MQTTS client mode-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `OP0\r\n` + + **With Parameter (Set)** + - No response + - Change the network operation mode + + + +--- + +#### IM + +--- + + - **Format:** `IM[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
MeaningRemarks
0Static-
1DHCPObtain 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 + + + +--- + +#### LI + +--- + + - **Format:** `LI[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 + + + +--- + +#### SM + +--- + + - **Format:** `SM[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 + + + +--- + +#### GW + +--- + + - **Format:** `GW[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 + + + +--- + +#### DS + +--- + + - **Format:** `DS[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 + + + +--- + +#### LP + +--- + + - **Format:** `LP[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 + + + +--- + +#### RH + +--- + + - **Format:** `RH[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 + + + +--- + +#### RP + +--- + + - **Format:** `RP[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 + + + +### Data UART Settings + + + +--- + +#### BR + +--- + + - **Format:** `BR[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 rateRemarks
0300-
1600-
21200-
31800-
42400-
54800-
69600-
714400-
819200-
928800-
1038400-
1157600-
12115200-
13230400-
14460800-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `BR12\r\n` + + **With Parameter (Set)** + - No response + - Change baud rate of serial interface + + + +--- + +#### DB + +--- + + - **Format:** `DB[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 bitRemarks
07-bit-
18-bit-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `DB1\r\n` + + **With Parameter (Set)** + - No response + - Change data bit of serial interface + + + +--- + +#### PR + +--- + + - **Format:** `PR[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 bitRemarks
0NONE-
1ODD-
2EVEN-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `PR0\r\n` + + **With Parameter (Set)** + - No response + - Change parity bit of serial interface + + + +--- + +#### SB + +--- + + - **Format:** `SB[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 bitRemarks
01-bit-
12-bit-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `SB0\r\n` + + **With Parameter (Set)** + - No response + - Change stop bit of serial interface + + + +--- + +#### FL + +--- + + - **Format:** `FL[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 controlRemarks
0NONE-
1XON/XOFFSoftware flow control
2RTS/CTSHardware flow control
3RTS on TXHardware flow control
4RTS 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 + + + +--- + +#### EC + +--- + + - **Format:** `EC[CR][LF]` + + - **Meaning:** UART Echoback function enable (data UART) + + - **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. + + + +### Serial Data Packing Options + + + +--- + +#### PT + +--- + + - **Format:** `PT[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 + + + +--- + +#### PS + +--- + + - **Format:** `PS[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) + + 1. 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. + 2. 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 + + + +--- + +#### PD + +--- + + - **Format:** `PD[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. + + + +### Options + + + +--- + +#### IT + +--- + + - **Format:** `IT[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 + + + +--- + +#### CP + +--- + + - **Format:** `CP[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. + + + + +--- + +#### NP + +--- + + - **Format:** `NP[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 + + + +--- + +#### SP + +--- + + - **Format:** `SP[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 + + + +--- + +#### DG + +--- + + - **Format:** `DG[CR][LF]` + + - **Meaning:** Serial debug message enable (debug UART) + + - **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. + + + +--- + +#### KA + +--- + + - **Format:** `KA[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](#ki) / [KE](#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. + + + +--- + +#### KI + +--- + + - **Format:** `KI[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 + + + +--- + +#### KE + +--- + + - **Format:** `KE[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 + + + +--- + +#### SO + +--- + + - **Format:** `SO[CR][LF]` + + - **Meaning:** SSL receive timeout value for SSL connection close + + - **Command Type:** Read / Write + + - **Parameter / Return Type:** Number (0 ~ 60000) + + - **Parameter / Return Value:** + + 0: Not used + 1 ~ 60000: SSL receive timeout (unit: millisecond) + + If the timeout is set, the SSL connection closes when SSL receive timeout over. + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `SO2000\r\n` + + **With Parameter (Set)** + - No response + - Change SSL receive timeout value + + + +--- + +#### RI + +--- + + - **Format:** `RI[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 + + + +### MQTT Settings + + + +--- + +#### QU + +--- + + - **Format:** `QU[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 + + + +--- + +#### QP + +--- + + - **Format:** `QP[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 + + + +--- + +#### QC + +--- + + - **Format:** `QC[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 + + + +--- + +#### QK + +--- + + - **Format:** `QK[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 + + + +--- + +#### PU + +--- + + - **Format:** `PU[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 + + + +--- + +#### U0 + +--- + + - **Format:** `U0[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 + + + +--- + +#### U1 + +--- + + - **Format:** `U1[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 + + + +--- + +#### U2 + +--- + + - **Format:** `U2[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 + + + +--- + +#### QO + +--- + + - **Format:** `QO[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 + + + +### Certificate Settings + + + +--- + +#### RC + +--- + + - **Format:** `RC[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 + + + +--- + +#### CE + +--- + + - **Format:** `CE[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 + + + +--- + +#### OC + +--- + + - **Format:** `OC[CR][LF][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][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][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[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 + + + +--- + +#### SS + +--- + + - **Format:** `SS[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 + + + +### 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 + + + +--- + +#### UF + +--- + + - **Format:** `UF[CR][LF]` + + - **Meaning:** Copy firmware from firmware binary bank to application bank + + - **Command Type:** Read / Write + + - **Parameter / Return:** + + Ex> 1 + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `UF0\r\n` + + **With Parameter (Set)** + - No response + - Change current bank flag + + After reset, copy firmware from firmware binary bank to application bank. + + + +--- + +#### 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 + + `> REBOOT` + + + +### Status I/O + + + +--- + +#### SC + +--- + + - **Format:** `SC[CR][LF]` + + - **Meaning:** Set status I/O pin **[S0](#s0)(PA\_10) and [S1](#s1)(PA\_01)** operation mode + + - **Command Type:** Read / Write + + - **Parameter / Return Type:** Number (0 / 1) + + - **Parameter / Return Value:** + + - **Parameter\_0** (upper byte) + + + + + + + + + + + + + + + + + + + + + +
Parameter / Return valueMeaningRemarks
0PHY link statusDefault
1DTRData Terminal Ready (RS-232/TTL only)
+ + - **Parameter\_1** (lower byte) + + + + + + + + + + + + + + + + + + + + + +
Parameter / Return valueMeaningRemarks
0TCP connection statusDefault
1DSRData 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 + + + +--- + +#### S0 + +--- + + - **Format:** `S0[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` + + + +--- + +#### S1 + +--- + + - **Format:** `S1[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 client / TCP server / TCP 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` + + + +----- diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-kr.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-kr.md new file mode 100644 index 0000000000..0c6ca5ba5a --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-kr.md @@ -0,0 +1,2763 @@ +--- +id: command-manual-kr +title: Command Manual-[KR] +date: 2022-06-09 +--- + + + +----- + + + +## W232N 커맨드 모드 개요 + +W232N은 제품 설정과 제어를 위한 다양한 명령어를 제공합니다. 각 명령어는 **2바이트 알파벳 문자열로 구성되며 모두 대문자**입니다. 사용자는 이러한 명령어를 사용하여 직렬 장치나 주 MCU에 스크립트를 추가하거나 네트워크를 통해 W232N 모듈을 제어하기 위한 프로그램을 만들 수 있습니다. + +각 명령어는 매개변수에 따라 읽기/쓰기 작업을 수행할 수 있으며 읽기 전용 명령어도 있습니다. + +명령어 입력 및 직렬 포트 장치의 명령 모드 전환은 **데이터 UART 포트**를 사용하여 수행됩니다. **디버그 UART** 포트는 명령어 입력이나 작동을 지원하지 않습니다. + +직렬 및 이더넷 네트워크를 통해 제품 설정을 위한 명령어로 동일한 2바이트 문자열을 사용하지만, 송신 프레임 형식에는 차이가 있습니다. 따라서 이 문서에서는 모든 명령어와 각 송신 방법 및 프레임 형식에 대한 설명 및 가이드를 다룹니다. + +다른 명령 모드는 다음과 같습니다. + + - [**시리얼 커맨드 모드로 디바이스 제어**](#시리얼-커맨드를-사용한-디바이스-제어) + - [**이더넷 네트워크를 통한 디바이스 제어**](#이더넷-네트워크를-통한-디바이스-제어) + +1. **Configuration tool**또한 디바이스를 검색 및 세팅시 동일한 커맨드를 사용합니다. + +2. 예를 들어, MAC 주소를 확인하기 위한 **MC** 명령과 펌웨어를 확인하기 위한 **VR** 명령이 동일합니다. + + + +### 용어 + +| 용어 | 설명 | +| :----------: | ---------------------------------------------------------------------------------- | +| CR | 캐리지 리턴, 커서를 맨 왼쪽(시작) 위치로 이동합니다. ('\\r', 0x0D) | +| LF | 라인 피드, 커서를 아래의 새 줄로 이동합니다. ('\\n', 0x0A) | +| N | 명령어 개수 | +| RW | Read / Write | +| RO | Read only | +| WO | Write only | + + + +----- + + + +## 명령 집합 사용 + + + +### 시리얼 커맨드를 사용한 디바이스 제어 + +아래 두 가지 방법 중 하나를 사용하여 시리얼 명령 모드로 들어갈 수 있습니다. + +**1. 모드 스위치를 사용하여 시리얼 커맨드 모드로 진입** + + - 모드 선택 슬라이드 스위치를 AT MODE 쪽으로 위치시킵니다. + + - 디바이스를 리셋 시키거나 디바이스를 재가동합니다. + · 디바이스의 Serial debug가 활성화 되어있다면 시리얼 커맨드 모드 진입시 아래와 같은 메시지가 디버그 포트로 출력됩니다. + · > SEG:AT Mode + + - 시리얼 커맨드 모드를 종료하려먼 EX[CR][LF] 명령어를 사용합니다. + · 디바이스의 Serial debug가 활성화 되어있다면 시리얼 커맨드 모드 진입시 아래와 같은 메시지가 디버그 포트로 출력됩니다. + · > SEG:GW Mode + + +**2. command mode switch code를 사용한 커맨드 모드 진입** + + - 출고 세팅은 command mode switch code가 활성화 되어있고 코드는 HEX로 [2B][2B][2B]가 기본으로 설정되어있습니다.유저가 Config-tool에서 다른 코드로 변경 가능합니다. + - HEX [2B][2B][2B]는 ascii +++ 이므로 문자열로 +++ 입력하셔도 진입 가능합니다. + + - 시리얼 포트로 command mode switch code를 입력합니다. + · 디바이스의 Serial debug가 활성화 되어있다면 시리얼 커맨드 모드 진입시 아래와 같은 메시지가 디버그 포트로 출력됩니다. + · > SEG:AT Mode + + - Enter the Command and Parameter that needs setting via serial port. + + - 시리얼 커맨드 모드를 종료하려먼 EX[CR][LF] 명령어를 사용합니다. + · 디바이스의 Serial debug가 활성화 되어있다면 시리얼 커맨드 모드 진입시 아래와 같은 메시지가 디버그 포트로 출력됩니다. + · > SEG:GW Mode + + +**command mode switch code를 사용하여 커맨드 모드 진입시 주의사항** + + - 'command mode switch code'의 시작과 끝에 **최소 500ms**의 시간 간격이 있어야 전환 코드로 인식할 수 있습니다. + + - ‘3-byte command mode switch code’의 각 바이트 사이 입력 시간은 **500ms 미만**이어야 합니다.
예시) command mode switch code가 [2B][2B][2B] 일 때, [2B]와 [2B]의 사이는 **500ms 미만** + + - 'command mode switch code' 끝에 CR 또는 LF를 추가하지 않습니다.(반대로 모드 전환 후 커맨드 명령은 CR 또는 LF로 끝나야 합니다). + + - 'command mode switch code' 시작과 끝 시간 간격과 ‘3-byte command mode switch code’ 사이 입력 시간은 데이터 패킹 옵션의 타이머 값이 설정되어 있다면 해당 값으로 변경됩니다. + + + + +#### 시리얼 커맨드 프레임 형식 + +각 명령의 끝에 CR과 LF를 포함해야 합니다. 여러 명령을 동시에 입력하는 경우 각 명령의 끝에 CR과 LF를 포함해야 합니다. + + + +##### 시리얼 커맨드를 입력하여 디바이스의 응답을 받는 경우 + + [2-bytes Command Code] [CR] [LF] + + - 매개 변수 없이 명령을 입력합니다. + - 명령과 관련된 응답이 반환됩니다. + + + +##### 시리얼 커맨드를 입력하여 디바이스의 세팅을 변경할 경우 + + [2-bytes Command Code] [Parameters] [CR] [LF] + + - 설정하려는 명령과 매개변수를 입력합니다. + - 특별한 응답은 없으며 명령과 관련된 필드 값이 즉시 변경됩니다. + - 정을 저장하려면 **[SV](#sv)** 명령을 사용해야 하며, IP 할당 방법이나 기타 초기 작업 변경을 변경하려면 **[RT](#rt)** 명령을 사용해야 합니다. + +\* 참고: **[EC](#ec)** 명령을 통해 UART 명령의 에코백을 확인할 수 있습니다. + + + +----- + + + +### 이더넷 네트워크를 통한 디바이스 제어 + +**명령 전송을 위한 네트워크 정보:** **UDP/TCP 서버 : 50001** (사용자는 UDP/TCP 클라이언트를 통해 장치로 명령을 전송해야 합니다.) + +#### 이더넷 커맨드 프레임 형식 + +이더넷을 통해 W232N을 제어할 때는 명령 코드를 보내기 전에 두 가지 추가 명령이 필요합니다. 다른 모든 설정과 조작은 데이터 포트를 통해 시리얼 명령 코드를 전송할 때와 동일합니다. + +두 가지 추가 명령은 **MA**와 **PW**입니다. + + - **\[MA\] command** + - 이 필드에는 **제품의 MAC 주소**가 표시됩니다. + - TCP와 UDP의 경우 모두 2바이트 MA 명령 뒤에 6바이트 MAC 주소를 포함해야 합니다. + - 사용자가 UDP를 통해 Get Request만 브로드캐스트하려는 경우, 관련 필드 값을 브로드캐스트 MAC 주소로 설정할 수 있습니다. 사용자는 여러 피어로부터 응답을 받을 수 있습니다. 설정 도구의 검색 기능은 다음과 같이 구현됩니다. + + - **\[PW\] command** + +1. 이더넷 커맨드를 사용하기 위해서는 사용자가 UDP 또는 TCP 클라이언트를 사용해야 합니다. + +2. 데이터는 브로드캐스트 IP 주소 255.255.255.255로 전송되며, 동일한 네트워크에 있는 모든 피어에게 데이터를 전송할 수 있습니다. + +3. FF:FF:FF:FF:FF:FF + +4. Hex 0x20은 공백을 의미하는 ASCII 코드입니다. + + + +##### 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 W232N | +| ----------------------- | + +1. 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 W232N | +| ----------------------- | + +**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 W232N | +| --------------------- | + + 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](#rt)** command after the settings are saved via **[SV](#sv)** command. + +1. IPv4 address forms like IP address, Gateway address, subnet mask, DNS server address, or Remote IP address. + +2. Save setting, reboot, switch mode, factory reset and Etc. + +3. WIZ107SR / WIZ108SR sync command list, excluding \[UN\], \[UI\] command + +4. WIZ750SR / WIZ750SR-1xx / WIZ750SR-12x sync command list, including \[UN\], \[UI\] command + +5. WIZ510SSL sync command list, including \[UN\], \[UI\] command + +6. W232N exclusive command list + +7. When the remote peer address is changed from IP address to domain + + + +### Basic Commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandCategoryDescriptionType
MCDevice InformationMAC addressRO
VR:::Firmware versionRO
MN:::Product nameRO
ST:::Operation statusRO
UN:::UART interface(str)RO
UI:::UART interface(code)RO
OPNetwork SettingsNetwork operation modeRW
IM:::IP address allocation method (static/DHCP)RW
LI:::Local IP addressRW
SM:::Subnet maskRW
GW:::Gateway addressRW
DS:::DNS server addressRW
LP:::Local port numberRW
RH:::Remote host IP address / DomainRW
RP:::Remote host port numberRW
BRData UART SettingsUART Baud rateRW
DB:::UART Data bitRW
PR:::UART Parity bitRW
SB:::UART Stop bitRW
FL:::UART Flow controlRW
EC:::UART Echoback enableRW
PTSerial Data Packing OptionsTime delimiterRW
PS:::Size delimiterRW
PD:::Char delimiterRW
ITOptionsInactivity timer valueRW
RI:::TCP Reconnection interval
+(TCP client only)
RW
CP:::Connection password enable (TCP server only)RW
NP:::Connection password (TCP server only)RW
SP:::Search ID codeRW
DG:::Serial debug message enableRW
KA:::TCP Keep-alive enableRW
KI:::TCP Keep-alive initial intervalRW
KE:::TCP Keep-alive retry intervalRW
SO:::SSL receive timeoutRW
QUMQTT SettingsMQTT user nameRW
QP:::MQTT passwordRW
QC:::MQTT client IDRW
QK:::MQTT Keep-aliveRW
PU:::MQTT publish topicRW
U0:::MQTT subscribe topic 1RW
U1:::MQTT subscribe topic 2RW
U2:::MQTT subscribe topic 3RW
QO:::MQTT QoS levelRW
RCCertificate SettingsRoot CA verify optionRW
CE:::Client certificate enableRW
OC:::Root CAWO
LC:::Client certificateWO
PK:::Private keyWO
TECommand Mode Switch SettingsCommand mode switch code enableRW
SS:::Command mode switch code (3-bytes Hex)RW
EXDevice ControlCommand mode exit (switch to data transfer mode)WO
SV:::Save device settingWO
UF:::Copy firmware from firmware binary bank to application bankRW
RT:::Device rebootWO
FR:::Device factory resetWO
+ + + +### Extended Commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandCategoryDescriptionType
SCStatus I/OStatus pin S0 & S1 operation mode settingRW
S0:::Status of pin S0 (PHY link or DTR)RO
S1:::Status of pin S1 (TCP connect or DSR)RO
+ + + +----- + + + +## 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` + + + +--- + +#### 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` + + + +--- + +#### MN + +--- + + - **Format:** `MN[CR][LF]` + + - **Meaning:** Check the product name + + - **Command Type:** Read only + + - **Return Type:** String + + - **Return Value:** + + Device model name + + ⇒ Default: WIZ5XXRSR-RP + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `MNWIZ5XXRSR-RP\r\n` + + + +--- + +#### 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` + + + +--- + +#### UN + +--- + + - **Format:** `UN[CR][LF]` + + - **Meaning:** Check product’s UART Interface + + - **Command Type:** Read only + + - **Return Type:** String + + - **Return Value:** + +| UART interface | Description | +| :------------: | --------------------------------------------------------------- | +| RS-232/TTL | Device supports UART input/output of RS-232C or TTL signals. | +| RS-422/485 | Device supports UART input/output of RS-422 and RS-485 signals. | + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `UNRS-232/TTL\r\n` + + + +--- + +#### UI + +--- + + - **Format:** `UI[CR][LF]` + + - **Meaning:** Check product’s UART Interface + + - **Command Type:** Read only + + - **Return Type:** String + + - **Return Value:** + +| Return value | Description | Remarks | +| :----------: | --------------------------------------------------------------- | :--------: | +| 0 | Device supports UART input/output of RS-232 or TTL signals. | RS-232/TTL | +| 1 | Device supports UART input/output of RS-422 and RS-485 signals. | RS-422/485 | + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `UI0\r\n` + + + +### Network Settings + + + +--- + +#### OP + +--- + + - **Format:** `OP[CR][LF]` + + - **Meaning:** Product’s network operation mode + + - **Command Type:** Read / Write + + - **Parameter / Return Type:** Number (0 ~ 6) + + - **Parameter / Return Value:** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter /
+Return value
MeaningRemarks
0TCP client mode-
1TCP server mode-
2TCP mixed modeTCP server / client mixed mode
3UDP mode-
4SSL TCP client mode-
5MQTT client mode-
6MQTTS client mode-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `OP0\r\n` + + **With Parameter (Set)** + - No response + - Change the network operation mode + + + +--- + +#### IM + +--- + + - **Format:** `IM[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
MeaningRemarks
0Static-
1DHCPObtain 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 + + + +--- + +#### LI + +--- + + - **Format:** `LI[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 + + + +--- + +#### SM + +--- + + - **Format:** `SM[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 + + + +--- + +#### GW + +--- + + - **Format:** `GW[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 + + + +--- + +#### DS + +--- + + - **Format:** `DS[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 + + + +--- + +#### LP + +--- + + - **Format:** `LP[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 + + + +--- + +#### RH + +--- + + - **Format:** `RH[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 + + + +--- + +#### RP + +--- + + - **Format:** `RP[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 + + + +### Data UART Settings + + + +--- + +#### BR + +--- + + - **Format:** `BR[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 rateRemarks
0300-
1600-
21200-
31800-
42400-
54800-
69600-
714400-
819200-
928800-
1038400-
1157600-
12115200-
13230400-
14460800-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `BR12\r\n` + + **With Parameter (Set)** + - No response + - Change baud rate of serial interface + + + +--- + +#### DB + +--- + + - **Format:** `DB[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 bitRemarks
07-bit-
18-bit-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `DB1\r\n` + + **With Parameter (Set)** + - No response + - Change data bit of serial interface + + + +--- + +#### PR + +--- + + - **Format:** `PR[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 bitRemarks
0NONE-
1ODD-
2EVEN-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `PR0\r\n` + + **With Parameter (Set)** + - No response + - Change parity bit of serial interface + + + +--- + +#### SB + +--- + + - **Format:** `SB[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 bitRemarks
01-bit-
12-bit-
+ + - **Response** + + **Without Parameter (Get)** + - In ASCII: `SB0\r\n` + + **With Parameter (Set)** + - No response + - Change stop bit of serial interface + + + +--- + +#### FL + +--- + + - **Format:** `FL[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 controlRemarks
0NONE-
1XON/XOFFSoftware flow control
2RTS/CTSHardware flow control
3RTS on TXHardware flow control
4RTS 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 + + + +--- + +#### EC + +--- + + - **Format:** `EC[CR][LF]` + + - **Meaning:** UART Echoback function enable (data UART) + + - **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. + + + +### Serial Data Packing Options + + + +--- + +#### PT + +--- + + - **Format:** `PT[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 + + + +--- + +#### PS + +--- + + - **Format:** `PS[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) + + 1. 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. + 2. 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 + + + +--- + +#### PD + +--- + + - **Format:** `PD[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. + + + +### Options + + + +--- + +#### IT + +--- + + - **Format:** `IT[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 + + + +--- + +#### CP + +--- + + - **Format:** `CP[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. + + + + +--- + +#### NP + +--- + + - **Format:** `NP[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 + + + +--- + +#### SP + +--- + + - **Format:** `SP[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 + + + +--- + +#### DG + +--- + + - **Format:** `DG[CR][LF]` + + - **Meaning:** Serial debug message enable (debug UART) + + - **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. + + + +--- + +#### KA + +--- + + - **Format:** `KA[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](#ki) / [KE](#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. + + + +--- + +#### KI + +--- + + - **Format:** `KI[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 + + + +--- + +#### KE + +--- + + - **Format:** `KE[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 + + + +--- + +#### SO + +--- + + - **Format:** `SO[CR][LF]` + + - **Meaning:** SSL receive timeout value for SSL connection close + + - **Command Type:** Read / Write + + - **Parameter / Return Type:** Number (0 ~ 60000) + + - **Parameter / Return Value:** + + 0: Not used + 1 ~ 60000: SSL receive timeout (unit: millisecond) + + If the timeout is set, the SSL connection closes when SSL receive timeout over. + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `SO2000\r\n` + + **With Parameter (Set)** + - No response + - Change SSL receive timeout value + + + +--- + +#### RI + +--- + + - **Format:** `RI[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 + + + +### MQTT Settings + + + +--- + +#### QU + +--- + + - **Format:** `QU[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 + + + +--- + +#### QP + +--- + + - **Format:** `QP[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 + + + +--- + +#### QC + +--- + + - **Format:** `QC[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 + + + +--- + +#### QK + +--- + + - **Format:** `QK[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 + + + +--- + +#### PU + +--- + + - **Format:** `PU[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 + + + +--- + +#### U0 + +--- + + - **Format:** `U0[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 + + + +--- + +#### U1 + +--- + + - **Format:** `U1[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 + + + +--- + +#### U2 + +--- + + - **Format:** `U2[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 + + + +--- + +#### QO + +--- + + - **Format:** `QO[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 + + + +### Certificate Settings + + + +--- + +#### RC + +--- + + - **Format:** `RC[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 + + + +--- + +#### CE + +--- + + - **Format:** `CE[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 + + + +--- + +#### OC + +--- + + - **Format:** `OC[CR][LF][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][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][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[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 + + + +--- + +#### SS + +--- + + - **Format:** `SS[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 + + + +### 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 + + + +--- + +#### UF + +--- + + - **Format:** `UF[CR][LF]` + + - **Meaning:** Copy firmware from firmware binary bank to application bank + + - **Command Type:** Read / Write + + - **Parameter / Return:** + + Ex> 1 + + - **Response** + + **Without Parameter (Get)** + - In ASCII: `UF0\r\n` + + **With Parameter (Set)** + - No response + - Change current bank flag + + After reset, copy firmware from firmware binary bank to application bank. + + + +--- + +#### 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 + + `> REBOOT` + + + +### Status I/O + + + +--- + +#### SC + +--- + + - **Format:** `SC[CR][LF]` + + - **Meaning:** Set status I/O pin **[S0](#s0)(PA\_10) and [S1](#s1)(PA\_01)** operation mode + + - **Command Type:** Read / Write + + - **Parameter / Return Type:** Number (0 / 1) + + - **Parameter / Return Value:** + + - **Parameter\_0** (upper byte) + + + + + + + + + + + + + + + + + + + + + +
Parameter / Return valueMeaningRemarks
0PHY link statusDefault
1DTRData Terminal Ready (RS-232/TTL only)
+ + - **Parameter\_1** (lower byte) + + + + + + + + + + + + + + + + + + + + + +
Parameter / Return valueMeaningRemarks
0TCP connection statusDefault
1DSRData 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 + + + +--- + +#### S0 + +--- + + - **Format:** `S0[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` + + + +--- + +#### S1 + +--- + + - **Format:** `S1[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 client / TCP server / TCP 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` + + + +----- diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-en.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-en.md new file mode 100644 index 0000000000..da7d05b96d --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-en.md @@ -0,0 +1,96 @@ +--- +id: factory-rst-guide-en +title: Factory Reset Guide +date: 2024-08-08 +--- + + + +----- + + + +## Factory reset overview + +A factory reset will return the settings on the **W232N** to their factory state. + + + +----- + + + +## Required Hardware and Software + + + +### Hardware + + - W232N + - 5~36V Power adapter + - Cables (Ethernet / Serial) + + +### Software + + - WIZnet S2E Configuration Tool + - [Download the Latest Version](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases/tag/V1.5.0) + - [Download the Older Versions](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + + +----- +## How to factory reset the W232N + +There are two ways to perform a W232N factory reset. + +- [Using Config-Tool](#Using-Config-Tool) +- [Using Factory reset switch](#Using-Factory-reset-switch) + +## Using Config Tool + + +### Step 1: Run Config-tool + +Run installed **'Config-tool'** + + +### Step 2: Select ⑦Factory Rest from the top icon menu + + + + +### step 3: Do factory reset + + + +- select **Yes** + + +### Step 4: Done + + + +- If the factory reset completed successfully, you'll see a completion notification. + + +## Using factory reset switch + +### Step 1: Remove the top case + + + +- Remove the bolts on either side of the device to remove the top case + +### Step 2: Click the Factory Reset switch + + + +- Press and hold the factory reset switch for 5 seconds with the W232N booting normally. +- The RUN, LINK, and TCP LEDs blink twice rapidly. + +### Step 3: Done + +- Use Config-tool to verify that it initialized properly. + +----- diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-kr.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-kr.md new file mode 100644 index 0000000000..86c8ddfd0c --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-kr.md @@ -0,0 +1,97 @@ +--- +id: factory-rst-guide-kr +title: Factory Reset Guide-[KR] +date: 2024-08-08 +--- + + + +----- + + + +## 공장 초기화 개요 + +공장 초기화를 진행하면 **W232N** 의 세팅을 출고 상태로 되돌릴 수 있습니다. + + + +----- + + + +## 필요한 하드웨어 및 소프트웨어 + + + +### 하드웨어 + + + - W232N + - 5V~36V의 전원 어댑터 + - 데이터 케이블 (이더넷) + + + +### 소프트웨어 + + - WIZnet S2E Configuration Tool + - [최신 버전 다운로드](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + + +----- +## W232N 공장 초기화 방법 + +W232N공장 초기화는 두 가지 방법으로 시행 가능합니다. + +- [Config-Tool을 사용하는 방법](#Config-Tool을-사용한-공장초기화) +- [공장초기화 스위치를 사용하는 방법](#공장초기화-스위치를-사용) + + + +## Config-Tool을-사용한-공장초기화 + +### 1단계: Config-tool 실행 + +설치된 **'Config-tool'** 실행 + +### 2단계: 상단 Icon Menu에서 ⑦Facory Rest 선택 + + + +### 3단계: 공장 초기화 진행 + + + +- 공장 초기화 진행을 묻는 알림창이 뜨면 Yes 를 선택합니다. + + + +### 4단계: 완료 + + + +- 공장 초기화가 정상적으로 완료되었다면 완료 알림창을 확인할 수 있습니다. + + +## 공장초기화-스위치를-사용 + +### 1단계: 상단 케이스 분리 + + + +- 디바이스 양 옆의 볼트를 제거하여 상단 케이스를 분리 + +### 2단계: 공장 초기화 스위치 클릭 + + + +- 공장 초기화 스위치를 W232N이 정상적으로 부팅된 상태에서 5초간 누릅니다. +- RUN, LINK, TCP LED가 빠르게 2번 깜빡입니다. + +### 3단계: 완료 + +- Config-tool 을 사용하여 정상적으로 초기화 되었는지 확인합니다. + +----- diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-en.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-en.md new file mode 100644 index 0000000000..620f17028f --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-en.md @@ -0,0 +1,167 @@ +--- +id: firmware-update-guide-en +title: Firmware update guide +date: 2022-06-28 +--- + + + +----- + + + +## W232N Firmware Update Overview + + + +### Memory Map + + - Internal Flash + - Main flash size: 2 Mbytes + +```cpp + Top Flash Memory Address /-------------------------------------------\ 0x10200000 + | | + ~ ~ + | Reserved (832KB) | + |-------------------------------------------| 0x10130000 + | | + | Parameters (64KB) | + | | + |-------------------------------------------| 0x10120000 + | | + | | + | | + | | + | Firmware Binary Bank (512KB) | + | | + | | + | | + |-------------------------------------------| 0x100A0000 + | | + | | + | | + | | + | Application Bank (512KB) | + | | + | | + | | + |-------------------------------------------| 0x10020000 + | | + Page 1 (256KB) | | + | Bootloader (128KB) | + Page 0 (256KB) | | + | | + \-------------------------------------------/ 0x10000000 +``` + + + +### Firmware Update Sequence + +| | +| :------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/firmware_update_sequence.png) | +| Figure: **Firmware Update Sequence** | + + + +----- + + + +## How to upload or update the W232N firmware + +The W232N provides three ways to upload or update the firmware. + +- [Using Config-Tool](#Using-the-Configuration-Tool) +- [Using Web-Config](#Using-Web-Config) +- [Using USB](#Using-USB) +- [Using SWD](#Using-SWD) + + +----- + + + +## Using the Configuration Tool + + + +### Required Hardware and Software + + + +#### Hardware + + - W232N + - 5~36V Power adapter + - Cables (Ethernet / Serial) + + +#### Software + + - WIZnet S2E Configuration Tool + - [Download the Latest Version](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases/tag/V1.5.0) + - [Download the Older Versions](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + + + + +### Step 1: Run Config-tool + +Run installed **'Config-tool'** + + + +#### Step 2: Upload Firmware + +1. Click the **Firmware Upload** button + +| | +| :----------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/click_firmware_upload_button.png) | +| Figure: **Click Firmware Upload button** | + +2. Select the uploaded firmware + +When selecting firmware, you must select **.bin**(*_linker.bin). + +Firmware in a file format other than .bin cannot be uploaded or updated properly. + +| | +| :------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/select_uploaded_firmware.png) | +| Figure: **Select uploaded firmware** | + +3. Uploading the firmware + +| | +| :------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/uploading_firmware.png) | +| Figure: **Uploading firmware** | + + + +#### Step 3: Done + +Firmware upload or update completed! + +W232N is searched after about 5 seconds in the Configuration Tool after firmware upload or update completed. + +| | +| :----------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/firmware_upload_or_update_complete.png) | +| Figure: **Firmware upload or update complete** | + +## Using Web config +- update soon + +## Using USB +- update soon + +## Using SWD +- update soon + +----- diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-kr.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-kr.md new file mode 100644 index 0000000000..cb695bae06 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-kr.md @@ -0,0 +1,162 @@ +--- +id: firmware-update-guide-kr +title: Firmware update guide-[KR] +date: 2024-08-08 +--- + + + +----- + + + +## W232N 펌웨어 업데이트 개요 + + + +### 메모리 맵 + + - 내부 플래쉬 + - 메인 플래쉬 사이즈: 2 Mbytes + +```cpp + Top Flash Memory Address /-------------------------------------------\ 0x10200000 + | | + ~ ~ + | Reserved (832KB) | + |-------------------------------------------| 0x10130000 + | | + | Parameters (64KB) | + | | + |-------------------------------------------| 0x10120000 + | | + | | + | | + | | + | Firmware Binary Bank (512KB) | + | | + | | + | | + |-------------------------------------------| 0x100A0000 + | | + | | + | | + | | + | Application Bank (512KB) | + | | + | | + | | + |-------------------------------------------| 0x10020000 + | | + Page 1 (256KB) | | + | Bootloader (128KB) | + Page 0 (256KB) | | + | | + \-------------------------------------------/ 0x10000000 +``` + + + +### 펌웨어 업데이트 순서도 + +| | +| :------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/firmware_update_sequence.png) | +| Figure: **펌웨어 업데이트 순서도** | + + + +----- + + + +## W232N 펌웨어 업로드 또는 업데이트 방법 + +W232N은 펌웨어를 업로드하거나 업데이트하는 세 가지 방법을 제공합니다. + +- [Config Tool을 사용하는 방법](#config-tool을-사용하는-방법) +- [Web Config를 사용하는 방법](#web-config를-사용하는-방법) +- [USB를 사용하는 방법](#usb를-사용하는-방법) +- [SWD를 사용하는 방법](#swd를-사용하는-방법) + + + + + +----- + +## Config Tool을 사용하는 방법 + + +### 필요한 하드웨어 및 소프트웨어 + + + +#### 하드웨어 + +- W232N +- 5V~36V의 전원 어댑터 +- 데이터 케이블 (이더넷) + +#### 소프트웨어 + + - WIZnet S2E Configuration Tool + - [최신 버전 다운로드](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + + +### 1단계: Config-tool 실행 + +설치된 **'Config-tool'** 실행 + + +### 2단계: 펌웨어 업로드 + +1. **Firmware Upload** 클릭 + +| | +| :----------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/click_firmware_upload_button.png) | +| Figure: **Click Firmware Upload button** | + +2. 업로드할 FW 선택 + +업로드할 FW는 **.bin**(*_linker.bin)형식만 지원합니다. + +.bin 이외의 파일 형식의 펌웨어는 제대로 업로드되지 않거나 업데이트할 수 없습니다. + +| | +| :------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/select_uploaded_firmware.png) | +| Figure: **Select uploaded firmware** | + +3. FW 업로드 + +| | +| :------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/uploading_firmware.png) | +| Figure: **Uploading firmware** | + + + +### 3단계: 완료 + +펌웨어 업로드 또는 업데이트 완료! + +펌웨어 업로드 또는 업데이트가 완료된 후 구성 도구에서 약 5초 후에 W232N이 검색됩니다. + +| | +| :----------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/firmware_update_guide/firmware_upload_or_update_complete.png) | +| Figure: **Firmware upload or update complete** | + +## Web config를 사용하는 방법 +- 추후 업로드 + +## USB를 사용하는 방법 +- 추후 업로드 + +## SWD를 사용하는 방법 +- 추후 업로드 + +----- diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-en.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-en.md new file mode 100644 index 0000000000..8d6b342d30 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-en.md @@ -0,0 +1,116 @@ +--- +id: modbus-connection-guide-en +title: Modbus Connection Guide +date: 2024-05-23 +--- + + + + + +----- + + + +## W232N Modbus Connection Overview + +The **W232N** supports protocol conversion between **Modbus TCP server/UDP** and **Modbus RTU/ASCII**. + + +----- + + + +## Required Hardware and Software + + + +### Hardware + + + - W232N + - 5~36V Power adapter + - Cables (Ethernet / Serial) + + + +### Software + + - WIZnet S2E Configuration Tool + > **Note** : Modbus protocol requires the latest version of WIZnet-S2E-Tool-GUI version 1.5.5 or higher. + - [Download the Latest Version](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + - Modbus Poll & Slave: + - [Download Link](https://www.modbustools.com/download.html) + + + +----- + + + +## How to Connect to Modbus + + + +### Step 1: Run Config-tool + +Run installed **'Config-tool'** + + +### Step 2: Setup Modbus Poll & Slave + +Setup Modbus Poll & Slave Program. + + - Modbus Poll connects via Modbus TCP/IP or Modbus UDP/IP depending on the settings. + - Modbus Slave connects via the Serial Port. + +| | +| :--------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/setup_modbus_program.png) | +| Figure: **Setup Modbus Poll & Slave Program** | + + + +### Step 3: Setup W232N through WIZnet S2E Configuration Tool for Modbus Connection + +1. Select **TCP Server** or **UDP** mode in the **Operation mode** setting section + +| | +| :-------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/select_operation_mode.png) | +| Figure: **Select TCP Server or UDP mode** | + +2. Setup Modbus Option + +| | +| :-----------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/setup_modbus_option.png) | +| Figure: **Setup Setup Modbus Option** | + +3. Click the **Apply Settings** button to save the settings + +| | +| :--------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/apply_settings.png) | +| Figure: **Click Apply Settings button** | + +| | +| :-------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/saved_settings.png) | +| Figure: **Saved settings** | + + + + +### Step 4: Done + +W232N is successfully connected to the Modbus! +| | +| :-------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/connect_modbus.png) | +| Figure: **connected to the Modbus** + + +----- + diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-kr.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-kr.md new file mode 100644 index 0000000000..702d1d1613 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-kr.md @@ -0,0 +1,117 @@ +--- +id: modbus-connection-guide-kr +title: Modbus Connection Guide-[KR] +date: 2024-08-09 +--- + + + + + +----- + + + +## W232N Modbus 연결 개요 + +**W232N**는 **Modbus TCP server/UDP** 와 **Modbus RTU/ASCII** 사이의 프로토콜 변환 기능을 지원합니다. + + +----- + + + +## 필요한 하드웨어 및 소프트웨어 + + + +### 하드웨어 + + + - W232N + - 5~36V 전원 어댑터 + - 케이블 (이더넷 / 시리얼) + + + +### 소프트웨어 + + - WIZnet S2E Configuration Tool + > **Note** : Modbus protocol은 WIZnet-S2E-Tool-GUI 1.5.5 버전 이상이 필요합니다. + - [Download the Latest Version](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + - Modbus Poll & Slave: + - [Download Link](https://www.modbustools.com/download.html) + + + +----- + + + +## Modbus 연결하는 법 + + + + +### 1단계: Config-tool 실행 + +설치된 **'Config-tool'** 실행 + + +### 2단계: Modbus Poll & Slave 설정 + +Modbus Poll & Slave 프로그램을 세팅합니다. + + - Modbus Poll은 설정에 따라 모드버스 TCP/IP 또는 모드버스 UDP/IP를 통해 연결됩니다. + - Modbus Slave는 직렬 포트를 통해 연결됩니다. + +| | +| :--------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/setup_modbus_program.png) | +| Figure: **Setup Modbus Poll & Slave Program** | + + + +### 3단계: Modbus 연결을 위해 W232N를 WIZnet S2E Configuration Tool로 세팅하기 + +1. **Operation mode**섹선에 있는 **TCP Server** 혹은 **UDP** 모드를 설정합니다. + +| | +| :-------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/select_operation_mode.png) | +| Figure: **Select TCP Server or UDP mode** | + +2. Modbus 옵션을 설정합니다. + +| | +| :-----------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/setup_modbus_option.png) | +| Figure: **Setup Setup Modbus Option** | + +3. **Apply Settings**을 눌러서 세팅을 저장합니다. + +| | +| :--------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/apply_settings.png) | +| Figure: **Click Apply Settings button** | + +| | +| :-------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/saved_settings.png) | +| Figure: **Saved settings** | + + + + +### 4단계: 완료 + +W232N가 모드버스에 성공적으로 연결되었습니다! +| | +| :-------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/modbus-connection-guide/connect_modbus.png) | +| Figure: **connected to the Modbus** + + +----- + diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-en.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-en.md new file mode 100644 index 0000000000..b863088c09 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-en.md @@ -0,0 +1,405 @@ +--- +id: mqtt-connection-guide-en +title: MQTT Connection Guide +date: 2022-06-28 +--- + + + +----- + + + +## MQTT Connection Overview + +**W232N** supports **MQTT client** and **MQTTS client** mode. + + + +----- + + + +## Required Hardware and Software + + + +### Hardware + + + - W232N + - 5V Power adapter + - Cables (Ethernet / Serial) + + + +### Software + + - WIZnet S2E Configuration Tool + - [Download the Latest Version](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases/tag/V1.5.0) + - [Download the Older Versions](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + - Mosquitto: + - [Download Link](https://mosquitto.org/download/) + + + +----- + + + +## How to Connect to MQTT Broker through Mosquitto + +W232N supports MQTT client and MQTTS client mode, but this section guides how to connect to MQTT broker through Mosquitto based on MQTT client mode. + +> **Note** : MQTTS client mode requires additional security-related settings, unlike MQTT client mode. + + + +### Step 1: Run Config-tool + +Run installed **'Config-tool'** + + + + + +### Step 2: Setup Mosquitto + +Depending on the Mosquitto version, you may need to setup Mosquitto, so refer to the below to setup. + + - In Mosquitto versions earlier than 2.0 the default is to allow clients to connect without authentication. + - In 2.0 and up, you must choose your authentication options explicitly before clients can connect. + +Therefore, if you are using version 2.0 or later, refer to following link to setup 'mosquitto.conf' in the directory where Mosquitto is installed. + + - [Authentication Methods](https://mosquitto.org/documentation/authentication-methods/) + + + +### Step 3: Run MQTT Broker through Mosquitto + +```bash +Ex> +mosquitto -c mosquitto.conf -p 1883 -v +``` + +| | +| :---------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/run_mqtt_broker_through_mosquitto.png) | +| Figure: **Run MQTT broker through Mosquitto** | + + + +### Step 4: Setup Device through WIZnet S2E Configuration Tool for MQTT Broker Connection + +1. Select **MQTT client** mode in the **Operation mode** setting section + +| | +| :-----------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/select_mqtt_client_mode.png) | +| Figure: **Select MQTT client mode** | + +2. Setup the **remote host IP (or URL)** and **remote port** in the **Remote host / port** section + +| | +| :------------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/setup_remote_host_ip_and_remote_port.png) | +| Figure: **Setup remote host IP and remote port** | + +3. Setup MQTT options + +| | +| :------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/setup_mqtt_options.png) | +| Figure: **Setup MQTT options** | + +4. Click the **Apply Settings** button to save the settings + +| | +| :---------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/click_apply_settings_button.png) | +| Figure: **Click Apply Settings button** | + +| | +| :--------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/saved_settings.png) | +| Figure: **Saved settings** | + + + +### Step 5: Done + +Device is successfully connected to the MQTT broker! + +| | +| :------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/status.png) | +| Figure: **Status** | + +| | +| :----------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/connect_to_mqtt_broker.png) | +| Figure: **Connect to MQTT broker** | + + + +----- + + +## How to connect to AWS using MQTT + +### Step 1: Create a Thing and Policy in AWS and Download a Certificate + +1. To use AWS services, you must first sign in. Click the link below to go to the sign in page. + +**[AWS login page](https://aws.amazon.com/console/)** + +
+
+ + +2. Once logged in, search for “IoT Console” in the search bar and click on it. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Search “IoT Console"** | + +
+
+ +2. Click the “Things” tab on the left, then hit the orange “Create things” button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **click "Create Things"** | + +
+
+ + +3. Select “Create single thing” and press the Next button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Select "Create things"** | + +
+
+ + +4. Enter “Thing name” and hit the Next button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Enter "Thing name"** | + +
+
+ + +5. Select “Auto-generate a new certificate (recommended)” and press the Next button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Select "Auto-generate a new certificate" and click "Next"** | + +
+
+ + +6. Next, you need to create a policy for securing your Thing. Click “Create policy”. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Click "Create policy"** | + +
+
+ + +7. Set a name for the policy, configure the Policy Document as shown, and hit the Create button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Setting policy information** | + +
+
+ + +8. Go back to the “Create single thing” page you opened earlier and press the “Create thing” button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Click "Create thing"** | + +
+
+ + +9. Download all keys and certificates. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Download all keys and certificates** | + +
+
+
+
+ +### Step 2: Enter the certificate on the device + +1. In AWS, enter the MQTT Test Client tab and copy the endpoint. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Copy Endpoint** | + +
+
+ +2. Turn on the configuration tool to detect your device and set the “Basic settings” tab as follows + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Set the “Basic settings” tab in the configuration tool** | + +
+
+ +3. Set up the “MQTT options” tab like this + +- MQTT Topics Section + - **Publish Topic:** $aws/things/my_w232n_thing/shadow/update + - **Subscribe Topic:** $aws/things/my_w232n_thing/shadow/update/accepted + +- MQTT Options + - **Client ID:** my_w232n_thing + - **Keep-Alive:** 60 + - **QoS:** QoS 0 + +- Remote Host / Port + - **Remote Host:** Paste the copied endpoint + - **Remote Port:** 8883 + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Set “MQTT options”** | + +
+
+ + +4. Go to the Certificate Manager tab and adjust the Root CA section as shown below. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Adjust the Root CA section** | + +
+
+ +5. Tap “Load file” to load the following certificate and key files + +- **Root CA** : AmazonRootCA1.pem +- **Client Certificate** : xxxxx-certificate.pem.crt +- **Private Key** : xxxxx-private.pem.key + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Load certificate and key files** | + +
+
+ +6. Press each of the “Save to device” buttons. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Save certificate and key files** | + +
+
+ +7. click “Apply settings”. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **click “Apply settings”** | + +
+
+
+
+ + +### Step 3: Run (Subscribe) + +1. Go back to the AWS IoT Console page and click “MQTT test client” under the “Test” section to enter it. Then, in the MQTT Topics Section of the configuration tool, enter the Publish Topic **$aws/things/my_w232n_thing/shadow/update** in the “Topic filter” and hit the Subscribe button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Subscrive topic** | + +
+
+ +2. Open your device's serial port using a terminal tool to transfer data. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Transfer data** | + +
+
+ +3. This will ensure that your MQTT communication with AWS is working correctly. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Successful MQTT communication with AWS** | + +
+
+
+
+ +### Step 4: Run (Publish) + +1. Return to the AWS IoT Console page and click “MQTT test client” under the “Test” section. Then in the MQTT Topics Section of the configuration tool, enter the Subscribe Topic $aws/things/my_w232n_thing/shadow/update/accepted in the “Topic name” and hit the Publish button. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Publish topic** | + +
+
+ +2. In the Serials window, you can see the data sent by AWS. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| Figure: **Successful MQTT communication with AWS** | diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-kr.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-kr.md new file mode 100644 index 0000000000..c012a4bb70 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-kr.md @@ -0,0 +1,404 @@ +--- +id: mqtt-connection-guide-kr +title: MQTT Connection Guide-[KR] +date: 2024-08-08 +--- + + + +----- + + + +## W232N MQTT 연결 개요 + +**W232N** 는 **MQTT client** 와 **MQTTS client** 모드를 지원합니다. + + + +----- + + + +## 필요한 하드웨어 및 소프트웨어 + + + +### 하드웨어 + + + - W232N + - 5V~36V의 전원 어댑터 + - 데이터 케이블 (이더넷 / 시리얼) + + + +### 소프트웨어 + + - WIZnet S2E Configuration Tool + - [최신 버전 다운로드](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + - Mosquitto + - [Download Link](https://mosquitto.org/download/) + + + +----- + + + +## Mosquitto를 통한 MQTT Broker 연결 방법 + +W232N은 MQTT 클라이언트 모드와 MQTTS 클라이언트 모드를 지원하만, 본 문서는 MQTT 클라이언트 모드를 기준으로 Mosquitto를 통해 MQTT 브로커에 연결하는 방법을 안내합니다. + +> **Note** : MQTTS 클라이언트 모드는 MQTT 클라이언트 모드와 달리 추가적인 보안 관련 설정이 필요합니다. + + + +### 1단계: Config-tool 실행 + +설치된 **'Config-tool'** 실행 + + + +### 2단계: Mosquitto 설정 + +Mosquitto 버전에 따라 모스키토 설정이 필요할 수 있으므로 아래를 참조하여 설정하세요. + + - 2.0V 이전 버전에서는 클라이언트가 인증 없이 연결할 수 있도록 허용하는 것이 기본값입니다. + - 2.0V 이상에서는 클라이언트가 연결하기 전에 인증 옵션을 명시적으로 선택해야 합니다. + +따라서 버전 2.0 이상을 사용하는 경우, 다음 링크를 참조하여 Mosquitto가 설치된 디렉토리에 'mosquitto.conf'를 설정하세요. + + - [인증 방법](https://mosquitto.org/documentation/authentication-methods/) + + + +### 3단계: Mosquitto를 통해 MQTT 브로커 실행하기 + +```bash +Ex> +mosquitto -c mosquitto.conf -p 1883 -v +``` + +| | +| :---------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/run_mqtt_broker_through_mosquitto.png) | +| Figure: **Mosquitto를 통해 MQTT 브로커 실행** | + + + +### 4단계: MQTT 브로커 연결을 위해 Config-Tool을 사용해 W232N을 설정하기 + +1. **Operation mode** 설정 섹션에서 **MQTT client** 모드를 선택합니다. + +| | +| :-----------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/select_mqtt_client_mode.png) | +| Figure: **MQTT client mode 선택** | + +2. **Remote host / port** 설정 섹션에서 **remote host IP (or URL)** 와 **remote port** 를 설정합니다. + +| | +| :------------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/setup_remote_host_ip_and_remote_port.png) | +| Figure: **remote host IP 와 remote port 설정** | + +3. MQTT options 설정 + +| | +| :------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/setup_mqtt_options.png) | +| Figure: **MQTT options 설정** | + +4. **Apply Settings** 버튼을 눌러 세팅값 적용. + +| | +| :---------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/click_apply_settings_button.png) | +| Figure: **Apply Settings 클릭** | + +| | +| :--------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/saved_settings.png) | +| Figure: **세팅값 저장** | + + + +### 5단계: 완료 + +W232N이 MQTT 브로커에 성공적으로 연결되었습니다! + +| | +| :------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/status.png) | +| Figure: **Status** | + +| | +| :----------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/mqtt_connection_guide/connect_to_mqtt_broker.png) | +| Figure: **Connect to MQTT broker** | + + + + +----- + + + +## MQTT를 이용하여 AWS에 연결하는 방법 + +### 1단계: AWS에서 Thing 및 정책 생성 및 인증서 다운로드 + +1. AWS 서비스를 사용하려면 먼저 로그인해야 합니다. 아래 링크를 클릭하여 로그인 페이지로 이동하세요. + +**[AWS 로그인 페이지](https://aws.amazon.com/console/)** + +
+
+ + +2. 로그인 후 검색 창에서 "IoT 콘솔"을 검색하고 클릭하세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"IoT 콘솔" 검색** | + +
+
+ +2. 왼쪽의 "Things" 탭을 클릭한 다음 오렌지색 "Create things" 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"Things 생성" 클릭** | + +
+
+ + +3. "Create single thing"을 선택하고 다음 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"Create things" 검색** | + +
+
+ + +4. "Thing name"을 입력하고 다음 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"Thing name" 입력** | + +
+
+ + +5. "Auto-generate a new certificate (recommended)"을 선택하고 다음 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"Auto-generate a new certificate" 선택 후 "Next"클릭** | + +
+
+ + +6. 다음으로, Thing의 보안을 위한 정책을 생성해야 합니다. "Create policy"를 클릭하세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"Create policy" 클릭** | + +
+
+ + +7. 정책의 이름을 설정하고 그림과 같이 Policy Document를 구성한 후 생성 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **정책 정보 설정** | + +
+
+ + +8. 이전에 열었던 "Create single thing" 페이지로 돌아가서 "Create thing" 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"Create thing" 버튼 누르기** | + +
+
+ + +9. 모든 Key 및 인증서를 다운로드하세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **모든 Key 및 인증서 다운로드** | + +
+
+
+
+ +### 2단계: S2E 모듈에 인증서 입력 + +1. AWS에서 MQTT 테스트 클라이언트 탭을 입력하고 엔드포인트를 복사하세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **Endpoint 복사** | + +
+
+ +2. Config-tool을 켜서 장치를 검색하고 다음과 같이 "Basic settings" 탭을 설정하세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **Config-tool을의 "Basic settings" 탭 설정** | + +
+
+ +3. 다음과 같이 "MQTT options" 탭을 설정하세요. + +- MQTT Topics Section + - **Publish Topic:** $aws/things/my_w232n_thing/shadow/update + - **Subscribe Topic:** $aws/things/my_w232n_thing/shadow/update/accepted + +- MQTT Options + - **Client ID:** my_w232n_thing + - **Keep-Alive:** 60 + - **QoS:** QoS 0 + +- Remote Host / Port + - **Remote Host:** 복사한 엔드포인트 붙여넣기 + - **Remote Port:** 8883 + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"MQTT options" 설정** | + +
+
+ + +4. Certificate Manager 탭으로 가서 아래 그림과 같이 Root CA 섹션을 조정하세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **Root CA 섹션 조정** | + +
+
+ +5. "Load file"을 눌러 다음 인증서 및 키 파일을 로드하세요: + +- **Root CA** : AmazonRootCA1.pem +- **Client Certificate** : xxxxx-certificate.pem.crt +- **Private Key** : xxxxx-private.pem.key + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **인증서 및 키 파일 로드** | + +
+
+ +6. 표시한 "Save to device" 버튼을 각각 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **인증서 및 키 파일 저장** | + +
+
+ +7. "Apply settings"을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **"Apply settings" 누르기** | + +
+
+
+
+ + +### 3단계: 실행 (Subscribe) + +1. AWS IoT 콘솔 페이지로 돌아가서 "Test" 섹션 아래의 "MQTT test client"를 클릭하여 들어갑니다. 그런 다음 구성 도구의 MQTT Topics Section에서 Publish Topic **$aws/things/my_w232n_thing/shadow/update**를 "Topic filter"에 입력하고 Subscribe 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **주제 구독** | + +
+
+ +2. 디바이스의 시리얼포트를 터미널 도구를 사용하여 열고 데이터를 전송하세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **데이터 전송** | + +
+
+ +3. 이렇게 하면 AWS와의 MQTT 통신이 올바르게 작동하는지 확인할 수 있습니다. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **AWS와의 성공적인 MQTT 통신** | + +
+
+
+
+ +### 4단계: 실행 (Publish) + +1. AWS IoT 콘솔 페이지로 돌아가서 "Test" 섹션 아래의 "MQTT test client"를 클릭합니다. 그런 다음 구성 도구의 MQTT Topics Section에서 Subscribe Topic $aws/things/my_w232n_thing/shadow/update/accepted를 "Topic name"에 입력하고 Publish 버튼을 누르세요. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **주제에 게시** | + +
+
+ +2. 시리얼 창에서 AWS에서 보낸 데이터를 확인할 수 있습니다. + +| | +| :-----------------------------------------------------------------------------------------: | +| | +| 그림: **AWS와의 성공적인 MQTT 통신** | diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/W55RP20-S2E.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/overview-[EN].md similarity index 97% rename from docs/Product/ioNIC/W55RP20/W55RP20-S2E/W55RP20-S2E.md rename to docs/Product/ioNIC/W55RP20/W55RP20-S2E/overview-[EN].md index e8fa1d6c74..f43d5ba027 100644 --- a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/W55RP20-S2E.md +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/overview-[EN].md @@ -1,4 +1,8 @@ - +--- +id: overview-[EN] +title: Overview +date: 2024-10-23 +--- ## Overview @@ -49,8 +53,10 @@ The **W55RP20-S2E** is a pre-programmed product with an Serial to Ethernet FW an - [How to connet SSL](./../../../S2E-Module/Industrial/ssl-connection-guide-en.md) - [How to connet Modbus](./../../../S2E-Module/Industrial/modbus-connection-guide-en.md) - [How to update FW](./../../../S2E-Module/Industrial/firmware-update-guide-en.md) -- [How to do factory reset ](./../../../S2E-Module/Industrial/factory-rst-guide-en.md) - +- [How to do factory reset](./../../../S2E-Module/Industrial/factory-rst-guide-en.md) + ## Customization Services diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-en.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-en.md new file mode 100644 index 0000000000..c5d5fb12f4 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-en.md @@ -0,0 +1,153 @@ +--- +id: ssl-connection-guide-en +title: SSL Connection Guide +date: 2022-06-28 +--- + + + +----- + + + +## W232N SSL Connection Overview + +**W232N** supports **SSL TCP client** mode. + + + +----- + + + +## Required Hardware and Software + + + +### Hardware + + - W232N + - 5~36V Power adapter + - Cables (Ethernet / Serial) + + + +### Software + + - WIZnet S2E Configuration Tool + - [Download the Latest Version](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases/tag/V1.5.0) + - [Download the Older Versions](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + - OpenSSL: + - [Download Link](https://slproweb.com/products/Win32OpenSSL.html) + + + +----- + + + +## How to Connect to SSL Server through OpenSSL + + + +### Step 1: Run Config-tool + +Run installed **'Config-tool'** + +### Step 2: Setup OpenSSL + +Setup OpenSSL to use as the SSL Server. + +```bash +genrsa -des3 -out [key_name].key 2048 +req -new -key [key_name].key -out [csr_name].csr +x509 -req -days [days] -in [csr_name].csr -signkey [key_name].key -out [crt_name].crt + +Ex> +genrsa -des3 -out server.key 2048 +req -new -key server.key -out server.csr +x509 -req -days 365 -in server.csr -signkey server.key -out server.crt +``` + + + +### Step 3: Run SSL Server through OpenSSL + +If you have setup the OpenSSL to use as the SSL server, run the SSL server. + +```bash +s_server -accept [port] -cert [crt_name].crt -key [key_name].key + +Ex> +s_server -accept 443 -cert server.crt -key server.key +``` + + + +### Step 4: Setup W232N through WIZnet S2E Configuration Tool for SSL Server Connection + +1. Select **SSL TCP client** mode in the **Operation mode** setting section + +| | +| :-------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/select_ssl_tcp_client_mode.png) | +| Figure: **Select SSL TCP client mode** | + +2. Setup the **remote host IP (or URL)** and **remote port** in the **Remote host / port** section + +| | +| :-----------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/setup_remote_host_ip_and_remote_port.png) | +| Figure: **Setup remote host IP and remote port** | + +3. Click the **Apply Settings** button to save the settings + +| | +| :--------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/click_apply_settings_button.png) | +| Figure: **Click Apply Settings button** | + +| | +| :-------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/saved_settings.png) | +| Figure: **Saved settings** | + + +> **Note**: If you need certificates to connect to the SSL server, please refer to the [**'What If I Need Certificates to Connect to SSL Server'**](#what-if-i-need-certificates-to-connect-to-ssl-server) section below. + + + +### Step 5: Done + +W232N is successfully connected to the SSL server! + + + +----- + + + +## Appendix + + + +### What If I Need Certificates to Connect to SSL Server? + +You can upload certificates below in the '**Certificate manager**' tab of the'WIZnet S2E Configuration Tool'. + - Root CA + - Client Certificate + - Private key + +Upload and setup the certificates required by the SSL server you want to connect to. + +After loading the certificate by clicking the '**Load file**' button, be sure to save it by clicking the '**Save to device**' button. + +| | +| :------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/upload_certificates.png) | +| Figure: **Upload certificates** | + + + +----- diff --git a/docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-kr.md b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-kr.md new file mode 100644 index 0000000000..cd5b8caac4 --- /dev/null +++ b/docs/Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-kr.md @@ -0,0 +1,147 @@ +--- +id: ssl-connection-guide-kr +title: SSL Connection Guide-[KR] +date: 2024-08-08 +--- + + + +----- + + + +## W232N SSL 연결 개요 + +**W232N**는 **SSL TCP client** 모드를 지원하니다. + + + +----- + + + +## 필요한 하드웨어 및 소프트웨어 + + + +### 하드웨어 + + - W232N + - 5~36V 전원 어댑터 + - 데이터 케이블 (Ethernet / Serial) + + +### 소프트웨어 + + - WIZnet S2E Configuration Tool + - [최신 버전 다운로드](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI/releases/tag/V1.5.0) + - [GitHub Repository](https://github.com/Wiznet/WIZnet-S2E-Tool-GUI) + - OpenSSL: + - [다운로드 링크](https://slproweb.com/products/Win32OpenSSL.html) + + + +----- + + + +## OpenSSL을 통해 SSL 서버에 연결하는 방법 + + + +### 1단계: Config-tool 실행 + +설치된 **'Config-tool'** 실행 + +### 2단계: OpenSSL 설정 + +SSL 서버로 사용할 OpenSSL을 설정합니다. + +```bash +genrsa -des3 -out [key_name].key 2048 +req -new -key [key_name].key -out [csr_name].csr +x509 -req -days [days] -in [csr_name].csr -signkey [key_name].key -out [crt_name].crt + +Ex> +genrsa -des3 -out server.key 2048 +req -new -key server.key -out server.csr +x509 -req -days 365 -in server.csr -signkey server.key -out server.crt +``` + + + +### 3단계: OpenSSL를 사용해 SSL서버 실행 + +OpenSSL을 SSL 서버로 사용하도록 설정한 경우 SSL 서버를 실행합니다. + +```bash +s_server -accept [port] -cert [crt_name].crt -key [key_name].key + +Ex> +s_server -accept 443 -cert server.crt -key server.key +``` + + + +### 4단계: Configuration Tool을 사용해 W232N을 SSL Server 연결할 수 있도록 설정 + +1. **Operation mode** 섹션에서 **SSL TCP client** 모드를 선택 + +| | +| :-------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/select_ssl_tcp_client_mode.png) | +| Figure: **Select SSL TCP client mode** | + +2. **Remote host / port** 섹션의 **remote host IP (or URL)** 와 **remote port** 를 설정 + +| | +| :-----------------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/setup_remote_host_ip_and_remote_port.png) | +| Figure: **Setup remote host IP and remote port** | + +3. **Apply Settings** 버튼을 눌러 세팅을 저장합니다. + +| | +| :--------------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/click_apply_settings_button.png) | +| Figure: **Click Apply Settings button** | + +| | +| :-------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/saved_settings.png) | +| Figure: **Saved settings** | + + +> **Note**: SSL 서버에 연결하기 위해 인증서가 필요한 경우 아래의 [SSL 서버에 연결하기 위해 인증서가 필요한 경우 어떻게 하나요?](#SSL-서버에-연결하기-위해-인증서가-필요한-경우)를 참고해주세요 + + + +### 5단계: 완료 + +W232N이 SSL 서버에 성공적으로 연결되었습니다! + + + +----- + + + +## SSL 서버에 연결하기 위해 인증서가 필요한 경우 + +Config-tool의 '**Certificate manager**' 탭에서 인증서를 업로드할 수 있습니다. + - Root CA + - Client Certificate + - Private key + +연결하려는 SSL 서버에 필요한 인증서를 업로드하고 설정합니다. + +'**Load file**' 버튼을 클릭하여 인증서를 로드한 후, '**Save to device**' 버튼을 클릭하여 저장해야 합니다. + +| | +| :------------------------------------------------------------------------------------: | +| ![](/img/products/s2e_module/wiz5xxsr-rp/ssl_connection_guide/upload_certificates.png) | +| Figure: **Upload certificates** | + + + +----- diff --git a/sidebars.js b/sidebars.js index 2129e380a6..8f6ee3f06a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -49,34 +49,34 @@ module.exports = { { type: 'category', label: 'W55RP20-S2E', - link: {type: 'doc', id: 'Product/ioNIC/W55RP20/W55RP20-S2E/W55RP20-S2E'}, items: [ + 'Product/ioNIC/W55RP20/W55RP20-S2E/overview-[EN]', +// { +// type: 'category', +// label: 'Common docs for using-[KR]', +// items: [ +// 'Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-kr', +// 'Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-kr', +// 'Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-kr', +// 'Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-kr', +// 'Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-kr', +// 'Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-kr', +// 'Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_KO', +// 'Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-kr', +// ], +// }, { type: 'category', - label: 'Common docs for using-[KR]', + label: 'Common docs for using', items: [ - 'Product/S2E-Module/Industrial/Config-tool-Guide-kr', - 'Product/S2E-Module/Industrial/command-manual-kr', - 'Product/S2E-Module/Industrial/mqtt-connection-guide-kr', - 'Product/S2E-Module/Industrial/ssl-connection-guide-kr', - 'Product/S2E-Module/Industrial/modbus-connection-guide-kr', - 'Product/S2E-Module/Industrial/firmware-update-guide-kr', - 'Product/S2E-Module/Industrial/Web_Config_Guide_KO', - 'Product/S2E-Module/Industrial/factory-rst-guide-kr', - ], - }, - { - type: 'category', - label: 'Common docs for using-[EN]', - items: [ - 'Product/S2E-Module/Industrial/Config-tool-Guide-en', - 'Product/S2E-Module/Industrial/command-manual-en', - 'Product/S2E-Module/Industrial/mqtt-connection-guide-en', - 'Product/S2E-Module/Industrial/ssl-connection-guide-en', - 'Product/S2E-Module/Industrial/modbus-connection-guide-en', - 'Product/S2E-Module/Industrial/firmware-update-guide-en', - 'Product/S2E-Module/Industrial/Web_Config_Guide_EN', - 'Product/S2E-Module/Industrial/factory-rst-guide-en', + 'Product/ioNIC/W55RP20/W55RP20-S2E/Config-tool-Guide-en', + 'Product/ioNIC/W55RP20/W55RP20-S2E/command-manual-en', + 'Product/ioNIC/W55RP20/W55RP20-S2E/mqtt-connection-guide-en', + 'Product/ioNIC/W55RP20/W55RP20-S2E/ssl-connection-guide-en', + 'Product/ioNIC/W55RP20/W55RP20-S2E/modbus-connection-guide-en', + 'Product/ioNIC/W55RP20/W55RP20-S2E/firmware-update-guide-en', + 'Product/ioNIC/W55RP20/W55RP20-S2E/Web_Config_Guide_EN', + 'Product/ioNIC/W55RP20/W55RP20-S2E/factory-rst-guide-en', ], }, ],