manualshive.com logo in svg

North Atlantic 8810A, Programmer'S Reference Manual

Share
Download
North Atlantic 8810A Programmer'S Reference Manual Download Page 2

 

 

 

 

 

 

 

 

 

 

 

              Contents 

 

Table of Contents 
 
1 

Introduction............................................................................................................................. 3 

2 

Remote Setup .......................................................................................................................... 4 

2.1 

Controlling Channel 1 Signal Input ................................................................................ 5 

3 

Language Support ................................................................................................................... 7 

3.1 

Compatibility to 8810 APIs ............................................................................................ 9 

3.2 

Language Independent Commands............................................................................... 11 

3.3 

API-8810A Native ........................................................................................................ 12 

3.4 

API-8810 Native (Legacy)............................................................................................ 29 

3.5 

API-8810 SR103 (Legacy) ........................................................................................... 31 

3.7 

API-8810 HSR202 (Legacy)......................................................................................... 32 

3.8 

API-8810 HSR203 (Legacy)......................................................................................... 33 

3.9 

API-8810 MATE/CIIL (Legacy) .................................................................................. 34 

4 

API-8810A USB Protocol..................................................................................................... 35 

5 

API-8810A Ethernet Protocol............................................................................................... 37 

6 

API-8810A DLL ................................................................................................................... 40 

7 

API-8810A Soft Panel Program............................................................................................ 41 

8 

Cypress USB Driver Installation for Windows XP .............................................................. 49 

North Atlantic Industries, Inc. 

631.567.1100/631.567.1823 (fax)               Revision 2.0.0.2 

Reference Guide 

110 Wilbur Place, Bohemia, NY 11716 

www.naii.com

 / e-mail:[email protected]       

Page 2 of 50 

 

8810A Programmer’s 

Summary of Contents for 8810A

Page 1: ...t and One optional Reference supply Programmer s Reference Programmer s Reference Guide for 8810A North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Guide for 8810A 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 1 of 50 ...

Page 2: ...03 Legacy 31 3 7 API 8810 HSR202 Legacy 32 3 8 API 8810 HSR203 Legacy 33 3 9 API 8810 MATE CIIL Legacy 34 4 API 8810A USB Protocol 35 5 API 8810A Ethernet Protocol 37 6 API 8810A DLL 40 7 API 8810A Soft Panel Program 41 8 Cypress USB Driver Installation for Windows XP 49 North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 w...

Page 3: ...ion For additional information about this instrument refer to the Operation Manual for Model 8810A For additional information about the Application Programming Interface API provided in the API8810ADll refer to the Function Reference Manual for 8810A Reference CD For electronic copies of the 8810A documentation API 8810A Soft Panel application program and source code for API 8810ADll and Soft Pane...

Page 4: ...ration screen In Local mode the configuration settings can be queried The unit must be in one of the Remote modes Ethernet IEEE USB or J1 before configuration settings can be changed remotely Note for remote programming via the IEEE interface the language type must be selected refer to section 3 on language support North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Refere...

Page 5: ...nnel 2 is read only from the J1 connection The configuration for channel 1 is configured two ways One method is to click the button shown below 8810A Programmer s The second method is to click on the Setup button See next page North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 5 of 5...

Page 6: ...1 Input Click on the Set button 8810A Programmer s Note the Auto Save option is not available on 8810A Revision B instruments North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 6 of 50 ...

Page 7: ...ialize to the conditions listed under DCL DCL DC4 14 Device Clear When the API receives the DCL command it is initialized to the following state SYNCHRO DATA FREEZE OFF SRQ MODE OFF GET MODE OFF GET BS 08 Group Execute Trigger When the GET command is received and if the API is addressed to listen and has the GET mode switch on data sent to the API will be applied to the instrument LLO DC1 11 Local...

Page 8: ...ity none L4 Listen capability all except LON LEO Extended Listen capability none SR1 Service request complete capability RL1 Remote Local complete capability PPO Parallel Poll no capability DC1 Device Clear complete capability DT1 Device Trigger complete capability North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www nai...

Page 9: ...REEZE When bit is set the display is frozen RESOLVER When bit is set the API is programmed for RESOLVER mode When cleared the API is set to SYNCHRO mode If the RQS bit is set the remaining bits indicate the state of the API when the SRQ line was last asserted If the RQS line is not set then the remaining bits indicate the state of the API at the time the status byte is read Service Request The API...

Page 10: ...GET Group Executive Trigger bus command is received GET mode is cancelled once the bus command GET is received and must be reprogrammed if desired again North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 10 of 50 8810A Programmer s ...

Page 11: ...r lf Clears the error message queue and resets the device with power on or last saved configuration settings APICMD b LANG cr lf Queries the IEEE Language setting Query returns 8810ANATIVE or 8810NATIVE or 8810SR103 or 8810HSR202 or 8810HSR203 or 8810MATECIIL Language APICMD b LANG b 8810ANATIVE 8810NATIVE 8810SR103 8810HSR202 8810HSR203 8810MATECIIL cr lf Sets the IEEE Language setting North Atla...

Page 12: ...an b MODE cr lf Queries the mode state of the channel Query returns RSL or SYN Signal Mode API chan b MODE b RSL SYN cr lf Sets the Rsl Syn state for the channel API chan b REF_SOURCE cr lf Queries the reference source for the channel Query returns INT or EXT Reference Mode API chan b REF_SOURCE b INT EXT cr lf Sets the Internal External reference source mode for the channel Ratio API chan b RATIO...

Page 13: ...lue Range 6 value 1200 API chan b AVERAGE cr lf Queries the averaging setting for the channel Query returns ON avgRate or OFF avgRate API chan b AVERAGE b STATE b ON OFF cr lf Turns on or off the channel s averaging feature API chan b AVERAGE b RATE cr lf Queries the averaging setting for the averaging rate in msec for the channel Angle Averaging API chan b AVERAGE b RATE b value cr lf Set the cha...

Page 14: ... angle or angle error comparison is used for limit testing API chan b ANG_LIMIT b ON OFF cr lf Turns on or off the channel s angle limit testing feature API chan b ANG_LIMIT b CMP cr lf Queries the angle limit test comparison settings for the channel Query returns ABS or ERR Angle Limit Testing API chan b ANG_LIMIT b CMP b ABS ERR cr lf Set the channel s angle limit comparison to Absolute Angle or...

Page 15: ...lue 180 0000 API chan b ANG_LIMIT LO cr lf Queries the lower limit test value settings for the channel Query returns lower limit in degrees Range 0 0000 value 359 9999 or Bipolar Range 180 0000 value 180 0000 API chan b ANG_LIMIT b LO b value cr lf Sets the lower limit test value in degrees Range 0 0000 value 359 9999 or Bipolar Range 180 0000 value 180 0000 North Atlantic Industries Inc 631 567 1...

Page 16: ...0 0000 value 180 0000 Velocity API chan b VEL cr lf Queries the angle velocity data for the channel Query returns channel velocity in degrees per second Range 32767 value 32767 Line to Line Voltage API chan b LL_VOLT cr lf Queries the line to line voltage for the channel Null Voltage API chan b NULL_VOLT cr lf Queries the null voltage for the channel Note this feature has not been implemented The ...

Page 17: ...ngle or velocity for D A voltage output conversion for the channel Digital to Analog Setup API chan b DA b HIDATA cr lf Queries the D A Upper Limit Data conversion for the channel Query returns for Angle Data in degrees Unipolar Range 0 0000 value 359 9999 or Bipolar Range 180 0000 value 180 0000 Query returns for Velocity Data in degrees sec Range 10000 value 10000 North Atlantic Industries Inc 6...

Page 18: ...cr lf Queries the D A Voltage conversion for the Upper Limit Conversion for the channel Query returns voltage value in the range 10 0 value 10 0 API chan b DA b HIVOLT b value cr lf Sets the D A Voltage conversion for the Upper Limit Conversion for the channel Voltage range in volts 10 0 value 10 0 North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wil...

Page 19: ...it Data conversion for the channel Angle Data Range in degrees Unipolar Range 0 0000 value 359 9999 or Bipolar Range 180 0000 value 180 0000 Velocity Data Range in degrees sec 10000 value 10000 API chan b DA b LOVOLT cr lf Queries the D A Voltage conversion for the Lower Limit Conversion for the channel Query returns voltage value in the range 10 0 value 10 0 North Atlantic Industries Inc 631 567 ...

Page 20: ...ion for the Lower Limit Conversion for the channel Voltage range in volts 10 0 value 10 0 North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 20 of 50 8810A Programmer s ...

Page 21: ...hannels Query returns ON avgRate or OFF avgRate Angle Averaging APIALL b AVG_ANGLE cr lf Queries the average angle value for BOTH channels Query returns angle in degrees Range 0 0000 value 359 9999 or Bipolar Range 180 0000 value 180 0000 Bandwidth APIALL b BANDWIDTH cr lf Queries the bandwidth setting for BOTH channels Query returns AUTO bwValue or OVERRIDE bwValue Signal Mode APIALL b MODE cr lf...

Page 22: ... limit test settings for BOTH channels Query returns ON or OFF to indicate whether limit testing is active or disable a blank space ABS or ERR to indicate whether absolute angle or angle error comparison is used for limit testing Velocity APIALL b VEL cr lf Queries the angle velocity data for BOTH channels Query returns channel velocity in degrees per second Range 32767 value 32767 Line to Line Vo...

Page 23: ...d Reference Voltage APIALL b REF_VOLT cr lf Queries the reference voltage for BOTH channels Reference Frequency APIALL b REF_FREQ cr lf Queries the reference frequency for BOTH channels North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 23 of 50 8810A Programmer s ...

Page 24: ...r lf Sets the voltage setting for the internal reference generator Voltage range is 2 0 to 115 0 volts REF_GEN b STATE cr lf Queries the output state of the internal reference generator Query returns OPEN or CLOSED Reference Generator Output State REF_GEN b STATE b OPEN CLOSE cr lf Sets the output state for the internal reference generator The CLOSE state will out allow reference signals to be ava...

Page 25: ...ommuni cation Setting APICMD b COMM b IEEE USB ETHERNET J1 cr lf Sets the communication setting to communicate remotely via IEEE USB Ethernet or J1 Go To Local APICMD b COMM b LOCAL cr lf Sets the device to Local mode Local Lockout APICMD b COMM b LOCKOUT cr lf Sets the device to Local Lockout mode Angle Display Format APICMD b ANG_FMT cr lf Queries the angle display format Query returns 0 to 360 ...

Page 26: ... to show angle difference or Channel 2 angle value If angle difference is turned ON the device will automatically switch the screen to Dual Chan and show the angle difference value in place of Channel 2 angle data Angle Difference APICMD b ANGDIFF cr lf Queries the device for the angle difference between Channel 1 angle and Channel 2 angle value Angle Diff Range 180 0000 value 180 0000 Default Val...

Page 27: ...and is sent APIBUF b SAMPLE_RATE cr lf Queries the device for the sample rate for recording data Query returns the sample interval followed by a blank and the sample units MSEC SEC or MIN APIBUF b SAMPLE_RATE b value b MSEC SE C MIN cr lf Sets the device to sample at the given rate Sample Rate range 100 msec value 30 min APIBUF b SAMPLE_TYPE cr lf Queries the device for the type of data to record ...

Page 28: ...nly via USB or Ethernet Via USB the maximum number of records returned for each call is 5 Via Ethernet the maximum number of records returned for each call is 150 Calibration APICMD b CALIBRATE cr lf Queries the device for the calibration state Query returns CAL DONE or CALIBRATING APICMD b CALIBRATE cr lf Calibrates the unit North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0...

Page 29: ...f Channel Input is set for Back Connector the Signal Mode configuration is not modified Channel 1 is set as the active channel Channel Select R cr lf or r cr lf or R cr lf or r cr lf or 2 cr lf or 2 cr lf If Channel 1 Input is set for Front Panel this will set the Signal Mode to RESOLVER Channel 1 is set as the active channel If Channel Input is set for Back Connector the Signal Mode configuration...

Page 30: ...or V cr lf or v cr lf Asserts SRQ when data is stable North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 30 of 50 8810A Programmer s ...

Page 31: ... If Channel Input is set for Back Connector the Signal Mode configuration is not modified Channel 1 is set as the active channel Channel Select R cr lf or r cr lf or R cr lf or r cr lf or 2 cr lf or 2 cr lf If Channel 1 Input is set for Front Panel this will set the Signal Mode to RESOLVER Channel 1 is set as the active channel If Channel Input is set for Back Connector the Signal Mode configurati...

Page 32: ...r Front Panel this will set the Signal Mode to SYNCHRO Channel 1 is set as the active channel If Channel Input is set for Back Connector the Signal Mode configuration is not modified Channel 1 is set as the active channel Channel Select R cr lf or r cr lf or R cr lf or r cr lf If Channel 1 Input is set for Front Panel this will set the Signal Mode to RESOLVER Channel 1 is set as the active channel...

Page 33: ...r Front Panel this will set the Signal Mode to SYNCHRO Channel 1 is set as the active channel If Channel Input is set for Back Connector the Signal Mode configuration is not modified Channel 1 is set as the active channel Channel Select R cr lf or r cr lf or R cr lf or r cr lf or 2 cr lf or 2 cr lf If Channel 1 Input is set for Front Panel this will set the Signal Mode to RESOLVER Channel 1 is set...

Page 34: ...8810 units with MATE CIIL support Only the features that were available for the 8810 MATE CIIL are supported with this language Please contact the manufacture if MATE CIIL support is needed North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 34 of 50 8810A Programmer s ...

Page 35: ... 0 byte loByte hiByte Format data to be sent Protocol 16 bits Number of bytes to be sent 16 bits Command ID 0x226A for 8810 szMsg data message Low byte of Total Bytes to send loByte byte usTotalBytes 0x00FF High byte of Total Bytes to send hiByte byte usTotalBytes 8 szData nDataCnt loByte szData nDataCnt hiByte Low byte of Command loByte byte usCommand 0x00FF High byte of Command hiByte byte usCom...

Page 36: ...EndPt TimeOut 10000 10 second timeout bSuccess glb_pUSBDevice BulkInEndPt XferData aReceiveBuffer BytesToRead numOfTries if bSuccess Wait 500 else strcpy pszReply char aReceiveBuffer else bSuccess true else bSuccess true while bSuccess numOfTries 2 else ReinitUSB return bSuccess North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY...

Page 37: ... 2 2 WSAStartup MAKEWORD 2 2 wsaData Create a new socket to make a TCP client connection sock socket AF_INET SOCK_STREAM IPPROTO_TCP setsockopt sock SOL_SOCKET SO_RCVTIMEO char RECEIVE_TIMEOUT sizeof int setsockopt sock SOL_SOCKET SO_SNDTIMEO char SEND_TIMEOUT sizeof int set to no_delay to insure quick ack result setsockopt sock IPPROTO_TCP TCP_NODELAY char NO_DELAY sizeof int Setup a SOCKADDR_IN ...

Page 38: ...BytesRead ETHER_RECV_ERROR return bSuccess strncpy pszReply char aReceiveBuffer nBytesRead bSuccess true return bSuccess int SendEthernetMsg SOCKET s char pszMessage int nMessageLen int ret char sendbuff MSG_MAX_SIZE int nLeft int nIndex int status 0 Copy the data to be sent to the buffer for nIndex 0 nIndex nMessageLen nIndex sendbuff nIndex pszMessage nIndex nLeft nMessageLen nIndex 0 while nLef...

Page 39: ...ge ret We don t know the exact size of each message for API we know that it won t exceed RECV_MSG_MAX_SIZE bytes nMessageLenToBeRead nLeft nLeft 0 got SOCKET_ERROR else status ETHER_RECV_ERROR break if nIndex 0 nMessageLen nIndex status ETHER_SUCCESS SUCCESS else status ETHER_RECV_ERROR ERROR return status North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide...

Page 40: ... interface that handles the language syntax to communicate with the unit The function lists provided in this Dynamic link library DLL is described in Function Reference Manual for 8810A North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 40 of 50 8810A Programmer s ...

Page 41: ... Web site http www microsoft com downloads 8810A Programmer s Choose the communication interface to the API 8810A Connection Status Option to show the command string and any errors in the tab labeled Command Sent Choose the IEEE Language to communicate with API 8810A Gets Sets the API 8810A Communication Setup Note communication to API 8810A must first be established Scans for API 8810A devices co...

Page 42: ...uency 400 Hz Ref Out Not Available When checked angle data for Channel 1 and Channel 2 will be written to the file specified during Cont Read mode The data is written as follows tab delimited 1 230 2710 314 4984 2 231 2988 316 3996 3 232 1987 319 0801 4 233 0217 322 1867 5 233 6806 325 3922 6 234 2289 328 4045 7 234 6222 330 6965 8 234 9082 332 2267 9 235 0213 332 8417 North Atlantic Industries In...

Page 43: ...nly when the API 8810A unit is set for Remote mode with specified communication interface IEEE USB or Ethernet North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 43 of 50 8810A Programmer s ...

Page 44: ...ote enable of the Dual Chan Angle Diff configuration the API 8810A unit will automatically show the Dual Channel Screen The angle value shown for Channel 2 represents the angle difference between the angle readings for Channel 1 and Channel 2 North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii...

Page 45: ...ile are overwritten Set Start Recording and Clear Recording are allowed only when the API 8810A unit is set for Remote mode with specified communication interface IEEE USB or Ethernet Upon receiving a remote Start or Stop Recording command the API 8810A unit will automatically show the Chart screen North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wil...

Page 46: ...tory Default Values are allowed only when the API 8810A unit is set for Remote mode with specified communication interface IEEE USB or Ethernet North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 46 of 50 8810A Programmer s ...

Page 47: ...tines to retrieve the data for both channels using the query command that returns data for channels North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0 2 Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 47 of 50 8810A Programmer s ...

Page 48: ... 0 2 8810A Programmer s Reference Guide 110 Wilbur Place Bohemia NY 11716 www naii com e mail sales naii com Page 48 of 50 Commands sent to the API 8810A as well as the results from performing a call to the API8810A Dll s API8810A_GetErrors method to retrieve any messages from the Error Queue ...

Page 49: ...nd the file CyUSB inf with your mouse select the file and right click on this file You should see Install as an option Click on the Install menu After installation power up the API 8810 unit and connect the USB cable from your machine to the unit Using Device Manager My Computer Properties Hardware Device Manager check that the installation is correct by looking at the Universal Serial Bus control...

Page 50: ...nition gc 2 0 0 2 Dec 21 2007 Added remote programmability support for averaging limit testing data buffer control multiple channel data retrieval Updated screen shots for Soft Panel application Removed function reference in API 8810A Dll The functions specified in the Dll have been moved to the Function Reference Manual gc North Atlantic Industries Inc 631 567 1100 631 567 1823 fax Revision 2 0 0...

Reviews:

No comments

Brands by name

Popular brands

Load more brands