ADMW1001_CHANNEL_CONFIG Struct Reference
[ADMW1001 Host Library API]

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

ADC channel configuration - applicable only to ADC channels

Definition at line 658 of file admw1001_config.h.

Optional compensation channel. Set to ADMW1001_CH_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 589 of file admw1001_config.h.

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 635 of file admw1001_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 582 of file admw1001_config.h.

Option to include this channel in normal measurement cycles

Definition at line 580 of file admw1001_config.h.

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

Definition at line 642 of file admw1001_config.h.

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

Definition at line 621 of file admw1001_config.h.

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 611 of file admw1001_config.h.

I2C channel configuration - applicable only to I2C channels

Definition at line 660 of file admw1001_config.h.

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 605 of file admw1001_config.h.

Select Look Up Table LUT for calculations, this implies that the fundamental measurement for the sensor (typically mV or Ohms) 0 = default, 1= unity, 2 = custom

Definition at line 595 of file admw1001_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 629 of file admw1001_config.h.

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

Definition at line 600 of file admw1001_config.h.

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

Definition at line 617 of file admw1001_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 647 of file admw1001_config.h.

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

Definition at line 625 of file admw1001_config.h.