SerialSwitch Network - Cloud. Installation Manual (Version 1.6)

Transcription

1

2 , Version 1.6, Page 2 of 33 Contents 1 Document history 3 2 Overview of the components 4 3 SerialSwitchPortal Access rights User groups Online help SerialClient Installation SerialSwitch Serial interface GPRS Virtual COM ports Installing com0com SerialTunnel Create SerialTunnel Delete SerialTunnel Hardware SIM Card GPRS-Terminal MC88i Identifying the GPRS terminals: IMEI Number Interfaces Power supply Antenna connector, FME RS232 interface Inserting the SIM Card UMTS-Terminal EHS Identifying the UMTS terminal: IMEI Number Power supply Antenna connector, SMA RS232 interface Inserting the SIM Card LEDs Faultfinding SerialClient SerialSwitch SerialTunnel Notes Mobile data volume Modifications Safety notes Returning faulty devices 32 Appendix 33

3 , Version 1.6, Page 3 of 33 1 Document history Version Date Changes Added comments from DTAG of Added new portal screenshots and adapted the text Added new portal screenshots and adapted the text Added new portal screenshots and adapted the text Amendments in chapter 4 and addition of UMTS terminal and conditions for SIM cards

4 , Version 1.6, Page 4 of 33 2 Overview of the components The SerialSwitch Cloud software and the associated SerialSwitch terminal device allow you to set up a serial tunnel through a wireless GPRS data service between a user device in the field and a customer application software running on a PC. The SerialSwitch Cloud solution consists of the following components: SerialSwitch GPRS terminal device with embedded SerialSwitch gateway software. It forms one end of the serial data tunnel and is connected via RS232 with a user device in the field. SerialClient Client software on a PC which forms the other end of the serial data tunnel. It communicates with the customer application software via TCP or RS232. SerialTunnel The data connection between the SerialClient and the SerialSwitch. SerialSwitchCloud Cloud service which can be configured through a web portal. SerialSwitchPortal The SerialSwitch web portal is used to configure SerialClients and SerialSwitches and monitor their status. You can also set up new SerialTunnels for your own PC or another PC (provided, the SerialClient-Software is installed on). Figure 1: Concept SerialSwitch Network - Cloud The SerialClient software must be installed on a Windows computer with an Internet connection. It runs as a Windows service in the background and connects to the SerialSwitchCloud automatically. Each SerialSwitch terminal contains pre-configured SerialSwitch gateway software and automatically makes a permanent connection to the SerialSwitch cloud when you switch it on. The SerialSwitch portal is then used to set up a serial data tunnel from the SerialSwitch terminal to a SerialClient running on a PC. It is also used to configure the RS232 interface between the SerialSwitch terminal and the user device in the field. Section 4: SerialClient of this document describes the installation and usage of the SerialClient. Section 5: SerialSwitch describes the configuration of the SerialSwitch terminal and section 8: Hardware describes the hardware.

5 , Version 1.6, Page 5 of 33 3 SerialSwitchPortal You can access the SerialSwitchPortal using your browser at the Internet address de. You must then log in to the SerialSwitchPortal using your username and password. You are given both of these when you first order the package. After logging in for the first time, please change the password to a new one of your choice. To do this, click the My account at the top right and click Change password in the new window which appears. Enter the new password, click Save and click Home at the top left to get back to the home screen. 3.1 Access rights Each user is assigned to one of the following user groups which determine the access rights which the user has when using the web portal. Administrator The Administrator can create new users and user groups and manage existing users and groups. In addition he or she can assign users to one of the groups. This is described in more detail in the following section. The Administrator can also use all of the other functions of the SerialSwitchPortal such as creating SerialTunnels between SerialClients and SerialSwitches. User Users can use all of the functions of the SerialSwitchPortal (such as creating a SerialTunnel to a client on the user s PC or to a client on another user s PC). However the functions can only be applied to the SerialClients and SerialSwitches which are visible in the assigned user group and in underlying user groups (if any).

6 , Version 1.6, Page 6 of User groups When you order the product, we will create for you a user with customer administrator rights. You can use this user to create new user groups according to the required hierarchy. To manage user groups, click the Administration tab and choose User groups. Figure 2: Administration The Administration tab it is only visible to users in the user group Administrator. Figure 3 shows an example of user groups arranged in a hierarchy to match the hierarchy of departments in a company. The hierarchy of the user groups can have up to 3 levels. The + button in the right-hand column is missing at the lowest level (here: Junior development). This shows that you cannot create an additional group at a fourth level. User groups in the SerialSwitch portal are intended to prevent the access of individual users to SerialClients and SerialSwitches which belong to other departments in your company. Each SerialClient and each SerialSwitch is assigned to the user group to which the user belongs. For example, if a SerialClient is assigned to a user in the group Software development, it is also visible to other users of this group and to users of the overlying usergroups. On the other hand, if you are assigned to the user group Marketing, you can also see SerialClients and SerialSwitches from the underlying usergroups. You can always see objects in the lower levels. The customer administrator is at the highest level (here: Sample company), and thus he or she can see all of the SerialClients and SerialSwitches in the company.

7 , Version 1.6, Page 7 of 33 Figure 3: User groups 3.3 Online help The SerialSwitchPortal also has Online help. Click the? Help at the top of the screen to show the online help panel and to hide it again. The help function is context sensitive, it describes the content and the options for the page which you are currently viewing (see figure below). if the help function is visible, you can also click a button to download the manual you are now reading as a PDF file (Serial Switch Network - Cloud): 4 SerialClient The SerialClient software is compatible with the following Windows versions: Windows XP Windows Vista, 32 and 64 bit Windows 7 und 8, 32 and 64 bit.

8 , Version 1.6, Page 8 of 33 Figure 4: Home page with Online help panel visible The SerialClient software connects automatically to the SerialSwitchCloud after installation and can then be configured with the web portal. This section describes how to install the SerialClient on your computer. The application uses TCP-port Therefore the port should be open. 4.1 Installation First you must download the installer for the SerialClient from To do this, log onto the SerialSwitchPortal and click Home at the top left of the screen. Then click the Downloads button on the Home page and click Download SerialSwitch Client software in the new window (see figure below).

9 , Version 1.6, Page 9 of 33 Figure 5: Home page: Download-Button Run the installer. You must first choose where to install the SerialClient software Then click Install. Now enter your user name and password. This is the same user name and password which you used to log in to the SerialSwitchPortal. Now enter a name for the SerialClient. Later, this name will be visible in the SerialClients list in the SerialSwitchPortal. Now enter a name for the SerialClient. Later, this name will be visible in the SerialClients list in the SerialSwitchPortal. Please note that the password is case sensitive, which means a difference is made between small and capital letters.

10 , Version 1.6, Page 10 of 33 Figure 6: Download Button for the SerialSwitch client The installer will now check your login data and complete the installation. Check for correct installation by looking for the SerialClient you just created in the web portal. You should see online alongside the name of your client in the SerialClients list. If you see offline instead (see Figure 9), have a look in section 9 Faultfinding for a possible solution.

11 , Version 1.6, Page 11 of 33 Figure 7: Choosing where to install the SerialClient Figure 8: Entering your user name and password in the SerialClient installer 5 SerialSwitch The SerialSwitch is the GPRS terminal device which is connected to the user device in the field through a serial interface (RS-232). It already contains the embedded SerialSwitch gateway software and connects automatically to the SerialSwitchCloud as soon as power is applied. When you order the SerialSwitch hardware, you are automatically assigned to be the owner of the SerialSwitch. You should see an overview of all of your SerialSwitches in the SerialSwitchPortal. Just like the SerialClients, you can see the online status and lots of other useful information. This section mainly describes the management and usage of the SerialClient. For more information about the GPRS terminal and the hardware please see section 8: Hardware. 5.1 Serial interface The GPRS terminals have a serial interface. You must configure the interface to allow communication with your user device. You need to know the baud rate of your user device and configure the same baud rate on your SerialSwitch. You do this when you set up a SerialTunnel (see section 7: SerialTunnel ). The SerialSwitch stores the settings for the serial interface and the settings are still the same after you restart the device. Accordingly you only need to configure the interface parameters once. If it should be necessary nonetheless to configure a different baud rate, delete the associated SerialTunnel in the

12 SerialSwitch Network - Cloud , Version 1.6, Page 12 of 33 Figure 9: Entering the name of the SerialClient SerialSwitchPortal and create a new tunnel with the new settings. 5.2 GPRS The SerialSwitch is connected to the SerialSwitchCloud via GPRS and thus it is important to ensure that the antenna is correctly connected. It is also important that the mobile data signal is strong enough to allow the SerialSwitch to connect to the GPRS network. As soon as the SerialSwitch connects to the network, you can view status information on the GPRS terminal in the SerialSwitchPortal. Among other things, you can check the strength of the received mobile data signal. To do this, navigate to the detail view of the SerialSwitch in the web portal by clicking on the IMEI and have a look at the diagram with the title GPRS-RSSI. Figure 10: Graphical view of the signal strength of the SerialSwitch

13 , Version 1.6, Page 13 of 33 6 Virtual COM ports The SerialClient can communicate with your application software in various ways, for example through COM ports. So-called virtual COM ports allow the application software to communicate with the SerialClient internally via software instead of using an RS232 cable. The program com0com (null-modem emulator) creates interconnected pairs of virtual COM ports which can be used to connect the two pieces of software. The installation of com0com is only necessary if the customer application is installed on the same PC as the SerialClient and you want to communicate using COM ports. The following diagram illustrates thea connection between the SerialClient and your application software using virtual COM ports. User- Application COM26 com0com SerialClient COM27 Personal Computer Figure 11: Virtual COM ports with com0com You must install the null-modem emulator com0com on the same computer where the SerialClient is installed. 6.1 Installing com0com To install the null-modem emulators com0com, click the Downloads button on the Home page and click Download com0com software in the new window (see figure below). Choose the appropriate version for your Windows operating system (Windows 7, 32-bit / 64-bit or Windows XP). Then run the installation program setup.exe. When you are prompted to accept the driver test certificate, click Yes to confirm that you want to continue with the installation. When you are prompted for a valid driver, just click Next (Search for driver automatically).

14 , Version 1.6, Page 14 of 33 Figure 12: Download com0com software After installation, com0com starts its configuration window automatically and initially creates the COM port pair CNCA1 and CNCB1 by default. Please rename the ports to COMx und COMz, where X and Y are digits (COM26 and COM 27 in the example below, see Figure 6) and click Apply. The assignment of the virtual COM ports is done later when you create a SerialTunnel. In this example, COM26 will be assigned to the customer application and the SerialClient will be assigned to COM27. Please refer to the manual of the customer application for information on how to configure the serial interface to use. If the customer application requires a particular COM port (e.g. COM4), you can configure this port as one of the two ports in com0com. Figure 13: com0com Configuration

15 , Version 1.6, Page 15 of 33 Note: The two checkboxes enable buffer overrun should always be checked. To check whether the COM ports have been correctly created, open the Windows device manager with: Start >Control Panel >System >Device Manager. A new device group for the com0com serial port emulator should be visible (see figure below). Figure 14: Virtual COM ports in the Windows Device Manager

16 , Version 1.6, Page 16 of 33 7 SerialTunnel A SerialTunnel is a data channel between two network endpoints, the SerialClient and the GPRS terminal (SerialSwitch). You can only configure one SerialTunnel at a time. However, you can configure several tunnels on each client PC by choosing different TCP or COM ports to connect several SerialSwitch terminals to one client PC. 7.1 Create SerialTunnel When you create a SerialTunnel, both the SerialClient and the SerialSwitch which you want to connect must be online. You can check the online status in the SerialSwitchPortal. In the portal, you can recognise the SerialClient by the name which you assigned during installation and you can recognise the SerialSwitch with the unique IMEI which is printed on the label of the GPRS terminal. Navigate to the SerialSwitchPortal and click on Create SerialTunnel. Figure 15: Creating a new SerialTunnel This starts a wizard which guides you through creating the tunnel. First choose a SerialSwitch which is online. Then click Next. You then need to choose a SerialClient which is online and click Next.

17 , Version 1.6, Page 17 of 33 Figure 16: Choosing a SerialSwitch Figure 17: Choosing a SerialClient

18 , Version 1.6, Page 18 of 33 Now configure the two network endpoints to your needs. Figure 18: Configuration of the two endpoints The following parameters must be configured for the SerialSwitch: Baudrate Configure the SerialSwitch to the same baud rate as the field device to which it is connected. Framing Choose the settings for data bits, stop bits and parity. These settings must also match the settings of the field device.

19 , Version 1.6, Page 19 of 33 The following parameters must be configured for the SerialClient: TCP If you choose TCP, the SerialClient will open a listener on the port which you specify (please note that port numbers below 1024 are reserved internally). Serial If you choose serial, you must choose the same settings for baud rate and framing as on the SerialSwitch. In addition, you can choose any one of the available COM ports. If the customer application runs on the same computer as the SerialClient, you do not need a physical serial port and you can connect them together using a virtual COM port pair by installing the nullmodem emulator software com0com. For more information see chapter 6: Virtual COM ports. Figure 19: Confirmation that the SerialTunnel is correctly configured The SerialTunnel has now been configured correctly. The SerialCloud will transfer all data bi-directionally between the two endpoints SerialClient and GPRS terminal.

20 , Version 1.6, Page 20 of Delete SerialTunnel If you no longer need the SerialTunnel, for example because you want to connect the SerialSwitch to a different SerialClient, you only need to delete it. To do this, click the SerialTunnel tab to get the detail view of the tunnels. Select the SerialTunnel which you want to delete and click - (see figure below). Figure 20: Deleting a SerialTunnels Only delete the SerialTunnel if you are sure you do not need it any more. It is easy to create it again but as soon as you delete the tunnel the communication between the SerialClient and the SerialSwitch will be interrupted.

21 , Version 1.6, Page 21 of 33 8 Hardware This section describes important information on the hardware which you need to operate the SerialSwitch software. Additional technical information on the hardware is contained in the documents listed in the appendix. 8.1 SIM Card For operating a SerielClient a SIM card of a mobile network provider, activated for data transfer, is required, which must be acquired separately. If you acquire a SIM for operating with SerialSwitch Cloud, please note the following points: The GPRS terminal must be fitted with a mini SIM card (1.8 Volt or 3 Volt) which is compatible with the GSM guidelines. You can use any SIM card tariff that allows you to get access to the mobile internet via GPRS/EDGE networks. It is not necessary to use tariffs with a fixed public IP address! (These are usually substantially more expensive than usual Data- and M2M rates) All necessary settings for the operation with SIM cards are already integrated in the software of the product, so that for the user a very easy use is given. To carry this out, use best a mobile phone. After the Pin was deactivated by means of a mobile phone the SIM can be used in the terminal. 8.2 GPRS-Terminal MC88i 8.3 Identifying the GPRS terminals: IMEI Number Each GPRS terminals has a unique 15 digit serial number, the IMEI. IMEI is an abbreviation for International Mobile Station Equipment Identity. The IMEI is shown on the device label, see Figure 26. The IMEI is shown in the SerialSwitchPortal in the list of SerialSwitches and uniquely identifies your GPRS terminal.

22 , Version 1.6, Page 22 of 33 Figure 21: Device label with IMEI 8.4 Interfaces Power supply At a supply voltage of +12V the current rating of the power supply should be at least 1.25A. The typical current consumption of the GPRS terminal is mA with an active GPRS connection. However, poor reception conditions can lead to short-term current peaks if the terminal tries to compensate for this by increasing transmission power. Pin Designation In/Out Description Parameter 1 Plus In Positive supply voltage +8-30VDC 2 Reserved, do not use 3 Reserved, do not use 4 Reserved, do not use 5 Reserved, do not use 6 Minus In GND 0VDC Figure 22: RJ12 socket for the power supply

23 , Version 1.6, Page 23 of Antenna connector, FME The GPRS terminal is provided with a 50 Ω male FME connector for attaching the external antenna. You can only use a 50 Ω GSM antenna with a female FME connector. Figure 23: Antenna connector FME RS232 interface The RS232 interface is used to connect the terminal to the field device. The GPRS terminal (Modem) is the DCE (Data Carrier Equipment) and the field device to which it is attached is the DTE (Data Terminal Equipment). The names of the pins in the table below are those of the DTE, and thus Receive Data is an output. If possible, always use a short RS 232 cable (max. 1.8 m). The input voltage must not exceed. ± 25 V. Avoid short-circuits! Secure the connector to the socket using the locking screws on the connector. Figure 24: RS232 interface showing pin numbers Pin Designation In/Out Description 1 DCD Out Data Carrier Detect 2 RxD Out Receive Data 3 TxDt In Transmit Data 4 DTR I n Data Terminal Ready 5 GND Signal ground 6 DSR Out Data Set Ready 7 RTS In Request to Send 8 CTS Out Clear to Send 9 RI Out Ring Indicator

24 , Version 1.6, Page 24 of Inserting the SIM Card The SIM card must be inserted as follows in the holder of the drawer at the rear of the device: Make sure that the terminal has been disconnected from the power supply! Changing the SIM card with the power supply switched on can damage the SIM card and/or the terminal. Press the small button next to the SIM card tray as shown in the figure. This causes the tray to slide out slightly Slide out the tray and insert the SIM card. Make sure the SIM card is inserted the right way round!: One of the corners of the tray is chamfered, and thus the SIM card will only fit correctly one way round. Carefully slide the tray back into the terminal. Do not use excessive force and make sure that the tray does not get stuck or tilted! Figure 25: SIM card holder

25 , Version 1.6, Page 25 of UMTS-Terminal EHS6 8.6 Identifying the UMTS terminal: IMEI Number Each UMTS terminal has a unique 15 digit serial number, the IMEI. IMEI is an abbreviation for International Mobile Station Equipment Identity. The IMEI is shown on the device label, see Figure 26. The IMEI is shown in the SerialSwitchPortal in the list of SerialSwitches and uniquely identifies your SerialSwitch terminal. Figure 26: Device Label with IMEI Power supply At a supply voltage of +12V the current rating of the power supply should be at least 2.0A. The typical current consumption of terminal is mA with an active UMTS connection. However, poor reception conditions can lead to short-term current peaks if the terminal tries to compensate for this by increasing transmission power. Pin Sesignation In/Out Description Parameter 1 Plus In Positive supply voltage +8-30VDC 2 Plus In Positive supply voltage +8-30VDC 3 Signal for Modulreset In U > 8V for t > 10ms RESET 4 Ignition In U > 8V für t > 200ms switches on 5 Minus In GND 0VDC 6 Minus In GND 0VDC

26 , Version 1.6, Page 26 of 33 Figure 27: Supply Voltage RJ12 Socket Figure 28: Supply Voltage RJ12 Socket Antenna connector, SMA The UMTS terminal is provided with an SMA connector (50 Ω female) for attaching the external antenna. You can only use UMTS antenna with an SMA socket (50 Ω, male). Figure 29: Antenna Connector SMA (4) RS232 interface The RS232 interface is used to connect the terminal to the field device. The UMTS terminal (modem) is a DCE (Data Carrier Equipment) and the field device, to which it is attached, is the DTE (Data Terminal Equipment). The names of the pins in the table below are those of the DTE, and thus Receive Data is an output. If possible, always use a short RS 232 cable (max. 1.8 m). The input voltage must not exceed. ± 25 V. Avoid short-circuits!

27 , Version 1.6, Page 27 of 33 Secure the connector to the socket using the locking screws on the connector. Figure 30: Pin Belegung der RS232 Schnittstelle Pin Designatiuon In/Out Description 1 DCD Out Data Carrier Detect 2 RxD Out Receive Data 3 TxDt In Transmit Data 4 DTR In Data Terminal Ready 5 GND Signal ground 6 DSR Out Data Set Ready 7 RTS In Request to Send 8 CTS Out Clear to Send 9 RI Out Ring Indicator 8.7 Inserting the SIM Card The SIM card will be inserted laterally into the terminal (contacts upwards and the bevelled corner first) until it snaps into place: Make sure that the terminal has been disconnected from the power supply! Changing the SIM card with the power supply switched on can damage the SIM card and/or the terminal. Figure 31: SIM Card installation

28 , Version 1.6, Page 28 of LEDs For the the indication of the operation mode the terminal has two LEDs. The green LED shines, as soon as the device is supplied with voltage. The yellow LED indicates via different flashing patterns the status of the mobile connection: The LED blinks constantly with a frequence of 1Hz (duty cycle: 50%): the device builds up a connection to the mobile radio network. The LED flashes with a frequence of 1Hz: the connection to the mobile radio network was built up successfully. Figure 32: Position of the LEDs

29 , Version 1.6, Page 29 of 33 9 Faultfinding 9.1 SerialClient I installed the SerialClient but it is not visible in the list in the SerialSwitchPortal. if the installation completed without errors, this means that the installer identified you correctly with the username and password you specified and was able to configure the SerialClient. If you have being given user data for several uses, maybe you chose the wrong user name when you installed the SerialClient? You should normally receive an error message if the installation has actually failed. Please refer to the other error descriptions below. My SerialClient is shown in the portal as offline. How can I check if the SerialClient is currently running? The SerialClient is installed as a Windows service. This means that it runs in the background and without any windows. Microsoft Windows starts the SerialClient service automatically when you boot your PC. To check whether the SerialClient service is currently running under Windows 7, click the Start button (button with the Windows logo at the bottom left of the screen). Then type Services in the text field and click the Services button (see figure). Figure 33: Searching for installed services

30 , Version 1.6, Page 30 of 33 A new window opens showing all installed services. Look for SerialSwitch Client and check the status. A double click at the service entry opens a new window with further details. If necessary restart the service. Figure 34: View of installed services The SerialSwitch client can not connect to the SerialSwitchCloud The application uses TCP-port Please check, if the port is blocked by your network devices (e.g. firewall). 9.2 SerialSwitch This chapter does not have any text. This chapter will be extended later if necessary according to customer feedback. 9.3 SerialTunnel This chapter does not have any text. This chapter will be extended later if necessary according to customer feedback.

31 , Version 1.6, Page 31 of Notes 10.1 Mobile data volume The monthly amount of mobile data which is included in your tariff depends on the product package which you ordered. For more information on the options see the specifications flyer of the SerialSwitch product Modifications The right is reserved to make changes to the hardware and software for the purpose of improving the product without prior announcement. Pictures and illustrations may not exactly match the product you have received. The manufacturer accepts no liability for any errors which may be contained in this document 10.3 Safety notes This product may only be installed and put into operation by qualified personnel who have received sufficient and appropriate training for this product. This product must not be used in dangerous environments, e.g. in environments with explosive materials or inflammable vapours or in sensitive areas such as e.g. aeroplanes or hospitals. Users must be aware that there may be time delays in mobile data transfer through the GSM network and must take account of this in their technical applications.

32 , Version 1.6, Page 32 of Returning faulty devices In case of faulty hardware please adhere to the following procedure. Step 1 Inform the service contact of the problem and include the following information: Customer name & number Product name IMEI number (see section 8.6) Description of the error Reason for returning the hardware Step 2 You will receive a transaction number and the address to return the product Write the transaction number on a note which you include with the hardware Send the hardware to the specified address Please quote the transaction number on all future correspondence.

33 , Version 1.6, Page 33 of 33 Appendix Hardware description: - Document: EGS5 AT Command Set - Document: MC 88(i)T User Guide These documents are available in the SerialSwitch web portal in the download section.