PIPLX & PICMLX LabVIEW Function Reference …downloads.pickeringtest.info/.../piplx_picmlx/LabVIEW/piplx_picmlx... · page 1 of 132 . PIPLX & PICMLX LabVIEW Function Reference V1.0.2

page 1 of 132

PIPLX & PICMLX LabVIEW Function Reference V1.0.2 Installed by ClientBridge 1.14.0. Functions listed in alphabetical order PICMLX Connect.vi Connect to a LXI and establish communication.

error in The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

status The status boolean is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

code The code input identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

source The source string describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Board Network adapter used for connection.

Remote Port Connection port of remote LXI.

Timeout Connection timeout in milliseconds.

Remote Machine IP or internet address of the remote LXI

error out The error out cluster passes error or warning information out of a VI to be used by other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.



source The source string describes the origin of the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the

page 2 of 132

error displayed.

Session Handle of session.

PICMLX Disconnect.vi Disconnect from LXI.





Session Handle of current session.





PICMLX Echo Broadcast.vi Send a broadcast message to a all LXI in current subnet. For getting information about available LXIs you must use VIs PICMLX_GetAvailableLXICount and PICMLX_GetAvailableLXIEntry.

page 3 of 132





Listen Port LXI listen port for broadcast messages.

Timeout Listening timeout for receiving information from LXIs.





Available LXIs Count of available LXIs.

PICMLX Echo Direct.vi Send a direct inquiry to a LXI for getting information. If LXI is available, then you can get information about LXI in 'LXIEntry' structure. If you pass a null as a LXIEntry variable, you can only find out if a LXI is available (return value is zero).s

page 4 of 132





Remote Port Connection port of remote LXI.


Remote Machine IP address or network name of the LXI





Port Communication port for connection

IP adress IP adress of the LXI

LXI description Descpription of the LXI

page 5 of 132

Card Count Number of cards present in LXI

Client Count Number of client connected to the LXI

Opened Card Count Number of cards opened on the LXI

PICMLX Get Active Session.vi Gets active session for using.


error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.




Session out Handle of current session.





page 6 of 132

New Session New session ID.

Token Unique confirmation token.

PICMLX Get Available LXI Count.vi Returns count of available LXIs if any. PICMLX_EchoBroadcast must be called first.









LXI count Number of LXI found by broadcast function

PICMLX Get Available LXI Entry.vi Receive information about LXI by index.

page 7 of 132





Index Index of LXI to get infromation for starting with 0.





Port Communication port for connection

IP adress IP adress of the LXI

LXI description Descpription of the LXI

Card Count Number of cards present in LXI

Client Count Number of clients connected to LXI

page 8 of 132

Opened Card Count Number of cards opened on LXI

PICMLX Get Card Sessions Count.vi Gets number of sessions which use given card.





Input Handle Handle combining session handle and card handle.

Session

Card number





Count Variable to receive a number of sessions which uses given card.

page 9 of 132

Output Handle Handle combining session handle and card handle.

Session

Card number

PICMLX Get Connected Card Clients.vi Gets clients which use a specific card on the LXI remotely.





Length Length of character string buffer.


Session

Card number




source The source string describes the origin of the error or warning.

page 10 of 132

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

Clients List of clients separated by ; in form: count - hostname, where count is number of connections coming from the hostname.


Session

Card number

PICMLX Get Connected Clients.vi Gets clients which communicates with the LXI remotely.





Length Length of character string buffer.





page 11 of 132


Clients List of clients separated by ; in form: count - hostname, where count is number of connections coming from the hostname.

Session Out Handle of current session.

PICMLX Get Count Card Type.vi Returns count of cards by card type.






Type Type of card.





page 12 of 132

error displayed.


Card Count Handle of current session.

PICMLX Get Foreign Sessions.vi Gets used foreign sessions of active session.






Max number of Sessions Variable containing maximum of sessions for which information is to be obtained.





page 13 of 132

Sessions One-dimensional array (vector) to receive sessions.

Numeric

Number of Sessions Number of filled sesions.


PICMLX Get Sessions Count.vi Gets number of all live sessions.










page 14 of 132

Count Variable to receive a number of all live sessions.


PICMLX Get Total Cards Count.vi Gets number of all cards (no mater on type of card).










Count variable to receive a number of all cards.


page 15 of 132

PICMLX Get Total Modules Count.vi Gets number of all active modules.










Count Variable to receive a number of all active modules.


PICMLX Get Total Opened Cards.vi Gets number of all opened cards (no matter on type of card).

page 16 of 132










Count Variable to receive a number of all opened cards.


PICMLX Get Usable Cards.vi Gets usable cards.

error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

page 17 of 132






Max number of cards Variable containing maximum of cards for which information is to be obtained.





Cards One-dimensional array (vector) to receive cards' IDs.

Numeric

Number of Cards Number of filled cards.


PICMLX Get Used Cards.vi Gets used cards.

error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other

page 18 of 132

VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.





Max number of cards Variable containing maximum of cards for which information is to be obtained.





Cards One-dimensional array (vector) to receive cards' IDs.

Numeric

Number of Cards Number of filled cards.


PICMLX Get version.vi Returns version of Picmlx.dll library.

error in (no error) The error in cluster can accept error information wired from VIs previously called.

page 19 of 132

Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.








Version Version of Picmlx.dll library.

PICMLX Has Exclusive Access.vi Tests whether the card is opened for exclusive access or not.


status The status boolean is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning.

page 20 of 132




Owner Type Owner type consists of these flags: 1 Cards owned by current session 2 Cards owned by session, that is shared 4 Cards owned by different sessions


Session

Card number





Is Esclusive True if the card is opened for exclusive access; otherwise false.


Session

Card number

PICMLX Is Card Used.vi Tests whether the card is used or not.

error in (no error) The error in cluster can accept error information wired from VIs previously called.

Use this information to decide if any functionality should be bypassed in the event of errors from other

page 21 of 132





Owner Type Owner type consists of these flags: 1 Cards owned by current session 2 Cards owned by session, that is shared 4 Cards owned by different sessions


Session

Card number





Is Used True if the card is already used; otherwise false.


Session

Card number

page 22 of 132

PICMLX Lock Device.vi Locks the LXI device so that no other client can open card (s). Clients which sooner opened card(s) or client with access „for read“ can still communicate with LXI device or client with lock can do with the LXI device. Others have to wait until client with lock call s unlock function. Lock function tries to get the lock on LXI device. All calling process is blocked and wait on lock by timeout.






Timeout Timeout for lock operation in miliseconds.






PICMLX Release Card.vi Alternative way to close a card. This VI is complement to UseCard VI, but can also close cards opened via OpenCard VI.

page 23 of 132






Card ID






PICMLX Release Cards.vi Alternative way to close cards. This VI is complement to UseCard VI, but can also close cards opened via OpenCard VI. This VI closes all cards of 743 type in target system.

page 24 of 132











PICMLX Release Foreign Session.vi Releases used foreign session.


error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error

page 25 of 132

displayed.




Used Session Used session ID.






PICMLX SbVersion.vi Returns a version of ServerBridge on LXI device.



page 26 of 132








SB Version The ServerBridge version code, multiplied by 100 (i.e. a value of 100 represents version 1.00) or -1 if error occured.


PICMLX Unlock Device.vi Releases the lock and another client can get a lock or can communicate with LXI device. The lock is released if connection between Client and Server is unexpectedly interrupted.




page 27 of 132








PICMLX Use Card.vi Alternative way to open a card. Instead of using bus/device pair, use index of card. This VI also allows to change rights to the card (see Exclusive control). This card can be already opened by driver (using UseCard or OpenCard VIs).





page 28 of 132

Exclusive Can be on of: 1 Card can be opened by other users 2 Exclusive access. Operation fails, if card is already opened for multi access. 3 Exclusive access. Operation succeeds, if card is already opened for multi access.


Card ID Handle of current session.






PICMLX Use Cards.vi Alternative way to open a card. Instead of using bus/device pair, use index of card. This VI also allows to change rights to the card (see Exclusive control). This card can be already opened by driver (using UseCard or OpenCard VIs). This VI opens all 743 cards in target system (PXI or LXI).




page 29 of 132



Exclusive Can be on of: 1 Card can be opened by other users 2 Exclusive access. Operation fails, if card is already opened for multi access. 3 Exclusive access. Operation succeeds, if card is already opened for multi access.






PICMLX Use Foreign Session.vi Adds another session ID to actual session.





page 30 of 132


New Session New session ID.

Token Unique confirmation token.






PIPLX Attenuator Info.vi Obtains a description of an attenuator sub-unit, as numeric values.





page 31 of 132

error displayed.

Output Subunit Subunit number.


Session

Card number





Type Number Type code.

Number Steps Step count.

Step Size Step size, in dB.


Session

Card number

PIPLX Attenuator Pad Value.vi Obtains the attenuation value of a numbered pad. This function facilitates explicit pad selection using PIPLX_OpBit or PIPLX_WriteSub, if the selections made by PIPLX_attenSetAttenuation are not optimal for the application. The number of pads in the sub-unit can be found using PIPLX_SubInfo.



page 32 of 132





Pad Number Pad number.


Session

Card number





Attenuation Pad's attenuation value, in dB.


Session

Card number

PIPLX Attenuator Type.vi Obtains a description of an attenuator sub-unit, as a text string. The format of the result is "ATTEN(<number of steps>,<step size in dB>". The description obtained by this VI is a logical one; a physical description indicating the number of discrete pads employed in the attenuator can be obtained using PIPLX Subunit Type.vi.s

page 33 of 132





Subunit Subunit number.


Session

Card number





Type String containing description of the subunit of the card.


Session

page 34 of 132

Card number

PIPLX Batt Get Current.vi Get Battery Simulator (BATT type) channel sink current

Subunit sub-unit of target to access (unity-based)


Session

Card number





Current variable to receive the current currently set (in Amps)


Session

Card number



code The code input identifies the error or warning. The pop-up option Explain Error (or Explain Warning) gives more information about the

page 35 of 132

error displayed.


PIPLX Batt Get Enable.vi Get Battery Simulator (BATT type) channel output enable states



Session

Card number





Pattern variable to receive the pattern of channel outputs currently enabled ('1' bit indicates corresponding channel is enabled)


Session

Card number


status The status boolean is either TRUE (X) for an error, or FALSE (checkmark) for no error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the

page 36 of 132

error displayed.



PIPLX Batt Get Voltage.vi Get Battery Simulator (BATT type) channel output voltage



Session

Card number





Voltage variable to receive the voltage currently set (in Volts)


Session

Card number


page 37 of 132




PIPLX Batt Read Interlock State.vi Get Battery Simulator (BATT type) interlock state



Session

Card number





Interlock variable to receive the interlock state


Session

Card number

page 38 of 132





PIPLX Batt Set Current.vi Set Battery Simulator (BATT type) channel sink current

Subunit When Subunit corresponds to a BATT sub-unit, the function sets the sink current of that sub-unit alone.If Subunit = 0 (BATT_ALL_BATT_SUB_UNITS), all of the card's BATT sub-units are set to the given current.

Current the current to set (in Amps)


Session

Card number





page 39 of 132


Session

Card number





PIPLX Batt Set Enable.vi Set Battery Simulator (BATT type) channel output enable states

Subunit When SubNum corresponds to a BATT sub-unit, the function sets the output enable state of that sub-unit alone according to the least significant bit of Pattern (0 = OFF, 1 = ON). If SubNum = 0 (BATT_ALL_BATT_SUB_UNITS), enable states of all the card's BATT sub-units are set; bits in the supplied Pattern are utilised in ascending order of BATT sub-unit, i.e.

Pattern the pattern of channel outputs to enable ('1' bit enables corresponding channel)


Session

Card number



page 40 of 132




Session

Card number





PIPLX Batt Set Voltage.vi Set Battery Simulator (BATT type) channel output voltage

Subunit When Subunit corresponds to a BATT sub-unit, the function sets the voltage of that sub-unit alone.If Subunit = 0 (BATT_ALL_BATT_SUB_UNITS), all of the card's BATT sub-units are set to the given voltage.

Voltage the voltage to set (in Volts)


Session

Card number


page 41 of 132





Session

Card number





PIPLX Card Id.vi Obtains the identification string of the specified card. The string contains these elements: "model code;serial number;revision code" The <revision code> value represents the hardware version of the unit - cards have no firmware on-board.


status The status boolean is either TRUE (X) for an error, or FALSE (checkmark) for no

page 42 of 132

error or a warning. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.




Session

Card number





Card ID String containing card identification.


Session

Card number

PIPLX Card Loc.vi Obtains the location of the specified card in terms of the logical PCI bus and device number in which it is located. These values can be cross-referenced to physical slot locations in a particular system.

error in The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

page 43 of 132






Session

Card number





Bus Logical PCI bus number of the card.

Slot Logical PCI device number of the card.


Session

Card number

PIPLX Card Ops Count.vi Returns count of switched relays from operation system start.

page 44 of 132






Session

Card number





Count Number of operations.


Session

Card number

page 45 of 132

PIPLX Clear All.vi Clears (disconnects) all outputs of all sub-units of all opened Pickering card.





Input handles Handles for all opened cards.

Output Handle Output handles for all opened cards.

Session

Card number





Output handles Output handles for all opened cards.


Session

page 46 of 132

Card number

PIPLX Clear Card.vi Clears (disconnects) all outputs of all sub-units of the specified Pickering card.






Session

Card number






Session

page 47 of 132

Card number

PIPLX Clear Mask.vi Clears a sub-unit's switch mask, enabling operation of all outputs by the PIPLX OpenClose Bit.vi, PIPLX OpenClose Crosspoint.vi and PIPLX Write Subunit.vi VIs.







Session

Card number





page 48 of 132


Session

Card number

PIPLX Clear Subunit.vi Clears (disconnects) all outputs of a subunit.







Session

Card number





page 49 of 132

error displayed.


Session

Card number

PIPLX Close Cards.vi Closes all open Pickering cards, which must have been opened using OpenCards. This VI should be called when the application program has finished using them.





Input handles Handles for all opened cards.


Session

Card number




page 50 of 132



PIPLX Close Specified Card.vi Closes the specified Pickering card, which must have been opened using OpenSpecifiedCard. This VI should be called when the application program has finished using the card.






Session

Card number





page 51 of 132

error displayed.

Session

PIPLX Close.vi Closes module previously opened with PIPLX_Init.






Session

Card number





PIPLX Closure Limit.vi

page 52 of 132

Obtains the maximum number of switches that may be activated simultaneously in the specified sub-unit. A single-channel multiplexer (MUX type) allows only one channel to be closed at any time. In some other models such as high-density matrix types a limit is imposed to prevent overheating; although it is possible to disable the limit for these types (see PIPLX Set Mode.vi), doing so is not recommended.





Output Subunit Output subunit.


Session

Card number





Closure Limit Closure Limit


page 53 of 132

Session

Card number

PIPLX Count Free Cards.vi Obtains the number of installed cards that are operable by the Piplx driver but are not currently opened by it.










Num Cards Number of available cards.


page 54 of 132

PIPLX Diagnostic.vi Obtains the diagnostic string of the specified card, giving expanded information on any fault conditons indicated by the PIPLX Status.vi value.






Session

Card number





Diag Result Diagnostic string.


Session

page 55 of 132

Card number

PIPLX Enumerate Subs.vi Obtains the numbers of input and output sub-units implemented on the specified card.






Session

Card number





In Subunits Number of input subunits.

Out Subunits Number of output subunits.

page 56 of 132


Session

Card number

PIPLX Error Converter.vi This VI converts error codes from VXIPnp instrument driver to standard LabVIEW error codes. If an error is detected the VI builds the appropriate error cluster that is readable by one of the error handlers supplied with LabVIEW.





CVI error code I32 Error code returned from a VXIPnp instrument driver operation.

VI name





page 57 of 132

PIPLX Find Free Cards.vi Obtains the logical bus and slot locations of installed cards that are operable by the Piplx driver and are currently unopened. These values are used with PIPLX Open Specified Card.vi.










Bus List List of bus numbers for free cards.

Slot List List of device numbers for free cards.

page 58 of 132


PIPLX Get Attenuation.vi Obtains the current attenuation setting.







Session

Card number





Attenuation Attenuation value, in dB.

page 59 of 132


Session

Card number

PIPLX Get Attribute DWORD.vi Obtains the value of DWORD-type attribute.






Attribute Code Code of DWORD attribute.

Output subunit True for output subunit, false for input subunit.


Session

Card number



code The code input identifies the error or warning.

page 60 of 132



Value Value of attribute.


Session

Card number

PIPLX Get Chassis Fan Speeds.vi Gets all monitored fan speed values of the LXI chassis.






Max number of speeds Variable containing maximum of values for which information is to be obtained.



page 61 of 132

error displayed.



Speeds One-dimensional array (vector) to receive temperature values.

Numeric

Number of speeds Number of filled values.


PIPLX Get Chassis Temperatures.vi Gets all monitored temperatures of the LXI chassis.






Max number of speeds Variable containing maximum of values for which information is to be obtained.



page 62 of 132




Temperatures One-dimensional array (vector) to receive temperature values.

Numeric

Number of temperatures Number of filled values.


PIPLX Get Chassis Voltage.vi Gets all monitored voltages values of the LXI chassis.






Max number of values Variable containing maximum of values for which information is to be obtained.

error out The error out cluster passes error or warning information out of a VI to be used by other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error

page 63 of 132

displayed.




Voltages One-dimensional array (vector) to receive voltage values.

Numeric

Number of voltages Number of filled values.


PIPLX Get Last Error Code.vi Returns last occured error code.







page 64 of 132




Error Code Last error code.


PIPLX Get Resistance.vi Obtains the current resistance setting of the specified programmable resistor. This function is only usable with programmable resistor models that support it, such as 40-260-001.







Session

Card number


page 65 of 132





Session

Card number

Resistance Current resistance set.

PIPLX Get Status Message.vi Returns message status of CERN board/cards/selftest






Card number Card number

Buffer length Length of Status message string

error out The error out cluster passes error or warning information out of a VI to be used by other VIs.

page 66 of 132






Status message Status message

PIPLX Get Version.vi Returns a version of library.







page 67 of 132



Library Version Version number of piplx library.

PIPLX Handle in.vi

Input Handle

Session

Card number

Session

Card number

PIPLX Handle out.vi

Session

Card number

Output Handle

Session

Card number

PIPLX Identify.vi Identify chassis VI.



page 68 of 132

error displayed.



Identify (1) 0 - disable identify feature, 1 - enable identify feature







PIPLX Init.vi Open an instrument specified by alias. The alias must be defined in resource database created using Pickering resource manager.




page 69 of 132



Alias Alias representing device to open. This alias needs to be defined in resource database generated using Pickering resource manager.

Storage File name of resource database created using Pickering resource manager. This needs to be full path to file containing database. If empty, local resource database is used.

Access Can be on of: 1 Card can be opened by other users 2 Exclusive access. Operation fails, if card is already opened for multi access. 3 Exclusive access. Operation succeeds, if card is already opened for multi access.







Session

Card number

PIPLX Op Bit.vi Operate a single output channel or bit. Note that in the case of a single-channel multiplexer (MUX type) any existing channel closure will be cleared automatically prior to selecting the new channel. Note that OpCrosspoint allows more straightforward use of row/column co-ordinates with matrix sub-units.

error in The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

page 70 of 132






Bit Number Bit number.

Action True to close relay, False to open relay.


Session

Card number






Session

Card number

PIPLX Op Crosspoint.vi

page 71 of 132

Operate a single matrix crosspoint.






Row Crosspoint row (Y) location.

Column Crosspoint column (X) location.

Action True to close relay, False to open relay.


Session

Card number





page 72 of 132



Session

Card number

PIPLX Op Switch.vi This VI obtains, and optionally sets, the state of a switch. It allows explicit access to the individual switches making up a sub-unit, in types where their operation is normally handled automatically by the driver. The main purpose of this is in implementing fault diagnostic programs for such types; it can also be used where normal automated behaviour does not suit an application.






SwitchFunc Code indicating the functional group of the switch.

SegNum The segment location of the switch.

SwitchNum The number of the switch in its functional group (unity-based).

SubSwitch The number of the subswitch to operate (unity-based).


Session

Card number

page 73 of 132

Action Action of operation (query/open switch/close switch)





State True - closed relay, False - opened relay.


Session

Card number

PIPLX Open Cards For Read.vi Opens cards only for read. See PIPLX Open Cards.vi.





page 74 of 132






Output handles


Session

Card number

Opened cards Number of opened cards using OpenCards VI.

PIPLX Open Cards.vi Locates and opens all installed Pickering cards. Once cards have been opened, other VIs may then be used to access cards by their handles. If cards are currently opened by some other program they cannot be accessed and the VI returns error.





page 75 of 132

error displayed.






Output handles Output handles for all opened cards.


Session

Card number

Opened cards Number of opened cards using OpenCards VI.

PIPLX Open Specified Card For Read.vi Opens cards only for read. See PIPLX Open Specified Card.vi.





page 76 of 132



Bus The card's logical bus location.

Slot The card's logical device location.






Session

Card number

PIPLX Open Specified Card.vi Opens the specified Pickering card. Once a card has been opened, other driver VIs may then be used to access it. If the card is currently opened by some other program it cannot be accessed and the VI returns an error.




page 77 of 132



Bus The card's logical bus location.

Slot The card's logical device location.






Session

Card number

PIPLX Power Cycle.vi Perform reset. Hard reset means power down and stay down, soft reset means power cycle.




page 78 of 132


Mode (1) Chassis power mode. (0 - for power down, 1 - for reboot or power cycle)







PIPLX PSU Enable.vi Enables or disables a power supply's output. This VI is usable only with sub-units having the capability PSU_CAP_OUTPUT_CONTROL - see PIPLX PSU Info.vi.





page 79 of 132

error displayed.


State True = enable, False = disable


Session

Card number






Session

Card number

PIPLX PSU Get Voltage.vi Obtains the voltage setting of a power supply sub-unit. The result is the nominal value to which the output has been let, not necessarily the actual voltage being output (which may be affected by device tolerances, current-limit conditions etc.). This VI is also usable with fixed-voltage supplies, returning the nominal output voltage.



page 80 of 132





Session

Card number





Voltage Output setting, in Volts.


Session

Card number

PIPLX PSU Info.vi Obtains a description of a power supply sub-unit, as numeric values. Power supply sub-unit type code is: 9 - TYPE_PSUDC (DC power supply) Certain driver VIs are only usable with sub-units having appropriate capabilities - examples being: PIL_PsuEnable PIL_PsuSetVoltage

page 81 of 132







Session

Card number





Type Number Type code.

Voltage Rated voltage (in Volts).

page 82 of 132

Current Rated current (in Amps).

Precision Precision (in bits, meaningful only for programmable supplies).

Capabilities Capability flag bit definitions: 0x00000010 - PSU_CAP_CURRENT_MODE_SENSE (can sense if operating in current-limited mode) 0x00000008 - PSU_CAP_PROG_CURRENT (output current is programmable) 0x00000004 - PSU_CAP_PROG_VOLTAGE (output voltage is programmable) 0x00000002 - PSU_CAP_OUTPUT_SENSE (has logic-level sensing of output active state) 0x00000001 - PSU_CAP_OUTPUT_CONTROL (has output on/off control)


Session

Card number

PIPLX PSU Set Voltage.vi Sets the output voltage of a power supply sub-unit to the specified value. The voltage value specified is rounded to the precision of the supply's DAC. The actual voltage setting can be obtained using PIPLX PSU Get Voltage.vi. This VI is usable only with sub-units having the capability PSU_CAP_PROG_VOLTAGE - see PIPLX PSU Info.vi.






Voltage The output voltage to set, in Volts.


Session

Card number


page 83 of 132






Session

Card number

PIPLX PSU Type.vi Obtains a description of a power supply sub-unit, as a text string. For a DC power supply the format of the result is "PSUDC(<rated voltage>,<rated current>)".





Subuni Subunit number.


Session

Card number

page 84 of 132





Type String containing description of the subunit of the card.


Session

Card number

PIPLX Read Bit.vi Obtains the state of an individual input.





Input Subunit Subunit number.

page 85 of 132



Session

Card number





State True = logical 1, False = logical 0


Session

Card number

PIPLX Read Calibration Data.vi Reads a 16-bit calibration value from on-card EEPROM. The driver places no interpretation on the value obtained - an application program can utilise it in any way it wishes.




page 86 of 132




Index Calibration value index.


Session

Card number





Data Calibration value.


Session

Card number

PIPLX Read Calibration DataFP.vi Reads one or more floating-point calibration values from on-card EEPROM.

error in The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error

page 87 of 132

displayed.






Session

Card number

Store Value indicating which store to access

Offset the offset in the sub-unit's calibration store at which to start

Num Values The number of values to be written






Session

Card number

Data Array containing values to write

page 88 of 132

Num Values 2 The number of values to be written

PIPLX Read Calibration Date.vi Reads a sub-unit's calibration date and interval from on-card EEPROM.







Session

Card number






page 89 of 132



Session

Card number

Year Year of calibration

Day Day of calibration

Interval Calibration interval (in days)

PIPLX Read Input Subunit.vi Obtains the current state of all inputs of a sub-unit.







Session

Card number



page 90 of 132

error displayed.




Session

Card number

Data One-dimensional array (vector) to receive the result.

Numeric

PIPLX Read Subunit.vi Obtains the current state of all inputs of a sub-unit. Usable only for sub-units lower or equal to 32 bits.







Session

Card number

error out The error out cluster passes error or warning information out of a VI to be used by other

page 91 of 132





Data Bit pattern of input subunit.


Session

Card number

PIPLX Resistor Info.vi Obtains a description of a sub-unit, as numeric values. Output sub-unit type codes are: 1 - TYPE_SW (uncommitted switch) 2 - TYPE_MUX (multiplexer single-channel) 3 - TYPE_MUXM (multiplexer, multi-channel) 4 - TYPE_MAT (matrix - LF) 5 - TYPE_MATR (matrix - RF) 6 - TYPE_DIG (digital outputs) 7 - TYPE_RES (programmable resistor) 8 - TYPE_ATTEN (programmable attenuator) 9 - TYPE_PSUDC (DC power supply) Input sub-unit type codes are: 1 - INPUT Row and column values give the dimensions of the sub-unit. For all types other than matrices the column value contains the significant dimension: their row value is always '1'.

error in The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error

page 92 of 132

displayed.






Session

Card number






Session

Card number

Minimum Resistance variable to receive minimum resistance setting.

Maximum Resistance variable to receive maximum resistance setting.

Reference Resistance variable to receive reference resistance value.

Percentage Precision variable to receive percentage precision value.

page 93 of 132

Offset Precision (ohms) variable to receive offset precision, in ohms.

Int1 currently unused variable.

Capabilities variable to receive capability flags If capability RES_CAP_ZERO is flagged a setting of "zero ohms" is also possible. If RES_CAP_INF is flagged an open-circuit setting is also possible. If capability RES_CAP_REF is flagged, RefRes is the reference resistance value - such as in model 40-265, where it gives the balanced state resistance.

Internal Precision internal precision, in ohms.

PIPLX Set Attenuation.vi Sets the attenuation to the specified value. The combination of pads inserted to achieve the desired attenuation level is determined by the driver for best all-round performance. In some models it may be possible to optimise particular aspects of attenuator performance by setting other pad combinations explicitly using PIPLX_OpBit or PIPLX_WriteSub. The pad value associated with each output channel can be discovered with PIPLX_AttenPadValue.s






Attenuation The attenuation value to be set, in dB.


Session

Card number


page 94 of 132





Session

Card number

PIPLX Set Attribute DWORD.vi Set DWORD-type attribute value.






Value Value of attribute to set.

Attribute Code Code of DWORD attribute.

Output subunit True for output subunit, false for input subunit.

page 95 of 132


Session

Card number






Session

Card number

PIPLX Set Chassis Fan Speeds.vi Gets all monitored fan speed values of the LXI chassis.





page 96 of 132


Max speed 1 for max speed. 0 for automatic speed.






PIPLX Set Mode.vi Allows control flags affecting the driver's global behaviour to be set and read. This VI gives accessto low-level control features of the Pilpxi driver and is intended for 'expert' use only - the default driver behaviour should be satisfactory for the great majority of applications: MODE_DEFAULT = 0x00000000UL, // Default, no special modes set MODE_NO_WAIT = 0x00000001UL, // Function calls exclude output settling delay MODE_UNLIMITED = 0x00000002UL, // Disable maximium closure limits MODE_REOPEN = 0x00000004UL, // Allow re-open without clearing cards MODE_IGNORE_TEST = 0x00000008UL // Enable card operation even if selftest fails





page 97 of 132



Mode Flags New value for driver mode flags.





Old mode The driver's mode flags prior to executing this function


PIPLX Set Resistance.vi Sets a programmable resistor to the closest available setting to the value specified. This function is only usable with programmable resistor models that support it, such as 40-260-001.





page 98 of 132



Session

Card number

Resistance The resistance value to set

Mode A value indicating how the given resistance value is to be applied.






Session

Card number

PIPLX Settle Time.vi Obtains a sub-unit's settling time (the period taken for its switches to stabilise). By default, Piplx driver VIs retain control during this period so that switches are guaranteed to have stabilised on completion. This mode of operation can be overriden if required - see PIPLX Set Mode.vi.



page 99 of 132





Session

Card number





Settling Time Settling time of relays on subunit.


Session

Card number

PIPLX Status Code To Message.vi Convert PILPXI status code to message.



page 100 of 132




Status Code Status code to convert.





Status Message String containing the status message.

PIPLX Status.vi Obtains the current status flags for the specified card. Status bits are as follows: 0x80000000 - STAT_NO_CARD (no card with specified number) 0x40000000 - STAT_WRONG_DRIVER (card requires newer driver) 0x20000000 - STAT_EEPROM_ERR (card EEPROM fault) 0x10000000 - STAT_DISABLED (card disabled) 0x04000000 - STAT_BUSY (card operations not completed) 0x02000000 - STAT_HW_FAULT (card hardware defect) 0x01000000 - STAT_PARITY_ERROR (PCIbus parity error) 0x00000000 - STAT_OK (card functional and stable)


page 101 of 132





Session

Card number





Status Obtains the current status flags for the specified card. Status bits are as follows: 0x80000000 - STAT_NO_CARD (no card with specified number) 0x40000000 - STAT_WRONG_DRIVER (card requires newer driver) 0x20000000 - STAT_EEPROM_ERR (card EEPROM fault) 0x10000000 - STAT_DISABLED (card disabled) 0x04000000 - STAT_BUSY (card operations not completed) 0x02000000 - STAT_HW_FAULT (card hardware defect) 0x01000000 - STAT_PARITY_ERROR (PCIbus parity error) 0x00000000 - STAT_OK (card functional and stable)


Session

Card number

page 102 of 132

PIPLX Subunit Attribute.vi Obtains the value of a sub-unit property. These values facilitate operation using PIPLX OpenClose Switch.vi. AttrCode: 1 - SUB_ATTR_CHANNEL_SUBSWITCHES - Gets number of subswitches per logical channel (matrix crosspoint) 2 - SUB_ATTR_X_ISO_SUBSWITCHES - Gets number of subswitches per logical X-isolator 3 - SUB_ATTR_Y_ISO_SUBSWITCHES - Gets number of subswitches per logical Y-isolator 4 - SUB_ATTR_X_LOOPTHRU_SUBSWITCHES - Gets number of subswitches per logical X-loopthru 5 - SUB_ATTR_Y_LOOPTHRU_SUBSWITCHES - Gets number of subswitches per logical Y-loopthru 0x100 - SUB_ATTR_NUM_X_SEGMENTS - Gets number of X-axis segments 0x101 - SUB_ATTR_X_SEGMENT01_SIZE - Gets size of X-axis segment 1 0x102 - SUB_ATTR_X_SEGMENT02_SIZE - Gets size of X-axis segment 2 0x103 - SUB_ATTR_X_SEGMENT03_SIZE - Gets size of X-axis segment 3 0x104 - SUB_ATTR_X_SEGMENT04_SIZE - Gets size of X-axis segment 4 0x105 - SUB_ATTR_X_SEGMENT05_SIZE - Gets size of X-axis segment 5 0x106 - SUB_ATTR_X_SEGMENT06_SIZE - Gets size of X-axis segment 6 0x107 - SUB_ATTR_X_SEGMENT07_SIZE - Gets size of X-axis segment 7 0x108 - SUB_ATTR_X_SEGMENT08_SIZE - Gets size of X-axis segment 8 0x109 - SUB_ATTR_X_SEGMENT09_SIZE - Gets size of X-axis segment 9 0x10A - SUB_ATTR_X_SEGMENT10_SIZE - Gets size of X-axis segment 10 0x10B - SUB_ATTR_X_SEGMENT11_SIZE - Gets size of X-axis segment 11 0x10C - SUB_ATTR_X_SEGMENT12_SIZE - Gets size of X-axis segment 12 0x200 - SUB_ATTR_NUM_Y_SEGMENTS - Gets number of Y-axis segments 0x201 - SUB_ATTR_Y_SEGMENT01_SIZE - Gets size of y-axis segment 1 0x202 - SUB_ATTR_Y_SEGMENT02_SIZE - Gets size of y-axis segment 2





Subunit Number of subunit.


Session

Card number

Output True = output subunit,

page 103 of 132

false = input subunit

Attribute code AttrCode: 1 - SUB_ATTR_CHANNEL_SUBSWITCHES - Gets number of subswitches per logical channel (matrix crosspoint) 2 - SUB_ATTR_X_ISO_SUBSWITCHES - Gets number of subswitches per logical X-isolator 3 - SUB_ATTR_Y_ISO_SUBSWITCHES - Gets number of subswitches per logical Y-isolator 4 - SUB_ATTR_X_LOOPTHRU_SUBSWITCHES - Gets number of subswitches per logical X-loopthru 5 - SUB_ATTR_Y_LOOPTHRU_SUBSWITCHES - Gets number of subswitches per logical Y-loopthru 0x100 - SUB_ATTR_NUM_X_SEGMENTS - Gets number of X-axis segments 0x101 - SUB_ATTR_X_SEGMENT01_SIZE - Gets size of X-axis segment 1 0x102 - SUB_ATTR_X_SEGMENT02_SIZE - Gets size of X-axis segment 2 0x103 - SUB_ATTR_X_SEGMENT03_SIZE - Gets size of X-axis segment 3 0x104 - SUB_ATTR_X_SEGMENT04_SIZE - Gets size of X-axis segment 4 0x105 - SUB_ATTR_X_SEGMENT05_SIZE - Gets size of X-axis segment 5 0x106 - SUB_ATTR_X_SEGMENT06_SIZE - Gets size of X-axis segment 6 0x107 - SUB_ATTR_X_SEGMENT07_SIZE - Gets size of X-axis segment 7 0x108 - SUB_ATTR_X_SEGMENT08_SIZE - Gets size of X-axis segment 8 0x109 - SUB_ATTR_X_SEGMENT09_SIZE - Gets size of X-axis segment 9 0x10A - SUB_ATTR_X_SEGMENT10_SIZE - Gets size of X-axis segment 10 0x10B - SUB_ATTR_X_SEGMENT11_SIZE - Gets size of X-axis segment 11 0x10C - SUB_ATTR_X_SEGMENT12_SIZE - Gets size of X-axis segment 12 0x200 - SUB_ATTR_NUM_Y_SEGMENTS - Gets number of Y-axis segments 0x201 - SUB_ATTR_Y_SEGMENT01_SIZE - Gets size of y-axis segment 1 0x202 - SUB_ATTR_Y_SEGMENT02_SIZE - Gets size of y-axis segment 2





Attribute Value Attribute value.


Session

Card number

PIPLX Subunit Info.vi Obtains a description of a sub-unit, as numeric values. Output sub-unit type codes are:

page 104 of 132

1 - TYPE_SW (uncommitted switch) 2 - TYPE_MUX (multiplexer single-channel) 3 - TYPE_MUXM (multiplexer, multi-channel) 4 - TYPE_MAT (matrix - LF) 5 - TYPE_MATR (matrix - RF) 6 - TYPE_DIG (digital outputs) 7 - TYPE_RES (programmable resistor) 8 - TYPE_ATTEN (programmable attenuator) 9 - TYPE_PSUDC (DC power supply) Input sub-unit type codes are: 1 - INPUT Row and column values give the dimensions of the sub-unit. For all types other than matrices the column value contains the significant dimension: their row value is always '1'.






Output Subunit True = output subunit, False = input subunit.


Session

Card number



page 105 of 132





Session

Card number

Rows Row count.

Columns Columns count

TypeNum Type number.

PIPLX Subunit Status.vi Obtains the current status flags for the specified output sub-unit. Status bits associated with significant card-level conditions are also returned. Status bits are as follows: 0x80000000 - STAT_NO_CARD (no card with specified number) 0x40000000 - STAT_WRONG_DRIVER (card requires newer driver) 0x20000000 - STAT_EEPROM_ERR (card EEPROM fault) 0x10000000 - STAT_DISABLED (card disabled) 0x08000000 - STAT_NO_SUB (no sub-unit with specified number) 0x04000000 - STAT_BUSY (sub-unit operations not completed) 0x02000000 - STAT_HW_FAULT (card hardware defect) 0x01000000 - STAT_PARITY_ERROR (PCIbus parity error) 0x00800000 - STAT_PSU_INHIBITED (power supply output is disabled - by software) 0x00400000 - STAT_PSU_SHUTDOWN (power supply output is shutdown - due to overload) 0x00200000 - STAT_PSU_CURRENT_LIMIT (power supply is operating in current-limited mode) 0x00100000 - STAT_CORRUPTED (sub-unit logical state is corrupted) 0x00000000 - STAT_OK (card functional and stable)




page 106 of 132



Session

Card number






Subunit Status Obtains the current status flags for the specified output sub-unit. Status bits associated with significant card-level conditions are also returned. Status bits are as follows: 0x80000000 - STAT_NO_CARD (no card with specified number) 0x40000000 - STAT_WRONG_DRIVER (card requires newer driver) 0x20000000 - STAT_EEPROM_ERR (card EEPROM fault) 0x10000000 - STAT_DISABLED (card disabled) 0x08000000 - STAT_NO_SUB (no sub-unit with specified number) 0x04000000 - STAT_BUSY (sub-unit operations not completed) 0x02000000 - STAT_HW_FAULT (card hardware defect) 0x01000000 - STAT_PARITY_ERROR (PCIbus parity error) 0x00800000 - STAT_PSU_INHIBITED (power supply output is disabled - by software) 0x00400000 - STAT_PSU_SHUTDOWN (power supply output is shutdown - due to overload) 0x00200000 - STAT_PSU_CURRENT_LIMIT (power supply is operating in current-limited mode) 0x00100000 - STAT_CORRUPTED (sub-unit logical state is corrupted) 0x00000000 - STAT_OK (card functional and stable)


Session

Card number

PIPLX Subunit Type.vi Obtains a description of a sub-unit, as a text string.

page 107 of 132

Type strings: INPUT(<size>) - Digital inputs SWITCH(<size>) - Uncommitted switches MUX(<size>) - Multiplexer, single-channel only MUXM(<size>) - Multiplexer, multi-channel MATRIX(<columns>X<rows>) - Matrix, LF MATRIXR(<columns>X<rows>) - Matrix, RF DIGITAL(<size>) - Digital Outputs RES(<number of resistors in chain>) - Programmable resistor ATTEN(<number of pads>) - Programmable attenuator PSUDC(0) - DC Power Supply






Output Subunit True = output subunit, False = input subunit.


Session

Card number




page 108 of 132



Type String containing type of subunit.


Session

Card number

PIPLX TC Get Voltage.vi Obtains the voltage setting of a thermocouple channel in milivolts.







Session

Card number



page 109 of 132




Voltage Output setting, in miliovolts.


Session

Card number

PIPLX TC Set Voltage.vi Sets the output voltage of a thermocouple channel. Value is in milivolts.






Voltage The output voltage to set, in milivolts.


Session

Card number

error out The error out cluster passes error or warning information out of a VI to be used by other

page 110 of 132






Session

Card number

PIPLX View Bit.vi Obtains the state of an individual output.








page 111 of 132

Session

Card number







Session

Card number

PIPLX View Crosspoint.vi Obtains the state of an individual matrix crosspoint.





page 112 of 132






Session

Card number







Session

Card number

PIPLX View Mask Bit.vi Obtains the state of an individual output's mask.



page 113 of 132







Session

Card number





State True = masked, False = not masked


Session

Card number

PIPLX View Mask Crosspoint.vi Obtains the state of an individual matrix crosspoint's mask.

page 114 of 132









Session

Card number





State True = masked,

page 115 of 132

False = not masked


Session

Card number

PIPLX View Mask.vi Obtains the switch mask of a sub-unit. The result fills the number of least significant bits corresponding to the size of the sub-unit.







Session

Card number




page 116 of 132



Session

Card number


Numeric

PIPLX View Subunit.vi Obtains the state of all outputs of a sub-unit. The result fills the number of least significant bits corresponding to the size of the sub-unit.







Session

Card number



page 117 of 132





Numeric


Session

Card number

PIPLX Vsource Get Enable.vi Get Voltage Source channel output enable states







Session

Card number


page 118 of 132





Pattern variable to receive the pattern of channel outputs currently enabled ('1' bit indicates corresponding channel is enabled)


Session

Card number

PIPLX Vsource Get Range.vi Get Voltage Source range.





Output Subunit sub-unit of target to access (unity-based)


Session

page 119 of 132

Card number





Range variable to receive the present range setting


Session

Card number

PIPLX Vsource Get Voltage.vi get Voltage Source output voltage






page 120 of 132


Session

Card number





Voltage variable to receive the voltage currently set (in Volts)


Session

Card number

PIPLX Vsource Set Enable.vi Set Voltage Source channel output enable states




page 121 of 132



Pattern the pattern of channel outputs to enable ('1' bit enables corresponding channel)


Session

Card number






Session

Card number

PIPLX Vsource Set Range.vi Set Voltage Source range.



page 122 of 132



Output Subunit sub-unit of target to access (unity-based)

Range the range to set


Session

Card number






Session

Card number

PIPLX Vsource Set Voltage.vi Set Voltage Source output voltage


page 123 of 132





Voltage the voltage to set (in Volts)


Session

Card number






Session

Card number

PIPLX Write Calibration Data.vi Writes a 16-bit calibration value to on-card EEPROM. The driver places no interpretation on the value written - an application program can utilise it in any way it wishes.

page 124 of 132






Index Calibration value index.

Data Value to be written.


Session

Card number






page 125 of 132

Session

Card number

PIPLX Write Calibration DataFP.vi Writes one or more floating-point calibration values into on-card EEPROM.







Session

Card number


Offset the offset in the sub-unit's calibration store at which to start

Num Values The number of values to be written

Data Array containing values to write

Num Values 2 The number of values to be written


page 126 of 132





Session

Card number

PIPLX Write Calibration Date.vi Writes a sub-unit's calibration date and interval into on-card EEPROM. Date information is obtained from the current system date.







Session

Card number

page 127 of 132


Interval Calibration interval (in days)






Session

Card number

PIPLX Write Mask Bit.vi Sets an individual output's mask.





page 128 of 132



Action True = mask, False = do not mask


Session

Card number






Session

Card number

PIPLX Write Mask Crosspoint.vi Mask or unmask a single matrix crosspoint. Masking disables the corresponding switch for the PIPLX OpenClose Bit.vi, PIPLX OpenClose Crosspoint.vi and PIPLX Write Subunit.vi VIs. This facility can be used to guard against programming errors that could otherwise result in damage to matrix switches or external circuits.



page 129 of 132







Action True = mask, False = do not mask


Session

Card number






Session

Card number

PIPLX Write Mask.vi Sets a sub-unit's switch mask to the supplied bit-pattern. The number of least significant bits corresponding to the size of the sub-unit are written into the mask. A '1' bit in the mask disables the corresponding switch for the OpBit,

page 130 of 132

OpCrosspoint, WriteSub VIs. This facility is particularly useful for matrix sub-units, where it can be used to guard against programming errors that could otherwise result in damage to matrix switches or external circuits.







Session

Card number

Data One-dimensional array (vector) containing the bit-pattern to be written.

Numeric





page 131 of 132


Session

Card number

PIPLX Write Subunit.vi Sets all outputs of a sub-unit to the supplied bit-pattern. The number of least significant bits corresponding to the size of the sub-unit are written.






Data One-dimensional array (vector) containing the bit-pattern to be written.

Numeric


Session

Card number




page 132 of 132




Session

Card number

Documents

PIPLX & PICMLX LabVIEW Function Reference …downloads.pickeringtest.info/.../piplx_picmlx/LabVIEW/piplx_picmlx... · page 1 of 132 . PIPLX & PICMLX LabVIEW Function Reference V1.0.2