Scilab-VISA User Manual

7/26/2019 Scilab-VISA User Manual

1/21

Date : 02/06/2015

Scilab VISA

User Manual

Scilab VISA - 1/21Scilab Enterprises S.A.S | 143 bis rue Yves Le C! " #$000 %ersailles " &'l. : 01.$0.##.04.60 "cntact(scilab"enterprises.c)

Capital*245+200 |523 2$, 536 -CS Evr| SIRET 523 2$, 536 00022 |VAT-565232$,536 |Sige socialarc rsa niversit' " 2 rue ean -stan "

,1$,3 rsa Cee "rance
mailto:[email protected]:[email protected]:[email protected]


2/21

summary

Installation..........................................................................................................2

re"reuisites.............................................................................................................................................................2

A7ilent........................................................................................................................................................................3

Quick start..........................................................................................................4

&utrial.......................................................................................................................................................................5

&utrial 8ull script.......................................................................................................................................................#

Module overview................................................................................................8

unctins...................................................................................................................................................................$

&pes........................................................................................................................................................................10

Cnstants.................................................................................................................................................................11

9te n instructins................................................................................................................................................11

Functions..........................................................................................................12

vietDe8initin........................................................................................................................................................12

8inAll;nstru)ents...................................................................................................................................................13vipenDe8ault-


3/21

Installation

Pre-requisites

Apprpriate >ar?are+ in t>e 8r) 8 a 9atinal ;nstru)ents ;@+;@"%;+ er >ar?are inter8aces+

9;"%;SA uses t>e sste)Bs stanar rivers.

9;"%;SA istributin )eia.

& use t>is )ule+ u >ave t:

" ;nstall 9;"%;SA+

" ;nstall Scilab 5.5.1+

" -un in Scilab: at)s;nstallpat> t attac>e 8ileFGscilabHvisaHversinF.!ipIJ nceI

" -un in Scilab: at)sLascilabHvisaIJ ?>en startin7 a Scilab sessinI.

Ailent

Yu can use bt> 9atinal ;nstru)ents ;@I an A7ilent/K K;@I Cntrllers n t>e sa)e sste).

& activate t>e inter8ace bet?een 9;H%;SA an A7ilent+ u )ust enable t>e 9i&ulip )e 8 9;H%;SA.

ner =in?s :

Searc> 9; is in8r)atin>ere.



http://www.ni.com/download/ni-visa-14.0/4722/en/http://www.ni.com/download/ni-visa-14.0/4722/en/http://digital.ni.com/public.nsf/allkb/3B3626D9C1F999218625694200791AD7mailto:[email protected]:[email protected]://www.ni.com/download/ni-visa-14.0/4722/en/http://digital.ni.com/public.nsf/allkb/3B3626D9C1F999218625694200791AD7mailto:[email protected]


4/21

Quick start

&>is sectin in8r)atin n usin7 t>e %;SA Librar Applicatin r7ra))erBs ;nter8ace A;I uner Scilab.

VISA

&>e %irtual ;nstru)ent S8t?are Arc>itecture %;SAI is a stanar 8r cn8i7urin7+ pr7ra))in7+ an

trubles>tin7 instru)entatin sste)s c)prisin7 ;@+ %;+ ;+ Serial+ Et>ernet+ an/r S@ inter8aces.

%;SA prvies t>e pr7ra))in7 inter8ace bet?een t>e >ar?are an evelp)ent envirn)ents.

!I"

;@ eneral urpse ;nter8ace @usI c)es 8r) ;EEE"4$$ stanar. ;t is a s>rt"ran7e i7ital c))unicatins

bus speci8icatin. ;t ?as create 8r use ?it> aut)ate test euip)ent.

Scilab VISA - #/21Scilab Enterprises S.A.S | 143 bis rue Yves Le C! " #$000 %ersailles " &'l. : 01.$0.##.04.60 "cntact(scilab"enterprises.c)




5/21

!utorial

"et t#e list o$ connected devices

& cnnect bet?een ur c)puter an ur evice u nee t>e aress 8 t>e instru)ent.

r t>is+ run t>e 8inAll;nstru)entsI ?>ic> 7ives u t>e list 8 all cnnecte instru)ents :

Mstatus+ eviceArsN O 8inAll;nstru)entsI

;8 8inAll;nstru)entsI >asnPt 8un an evice+ it returns MN.

" status cntains t>e return ce 8 t>e peratin.

" eviceArs cntains t>e list 8 escriptrs r aressesI 8 all cnnecte evices.

%&en a session

vipenDe8ault-e De8ault -esurce


6/21

)ead data

&>e vi-eaI is use 8r t>is purpse:

Mstatus+ bu88erut+ cuntN O vi-eaiDevice+ 255IJ

" iDevice is t>e evice ienti8ier.

" 255 is nu)ber 8 btes t be rea.

" status cntains t>e return ce 8 t>e peratin.

" bu88erut cntains t>e rea ata.

" cunt is t>e nu)ber 8 btes actuall rea.

)ead attri*utes

Yu can als rea ne 8 t>e instru)ents attributes ?it> t>e vietAttributeI 8unctin.

&>is 8unctin nees a pinter n t>e attribute+ s u nee t create a pinter 8 t>e attribute tpe+ t>en pass

it t t>e 8unctin.

&>en+ u ?ill nee t rea t>e pinter value+ use t>e eicate 8unctin 8r t>is:

pTueueLen7t> O ne?H%i;nt16IJ

status O vietAttributeiDevice+ vietDe8initin%;HA&&-HIJ

TueueLen7t> O %i;nt16HvaluepTueueLen7t>IJ


" vietDe8initin%;HA&&-Hic> t>e state uer is )ae." pTueueLen7> is t>e pinter t t>e value 8 t>e attribute.

" status is t>e pinter t t>e value 8 t>e attribute.

+isconnect $rom t#e device

&>e c))unicatin ?it> t>e evice is ver+ u can clse it usin7 t>e 8unctin viClse.

viClseiDeviceIJ


'lose t#e session

&>e sa)e c))an is use t clse t>e sessin.

viClsee8ault-


7/21

!utorial $ull scri&tMstatus+ eviceArsN O 8inAll;nstru)entsIJ

Mstatus+ e8ault-


8/21

Module overview

&>is sectin escribes 7ives an ver?ie? 8 t>e 8unctins+ tpes+ an t>er entities 8 t>e Scilab %;SA inter8ace.

&>e Scilab %;SA inter8ace is base n t>e %;SA C inter8ace escribe in t>e 9;"%;SA r7ra))er at 8r ea)ple+ all Scilab 8unctins >ave t>e sa)e na)es as in t>e C A;+ an t>eir si7natures are

t>e sa)e+ as )uc> as pssible. Di88erences are escribe >ere.

Functions

Scilab 8unctins >ave )stl t>e sa)e na)e as 8unctins in t>e C A;. nl t>e prttpes 8 8unctins i88er.

S)e 8unctins ?it> a pinter as para)eter can be returne in t>e Scilab euivalent 8unctin. &>ese are s)e

ea)ples:

VISA C 'unction E(ui)alent in Scilab

%iStatus vipenDe8ault-


9/21

S)e t>er 8unctins accept bu88er pinters in inputs+ an Scilab si)pli8ies t>eir use. As ?e can see bel?+ a

si)ple strin7 can be passe instea 8 bu88er pinters+ an cunt is aut)aticall calculate.


%iStatus vi=rite%iSessin vi+ %i@u8 bu8+ %i;nt32 cunt+ V

%i;nt32 retCuntIJMstatus+ retCuntN O vi=ritevi+ bu8IJ

%iStatus vi=riteAsnc%iSessin vi+ %i@u8 bu8+ %i;nt32 cunt+ V

%ib; Wb;IJMstatus+ Wb;N O vi=riteAsncvi+ bu8IJ

%iStatus vi@u8=rite%iSessin vi+ %i@u8 bu8+ %i;nt32 cunt+ V

%i;nt32 retCuntIJMstatus+ retCuntN O vi@u8=ritevi+ bu8IJ

%iStatus vipibC))an%iSessin vi+ %i@u8 bu8+ V

%i;nt32 cunt+ ... %i;nt32 retCuntIJMstatus+ retCuntN O vipibC))anvi+ bu8IJ

Ea)ple :

Mstatus+ cuntN O vi=ritevi+ R;D9IJ

S)e 8unctins use pinters t vi + as t>e utput tpe is nt e8ine an t>ere8re it is t>e userPs

respnsibilit t e8ine t>is tpe.


%iStatus vietAttribute%ibWect vi+ %iAttr attribute+ V

vi R attrStateIJstatus O vietAttributevi+ attribute+ attrStateIJ

Ea)ple :

attrState O ne?H%i;nt16IJ

attribute O vietDe8initin%;HA&&-H


10/21

!y&es

&>e %;SA C A; ree8ines t>e pri)itive tpes. r ea)ple t>e %;SA C tpe 8r an inte7er 16 bits is %iint16.

&>ese pri)itive tpes are aut)aticall )appe t Scilab tpes. &>e 8unctins usin7 t>at tpes can be use

transparentl+ ?it>ut an cnversin.

S)e 8unctins reuire pinters t a %;SA pri)itive tpeI as ar7u)ents t>at is t>e case 8 t>e 8unctin

vi=riteI 8r ea)pleI.

%;SA als e8ines als tpes 8r t>ese pinters+ 8ll?in7 is t>e list:

%i;nt32

%iA;nt32

%i;nt32

%iA;nt32

%i;nt16

%iA;nt16

%i;nt16

%iA;nt16

%i;nt$

%iA;nt$

%i;nt$

%iA;nt$

%iC>ar

%iAC>ar

%i@te %iA@te

%iAr

%iAAr

%i-eal32

%iA-eal32

%i-eal64

%iA-eal64

%i@lean

%iA@lean

%iStatus

%iAStatus

%i%ersin

%iA%ersin

%ibWect

%iAbWect

%iASessin

A set 8 eicate 8unctins are prvie t create an )anipulate pinters n eac> 8 t>ese tpes.

Create a pinter n a 7iven tpe &peF is ne ?it> new_(). r ea)ple t create a pinter n a

%iint16:

pData O ne?H%i;nt16IJ

& ere8erence a pinter+ use _value()t rea+ an _assign()t ?rite+ ?it> t>e pinter

as ar7u)ent:

%i;nt16Hassi7npData+ value;nIJ

valueut O %i;nt16HvaluepDataIJ

Cpin7 a pinter is ne ?it> copy_().

inall+ u >ave t elete t>e pinter t 8ree t>e allcate )e)rI ?it> delete_()

eleteH%i;nt16pDataIJ

Scilab VISA - 1,/21Scilab Enterprises S.A.S | 143 bis rue Yves Le C! " #$000 %ersailles " &'l. : 01.$0.##.04.60 "cntact(scilab"enterprises.c)




11/21

'onstants

&>e %;SA C A; e8ines a lt a cnstants+ lie attribute ;Ds e: %;HA&&-H@H;DI+ event ;Ds

e: %;HE%E9&H;HCese cnstants are accesse in Scilab via t>e vietDe8initinI 8unctin.

,ote on instructions

=>en u sen a c))an ?it> vi=riteI+ a carria7e return GnI is aut)aticall ae b t>e 8unctin:

Mstatus+ cuntN O vi=riteinstr+ :=A%e8r):DA&AIJ





12/21

Functions

vi"et+e$inition

Calling Se(uence

res O vietDe8initinstrin7HinI

Arguents

strin7Hin :

a c>aracter strin7.

res :

a real .

.escription

Durin7 t>e %;SA librar inte7ratin int t>e )ule+ na)es 8 e8initins ?>ic> ?ere ver 24 c>aracters >a t

be abbreviate.

&>is )acr )atc> t>e abbreviate na)e ?it> t>e ri7inal ne.

Ea)ples :vietDe8initin%;HSCCESSI





13/21

$indAllInstruments

-eturns t>e aresses 8 all cnnecte evices.

Calling Se(uence

Mstatus+ eviceArsN O 8inAll;nstru)entsI

Arguents

status :

a real cntainin7 t>e status 8 t>e peratin.

eviceArs :a )atri 8 strin7 cntainin7 t>e aresses 8 all cnnecte evices.

.escription

&>is )acr returns t>e aress r escriptrI 8 eac> cnnecte evice. An e)pt )atri MN is returne i8 n

evice is cnnecte.

Ea)ples :

Mstatus+ eviceDescriptrsN O 8inAll;nstru)entsI

utput ea)ple:

X&C;0::12#.0.0.1::&ES&::;9S&- X

X X

XAS-L1::;9S&- X

X X

XAS-L4::;9S&- X





14/21

vi%&en+e$ault)M

&>is 8unctin returns a sessin t t>e De8ault -esurce e peratin.

sesn :uniue l7ical ienti8ier t a De8ault -esurce e vipenDe8ault-e 8irst call t

t>is 8unctin initiali!es t>e %;SA sste)+ incluin7 t>e De8ault -esurce at resurce. Subseuent calls t t>is 8unctin return uniue sessins t t>e sa)e De8ault -esurce

en a -esurce at sessin clse+

but als all 8in lists an evice sessins ?>ic> t>at -esurce


15/21

vi%&en

pens a sessin t t>e speci8ie resurce .

Calling Se(uence

Mstatus+ viN O vipen sesn+ rsrc9a)e+ accesse return ce 8 t>e peratin.

vi :?ill be t>e c)puterPs ienti8ier 8r t>er 8unctins.

sesn :

resurce e Descriptin sectin 8r vali valuesI.

pen&i)eut :

speci8ies t>e )ai)u) ti)e peri in )illisecnsI t>e peratin ?aits be8re returnin7 an errr.

t>is es nt set t>e ;/ ti)eut"t t>at u )ust call viSetAttributeI ?it> t>e attribute

%;HA&&-H&e vipenI peratin pens a sessin t t>e speci8ie resurce.

Ea)ples :

Mstatus+ e8ault-


16/21

vi'lose

Clses t>e speci8ie sessin+ r t>e cnnectin t a evice.

Calling Se(uence

status O viClseviI

Arguents

status :

cntains t>e return ce 8 t>e peratin.

vi :uniue l7ical ienti8ier t a sessin+ event+ r 8in list.

.escription

&>e viClseI peratin clses a sessin r a cnnectin t a evice r an event+ r a 8in listI. ;n t>is prcess

all t>e ata structures t>at >a been allcate 8r t>e speci8ie vi are 8ree. Callin7 viClseI n a %;SA

-esurce t>at resurce )ana7er sessin.

Ea)ples :

Mstatus+ e8ault-


17/21

virite

=rites snc>rnusl ata t evice r inter8ace

Calling Se(uence

Mstatus+ ?riteCuntN O vi=ritesessin+ bu8I O vi=ritesessin+ bu8I

Arguents

status :

a real.

?riteCunt :

nu)ber 8 btes actuall trans8erre.

sessin :

uniue l7ical ienti8ier 8 a sessin.

bu8 :

a c>aracter strin7.

lcatin 8 a ata blc t be sent t a evice.

.escription

&>e vi=riteI peratin snc>rnusl trans8ers ata. &>e ata t be ?ritten is in t>e bu88er represente b

bu8. &>is peratin returns nl ?>en t>e trans8er is ter)inate. nl ne snc>rnus ?rite peratin canccur at a ti)e.

Ea)ples :

Mstatus+ e8ault-


18/21

vi)ead

Snc>rnusl reas ata 8r) evice r inter8ace .

Calling Se(uence

Mstatus+ bu8+ reaCuntN O vi-easessin+ cuntI

Arguents

status :

a real.

bu8 :

a c>aracter strin7.lcatin 8 t>e bu88er receivin7 ata 8r) evice.

reaCunt :

nu)ber 8 btes actuall trans8erre.

sessin :


cunt :

nu)ber 8 btes t be rea .

.escription

&>e vi-eaI peratin snc>rnusl trans8ers ata. &>e ata rea is stre in t>e bu88er represente b bu8.

&>is peratin returns nl ?>en t>e trans8er is ter)inate. nl ne snc>rnus rea peratin can ccur at

a ti)e.

Ea)ples :

Mstatus+ e8ault-


19/21

vi)equest

Snc>rnusl -ea an =rite ata in evice r inter8ace.

Calling Se(uence

Mstatus+ bu8utN O vi-euestsessin+ bu8I

Arguents

status :

a real.

bu8ut :

a c>aracter strin7.lcatin 8 a bu88er t receivin7 ata 8r) evice.

sessin :


bu8 :

a c>aracter strin7.

lcatin 8 t>e ata blc t be sent t t>e evice .

.escription

&>e vi-euestI peratin snc>rnusl trans8ers ata. &>e ata t be ?ritten is in t>e bu88er represente bbu8 an t>e ata rea t be stre is in t>e bu88er represente b bu8ut. &>is peratin returns nl ?>en

t>e trans8er is ter)inate. nl ne snc>rnus uer peratin can ccur at a ti)e.

Ea)ples :

Mstatus+ e8ault-en

Aress O &C;0::8tp.ni.c)::21::SCUE&J

en

Mstatus+ instrN O vipen e8ault-


20/21

vi"etAttri*ute

ets t>e value 8 a resurce attribute.

Calling Se(uence

status O vietAttributevi+ attribute+ pDataI

Arguents

vi :

uniue l7ical ienti8ier t a sessin+ event+ r 8in list.

attribute :

ienti8ier 8 t>e resurce attribute.

pData :

pinter t t>e attribute value.

.escription

&>e vietAttributeI peratin is use t 7et t>e value 8 an attribute 8r t>e speci8ie sessin+ event+ r 8in

list.

&>e pData utput para)eter is a pinter ?>ic> tpe epens n t>e attribute. r blean attributes+ u >ave

t create a pinter t a %i@lean variable an pass it t t>e 8unctin. se t>e 8unctins eicate t pinter

creatin+ as 8ll?in7:

pData%i@lean O ne?H%i@leanIJ

Ant>er ea)ple 8r %i;nt32 attributes:

pData%i;nt32 O ne?H%i;nt32IJ

ViGetAttribute() ?rites t>e value 8 t>e attribute t t>e aress pinte b t>e pData pinter ar7u)ent.

& rea t>is value+ use ant>er eicate 8unctin 8ll?in7 is 8r %i;nt32 attributesI:

ata O %i;nt32HvaluepData%i;nt32IJ

Scilab VISA - 2,/21Scilab Enterprises S.A.S | 143 bis rue Yves Le C! " #$000 %ersailles " &'l. : 01.$0.##.04.60 "cntact(scilab"enterprises.c)




21/21

Examples :

Mstatus+ e8ault-

Date post:	03-Mar-2018
Category:	Documents
Upload:	alberto-nunez-cardezo
View:	288 times
Download:	0 times

Scilab-VISA User Manual

Documents