Test, please delete

Embed: (wiki syntax)

« Back to documentation index

ADI_SENSE_1000_CHANNEL_CONFIG Struct Reference

ADI_SENSE_1000_CHANNEL_CONFIG Struct Reference
[ADSNS1000 Host Library API]

#include <adi_sense_1000_config.h>

Data Fields

bool_t enableChannel
bool_t enableFFT
bool_t disablePublishing
ADI_SENSE_1000_CHANNEL_ID compensationChannel
bool_t enableUnityLut
ADI_SENSE_1000_MEASUREMENT_UNIT measurementUnit
float32_t lowThreshold
float32_t highThreshold
float32_t offsetAdjustment
float32_t gainAdjustment
float32_t sensorParameter
uint32_t measurementsPerCycle
uint32_t cycleSkipCount
uint32_t extraSettlingTime
ADI_SENSE_1000_CHANNEL_PRIORITY priority
union {
   ADI_SENSE_1000_ADC_CHANNEL_CONFIG   adcChannelConfig
   ADI_SENSE_1000_I2C_CHANNEL_CONFIG   i2cChannelConfig
   ADI_SENSE_1000_SPI_CHANNEL_CONFIG   spiChannelConfig
   ADI_SENSE_1000_UART_CHANNEL_CONFIG   uartChannelConfig
}; 

Detailed Description

ADSNS1000 Measurement Channel configuration details

Definition at line 780 of file adi_sense_1000_config.h.


Field Documentation

union { ... }

Only one of adcChannelConfig, i2cChannelConfig, spiChannelConfig or uartChannelConfig is required, depending on the channel designation (analog, I2C, SPI or UART)

ADC channel configuration - applicable only to ADC channels

Definition at line 863 of file adi_sense_1000_config.h.

Optional compensation channel. Set to ADI_SENSE_1000_CHANNEL_ID_NONE if not required. Typically used for thermocouple sensors that require a separate measurement of the "cold-junction" temperature, which can be be provided by an RTD temperature sensor connected on a separate "compensation channel"

Definition at line 795 of file adi_sense_1000_config.h.

uint32_t cycleSkipCount

Optional number of cycles to skip, such that this channel is included in the sequence in only one of every (cycleSkipCount + 1) cycles that occur. If set to 0 (default), this channel is included in every cycle; if set to 1, this channel is included in every 2nd cycle; if set to 2, this channel is included in every 3rd cycle, and so on.

Definition at line 841 of file adi_sense_1000_config.h.

Option to disable publishing of data samples from this channel. The channel may still be included in measurement cycles, but data samples obtained from this channel will not be published. This is typically used for channels which are required only as a compensation reference for another channel (e.g. Cold-Junction Compensation channels).

Definition at line 788 of file adi_sense_1000_config.h.

bool_t enableChannel

Option to enable this channel. If set to false, all other fields are ignored and this channel will be omitted from measurement cycles

Definition at line 782 of file adi_sense_1000_config.h.

bool_t enableFFT

Option to include this channel in FFT mode measurements

Definition at line 786 of file adi_sense_1000_config.h.

Option to choose the LUT for calculations, this implies that the fundamental measurement for the sensor (typically mV or Ohms) would be returned as the measurement result.

Definition at line 801 of file adi_sense_1000_config.h.

A minimum settling time is applied internally for each channel, based on the sensor type. However, additional settling time (microseconds) can optionally be specified. Set to 0 if not required.

Definition at line 848 of file adi_sense_1000_config.h.

float32_t gainAdjustment

Optional gain adjustment value applied to each processed sample. Set to NaN or 1.0 if not required.

Definition at line 827 of file adi_sense_1000_config.h.

float32_t highThreshold

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.

Definition at line 817 of file adi_sense_1000_config.h.

I2C channel configuration - applicable only to I2C channels

Definition at line 865 of file adi_sense_1000_config.h.

float32_t lowThreshold

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.

Definition at line 811 of file adi_sense_1000_config.h.

The number of measurements to obtain from this channel within each cycle. Each enabled channel is measured in turn, until the number of measurements requested for the channel has been reached. A different number of measurements-per-cycle may be specified for each channel.

Definition at line 835 of file adi_sense_1000_config.h.

Optional measurement unit selection for conversion results. Applicable only for certain sensor types. Set to ADI_SENSE_1000_MEASUREMENT_UNIT_DEFAULT if not applicable.

Definition at line 806 of file adi_sense_1000_config.h.

float32_t offsetAdjustment

Optional offset adjustment value applied to each processed sample. Set to NaN or 0.0 if not required.

Definition at line 823 of file adi_sense_1000_config.h.

By default, channels are arranged in the measurement sequence based on ascending order of channel ID. However, a priority-level may be specified per channel to force a different ordering of the channels, with higher-priority channels appearing before lower-priority channels. Channels with equal priority are ordered by ascending order of channel ID. Lower numbers indicate higher priority, with 0 being the highest. Set to 0 if not required.

Definition at line 853 of file adi_sense_1000_config.h.

float32_t sensorParameter

Optional sensor parameter adjustment. Set to NaN or 0 if not required.

Definition at line 831 of file adi_sense_1000_config.h.

SPI channel configuration - applicable only to SPI channels

Definition at line 867 of file adi_sense_1000_config.h.

UART channel configuration - applicable only to UART channels

Definition at line 869 of file adi_sense_1000_config.h.