ERMA SSI 1417-S04 User manual

SSI 1417-S04
PCI-Card with SSI-Outputs
Instruction Manual

Warranty
For delivered products our "Allgemeine Lieferungs- und Zahlungsbedingungen" are effective. In no event
ERMA-Electronicoritssuppliersshallbeliableforanyotherdamageswhatsoever(including,withoutlimi-
tation, damages forloss of business profits, business interruption orother pecuniary loss) arising outof or
inability to use this product.
AllproductsfromERMA-Electronicarewarrantedagainstdefectivematerialandworkmanshipforaperiod
oftwo(2)yearsfrom dateofdelivery.IfitisnecessarytoreturntheproducttoERMA, thesenderisrespon-
sibleforshippingcharges,freight,insuranceandproperpackagingtopreventbreakagein transit.ERMA's
warranty does not apply to defects resulting from action of thebuyer, such mishandling, improper interfa-
cing, operation outside of design limits, improper repair or unauthorized modification.
Trademarks
Turbo Pascal, Delphi are registered trademarks of Borland International, INC.
MS-DOS, Windows, Visual Basic are registered trademarks of Microsoft Corporation.
IBM,PCXT/AT,OS/2areregisteredtrademarksinoftheInternationalBusinessMachinesCorporation.
All other trademarks named or portrayed in the text are registered trademarks of its ownwer and are re-
cognized by ERMA-Electronic.

CONTENTS
1. Safety Instructions .......................4
2. Symbol Explanation ......................4
3. General .............................5
4. Function.............................5
5. Block diagram .........................6
6. Hints against noisy environment ...............6
7. Installation ...........................7
7.1. Hardware configuration ..................7
7.1.1. Component layout ...................8
7.1.2. Connection of SSI-Outputs ..............9
7.2. Open PC..........................9
7.3. Card insertion .......................9
7.4. Close PC..........................9
7.5. Driver installation .....................10
7.5.1. Windows 2000 / XP ..................10
8. Programming ..........................10
8.1. Programming under Windows ...............10
8.2. Programming with S1417S04_DLL-DLL .........10
8.2.1. Functions .......................11
8.3. Usage within own applications ..............13
ERMA-Electronic GmbH 2

8.3.1. VisualBasic6 ......................13
8.3.2. VisualBasic 2005 (.net) ................13
8.3.3. Visual C++/ LabWindowsCVI .............13
8.3.4. C# ...........................13
8.3.5. LabView ........................13
8.4. Direct programming ....................14
8.4.1. Registers of SSI 1417 .................15
8.4.2. Tips and Tricks.....................15
9. Troubleshooting ........................15
10. Technical datas.........................16
11. Ordering information......................17
3ERMA-Electronic GmbH
Stand : 03.2010
ssi1417s04_man_en.vp
Technical subjects to change

1. Safety Instructions
This instrument is produced in accordance with Class II of IEC 348 and VDE
0411.Whendeliveredtheintrumenthasbeentestedtomeetallfunctionsdescri-
bed. Before installing the instrument please read the mounting and servicing in-
structions.Wehavenoliabilityorresponsibilitytocustomeroranyotherpersonor
entity with respect to any liablity, loss or damage caused or alleged to be caused
directlyorindirectlybyequipmentorsoftwaresoldorfurnishedbyus.Readthein-
stallationinstructioncarefully.Noliabilitywillbeassumedforanydamagecaused
by improper installation.
Inspecttheinstrumentmodulecarton for obvious damage.Beshurethereareno
shipping and handling damages on the module before processing. Do not apply
power to the instrument if it has damaged.
The warranty does not apply to defects resulting from action of buyer, such as
mishandling,improperinterfacing,operationoutsideofdesignlimits,improperre-
pair or unauthorized modifications.
2. Symbol Explanation
Caution Attention Instruction Tip
Caution: Will be used at dangerous for life and health !
Attention: Will cause damage.
Instruction: If not noticed, Trouble may occur.
Tip: Useful hints for better operation.
ERMA-Electronic GmbH 4
1. Safety Instructions

3. General
The SSI 1417-S04 is a PCI-card which presents 2 SSI-outputs.
Available options:
•Opto-isolation
4. Function
The SSI 1417-S04 will use one PCI-slot within the pc. Because the PCI-bus sup-
ports plug and play, there are no jumpers or switches to change configuration.
The card will use 8 x 32-bit-IO-addresses for the function and 16 x 32-bit-IO-a-
dresses for the PCI-target-controller. You can use any number of SSI 1417-S04
within one pc (depends on number of PCI-slots). The standard drivers supports
up to 4 cards. If more than 4 cards should be used, you can ask for a driver for
morecards.Thecardhasone9-pinSUB-Dmaleconnectorfortheinputsandtwo
9-pin SUB-D female connectors for the encoders.
The functions of the card will be handled in a FPGA. This free pro-
gramable device makes it possible to support customer specific
functions without changing the hardware. It is possible to imple-
ment additional special functions or fast controllers within the
FPGA.
5ERMA-Electronic GmbH
3. General

5. Block diagram
6. Hints against noisy environment
All inputs and outputs are protected against noisy environment and high voltage
spikes.Neverthelessthe locationshouldbeselected toensurethatno capacitive
orinductiveinterferencecanhaveaneffectontheinstrumentorconnectionlines.
It is advisable:
•To use shielded, twisted pair cables.
•The wiring of shields and ground (0V) should be star-shaped.
•The distance to interference sources should be as far as possible. If necessa-
ry, protective screen or metal enclosures must be provided.
•Coils of relays must be supplied with filters.
•Parallel wiring of input signals and AC power lines should be avoided.
ERMA-Electronic GmbH 6
5. Block diagram
FPGA
PCI-Target-
Controller
Input-
and
Output-
Logic
SSI-Interface
SSI-Interface
PCI-Bus
Optional
Isolation

7. Installation
The installation of the card should only be done by qualified personal
only.Before installationallcomponentshavetobedisconnectedfrom
powersupply.BecausewithinPC’sandtheperipheralsarehighvolta-
ges it is dangerous to life!
7.1. Hardware configuration
TheSSI1417-S04usesplugandplayandsothereisnoneedforanysettings.
7ERMA-Electronic GmbH
7. Installation

7.1.1. Component layout
ERMA-Electronic GmbH 8
7. Installation
male female female
SV1
SV2
SV3
SSI0
SSI1
unused
component layout

7.1.2. Connection of SSI-Outputs
7.2. Open PC
Before opening the pc-case disconnect power supply! The case should be ope-
ned as described by the manufacturer of the PC.
7.3. Card insertion
While nserting the card you could be hurt. This is because all components on the
cardsandinthePChavesharppins.Sothisworkhavetobedonecarefully.Thee
SSI 1417-S04 should be placed in a free PCI-Slot. The card should be installed
vertically from above. Afterwards the slot plate of the card have to be screwed to
the backside of the PC-case.
Theslotplateisusedformountingandalsoforshielding.Keepinmindthatremo-
valoftheplatewillresult inlossofshieldingand card andPCwillbemoresensiti-
vetoEMC.Additionalythecardwon’tbeheldin slot-positionwhenexternalforce
willhappentotheconnectedcables.Thenthecardcouldmovewithintheslotand
that can result in damage to the SSI 1417-S04 and the PC! So, don’t remove the
slot plate!
7.4. Close PC
The case should be closed as described by the manufacturer of the PC.
9ERMA-Electronic GmbH
7. Installation
nc
+Vs
0V
NSSICLOCK
SSICLOCK
+Vs
NSSIDATA
SSIDATA
0V
SUB-D 9-pol.
female
User designation
Illustration 1Pinning of
SSI-female-connector

7.5. Driver installation
On most Windows-versions you must have administrator rights to install
drivers.
7.5.1. Windows 2000 / XP
Windows will recognize the new card and ask for the driver. The driver is on the
disc within the directory Driver\WinXP or Driver\Win2000.
8. Programming
8.1. Programming under Windows
To build applications for Windows the disc includes different drivers for all Win-
dows-versions.Tokeep the programmingoftheSSI1417-S04aseasyaspossi-
ble,allfunctionsofthedriversarehandledwithin oneDLL.Soallprogramming of
the card is done by using the DLL.
The file S1417S04_DLL.DLL should be copied to the Windows system directory
or the application directory.
8.2. Programming with S1417S04_DLL-DLL
The DLL S1417S04_DLL.DLL includes all functions necessary for the work with
theSSI1417-S04.Thereturnvalueofallfunctionsreportsanerror-code.Areturn
value of SSI_ERR_OK will show successful execution. Otherwise the code will
show the type of error.
ERMA-Electronic GmbH 10
8. Programming

8.2.1. Functions
S1417S04_InitDevice
The function SSIInit must be called once at the beginning of the program. The
functioninitialisestheDLLandthedriverandtheoutputdriverswillbeactivated.
S1417S04_DeInitDevice
ThefunctionSSIDeInitmustbecalledonceatthe endoftheprogram. Theoutput
drivers will be deactivated.
S1417S04_GetCardCount
This function returns the number of installed SSI 1417-S04 cards.
S1417S04_GetCardNumber
Thisfunctionreturnsthe serial numberoftheSSI1417-S04 card withthedesired
index. Index starts with 0 for the first card!.
S1417S04_GetLastError
This function returns the last happened error code.
Available error codes:
- S1417S04_ERR_OK= 0
- S1417S04_ERR_ALREADYOPEN = 1
- S1417S04_ERR_NOTOPEN = 2
- S1417S04_ERR_NOCARD = 3
- S1417S04_ERR_VXDNOTFOUND = 7
- S1417S04_ERR_INTERNALERROR = 8
- S1417S04_ERR_WRONGVALUE = 10
- S1417S04_ERR_NOTCONFIGURED = 14
11 ERMA-Electronic GmbH
8. Programming

S1417S04_SetConf
Thisfunctionsetstheconfigurationofthecardwiththedesiredindex.Indexstarts
with 0 for the first card!
The outputs will be activated after configuration of the card.
The value is bit coded and has the following meaning:
Bit 0 - 5 Number of bits for output SSI0 (min. 1 to max. 32)
Bit 6 - 11 Monofloptime for output SSI0 in us (min. 1 to max. 63)
Bit 12 Enable for multiplereading of SSI0 (ring register mode)
Bit 13 Gray-Binary-Conversion for SSI0 (only used in driver/softwarefunction)
Bit 14 + 15 unused
Bit 16 - 21 Number of bits for output SSI1 (min. 1 to max. 32)
Bit 22 - 27 Monofloptime for output SSI1 in us (min. 1 to max. 63)
Bit 28 Enable for multiplereading of SSI1 (ring register mode)
Bit 29 Gray-Binary-Conversion for SSI1 (only used in driver/softwarefunction)
Bit 30 + 31 unused
S1417S04_GetConf
Thisfunctionwillreturnthe configurationofthecardwiththedesiredindex.Index
starts with 0 for the first card!
The meaning of the bits for the value is the same as for S1417S04_SetConf.
S1417S04_SetSSI0Value
S1417S04_SetSSI1Value
ThesefunctionswillsettheabsolutevalueforthecorrespondingSSIoutput0or1
of the card with the desired index. Index starts with 0 for the frst card!
S1417S04_GetSSI0Value
S1417S04_GetSSI1Value
These functions will return the absolute value for the corresponding SSIoutput 0
or 1 of the card with the desired index. Index starts with 0 for the frst card!
ERMA-Electronic GmbH 12
8. Programming

8.3. Usage within own applications
8.3.1. VisualBasic6
WithindirectoryInclude\VB6onthecdthereisthefiles1417s04_dll.bas.Ifthisfile
is included within a VisualBasic-project, all DLL functions for SSI 1417-S04 are
available in the project.
8.3.2. VisualBasic 2005 (.net)
Within directory Include\VB_2005 on the cd there is the file s1417s04_dll.vb. If
this file is included within a VisualBasic-project, all DLL functions for
SSI 1417-S04 are available in the project.
8.3.3. Visual C++/ LabWindowsCVI
For C/C++ applications there are an import library S1417S04_DLL.LIB and a
header-fileS1417S04.H.Thelibraryhastobeinsertedin thelinker-optionsofthe
project-settings(seedocumentationofVisualC++/LabWindowsCVI). Includethe
header-file in all source-files where SSI 1417-S04 functions are needed.
An additional method is to use the Windows-function LoadLibrary to connect the
application to the DLL. See documentation of VisualC++ / LabWindowsCVI for
further information.
8.3.4. C#
InthedirectoryInclude\CsharpofthecdthereisthefileS1417S04_DLL.cs.Ifthis
file is inserted within a C#-project all DLL-functions of the SSI 1417S04-are avai-
lable.
8.3.5. LabView
In the directory LabView of the cd there are an example and VIs for using the
SSI 1417-S04 in LabView.
13 ERMA-Electronic GmbH
8. Programming

8.4. Direct programming
ForuseoftheSSI1417-S04onotheropertingsystemsor togetfasterreactionti-
mesorspecialreactionsother drivers shouldbeimplemented.Therefore allnee-
ded information follows.
Addresses and interrupts of the card
TheSSI1417-S04uses2IO-addressranges.Becauseoftheplug-and-playofthe
PCI-bus these data should be found out. Therefore functions of the BIOS has to
be used like described in “PCI BIOS SPECIFICATION Revision 2.1".
The SSI 1417-S04 uses a configuration space header type 00h. The datas could
be found in the PCI-configuration space on BaseAddress0 and BaseAddress1.
With BIOS-function the data could be read out of the configuration space. Ba-
seAddress0isused forthePCI-targetcontroller,BaseAddress1fortheSSI-func-
tions of the card.
For the BIOS-functions the following informations are necessary:
•VendorID = 0x10E8 (AMCC)
•DeviceID = 0x5920 (S5920Q)
•SubVendorID = 0x1485 (ERMA - Electronic GmbH)
•SubSystemID = 0x0009 (SSI 1417-S04)
Functions of the PCI-target
Initialisation of the PCI-target
Write value 0x87878787 to address BaseAddr0 + 0x60
ERMA-Electronic GmbH 14
8. Programming

8.4.1. Registers of SSI 1417
Position-register
read only
BaseAddr1 + 0x00 Position SSI0
BaseAddr1 + 0x04 Position SSI1
Configuration-registers
Read/Write BaseAddr1 + 0x08
Bit 0 - 5 Number of bits for output SSI0 (min. 1 to max. 32)
Bit 6 - 11 Monofloptime for output SSI0 in us (min. 1 to max. 63)
Bit 12 Enable for multiplereading of SSI0 (ring register mode)
Bit 13 + 15 unused
Bit 16 - 21 Number of bits for output SSI1 (min. 1 to max. 32)
Bit 22 - 27 Monofloptime for output SSI1 in us (min. 1 to max. 63)
Bit 28 Enable for multiplereading of SSI1 (ring register mode)
Bit 29 unused
Bit 30 Global Enable of SSI output registers
Bit 31 Global Enable of the card (enable output drivers)
8.4.2. Tips and Tricks
•If drivers are developed, the following points should be considered:
- While writing to registers, set all unused bits to 0
- While reading registers, mask out all unused bits.
This will safe compatibility with future changes.
9. Troubleshooting
All PC-boards of ERMA-Electronic GmbH are tested during manufacturing as
wellaswhendelivered. Nevertheless it can occur that anewboarddoesn’twork.
Thatmustnotbe afailureofthe board. Therearemanyminordetails when anew
boarddoesn’twork.Inthatcaseatfirstsomepointsshouldbepaidattentionto.
15 ERMA-Electronic GmbH
9. Troubleshooting

•Oneofthemostfrequentfailuresaredirtyslots.Itisrecommendedtocleanthe
connector of the board with a cloth and a little spirit.
•Furtherit can happen that the board doesn’t fit correctly into the slot orintothe
PC case. The dimensions of the board are standardized. But the dimension of
the PC cases are sometimes out of the prescribed dimensions.
•The cable of the peripherie should be tested.
If you have observed the hints above and the board doesn’t work at all call the
ERMA - Team. The ERMA-Team will help you.
10. Technical datas
Interfaces : 2 x SSI-outputs
Inputs : EIA RS422
Max. Resolution : 32 Bit, programable separately
for each interface
Clock Outputs : EIA RS422
Max. Clock : 5 MHz, programmable seperately
for each interface
Monofloptime : 1 µs to 63 µs, programmable
seperately for each interface
Ecoder Power Supply : Optional
5 V / 2 x 300 mA or
12 V / 2 x 125 mA or
24 V / 2 x 60 mA
Isolation : 500 VDC (only with option galv.
isolation)
Connectors : 2 x 9-pol. SUB-D-female for SSI
1 x 9-pol. SUB-D-male unused
EMC : corresponding to
2004/108/EG
Operating Temperature : 0 bis 40 °C
Storage Temperature : -25 bis +85°C
Dimensions : 132 x 105 mm
ERMA-Electronic GmbH 16
10. Technical datas

11. Ordering information
SSI 1417/ x/ 0/ xx -S04
Encoder Power Supply
000 Without power supply
005 With 5 V power supply
012 With 12 V power supply
024 With 24 V power supply
Galvanic (opto) Isolation
0Without galvanic isolation
1With galvanic isolation
17 ERMA-Electronic GmbH
11. Ordering information

ERMA - Electronic GmbH
Max-Eyth-Str. 8
D-78194 Immendingen
Telefon [phone]
Fax [phone]
email [email protected]
Web www.erma-electronic.de