sx-client · 2021. 1. 28. · 4.1. installing the sx-client program and drivers the sx-client...

SX-Client SimpLinx SX-Client User Manual

07/2020 man-en-sx-client.docx Version 1. 1

man-en-sx-client.docx

© 2020 SIMPLINX - 1 -

Legal Notices

Warning Notice System

This document contains alerts and information indications for the safety of you and your devices.

The symbols and meanings used to draw your attention to these notifications are listed below.

Qualified Personnel

It is assumed that what is described in this document will be applied by qualified personnel for

the specific task.

Disclaimer

We have reviewed the contents of this publication to ensure consistency with the hardware and

software described. Since variance cannot be precluded entirely, we cannot guarantee full

consistency.

The information in this publication is reviewed regularly and any necessary corrections are

included in subsequent editions.

Danger: Indicates that death or severe personal injury will result if proper

precautions are not taken.

Warning: Indicates that death or severe personal injury may result if proper

precautions are not taken.

Info: Indicates advice or information.


© 2020 SIMPLINX - 2 -

Change Log

Version Date Description

V1.0 07/2020 Draft

V1.1 01/2021 New Features


© 2020 SIMPLINX - 3 -

Preface

Purpose of the Document

This document contains information about the following topics;

Simplinx Remote Connection Solutions

SMX-RNS02

SMX-RKY01 / SMX-RKS01

Required Level of Knowledge

In order to fully understand and apply this document, it is necessary to have knowledge of IT,

Automation and Electrical.

Contents

Legal Notices ........................................................................................................................................ - 1 - Warning Notice System ................................................................................................................ - 1 - Qualified Personnel ...................................................................................................................... - 1 - Disclaimer ..................................................................................................................................... - 1 -

Change Log ........................................................................................................................................... - 2 - Preface .................................................................................................................................................. - 3 -

Purpose of the Document ............................................................................................................ - 3 - Required Level of Knowledge ....................................................................................................... - 3 -

1. Required Hardware and Software ............................................................................................... - 5 - 2. Preparing Hardware .................................................................................................................... - 6 -

2.1. Electrical Connection of SMX-RNS02 Module ................................................................ - 6 - 2.2. Connecting Devices to be Communicated ...................................................................... - 6 -

3. Preparing the User Certificate ..................................................................................................... - 7 - 3.1. Preparation of SMX-RKY01 ............................................................................................. - 7 - 3.2. Preparation of SMX-RKS01 ............................................................................................. - 8 -

4. Logging In to the System ............................................................................................................. - 9 - 4.1. Installing the SX-Client Program and Drivers .................................................................. - 9 - 4.2. Logging Into the System with User Certificate ............................................................. - 10 -

5. Welcome Screen ........................................................................................................................ - 11 - 5.1. General Announcements .............................................................................................. - 11 - 5.2. Messages ...................................................................................................................... - 11 -

6. SX-Node ..................................................................................................................................... - 12 - 6.1. SX – Node – List ............................................................................................................ - 12 - 6.2. SX-Node – Map ............................................................................................................. - 13 -

7. Registering your SMX-RNS02 Device to the System .................................................................. - 14 - 8. Device Detail Pages .................................................................................................................... - 16 -

8.1. Homepage (Remote Connection) ................................................................................. - 16 - 8.2. View Information .......................................................................................................... - 18 - 8.3. Update Status ............................................................................................................... - 18 - 8.4. Edit Information ............................................................................................................ - 19 - 8.5. Delete Device ................................................................................................................ - 20 - 8.6. Log ................................................................................................................................ - 20 - 8.7. Sub Device List .............................................................................................................. - 21 - 8.8. Send Command............................................................................................................. - 21 -

9. User Management ..................................................................................................................... - 22 - 9.1. Sub-Key (Slave) Permissions ......................................................................................... - 22 - 9.2. Add New Sub Key (Slave) .............................................................................................. - 23 -

10. SX-Client ................................................................................................................................ - 24 - 11. Profile .................................................................................................................................... - 25 -

11.1. User Settings ................................................................................................................. - 25 - 11.2. Mobile Access Settings ................................................................................................. - 25 -

12. Change the SW Key Password ............................................................................................... - 26 - 13. Changing Interface Language ................................................................................................ - 27 - 14. Exit ......................................................................................................................................... - 28 -


© 2020 SIMPLINX - 5 -

1. Required Hardware and Software

The software and hardware to be used in this guide are listed below.

Hardware

1 x SMX-RNS02 Module

1 x SMX-RKY01 or 1 x SMX-RKS01

DC Power Supply (At least 24V 1A or 12V 2A)

User PC

Software

Windows 7 or Windows 10 (32 or 64 Bit) Operating System

Web Browser (Preferably Google Chrome)

Administrator authorization to install required programs

The SX-Client program installs network and USB drives, so during installation administrator permissions will be required.

Administrator permissions will be required because the SX-Client program changes network

settings while running.


© 2020 SIMPLINX - 6 -

2. Preparing Hardware

2.1. Electrical Connection of SMX-RNS02 Module

The SMX-RNS02 module has one terminal group. The terminal group is called X1. The X1 terminal

group has 3 terminals. They are in order as follows;

X1

+ - Gnd

Connect your power supply’s output to the appropriate terminals (+), (-) and GND.

Faulty or incomplete connection may damage you, those around you, or devices.

See the relevant documents and electrical drawings for detailed information.

2.2. Connecting Devices to be Communicated

Complete the connection of your devices to be communicated.

You can connect your devices directly to the relevant ports, which will be communicated by Ethernet

and USB.

See the relevant documentation for other connection options.

Faulty or incomplete connection may damage you, those around you, or devices.

See the relevant documents and electrical drawings for detailed information.

There are 2 USB connections on the SMX-RNS02. The USB connection requires the (-) and

GND terminals to be short circuit as a design concept. For this reason, GND and (-) terminals

on SMX-RNS02 are shorted.


© 2020 SIMPLINX - 7 -

3. Preparing the User Certificate

There are 2 methods to store the user certificate.

SMX-RKS01: Soft Certificate. The user can store the certificate on his/her personal computer or

USB disk. The certificate is protected by password.

SMX-RKY01: HW Certificate. The user certificate is also stored in the USB that is encrypted at the

hardware level. The certificate is only valid as long as it is stored on this USB disk. Each certificate

is encrypted with the USB serial number. The USB disk is protected by an external password. USB

disk content cannot be displayed unless the password is entered.

If you intend to use SMX-RKS01 as certificate, you can jump to the next section.

3.1. Preparation of SMX-RKY01

Connect the SMX-RKY01 to an empty USB slot on your PC.

The "Kingston Password" screen will be automatically opened. If the password screen does not

open, start the application located at "My computer"->"DTL+G3"->"DTLplus_Launcher.exe". The

password screen will be opened.

If you’re entering the password for the first time, enter the pre-defined password.

After typing the password, press ENTER.

The relevant USB Disk files can be viewed. You can close the Explorer tabs that are opened.

Your user certificate is ready for use.

Pre-defined Password: "@S123456"

The SMX-RKY01 certificate is protected with an external password on the hardware level.

Entering incorrect passwords 10 times or using the "Reset Password" option makes your

certificate invalid.

For security reasons, it is recommended to change the predefined password in the first use.

See the relevant documentation for detailed information.


© 2020 SIMPLINX - 8 -

3.2. Preparation of SMX-RKS01

If you intend to use SMX-RKY01 as certificate, you can skip this section.

Connect the SMX-RKS01 USB drive to an empty USB slot on your PC.

USB Disk content will appear under the "My Computer". USB Drive is named as "SXC-*******".

Copy the "SXC-*******.sxc" file to your hard disk.

Your user certificate is ready for use.

Pre-defined Password: "@S123456"

The SMX-RKS01 certificate is protected by password.

Secure storage of your certificate file and password is critical for you and your customers.

For security reasons, it is recommended to change the predefined password in the first use.

See the relevant documentation for detailed information.


© 2020 SIMPLINX - 9 -

4. Logging In to the System

SimpLinx remote connection user interfaces are completely web-based. The SX-Client program is used

to perform functions such as interaction with Windows operating system and driver control.

The SX-Client program installs network and USB drives, so administrator privileges will be

required during installation.

Administrator privileges will be required because the SX-Client program changes network

settings while running.

The web browser does not need to be run with administrative privileges.

4.1. Installing the SX-Client Program and Drivers

The SX-Client program will need to be installed and running during operation.

Go to https://www.simplinx.net from your web-browser.

Enter the "SX-Client" section.

https://www.simplinx.net/


© 2020 SIMPLINX - 10 -

Download and install the program by following the link on the "HW Key Login" tab.

Run the program using the SX-Client icon on the desktop after setup is finished.

When SX-Client runs, Windows will create an information message on system tray (taskbar).

If you are logging in for the first time in the browser you have used or if the browser cache data

has been cleared, you must give access permission to SX-Client.

If you are using Windows 7 and ClientNode is pre-installed

Open ClientNode program.

Remove the USB drive from the Drivers->USB Drive page

Restart your PC

Install SX-Client

4.2. Logging Into the System with User Certificate

To log in;

Go to https://www.simplinx.net from your web-browser

Enter "SX-Client" section

Password screen;

If you are using SMX-RKY01;

From your web-browser, press "HW Key Read" button. In previous steps, the HW

Key certificate was made ready for use. If it's not ready to use, you can follow the

instructions in the relevant section.

The HW Key certificate will be read and you will be logged in automatically.

If you are using SMX-RKS01;

Go to the "SW Key Login" tab.

Select your certificate and enter your password

In previous steps, the SW Key certificate was made ready for use. If it's not ready, you

can follow the instructions in the relevant section.

Press the "Log in" button

SW Key certificates will be read and you will be logged into the system.

https://www.simplinx.net/


© 2020 SIMPLINX - 11 -

5. Welcome Screen

When the first login to the system is made through the browser, the "Welcome" screen will be

opened. The screen is displayed in two parts. The page structure is in the form of menu on the left

side and page content on the right side.

On the Welcome page, page content is also divided into two pieces in itself. These are;

5.1. General Announcements

Important announcements, they can be seen by everyone and cannot be deleted.

5.2. Messages

Key-specific announcements that appear to related user and can be deleted when prompted.


© 2020 SIMPLINX - 12 -

6. SX-Node

6.1. SX – Node – List

This is the page where you can list and manage your devices.

The page consists of couple of buttons and data displayed in the form of table. These are;

Buttons

Used to add a new device to the list. Redirects to the device add-up page.

Used to access the management and details of the selected device.

Used to download the current content of the table in CSV format.

Used to update data in the table.

Data

Specifies the number of devices in the list.

Status Column The status of the devices in the list (Online, Offline, etc.) is displayed in

this column.

Serial Column Serial numbers of the devices in the list are found in this column.

Last Conn Date Column Timestamp for the most recent online status of the devices in the list is

found in this column.

Last Conn IP The latest IP information of the online devices in the list is available in this

column.

Note-1 Column Additional note (1) for the devices in the list is found in this column.

Note-2 Column Additional note (2) for the devices in the list is found in this column.

Location Column Approximately specified locations according to the IP information that the

devices in the list are most recently online are displayed in this column.

If your HW Key or SW Key is a slave-type key, only the devices you are authorized are listed.


© 2020 SIMPLINX - 13 -

Device information is updated automatically at 3 sec. intervals.

6.2. SX-Node – Map

This is the page on which your devices are listed on the map by their location. Location information is

approximately determined according to the IP information that your devices are most recently online,

and your active devices are marked on the map in green color and your passive devices are in gray.

You can also come up on the device marks in the map with the help of mouse pointer and see the

information of the device in the current location.

In the case of multiple devices in the same location, it is marked as a single device on the map, and

active devices are listed as green and passive devices as gray when they are hovered with the help of

mouse pointer.

If your HW Key or SW Key is a slave-type key, only the devices you are authorized are listed.

Device information is updated at 1min. and the location information is updated at 60 min.

intervals.


© 2020 SIMPLINX - 14 -

7. Registering your SMX-RNS02 Device to the System

In order to use the SMX-RNS02 device, the device must first be registered on behalf of the user.

Each device box has a "Register Info" card. This card has a serial number and registration password

for the device. For example,

Register Info

Model SMX-RNS02

Serial No. SRX-XXXXX-XXXXX

Password XXXXX-XXXXX-XXXXX

From the Left Menu, go to the "SX-Node"--->"SX-Node - List" page.

Your existing devices are listed in the table on the page. If you're logging into the system for the

first time, the list will be empty.

Press the + icon from toolbar of the table. You will be redirected to the "Add New Device" page.

Enter all information on the Register Info card to complete error-free registration.

Press the Save button.


© 2020 SIMPLINX - 15 -

If all information is correct, you will be redirected to the device list and your new device will be

displayed in the list.

If your HW Key or SW Key is a slave-type key, the recently added devices will be registered

to the master key account.

If your HW Key or SW Key is a slave-type key and if you’re not authorized to connect to all

devices by the master, the recently added devices will not appear in your list.

All information on the register info card is private to you.

It is recommended not to share it with anyone else for your safety.

Once the device is registered, it is recommended to type your customer name or reference

in the relevant section on the "Register Info" card and store the card.


© 2020 SIMPLINX - 16 -

8. Device Detail Pages

From the list, double-click your device or select your device and press button to go to the

device detail page.

You can access the following screens through the device detail page;

8.1. Homepage (Remote Connection)

This page contains the "Connect" button, where you can start a connection with your device and the

"Reset" button so that you can end the active connection.

If you're ready to connect to the device, press the "Connect" button. The device will change the

"Status" sign to "Connecting" and the auto-link button will be formed in the "gray" color at the top

right of the interface.

This button specifies the serial number and connection status of the device on which you are

connected or where the automatic connection is active. When clicked, it goes to the detail page of the

corresponding device. The connection status is specified in two different colors. These are;

: Specifies that the automatic connection is active but your device is turned

off or not yet connected to your device. As long as this button is active, your device will automatically

be able to connect when it is online.

: Specifies that the automatic connection is active and that a remote

connection is performed with your device.

After about 12 seconds the automatic connection button will change to "green", status text will

change to "You can connect to your field devices".

You're ready to connect to your on-site devices!


© 2020 SIMPLINX - 17 -

After the connection is provided, connection statistics will be displayed under the buttons.

These statistics mean;

Incoming Data Size: Total amount of data from your field devices and your SMX-RNS02 to your

PC (KB)

Outbound Data Size: The total amount of data sent from your PC to your SMX-RNS02 and your

field devices (KB)

Data Lap Time (RTT): The time required for a data packet from your PC to reach SMX-RNS02 and

return back to PC (ms).

After about 30 sec. the entire IP addresses on the Ethernet network will be displayed as a

list on the screen. If your Ethernet device has HTTP or HTTPS feature, the "Connect" button

will appear next to the IP. If you press the button, the web interface of the relevant IP

address will be opened.

After about 30 sec. your devices which are connected to USB ports will be displayed. Simply

press the "Connect" button next to the USB device you want to connect.

The SMX-RNS02 does not need any USB drives to connect to the remote USB devices. All

USB devices are emulated / simulated and connected to your PC. Therefore, the driver for

the USB device that you will connect should be installed on your PC.

There is no limitation for the number of connections to your Ethernet field devices. With

the help of Ethernet Switch, you can be connected to all devices at the same time as

permitted by your network settings.

To do that, you don't need to identify your devices anywhere.

You can be connected to only 1 USB field device at the same time.


© 2020 SIMPLINX - 18 -

In order to see or connect to your devices, you don't need to define them in a "Sub device

List".

This list helps you making such as HTTP or VNC connections from a phone or tablet.

8.2. View Information

On this page, you can find the status of your device, the HW and SW versions, the latest connection

information, and the approximate location of your device.

8.3. Update Status

On this page, you can see the active and last update status, last update date and update messages of

your device. Device update is not a choice left to the user in terms of security. All devices are updated

automatically whenever a new update is released. The update procedure consists of 3 stages. These

are;

Download Update File: The device downloads the necessary files from the server. (Approx.

150MB)

Reboot: The device automatically restarts itself atfer downloading files. All active connections to

device will be closed at this stage.

Test & Confirm Update: After the device restarts, your device must be connected to the internet

and remain connected for at least 5 minutes. Thus, the device will understand that the update

was successful and make the update permanent.


© 2020 SIMPLINX - 19 -

What happens if the device does not connect to the Internet after the update?

The device decides that the update was not successful and reverts to the old version. For this reason,

after the update, your device must be connected to the internet and remain connected for at least 5

minutes. If your device is connected internet via your phone, make sure to turn “Internet Sharing”

back on from your phone after the device restart.

Update was not successful. What will happen now?

If the update failed for any reason, your device will restart the update process and try again. The

device will try to install the update up to 5 times. If it has failed 5 times in a row, please contact for

technical support.

Can I use my device while updating?

Yes. During the update, you can use your device as you normally would.

8.4. Edit Information

On this page, you can take notes about your device or edit your existing notes.


© 2020 SIMPLINX - 20 -

8.5. Delete Device

If the key you are using is the master key, you can delete the device from your device list by giving the

correct answer to the security question from this page.

8.6. Log

On this page, you can view information about the last performed 10 remote connections to your

device.

This information is as follows:

Date: Shows the date & time when the remote connection with the corresponding device begins.

Key: Shows the ID of the key that allows to connect the corresponding device.

Duration: Shows the length of time in seconds when the remote connection with the corresponding

device remains active.

The duration information is not determined until the remote connection is ended and it is

shown as 0.


© 2020 SIMPLINX - 21 -

8.7. Sub Device List

On this page, you can create a list of your field devices connected to your SimpLinx device, make links

from your mobile devices to your field devices such as s HTTP, HTTPS, VNC or RDP, and access the

Remote Node web interface where your remote IO and device settings are made without performing

remote connection to your device.

Active connections will be terminated automatically after 30 minutes.

It is possible to add up to 10 devices to the list.

8.8. Send Command

From this tab, if you forget your password Remote Node web interface password, you can reset your

interface password with the "Reset Password" command, and can restart SMX-RNS02 remotely with

the "Restart" command when necessary.

Remote connection must be established with SMX-RNS02 in order to send commands.

After the Reset Password command is sent, you must restart SMX-RNS02 for the password

to be activated.


© 2020 SIMPLINX - 22 -

9. User Management

On this page, you can check the status of your keys (master-slave), add new slave keys and take

user-specific notes.

If your key is a master, the slave keys that are belong to you are listed in the 'Slave Key List' section.

You can take user-specific notes to identify these listed slave keys, and you can delete them from your

list if you want, by correctly answering the security question.

9.1. Sub-Key (Slave) Permissions

Under each key in the list, there is an "Edit Permissions" button. With this button, you can manage

permissions for that selected key. It is possible to manage the key as having permission to connect

only the selected devices in the list.


© 2020 SIMPLINX - 23 -

For all sub-keys (slaves) that the option “Connect to All Devices” is not active, even if they

add new device(s) to the device list, that device(s) will not appear in their list of devices.

9.2. Add New Sub Key (Slave)

You can add a sub-key (slave) in two different ways. These are;

Adding Sub-Key (Slave) with HW Key

You can see other USB keys connected to your PC under the USB Keys connected to PC section. Next

to the listed keys on the list, there is a button named as “Add as Slave Key!”. With this button, you

can add it to your list.

Adding A Sub-Key (Slave) with SW Key

From the Upload Slave Certificate section, you can add your certificate to your list with the "Install"

button after selecting your certificate file with Browse button and entering the correct password for

it.


© 2020 SIMPLINX - 24 -

10. SX-Client

This page contains information section about SX-Client and a download link section if the SX-Client

program is not yet installed or running.

After the program is run and the connection permissions are given, information about the SX-Client

status is listed.

The information content and their definitions are listed as follows:

Last Error: Provides information about the latest error that occurred during the connection.

Network Driver: Provides information about whether the network driver which is required to make a

remote connection is installed or not.

USB Driver: Provides information about whether the USB driver which is required to communicate

with USB Devices is installed or not.

Connected Device: Provides information about the serial number of the device connected with a

remote connection.

SX-Client Status: Provides information about the status of SX-Client.

SX-Client Version: Provides information about the version of the installed SX-Client application.


© 2020 SIMPLINX - 25 -

11. Profile

From the menu on left, in order, go to the "Profile"-->"Settings" page. The incoming page contains

two different settings. These are;

11.1. User Settings

User information must be entered completely and correctly in order to make a remote connection to

your devices. This information will also be used for password reset if you forget your password for

your SW key.

11.2. Mobile Access Settings

Mobile access option allows you to make connections such as HTTP, VNC etc. to your devices in the

sub-device list although it is not possible to connect remotely from your tablet or phone.

If you're activating the mobile access option for the first time, you can set a new password or change

your current password if it's already activated.

Your mobile access username is the ID of the key that you’re using.

Your mobile access password must be in the form of at least 8 characters, containing at

least 1 lowercase letter, 1 uppercase letter and 1 digit


© 2020 SIMPLINX - 26 -

12. Change the SW Key Password

From the menu on left, in order, go to the "Change profile"-->"Password" page. You can change your

SW Key password by specifying your new password on the incoming page.

When if it’s not possible to access the SX-Client web interface, you can and create a

password reset request by filling in the relevant fields from the “Have you forgotten your

password?” link under the “Home” page. You will be contacted as soon as possible.


© 2020 SIMPLINX - 27 -

13. Changing Interface Language

From the menu on left, you can change the interface language by selecting any of the languages

under the "Language" tab.


© 2020 SIMPLINX - 28 -

14. Exit

From the menu on left, you can exit the interface with the "Exit" button.

If the SX-Client application is running and your connection is active, your remote connection

will be terminated by turning off the SX-Client application when you log out, but the

automatic connection will remain active unless you clear your browser data, and a remote

connection will be provided automatically if your SMX-RNS02 device is ready when you log

on again.


© 2020 SIMPLINX - 29 -

07/2020 man-en-sx-client.docx Version 1. 1

SimpLinx Elektronik Ltd.

Halil Rifat Pasa Mh. Nazli Sk. No:1/5 No:17 Sisli/Istanbul www.simplinx.com

sx-client · 2021. 1. 28. · 4.1. installing the sx-client program and drivers the sx-client...

Documents