ADI Sense 1000 Host Library API
[ADI Sense Host Library API]

ADI Sense 1000 analog sensor excitation current output level options

Note:

applicable only to ADC analog sensor channels, and specific sensor types

Enumerator:

ADI_SENSE_1000_ADC_EXC_CURRENT_NONE	Excitation current disabled
ADI_SENSE_1000_ADC_EXC_CURRENT_50uA	50uA excitation current enabled
ADI_SENSE_1000_ADC_EXC_CURRENT_100uA	100uA excitation current
ADI_SENSE_1000_ADC_EXC_CURRENT_250uA	250uA excitation current enabled
ADI_SENSE_1000_ADC_EXC_CURRENT_500uA	500uA excitation current enabled
ADI_SENSE_1000_ADC_EXC_CURRENT_750uA	750uA excitation current enabled
ADI_SENSE_1000_ADC_EXC_CURRENT_1000uA	1mA excitation current enabled

Definition at line 170 of file adi_sense_1000_config.h.

ADI Sense 1000 analog sensor excitation current swap options

Note:

applicable only to ADC analog sensor types where 2 excitation current sources may be enabled (e.g. 3-wire RTD sensors)

Enumerator:

ADI_SENSE_1000_ADC_EXC_CURRENT_SWAP_DYNAMIC	2 measurements are performed, one with excitation currents output on default output pins, then another with the current outputs swapped, and these measurements are averaged to provide a single result.
ADI_SENSE_1000_ADC_EXC_CURRENT_SWAP_STATIC	Excitation current output pin assignments are swapped from defaults
ADI_SENSE_1000_ADC_EXC_CURRENT_SWAP_NONE	Excitation current output on default pins (IOUT0->AIN0, IOUT1->AIN3)

Definition at line 192 of file adi_sense_1000_config.h.

ADI Sense 1000 analog filter selection options

Note:

applicable only to ADC analog sensor channels

Enumerator:

ADI_SENSE_1000_ADC_FILTER_SINC4	SINC4 filter Note: The number of input samples to be averaged by the filter must be specified by fs (see ADI_SENSE_1000_ADC_FILTER_CONFIG) The fs value affects the output sample rate and settling times of the ADC
ADI_SENSE_1000_ADC_FILTER_FIR_20SPS	FIR post filter, producing a 20sps output sample rate
ADI_SENSE_1000_ADC_FILTER_FIR_25SPS	FIR post filter, producing a 25sps output sample rate

Definition at line 253 of file adi_sense_1000_config.h.

ADI Sense 1000 analog input signal amplification gain options

Note:

applicable only to ADC analog sensor channels

Enumerator:

ADI_SENSE_1000_ADC_GAIN_1X	no amplification gain
ADI_SENSE_1000_ADC_GAIN_2X	x2 amplification gain
ADI_SENSE_1000_ADC_GAIN_4X	x4 amplification gain
ADI_SENSE_1000_ADC_GAIN_8X	x8 amplification gain
ADI_SENSE_1000_ADC_GAIN_16X	x16 amplification gain
ADI_SENSE_1000_ADC_GAIN_32X	x32 amplification gain
ADI_SENSE_1000_ADC_GAIN_64X	x64 amplification gain
ADI_SENSE_1000_ADC_GAIN_128X	x128 amplification gain

Definition at line 146 of file adi_sense_1000_config.h.

ADI Sense 1000 analog reference selection options

Note:

applicable only to ADC analog sensor channels, and specific sensor types

Enumerator:

ADI_SENSE_1000_ADC_REFERENCE_NONE	No reference is selected
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_INTERNAL_1	Internal reference resistor #1 (4320 ohms) is selected
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_INTERNAL_2	Internal reference resistor #2 (10000 ohms) is selected
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_INTERNAL	Internal ADC voltage reference (2.5V) is selected
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_AVDD	Analag Supply Voltage AVDD reference (typically 3.3V) is selected
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_EXTERNAL_1	External user-supplied reference resistor #1 is selected Note: reference resistor value externalRef1Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_EXTERNAL_2	External user-supplied reference resistor #2 is selected Note: reference resistor value externalRef2Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_EXTERNAL_1	External user-supplied reference voltage #1 is selected Note: reference voltage value externalRef1Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_EXTERNAL_2	External user-supplied reference voltage #2 is selected Note: reference voltage value externalRef2Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_BRIDGE_EXCITATION	Bridge Excition Voltage is selected as reference Note: this reference MUST be selected for 4/6-wire bridge sensor types (see ADI_SENSE_1000_ADC_SENSOR_TYPE)

Definition at line 209 of file adi_sense_1000_config.h.

ADI Sense 1000 analog sensor type options

Select the sensor type that is connected to an ADC analog measurement channel.

Note:

Some channels may only support a subset of the available sensor types below.

The sensor type name may include a classification suffix:

• _DEF_L1: pre-defined sensor using built-in linearisation data
• _DEF_L2: pre-defined sensor using user-supplied linearisation data Where the suffix is absent, assume the _DEF_L1 classification above.

Enumerator:

ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_T_DEF_L1	Standard T-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_J_DEF_L1	Standard J-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_K_DEF_L1	Standard K-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_1_DEF_L2	Standard thermocouple temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_2_DEF_L2	Standard thermocouple temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_3_DEF_L2	Standard thermocouple temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_4_DEF_L2	Standard thermocouple temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_T_ADV_L1	T-type thermocouple temperature sensor with default linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_K_ADV_L1	T-type thermocouple temperature sensor with default linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_J_ADV_L1	T-type thermocouple temperature sensor with default linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_1_ADV_L2	Thermocouple temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_2_ADV_L2	Thermocouple temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_3_ADV_L2	Thermocouple temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMOCOUPLE_4_ADV_L2	Thermocouple temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_PT100_DEF_L1	Standard 2-wire PT100 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_PT1000_DEF_L1	Standard 2-wire PT1000 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_1_DEF_L2	2-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_2_DEF_L2	2-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_3_DEF_L2	2-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_4_DEF_L2	2-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_PT100_ADV_L1	Standard 2-wire PT100 RTD temperature sensor with default linearisation and advanced configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_PT1000_ADV_L1	Standard 2-wire PT1000 RTD temperature sensor with default linearisation and advanced configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_1_ADV_L2	2-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_2_ADV_L2	2-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_3_ADV_L2	2-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_2WIRE_4_ADV_L2	2-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_PT100_DEF_L1	Standard 3-wire PT100 RTD temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_PT1000_DEF_L1	Standard 3-wire PT1000 RTD temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_1_DEF_L2	3-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_2_DEF_L2	3-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_3_DEF_L2	3-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_4_DEF_L2	3-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_PT100_ADV_L1	Standard 3-wire PT100 RTD temperature sensor with default linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_PT1000_ADV_L1	Standard 3-wire PT1000 RTD temperature sensor with default linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_1_ADV_L2	3-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_2_ADV_L2	3-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_3_ADV_L2	3-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_3WIRE_4_ADV_L2	3-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_PT100_DEF_L1	Standard 4-wire PT100 RTD temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_PT1000_DEF_L1	Standard 4-wire PT1000 RTD temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_1_DEF_L2	4-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_2_DEF_L2	4-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_3_DEF_L2	4-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_4_DEF_L2	4-wire RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_PT100_ADV_L1	Standard 4-wire PT100 RTD temperature sensor with default linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_PT1000_ADV_L1	Standard 4-wire PT1000 RTD temperature sensor with default linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_1_ADV_L2	4-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_2_ADV_L2	4-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_3_ADV_L2	4-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_RTD_4WIRE_4_ADV_L2	4-wire RTD temperature sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_A_10K_DEF_L1	Standard 10kOhm NTC Thermistor temperature sensor with Steinhart–Hart linearisation equation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_B_10K_DEF_L1	Standard 10kOhm NTC Thermistor temperature sensor with Beta linearisation equation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_1_DEF_L2	Thermistor sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_2_DEF_L2	Thermistor sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_3_DEF_L2	Thermistor sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_4_DEF_L2	Thermistor sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_A_10K_ADV_L1	10kOhm NTC Thermistor temperature sensor with Steinhart–Hart linearisation equation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_B_10K_ADV_L1	10kOhm NTC Thermistor temperature sensor with Beta linearisation equation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_1_ADV_L2	Thermistor sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_2_ADV_L2	Thermistor sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_3_ADV_L2	Thermistor sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_THERMISTOR_4_ADV_L2	Thermistor sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_1_DEF_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_2_DEF_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_3_DEF_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_4_DEF_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_1_ADV_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_2_ADV_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_3_ADV_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_4WIRE_4_ADV_L2	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_1_DEF_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_2_DEF_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_3_DEF_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_4_DEF_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_1_ADV_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_2_ADV_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_3_ADV_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_BRIDGE_6WIRE_4_ADV_L2	Standard 6-wire Bridge Transducer sensor with user-defined linearisation and advanced configuration options Note: For use with Analog Sensor channels only Bridge Excition Voltage must be selected as reference
ADI_SENSE_1000_ADC_SENSOR_VOLTAGE	Generic voltage sensor with no linearisation applied Note: For use with Analog 0-10V Voltage Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_VOLTAGE_PRESSURE_HONEYWELL_TRUSTABILITY	Honeywell Pressure voltage sensor (HSCMRNN1.6BAAA3) with default linearisation and default configuration options Note: For use with Analog 0-10V Voltage Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_VOLTAGE_PRESSURE_AMPHENOL_NPA300X	Amphenol Pressure voltage sensor (NPA-300B-015A) with default linearisation and default configuration options Note: For use with Analog 0-10V Voltage Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_VOLTAGE_PRESSURE_3_DEF	Generic pressure voltage sensor with user-defined linearisation and default configuration options Note: For use with Analog 0-10V Voltage Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_CURRENT	Generic current sensor with no linearisation applied Note: For use with Analog 4-20mA Current Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_CURRENT_PRESSURE_HONEYWELL_PX2	Honeywell Pressure current sensor (PX2CN2XX100PACH) with default linearisation and default configuration options Note: For use with Analog 4-20mA Current Sensor channels only
ADI_SENSE_1000_ADC_SENSOR_CURRENT_PRESSURE_2_DEF	Generic pressure current sensor with user-defined linearisation and default configuration options Note: For use with Analog 4-20mA Current Sensor channels only

Definition at line 103 of file adi_sense_1000_sensor_types.h.

ADI Sense 1000 measurement channel identifiers

Enumerator:

ADI_SENSE_1000_CHANNEL_ID_NONE	Used to indicate when no channel is selected (e.g. compensation channel)
ADI_SENSE_1000_CHANNEL_ID_CJC_0	Cold-Juction Compensation channel #0
ADI_SENSE_1000_CHANNEL_ID_CJC_1	Cold-Juction Compensation channel #1
ADI_SENSE_1000_CHANNEL_ID_SENSOR_0	Analog Sensor channel #0
ADI_SENSE_1000_CHANNEL_ID_SENSOR_1	Analog Sensor channel #1
ADI_SENSE_1000_CHANNEL_ID_SENSOR_2	Analog Sensor channel #2
ADI_SENSE_1000_CHANNEL_ID_SENSOR_3	Analog Sensor channel #3
ADI_SENSE_1000_CHANNEL_ID_VOLTAGE_0	Analog 0-10V Voltage Sensor channel #0
ADI_SENSE_1000_CHANNEL_ID_CURRENT_0	Analog 4-20mA Current Sensor channel #0
ADI_SENSE_1000_CHANNEL_ID_I2C_0	Digital I2C Sensor channel #0
ADI_SENSE_1000_CHANNEL_ID_I2C_1	Digital I2C Sensor channel #1
ADI_SENSE_1000_CHANNEL_ID_SPI_0	Digital SPI Sensor channel #0
ADI_SENSE_1000_CHANNEL_ID_SPI_1	Digital SPI Sensor channel #1
ADI_SENSE_1000_CHANNEL_ID_SPI_2	Digital SPI Sensor channel #2
ADI_SENSE_1000_MAX_CHANNELS	Maximum number of measurement channels on the ADI Sense 1000

Definition at line 55 of file adi_sense_1000_sensor_types.h.

ADI Sense 1000 data ready mode options

Enumerator:

ADI_SENSE_1000_DATAREADY_PER_CONVERSION	The DATAREADY signal is asserted after completion of each conversion a single data sample only from the latest completed conversion is stored in this mode
ADI_SENSE_1000_DATAREADY_PER_CYCLE	The DATAREADY signal is asserted after completion of each measurement cycle data samples only from the lastest completed measurement cycle are stored in this mode
ADI_SENSE_1000_DATAREADY_PER_MULTICYCLE_BURST	The DATAREADY signal is asserted after completion of each burst of measurement cycles applicable only when ADI_SENSE_1000_OPERATING_MODE_MULTICYCLE is also selected data samples only from the lastest completed burst of measurement cycles are stored in this mode

Definition at line 75 of file adi_sense_1000_config.h.

ADI Sense 1000 digital sensor data encoding

Note:

applicable only to SPI and I2C digital sensor channels

Enumerator:

ADI_SENSE_1000_DIGITAL_SENSOR_DATA_CODING_NONE	None/Invalid - data format is ignored if coding is set to this value.
ADI_SENSE_1000_DIGITAL_SENSOR_DATA_CODING_UNIPOLAR	Unipolar - unsigned integer values.
ADI_SENSE_1000_DIGITAL_SENSOR_DATA_CODING_TWOS_COMPLEMENT	Twos-complement - signed integer values.
ADI_SENSE_1000_DIGITAL_SENSOR_DATA_CODING_OFFSET_BINARY	Offset Binary - used to represent signed values with unsigned integers, with the mid-range value representing 0.

Definition at line 377 of file adi_sense_1000_config.h.

ADI Sense 1000 I2C digital sensor type options

Select the sensor type that is connected to an I2C digital measurement channel.

Note:

These are pre-defined sensors using built-in linearisation data

Enumerator:

ADI_SENSE_1000_I2C_SENSOR_HUMIDITY_HONEYWELL_HUMIDICON	Honeywell HiH9000-series humidity sensor with default linearisation and default configuration options Note: For use with I2C Digital Sensor channels only
ADI_SENSE_1000_I2C_SENSOR_HUMIDITY_SENSIRION_SHT3X	Sensirion SHT35-DIS-B humidity sensor with default linearisation and default configuration options Note: For use with I2C Digital Sensor channels only

Definition at line 649 of file adi_sense_1000_sensor_types.h.

Linearisation data vector format

Enumerator:

ADI_SENSE_1000_LUT_DATA_TYPE_RESERVED	Reserved - for internal use only.
ADI_SENSE_1000_LUT_DATA_TYPE_FLOAT32	Single-precision 32-bit floating-point.
ADI_SENSE_1000_LUT_DATA_TYPE_FLOAT64	Double-precision 64-bit floating-point.

Definition at line 123 of file adi_sense_1000_lut_data.h.

Linearisation equation type

Enumerator:

ADI_SENSE_1000_LUT_EQUATION_POLYN	Polynomial equation, typically used for Thermocouple and RTD linearisation.
ADI_SENSE_1000_LUT_EQUATION_POLYNEXP	Polynomial + exponential equation, typically used for Thermocouple inverse linearisation.
ADI_SENSE_1000_LUT_EQUATION_QUADRATIC	Quadratic linearisation equation, typically used for RTD linearisation.
ADI_SENSE_1000_LUT_EQUATION_STEINHART	Steinhart-Hart equation, typically used for Thermistor linearisation.
ADI_SENSE_1000_LUT_EQUATION_LOGARITHMIC	Beta-based logarithmic equation, typically used for Thermistor linearisation.
ADI_SENSE_1000_LUT_EQUATION_EXPONENTIAL	Exponential equation.
ADI_SENSE_1000_LUT_EQUATION_BIVARIATE_POLYN	Bi-variate polynomial equation, typically used for bridge pressure sensor linearisation. Note: 2nd-degree is the maximum currently supported
ADI_SENSE_1000_LUT_EQUATION_COUNT	Enum count value - for internal use only.
ADI_SENSE_1000_LUT_EQUATION_LUT	Hard-coded Look-Up Table - for internal use only.

Definition at line 83 of file adi_sense_1000_lut_data.h.

Linearisation look-up table / co-efficient list geometry

Enumerator:

ADI_SENSE_1000_LUT_GEOMETRY_RESERVED	reserved - for internal use only
ADI_SENSE_1000_LUT_GEOMETRY_COEFFS	1-dimensional equation coefficient list
ADI_SENSE_1000_LUT_GEOMETRY_NES_1D	1-dimensional not-equally-spaced look-up table
ADI_SENSE_1000_LUT_GEOMETRY_NES_2D	2-dimensional not-equally-spaced look-up table
ADI_SENSE_1000_LUT_GEOMETRY_ES_1D	1-dimensional equally-spaced look-up table
ADI_SENSE_1000_LUT_GEOMETRY_ES_2D	2-dimensional equally-spaced look-up table

Definition at line 67 of file adi_sense_1000_lut_data.h.

Enumerator:

ADI_SENSE_1000_LUT_TC_DIRECTION_FORWARD	Thermocouple forward (mV to Celsius) linearisation Use this value by default for non-thermocouple sensors.
ADI_SENSE_1000_LUT_TC_DIRECTION_BACKWARD	Thermocouple inverse (Celsius to mV) linearisation.
ADI_SENSE_1000_LUT_TC_DIRECTION_COUNT	Enum count value - for internal use only.

Definition at line 112 of file adi_sense_1000_lut_data.h.

ADI Sense 1000 measurement unit options

Optionally select a measurement unit for final conversion results. Currently applicable only to specific temperature sensor types.

Enumerator:

ADI_SENSE_1000_MEASUREMENT_UNIT_DEFAULT	No measurement unit specified - implied by sensor type selection
ADI_SENSE_1000_MEASUREMENT_UNIT_CELSIUS	Celsius temperature unit - applicable to temperature sensors only
ADI_SENSE_1000_MEASUREMENT_UNIT_FAHRENHEIT	Fahrenheit temperature unit - applicable to temperature sensors only

Definition at line 112 of file adi_sense_1000_config.h.

ADI Sense 1000 Open-Sensor Diagnostics frequency

Select the per-cycle frequency at which open-sensor diagnostic checks should be performed. Open-sensor diagnostic checks typically require specific or time-consuming processing which cannot be executed while a measurement cycle is running.

Note:

Open-sensor diagnostic checks, when performed, will add a delay to the start of the next measurement cycle.

Enumerator:

ADI_SENSE_1000_OPEN_SENSOR_DIAGNOSTICS_DISABLED	No Open-Sensor Detection is performed
ADI_SENSE_1000_OPEN_SENSOR_DIAGNOSTICS_PER_CYCLE	No Open-Sensor Detection is performed prior to each cycle
ADI_SENSE_1000_OPEN_SENSOR_DIAGNOSTICS_PER_100_CYCLES	No Open-Sensor Detection is performed at intervals of 100 cycles
ADI_SENSE_1000_OPEN_SENSOR_DIAGNOSTICS_PER_1000_CYCLES	No Open-Sensor Detection is performed at intervals of 1000 cycles

Definition at line 131 of file adi_sense_1000_config.h.

ADI Sense 1000 operating mode options

Enumerator:

ADI_SENSE_1000_OPERATING_MODE_SINGLECYCLE	Executes a single measurement cycle and stops
ADI_SENSE_1000_OPERATING_MODE_CONTINUOUS	Continuously executes measurement cycles
ADI_SENSE_1000_OPERATING_MODE_MULTICYCLE	Executes a burst of measurement cycles, repeated at defined intervals

Definition at line 65 of file adi_sense_1000_config.h.

ADI Sense 1000 data power mode options

Enumerator:

ADI_SENSE_1000_POWER_MODE_LOW	Lowest ADC power consumption mode, with lowest conversion rate
ADI_SENSE_1000_POWER_MODE_MID	Medium ADC power consumption mode, with medium conversion rate
ADI_SENSE_1000_POWER_MODE_FULL	Highest ADC power consumption mode, with highest conversion rate

Definition at line 98 of file adi_sense_1000_config.h.

ADI Sense 1000 SPI digital sensor type options

Select the sensor type that is connected to an SPI digital measurement channel.

Note:

These are pre-defined sensors using built-in linearisation data

Enumerator:

ADI_SENSE_1000_SPI_SENSOR_PRESSURE_HONEYWELL_TRUSTABILITY

Honeywell HSCDRNN1.6BASA3 pressure sensor with default linearisation and default configuration options Note: For use with SPI Digital Sensor channels only

ADI_SENSE_1000_SPI_SENSOR_ACCELEROMETER_ADI_ADXL362

Analog Devices ADxL362 3-axis accelerometer sensor with default linearisation and default configuration options(*) Note: (*) Custom configuration command can be optionally specified For use with SPI Digital Sensor channels only This sensor requires the use of 3 SPI Digital Sensor channels, with the sensor measurements from the X/Y/Z axes each output on a seperate dedicated channel (SPI#0/SPI#1/SPI#2, respectively)

Definition at line 671 of file adi_sense_1000_sensor_types.h.

Struct for a list of coefficients to be used in an equation

Struct for a 1-dimensional equally-spaced look-up table

Struct for a 1-dimensional not-equally-spaced look-up table

Struct for a 2-dimensional equally-spaced look-up table

Struct for a 2-dimensional not-equally-spaced look-up table

Struct for a 2-dimensional list of coefficients to be used in a bi-variate polynomial equation

Look-Up Table descriptor

Look-Up Table structure

LUT data format versions

LUT data header structure

LUT data top-level structure

Alternative top-level structure for raw LUT data representation

Note:

This is intended to be used for encapsulating the storage of static LUT data declarations in C files. The rawTableData can be cast to the ADI_SENSE_LUT type for further parsing/processing.

< number of coefficients

< look-up table range - minimum

< look-up table range - maximum

< C99 flexible array: sorted by ascending exponent in polynomials

< number of elements.

< initial input value, corresponding to first table element

< interval between successive input values

< C99 flexible array

< number of elements of each array.

< C99 flexible array, first X's array then Y's array

< number of elements for input X.

< number of elements for input Y.

< initial X input value

< interval between successive X input values

< initial Y input value

< interval between successive Y input values

< C99 flexible array, Z matrix[y][x]

< number of elements in array X.

< number of elements in array Y.

< C99 flexible array, Order: X's array, Y's array, Z matrix[y][x]

< number of coefficients

< look-up table range - minimum X input value

< look-up table range - maximum X input value

< look-up table range - minimum Y input value

< look-up table range - maximum Y input value

< C99 flexible array: sorted by ascending X degree then sorted by ascending Y exponent

< Table geometry

< Equation type

< Thermocouple linearisation direction

< Sensor Type ID

< Table vector data type

< Length in bytes of table data section (excluding this header)

< CRC-16-CCITT of the data

< Look-Up Table descriptor

< Look-Up Table data

< Major version number

< Minor version number

< Hard-coded signature value (ADI_SENSE_LUT_SIGNATURE)

< LUT data format version (ADI_SENSE_LUT_VERSION)

< Total number of tables

< Total length (in bytes) of all table descriptors and data (excluding this header) This, plus the header length, must not exceed ADI_SENSE_LUT_MAX_SIZE

< LUT data top-level header structure

< Variable-length array of one-or-more look-up table structures

< LUT data top-level header structure

< Variable-length byte array of look-up tables in raw binary format

Definition at line 133 of file adi_sense_1000_lut_data.h.

Assemble a list of separate Look-Up Tables into a single buffer.

Parameters:

[out]	pLutBuffer	Pointer to the Look-Up Table data buffer where the assembled Look-Up Table data will be placed
[in]	nLutBufferSize	Allocated size, in bytes, of the output data buffer
[in]	nNumTables	Number of tables to add to the Look-Up Table buffer
[in]	ppDesc	Array of pointers to the table descriptors to be added
[in]	ppData	Array of pointers to the table data to be added

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

This utiliity function fills the Look-up Table header fields; then walks through the array of individual table descriptor and data pointers provided, appending (copying) each one to the Look-Up Table data buffer. The length and crc16 fields of each table descriptor will be calculated and filled by this function, but other fields in the descriptor structure must be filled by the caller beforehand.

Note:

The assembled LUT data buffer filled by this function can then be written to the device memory using .

Definition at line 2319 of file adi_sense_1000.c.

Get the number of samples available when DATAREADY status is asserted.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	bMeasurementMode	Must be set to the same value used for adi_sense_StartMeasurement().
[out]	peOperatingMode	Pointer to return the configured operating mode
[out]	peDataReadMode	Pointer to return the configured data publishing mode
[out]	pnSamplesPerDataready	Pointer to return the calculated number of samples available when DATAREADY is asserted
[out]	pnSamplesPerCycle	Pointer to return the calculated number of samples produced per measurement cycle

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Examines the current configuration settings in the device registers to calculate the number of samples available whenever the DATAREADY signal is asserted, along with other related information. This may be used to allocate buffers to store samples and to determine how many samples to retrieve whenever the DATAREADY status is asserted.

Definition at line 827 of file adi_sense_1000.c.

Read the contents of the ADI Sense internal factory calibration table.

Calibration coefficients/gains/offsets are stored internally in a 2D table of 32-bit floating point values. Refer to product documentation for details of the rows and columns.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	pfBuffer	Pointer to destination buffer for the calibration data
[in]	nMaxLen	The buffer capacity in bytes (e.g. 672 for 56x3 table)
[out]	pnDataLen	The number of bytes written to the buffer
[out]	pnRows	Pointer to return the number of table rows (e.g. 56)
[out]	pnColumns	Pointer to return the number of table columns (e.g. 3)

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.
• ADI_SENSE_FAILURE
• ADI_SENSE_INVALID_OPERATION Invalid register identifier.

Definition at line 2384 of file adi_sense_1000.c.

Read one or more device registers at the specified register address.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	nAddress	Register map address to read from
[out]	pData	Pointer to return the register map data
[in]	nLength	Number of bytes of data to read from the register map

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Provides direct byte-level read access to the device register map. The size and format of the register(s) must be known.

Note:

Reads from special "keyhole" or "FIFO" registers will be handled according to documentation for those registers.

Definition at line 772 of file adi_sense_1000.c.

Update channel configuration settings for a specific channel.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	eChannelId	Selects the channel to be updated
[in]	pChannelConfig	Channel configuration details

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers. Allows individual channel configuration details to be dynamically adjusted without rewriting the full device configuration.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 2022 of file adi_sense_1000.c.

Update number of measurements-per-cycle for a specific channel.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	eChannelId	Selects the channel to be updated
[in]	nMeasurementsPerCycle	Specifies the number of measurements to be obtained from this channel in each measurement cycle. Set as 0 to disable the channel (omit from measurement cycle).

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers. Allows individual channels to be dynamically enabled/disabled, and measurements-per-cycle to be adjusted.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 1217 of file adi_sense_1000.c.

Update the extra settling time for a specified channel.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	eChannelId	Selects the channel to be updated
[in]	nSettlingTime	A minimum settling time is applied internally for each channel, based on the sensor type. However, additional settling time (microseconds) can optionally be specified here. Set to 0 if not required.

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers. Allows individual channel settling times to be dynamically adjusted.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 2010 of file adi_sense_1000.c.

Update the measurement threshold limits for a specified channel.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	eChannelId	Selects the channel to be updated
[in]	fHighThresholdLimit	Optional maximum threshold value for each processed sample, to be checked prior to publishing. A channel ALERT condition is raised if the processed value is higher than this threshold. Set to NaN if not required.
[in]	fLowThresholdLimit	Optional minimum threshold value for each processed sample, to be checked prior to publishing. A channel ALERT condition is raised if the processed value is lower than this threshold. Set to NaN if not required.

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers. Allows individual channel thresholds to be dynamically adjusted.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 1961 of file adi_sense_1000.c.

Update diagnostics configuration settings on the device.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	pDiagnosticsConfig	Diagnostics configuration details

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 1174 of file adi_sense_1000.c.

Write Look-Up Table data to the device memory.

Parameters:

[in]	hDevice	ADI Sense device context handle
[out]	pLutData	Pointer to the Look-Up Table data structure

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Validates the Look-Up Table data format and loads it into device memory via dedicated keyhole registers.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 2174 of file adi_sense_1000.c.

Write Look-Up Table raw data to the device memory.

Parameters:

[in]	hDevice	ADI Sense device context handle
[out]	pLutData	Pointer to the Look-Up Table raw data structure

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

This can be used instead of for loading LUT data from the alternative raw data format. See for more information.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 2277 of file adi_sense_1000.c.

Update measurement configuration settings on the device.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	pMeasurementConfig	Measurement configuration details

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 1126 of file adi_sense_1000.c.

Update power configuration settings on the device.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	pPowerConfig	Power configuration details

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers.

Note:

Settings are not applied until adi_sense_ApplyConfigUpdates() is called

Definition at line 984 of file adi_sense_1000.c.

Write one or more device registers at the specified register address.

Parameters:

[in]	hDevice	ADI Sense device context handle
[in]	nAddress	Register map address to read from
[out]	pData	Pointer to return the register map data
[in]	nLength	Number of bytes of data to read from the register map

Returns:

Status

• ADI_SENSE_SUCCESS Call completed successfully.

Provides direct byte-level write access to the device register map. The size and format of the register(s) must be known.

Note:

Writes to read-only registers will be ignored by the device.

Writes to special "keyhole" registers will be handled according to documentation for those registers.

Definition at line 730 of file adi_sense_1000.c.