This document summarizes the Settings field groups used by the instruNet field hierarchy.
Each group may be used many times; for example, the Display group contains 4 fields (Digitize On/Off, Display Min, Display Max, Display Control).
Each Settings group contains 1 to 10 fields, each of which can be set to a different value, as described in the following table.
For Programmers:
Each Setting Group has an associated settingType value, which are passed to the iNet() subroutine in the 'settingGroupNumOrType' argument.
These are listed in the 1st column of the table in subscript form.
For example, the settingType of the Filter Settings group is -11.
These are also listed in the ion_settingGroupType area of the interface .h file.
Each Field has an associated fieldNum value, which are be passed to the iNet() subroutine in the 'fieldNum' argument.
These is listed in the 2nd column of the table in subscript form.
For example, the fieldNum of the Passband Ripple field within the Filter Settings group is 2.
These are also listed in the fldnum_.... areas of the interface .h file.
Some Fields have several possible values which are passed to the iNet() subroutine in the 'ptrToArg' argument.
These are listed in the 3rd column of the table in subscript form.
or example, the fieldValue for the Elliptic option of the Filter field within the Filter Settings group is 2.
These are also listed in the fldnum_.... areas of the interface .h file.
Selects filter model = {Off=1, Elliptic=2, Chebyshev P=3, Chebyshev S=4, or Butterworth=5 }.
Passband Ripple=2
Specifies maximum allowable passband ripple, in dB.
Stopband Attn=3
Specifies the minimum stop band attenuation, in dB.
Filter Order=4
Displays filter order. Automatically determined by the filter design, which is based on the specified criteria.
Passband F1 Hz=5
Frequencies below Passband F1 Hz are passed.
Stopband F1 Hz=6
Specifies lower cutoff frequency of the band that is stopped. Frequencies between Stopband F1 Hz and Stop B F2 Hz are stopped (i.e. attenuated).
Pass B F2 Hz=7
Frequencies above Passband F2 Hz are passed.
Stop B F2 Hz=8
Specifies higher cutoff frequency of the band that is stopped. Frequencies between Stopband F1 Hz and Stop B F2 Hz are stopped (i.e. attenuated).
Constants = -4
Defines constants used to calculate engineering units when measuring sensors (e.g. RTD, strain gage, etc). For more information, please refer to Connecting to Sensors.
Ro=1
Specifies value of bridge completion resistor, unstrained strain gage, load cell w/ 0 force, potentiometer, or resistance of an RTD at 0°C. Units are ohms.
Rshunt=2
Specifies value of shunt resistor in voltage divider or current measurement circuit. Units are ohms.
Vout=3
Sets excitation voltage in bridge/voltage divider circuits. Units are Volts.
Vinit=4
Specifies voltage across an unstrained bridge (e.g. strain gage, load cell); the voltage of a pot in the CCW position; or the voltage out of an accelerometer at 0 g's.
alpha=5
Specifies temperature coefficient of an RTD at 0°C (typically .00385 for American RTD's, and .00392 for European RTD's), as specified by the manufacturer of the RTD (ohms/ohms/C units); maximum force (Kg) in the case of a load cell; or maximum acceleration (g's) in the case of an accelerometer.
delta, Rlead=6
When connecting to an RTD, delta is the Callendar-Van Dusen delta constant (typically 1.492). This constant is specified by the manufacturer of the RTD. When doing measurements using quarter-bridge and half-bridge circuits, Rlead specifies the lead resistance of the wires connecting the sensor (i.e. strain gage) to the bridge.
GF=7
Specifies the gage factor of a Strain Gage as specified by the manufacturer of the gage (i.e. relates resistance change to strain); V/V per Kg of force in the case of a Load Cell; and V per g in the case of an accelerometer.
u_Poisson=8
Specifies Poisson's ratio in axial strain gage measurements.
Directory = -19
Contains fields that specify where and how information is saved to, and retrieved from, disk. For the most part, this is only used by programmers.
Path Name=1
Specifies the path name for the directory/folder that is used when loading or saving files via the Save or Open buttons in the Record page.
New Name=2
When the Save button is pressed in the Record page to save waveforms to disk, a new directory/folder is created for the new files. If the New Name field is set to Prompt User, the user is prompted for the new folder's name and location, otherwise, if New Name is set to Auto Generate, the folder is automatically created and named.
Save Fields=3
When the Save button is pressed in the Record page to save waves to disk, the user has the option of saving the network Fields with the waveforms. Save Fields is set to On=1 if Fields are to be saved, and Off=2 if they are not.
Load Fields=4
If Load Fields4 is set to On, the network Fields are loaded from disk when one presses the Open button in the Record page = {On=1, or Off=2}.
File Type=5
Specifies the file type for waveforms saved to disk via the Save button in the Record page = { Binary=1, Text (ASCII)=2, Text Merge (ASCII)=3, Binary Merge=4,}. Binary and Binary Merge are fast and compact, whereas Text is compatible with other programs such as word processors and spreadsheets. Text Merge saves an additional "Excel Waveform Data.txt" text file that contains all waves in one file. Binary Merge saves all channels in 1 file and spools to disk very fast; whereas Binary saves each channel in its own file and uses less RAM memory.
Command=6
Writing New Directory to the Command field causes a new directory/folder to be created. Writing Show Dialog to the Command field causes the File Open dialog to appear, which enables one to modify the Path Name field. Command is used primarily by programmers.
Display = -7
Defines the vertical scale of Record page Displays,
and allows one to enable a channel for digitizing,
as noted here.
Digitize=1
If Digitize is set to On=1, the channel is enabled for digitizing when the Start button is pressed in the Record page = {On=1, or Off=2}. When turned On within instruNet World, Input channels are Digitized and Plotted; whereas Output channels are only plotted (one must use the iW+ Control calculate field or Control script to drive output channels). When turned On while programming (e.g. C/BASIC), input channels are enabled for digitizing and their data is sent to data buffers; whereas output channels are placed into the digitize list and fed with data from their data buffers at the digitize sample rate.
Display Max=2
Specifies the Engineering Units value that corresponds to the top line of a Record page or Channel Setup dialog snapshot display.
Display Min=3
Specifies the Engineering Units value that corresponds to the bottom line of a Record page or Channel Setup dialog snapshot display.
Display Control=4
UseExplicitMinMaxFields=1, Hide Display in Record page while digitizing=2, AutoWithMeasMinMax=3
Driver Ram = -15
Defines a buffer, in RAM memory, that is maintained by the instruNet Driver. This is used by programmers to hold digitized data.
Digitize=1
If Digitize1 is set to On, the channel is enabled for digitizing, and the digitized data is sent to the Driver Ram buffer at runtime = {On=1, or Off=2}.
Buffer Addr=2
This is the address, in RAM memory, of the Driver Ram Buffer; 0 if not used (off). The Buffer size corresponds to 1 Scan of data points, where each point is stored in a 32bit floating point number (4 bytes per point).
Ptr Byte Size=3
This is the size of the Driver Ram Buffer in Bytes. This is often equal to 4 * PtsPerScan.
Scan Num In=4
Scan Number of last data point pushed into Driver Ram Buffer = {1... numScans}.
Pt Num In=5
Point Number of last data point pushed into Driver Ram Buffer = {1... PtsPerScan}
Scan Num=6
Scan Number of last data point pulled out of Driver Ram Buffer by Access_Digitized_Data_In_Ram_Buffer_32or64() = {1...numScans}.
Pt Num Out=7
Point Number of last data point pulled out of Driver Ram Buffer by Access_Digitized_Data_In_Ram_Buffer_32or64() = {1...PtsPerScan}.
File = -17
Specifies a file that contains digitized data. This is used primarily by programmers.
File=1
If File is set to On the channel is linked to the file = {On=1, or Off=2}.
Digitize=2
If Digitize is set to On1 the channel is enabled for digitizing, and the digitized data is sent to the Driver Ram buffer at runtime = {On=1, or Off=2}.
File Name=3
Specifies the file name that is linked to the channel. This is often the same as the channel name (e.g. "Ch1 Vin+").
Command=4
Writing to the Command field causes the following to occur (use the Record window Open/Save commands to connect with datasets on disk):
File > Ram Buffer (1) - Transfer Num Pts (number of points) from the Scan Num scan, starting at PointNum,
from the File to the Driver Ram Buffer. If FileType is Binary Merge, this occurs for all channels stored in the file for this network.
File > User buf (4) - Same as File > Ram buf, yet to User Ram Buffer.
Ram buf > File (3) - Transfer the data in the Driver Ram Buffer to the file on disk. If FileType is Binary Merge, this occurs for all channels stored in the file for this network.
User buf > File (5) Same as Ram buf > File, yet from User Ram Buffer.
Get File Info (6) - Get information about the File. Load {Scan Num, PointNum} with the last point in the file, and
load Num Pts with the number of points per scan.
Scan Num=5
Refers to a scan number = {1...numScans}.
PointNum=6
Num Pts=7
Refers to the number of points in the last Scan = {1...PtsPerScan}.
General = -6
Specifies general information about a channel, such as its name and value.
Value I/O=1
Specifies realtime value of the channel, in engineering Units. If the channel is a voltage input, this reflects the realtime voltage at the input terminals. If the channel is a voltage output, this is the voltage at the output terminals.
Units Label=2
Specifies vertical label that is shown in the Record page and Channel Setup dialog displays (e.g. "Volts", "C").
User Name=3
Specifies the name of the channel that is shown in the displays (e.g. "Pressure1", "Temp2").
% Sample Rate=4
Specifies the channel's sample rate as a percentage of the master sample rate that is defined in the Timing dialog (press Timing in Setup dialog) = {.001...100}. For example, if the master sample rate is 1Ks/sec, and Ch1's % Sample Rate4 is set to 25, then Ch1 will digitize at 250s/sec.
Hardware = -3 with Voltage Input Channels
Specifies parameters that control a Voltage Input channel. For more information, please refer to Connecting to Sensors.
Sensor Type=1
Specifies type of sensor attached to Voltage input terminals = { Voltage=1, Current=2, Resistance=3, Strain Gage=4, RTD=5, Thermocouple types J=6, K=7, T=8, E=9, R=10, S=11, B=12, N=13, Thermistor=14, Load Cell=16, Potentiometer=17, Accelerometer=18 }.
Wiring Type=2
Specifies wiring at Voltage input terminals = { Vin+ - Vin-=1, Vin - Gnd=2, Shunt Resistor=3, Voltage Divider=4, Bridge=5, ¼ Bridge=6, ½ Bridge Bend=7, ½ Bridge Axial=8, Full Bridge Bend=9, Full Bridge Axial I=10, Full Bridge Axial II=11 }.
Low Pass Filter=3
Specifies lowpass analog filter cutoff frequency in Hz units (e.g. i423 options are off (0), 6Hz, or 4KHz).
Integrate=4
Specifies amount of integration (i.e. smoothing) in units of seconds. Signal are sampled and averaged for the duration specified in this field. For details, please see Sample Rate Vs. Integration Time Vs. Noise.
Range=5
Specifies maximum input range for the measured voltage, in units of Volts. For the most accurate readings, specify the smallest range possible without causing the measured voltage to hit the bound. For example if your maximum expected input range
is ±500mV select a range of ±0.6V (i.e. set the Range field to 0.6).
If your range is unipolar, then set Range to Minus Maximum Voltage (e.g. -5.0 for 0 to 5V range).
For details, click here.
MaxIntEu=6
Specifies measurement maximum value, in Internal Engineering units, as noted here.
MinIntEu=7
Specifies measurement minimum value, in Internal Engineering units, as noted here.
Hardware = -5 with Digital I/O
Specifies parameters that control a Digital I/O channel.
Digital Output=1
Specifies the logic level of bits that have been set up as digital outputs in the Direction field.
Direction=2
Sets the direction of the various digital bits as an input (0) or an output (1).
Selects filter model = {Off=1, Elliptic=2, Chebyshev P=3, Chebyshev S=4, or Butterworth=5 }
Passband Ripple=2
Specifies maximum allowable passband ripple, in dB.
Stopband Attn=3
Specifies the minimum stop band attenuation, in dB.
Filter Order4
Displays filter order. Automatically determined by the filter design, which is based on the specified criteria.
Passband F1 Hz=5
Frequencies below Passband F1 H are passed.
Stopband F1 Hz=6
Frequencies above Stopband F1 Hz are attenuated.
Pass B F2 Hz=7
Not used.
Stop B F2 Hz=8
Not used.
Display Options = -18
Specifies how waveforms are displayed and stored while digitizing.
Horiz Scale=1
Specifies the horizontal scale of the displays in the Record page and Channel Setup dialog (i.e. Seconds per horizontal division). Use 0.0 to enable automatic scale selection, which is based on the sample rate and Scan size.
Horiz Position=2
Specifies the horizontal position of the displays in the Record page and Channel Setup dialog (i.e. seconds associated with the display left edge). This, in effect, is linked to the horizontal scrollbar.
Plot=3
Specifies whether to plot one dot per data point, or to connect data points with lines = { Lines=1, or Dots=2 }. Lines requires more processor time.
Grid=4
Turns display grid on or off = { On=1, or Off=2 }.
Max Pts Per Horiz Pixel=5
Sets the maximum number of points plotted in each vertical column of pixels.
Digitize Into=6
Specifies where digitized data is saved = { Off=1, ToRamBuffer=2, ToFile=3, or UserControl=4 }.
Overflow Alrt=7
Specifies whether or not the instruNet driver shows an alert when the Digitizer buffer overflows = { On=1, or Off=2 }.
Timer = -14
Specifies the function of the Digital Timer I/O Channels on the Model 200 instruNet Controllers (not iNet-230).
Function=1
Sets the channel function as one of = { Digital In=1, Digital Out=2, Clock Output=3, Period Measurement=4 }.
Clock Period=2
Sets the cycle time, in seconds, when doing Clock Output.
Clock Out Hi=3
Sets the high time, in seconds, when doing Clock Output.
Measure=4
When doing Period Measurement, this specifies if the cycle time or the high time is measured = { Cycle Time=1, or High Time=2 }.
Meas. Resol.=5
When doing Period Measurement, this specifies the measurement accuracy to one of = { 0.25µs=1, or 4ms=2 }.
Meas. Cycles=6
When doing Period Measurement, this specifies the number of cycles or high times that must elapse during the measured duration = {0...255}.
Timing = -12
Specifies parameters for the DSP based digitizing via the i2x0/i60x Controllers.
Digitize=1
Turns digitizing on or off for all channels = { On=1, or Off=2 }. This field is automatically set to On when the Start button is pressed and Off when the Stop button is pressed.
Points Per Scan=2
Specifies the number of points digitized for each Scan, at the master Sample Rate.
Number. of Scans=3
Specifies the number of Scans that are digitized when the Start button is pressed.
Scan Mode=4
Specifies whether consecutive Scans are continuous with respect to each other = { Strip Chart=1, Oscilloscope=2, Oscillo Queued=3 }.
Sample Rate=5
Specifies the master sample rate, in units of samples-per-second-per-channel. If the specified rate is too fast, instruNet will adjust to the fastest possible rate. All channels run at this rate, unless their % Sample Rate field is requesting a slower rate.
Min sec/tsfr=6
Specifies the minimum acceptable time to transfer a 16bit value on the instruNet network, in units of seconds.
Network BPS=7
Specifies the instruNet network data transfer rate in bits per second = {100,000 ...4,000,000}. This is automatically set to the fastest possible rate when instruNet is reset. Long network cables and/or many network Devices sometimes require a slower rate.
Switching=8
Specifies analog channel switching to run Fast=2 or Accurate=1. If Fast is used, the system switches from one channel to another as fast as possible; otherwise, with Accurate, the switching is a little slower, yet provides the amplifiers more time to settle, and is therefore a little more accurate. This effect the i100 box more than it effects the i4xx cards.
Trigger = -13
Specifies the
Trigger
condition that must be met before digitizing (after the Start button is pressed).
Trigger=1
Sets the trigger mode to one of: { Off=1, Auto=2, or Norm=3 }. Off1 specifies no trigger, Norm mandates that the digitizing cannot begin until the trigger condition is met, and Auto waits for the trigger condition yet digitizes anyway if the condition is not met within several seconds.
Threshold EU=2
Specifies the trigger threshold in engineering units (EU).
Slope=3
Specifies the direction the waveform must cross the threshold in order to trigger = {Rising=1, or Falling=2}.
Expansion=4
Trig. Net#=5
Specifies the Network number of the trigger channel.
Trig. Dev#=6
Specifies the Device number of the trigger channel.
Trig. Mod#=7
Specifies the Module number of the trigger channel.
Trig. Chan#=8
Specifies the Channel number of the trigger channel.
User Ram = -16
Defines a buffer, in RAM memory, that is maintained by the programming end user. This buffer is used to hold digitized data.
Digitize=1
If Digitize is set to On, the channel is enabled for digitizing, and the digitized data is sent to the User Ram buffer at runtime = {On=1, or Off=2}.
User Addr=2
This is the address, in RAM memory, of the User Ram Buffer; 0 if not used (off). The Buffer size must be enough to hold 1 Scan of data points, where each point is stored in a 32bit floating point number (4bytes/point).
Buff Byte Size=3
This is the size of the User Ram Buffer in Bytes. This must be greater than or equal to 4 * PtsPerScan.
Scan Num In=4
Scan Number of last data point pushed into User Ram Buffer = {1... numScans}.
Pt Num In=5
Point Number of last data point pushed into User Ram Buffer = {1... PtsPerScan}
Scan Num=6
Scan Number of last data point pulled out of User Ram Buffer by Access_Digitized_Data_In_Ram_Buffer_32or64() = {1...numScans}.
Pt Num Out=7
Point Number of last data point pulled out of User Ram Buffer by Access_Digitized_Data_In_Ram_Buffer_32or64() = {1...PtsPerScan}.
Hidden
Hidden
Hidden
Hidden