SOFTWARE DESIGN GUIDE AUG ENGLISH

Transcription

1 ecatcher Mobile SOFTWARE DESIGN GUIDE AUG ENGLISH

2 Important User Information Liability Every care has been taken in the preparation of this document. Please inform HMS Industrial Networks SA of any inaccuracies or omissions. The data and illustrations found in this document are not binding. We, HMS Industrial Networks SA, reserve the right to modify our products in line with our policy of continuous product development. The information in this document is subject to change without notice and should not be considered as a commitment by HMS Industrial Networks SA. HMS Industrial Networks SA assumes no responsibility for any errors that may appear in this document. There are many applications of this product. Those responsible for the use of this device must ensure that all the necessary steps have been taken to verify that the applications meet all performance and safety requirements including any applicable laws, regulations, codes, and standards. HMS Industrial Networks SA will under no circumstances assume liability or responsibility for any problems that may arise as a result from the use of undocumented features, timing, or functional side effects found outside the documented scope of this product. The effects caused by any direct or indirect use of such aspects of the product are undefined, and may include e.g. compatibility issues and stability issues. The examples and illustrations in this document are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular implementation, HMS Industrial Networks SA cannot assume responsibility for actual use based on these examples and illustrations. Intellectual Property Rights HMS Industrial Networks SA has intellectual property rights relating to technology embodied in the product described in this document. These intellectual property rights may include patents and pending patent applications in the USA and other countries.

3 Table of Contents Page 1 Preface About This Document Document history Related Documents Trademark Information Product Summary Introduction ecatcher, ecatcher Mobile & M2Web Requirements Installation & First Connection Install ecatcher Mobile Connect to an ewon Disconnect from an ewon User Interface Login Form PIN Code / Fingerprint Main View ewon Detailed View... 11

4 This page intentionally left blank

5 Preface 3 (14) 1 Preface 1.1 About This Document This document describes the ecatcher Mobile application used to establish secure connection through Talk2M in order to connect to devices that are linked/plugged to an ewon. For additional related documentation and file downloads, please visit Document history Version Date Description Prerelease version Official release 1.3 Related Documents Document Author Document ID 1.4 Trademark Information ewon is a registered trademark of HMS Industrial Networks SA. All other trademarks mentioned in this document are the property of their respective holders.

6 Product Summary 4 (14) 2 Product Summary 2.1 Introduction The ecatcher Mobile app is used to initialize secure remote access through VPN tunnels and allows the use of mobile apps to connect to HMIs from automation vendors such as: Schneider Magelis Rockwell Siemens SIMATIC Beijer Hakko... Take advantage of the user-friendliness and security of ecatcher Mobile by validating direct access to a Talk2M account through PIN code or fingerprint, similar to most mobile banking applications. The application can be used only on mobile devices such as smartphones or tablets under ios or Android. Currently, the ecatcher Mobile application is in its pre-release version. 2.2 ecatcher, ecatcher Mobile & M2Web There are currently 3 methods to remotely access an ewon that is connected to Talk2M ecatcher ecatcher is the Windows-only desktop version of Talk2M. It is used for configuration, management and remote access to the ewons. The ecatcher software allows: the remote access to an ewon through a (Talk2M) VPN tunnel the configuration of the Talk2M account itself the users and their groups the ewons and their pools the third-party devices connection parameters... For more information about ecatcher desktop version, refer to ecatcher Mobile ecatcher Mobile is a native application that runs on ios and Android. Like the desktop version, the ecatcher Mobile app can be used to access remotely an ewon and the devices connected to this ewon. However, it does not allow the configuration and management of the Talk2M account (i.e: adding a user, create a pool, edit ewon description,...).

7 Product Summary 5 (14) Once connected to an ewon on his mobile device, the user will be able to: open the web interface of the ewon in his browser connect to a device linked to an ewon using VNC or RDP protocols thanks to a third-party app M2Web M2Web allows the remote access to the web interface of an ewon or the LAN devices behind it. VNC and RDP connections are also supported. Unlike ecatcher Mobile, it doesn t use VPN protocol but secured HTTPS instead. It makes this solution device independent where only a web browser is required However, similar to ecatcher Mobile, M2Web doesn t offer the possibility to configure or manage the Talk2M account, its users, ewons, Requirements To take advantage of ecatcher Mobile, some requirements must be met: The application can be launched only on smartphones and tablets running ios (v9.0 and later) or Android (v4.4 Kitkat and later). The mobile device must have an Internet connection. The user must already have a Talk2M account (either Free+ or Pro) with device(s) already registered to this account.

8 Installation & First Connection 6 (14) 3 Installation & First Connection 3.1 Install ecatcher Mobile To get ecatcher Mobile on a mobile device, download and install the application labeled as ecatcher on the App Store (ios) or the Play Store (Android). Once the application installed, tap on it to see the Talk2M splash screen followed by the form to log in to a Talk2M account. 3.2 Connect to an ewon Once the application is opened, a login form will appear. Supply the Talk2M account name, the user login and the password. Choose to be remembered or not and tap the Login button. For more information about the login form, refer to Login Form, p. 7 If the two-factor authentication has been activated, an SMS will be send to the mobile phone linked to the user account. This SMS contains the code needed to go further in the app and connect to the Talk2M account. The next screen will ask to set up a 4-digits PIN code and to confirm the newly created code. This one is used to unlock the ecatcher Mobile app in case of inactivity for a certain amount of time. For more information about the PIN code, refer to PIN Code / Fingerprint, p. 8. To connect to an ewon, this one needs to be blue colored, indicating that it is online in opposition to gray which indicates an offline ewon. Tap its name then the Connect button of the newly displayed screen. If the ewon is configured to be triggered by a message to turn on its VPN connection, a Wake Up button is shown instead of the Connect. The status of the connection is color-based: orange: the connection is being established green: the connection has been established red: impossible to connect or disconnected Once the connection is established, the user is able to initialize a VNC or RDP connection to the devices linked to the connected ewon thanks to a third-party app or reach the web interface of the ewon via his Internet browser. 3.3 Disconnect from an ewon To disconnect from a connected ewon, tap the Disconnect button. The status color will change to red indicating the disconnection from the ewon.

9 User Interface 7 (14) 4 User Interface This chapter covers the different screens the user can see during his ecatcher Mobile experience. 4.1 Login Form Fig. 1 Login Form If the app hasn t been opened previously (first time open, after a reboot,...) or if a proper logout from a Talk2M account was performed, the login form will be the screen displayed when the ecatcher Mobile app is opened. To connect to a Talk2M account, several fields must be filled in: the account name the username the password Optionally, a Keep me logged in box can be checked. Once those fields correctly supplied and the Login button tapped, ecatcher Mobile will display the list of ewons of the Talk2M account. If the Keep me logged in box has been checked, it will first ask for a PIN code. If a user is connected to a Talk2M account and performs a log out, the app will switch back to the login form with the account and username fields already prefilled.

10 User Interface 8 (14) 4.2 PIN Code / Fingerprint Fig. 2 PIN Code Creation & Confirmation. Unlock ecatcher Mobile with Fingerprint or PIN Code The PIN code / fingerprint is a security feature which aims at preventing a non-authorized person to access a remebered Talk2M account. The code is created and confirmed right after a login form submission only if the Keep me logged in box has been checked. We recommend setting a strong PIN code different than the phone s one. If a user kills the app, has been idle too long or reboots his mobile device while he was connected to a Talk2M account, the PIN code or the fingerprint authentication will be asked. Once the PIN code correctly inserted or the fingerprint correctly recognized, ecatcher Mobile will be unlocked and the user will have access to the Talk2M account. 4.3 Main View The main view is the central screen of the app displaying the access button for the sidebar menu, the row regrouping all the pools of ewons and the whole list of ewons linked to the Talk2M account.

11 User Interface 9 (14) Sidebar Menu Fig. 3 Sidebar Menu The sidebar menu is accessible by tapping the top button of the main view. This menu offers 3 options: Log out By logging out, a proper disconnection from the Talk2M account is performed and a redirection to the login form occurs. TCP UDP TCP/UDP The choice is offered to select which protocol should be used to establish the connection to the remote ewon. By default, it is set to TCP/UDP. Notifications Choose whether notifications should appear on the mobile devices when events occur in the app.

12 User Interface 10 (14) Pools Fig. 4 Filtering by Pools This section concerns the Talk2M Pro accounts only. By default, when connected to a Talk2M account, the whole list of ewons is being displayed. However, it is possible to sort the list and display the ewons of a specific pool. Beneath the top menu icon, a row displays all the pools of the Talk2M account allowing by a tap the filtering of the displayed list of the ewons to show only those belonging to the selected pool List of ewons The ewons displayed are the ones the user has been authorized to see. This configuration is done by the administrator of the Talk2M account in the ecatcher desktop version. Each ewon is characterized by: its name its description the number of devices, illustrated by a plug icon, connected to the ewon and configured in ecatcher desktop version Optionally, if the ewon is based on a triggered type of connection, a clock icon is added near the plug icon. The ewons can be displayed in two different colors: Blue: the ewon is available for a secure remote connection Gray: two cases can be considered: The ewon isn t connected to the Internet and is appearing then offline in the app. The ewon is configured to use a triggered connection. A wake-up message needs to be sent to switch the device online. This can be done by tapping the ewon name then the Wake Up button.

13 User Interface 11 (14) If the user is already connected to an ewon on another platform (ecatcher desktop version or even another ecatcher Mobile), a red bar will appear at the bottom of the screen indicating so. 4.4 ewon Detailed View Fig. 5 Detailed View of an ewon The detailed view of an ewon shows different types of information: the ewon itself The name and description of the ewon appears on top of the screen. A button is also available which purpose is: to connect to the ewon if it is online. to wake the ewon up if it is offline and based on a triggered connection type This button isn t shown if the device isn t connected to the Talk2M service. Devices If devices are plugged in the ewon and have been configured via the ecatcher desktop version, they will appear underneath the name and description of the ewon as a list. Each device has its own block containing its name, its IP address and a description if provided. Custom Fields The custom fields which are personalized by the admin of the Talk2M account are displayed at the bottom of the screen.

14 User Interface 12 (14) Logs Logs can be accessed by tapping the Logs button in the bottom right corner of the screen. The screen will slide to show a list of all logs concerning the device. Each row has the same format: First line: Date & Time (with GMT accuracy) Second line: Description of the event Logs can also be exported (to the phone s memory, inside an ,...)

15 This page intentionally left blank

16 last page 2017 HMS Industrial Networks AB Box Halmstad, Sweden AUG /