ADMW1001 Host Library API
[ADMW Host Library API]

ADMW1001 analog sensor excitation current output level options

Note:

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

Enumerator:

ADMW1001_ADC_NO_EXTERNAL_EXC_CURRENT	NO External excitation is provided
ADMW1001_ADC_EXC_CURRENT_EXTERNAL	External excitation is provided
ADMW1001_ADC_EXC_CURRENT_50uA	50uA excitation current enabled
ADMW1001_ADC_EXC_CURRENT_100uA	100uA excitation current
ADMW1001_ADC_EXC_CURRENT_250uA	250uA excitation current enabled
ADMW1001_ADC_EXC_CURRENT_500uA	500uA excitation current enabled
ADMW1001_ADC_EXC_CURRENT_1000uA	1mA excitation current enabled

Definition at line 220 of file admw1001_config.h.

ADMW1001 analog sensor excitation current ratios used for diode sensor

Note:

applicable only to a diode sensor

Enumerator:

ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_100UA	2 Current measurement 10uA 100uA
ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_160UA	2 Current measurement 20uA 160uA
ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_300UA	2 Current measurement 50uA 300uA
ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_600UA	2 Current measurement 100uA 600uA
ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_10UA_50UA_100UA	3 current measuremetn 10uA 50uA 100uA
ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_20UA_100UA_160UA	3 current measuremetn 20uA 100uA 160uA
ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_50UA_150UA_300UA	3 current measuremetn 50uA 150uA 300uA
ADMW1001_ADC_EXC_CURRENT_IOUT_DIODE_100UA_300UA_600UA	3 current measuremetn 100uA 300uA 600uA

Definition at line 243 of file admw1001_config.h.

ADMW1001 analog sensor excitation state options

Note:

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

Enumerator:

ADMW1001_ADC_EXC_STATE_CYCLE_POWER	Excitation for measurement is active only during measurement
ADMW1001_ADC_EXC_STATE_ALWAYS_ON	Excitation for measurement is always on

Definition at line 206 of file admw1001_config.h.

ADMW1001 analog filter selection options

Note:

applicable only to ADC analog sensor channels

Enumerator:

ADMW1001_ADC_FILTER_SINC4	SINC4 - 4th order sinc response filter
ADMW1001_ADC_FILTER_SINC3	SINC3 - 3rd order sinc response filter

Definition at line 309 of file admw1001_config.h.

ADMW1001 analog input signal amplification gain options

Note:

applicable only to ADC analog sensor channels

Enumerator:

ADMW1001_ADC_GAIN_1X	no amplification gain
ADMW1001_ADC_GAIN_2X	x2 amplification gain
ADMW1001_ADC_GAIN_4X	x4 amplification gain
ADMW1001_ADC_GAIN_8X	x8 amplification gain
ADMW1001_ADC_GAIN_16X	x16 amplification gain
ADMW1001_ADC_GAIN_32X	x32 amplification gain
ADMW1001_ADC_GAIN_64X	x64 amplification gain

Definition at line 182 of file admw1001_config.h.

ADMW1001 ADC Reference configuration

Note:

applicable only to ADC analog sensor channels

Enumerator:

ADMW1001_ADC_GND_SW_OPEN	Ground switch not enabled for measurement.
ADMW1001_ADC_GND_SW_CLOSED	Ground switch enabled for measurement.

Definition at line 284 of file admw1001_config.h.

ADMW1001 analog reference selection options

Note:

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

Enumerator:

ADMW1001_ADC_REFERENCE_VOLTAGE_INTERNAL	Internal VRef - 1.2V
ADMW1001_ADC_REFERENCE_VOLTAGE_EXTERNAL_1	External reference voltage #1
ADMW1001_ADC_REFERENCE_VOLTAGE_AVDD	Analog Supply Voltage AVDD reference (typically 3.3V) is selected

Definition at line 269 of file admw1001_config.h.

ADMW1001 analog input signal amplification gain options

Note:

applicable only to ADC analog sensor channels

Enumerator:

ADMW1001_ADC_RTD_CURVE_EUROPEAN	EUROPEAN RTD curve used.
ADMW1001_ADC_RTD_CURVE_AMERICAN	AMERICAN RTD curve used.
ADMW1001_ADC_RTD_CURVE_JAPANESE	JAPANESE RTD curve used.
ADMW1001_ADC_RTD_CURVE_ITS90	ITS90 RTD curve used.

Definition at line 166 of file admw1001_config.h.

ADMW1001 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.

Enumerator:

ADMW1001_ADC_SENSOR_THERMOCOUPLE_T	Standard T-type Thermocouple temperature sensor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_J	Standard J-type Thermocouple temperature sensor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_K	Standard K-type Thermocouple temperature sensor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_E	Standard E-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_N	Standard N-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_R	Standard R-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_S	Standard S-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_B	Standard B-type Thermocouple temperature sensor with default linearisation and default configuration options Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMOCOUPLE_CUSTOM	CUSTOM -type Thermocouple temperature sensor with custom linearisation and default configuration options Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_2WIRE_PT100	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
ADMW1001_ADC_SENSOR_RTD_2WIRE_PT1000	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
ADMW1001_ADC_SENSOR_RTD_2WIRE_PT10	Standard 2-wire PT10 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_2WIRE_PT50	Standard 2-wire PT50 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_2WIRE_PT200	Standard 2-wire PT200 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_2WIRE_PT500	Standard 2-wire PT500 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_2WIRE_PT1000_0P00375	Standard 2-wire PT1000 RTD temperature sensor with alpha 0.00375 linearisation Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_2WIRE_NI120	Standard 2-wire NI120 RTD temperature sensor Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_2WIRE_CUSTOM	2-wire Custom RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_PT100	Standard 3-wire PT100 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_PT1000	Standard 3-wire PT1000 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_PT10	Standard 3-wire PT10 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_PT50	Standard 3-wire PT50 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_PT200	Standard 3-wire PT200 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_PT500	Standard 3-wire PT500 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_PT1000_0P00375	Standard 3-wire PT1000 RTD temperature sensor with alpha 0.00375 linearisation Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_NI120	Standard 3-wire NI120 RTD temperature sensor Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_3WIRE_CUSTOM	3-wire Custom RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_PT100	Standard 4-wire PT100 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_PT1000	Standard 4-wire PT1000 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_PT10	Standard 4-wire PT10 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_PT50	Standard 4-wire PT50 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_PT200	Standard 4-wire PT200 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_PT500	Standard 4-wire PT500 RTD temperature sensor with default linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_PT1000_0P00375	Standard 4-wire PT1000 RTD temperature sensor with alpha 0.00375 linearisation Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_NI120	Standard 4-wire NI120 RTD temperature sensor Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_RTD_4WIRE_CUSTOM	4-wire Custom RTD temperature sensor with user-defined linearisation and default configuration options Note: For use with Cold-Juction Compensation and Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_44004_44033_2P252K_AT_25C	Standard 2.252kOhm NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_44005_44030_3K_AT_25C	Standard 3kOhm NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_44007_44034_5K_AT_25C	Standard 5kOhm NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_44006_44031_10K_AT_25C	Standard 10kOhm NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_44008_44032_30K_AT_25C	Standard 30kOhm NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_YSI_400	Standard YSI400 NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_SPECTRUM_1003K_1K	Standard 1kOhm NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_CUSTOM_STEINHART_HART	CUSTOM Equation NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_THERMISTOR_CUSTOM_TABLE	Custom Table NTC Thermistor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_BRIDGE_4WIRE	Standard 4-wire Bridge Transducer sensor with user-defined linearisation and default configuration options Note: For use with Analog Sensor channels only Bridge Excitation Voltage must be selected as reference
ADMW1001_ADC_SENSOR_BRIDGE_6WIRE	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
ADMW1001_ADC_SENSOR_DIODE	Standard Diode current temperature sensor Note: For use with Analog Sensor channels only
ADMW1001_ADC_SENSOR_SINGLE_ENDED_ABSOLUTE	Test sensor for internal use Note: For use with Analog 4-20mA Current Sensor channels only
ADMW1001_ADC_SENSOR_DIFFERENTIAL_ABSOLUTE	Test sensor for internal use Note: For use with Analog 4-20mA Current Sensor channels only
ADMW1001_ADC_SENSOR_SINGLE_ENDED_RATIO	Test sensor for internal use Note: For use with Analog 4-20mA Current Sensor channels only
ADMW1001_ADC_SENSOR_DIFFERENTIAL_RATIO	Test sensor for internal use Note: For use with Analog 4-20mA Current Sensor channels only

Definition at line 96 of file admw1001_sensor_types.h.

Enumerator:

ADMW1001_BUFFER_BYPASSS_DISABLED	Buffer Bypass Disabled
ADMW1001_BUFFER_BYPASSS_ENABLED	Buffer Bypass Enabled

Definition at line 153 of file admw1001_config.h.

ADMW1001 measurement channel identifiers

Enumerator:

ADMW1001_CH_ID_NONE	Used to indicate when no channel is selected
ADMW1001_CH_ID_ANLG_1_UNIVERSAL	Universal channel 1 universal channel
ADMW1001_CH_ID_ANLG_2_UNIVERSAL	Universal channel 2 universal channel
ADMW1001_CH_ID_ANLG_1_DIFFERENTIAL	Universal channel 1 differential channel
ADMW1001_CH_ID_ANLG_2_DIFFERENTIAL	Universal channel 2 differential channel
ADMW1001_CH_ID_DIG_I2C_0	Digital I2C Sensor channel #0
ADMW1001_CH_ID_DIG_I2C_1	Digital I2C Sensor channel #1
ADMW1001_CH_ID_DIG_I2C_2	Digital I2C Sensor channel #2
ADMW1001_CH_ID_DIG_I2C_3	Digital I2C Sensor channel #3
ADMW1001_CH_ID_DIG_I2C_4	Digital I2C Sensor channel #4
ADMW1001_CH_ID_DIG_I2C_5	Digital I2C Sensor channel #5
ADMW1001_MAX_CHANNELS	Maximum number of measurement channels on ADMW1001

Definition at line 55 of file admw1001_sensor_types.h.

ADMW1001 channel priority options

Definition at line 61 of file admw1001_config.h.

ADMW1001 analog filter chop mode

Note:

applicable only to ADC analog sensor channels

Enumerator:

ADMW1001_CHOP_MD_OFF

chop performed.

Definition at line 297 of file admw1001_config.h.

ADMW1001 data ready mode options

Enumerator:

ADMW1001_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
ADMW1001_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
ADMW1001_DATAREADY_PER_FIFO_FILL	The DATAREADY signal is asserted after each fill of the data FIFO applicable only when ADMW1001_OPERATING_MODE_CONTINUOUS or ADMW1001_OPERATING_MODE_MULTICYCLE is also selected

Definition at line 93 of file admw1001_config.h.

ADMW1001 I2C clock speed options

Note:

applicable only for I2C sensors

Enumerator:

ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_100K	100kHz I2C clock speed
ADMW1001_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_400K	400kHz I2C clock speed

Definition at line 345 of file admw1001_config.h.

ADMW1001 digital sensor data encoding

Note:

applicable only to SPI and I2C digital sensor channels

Enumerator:

ADMW1001_DIGITAL_SENSOR_DATA_CODING_NONE	None/Invalid - data format is ignored if coding is set to this value.
ADMW1001_DIGITAL_SENSOR_DATA_CODING_UNIPOLAR	Unipolar - unsigned integer values.
ADMW1001_DIGITAL_SENSOR_DATA_CODING_TWOS_COMPLEMENT	Twos-complement - signed integer values.
ADMW1001_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 499 of file admw1001_config.h.

ADMW1001 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:

ADMW1001_I2C_SENSOR_HUMIDITY	Sensirion SHT35-DIS-B humidity sensor Note: For use with I2C Digital Sensor channels only
ADMW1001_I2C_SENSOR_TEMPERATURE_ADT742X	ADT742X sensor Note: the ADT742X Temperature sensor. Note: For use with I2C Digital Sensor channels only

Definition at line 428 of file admw1001_sensor_types.h.

Linearisation data vector format

Enumerator:

ADMW1001_LUT_DATA_TYPE_RESERVED	Reserved - for internal use only.
ADMW1001_LUT_DATA_TYPE_FLOAT32	Single-precision 32-bit floating-point.
ADMW1001_LUT_DATA_TYPE_FLOAT64	Double-precision 64-bit floating-point.

Definition at line 118 of file admw1001_lut_data.h.

Linearisation equation type

Enumerator:

ADMW1001_LUT_EQUATION_POLYN	Polynomial equation, typically used for Thermocouple and RTD linearisation.
ADMW1001_LUT_EQUATION_POLYNEXP	Polynomial + exponential equation, typically used for Thermocouple inverse linearisation.
ADMW1001_LUT_EQUATION_QUADRATIC	Quadratic linearisation equation, typically used for RTD linearisation.
ADMW1001_LUT_EQUATION_STEINHART	Steinhart-Hart equation, typically used for Thermistor linearisation.
ADMW1001_LUT_EQUATION_LOGARITHMIC	Beta-based logarithmic equation, typically used for Thermistor linearisation.
ADMW1001_LUT_EQUATION_BIVARIATE_POLYN	Bi-variate polynomial equation, typically used for bridge pressure sensor linearisation. Note: 2nd-degree is the maximum currently supported
ADMW1001_LUT_EQUATION_COUNT	Enum count value - for internal use only.
ADMW1001_LUT_EQUATION_LUT	Hard-coded Look-Up Table - for internal use only.

Definition at line 80 of file admw1001_lut_data.h.

Linearisation look-up table / co-efficient list geometry

Enumerator:

ADMW1001_LUT_GEOMETRY_RESERVED	reserved - for internal use only
ADMW1001_LUT_GEOMETRY_COEFFS	1D/2D equation coefficient list
ADMW1001_LUT_GEOMETRY_NES_1D	1-dimensional not-equally-spaced look-up table

Definition at line 70 of file admw1001_lut_data.h.

ADMW1001 look-up table selection Select table used to linearise the measurement.

Enumerator:

ADMW1001_LUT_DEFAULT	Default LUT
ADMW1001_LUT_CUSTOM	User defined custom LUT
ADMW1001_LUT_RESERVED	Reserved for future use

Definition at line 484 of file admw1001_config.h.

Enumerator:

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

Definition at line 107 of file admw1001_lut_data.h.

ADMW1001 measurement unit options

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

Enumerator:

ADMW1001_MEASUREMENT_UNIT_UNSPECIFIED	No measurement unit specified
ADMW1001_MEASUREMENT_UNIT_CELSIUS	Celsius temperature unit - applicable to temperature sensors only
ADMW1001_MEASUREMENT_UNIT_FAHRENHEIT	Fahrenheit temperature unit - applicable to temperature sensors only

Definition at line 142 of file admw1001_config.h.

ADMW1001 operating mode options

Enumerator:

ADMW1001_OPERATING_MODE_SINGLECYCLE	Executes a single measurement cycle and stops
ADMW1001_OPERATING_MODE_CONTINUOUS	Continuously executes measurement cycles

Definition at line 83 of file admw1001_config.h.

ADMW1001 power mode options

Enumerator:

ADMW1001_POWER_MODE_ACTIVE	Part is fully powered up and either cycling through a sequence or awaiting a configuration
ADMW1001_POWER_MODE_HIBERNATION	module has entede hibernation mode. All analog circuitry is disabled. All peripherals disabled apart from the Wake-up pin functionality.

Definition at line 115 of file admw1001_config.h.

ADMW1001 Sinc Filter range (SF)

Note:

applicable only to ADC analog sensor channels

SF must be set in conjunction with chop mode and sinc filter type to achieve the desired sampling rate.

Enumerator:

ADMW1001_SF_122HZ	SF setting for 122Hz sample rate.
ADMW1001_SF_61HZ	SF setting for 61Hz sample rate.
ADMW1001_SF_30P5HZ	SF setting for 61Hz sample rate.
ADMW1001_SF_10HZ	SF setting for 10Hz sample rate.
ADMW1001_SF_8P24HZ	SF setting for 8.24Hz sample rate.
ADMW1001_SF_5HZ	SF setting for 5Hz sample rate.

Definition at line 324 of file admw1001_config.h.

ADMW1001 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

Definition at line 451 of file admw1001_sensor_types.h.

ADMW1001 External Vref Buffer Mode options

Enumerator:

ADMW1001_VREF_BUFF_MODE_DISABLE_BOTH	Both Vref+ and Vref- buffers to be disabled
ADMW1001_VREF_BUFF_MODE_ONLY_POS	only Vref+ buffer to be disabled
ADMW1001_VREF_BUFF_MODE_ONLY_NEG	Only Vref- buffers to be disabled
ADMW1001_VREF_BUFF_MODE_ENABLE_BOTH	Both Vref+ and Vref- buffers to be Enabled

Definition at line 125 of file admw1001_config.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

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 ADMW_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

< ADMW1001_LUT_GEOMETRY

< ADMW1001_ADC_CHANNEL

< ADMW1001_LUT_EQUATION

< ADMW1001_LUT_TC_DIRECTION

< ADMW1001_ADC_SENSOR_TYPE

< ADMW1001_LUT_DATA_TYPE

< Length (bytes) of table data section (excl. this header)

< Look-Up Table descriptor

< Look-Up Table data

< Major version number

< Minor version number

< Hard-coded signature value (ADMW_LUT_SIGNATURE)

< LUT data format version (ADMW_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 ADMW_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 128 of file admw1001_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

• ADMW_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 admw1001_SetLutData.

Definition at line 2106 of file admw_1001.c.

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

Parameters:

[in]	hDevice	ADMW device context handle
[in]	eMeasurementMode	Must be set to the same value used for admw_StartMeasurement().
[out]	peOperatingMode	Pointer to return the configured operating mode
[out]	peDataReadyMode	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
[out]	pnBytesPerSample	Pointer to return the size, in bytes, of each sample

Returns:

Status

• ADMW_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 795 of file admw_1001.c.

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

Parameters:

[in]	hDevice	ADMW1001 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

• ADMW_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.

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

Parameters:

[in]	hDevice	ADMW1001 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

• ADMW_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 754 of file admw_1001.c.

Enable access to advanced sensor configuration options.

Parameters:

[in]	hDevice	ADMW1001 device context handle
[in]	key	Key to unlock advanced access

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

When the correct access key is provided, access to advanced sensor configuration options and use of advanced sensor types is enabled.

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Update channel configuration settings for a specific channel.

Parameters:

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

Returns:

Status

• ADMW_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 admw_ApplyConfigUpdates() is called

Definition at line 1908 of file admw_1001.c.

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

Parameters:

[in]	hDevice	ADMW1001 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

• ADMW_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 admw_ApplyConfigUpdates() is called

Definition at line 1201 of file admw_1001.c.

Update priority level for a specific channel.

Parameters:

[in]	hDevice	ADMW1001 device context handle
[in]	eChannelId	Selects the channel to be updated
[in]	ePriority	Specifies the channel priority level

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers. Allows individual channels to be dynamically re-prioritised.

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Update the extra settling time for a specified channel.

Parameters:

[in]	hDevice	ADMW1001 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

• ADMW_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 admw_ApplyConfigUpdates() is called

Definition at line 1893 of file admw_1001.c.

Update the measurement threshold limits for a specified channel.

Parameters:

[in]	hDevice	ADMW1001 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

• ADMW_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 admw_ApplyConfigUpdates() is called

Definition at line 1834 of file admw_1001.c.

Update diagnostics configuration settings on the device.

Parameters:

[in]	hDevice	ADMW1001 device context handle
[in]	pDiagnosticsConfig	Diagnostics configuration details

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Definition at line 1169 of file admw_1001.c.

Write Look-Up Table data to the device memory.

Parameters:

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

Returns:

Status

• ADMW_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 admw_ApplyConfigUpdates() is called

Definition at line 2165 of file admw_1001.c.

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

Parameters:

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

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Definition at line 2080 of file admw_1001.c.

Update measurement configuration settings on the device.

Parameters:

[in]	hDevice	ADMW1001 device context handle
[in]	pMeasurementConfig	Measurement configuration details

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Definition at line 1096 of file admw_1001.c.

Set a sensor specific parameter for a specified channel.

Parameters:

[in]	hDevice	ADMW1001 device context handle
[in]	eChannelId	Selects the channel to be updated
[in]	fSensorParam	Sensor specific parameter

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers. Allows optional sensor-specific parameter to be specified

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Definition at line 1880 of file admw_1001.c.

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

Parameters:

[in]	hDevice	ADMW1001 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

• ADMW_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.

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

Parameters:

[in]	hDevice	ADMW1001 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

• ADMW_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 700 of file admw_1001.c.