NI Analog Read Task

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

For task lifecycle management, see the Task Basics page.

Task Configuration Reference

Parameter	Type	Required	Default	Description
`name`	string	Yes	-	Human-readable task name
`sample_rate`	number	Yes	-	Samples per second (Hz), determined by module
`stream_rate`	number	No	`sample_rate`	Rate data is streamed to Synnax (Hz), must be ≤ `sample_rate`
`data_saving`	boolean	No	`false`	Enable permanent storage in Synnax
`auto_start`	boolean	No	`false`	Automatically start task after configuration
`channels`	array	Yes	-	List of analog input channel configurations

Channel Types Reference

Accelerometer (ai_accel)

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

Bridge (ai_bridge)

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

Current (ai_current)

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

Force Bridge Table (ai_force_bridge_table)

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

Force Bridge Two-Point Linear (ai_force_bridge_two_point_lin)

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

Force IEPE (ai_force_iepe)

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

Microphone (ai_microphone)

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

Pressure Bridge Table (ai_pressure_bridge_table)

Parameter	Type	Required	Default	Description
`channel`	number	Yes	-	Synnax channel key
`device`	string	Yes	-	Device identifier
`port`	number	Yes	-	Physical port
`min_val`	number	No	`0`	Minimum pressure
`max_val`	number	No	`100`	Maximum pressure
`terminal_config`	enum	No	`Cfg_Default`	Terminal configuration
`units`	enum	Yes	-	Pressure units (`Pascals`, `PSI`, `Bar`)
`bridge_config`	enum	Yes	-	`FullBridge`, `HalfBridge`, `QuarterBridge`
`voltage_excit_source`	enum	Yes	-	`Internal`, `External`, `None`
`voltage_excit_val`	number	Yes	-	Excitation voltage (Volts)
`nominal_bridge_resistance`	number	Yes	-	Nominal resistance (Ohms)
`electrical_vals`	array	Yes	-	Electrical values for table
`physical_vals`	array	Yes	-	Physical values for table
`electrical_units`	enum	Yes	-	Electrical units
`physical_units`	enum	Yes	-	Physical units
`custom_scale`	object	No	-	Custom scaling

Pressure Bridge Two-Point Linear (ai_pressure_bridge_two_point_lin)

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

Resistance (ai_resistance)

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

RTD (ai_rtd)

Parameter	Type	Required	Default	Description
`channel`	number	Yes	-	Synnax channel key
`device`	string	Yes	-	Device identifier
`port`	number	Yes	-	Physical port
`min_val`	number	No	`0`	Minimum temperature
`max_val`	number	No	`100`	Maximum temperature
`terminal_config`	enum	No	`Cfg_Default`	Terminal configuration
`units`	enum	No	`DegC`	`DegC`, `DegF`, `Kelvins`, `DegR`
`rtd_type`	enum	Yes	-	`Pt3750`, `Pt3851`, `Pt3911`, `Pt3916`, `Pt3920`, `Pt3928`, `Custom`
`resistance_config`	enum	Yes	-	`2Wire`, `3Wire`, `4Wire`
`current_excit_source`	enum	Yes	-	`Internal`, `External`, `None`
`current_excit_val`	number	Yes	-	Excitation current (Amps)
`r_0`	number	No	-	Resistance at 0°C (for custom RTD)
`custom_scale`	object	No	-	Custom scaling

Strain Gauge (ai_strain_gauge)

Parameter	Type	Required	Default	Description
`channel`	number	Yes	-	Synnax channel key
`device`	string	Yes	-	Device identifier
`port`	number	Yes	-	Physical port
`min_val`	number	No	`0`	Minimum strain
`max_val`	number	No	`1`	Maximum strain
`terminal_config`	enum	No	`Cfg_Default`	Terminal configuration
`units`	enum	No	`strain`	`strain`
`strain_config`	enum	Yes	-	`full-bridge-I`, `full-bridge-II`, `full-bridge-III`, `half-bridge-I`, `half-bridge-II`, `quarter-bridge-I`, `quarter-bridge-II`
`voltage_excit_source`	enum	Yes	-	`Internal`, `External`, `None`
`voltage_excit_val`	number	Yes	-	Excitation voltage (Volts)
`gage_factor`	number	Yes	-	Gage factor
`initial_bridge_voltage`	number	Yes	-	Initial bridge voltage
`nominal_gage_resistance`	number	Yes	-	Nominal gage resistance (Ohms)
`poisson_ratio`	number	Yes	-	Poisson’s ratio
`lead_wire_resistance`	number	Yes	-	Lead wire resistance (Ohms)
`custom_scale`	object	No	-	Custom scaling

Temperature Built-In Sensor (ai_temp_builtin)

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

Thermocouple (ai_thermocouple)

Parameter	Type	Required	Default	Description
`channel`	number	Yes	-	Synnax channel key
`device`	string	Yes	-	Device identifier
`port`	number	Yes	-	Physical port
`min_val`	number	No	`0`	Minimum temperature
`max_val`	number	No	`100`	Maximum temperature
`terminal_config`	enum	No	`Cfg_Default`	Terminal configuration
`units`	enum	No	`DegC`	`DegC`, `DegF`, `Kelvins`, `DegR`
`thermocouple_type`	enum	Yes	-	`J`, `K`, `N`, `R`, `S`, `T`, `B`, `E`
`cjc_source`	enum	Yes	-	Cold junction compensation source (`BuiltIn`, `ConstVal`, `Chan`)
`cjc_val`	number	No	`25`	Cold junction temperature (if `cjc_source` is `ConstVal`)
`cjc_channel`	number	No	-	Cold junction channel (if `cjc_source` is `Chan`)
`custom_scale`	object	No	-	Custom scaling

Torque Bridge Table (ai_torque_bridge_table)

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

Torque Bridge Two-Point Linear (ai_torque_bridge_two_point_lin)

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

Velocity IEPE (ai_velocity_iepe)

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

Voltage (ai_voltage)

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

Important Rules

Sample rates: All channels in a task sample at the same rate. Create separate tasks for different rates.
One task per module: Only one running task can claim a module at a time.
Stream rate optimization: For low-rate tasks (< 50 Hz), set the stream rate to the sample rate. For high-rate tasks, keep the stream rate less than 50 Hz for better performance.

How-To

Configure a Device

Analog Write Task