Digalog Systems DigESwitch User manual

DigESwitch Differential 4200-0352 V1.1

DigESwitch Differential
Table of Contents
Hardware Installation......................................................................................................................................12
Hardware Installation - 19”rack ..........................................................................................................12
Software Installation........................................................................................................................................13
For IVI Installation Only:.........................................................................................................................13
To Create A Hardware Asset.................................................................................................................14
To Create A Driver Session....................................................................................................................14
Software Installation:..............................................................................................................................15
IVI Configuration...............................................................................................................................................15
To Create A Logical Name.....................................................................................................................17
Configuration and Setup ...............................................................................................................................19
DigESwitch Home Page.........................................................................................................................19
IP Configuration Page.............................................................................................................................21
Changing the IP settings on the DigESwitch box ........................................................................25

DigESwitch Differential
Customer Support Page........................................................................................................................28
Factory IP Configuration Default Settings ......................................................................................28
Block Diagram...........................................................................................................................................32
Connector Pinout / Layout ...................................................................................................................33
Overview..............................................................................................................................................................34
Features:......................................................................................................................................................34
Front Panel .................................................................................................................................................37
Power LED...................................................................................................................................................37
Active LED...................................................................................................................................................37
Link LED.......................................................................................................................................................38
Signal Connectors....................................................................................................................................38
Connector J1..............................................................................................................................................39
Connector J2..............................................................................................................................................40
Connector J3..............................................................................................................................................41

DigESwitch Differential
Connector J4..............................................................................................................................................42
Connector J5..............................................................................................................................................43
Rear Panel ...................................................................................................................................................44
Specifications.....................................................................................................................................................45
DigESwitch I/O Connectors (J1 – J5) .................................................................................................45
Relays............................................................................................................................................................45
System Operating Environment.........................................................................................................46
DigESwitch Configurations ..................................................................................................................46
Power Requirements ..............................................................................................................................46
Fuses.............................................................................................................................................................47
Switching Speeds.....................................................................................................................................47
High Frequency Specifications ...........................................................................................................47
Box Dimensions........................................................................................................................................48
IVI Compliance Category ...............................................................................................................................51

DigESwitch Differential
IVI-C Custom Specific Instrument Driver .........................................................................................51
Software Information:.............................................................................................................................52
IVI Switch Class Software ...............................................................................................................................52
Supported Calls - Required Functions..............................................................................................52
Supported Calls - IviSwitchBase Capability Group Functions..................................................53
Supported Calls - Utility Functions....................................................................................................53
Supported Calls - Set and Get Check Attribute Functions........................................................53
Supported Calls - Lock and Unlock Functions...............................................................................54
Supported Calls - Error Information Functions .............................................................................54
Unsupported Calls - Interchangeability Checking Functions..................................................55
Unsupported Calls - IviSwitchScanner Extension Group Functions......................................55
Unsupported Calls - IviSwitchSoftwareTrigger Extension Group Functions......................55
Unsupported Calls - Utility Functions...............................................................................................55
IVI-C Switch Class-Compliant Specific Software....................................................................................56

DigESwitch Differential
Library (.dll) Software .............................................................................................................................59
dlesw_Open...............................................................................................................................................60
dlesw_Close...............................................................................................................................................61
dlesw_GetFirmwareRev.........................................................................................................................62
dlesw_GetInstrumentModel................................................................................................................63
dlesw_Reset...............................................................................................................................................64
dlesw_ConnectChan...............................................................................................................................65
dlesw_DisconnectChan.........................................................................................................................66
dlesw_DisconnectAll ..............................................................................................................................67
dlesw_WriteChanImage ........................................................................................................................68
dlesw_ReadChanImage.........................................................................................................................69
dlesw_ReadBusImage............................................................................................................................71
dlesw_WriteBoardImage.......................................................................................................................72
dlesw_ReadBoardImage .......................................................................................................................73

DigESwitch Differential
dlesw_WriteBoxImage ...........................................................................................................................75
dlesw_ReadChanRelayStates...............................................................................................................77
dlesw_ReadBusRelayStates..................................................................................................................78
dlesw_ReadBoardRelayStates .............................................................................................................79
dlesw_ReadBoxRelayStates..................................................................................................................80
dlesw_RelayUpdate ................................................................................................................................81
Error Codes.................................................................................................................................................82
Library Call Code Examples..................................................................................................................85
OVERVIEW OF TCP API.....................................................................................................................................91
TCP Message Structure ..........................................................................................................................92
TCP Command Summary Table ..........................................................................................................93
TCP Command Listing............................................................................................................................94
0x01 Get Firmware Rev..........................................................................................................................94
0x02 Board Reset......................................................................................................................................95

0x05 Connect Channel...........................................................................................................................96
0x06 Disconnect Channel.....................................................................................................................97
0x07 Disconnect All.................................................................................................................................98
0x08 Number of Boards Present.........................................................................................................99
0x09 Write Channel Image................................................................................................................. 100
0x0A Read Channel Image................................................................................................................. 101
0x0B Write Bus Image.......................................................................................................................... 102
0x0C Read Bus Image .......................................................................................................................... 103
0x0D Write Board Image..................................................................................................................... 104
0x0E Read Board Image...................................................................................................................... 106
0x0F Read Channel Relay State........................................................................................................ 108
0x10 Read Bus Relay State................................................................................................................. 109
0x11 Read Board Relay State ............................................................................................................ 110
0x12 Relay Update................................................................................................................................ 111
0x1B Get Instrument Model.............................................................................................................. 112

0x1E Write Box Image.......................................................................................................................... 113
0x1F Read Box Image .......................................................................................................................... 115
0x20 Read Box Relay States............................................................................................................... 116
0x21 Set Relay Break Time ................................................................................................................. 117
TCP Error Codes ..................................................................................................................................... 118
Appendix A - Replacement Parts ............................................................................................................. 119
Fuses.......................................................................................................................................................... 119
Relays......................................................................................................................................................... 119
DigESwitch I/O Connectors (J1 – J5) .............................................................................................. 119
Appendix B - Warranty................................................................................................................................. 121

11
Installation
DigESwitch Differential
Installation

12
Installation
DigESwitch Differential
Hardware Installation
Hardware Installation - 19” rack
Install the (2) rack mount brackets (0000-8337) to each side of the
DigESwitch box using the (6) black 8-32 (2825-0167) screws provided.
Mount the DigESwitch box in the 19”rack using (4) clips (1400-1041) and (4)
10-32 screws (1400-3333) provided.
Connect power to the DigESwitch box using the power cord provided.
Connect the DigESwitch box to the network using the appropriate RJ-45
cable.
A shielded ethernet cable and shielded accessory cables should be used
whenever possible to reduce noise.
1.
2.
3.
4.
5.

13
Installation
DigESwitch Differential
Software Installation
There are two different software packages that can be used to program the
DigESwitch. One software package installs only the DLL files necessary to
program the DigESwitch from any programming language that uses the C
function calling syntax. The other software package installs the necessary files
for the DigESwitch to be programmed from an IVI-compatible programming
environment. Also available are National Instruments LabView™ VIs and
National Instruments LabWindows/CVI™ front panels.
For IVI Installation Only:
Install Windows Installer Version 2.0 or later. this software can be found at :
http://www.microsoft.com/downloads/release.asp?ReleaseId=32832
Install the NI IVI Compliance Package Version 2.1 or later. This includes the
latest IVI Shared Components. The latest version is available from: http://
www.ni.com.
Install the NI-VISA Run-time Engine Version 3.0.1 or later. The latest version
available from: http://www.ni.com.
1.
2.
3.

14
Installation
DigESwitch Differential
To Create A Hardware Asset
Right click on the “Hardware Asset” entry and select “Create New . . .“. This
will create a new form where the Hardware Asset information can be
entered. The “Hardware Asset” entry is in the tree view on the left hand side
of the Configuration Store Editor.
Enter a name that specifies the hardware asset that is being added. For
example:“DigESwitch”.
Enter a description for the asset. This field is optional. An example would
be“50 Channel Differential Switch”.
Enter the I/O Resource. The I/O Resource is in the format of“TCPIP :: (Host
Address) :: 9000 :: Socket” where (Host Address) is either the IP address such
as 192.168.1.213 or is the given host name.
The entry will be automatically saved.
1.
2.
3.
4.
5.

15
Installation
DigESwitch Differential
Software Installation:
If installing the IVI software, install the necessary components above to
meet the Required Software Components.
Run the dlesw_ivi_c_driver.msi program on the Installation CD to install the
drivers. When prompted, select the Foundation option if the IVI drivers are
not required or select both to install both the C syntax and IVI drivers.
If the IVI drivers were installed, run the“ConfigStoreEditor Setup.exe”
program on the Installation CD to install the Configuration Store Editor
program.
Follow the DigESwitch Hardware Configuration instructions. The software is
now ready to use.
IVI Configuration
If installing the IVI drivers, use the Configuration Store Editor Program found at
“C:\Program Files\Digalog\Configuration Store Editor and create the following
setup in the order given:
1.
2.
3.
4.

16
Installation
DigESwitch Differential
To Create A Driver Session
Right click on the “Sessions”entry and select“Create New . . .“. This will
create a new form where the Driver Session information can be entered.
The“Sessions”entry is in the tree view on the left hand side of the
Configuration Store Editor.
Enter a name that specifies the driver session that is being added. For
example:“DigESwitch”.
Enter a description for the driver session. This field is optional. An example
would be“50 Channel Differential Switch”.
Select which Session Attributes are to be enabled.
Select the Software Module called dleSw.
Select a Hardware Asset from the list of previously created Hardware Assets.
If the hardware asset for this card does not exist, it must be created before
finishing this Driver Session.
The Virtual Names tab can be used to assign virtual names to the channels
1.
2.
3.
4.
5.
6.
7.

17
Installation
DigESwitch Differential
on the card. This is done in the Names section. First, enter the virtual name.
Then select the channel to assign that virtual name to from the drop down
list. Please note, a software module needs to be selected on the Driver tab
in order for the drop down list to be filled with channels names for the card.
Once both are entered select “Add”. The new assignment will appear in the
list of assignments on the left. An existing assignment can be deleted by
selecting it from the list and then selecting “Remove”.
The Initial Settings tab only applies to equipment that use initial settings.
Review the documentation for the equipment to see what, if any, initial
settings are available.
To Create A Logical Name
Right click on the “Logical Names”entry and select “Create New . . .“. This
will create a new form where the Logical Name information can be entered.
The“Logical Names”entry is in the tree view on the left hand side of the
Configuration Store Editor.
8.
1.

18
Installation
DigESwitch Differential
Enter a name that specifies the logical name that is being added. For
example:“DigESwitch”. If an existing logical name is being used, select that
logical name and then select the Driver Session created for this card.
Enter a description for the logical name. This field is optional. An example
would be“50 Channel Differential Switch”.
Select a Driver Session from the list of previously created driver sessions.
2.
3.
4.

19
Installation
DigESwitch Differential
Configuration and Setup
DigESwitch Home Page
The DigESwitch Home page contains information about the DigESwitch box.
The following information is displayed:
Instrument Model The DigESwitch model number.
Manufacturer Manufacturer name - Digalog
Systems, Inc.
Serial Number Serial number of the DigESwitch box.

20
Installation
DigESwitch Differential
Description Description of the DigESwitch box.
This string can be configured by the
user and may be changed on the IP
Configuration page.
Host Name Host name as resolved by the DNS
server. This field will contain the
assigned IP address if no host name is
assigned to the DigESwitch box.
MAC Address Media Access Control address of the
DigESwitch box.
TCP/IP Address Current IP address assigned to the
DigESwitch box.
Firmware Revision Firmware revision of the DigESwitch
box.