ReferenceDevice driversNational InstrumentsAnalog read task

NI analog read task

Learn how to acquire analog data from NI devices with Synnax.

This task follows the standard task lifecycle.

Task configuration reference

Parameter Type Required Default Description
sample_rate number 10 Samples per second (Hz), determined by module
stream_rate number 5 Rate data is streamed to Synnax (Hz), must be ≤ sample_rate
channels array - List of analog input channel configurations

Channel types reference

Accelerometer (ai_accel)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum acceleration
max_val number 1 Maximum acceleration
terminal_config enum Cfg_Default Terminal configuration
sensitivity number 0 Sensor sensitivity
sensitivity_units enum mVoltsPerG mVoltsPerG, VoltsPerG
units enum g g, MetersPerSecondSquared, InchesPerSecondSquared
current_excit_source enum Internal Internal, External, None
current_excit_val number 0 Excitation current (Amps)
custom_scale object - Custom scaling

Accelerometer 4-wire DC voltage (ai_accel_4_wire_dc_voltage)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum acceleration
max_val number 1 Maximum acceleration
terminal_config enum Cfg_Default Terminal configuration
units enum g g, MetersPerSecondSquared, InchesPerSecondSquared
sensitivity number 0 Sensor sensitivity
sensitivity_units enum mVoltsPerG mVoltsPerG, VoltsPerG
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
scaled_by_excitation boolean false Scale the reading by the excitation voltage
custom_scale object - Custom scaling

Accelerometer charge (ai_accel_charge)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum acceleration
max_val number 1 Maximum acceleration
terminal_config enum Cfg_Default Terminal configuration
units enum g g, MetersPerSecondSquared, InchesPerSecondSquared
sensitivity number 0 Sensor sensitivity
sensitivity_units enum PicoCoulombsPerG PicoCoulombsPerG, PicoCoulombsPerMetersPerSecondSquared, PicoCoulombsPerInchesPerSecondSquared
custom_scale object - Custom scaling

Bridge (ai_bridge)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum value
max_val number 1 Maximum value
units enum mVoltsPerVolt mVoltsPerVolt, VoltsPerVolt
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms), must be > 0
custom_scale object - Custom scaling

Charge (ai_charge)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum charge
max_val number 1 Maximum charge
terminal_config enum Cfg_Default Terminal configuration
units enum Coulombs Coulombs, PicoCoulombs
custom_scale object - Custom scaling

Current (ai_current)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum current (Amps)
max_val number 1 Maximum current (Amps)
terminal_config enum Cfg_Default Terminal configuration
shunt_resistor_loc enum Default Default, Internal, External
ext_shunt_resistor_val number 1 External shunt resistor value (Ohms)
custom_scale object - Custom scaling

Current RMS (ai_current_rms)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum current (Amps)
max_val number 1 Maximum current (Amps)
terminal_config enum Cfg_Default Terminal configuration
shunt_resistor_loc enum Default Default, Internal, External
ext_shunt_resistor_val number 1 External shunt resistor value (Ohms)
custom_scale object - Custom scaling

Force bridge polynomial (ai_force_bridge_polynomial)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum force
max_val number 1 Maximum force
units enum Newtons Force units (Newtons, Pounds, KilogramForce)
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
forward_coeffs array [] Polynomial coefficients from electrical to physical values
reverse_coeffs array [] Polynomial coefficients from physical to electrical values
electrical_units enum mVoltsPerVolt Electrical units
physical_units enum Newtons Physical units
custom_scale object - Custom scaling

Force bridge table (ai_force_bridge_table)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum force
max_val number 1 Maximum force
units enum Newtons Force units (Newtons, Pounds, KilogramForce)
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
electrical_vals array [] Electrical values for table
physical_vals array [] Physical values for table
electrical_units enum mVoltsPerVolt Electrical units
physical_units enum Newtons Physical units
custom_scale object - Custom scaling

Force bridge two-point linear (ai_force_bridge_two_point_lin)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum force
max_val number 1 Maximum force
units enum Newtons Force units (Newtons, Pounds, KilogramForce)
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
first_electrical_val number 0 First electrical value
second_electrical_val number 1 Second electrical value
electrical_units enum mVoltsPerVolt Electrical units
first_physical_val number 0 First physical value
second_physical_val number 1 Second physical value
physical_units enum Newtons Physical units
custom_scale object - Custom scaling

Force IEPE (ai_force_iepe)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum force
max_val number 1 Maximum force
terminal_config enum Cfg_Default Terminal configuration
units enum Newtons Force units (Newtons, Pounds, KilogramForce)
sensitivity number 0 Sensor sensitivity
sensitivity_units enum mVoltsPerNewton mVoltsPerNewton, mVoltsPerPound
current_excit_source enum Internal Internal, External, None
current_excit_val number 0 Excitation current (Amps)
custom_scale object - Custom scaling

Frequency voltage (ai_freq_voltage)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum frequency (Hz)
max_val number 1 Maximum frequency (Hz)
threshold_level number 0 Voltage level at which a cycle is counted
hysteresis number 0 Hysteresis around the threshold (Volts)
custom_scale object - Custom scaling

Microphone (ai_microphone)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
terminal_config enum Cfg_Default Terminal configuration
mic_sensitivity number 0 Microphone sensitivity
max_snd_press_level number 0 Maximum sound pressure level
current_excit_source enum Internal Internal, External, None
current_excit_val number 0 Excitation current (Amps)
custom_scale object - Custom scaling

Pressure bridge polynomial (ai_pressure_bridge_polynomial)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum pressure
max_val number 1 Maximum pressure
units enum PoundsPerSquareInch Pascals, PoundsPerSquareInch, Bar
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
forward_coeffs array [] Polynomial coefficients from electrical to physical values
reverse_coeffs array [] Polynomial coefficients from physical to electrical values
electrical_units enum mVoltsPerVolt Electrical units
physical_units enum PoundsPerSquareInch Physical units
custom_scale object - Custom scaling

Pressure bridge table (ai_pressure_bridge_table)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum pressure
max_val number 1 Maximum pressure
units enum PoundsPerSquareInch Pascals, PoundsPerSquareInch, Bar
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
electrical_vals array [] Electrical values for table
physical_vals array [] Physical values for table
electrical_units enum mVoltsPerVolt Electrical units
physical_units enum PoundsPerSquareInch Physical units
custom_scale object - Custom scaling

Pressure bridge two-point linear (ai_pressure_bridge_two_point_lin)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum pressure
max_val number 1 Maximum pressure
units enum PoundsPerSquareInch Pascals, PoundsPerSquareInch, Bar
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
first_electrical_val number 0 First electrical value
second_electrical_val number 1 Second electrical value
electrical_units enum mVoltsPerVolt Electrical units
first_physical_val number 0 First physical value
second_physical_val number 1 Second physical value
physical_units enum PoundsPerSquareInch Physical units
custom_scale object - Custom scaling

Resistance (ai_resistance)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum resistance (Ohms)
max_val number 1 Maximum resistance (Ohms)
resistance_config enum 2Wire 2Wire, 3Wire, 4Wire
current_excit_source enum Internal Internal, External, None
current_excit_val number 0 Excitation current (Amps)
custom_scale object - Custom scaling

RTD (ai_rtd)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum temperature
max_val number 1 Maximum temperature
units enum DegC DegC, DegF, Kelvins, DegR
rtd_type enum Pt3750 Pt3750, Pt3851, Pt3911, Pt3916, Pt3920, Pt3928
r0 number 0 Sensor resistance at 0 degrees Celsius (Ohms)
resistance_config enum 2Wire 2Wire, 3Wire, 4Wire
current_excit_source enum Internal Internal, External, None
current_excit_val number 0 Excitation current (Amps)

Strain gauge (ai_strain_gauge)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum strain
max_val number 1 Maximum strain
strain_config enum FullBridgeI FullBridgeI, FullBridgeII, FullBridgeIII, HalfBridgeI, HalfBridgeII, QuarterBridgeI, QuarterBridgeII
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
gage_factor number 0 Gage factor
initial_bridge_voltage number 0 Initial bridge voltage
nominal_gage_resistance number 0 Nominal gage resistance (Ohms)
poisson_ratio number 0 Poisson’s ratio
lead_wire_resistance number 0 Lead wire resistance (Ohms)
custom_scale object - Custom scaling

Temperature built-in sensor (ai_temp_builtin)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
units enum DegC DegC, DegF, Kelvins, DegR

Thermistor current excitation (ai_thermistor_iex)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum temperature
max_val number 1 Maximum temperature
units enum DegC DegC, DegF, Kelvins, DegR
resistance_config enum 2Wire 2Wire, 3Wire, 4Wire
current_excit_source enum Internal Internal, External, None
current_excit_val number 0 Excitation current (Amps)
a number 0 First Steinhart-Hart coefficient
b number 0 Second Steinhart-Hart coefficient
c number 0 Third Steinhart-Hart coefficient

Thermistor voltage excitation (ai_thermistor_vex)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum temperature
max_val number 1 Maximum temperature
units enum DegC DegC, DegF, Kelvins, DegR
resistance_config enum 2Wire 2Wire, 3Wire, 4Wire
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
a number 0 First Steinhart-Hart coefficient
b number 0 Second Steinhart-Hart coefficient
c number 0 Third Steinhart-Hart coefficient
r1 number 0 Reference resistor (Ohms)

Thermocouple (ai_thermocouple)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum temperature
max_val number 1 Maximum temperature
units enum DegC DegC, DegF, Kelvins, DegR
thermocouple_type enum J J, K, N, R, S, T, B, E
cjc object built_in Cold junction compensation. One of {"source": "built_in"}, {"source": "const_val", "val": <temp>}, or {"source": "chan", "port": <port>}

Torque bridge polynomial (ai_torque_bridge_polynomial)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum torque
max_val number 1 Maximum torque
units enum NewtonMeters NewtonMeters, InchPounds, FootPounds, InchOunces
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
forward_coeffs array [] Polynomial coefficients from electrical to physical values
reverse_coeffs array [] Polynomial coefficients from physical to electrical values
electrical_units enum mVoltsPerVolt Electrical units
physical_units enum NewtonMeters Physical units
custom_scale object - Custom scaling

Torque bridge table (ai_torque_bridge_table)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum torque
max_val number 1 Maximum torque
units enum NewtonMeters NewtonMeters, InchPounds, FootPounds, InchOunces
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
electrical_vals array [] Electrical values for table
physical_vals array [] Physical values for table
electrical_units enum mVoltsPerVolt Electrical units
physical_units enum NewtonMeters Physical units
custom_scale object - Custom scaling

Torque bridge two-point linear (ai_torque_bridge_two_point_lin)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum torque
max_val number 1 Maximum torque
units enum NewtonMeters NewtonMeters, InchPounds, FootPounds, InchOunces
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
nominal_bridge_resistance number 1 Nominal resistance (Ohms)
first_electrical_val number 0 First electrical value
second_electrical_val number 1 Second electrical value
electrical_units enum mVoltsPerVolt Electrical units
first_physical_val number 0 First physical value
second_physical_val number 1 Second physical value
physical_units enum NewtonMeters Physical units
custom_scale object - Custom scaling

Velocity IEPE (ai_velocity_iepe)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum velocity
max_val number 1 Maximum velocity
units enum MetersPerSecond MetersPerSecond, InchesPerSecond
terminal_config enum Cfg_Default Terminal configuration
sensitivity number 0 Sensor sensitivity
sensitivity_units enum MillivoltsPerMillimeterPerSecond MillivoltsPerMillimeterPerSecond, MilliVoltsPerInchPerSecond
current_excit_source enum Internal Internal, External, None
current_excit_val number 0 Excitation current (Amps)
custom_scale object - Custom scaling

Voltage (ai_voltage)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum voltage (Volts)
max_val number 1 Maximum voltage (Volts)
terminal_config enum Cfg_Default Terminal configuration (Cfg_Default, RSE, NRSE, Diff, PseudoDiff)
custom_scale object - Custom scaling

Voltage RMS (ai_voltage_rms)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum voltage (Volts)
max_val number 1 Maximum voltage (Volts)
terminal_config enum Cfg_Default Terminal configuration (Cfg_Default, RSE, NRSE, Diff, PseudoDiff)
custom_scale object - Custom scaling

Voltage with excitation (ai_voltage_with_excit)

Parameter Type Required Default Description
channel number - Synnax channel key
device string - Device identifier
port number - Physical port
min_val number 0 Minimum voltage (Volts)
max_val number 1 Maximum voltage (Volts)
terminal_config enum Cfg_Default Terminal configuration
bridge_config enum FullBridge FullBridge, HalfBridge, QuarterBridge
voltage_excit_source enum Internal Internal, External, None
voltage_excit_val number 0 Excitation voltage (Volts)
scaled_by_excitation boolean false Scale the reading by the excitation voltage
custom_scale object - Custom scaling

Important rules

  • One task per module -> Only one running task can claim a module at a time.
  • Stream rate -> For sample rates under 50 Hz, set the stream rate equal to the sample rate. Above that, keep the stream rate under 50 Hz.

How-to