wezarp server library user guide · wezarp server library pro is dedicated to a development...

Wezarp.com

Version 1.5

Contact: [email protected]

WEZARPTM Server Library for Various IDE

USER GUIDE

Server Library for various IDE

1

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

Foreword

WezarpTM Server Library for

Various IDE

USER GUIDE Take the control of your application

with your remote device

WezarpTM Server Library aims to visualize and control any

Windows application from a tablet, a smartphone or a remote

PC. WezarpTM proposes a simple solution, multi-client, multi-

window, multi-control without ergonomics 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 connected on the

same local network. WezarpTM client is available for iOS, Android

and Windows.

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

2

Table of contents

1 WezarpTM Server Library ......................................................................................... 4

1.1 Installer ............................................................................................................. 4

1.1.1 Instruction setup ......................................................................................... 4

1.1.2 Administrator right ...................................................................................... 4

1.1.3 License activation ...................................................................................... 5

1.1.4 Differences between Lite and Pro licenses ............................................ 6

1.1.5 End User License Agreement.................................................................... 8

1.2 Presentation .................................................................................................... 9

1.2.1 The Package ............................................................................................... 9

1.2.2 The Library ................................................................................................... 9

1.2.3 The Functions ............................................................................................ 10

1.2.4 The License file .......................................................................................... 17

1.3 Development integration ........................................................................... 18

1.3.1 NI LabWindows/CVI ................................................................................. 18

1.3.2 C++............................................................................................................. 23

1.3.3 C# .............................................................................................................. 27

1.3.4 Visual Basic .NET ....................................................................................... 31

1.3.5 Java ........................................................................................................... 35

1.4 Providing WEZARP third-party installer ....................................................... 39

1.5 Settings and use ........................................................................................... 40

1.5.1 Settings ...................................................................................................... 40

1.5.2 Use .............................................................................................................. 48

1.5.3 Version updating process ....................................................................... 48

3

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

2 WezarpTM client for iPad and iPhone ................................................................. 49

2.1 Get the App................................................................................................. 49

2.2 Device Settings ............................................................................................ 49

2.3 App Settings ................................................................................................. 50

2.4 App Features ............................................................................................... 50

2.4.1 Single touch events ................................................................................. 51

2.4.2 Double touch events .............................................................................. 51

3 WezarpTM Client for Windows .............................................................................. 52

3.1 Features ........................................................................................................ 52

3.2 Get the application .................................................................................... 53

3.3 Settings ......................................................................................................... 54

3.3.1 Move Windows ........................................................................................ 54

3.3.2 Configuration IP Addresses .................................................................... 55

4 WEZARPTM client for Android ............................................................................... 57

4.1 Get the App................................................................................................. 57

4.2 Device Settings ............................................................................................ 57

4.3 App Settings ................................................................................................. 58

4.4 App Features ............................................................................................... 58

4.4.1 Single touch events ................................................................................. 59

4.4.2 Double touch events .............................................................................. 59

4.4.3 Menu app settings event ....................................................................... 59

5 WezarpTM Server minimal requirement .............................................................. 60

5.1 Hardware requirement ............................................................................... 60

5.1.1 Computer ................................................................................................. 60

5.1.2 Wi-FI network ............................................................................................ 60

5.2 Software requirement ................................................................................. 60

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

4

1 WezarpTM Server Library

WezarpTM Server Library 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 various IDE and programming languages.

Just launch the application named “Wezarp_Server_Library.exe” and follow all

instructions.

Samples for demo examples 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 (your application). 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.

http://www.wezarp.com/

5

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

WezarpTM server

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, select first the license version via the checkbox “Lite version”.

Then, buy WezarpTM Server Library 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.

Lite version

Check the box “Lite version”.

To obtain a license, email your PC-ID code at [email protected]. Our team will

send you the activation code by email. Then, enter your activation code

received. Click on Validate to activate.

Pro version

Keep unchecked the box “Lite version”.

To obtain a license, email your PC-ID code at [email protected]. Our team will

send you the activation code by email. Then, enter your activation code

received. Click on Validate to activate.

mailto:[email protected]

mailto:[email protected]

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

6

WezarpTM server

1.1.4 Differences between Lite and Pro licenses

Pro version

Wezarp Server Library Pro is dedicated to a development computer and allows

building an unlimited number of applications embedding Wezarp.

The deployment of your application will use Wezarp on each target computer

without any activation required.

Note:

Wezarp.wlax should be distributed with your executable (see chapter 1.2.4).

FIGURE 2: WEZARP SERVER LIBRARY PRO LICENSING SYSTEM

7

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

WezarpTM server

Lite version

Wezarp Server Library Lite is dedicated to a computer using Wezarp

technology if Wezarp Server Library Pro has not been activated.

If you need to deploy your application that embeds Wezarp technology, you

will also have to activate the Wezarp Server Library Lite license on your target

computer.

Note:

Wezarp.wlax does not need to be distributed with your executable (see

chapter 1.2.4).

FIGURE 3: WEZARP SERVER LIBRARY LITE LICENSING SYSTEM

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

8

WezarpTM server

1.1.5 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.

Nevertheless, it gives you the opportunity to create any distributable executable

applications incorporating WezarpTM.

For more details, please read Wezarp End Use License Agreement on

www.wezarp.com/eula.

http://www.wezarp.com/eula

9

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

WezarpTM Server Library

1.2 Presentation

The main interest of WezarpTM is the simply way to integrate it to your application.

To illustrate the integration of Wezarp within your application, several demo

examples are provided in the dedicated directory:

[Users]\Public\Documents\Samples.

They are based on simple examples to show how to use Wezarp Server Library.

1.2.1 The Package

WezarpTM Server Library is a package composed of a set of libraries (32 and 64 bit)

and samples for various IDE and/or programming languages:

- Libraries

o a standard DLL unmanaged

o a .NET DLL managed (Assembly)

- Samples

o ANSI C

o C++

o C#

o NI LabWindows/CVI

o Java

o Visual Basic .NET

o Windev

1.2.2 The Library

In order to adapt to various IDE and programming languages, the two kinds of

library are available.

A standard DLL (unmanaged) and a .NET DLL (Assembly).

They can be found in the install directory:

[Program Files (X86)]\WEZARP\Server Library\lib\ (DLL or .NET)

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

10


DLL standard

Containing the Dynamic Link Library files as follows.

WEZARP_SRV_DLL.dll

WEZARP_ SRV_DLL .lib

WEZARP_ SRV_DLL.h

Entry point for server library (32bit)

WEZARP_SRV_DLL_x64.dll

WEZARP_ SRV_DLL_x64.lib

WEZARP_ SRV_DLL_x64.h


DLL .NET (Assembly)

Containing the .NET DLL Assembly required files.

WEZARP_ SRV_DNET.dll

WEZARP_ SRV_DNET.xml


Namespace = com.wezarp.lib

WEZARP_ SRV_DNET_x64.dll

WEZARP_ SRV_DNET_x64.xml


Namespace = com.wezarp.x64.lib

1.2.3 The Functions

Main functions

Both WEZARP_SRV_DLL.dll and WEZARP_SRV_DNET.dll allow to start and stop server

through the two following functions.

int __cdecl WEZARP_Start(char PC_ID[])

Start WEZARP server

* PC-ID: empty string to make the pop-up license activation appears to get your PC-ID

code (as described above in chapter 1.1.3).

PC-ID: enter your PC-ID and leave it.

int __cdecl WEZARP_Exit(void)

Stop WEZARP server

11

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


Advanced functions

Both WEZARP_SRV_DLL.dll and WEZARP_SRV_DNET.dll contain advanced functions

to get and set specific configuration and parameters programmatically if needed.

SET

int __cdecl Wezarp_adv_DESK_ViewHide(int ViewHide)

Show or Hide Systray item : "App/Desktop"

* ViewHide :

Show = 1

Hide = 0

int __cdecl Wezarp_adv_DESK_Monitor(int Monitor)

Set the remote monitoring selection between APPLICATION or DESKTOP.MONITORn.

* Monitor:

Application: 0 (Default value)

Monitor n: with n = (1, 2, 3 or 4) to select the monitor desktop to display.

int __cdecl Wezarp_adv_WEZ_Enable(int Enable)

Enable or Disable Wezarp Server.

* Enable:

Enable: 1 (Default value)

Disable: 0

int __cdecl Wezarp_adv_CLI_ConfigIP(char IP[], char CTRL[])

Add the IP addresses (single or group) to the current list with specified control.

* IP:

Single IP Address or Group Addresses.

Examples:

- IP Single: 192.168.0.10 (Automatic port is applied if no specified)

- IP Single: 192.168.0.10:1234 (port is 1234)

- IP Group: 192.168.0.10-27 (from 192.168.0.10 to 192.168.0.27 with automatic port)

- IP Group: 192.168.0.10-27 :1230 (from 192.168.0.10 to 192.168.0.27 with port applied for

each IP from 1230 to 1247)

* CTRL:

Set the access privilege for client(s) specified in IP.

Privileges are :

- ALL: Allowed (default access)

- MON: Monitoring only

- NOT: NOT allowed

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

12


int __cdecl Wezarp_adv_CLI_ConfigEnable(int Enable)

Enable or Disable the Clients configuration item in the systray menu of Wezarp Server.

* Enable:


Disable: 0

int __cdecl Wezarp_adv_CLI_CTRL_Privileges(char CTRL[])

Set the Control by default for incoming clients.

* CTRL:

Set the access privilege for incoming clients.

Privileges are :

- ALL: Allowed (default access)

- MON: Monitoring only

- NOT: NOT allowed

int __cdecl Wezarp_adv_FPIP_JustForIP(char FPName[], char IPs[])

int __cdecl Wezarp_adv_FPIP_NotForIP(char FPName[], char IPs[])

Not implemented

GET

int __cdecl Wezarp_adv_Get_DESK(int *Visible, int *Monitor)

Get the current Desktop/Monitor status: visible/hidden.

* Visible:

Is Systray item "App/Desktop" visible or hidden.

Visible = 1

Hidden = 0

* Monitor:

Is application or desktop currently controllable.

Application = 0

Monitor n = with n (1, 2, 3 or 4) currently displayed.

int __cdecl Wezarp_adv_Get_WEZ(int *OnOff)

Get Wezarp Server status: Enable (On) or disable (Off).

* OnOff:

On : Enable: 1

Off : Disable: 0

13

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


int __cdecl Wezarp_adv_Get_CLI_ConfigEnable(int *Enable)

Get current status item "Clients configuration" (Enable or Disable) in the systray menu of

Wezarp Server.

* Enable:


Disable: 0

int __cdecl Wezarp_adv_Get_CLI_ConfigIP_ALL(char CFG_IP[], int *sizeof_CFG_IP)

int __cdecl Wezarp_adv_Get_CLI_ConfigIP_MON(char CFG_IP[], int *sizeof_CFG_IP)

int __cdecl Wezarp_adv_Get_CLI_ConfigIP_NOT(char CFG_IP[], int *sizeof_CFG_IP)

Get the IP addresses (single or group) from the current list with specified access

privilege "ALLowed", “MONitor only” or “NOT allowed/access denied”.

* CFG_IP:

Single IP Address or Group Addresses.

Examples:

- IP Single: 192.168.0.10 (Automatic port is applied if no specified)

- IP Single: 192.168.0.10:1234 (port is 1234)

- IP Group: 192.168.0.10-27 (from 192.168.0.10 to 192.168.0.27 with automatic port)

- IP Group: 192.168.0.10-27 :1230 (from 192.168.0.10 to 192.168.0.27 with port applied for

each IP from 1230 to 1247)

Note: Field separator is ";"

* sizeof_CFG_IP:

Size of the string returned by CFG_IP.

int __cdecl Wezarp_adv_Get_CTRL(int *CTRLByDefault)

Get the Control by default for incoming clients.

* CTRL:

Privileges are:

- 0 = ALL: Allowed (default access)

- 1 = MON: Monitoring only

- 2 = NOT: NOT allowed

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

14


CONFIG

int __cdecl Wezarp_adv_WEZ_SaveConfiguration(void)

Save Parameters in Wezarp_adv.cfg

Will be applied at next startup.

Notes:

- Wezarp_adv.cfg must be in the directory :

.../[CurrentUser]/AppData/Local/WEZARP/[PROG_NAME]

int __cdecl Wezarp_adv_WEZ_ResetConfiguration(void)

Reset & save Parameters in Wezarp_adv.cfg

Will be applied immediately.

Notes:

- Wezarp_adv.cfg must be in the directory :

.../[CurrentUser]/AppData/Local/WEZARP/[PROG_NAME]

15

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


Super Advanced functions

Both WEZARP_SRV_DLL.dll and WEZARP_SRV_DNET.dll contain super advanced

functions to modify some low level configuration values.

Should be used with caution.

SET

int __cdecl Wezarp_adv_SUP_Set_cpu(int cpu)

Set the maximum global CPU overload accepted (%). If global CPU overload value is

reached, then parameters are automatically adjusted to reduce the CPU load.

* CPU: cpu overload (%)

Value between 50 to 100%.

Default value: 75%

int __cdecl Wezarp_adv_SUP_Set_fps(int fps)

Set the maximum frame rate (fps).

At each UI event or Front panel change detection, a message is sent at this maximum

frame rate. If no UI event or FP change detection, a message is sent at every second.

* fps: Maximum frame rate (fps)

Value between 2 to 20 fps.

Default value: 20 fps

int __cdecl Wezarp_adv_SUP_Set_udptime(int Tudp)

Set the time interval between UDP packets (ms).

* Tudp: Time interval UDP packets (ms)

Value between 0 to 20 ms.

Default value: 0 => automatic time interval

int __cdecl Wezarp_adv_SUP_Set_ImageQuality(int Quality)

Set the JPEG image quality (%).

* Quality : Image Quality (%)

Value between 0 (low quality) to 100 (best quality) %.

Default value : 70%

int __cdecl Wezarp_adv_SUP_Set_DefaultValues(void)

Set the default values of super advanced low level configuration values.

* No input

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

16


GET

int __cdecl Wezarp_adv_Get_SUP(int *fps, int *cpu, int *Tudp, int *Image)

Get the super advanced low level configuration values.

* fps: Maximum frame rate per seconds (fps)

* cpu: cpu overload (%)

* Tudp: Time interval UDP packets (ms)

* Image: Image quality (%)

Return status: Error

All functions described above has an Error return status.

No error: 0

Error: 1

17

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


1.2.4 The License file

As indicated previously, buying a license allows the user to create distributable

executable application with WezarpTM.

Once activated, the file called WEZARP.wlax is automatically generated in the root

directory of your application.

WEZARP.wlax

File containing your current PC activation code once

activated.

It is automatically fulfilled during activation procedure.

This file should be distributed with the executable (1).

Note 1:

If Wezarp Server Library Pro has been activated. The WEZARP.wlax file should be

distributed with the executable.

If Wezarp Server Library Lite has been activated. The WEZARP.wlax file does not

need to be distributed with the executable because the target computer will

need a Wezarp Server Library Lite license.

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

18

WezarpTM Server integration

1.3 Development integration

WEZARP Server integration is presented below through simple examples for

different IDE.

1.3.1 NI LabWindows/CVI

IDE used: NI LabWindows/CVI

DLL used: standard DLL

Project Path: [Users]\Public\Documents\WEZARP\Samples\CVI.

Name: ColorRamps_wezarp.cws

This sample is based on the already existing “ColorRamps” demo example.

FIGURE 4: CVI: SAMPLE PROJECT

19

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

WezarpTM server integration

Application integration

As done in this example, just add the three following lines in your main program file

(ColorRamps_wezarp.c).

- WEZARP_SRV_DLL.h : DLL prototype functions

Add this line with the include files header file.

- WEZARP_Start (PC-ID); : Launch the Wezarp server

PC-ID: Enter empty string to make the pop-up license activation appears to get

your PC-ID code (as described above in chapter 1.1.3).

PC-ID: Enter your current PC-ID code (1) and leave it. (1) : Do not enter the Activation Code.

- WEZARP_Exit(); : Close the Wezarp server

Deployment and distribution



1- Preparing the LabWindows Project

1. Just add the required files for standard DLL as described above in chapter

1.2.2.1 by Selecting in menu: Edit >> Add Files to Project >> All Files (*.*)…

FIGURE 5: CVI: PREPARING PROJECT

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

20


2. Go to directory:

[Users]\Public\Documents\National Instruments\CVI\Samples.

Select the following files:

WEZARP_SRV_DLL.lib Entry point Wezarp Server.

WEZARP.wlax

File containing your current PC activation code once activated.


This file should be distributed with the executable.

2- Building executable

Building executable containing Wezarp is done as usual.

There is no additional specific action to do.

21

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

WezarpTM server distribution

3- Building distribution kit

Building distribution kit containing Wezarp is done as usual.

Simply add the specific file WEZARP.wlax.

1. Add new distribution by selecting: Build>>Distributions>>Manage Distributions…

(see figure 4).

FIGURE 6: CVI: MANAGE DISTRIBUTION

2. Select New Distribution and click on OK (figure 5) to continue and edit installer.

FIGURE 7: CVI: NEW DISTRIBUTION

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

22

WezarpTM server distribution

3. Go to Files tabulation and add file WEZARP.wlax as shown figure 6 below.

FIGURE 8: CVI: EDIT INSTALLER

4. In the Manage Distributions dialog box, right-click on the installer and

select Build. You also can close the Manage Distributions dialog box and

select Build»Distributions»Build distribution name to build the installer.

5. When LabWindows/CVI finishes building the installer, click Close. You now can

install the application.

4- Deploying your application

Goto chapter 1.4.

23

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


1.3.2 C++

IDE used: Microsoft Visual Studio


Project Path: [Users]\Public\Documents\WEZARP\Samples\C++.

Name: RandomNumberGenerator.vcxproj

FIGURE 9 C++: SAMPLE PROJECT

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

24




(MyForm.cpp).

- WEZARP_SRV_DLL.h : DLL prototype functions

Add this line with the include files header file.

- WEZARP_Start (PC-ID); : Launch the Wezarp server




- WEZARP_Exit(); : Close the Wezarp server




1- Preparing the Project

1. Just add the required files for standard DLL as described above in chapter

1.2.2.1 by right-clicking in Solution Explorer window on RandomNumberGenerator

and select: Add >> Existing items…

FIGURE 10: C++: PREPARING PROJECT

25

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


2. Go to directory:

[Users]\Public\Documents\Samples\C++.

Select the following files:

WEZARP_SRV_DLL.lib

or

WEZARP_SRV_DLL_x64.lib

Entry point Wezarp Server (32bit or 64bit).

WEZARP.wlax

File containing your current PC activation code once activated.


This file should be distributed with the executable.

3. Disabling SAFESEH Property

Right-click in Solution Explorer on RandomNumberGenberator and select

Properties.

In menu: Configuration Properties>>Linker>>Advanced. Then, change Image

Has Safe Exception Handlers to “No (/SAFESEH:NO) as shown below.

FIGURE 11 C++: PROPERTY CHANGE

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

26







Just add the specific file WEZARP.wlax.


Goto chapter 1.4.

27

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


1.3.3 C#


DLL used: .NET DLL (Assembly)

namespace: com.wezarp.lib (32bit) or com.wezarp.x64.lib (64bit)

Project Path: [Users]\Public\Documents\WEZARP\Samples\C#.

Name: WindowsFormsApplicarion2.sln

FIGURE 12 C#: SAMPLE PROJECT

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

28




(Program.cs).

- using com.wezarp.lib : Namespace assembly WEZARP

- WEZARP.Start (PC-ID); : Launch the Wezarp server




- WEZARP.Exit(); : Close the Wezarp server





1. Just add the required .NET DLL file by right-clicking in Solution Explorer window on

References and select: Add Reference…

Then, browse to add WEZARP_SRV_DNET.dll and select OK.

FIGURE 13 C#: PREPARING PROJECT

29

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


2. Go to directory:

[Users]\Public\Documents\Samples\C#.

Select the following file:

WEZARP_SRV_DNET.dll

or

WEZARP_SRV_DNET_x64.dll



1. Change the active solution platform to x86 (for 32bit) by selecting:

Build>> Configuration Manager.

FIGURE 14 C#: BUILD CONFIGURATION MANAGER

2. Select <New…> in the listbox Active solution platform.

FIGURE 15 C#: SELECT NEW CPU PLATFORM

3. Select the new platform x86 (for 32bit).

FIGURE 16 C#: SELECT PLATFORM X86

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

30








Goto chapter 1.4.

31

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


1.3.4 Visual Basic .NET


DLL used: .NET DLL (Assembly)

namespace: com.wezarp.lib (32bit) or com.wezarp.x64.lib (64bit)

Project Path: [Users]\Public\Documents\WEZARP\Samples\VB .NET.

Name: WindowsApplicarion1.sln

FIGURE 17 VB .NET: SAMPLE PROJECT

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

32



As done in this example, just add the two following lines in your main program file

(Form1).

- WEZARP.Start (PC-ID); : Launch the Wezarp server




- WEZARP.Exit(); : Close the Wezarp server





1. Just add the required .NET DLL file by right-clicking in Solution Explorer window on

References and select: Add Reference…

Then, browse to add WEZARP_SRV_DNET.dll and select OK.

FIGURE 18 VB .NET: PREPARING PROJECT

33

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


2. Go to directory:

[Users]\Public\Documents\Samples\VB .NET.

Select the following file:

WEZARP_SRV_DNET.dll

or

WEZARP_SRV_DNET_x64.dll



1. Change the active solution platform to x86 (for 32bit) by selecting:

Build>> Configuration Manager.

FIGURE 19 VB .NET: BUILD CONFIGURATION MANAGER

2. Select <New…> in the listbox Active solution platform.

FIGURE 20 VB .NET: SELECT NEW CPU PLATFORM

3. Select the new platform x86 (for 32bit).

FIGURE 21 VB .NET: SELECT PLATFORM X86

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

34








Goto chapter 1.4.

35

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


1.3.5 Java

IDE used: Eclipse


Project Path: [Users]\Public\Documents\WEZARP\Samples\Java.

Name: userinterface

FIGURE 22 JAVA: SAMPLE PROJECT

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

36



As done in this example, just add the following lines in your main program.

A. Specify components from the plugin JNA to import.

import com.sun.jna.Library; import com.sun.jna.Native;

B. Define the library interface with this prototype functions

public interface WEZARP_SRV_DLL extends Library { public int WEZARP_Start(String PC_ID); public void WEZARP_Exit(); } static WEZARP_SRV_DLL lib = (WEZARP_SRV_DLL) Native.loadLibrary("WEZARP_SRV_DLL", WEZARP_SRV_DLL.class);

C. Launch the Wezarp server

lib.WEZARP_Start("");



lib.WEZARP_Start("9204-E540-8130-311E-1730-50C6-25E0-C730-FE06-C756-82A3-0725-0925");


D. Stop the Wezarp server

lib.WEZARP_Exit();

37

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE






1. Copy the WEZARP_SRV_DLL necessary files in the current project directory.

WEZARP_SRV_DLL.dll

WEZARP_SRV_DLL.lib

WEZARP_SRV_DLL_x64.dll

WEZARP_SRV_DLL_x64.lib

Entry point Wezarp Server

(32bit or 64bit).


1. Download the Java Native Access (JNA) plugin file to load external DLL.

You can find on GitHub here: https://github.com/twall/jna

2. Add the JNA to the project library path by selecting the menu:

Project>>Properties

Then, in Java Build Path, select Add external JAR and browse to put the file

“jna.jar” previously downloaded.

FIGURE 23 JAVA: ADD JNA PLUGIN LIBRARY



https://github.com/twall/jna

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

38






Goto chapter 1.4.

39

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


1.4 Providing WEZARP third-party installer

As Wezarp Server uses technology developed with NI LabVIEW. The library called

WEZARP_SRV_DLL.dll or WEZARP_SRV_DNET.dll for 32bit or

WEZARP_SRV_DLL_x64.dll or WEZARP_SRV_DNET_x64.dll for 64bit

are the only entry point required to use Wezarp Server.

Thus, your application needs the third party installer called:

Wezarp_Server_Library.exe

It is available on the Wezarp website – www.wezarp.com.

For deployment, you have to provide this third-party installer with your Windows

installer application.


We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

40

WezarpTM server settings and use

1.5 Settings and use Before starting, make sure that both devices (computer and client) are connected

on the same local network.

1.5.1 Settings

Wezarp menu in systray

At launching WezarpTM appears in Windows systray.

FIGURE 24: ACCESSING WEZARP MENU IN SYSTRAY

Right click on WezarpTM systray icon to make the menu appears.

Menu items are:

Items Sub item Description

Application

Select application to control

(visible via advanced palette)

Desktop … List all the monitors currently used and allows

to select which desktop monitor is controlled

(visible via advanced palette)

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

41

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


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 25: ACCESSING CLIENTS CONFIGURATION

The popup configuration lists the clients detected or manually specified.

FIGURE 26: CLIENTS CONFIGURATION POPUP

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

42


1.5.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.5.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.5.1.2.3 Add a group of clients

Click on button to set the IP Addresses, privilege access and port of the clients

group.


43

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


1.5.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.

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

44


1.5.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 27: 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 ».

45

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


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 your executable.

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

*************************************************************************

[CLI:LIST]

192.168.0.1-15:61551 = "ALL"

192.168.0.16 = “MON”

192.168.0.20-255 = “NOT”

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

46


Advanced configuration

By clicking on “Clients List”, select “Advanced” to go to the following page.

FIGURE 28: ADVANCED CONFIGURATION POPUP

It allows changing parameters for the current execution.

Default values will always be applied at the next startup.

47

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE


About

FIGURE 29: WEZARPTM SPLASHSCREEN

Access to WezarpTM Splashscreen to view:

- Current version of your WezarpTM server.

- Current (Server) IP address to set in client app.

- Current license version (Lite, Pro or Trial)

Note:

If you have several network interfaces, you can see complete list of your IP

addresses by clicking on the address.

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

48


1.5.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 Server Library allows access to all panels, contextual menus and windows

pop-up belonging or instanciated by your application.

1.5.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 28).

Click on to go to our website download page.

FIGURE 30: WEZARPTM NEW VERSION AVAILABLE


49

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

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 31: WAITING PICTURE ON IOS WEZARPTM APP

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

50

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 32: 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 33: REMOTE FRONT PANEL ON IPAD

51

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

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

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

52

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 34: MULTI FRONT PANEL DISPLAY

You can navigate between front panels from Windows taskbar.

FIGURE 35: FRONT PANEL NAVIGATION

53

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

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 36: 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 37: WEZARPTM CLIENT FOR WINDOWS LAUNCHING


We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

54

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 38: 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 39: FRONT PANEL MOVING

55

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

WEZARPTM Client for Windows

3.3.2 Configuration IP Addresses

FIGURE 40: 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.


We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

56

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.

57

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

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 41: WAITING SPLASH SCREEN FOR ANDROID WEZARPTM APP

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

58

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 42: 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 43: REMOTE FRONT PANEL ON ANDROID DEVICE

59

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

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

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

60

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

Various IDEany IDE being abble to load external

library (standard DLL or .NET DLL)

61

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

INDEX

Figure 1: License activation pop-up ...........................................................................5

Figure 2: Wezarp Server Library Pro licensing system ................................................6

Figure 3: Wezarp Server Library Lite licensing system................................................7

Figure 4: CVI: Sample project ................................................................................... 18

Figure 5: CVI: Preparing project ............................................................................... 19

Figure 6: CVI: Manage Distribution .......................................................................... 21

Figure 7: CVI: New Distribution .................................................................................. 21

Figure 8: CVI: Edit Installer.......................................................................................... 22

Figure 9 C++: Sample project ................................................................................... 23

Figure 10: C++: Preparing project ............................................................................ 24

Figure 11 C++: Property Change.............................................................................. 25

Figure 12 C#: Sample project ................................................................................... 27

Figure 13 C#: Preparing project ............................................................................... 28

Figure 14 C#: Build Configuration Manager ........................................................... 29

Figure 15 C#: Select new cpu platform .................................................................. 29

Figure 16 C#: Select platform x86 ............................................................................ 29

Figure 17 VB .NET: Sample project............................................................................ 31

Figure 18 VB .NET: Preparing project ........................................................................ 32

Figure 19 VB .NET: Build Configuration Manager ................................................... 33

Figure 20 VB .NET: Select new cpu platform ........................................................... 33

Figure 21 VB .NET: Select platform x86 ..................................................................... 33

Figure 22 Java: Sample project ................................................................................ 35

Figure 23 Java: Add JNA plugin library ................................................................... 37

Figure 24: accessing Wezarp menu in systray ........................................................ 40

Figure 25: accessing Clients configuration ............................................................. 41

Figure 26: Clients configuration popup ................................................................... 41

Figure 27: Clients list in systray menu ........................................................................ 44

Figure 28: Advanced configuration popup ........................................................... 46

Figure 29: WezarpTM Splashscreen ............................................................................ 47

Figure 30: WezarpTM New version available ............................................................ 48

We

zarp

TM Se

rve

r Li

bra

ry U

SER

GU

IDE

62

INDEX

Figure 31: Waiting Picture on iOS WezarpTM APP ..................................................... 49

Figure 32: iOS App Settings ........................................................................................ 50

Figure 33: Remote Front Panel on iPad .................................................................... 50

Figure 34: Multi Front Panel Display ........................................................................... 52

Figure 35: Front panel navigation ............................................................................. 52

Figure 36: WezarpTM Client for Windows icon .......................................................... 53

Figure 37: WezarpTM Client for Windows launching ................................................ 53

Figure 38: WezarpTM Client for Windows settings menu ......................................... 54

Figure 39: Front panel moving ................................................................................... 54

Figure 40: WezarpTM Client IP Configuration for Windows ...................................... 55

Figure 41: Waiting Splash screen for Android WezarpTM APP ................................ 57

Figure 42: Android Menu App Settings ..................................................................... 58

Figure 43: Remote Front Panel on Android device ................................................ 58