Finisar WaveShaper A Series User Manual Download Page 35 | Manualshive

Page: 35 / 47

background image

Section 5 Programming

5.1

RESTful Interface

Web Services

The WaveShaper provides a RESTful style Web service API that enables conﬁguring the device and access to measurement data

using HTTP commands from a Web browser or from a software programming language.

Communication with the Series A WaveShapers can be done directly through the browser. Most major languages support sending

and receiving http requests via 3rd party tools, although some provide native support.

LANGUAGE

HTTP SUPPORT

LabVIEW

natively via HTTP Client VIs

Python

requests library

MATLAB

webread / webwrite (R2014b onwards)

urlread2, 3rd party (http://au.mathworks.com/matlabcentral/ﬁleexchange/35693-urlread2)

urlread (not recommended)

Octave

wget/curl system calls

urlread (not recommended)

C/C++

libcurl library

Java

Apache HttpClient

Javascript/Node.js

Natively via http.get

C#/VB.NET

System.Net

JSON

The response data is in JSON format. This stands for JavaScript Object Notation which is a lightweight and human readable data

format.

JSON is supported by most languages either natively or via 3rd party libraries. An extensive list can be found at

http://www.json.org/

Some languages have many to choose from, and personal preference is usually the deciding factor.

WaveShaper A Series User Manual

35

«
...
33
34
35
36
37
...
»

Summary of Contents for WaveShaper A Series

Page 1: ...WaveShaper A Series User Manual WaveShaper A Series User Manual 1 ...

Page 2: ...veShaper App and the WaveShaper Webserver It is not valid for other hardware or software versions For information about the WaveShaper Series A range please visit the Finisar Optical Instrumentation website For detailed technical help please visit the Finisar KnowledgeBase website www ﬁnisarknowledgebase com Finisar 2013 2020 WaveShaper A Series User Manual 2 ...

Page 3: ...ch 13 3 12 Pulse Shaping 20 3 17 Tools 24 3 24 Power Splitting 28 Section 4 Deﬁning Optical Filters 30 4 1 Optical Filter Files 30 4 2 User Conﬁgured Filters ucf 30 4 3 WaveShaper Presets wsp 31 Section 5 Programming 35 5 1 RESTful Interface 35 5 2 HTTP API Basics 36 5 3 Programming Examples 37 5 4 Python Examples 38 5 5 MATLAB Examples 39 5 6 LabVIEW Examples 41 5 7 Power Splitting Programming 42...

Page 4: ...our eyesight Do not operate the WaveShaper without attaching the optical output connector s to a safely terminated mating connector s Refer servicing only to qualiﬁed and authorized Finisar personnel Electrical Safety The mains powered versions of the WaveShaper require single phase AC 100 240V 50 60Hz and has a maximum power consumption of 50VA In accordance with international safety standards th...

Page 5: ...he Active Matrix silicon backplane and the ITO coated Indium Titanium Oxide top glass 1 3 Optical Design LCoS can be employed to control the phase of light at each pixel to produce beam steering In the WaveShaper a large number of phase steps are used to create a highly efﬁcient low insertion loss switch shown schematically in this diagram This simple optical design incorporates polarisation diver...

Page 6: ...tation on the Finisar website 2 2 Ethernet Connection There are two programs used to connect to the WaveShaper through the Ethernet port The WaveShaper App is installed on Windows operating systems and the WaveShaper Webserver is installed on each Series A WaveShaper for control through HTTP Note that the App and Webserver are identical and vary only in the location that they are stored The functi...

Page 7: ...de shipped with the WaveShaper Help KnowledgeBase Connects to an online address that is dedicated to answering more technical questions about the WaveShaper and WaveAnalyzer family of products from the Optical Instrumentation Group of Finisar Help About Shows the currently installed version number of the WaverShaper App 2 3 Webserver Browser Interface The WaveShaper Series A instruments contain an...

Page 8: ...etwork conﬁgurations If the WaveShaper still does not appear it could be due to changes made to the WaveShaper IP settings The WaveShaper IP setting can be reset to the default mode with the reset switch The default mode is DHCP then Fixed IP While the WaveShaper is running press and hold the reset switch at the back of the instrument for at least 5 seconds Let go of the reset switch and afterward...

Page 9: ...oﬁle can be applied which is deﬁned either by simple internal proﬁles stored within the WaveShaper Flat top Band pass Gaussian Band pass or Band stop or from a user speciﬁed ﬁlter stored on the users computer For a WaveShaper 100A only the internally deﬁned Flat top and Gaussian Band pass ﬁlter shapes are available WaveShaper A Series User Manual 9 ...

Page 10: ...uency control is not available if a WSP ﬁle is selected Bandwidth This allows the user to change the bandwidth of the ﬁlter selected in 1 GHz increments The display shows the nominal 3 dB bandwidth selected The change in the bandwidth is symmetric to within 2 GHz around the center of the ﬁlter Note The bandwidth control is accurate for values down to approximately 20 GHz below this value the bandw...

Page 11: ...ools tab Phase Control The drop down list box lets the user select how to deﬁne one of phase group delay or dispersion control values for the WaveShaper Phase control is not available for the WaveShaper 100A or WaveShaper 500A or if a wsp ﬁle is selected Phase Allowable range 2π to 2π rad Delay Allowable range 25 to 25 ps Dispersion Allowable range 100 to 100 ps nm for a 50 GHz bandpass ﬁlter 3 4 ...

Page 12: ...0 GHz up to the operating range of the unit The change in the window is symmetric around the center of the ﬁlter Adjustment of the Window is through direct editing in the entry box Note The Window control is accurate for values down to approximately 20 GHz Below this value the bandwidth approaches the instrument transfer function of approximately 10 GHz Repeat Function The repeat function allows t...

Page 13: ...e Sketch provides graphical tools to create drag and drop single data points and area selected sets of data points It has selected area zoom in and full view reset capability for the graphical view The created ﬁlters can be saved as Preset Point Data ﬁles for future use and exported as WaveShaper Preset wsp ﬁles for later downloading direct to supported WaveShapers 3 7 Mode Mode Selection Select w...

Page 14: ... is 25 to 25 picoseconds Attenuation and Chromatic Dispersion Allows the adjustment of the Chromatic Dispersion in the bottom window The phase sketch points are orange The allowable range is 100 to 100 ps nm for a 50 GHz bandpass ﬁlter 3 8 Shape Grid Selection Select an existing sketch grid ﬁle from the drop down list or upload a new ﬁle by dragging and dropping it to the indicated area on the con...

Page 15: ...the nearest sketch points on either side Nearest Neighbour Produces a square shaped proﬁle when the points are adjusted The points can be adjusted for both attenuation vertical direction or frequency horizontal direction Linear Produces a triangular shaped proﬁle when the points are adjusted The points can be adjusted for both attenuation vertical direction or frequency horizontal direction WaveSh...

Page 16: ...rtical y direction attenuation adjustment This allows for the manipulation of the set channels Port The Port Selector Control is only available for the 4000A and 16000A range of Series A WaveShapers Port Control is not available if a WSP ﬁle is selected This allows the user to select the port to which the output is directed Port Selection 4000A The default value after start up is Port 1 The user c...

Page 17: ...conﬁguration 96 ports default A 5 10x10 conﬁguration 100 ports default A 7 To select any of the other available conﬁgurations use the WaveShaper Conﬁguration option in the Tools tab 3 10 Graph Control DRAW Allows you to directly manipulate points on the sketch trace See the section on Modifying Points for more details PAN Allows you to grab the trace and move it to a different part of the graph Th...

Page 18: ...gging that point you can change the shape of the sketched proﬁle Click anywhere else in the graph area to deselect the point Adding Points Double click on the sketch graph area to add a point to the sketch proﬁle This extra data point can be manipulated by selecting and dragging the point around in the graph window WaveShaper A Series User Manual 18 ...

Page 19: ...licking elsewhere in the graph will deselect those points Deleting Points Select a single point or a group of points Hitting the delete button will delete the selected point or points Undo and Redo The Undo and Redo buttons allow you to go back and forward through a number of changes made to the sketch proﬁle It will also restore deleted points from the sketch proﬁle WaveShaper A Series User Manua...

Page 20: ...Filter Shape Available Filters Deﬁnes a basic ﬁltering scheme Typically this pre ﬁltering is used to achieve a transform limited pulse shape The user can select the ﬁlter shape from a drop down list comprising pre programmed Bandpass and Gaussian ﬁlters as well as the option of having No Filtering User Filters In addition to his this User Conﬁgured Filter UCF and WaveShaper Preset WSP ﬁles can be ...

Page 21: ...B bandwidth selected Bandwidth Control is not available if a WSP or UCF ﬁle is loaded Attenuation The Attenuation Control provides a programmable insertion loss for the current ﬁlter Attenuation control is not available if a WSP ﬁle is selected Dispersion Dispersion can be controlled in two modes Linear ps nm and Quadratic ps nm2 3 15 Output Pulse Shaping Pulse Selection Allows the user to select ...

Page 22: ...10ps Flat Top Pulse Shaping The control option for Flat Top Shaping is the pulse length adjustment This example has a bandwidth of 10nm and a pulse length of 10ps Triangle Pulse Shaping The control option for Triangle Pulse Shaping is the pulse length adjustment This example has a bandwidth of 10nm and a pulse length of 10ps WaveShaper A Series User Manual 22 ...

Page 23: ...power to be distributed to each pulse The power percentage is set by the user The power percentage and phase are then automatically calculated by the software Double Pulse Shaping This example has a bandwidth of 10nm and a pulse length of 10ps and a power1 percentage of 50 3 16 Graph Control PAN Allows you to grab the trace and move it to a different part of the graph The axes numbers will update ...

Page 24: ...select and deselect port traces as well as deﬁne which graphs are visible in the WaveShaper App window 3 17 Tools The tools interface is used to make conﬁguration changes to the WaveShaper It also provides feedback about the device connected as well as provides an interface to obtain system log information 3 18 Wavelength Frequency Selection Wavelength Unit Use this tool to select units of either ...

Page 25: ...ges click on the Hide button If running the WaveShaper App then you can reboot the WaveShaper using the Reboot button in the System options Otherwise you can power cycle the WaveShaper to apply the changes DHCP then Fixed IP DHCP then Fixed IP is the default setting If the program cannot ﬁnd an IP address using the DHCP network assignment then it will attempt to connect to the default ﬁxed IP addr...

Page 26: ...IP mode To do this press and hold the reset switch at the back of the WaveShaper for 5 seconds whilst the WaveShaper is powered on The WaveShaper will then be discoverable in the WaveShaper Connect mode or with the WS200427 local IP address in a browser 3 20 Logging Download Log The logging function is used to download a log ﬁle of the WaveShaper activity This is helpful for troubleshooting purpos...

Page 27: ...ere the WaveShaperSystem wspkg ﬁle has been saved Click on the Open button Once the WaveShaper has been updated a message will appear prompting you to Reboot the WaveShaper Note that the power needs to be kept on during the update process otherwise the system can become corrupt and the WaveShaper will not connect Reboot Click on the Reboot button or power cycle the device and wait until the reboot...

Page 28: ...raction effects which introduces additional attenuation to the WaveShaper depending on the number of active ports Number of Active Ports Power Splitting Efﬁciency Additional Attenuation dB 1 100 0 2 75 1 25 3 70 1 55 4 5 60 2 22 6 55 2 60 7 50 3 01 8 45 3 47 9 11 40 3 98 12 16 35 4 56 Note Table showing the extra loss associated with the power splitting algorithm This loss is in addition to the in...

Page 29: ...f the power splitting algorithm Undo Redo capability is not supported for power splitting 3 26 Coupling Ratios Settings Used to deﬁne power splitting ratios to all or only some of the available ports on the WaveShaper Click on the Apply button to upload the required image to the WaveShaper The minimum per port power level that can be set is 1 The sum of the total per port percentages does not have...

Page 30: ...e input ﬁle will be set to the respective edge points of the input ﬁle deﬁnition as that will be the nearest neighbour to these frequencies For optimal consistency and portability of ucf ﬁles between different WaveShapers it is recommended to specify the proﬁles down to a resolution of 1 GHz File Structure The format of a ucf ﬁle is a tab delimited text ﬁle with three columns Frequency Offset THz ...

Page 31: ...When using Microsoft Excel to generate a ucf ﬁle the following points should be noted The ﬁle should be saved as Text Tab delimited txt ﬁle and subsequently renamed to have the sufﬁx ucf Before saving as a txt ﬁle the format of all columns should be set to Number with at least three 3 decimal places If the number format is set to less than three decimal places Excel may misinterpret the data durin...

Page 32: ...accuracy according to the WaveShaper speciﬁcation 30 1 40 dB WaveShaper attempts to set attenuation to requested value No guarantee of accuracy greater than 40 dB Signal set to Block Note Excluding the WaveShaper 100A Tuneable Optical Filter which does not provide attenuation control Phase The phase control range available in the WaveShaper is 0 2π Not available in the 100A and 500A models phase m...

Page 33: ...t conﬁguration for the 16000A Note that the WaveShaper App version 1 01 only supports the 1x19 conﬁguration For the other conﬁgurations please upgrade to WaveShaper App 1 2 or use WaveManager 2 7 4 1x19 conﬁguration 19 ports total INPUT OUTPUT PORT A B 1 A C 2 A D 3 A 1 4 A 2 5 A 15 18 A 16 19 The port numbers for 1x19 conﬁguration WaveShaper A Series User Manual 33 ...

Page 34: ...other conﬁgurations please upgrade to WaveShaper App 1 2 or use WaveManager 2 7 4 10x10 conﬁguration 100 ports total INPUT OUTPUT PORT A 7 1 A 16 10 B 7 11 B 16 20 C 7 21 C 16 30 6 7 91 6 16 100 The port numbers for 10x10 conﬁgurationNote that the WaveShaper App version 1 01 only supports the 1x19 conﬁguration For the other conﬁgurations please upgrade to WaveShaper App 1 2 or use WaveManager 2 7 ...

Page 35: ...Python requests library MATLAB webread webwrite R2014b onwards urlread2 3rd party http au mathworks com matlabcentral ﬁleexchange 35693 urlread2 urlread not recommended Octave wget curl system calls urlread not recommended C C libcurl library Java Apache HttpClient Javascript Node js Natively via http get C VB NET System Net JSON The response data is in JSON format This stands for JavaScript Objec...

Page 36: ...o send the ﬁlter proﬁle For more complex automation modern programming languages support HTTP requests through common libraries Upload Filter Description Upload ﬁlter proﬁle to the WaveShaper HTTP method POST URL http _ip_ waveshaper loadproﬁle POST Data JSON formatted request includes the following ﬁelds JSON FIELD DESCRIPTION type Filter type with one of the following options wsp blockall transm...

Page 37: ...ding WSP ﬁlter ﬁles These examples also demonstrate how HTTP commands and JSON strings work together to control your instrument Examples Each example demonstrates a different commonly used WaveShaper function A complete copy of the code examples may be downloaded from within the help section of the WaveShaper Software Here is an overview Example_UploadPredeﬁnedProﬁle Demonstrates how to program th...

Page 38: ...er shapes by abstracting away the handling of JSON strings and HTTP commands uploadPredeﬁnedProﬁle This function simpliﬁes the task of uploading predeﬁned proﬁle by abstracting away the handling of JSON strings and HTTP commands 5 4 Python Examples The Python example code below is written for use with Python 3 In addition the following packages must be installed numpy requests json A complete copy...

Page 39: ... get http ip waveshaper devinfo json Set frequency variables from device info s result startfreq e result stopfreq Create data for wsp wsFreq np linspace s e int e s 0 001 1 wsAttn 50 np power np sin 2 np pi 0 5 wsFreq 193 2 wsPhase np zeros wsFreq shape wsPort np ones wsFreq shape Upload profile using created data r uploadProfile ip wsFreq wsAttn wsPhase wsPort import requests import json import ...

Page 40: ...ile ip profileType centerFreq bandwidth attenuation port addpath WSMethods Define device IP ip 169 254 6 8 GET device info and decode JSON result webread http ip waveshaper devinfo result jsondecoder result Set frequency variables from device info s result startfreq e result stopfreq Create data for wsp wsFreq linspace s e e s 0 001 1 wsAttn 50 sin 2 pi 0 5 wsFreq 193 2 wsPhase zeros size wsFreq w...

Page 41: ...Example_UploadPredeﬁnedProﬁle vi Example_UploadProﬁle vi Example_UploadProﬁleFromFile vi addpath WSMethods Define device IP ip 169 254 6 8 Open the wspTestFile wsp file from the same directory as this file string fileread wspTestFile wsp Run splitWspString function using the WSP string from the file wsFreq wsAttn wsPhase wsPort splitWspString string Upload profile using split data r uploadProfile ...

Page 42: ... Port 3 and 20 in Port 4 URL http _ip_ waveshaper loadsplitter Post Body 2 port coupler on ports 2 and 3 with equal splitting between the two coupler outputs URL http _ip_ waveshaper loadsplitter Post Body 4 way equal power splitter with an additional 3dB of attenuation programmed in URL http _ip_ waveshaper loadsplitter Post Body port1 P1 port2 P2 port3 P3 port4 P4 port1 0 2 port2 0 2 port3 0 4 p...

Page 43: ...ot deﬁned for values 1 If the sum of the normalized port power is 1 then the following error message will be returned Care should be taken to ensure that the formatting of the command is correct An incorrectly formatted command e g missing the leading 0 in a value for Pn will generate the following error message msg OK rc 0 msg OK rc 0 rc 1 msg error invalid json format WaveShaper A Series User Ma...

Page 44: ...andwidth Setting Accuracy 5 GHz 40 pm 10 GHz Bandwidth Setting Repeatability 2 5 GHz 20 pm 5 GHz Group Delay Control Range n a 25 ps to 25 ps 15 ps to 15 ps Attenuation Control Range n a 0 to 35dB Attenuation Setting Resolution n a 0 01 dB 0 1 dB 0 01 dB Attenuation Setting Accuracy n a 1 0 dB from 0 to 10 dB 10 from 10 to 30 dB Settling Time 500 ms Loss and Dispersion Insertion Loss 5 dB 6 5 dB I...

Page 45: ... to the supply wire resistance the voltage can drop signiﬁcantly between the power source and the terminal The supply wire gauge should be chosen to be able to deliver up to 10 A Rear view of the Series A module showing the Ethernet USB power supply and reset pins Benchtop Power Supply DESCRIPTION PARAMETER UNIT MIN TYPICAL MAX NOTES Power Consumption W 20 50 Typical at 25 C after warm up period M...

Page 46: ... C 20 70 Storage Humidity 10 90 Non condensing Case operating temperature C 15 55 Module Only ESD kV 16 Class N per HBM meets IEC 61000 4 2 level 4 Exceeding the ranges deﬁned here may result in permanent damage to the unit Normal Operating Conditions CONDITION PARAMETER UNIT MIN MAX NOTES Operating Temperature module C 15 55 Temperature of case with airﬂow across top of unit Min ﬂow rate 1m sec O...

Page 47: ...WaveShaper A Series User Manual 47 ...

Reviews:

No comments

Related manuals for WaveShaper A Series

Brand: Danelec Pages: 67

Brand: Gardigo Pages: 24

Brand: Gardner Bender Pages: 8

Brand: Garantia Pages: 4

Brand: NARIKA Pages: 2

Brand: Harken Pages: 4

Brand: Harken Pages: 2

TERRA FORCE BOOM

Brand: Hardi Pages: 40

Brand: Harken Pages: 4

QuickSlide HemaPRO

Brand: Hardy Diagnostics Pages: 2

Brand: H&S Pages: 42

Brand: Martin Pages: 202

So-exercise TX7

Brand: T-SoX Pages: 8

Brand: PMK Pages: 24

Brand: SteelFlex Pages: 13

Brand: Kettler Pages: 20

Brand: impact Pages: 12

Brand: Otto Bock Pages: 20

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands