User Manual and Test Guide

Transcription

1 User Manual and Test Guide IOTService Tool

2 CONTENT 1. IOTSERVICE INSTALLATION IOTSERVICE INTRODUCTION product connection Eport-E10 Device Connection HF2211 Device Connection Serial Port Configuration Serial port tool: SecureCRT Serial Parameter Configuration IOTSERVICE INTRODUCTION Main Page Introduction Eport Status Interface Eport Setup Parameter Config Page Test CASE EVK Test Topology TCP Server Test TCP Client Local Test... 22

3 5.4. TCP Client Connect to Remote Test Server VIRTUAL Path UES CASE EVK Test Topology Remote Communication Via Virtual Com Virtual Through Local Communication Virtual Through Remote Communication IOTBridge ALARM function Set IOTBridge Parameters Set Mail Information IOTBridge Cloud... 39

4 History: First Version Update to IOTService 2.5 Version Update IOTService to IOTService. Version Update IOTService. Version e Update IOTService. Version

5 1. IOTSERVICE INSTALLATION Step 1: Download the IOTService tool as the following link. Address 1: Address 2: Step 2: Install IOTService tool according to the PC OS(x64 for 64 bit Windows OS, x86 for 32 bit Windows OS) Step 3: Click IOTService and launch the tool after installation. It will pop up the following choice. If does not need to use our IOTBridge function, then choice Cancel. Click Confirm button to enable our IOTBridge function. Step 4: Fill in the <Service Id> (See IOTBridge chapter to get this account). Service Name is irrelevant currently. Step 5: The tool will show the following UI.

6 Notes: This tools need JRE environment and will automatically install it.

7 2. IOTSERVICE INTRODUCTION IOTService is a management tools for our serial server devices. It is the upgrade version if previous IOTService. Add the feature of our IOT bridge cloud for remote device setting and data transfer. IOT bridge cloud use UDP/P2P/NAT to make the IOTService software remote setting and control devices. The detailed structure is as following picture. The following products can be configured by this tool. Take Eport-E10 and

8 HF2211 for example, the others is the same usage. Super Ethernet Port Product: Ethernet Serial Server Product: Wi-Fi Serial Server Product 4G Serial Server

9 3. PRODUCT CONNECTION 3.1. Eport-E10 Device Connection Connect the EPORT EVK with PC by USB cable and connect the EPORT EVK to the router by Ethernet cable. Meanwhile, it can be seen that the power light is on, which means power supply is already. 2~3 sec after powered on, the Link light is on, and it indicates Eport-E10 launch normally and link to the router. Notes: 1. Press Reload 3 seconds and then leave, the module will restore the factory configure and the restart. 2. If using USB port, it needs to download FT232 drive from the website and then update HF2211 Device Connection Connect device Ethernet to router LANN port. Then power on the device, the device Link LED will be on. The HF2211 Wi-Fi by default is AP mode, the Ethernet port is WANN mode, so Ethernet can direct connect to router(get DHCP IP from router or use AUTO-IP when Ethernet direct connect to PC). If configure the product Wi-Fi to STA mode, then the Ethernet port is by default changed to LANN mode.

10 3.3. Serial Port Configuration Serial port tool: SecureCRT Download address : Unzip the file and find the following icon, Open and click quick connect button to create connection Serial Parameter Configuration Protocol:Serial

11 Port : The real PC connected com(check by MY PC -> Device Manager -> Port ),shown like this figure Baud rate: Data bit: 8 Parity check: None Stop bit: 1 Flow control: NONE(Please remove in front of RTS/CTS)

12 4. IOTSERVICE INTRODUCTION 4.1. Main Page Introduction When it starts, it will show the scaned products in the same local area network or the remote device under the same Service Id. The scan can be enabled or stopped.. To the selected product, it can check the specific status and configure it. Vircom: virtual serial setting and virtual throughput function. See examples for more detailed usage.

13 Software Setting:Tool setting, it is relevant with product.

14 Remote Access Enable:Enable/Disable our remote control function, IOTBridge server is used for P2P device management and data transfer if enable. Service Id:This id is used for IOTBridge to distinguish different user device. The device side must write User Id(Cli command SYS/UserID to modify) to bind to this Service Id. See chapter 8 for details to get ServiceId and User Id. Service Name:Reserved Communication:Communication relevant setting. No need to modify, keep default. Alarm: Alarm when device offline. Default Setting:Restore tool setting to default. Add Device: Add remote device under Service Id(The User Id should first be written via Cli SYS/UserID command), if the device is in locally, then it will be added automatically.

15 BroadCast Scan: BroadCast scan device. When set the device with static IP such as XXX, but this IP is not in the same network with router( xxx), with this broadcast scan, it can be also found and modify it to the same network, and then the device status can be checked and modified.

16 VirPath: The virtual path is for virtual com and virtual throughput function. DeviceType : device name. This name can be changed by cli command(sys/customerid) Position: Show device position. VirPath: Show virtual path status. Connected: the status of connecting to our IOTBridge server. If only it is

17 connected, the remote device can be checked and controlled..

18 4.2. Eport Status Interface Status interface indicates the default information(including software version, network, serial port and socket communication status.etc) Reload button: restore parameter to the factory parameter. Restart button: restart product Edit button: enter into parameter setting interface 4.3. Eport Setup Parameter Config Page The specific meaning of each parameter, please search the Cli command chapter in product manual. Confirm button: Confirm modified parameter Cancel button: Exit setting page Export button: Export current parameter config file. This file can be used to configure other product. Import button: Import parameter config file. VCOM button: Set virtual com and the following chapter will describe this function. Detail button: It appears more specific parameter settings. F-Set Update:Set the current as factory setting, when do reload operation, restore to the current setting. F-Set Clear:Clear the factory setting, when do reload operation, restore to the default setting. Notes: HF5111A/HF5111B/HF2211 product have Protect switch to enable the parameters protect function, when it is switch to on, then some setting of the

19 tools is forbidden.

20 5. TEST CASE 5.1. EVK Test Topology 5.2. TCP Server Test Step 1: Open TCP&UDP test tool and bulid TCP connection as following steps. Products provides with a built TCP server(port 8899) TCP&UDP test tool can be downloaded from website: Dest IP:IP address Port:Port of server Step 2: Click Connect to build TCP connection.

21 After build successfully, the left arrow will turn to green. Step 3: Open the serial port as following parameters ( baud rate default) Step 4:Transmit data between TCP tool and serial port tool.

22 5.3. TCP Client Local Test Step 1: Open TCP&UDP test tool and build TCP connection as following steps. Local IP:PC IP address. Do not tick, tool will automatically select. Local Port:TCP Server port number Step 2:Click Start Server to launch PC TCP Server function After connect successfully, the icon has the following changes.

23 Step 3:Open IOTService tool and create socket to connect tool as following step. Socket Name:Socket name can be set randomly (differ from other sockets), 5 maximum default. Protocol:Select TCP-Client Server Addr: Server IP address Server Port:Server port number Step 4:Transmit data between TCP tool and serial port tool

24 5.4. TCP Client Connect to Remote Test Server Step 1: Open TCP&UDP test tool and build TCP connection as following steps. Socket Name:Socket name can be set randomly (differ from other sockets), 5 maximum default. Protocol:Select TCP-Client Server Addr:Server IP address, Test Server IP: Server Port:Server port number, Test server TCP port:3006, UDP port: This case takes TCP transport as example.

25 Step 2:Setting interface, search device status to confirm if server is connected Step 3:Serial port sends aaa and the server will respond TCP client WAN IP address and received data(format: [Protocol]:[IP address]:[port]\adata:[data]), the output from serial port is show below:

26 6. VIRTUAL PATH UES CASE 6.1. EVK Test Topology Virtual com is used for communication from local PC to remote device. In the following figure, PC and send data to PLC or receive from it by serial port. In the following test, pc is stimulated as PLC and use the same PC to build two COMs to send and receive data. Step 1: Open IOTService Tool and create virtual com as follows: VCOM: Virtual port to create delete button. After select related COM number and communication type, and click Add button to create. Step 2:Enter into device manage window and socket window and it can confirm

27 created virtual COM. Step 3: Open serial port tool and set virtual port baud rate (Product supports self-adaption baud rate function and serial port from device hardware will execute according to the parameter from virtual Com. You do not need to modify its serial port baud rate ) Step 4:Send and receive data Step 5: Modify virtual COM baud rate as From the following figure, it can be seen that the baud rate of device is However, in fact, device works at 9600 which is the same as configured (If reset device, product works at default baud rate)

28 6.2. Remote Communication Via Virtual Com The following HF2211 device is in the remote environment and connect a PLC 如下 device, the local PC can also send/receive to the PLC via virtual path.

29 Step 1:Write User Id into device as the following picture. Service Id and User Id can be got via IOTBridge. Step 2:IOTService write Service Id.

30 Step 3:Add HF2211 in the IOTService tools. After add successfully, this device can be seen in the IOTService.

31 Step 4:Create Virtual Com. The setting is the same as previous. Step 5:It show COM1/TCP has been connected. The IP address is meaningless in the remote test environment. (Can use phone hotpot to simulate the remote test environment )

32 The following is direct connect RS232 TX and RX, so it show the data received.

33 6.3. Virtual Through Local Communication Virtual Path use TCP or UDP method to transfer data with device. Step 1:Open IOTService tools, follow the following steps to create virtual through path. VirPath:Create or delete virtual path. Socket Type:TCP or UDP Server Addr: Virtual throughpath destination address, usually write PC TCP server IP and port Port:Server Port Step 2:Open TCP&UDP tools, PC create TCP Server.

34 Step 3:Confirm Virtual Path status. Step 4:Send and receive data.

35

36 6.4. Virtual Through Remote Communication The following test case is in remote environment, the PC can create virtual through path to transfer data with remote PLC. Step 1:Add the product into IOTService as chapter 6.2. Step 2:Create the Virtual Through Path as following pic. Step 5:The IOTService show Virtual Path has been connected.

37 The following is direct connect RS232 TX and RX, so it show the data received.

38 7. IOTBRIDGE ALARM FUNCTION 7.1. Set IOTBridge Parameters 7.2. Set Mail Information When IOTBridge find device is off line, it will auto send mail to the mail address. Example:

39 8. IOTBRIDGE CLOUD IOT Bridge cloud is for customer to check device status in its account and used for remote setting and data transfer with IOTService tools. The user guide is as following. Step 1:Open Step 2:Open I.O.T bridge and fill in the account information

40 Step 3:Fill in the personal information as following pic(english version language will be supported soon).

41 Step 4 : After register success, fill in the account information(service Id) in the IOTService tool. Note:Service ID can create more, while User ID is unique for an account.

42 Step 5 : Fill Service Id in IOTService.

43 Step 6 : Copy device mac. Step 7 : Ad device into IOTService.

44 Step 8 : Copy User ID.

45 Step 9 : Fill User Id into device, see user manual to enter Cli command mode.

46 Step 11 : The device will be shown in IOTBridge website. Step 12: Check detailed information

47