CAC_smartcushion / Mbed OS 2Temp_ADISense1000_Example

Fork of ADISense1000_Example_FW by Analog Devices

Embed: (wiki syntax)

« Back to documentation index

ADI_SENSE_1000_CHANNEL_CONFIG Struct Reference

ADI_SENSE_1000_CHANNEL_CONFIG Struct Reference
[ADI Sense 1000 Host Library API]

#include <adi_sense_1000_config.h>

Data Fields

bool_t enableChannel
bool_t disablePublishing
ADI_SENSE_1000_CHANNEL_ID compensationChannel
ADI_SENSE_1000_MEASUREMENT_UNIT measurementUnit
float32_t lowThreshold
float32_t highThreshold
float32_t offsetAdjustment
float32_t gainAdjustment
uint32_t measurementsPerCycle
uint32_t extraSettlingTime
union {
   ADI_SENSE_1000_ADC_CHANNEL_CONFIG   adcChannelConfig
   ADI_SENSE_1000_I2C_CHANNEL_CONFIG   i2cChannelConfig
   ADI_SENSE_1000_SPI_CHANNEL_CONFIG   spiChannelConfig
}; 

Detailed Description

ADI Sense 1000 Measurement Channel configuration details

Definition at line 471 of file adi_sense_1000_config.h.


Field Documentation

union { ... }

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

ADC channel configuration - applicable only to ADC channels

Definition at line 527 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 484 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 477 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 473 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 521 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 511 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 501 of file adi_sense_1000_config.h.

I2C channel configuration - applicable only to I2C channels

Definition at line 529 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 495 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 515 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 490 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 507 of file adi_sense_1000_config.h.

SPI channel configuration - applicable only to SPI channels

Definition at line 531 of file adi_sense_1000_config.h.