LabVIEW API Utility¶
ziLoadSettings¶
None
Input
| Name | Type | Description |
|---|---|---|
| Handle in |  LabOne handle in |
LabOne handle in. |
| Error in |  error in |
Error In can accept error information wired from VIs previously called. |
| File path |  path string |
Path to file where the settings are stored/loaded. (default = dialog if empty) |
| Path |  string |
LabOne node path. |
Output
| Name | Type | Description |
|---|---|---|
| Handle out |  LabOne handle out |
LabOne handle out. |
| Error out |  error out |
Contains the Error information, if there are any. |
ziSaveSettings¶
None
Input
| Name | Type | Description |
|---|---|---|
| Handle In | LabOne handle in |
LabOne handle in. |
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
| Path | string |
LabOne node path. (default = "") |
| file path | path string |
Path to file where the settings are stored/loaded. (default = dialog if empty) |
Output
| Name | Type | Description |
|---|---|---|
| Handle Out | LabOne handle out |
LabOne handle out. |
| Error Out | error out |
Contains the Error information, if there are any. |
| Saved Array |  string array |
Array of the saved data |
ziAutoRange¶
Automatically set the input range of signalinputs/{0,1} to half full level.
Input
| Name | Type | Description |
|---|---|---|
| Handle in | LabOne handle in |
LabOne handle in. |
| Error in | error in |
Error In can accept error information wired from VIs previously called. |
| Path | string |
LabOne node path. |
Output
| Name | Type | Description |
|---|---|---|
| Handle out | LabOne handle out |
LabOne handle out. |
| Error out | error out |
Contains the Error information, if there are any. |
| Success |  bool |
Flag if the operation was successful. |
ziCheckVersion¶
Checks if Version of API and DataServer are the same and reports a user dialog with warning if not.
Input
| Name | Type | Description |
|---|---|---|
| Handle In | LabOne handle in |
LabOne handle in. |
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
Output
| Name | Type | Description |
|---|---|---|
| Error Out | error out |
Contains the Error information, if there are any. |
| Handle Out | LabOne handle out |
LabOne handle out. |
| Message |  string |
Message reported by the VI. |
ziList¶
Returns a list of nodes found at the specified path. The path may contain wild cards so that the rertuned nodes do not necessarily have to have the same parents.
Input
| Name | Type | Description |
|---|---|---|
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
| Path | string |
LabOne node path. (default = "") |
| Flags | LabOne handle in |
Optional flags to control the result. (default = None) |
| Handle In | LabOne handle in |
LabOne handle in. |
Output
| Name | Type | Description |
|---|---|---|
| Error Out | error out |
Contains the Error information, if there are any. |
| Nodes |  string array |
Reported nodes. |
| Handle Out | LabOne handle out |
LabOne handle out. |
ziListDevices¶
Returns a list of ZI Instruments that are available in the connected Data Server.
Input
| Name | Type | Description |
|---|---|---|
| Handle In | LabOne handle in |
LabOne handle in. |
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
Output
| Name | Type | Description |
|---|---|---|
| Handle Out | LabOne handle out |
LabOne handle out. |
| Error Out | error out |
Contains the Error information, if there are any. |
| Devices |  string array |
Reported devices |
ziListNodesJSON¶
Returns nodes documentation found at the specified path. The path may contain wild cards so that the rertuned nodes do not necessarily have to have the same parents.
Input
| Name | Type | Description |
|---|---|---|
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
| Path | string |
LabOne node path. (default = "") |
| Flags | LabOne handle in |
Optional flags to control the result. (default = None) |
| Handle In | LabOne handle in |
LabOne handle in. |
Output
| Name | Type | Description |
|---|---|---|
| Error Out | error out |
Contains the Error information, if there are any. |
| Handle Out | LabOne handle out |
LabOne handle out. |
| Doc | string array |
node documentation |
ziConnectDevice¶
None
Input
| Name | Type | Description |
|---|---|---|
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
| Device Serial | string |
Device serial/id (e.g. DEV2345). |
| Handle In | LabOne handle in |
LabOne handle in. |
| Device Interface | string |
Interface that should be used to connect to the device (e.g. 1GbE) |
| Device Interface Params | string |
Additional flags for the device interface (only for debugging). (default = "") |
Output
| Name | Type | Description |
|---|---|---|
| Error Out | error out |
Contains the Error information, if there are any. |
| Handle Out | LabOne handle out |
LabOne handle out. |
ziDisconnectDevice¶
None
Input
| Name | Type | Description |
|---|---|---|
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
| Device Serial | string |
Device serial/id (e.g. DEV2345). |
| Handle In | LabOne handle in |
LabOne handle in. |
Output
| Name | Type | Description |
|---|---|---|
| Error Out | error out |
Contains the Error information, if there are any. |
| Handle Out | LabOne handle out |
LabOne handle out. |
ziMDSStart¶
Enables multiDeviceSync (MDS) on the Master and Slave devices and returns the status of the MDS.
Input
| Name | Type | Description |
|---|---|---|
| Master | string |
ID of leading device. |
| Slaves |  string array |
List of follower devices. |
Output
| Name | Type | Description |
|---|---|---|
| Status |  double |
Status |
| Message | string |
Message reported by the VI. |
| Error Out | error out |
Contains the Error information, if there are any. |
| ModHandle Out | LabOne handle out |
LabOne Module handle out. |
| Handle Out | LabOne handle out |
LabOne handle out. |
| MDS_Devices | string array |
Included devices. |
ziSelectDevice¶
Selects to the default device to use.
Input
| Name | Type | Description |
|---|---|---|
| Handle In | LabOne handle in |
LabOne handle in. |
| Error In | error in |
Error In can accept error information wired from VIs previously called. |
| Device | string |
device to use. by default the first device will be used. (default = first) |
Output
| Name | Type | Description |
|---|---|---|
| Handle Out | LabOne handle out |
LabOne handle out. |
| Error Out | error out |
Contains the Error information, if there are any. |
| Selected Device | string |
Device that was selected. |
ziTicks2S¶
Convert a scalara or vector value from the machine unit ticks to the SI unit second.
Input
| Name | Type | Description |
|---|---|---|
Output
| Name | Type | Description |
|---|---|---|
ziBW2TC¶
Convert an effective signal bandwidth value and an order value to the required timeconstant per filter order.
Input
| Name | Type | Description |
|---|---|---|
| Order |  integer (32 bit) |
The demodulator order (1 to 8) for which to convert the bandwidth. (default = 1) |
| BW |  double |
The demodulator 3dB bandwidth to convert. (default = Hz) |
| Eq BW |  bool |
(default = F) |
Output
| Name | Type | Description |
|---|---|---|
| TC | double |
time constant |
ziTC2BW¶
Convert a timeconstant value and order value to an effective signal bandwidth.
Input
| Name | Type | Description |
|---|---|---|
| TC | double |
time constant (default = s) |
| Order | integer (32 bit) |
The demodulator order (1 to 8) for which to convert the bandwidth. (default = 1) |
| Eq BW | bool |
(default = F) |
Output
| Name | Type | Description |
|---|---|---|
| BW | double |
The demodulator 3dB bandwidth to convert. |
ziUpdateDevice¶
Allow to Update MFLI/UHF devices via the Labview API.
Input
| Name | Type | Description |
|---|---|---|
| file path | path string |
Path to file where the settings are stored/loaded. (default = use dialog) |
| Address | string |
Device address |
Output
| Name | Type | Description |
|---|---|---|
| Error Out | error out |
Contains the Error information, if there are any. |