wezarp for ni teststand user guide · wezarptm for ni teststand user guide ... ni labview or vb...
TRANSCRIPT
1
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
Foreword
WezarpTM for
NI TestStand
USER GUIDE Take the control of your NI
TestStand Development System
(Sequence Editor) with your remote
device
WezarpTM for NI TestStand aims to visualize your TestStand
Sequence Editor from a tablet, a smartphone or a remote PC.
WezarpTM proposes a simple solution, multi-client, multi-window,
multi-control without ergonomic or customization limitation of the
remote front panel.
WezarpTM is based on the communication via UDP/IP between a
client (computer or tablet) and a server (with NI TestStand
Sequence Editor running) connected on the same local network.
WezarpTM client is available for iOS, Android and Windows.
Wezarp for NI TestStand is useful when TestStand Development System
(i.e. Sequence Editor) is used directly on the ATE computer.
On the contrary, when an operator Interface is developed with an external IDE
(C++, C#, NI LabWindows/CVI, NI LabVIEW or VB .NET) and uses TestStand API to execute
TestStand engine, Wezarp Server Library should be preferred.
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
2
Table of contents
1 WezarpTM server ...................................................................................................... 4
1.1 Installer ............................................................................................................. 4
1.1.1 Instruction setup ......................................................................................... 4
1.1.2 Administrator right ...................................................................................... 4
1.1.3 License activation ...................................................................................... 4
1.1.4 End User License Agreement.................................................................... 5
1.2 Development integration ............................................................................. 6
1.2.1 About the example ................................................................................... 6
1.2.2 Sequence integration ............................................................................... 7
1.2.3 Deployment and distribution .................................................................... 8
1.3 Settings and use ............................................................................................. 9
1.3.1 Settings ........................................................................................................ 9
1.3.2 Use .............................................................................................................. 17
1.3.3 Version updating process ....................................................................... 17
2 WezarpTM client for iPad and iPhone ................................................................. 18
2.1 Get the App ................................................................................................. 18
2.2 Device Settings ............................................................................................. 18
2.3 App Settings.................................................................................................. 19
2.4 App Features ................................................................................................ 19
2.4.1 Single touch events ................................................................................. 20
2.4.2 Double touch events ............................................................................... 20
3 WezarpTM Client for Windows.............................................................................. 21
3.1 Features ......................................................................................................... 21
3.2 Get the application ..................................................................................... 22
3.3 Settings .......................................................................................................... 23
3.3.1 Move Windows ......................................................................................... 23
3.3.2 Configuration IP Addresses ..................................................................... 24
4 WEZARPTM client for Android ............................................................................... 26
4.1 Get the App ................................................................................................. 26
4.2 Device Settings ............................................................................................. 26
4.3 App Settings.................................................................................................. 27
4.4 App Features ................................................................................................ 27
4.4.1 Single touch events ................................................................................. 28
4.4.2 Double touch events ............................................................................... 28
4.4.3 Menu app settings event ........................................................................ 28
3
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
Table of contents
5 WezarpTM Server minimal requirement .............................................................. 29
5.1 Hardware requirement ............................................................................... 29
5.1.1 Computer ................................................................................................. 29
5.1.2 Wi-FI network ............................................................................................ 29
5.2 Software requirement ................................................................................. 29
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
4
1 WezarpTM server
WezarpTM server for NI TestStand is available on the Wezarp website –
www.wezarp.com.
1.1 Installer
1.1.1 Instruction setup
WezarpTM file recovered on our website is actually a full package installer to use
Wezarp with NI TestStand. Just launch the application named
“Wezarp_Server_for_NI_TestStand.exe” and follow all instructions.
A demo example (Sequence File sample.seq) has been installed on your PC during
the installation process to help you understand how to use WezarpTM.
See chapter 1.2 for further details.
1.1.2 Administrator right
As indicated above, WezarpTM is based on the communication via UDP/IP between
a client (computer or tablet) and a server (where NI TestStand Sequence Editor is
running). Client and server have to be on the same local network. Make sure the
port used is opened and is the same on both client and server. Contact you
Information System Administrator for any question.
1.1.3 License activation
When you use WezarpTM server in trial version, a license activation pop-up often
appears. It indicates the number of days remaining in trial period.
FIGURE 1: LICENSE ACTIVATION POP-UP
To obtain a license, buy WezarpTM for NI TestStand on wezarp.com and provide your
PC-ID code to [email protected]. As soon as the payment is confirmed, the
activation code will be sent to you by email. If you want to evaluate the product,
click on Continue.
5
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM server
1.1.4 End User License Agreement
In exchange for Licensee’s payment of all applicable fees and compliance with all
of the terms and conditions, Licensor grants Licensee a nonassignable,
nontransferable and nonexclusive license to use the Software and any related user
documentation. Licensee may install the Software only on a desktop or personal
computer owned or leased by it or its employees.
For more details, please read Wezarp End Use License Agreement on
www.wezarp.com/eula.
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
6
WezarpTM server integration
1.2 Development integration
The main interest of WezarpTM is the simply way to integrate it to your main
sequence executed with NI TestStand Sequence Editor.
1.2.1 About the example
To illustrate the integration of Wezarp within your main sequence, a demo example
is provided in the dedicated directory:
[Users]\Public\Documents\National Instruments\TestStand\Samples\WEZARP.
Open the sequence Sequence File sample.seq in the directory:
[Users]\Public\Documents\National Instruments\TestStand\Samples\WEZARP.
FIGURE 2: SEQUENCE FILE SAMPLE
7
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM server integration
1.2.2 Sequence integration
As done in this example, just add in your main sequence in the Setup section the
step Call Executable (renamed as WEZARP Open) with the following Step Settings.
- Properties : Do not change anything.
- Call Settings
FIGURE 3: STEP SETTINGS - CALL SETTINGS
Select Wezarp Server for TestStand executable in the Program files directory:
C:\Program Files (x86)\WEZARP\Server TESTSTAND\WEZARP_Server_TestStand.exe
- Wait Options
FIGURE 4: STEP SETTINGS - WAIT OPTIONS
Select No Wait in the Wait Condition list.
- Standard Input : Do not change anything.
- Standard Output/Error : Do not change anything.
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
8
WezarpTM server distribution
1.2.3 Deployment and distribution As indicated previously, Wezarp for NI TestStand is useful when TestStand
Development System (i.e. Sequence Editor) is used directly on the computer.
Thus, the Wezarp Server for NI TestStand must be installed on every computer which
uses NI TestStand Sequence Editor.
On the contrary, when an operator Interface is developed with an external IDE
(C++, C#, NI LabWindows/CVI, NI LabVIEW or VB .NET) and uses TestStand API to
execute TestStand engine, Wezarp Server Library should be preferred.
9
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM server settings and use
1.3 Settings and use Before starting, make sure that both devices (computer and client) are connected
on the same local network.
1.3.1 Settings
Wezarp menu in systray
At launching WezarpTM appears in Windows systray.
FIGURE 5: ACCESSING WEZARP MENU IN SYSTRAY
Right click on WezarpTM systray icon to make the menu appears.
Menu items are:
Items Sub item Description
Clients Configuration… Access to the clients
configuration popup
Help Open Wezarp User Guide
About Wezarp version and current
IP address
Exit Exit Wezarp without quitting
the application
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
10
WezarpTM server settings and use
Client configuration
By default, port is automatically set to 61550 + last client IP number and every clients
are authorized to control the application.
For clients allowed to control and for which port is left on automatic, there is no need
to configure.
In case the clients for which port is set manually, or to specify clients authorized to
control the application or those that have access to the monitoring only, you need
to go to the “Clients configuration popup”.
Right click on WezarpTM systray icon to make the menu appears and select
Clients>>Configuration…
FIGURE 6: ACCESSING CLIENTS CONFIGURATION
The popup configuration lists the clients detected or manually specified.
FIGURE 7: CLIENTS CONFIGURATION POPUP
11
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM server settings and use
1.3.1.2.1 Default Access
Default access can be defined for incoming client.
Clients not listed in the client list will get this default access when connecting.
1.3.1.2.2 Add a new client
Click on button to set the IP Address, privilege access and port of the new client.
Then, click on validate to apply and make it appears in the list.
1.3.1.2.3 Add a group of clients
Click on button to set the IP Addresses, privilege access and port of the clients
group.
Then, click on validate to apply and make it appears in the list.
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
12
WezarpTM server settings and use
1.3.1.2.4 How to modify client configuration
A client configuration is defined by:
Control (Detection) Description
Not detected
Detected
Control (Authorization) Description
Client can control and monitor
Client can monitor only
Client is not allowed to monitor
Delete single IP address client
Delete group IP addresses clients
IP Address Description
xxxx.xxxx.xxxx.xxxx Client IP address.
It must be on the same local network
Port Description
Auto port is activated.
Port value is automatically defined as
61550 + last client IP number
Port is manually defined by value
Click on validate to apply the new configuration.
13
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM server settings and use
1.3.1.2.5 Clients list
The clients list is visible in the “Client configuration popup” or directly by the systray
menu in sub item Clients.
FIGURE 8: CLIENTS LIST IN SYSTRAY MENU
Clients checked are authorized to control the application.
Clients unchecked can monitor the application.
Clients disabled are not connected.
Clients connected but not visible in this list are defined in “Clients configuration
popup” as « Do not view ».
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
14
WezarpTM server settings and use
Configuration File (optional)
A file configuration Wezarp_adv.cfg can be created to set parameters (as
described above) at startup.
Wezarp_adv.cfg must be in the root directory path of the Wezarp server for
TestStand.
C:\Program Files (x86)\WEZARP\Server TESTSTAND\WEZARP_Server_TestStand.exe
Example of content:
[WEZARP]
WEZ.Enable = TRUE
SYS.Config.Enable = FALSE
CLI.CTRL_DEFAULT = "ALL"
* INFOS *****************************************************************
ALL : Control allowed
MON : Control not allowed, view & monitor only
NOT : Do not view
*************************************************************************
[FP:LIST_HIDDEN]
Title001 = toto
Title002 = TITLE
Title003 =
...
[CLI:LIST]
192.168.0.1-15:61551 = "ALL"
192.168.0.16 = “MON”
192.168.0.20-255 = “NOT”
15
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM server settings and use
Advanced configuration
By clicking on “Clients List”, select “Advanced” to go to the following page.
FIGURE 9: ADVANCED CONFIGURATION POPUP
It allows changing parameters for the current execution.
Default values will always be applied at the next startup.
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
16
WezarpTM server settings and use
About
FIGURE 10: WEZARPTM SPLASHSCREEN
Access to WezarpTM Splashscreen to view:
- Current version of your WezarpTM server.
- Current (Server) IP address to set in client app.
Note:
If you have several boards, you can see complete list of your IP addresses by clicking
on the address.
17
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM server settings and use
1.3.2 Use As soon as both client and server IP addresses are settled, a few seconds is needed
to start the connection. The server front panel has to be the active window to be
detected by WezarpTM server …
WezarpTM for NI TestStand allows access to all front panel contextual menus and
windows pop-up launched and initiated by the Main Sequence containing the call
executable WEZARP Open (as described above).
1.3.3 Version updating process If a new version of WezarpTM server is available on www.wezarp.com website
(internet connection is required), a message will appear (figure below).
Click on to go to our website download page.
FIGURE 11: WEZARPTM NEW VERSION AVAILABLE
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
18
2 WezarpTM client for iPad and iPhone
2.1 Get the App
Download and install WezarpTM app from the App Store.
2.2 Device Settings
The iPad or iPhone have to be connected on the same local network than the
server.
FIGURE 12: WAITING PICTURE ON IOS WEZARPTM APP
19
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM client for iPad and iPhone
2.3 App Settings
In order to set the server IP address, go to the app settings. The port must be the
same than the server one.
FIGURE 13: IOS APP SETTINGS
2.4 App Features
We can distinguish two kinds of user events. Events which have to be transmitted to
the server and events related to display management. The difference between both
events is managed by the number of touches. The accuracy required for mouse
gesture imposed that the events transmitted to the server are single touch events.
FIGURE 14: REMOTE FRONT PANEL ON IPAD
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
20
WezarpTM client for iPad and iPhone
2.4.1 Single touch events
2.4.2 Double touch events
Multiple device orientations and zoom are also supported.
Single touch Left click
Touch hold down
Right click
Two-finger slide to the right or left
If front panel displayed is smaller than the screen : Switch front panel
Two-finger slide upDisplay keyboard (only the first 128 ASCII
characters are supported)ht click)
Two-finger slide up when keyboard is out
Move the front panel on the iPad
Two-finger double touch
Enable / disable the full screen function for front panels smaller than the iPad screen
21
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
3 WezarpTM Client for Windows
3.1 Features WezarpTM client for Windows allows the control of your application running on a
Windows server. All front panels will be displayed and automatically centered on the
screen.
FIGURE 15: MULTI FRONT PANEL DISPLAY
You can navigate between front panels from Windows taskbar.
FIGURE 16: FRONT PANEL NAVIGATION
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
22
WezarpTM Client for Windows
3.2 Get the application
Download and install WezarpTM Client for Windows from www.wezarp.com. When
installation is completed, the following shortcut appears on your desktop.
FIGURE 17: WEZARPTM CLIENT FOR WINDOWS ICON
When you launch the application, a pop-up window and an icon in Windows
taskbar appear. The pop-up window indicates client and server IP address. Right
click on the icon to access the application settings.
FIGURE 18: WEZARPTM CLIENT FOR WINDOWS LAUNCHING
23
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WezarpTM Client for Windows
3.3 Settings
Available via the systray menu by right clicking on Wezarp icon, settings are:
Move Windows Allows to move window as described before.
Configuration IP Addresses… Open a popup window for advanced IP configuration.
Help Open the user guide.
About Displays IP addresses (server and client) currently used
and software version.
Exit Closes Wezarp client application.
FIGURE 19: WEZARPTM CLIENT FOR WINDOWS SETTINGS MENU
3.3.1 Move Windows
You can move the position of windows by selecting “Move Windows". All front
panels are disabled and grayed out with a cross shaped blue icon in the center.
You can move front panels by clicking left and holding down while moving.
By releasing, it becomes enable.
Move every front panels or uncheck “Move Windows” to come back in standard
mode.
FIGURE 20: FRONT PANEL MOVING
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
24
WEZARPTM Client for Windows
3.3.2 Configuration IP Addresses
FIGURE 21: WEZARPTM CLIENT IP CONFIGURATION FOR WINDOWS
My IP address
The Windows device which runs WezarpTM client has to be connected on the same
local network than the server(s).
The current Client (my IP address) used is displayed at the top.
By default, the port is automatically set to 61550 + last client IP number.
If you have several Network Interface Card, you can swap your IP address to use
by clicking on “my IP address (Client)”.
If you specify a different port value manually. You have to define the same port on
server side.
Servers list
3.3.2.2.1 Add a new server
Click on button to specify the IP Address and port of the new server.
Then, click on validate to apply and make it appears in the list.
25
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WEZARPTM Client for Windows
3.3.2.2.2 Delete list
Click on button to erase full servers list. Then, click on validate to apply and erase the list.
3.3.2.2.3 Modify server configuration
A server configuration is defined by:
Control (Detection) Description Field type
Not detected
Indicator
Detected
Control (Authorization)
Server is defined
Selectable
Delete server from the list
Name
Server N Server name.
Editable
IP Address
xxxx.xxxx.xxxx.xxxx Server IP address.
It must be on the same local
network
Port
Auto port is activated.
Port value is automatically
defined as 61550 + last client IP
number
Port is manually defined by
value
Selection
Server currently used
Selectable Server disabled
Click on validate to apply the new configuration.
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
26
4 WEZARPTM client for Android
4.1 Get the App
Download and install WezarpTM app from Google Play.
4.2 Device Settings
The Android Tablet or Smartphone has to be connected on the same local
network than the server(s).
FIGURE 22: WAITING SPLASH SCREEN FOR ANDROID WEZARPTM APP
27
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
WEZARPTM client for Android
4.3 App Settings
In order to set the server(s) IP address(es), make appear the app settings by sliding
with one finger from the left border side to the center.
The port must be the same than the server one.
FIGURE 23: ANDROID MENU APP SETTINGS
4.4 App Features
We can distinguish two kinds of user events. Events which have to be transmitted to
the server and events related to display management. Difference between both
events is managed by the number of touches. The accuracy required for mouse
gesture imposed that events transmitted to the server are single touch events.
FIGURE 24: REMOTE FRONT PANEL ON ANDROID DEVICE
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
28
WEZARPTM client for Android
4.4.1 Single touch events
4.4.2 Double touch events
Multiple device orientations and zoom are also supported.
4.4.3 Menu app settings event
Single touch Left click
Touch hold down
Right click
Two-finger slide to the right or left
If front panel displayed is smaller than the screen : Switch front panel
Two-finger slide upDisplay keyboard (only the first 128 ASCII
characters are supported)ht click)
Two-finger slide up when keyboard is out
Move the front panel on the iPad
Two-finger double touch
Enable / disable the full screen function for front panels smaller than the iPad screen
One-finger slide
from left border side
to the center
Bring up the menu app settings
to define IP servers addresses
29
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
5 WezarpTM Server minimal requirement
5.1 Hardware requirement
WezarpTM is based on the communication via UDP/IP between a client (computer or
tablet) and a server. The data flow can greatly vary depending on the number of
remote front panels and clients. The following requirements are given for a basic
WezarpTM use: one client, multiple remote panels.
5.1.1 Computer
5.1.2 Wi-FI network
5.2 Software requirement
Processor Intel Core i5 or equivalent
RAM 1GB
Operating System Windows XP, Vista, Seven, 8.x
Network interface card
Fast Ethernet 100 Mbit/s
Wi-Fi IEEE Standard 802.11n
NI TestStand
Sequence Editorany version
We
zarp
TM fo
r N
I Te
stSta
nd
USER
GU
IDE
30
INDEX
Figure 1: License activation pop-up ........................................................................... 4
Figure 2: Sequence File sample ................................................................................... 6
Figure 3: Step Settings - Call Settings .......................................................................... 7
Figure 4: Step Settings - Wait Options ......................................................................... 7
Figure 5: accessing Wezarp menu in systray ............................................................. 9
Figure 6: accessing Clients configuration ................................................................ 10
Figure 7: Clients configuration popup ...................................................................... 10
Figure 8: Clients list in systray menu ........................................................................... 13
Figure 9: Advanced configuration popup .............................................................. 15
Figure 10: WezarpTM Splashscreen............................................................................. 16
Figure 11: WezarpTM New version available ............................................................. 17
Figure 12: Waiting Picture on iOS WezarpTM APP ..................................................... 18
Figure 13: iOS App Settings ........................................................................................ 19
Figure 14: Remote Front Panel on iPad .................................................................... 19
Figure 15: Multi Front Panel Display ........................................................................... 21
Figure 16: Front panel navigation ............................................................................. 21
Figure 17: WezarpTM Client for Windows icon .......................................................... 22
Figure 18: WezarpTM Client for Windows launching ................................................ 22
Figure 19: WezarpTM Client for Windows settings menu ......................................... 23
Figure 20: Front panel moving ................................................................................... 23
Figure 21: WezarpTM Client IP Configuration for Windows ...................................... 24
Figure 22: Waiting Splash screen for Android WezarpTM APP ................................ 26
Figure 23: Android Menu App Settings ..................................................................... 27
Figure 24: Remote Front Panel on Android device ................................................ 27