« Close

Datasheets and User Guides

Software & Driver

 

14.1 AIN Extended Features [T-Series Datasheet]

AIN Extended Features Overview

Analog Extended Features (AIN-EF) simplify some common analog input applications. Each AIN-EF feature:

  • collects one or more input samples
  • performs math on the collected samples

AIN-EF is only supported in command-response mode and not in stream mode.

Kipling Walkthrough: Kipling's Register Matrix can be used to perform AIN-EF features. For example:

Available AIN Extended Features

For any given AIN channel, one AIN-EF feature may be selected. AIN-EF indices:

Index  AIN-EF Name Supported Devices
0: None (disabled) All T-series
1: Offset and Slope All T-series
3: Max, Min, Avg All T-series
4: Resistance All T-series
5: Average and Threshold All T-series
10: RMS Flex All T-series
11: RMS Auto All T-series
20: Thermocouple type E T7 only
21: Thermocouple type J T7 only
22: Thermocouple type K T7 only
23: Thermocouple type R T7 only
24: Thermocouple type T T7 only
25: Thermocouple type S T7 only
30: Thermocouple type C T7 only
40: RTD PT100 All T-series
41: RTD PT500 All T-series
42: RTD PT1000 All T-series
50: Thermistor using Steinhart-Hart equation All T-series
51: Thermistor using Beta equation All T-series

AIN-EF Usage

To use any AIN-EF:

  1. Set the EF_INDEX to select an extended feature
  2. Configure the extended feature using the EF_CONFIG registers
  3. Configure normal AIN configurations through the normal AIN registers
  4. Read from READ_A to perform the extended feature operation
  5. Read additional results from B, C, and D

For a quick example of setting up an AIN-EF in thermocouple mode, see Configuring & Reading a Thermocouple.

1. Set the AIN#_EF_INDEX to select an extended feature

Name Start Address Type Access

AIN#(0:13)_EF_INDEX             Specify the desired extended feature for this analog input with the index value. List of index values: 0=None(disabled); 1=Offset and Slope; 3=Max/Min/Avg; 4=Resistance; 5=Average and Threshold; 10=RMS Flex; 11=FlexRMS; 20=Thermocouple type E; 21=Thermocouple type J; 22=Thermocouple type K; 23=Thermocouple type R; 24=Thermocouple type T; 25=Thermocouple type S; 30=Thermocouple type C; 40=RTD model PT100; 41=RTD model PT500; 42=RTD model PT1000.

9000 UINT32 R/W

AIN_ALL_EF_INDEX             Write 0 to deactivate AIN_EF on all AINs. No other values may be written to this register. Reads will return the AIN_EF index if all 128 AINs are set to the same value. If values are not the same returns 0xFFFF (65535).

43906 UINT32 R/W

Write to AIN#(0:14)_EF_INDEX or AIN_ALL_EF_INDEX to select the AIN extended feature. 

2. Configure the extended feature using the AIN#_EF_CONFIG registers

Name Start Address Type Access

AIN#(0:13)_EF_CONFIG_A             Function dependent on selected feature index.

9300 UINT32 R/W

AIN#(0:13)_EF_CONFIG_B             Function dependent on selected feature index.

9600 UINT32 R/W

AIN#(0:13)_EF_CONFIG_C             Function dependent on selected feature index.

9900 UINT32 R/W

AIN#(0:13)_EF_CONFIG_D             Function dependent on selected feature index.

10200 FLOAT32 R/W

AIN#(0:13)_EF_CONFIG_E             Function dependent on selected feature index.

10500 FLOAT32 R/W

AIN#(0:13)_EF_CONFIG_F             Function dependent on selected feature index.

10800 FLOAT32 R/W

AIN#(0:13)_EF_CONFIG_G             Function dependent on selected feature index.

11100 FLOAT32 R/W

Each AIN-EF index requires different configuration parameters, so the meaning of the AIN#_EF_CONFIG registers depend on which AIN#_EF_INDEX is set.

3. Configure normal AIN configurations through the normal AIN registers

Analog input range, resolution, settling, and negative channel settings are configured through the normal AIN registers.

4. Read from AIN#_EF_READ_A to perform the extended feature operation

Name Start Address Type Access

AIN#(0:13)_EF_READ_A             Function dependent on selected feature index.

7000 FLOAT32 R

Only reading AIN#_EF_READ_A will trigger the selected AIN-EF operation. The AIN#_EF_READ_A result is returned. Additional results are saved for later retrieval.

If the AIN-EF index uses stream-burst, reading AIN#_EF_READ_A will block for the length of time it takes to collect the necessary samples.

5. Read additional results B, C, and D

Name Start Address Type Access

AIN#(0:13)_EF_READ_B             Function dependent on selected feature index.

7300 FLOAT32 R/W

AIN#(0:13)_EF_READ_C             Function dependent on selected feature index.

7600 FLOAT32 R/W

AIN#(0:13)_EF_READ_D             Function dependent on selected feature index.

7900 FLOAT32 R

Reading from result registers other than AIN#_EF_READ_A will read the saved values and will not initiate a new reading.