Test, please delete
ADSNS1000 Host Library API
[ADISENSE Host Library API]
Detailed Description
ADSNS1000 device-specific API function prototypes. These are supplementary to the common ADISENSE Host Library API.
Enumeration Type Documentation
ADSNS1000 analog sensor excitation current output level options
- Note:
- applicable only to ADC analog sensor channels, and specific sensor types
- Enumerator:
Definition at line 232 of file adi_sense_1000_config.h.
ADSNS1000 analog sensor excitation current ratios used for diode sensor
- Note:
- applicable only to a diode sensor
Definition at line 253 of file adi_sense_1000_config.h.
ADSNS1000 analog filter selection options
- Note:
- applicable only to ADC analog sensor channels
- Enumerator:
ADI_SENSE_1000_ADC_FILTER_SINC4 SINC4 filter
- Note:
- The number of input samples to be averaged by the filter must be specified by fs (see ADI_SENSE_1000_ADC_FILTER_CONFIG). The fs value affects the output sample rate and settling times of the ADC
ADI_SENSE_1000_ADC_FILTER_FIR_20SPS FIR post filter, producing a 20sps output sample rate
ADI_SENSE_1000_ADC_FILTER_FIR_25SPS FIR post filter, producing a 25sps output sample rate
Definition at line 307 of file adi_sense_1000_config.h.
ADSNS1000 analog input signal amplification gain options
- Note:
- applicable only to ADC analog sensor channels
- Enumerator:
Definition at line 208 of file adi_sense_1000_config.h.
ADSNS1000 analog reference selection options
- Note:
- applicable only to ADC analog sensor channels, and specific sensor types
- Enumerator:
ADI_SENSE_1000_ADC_REFERENCE_NONE No reference is selected
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_INTERNAL_1 Internal reference resistor #1 (4320 ohms) is selected
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_INTERNAL_2 Internal reference resistor #2 (10000 ohms) is selected
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_INTERNAL Internal ADC voltage reference (2.5V) is selected
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_AVDD Analag Supply Voltage AVDD reference (typically 3.3V) is selected
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_EXTERNAL_1 External user-supplied reference resistor #1 is selected
- Note:
- reference resistor value externalRef1Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_RESISTOR_EXTERNAL_2 External user-supplied reference resistor #2 is selected
- Note:
- reference resistor value externalRef2Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_EXTERNAL_1 External user-supplied reference voltage #1 is selected
- Note:
- reference voltage value externalRef1Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_VOLTAGE_EXTERNAL_2 External user-supplied reference voltage #2 is selected
- Note:
- reference voltage value externalRef2Value must be specified (see ADI_SENSE_1000_MEASUREMENT_CONFIG)
ADI_SENSE_1000_ADC_REFERENCE_BRIDGE_EXCITATION Bridge Excition Voltage is selected as reference
- Note:
- this reference MUST be selected for 4/6-wire bridge sensor types (see ADI_SENSE_1000_ADC_SENSOR_TYPE)
Definition at line 263 of file adi_sense_1000_config.h.
ADSNS1000 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.
-
The sensor type name may include a classification suffix:
- _DEF_L1: pre-defined sensor using built-in linearisation data
- _DEF_L2: pre-defined sensor using user-supplied linearisation data Where the suffix is absent, assume the _DEF_L1 classification above.
- Enumerator:
Definition at line 105 of file adi_sense_1000_sensor_types.h.
ADSNS1000 calibration mode options
- Enumerator:
Definition at line 140 of file adi_sense_1000_config.h.
ADSNS1000 measurement channel identifiers
- Enumerator:
Definition at line 55 of file adi_sense_1000_sensor_types.h.
ADSNS1000 channel priority options
Definition at line 84 of file adi_sense_1000_config.h.
ADSNS1000 measurement cycle types
- Enumerator:
Definition at line 160 of file adi_sense_1000_config.h.
ADSNS1000 data ready mode options
- Enumerator:
ADI_SENSE_1000_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
ADI_SENSE_1000_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
ADI_SENSE_1000_DATAREADY_PER_MULTICYCLE_BURST The DATAREADY signal is asserted after completion of each burst of measurement cycles
- applicable only when ADI_SENSE_1000_OPERATING_MODE_MULTICYCLE is also selected
- data samples only from the lastest completed burst of measurement cycles are stored in this mode
Definition at line 117 of file adi_sense_1000_config.h.
ADSNS1000 I2C clock speed options
- Note:
- applicable only for I2C sensors
- Enumerator:
ADI_SENSE_1000_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_100K 100kHz I2C clock speed
ADI_SENSE_1000_DIGITAL_SENSOR_COMMS_I2C_CLOCK_SPEED_400K 400kHz I2C clock speed
Definition at line 377 of file adi_sense_1000_config.h.
ADSNS1000 SPI clock speed options
- Note:
- applicable only for SPI sensors
- Enumerator:
Definition at line 455 of file adi_sense_1000_config.h.
ADSNS1000 SPI mode options
- Note:
- applicable only for SPI sensors
- Enumerator:
Definition at line 439 of file adi_sense_1000_config.h.
ADSNS1000 UART baud rate options
- Note:
- applicable only for UART sensors
- Enumerator:
Definition at line 389 of file adi_sense_1000_config.h.
ADSNS1000 UART line config options
- Note:
- applicable only for UART sensors
- Enumerator:
Definition at line 413 of file adi_sense_1000_config.h.
ADSNS1000 digital sensor data encoding
- Note:
- applicable only to SPI and I2C digital sensor channels
- Enumerator:
Definition at line 608 of file adi_sense_1000_config.h.
ADSNS1000 FFT sequence mode options
- Note:
- applicable only for FFT measurement modes
- Enumerator:
ADI_SENSE_1000_FFT_MODE_SINGLE Performs a single sequence of FFTs on selected channels and stops
ADI_SENSE_1000_FFT_MODE_CONTINUOUS Performs continuous sequences of FFTs on selected channels
Definition at line 325 of file adi_sense_1000_config.h.
ADSNS1000 FFT output format options
- Note:
- applicable only for FFT measurement modes
- Enumerator:
Definition at line 364 of file adi_sense_1000_config.h.
ADSNS1000 FFT size options (number of bins)
- Note:
- applicable only for FFT measurement modes
- Enumerator:
ADI_SENSE_1000_FFT_SIZE_256 256 bins
ADI_SENSE_1000_FFT_SIZE_512 512 bins
ADI_SENSE_1000_FFT_SIZE_1024 1024 bins
ADI_SENSE_1000_FFT_SIZE_2048 2048 bins
Definition at line 336 of file adi_sense_1000_config.h.
ADSNS1000 FFT window type options
- Note:
- applicable only for FFT measurement modes
- Enumerator:
ADI_SENSE_1000_FFT_WINDOW_NONE No Window
ADI_SENSE_1000_FFT_WINDOW_HANN Hann Window
ADI_SENSE_1000_FFT_WINDOW_BLACKMAN_HARRIS Blackman-Harris Window
Definition at line 351 of file adi_sense_1000_config.h.
ADSNS1000 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:
Definition at line 801 of file adi_sense_1000_sensor_types.h.
Linearisation data vector format
- Enumerator:
Definition at line 123 of file adi_sense_1000_lut_data.h.
Linearisation equation type
- Enumerator:
Definition at line 83 of file adi_sense_1000_lut_data.h.
Linearisation look-up table / co-efficient list geometry
- Enumerator:
Definition at line 67 of file adi_sense_1000_lut_data.h.
- Enumerator:
Definition at line 112 of file adi_sense_1000_lut_data.h.
ADSNS1000 measurement unit options
Optionally select a measurement unit for final conversion results. Currently applicable only to specific temperature sensor types.
- Enumerator:
Definition at line 174 of file adi_sense_1000_config.h.
ADSNS1000 Open-Sensor Diagnostics frequency
Select the per-cycle frequency at which open-sensor diagnostic checks should be performed. Open-sensor diagnostic checks typically require specific or time-consuming processing which cannot be executed while a measurement cycle is running.
- Note:
- Open-sensor diagnostic checks, when performed, will add a delay to the start of the next measurement cycle.
- Enumerator:
Definition at line 193 of file adi_sense_1000_config.h.
ADSNS1000 operating mode options
- Enumerator:
Definition at line 107 of file adi_sense_1000_config.h.
ADSNS1000 power mode options
- Enumerator:
Definition at line 150 of file adi_sense_1000_config.h.
ADSNS1000 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
- Enumerator:
Definition at line 883 of file adi_sense_1000_sensor_types.h.
ADSNS1000 UART digital sensor type options
Select the sensor type that is connected to an UART digital measurement channel.
- Note:
- These are pre-defined sensors using built-in linearisation data
- Enumerator:
Definition at line 997 of file adi_sense_1000_sensor_types.h.
Function Documentation
struct __attribute__ | ( | (packed, aligned(4)) | ) | [read, write] |
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
Struct for a 2-dimensional equally-spaced look-up table
Struct for a 2-dimensional not-equally-spaced look-up table
Struct for a 2-dimensional list of coefficients to be used in a bi-variate polynomial equation
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 ADI_SENSE_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
< number of elements for input X.
< number of elements for input Y.
< initial X input value
< interval between successive X input values
< initial Y input value
< interval between successive Y input values
< C99 flexible array, Z matrix[y][x]
< number of elements in array X.
< number of elements in array Y.
< C99 flexible array, Order: X's array, Y's array, Z matrix[y][x]
< number of coefficients
< look-up table range - minimum X input value
< look-up table range - maximum X input value
< look-up table range - minimum Y input value
< look-up table range - maximum Y input value
< C99 flexible array: sorted by ascending X degree then sorted by ascending Y exponent
< Table geometry
< Equation type
< Thermocouple linearisation direction
< Sensor Type ID
< Table vector data type
< Length in bytes of table data section (excluding this header)
< CRC-16-CCITT of the data
< Look-Up Table descriptor
< Look-Up Table data
< Major version number
< Minor version number
< Hard-coded signature value (ADI_SENSE_LUT_SIGNATURE)
< LUT data format version (ADI_SENSE_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 ADI_SENSE_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 133 of file adi_sense_1000_lut_data.h.
ADI_SENSE_RESULT adi_sense_1000_AssembleLutData | ( | ADI_SENSE_1000_LUT * | pLutBuffer, |
unsigned | nLutBufferSize, | ||
unsigned const | nNumTables, | ||
ADI_SENSE_1000_LUT_DESCRIPTOR *const | ppDesc[], | ||
ADI_SENSE_1000_LUT_TABLE_DATA *const | ppData[] | ||
) |
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
- ADI_SENSE_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 adi_sense_1000_SetLutData.
Definition at line 3027 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_GetDataReadyModeInfo | ( | ADI_SENSE_DEVICE_HANDLE const | hDevice, |
ADI_SENSE_MEASUREMENT_MODE const | eMeasurementMode, | ||
ADI_SENSE_1000_OPERATING_MODE *const | peOperatingMode, | ||
ADI_SENSE_1000_DATAREADY_MODE *const | peDataReadyMode, | ||
uint32_t *const | pnSamplesPerDataready, | ||
uint32_t *const | pnSamplesPerCycle, | ||
uint8_t *const | pnBytesPerSample | ||
) |
Get the number of samples available when DATAREADY status is asserted.
- Parameters:
-
[in] hDevice ADISENSE device context handle [in] eMeasurementMode Must be set to the same value used for adi_sense_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
- ADI_SENSE_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 984 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_ReadRegister | ( | ADI_SENSE_DEVICE_HANDLE const | hDevice, |
uint16_t const | nAddress, | ||
void *const | pData, | ||
unsigned const | nLength | ||
) |
Read one or more device registers at the specified register address.
- Parameters:
-
[in] hDevice ADISENSE 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
- ADI_SENSE_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 921 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetChannelConfig | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_CHANNEL_ID | eChannelId, | ||
ADI_SENSE_1000_CHANNEL_CONFIG * | pChannelConfig | ||
) |
Update channel configuration settings for a specific channel.
- Parameters:
-
[in] hDevice ADISENSE device context handle [in] eChannelId Selects the channel to be updated [in] pChannelConfig Channel configuration details
- Returns:
- Status
- ADI_SENSE_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 adi_sense_ApplyConfigUpdates() is called
Definition at line 2718 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetChannelCount | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_CHANNEL_ID | eChannelId, | ||
uint32_t | nMeasurementsPerCycle | ||
) |
Update number of measurements-per-cycle for a specific channel.
- Parameters:
-
[in] hDevice ADISENSE 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
- ADI_SENSE_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 adi_sense_ApplyConfigUpdates() is called
Definition at line 1490 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetChannelPriority | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_CHANNEL_ID | eChannelId, | ||
ADI_SENSE_1000_CHANNEL_PRIORITY | ePriority | ||
) |
Update priority level for a specific channel.
- Parameters:
-
[in] hDevice ADI Sense device context handle [in] eChannelId Selects the channel to be updated [in] ePriority Specifies the channel priority level
- Returns:
- Status
- ADI_SENSE_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 adi_sense_ApplyConfigUpdates() is called
ADI_SENSE_RESULT adi_sense_1000_SetChannelSettlingTime | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_CHANNEL_ID | eChannelId, | ||
uint32_t | nSettlingTime | ||
) |
Update the extra settling time for a specified channel.
- Parameters:
-
[in] hDevice ADISENSE 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
- ADI_SENSE_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 adi_sense_ApplyConfigUpdates() is called
Definition at line 2693 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetChannelThresholdLimits | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_CHANNEL_ID | eChannelId, | ||
float32_t | fHighThresholdLimit, | ||
float32_t | fLowThresholdLimit | ||
) |
Update the measurement threshold limits for a specified channel.
- Parameters:
-
[in] hDevice ADISENSE 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
- ADI_SENSE_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 adi_sense_ApplyConfigUpdates() is called
Definition at line 2634 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetDiagnosticsConfig | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_DIAGNOSTICS_CONFIG * | pDiagnosticsConfig | ||
) |
Update diagnostics configuration settings on the device.
- Parameters:
-
[in] hDevice ADISENSE device context handle [in] pDiagnosticsConfig Diagnostics configuration details
- Returns:
- Status
- ADI_SENSE_SUCCESS Call completed successfully.
Translates configuration details provided into device-specific register settings and updates device configuration registers.
- Note:
- Settings are not applied until adi_sense_ApplyConfigUpdates() is called
Definition at line 1349 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetLutData | ( | ADI_SENSE_DEVICE_HANDLE const | hDevice, |
ADI_SENSE_1000_LUT *const | pLutData | ||
) |
Write Look-Up Table data to the device memory.
- Parameters:
-
[in] hDevice ADISENSE device context handle [out] pLutData Pointer to the Look-Up Table data structure
- Returns:
- Status
- ADI_SENSE_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 adi_sense_ApplyConfigUpdates() is called
Definition at line 2891 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetLutDataRaw | ( | ADI_SENSE_DEVICE_HANDLE const | hDevice, |
ADI_SENSE_1000_LUT_RAW *const | pLutData | ||
) |
Write Look-Up Table raw data to the device memory.
- Parameters:
-
[in] hDevice ADISENSE device context handle [out] pLutData Pointer to the Look-Up Table raw data structure
- Returns:
- Status
- ADI_SENSE_SUCCESS Call completed successfully.
This can be used instead of adi_sense_1000_SetLutData for loading LUT data from the alternative raw data format. See adi_sense_1000_SetLutData for more information.
- Note:
- Settings are not applied until adi_sense_ApplyConfigUpdates() is called
Definition at line 2986 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetMeasurementConfig | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_MEASUREMENT_CONFIG * | pMeasurementConfig | ||
) |
Update measurement configuration settings on the device.
- Parameters:
-
[in] hDevice ADISENSE device context handle [in] pMeasurementConfig Measurement configuration details
- Returns:
- Status
- ADI_SENSE_SUCCESS Call completed successfully.
Translates configuration details provided into device-specific register settings and updates device configuration registers.
- Note:
- Settings are not applied until adi_sense_ApplyConfigUpdates() is called
Definition at line 1305 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetPowerConfig | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_POWER_CONFIG * | pPowerConfig | ||
) |
Update power configuration settings on the device.
- Parameters:
-
[in] hDevice ADISENSE device context handle [in] pPowerConfig Power configuration details
- Returns:
- Status
- ADI_SENSE_SUCCESS Call completed successfully.
Translates configuration details provided into device-specific register settings and updates device configuration registers.
- Note:
- Settings are not applied until adi_sense_ApplyConfigUpdates() is called
Definition at line 1167 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_SetSensorParameter | ( | ADI_SENSE_DEVICE_HANDLE | hDevice, |
ADI_SENSE_1000_CHANNEL_ID | eChannelId, | ||
float32_t | fSensorParam | ||
) |
Set a sensor specific parameter for a specified channel.
- Parameters:
-
[in] hDevice ADI Sense device context handle [in] eChannelId Selects the channel to be updated [in] fSensorParam Sensor specific parameter
- Returns:
- Status
- ADI_SENSE_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 adi_sense_ApplyConfigUpdates() is called
Definition at line 2680 of file adi_sense_1000.c.
ADI_SENSE_RESULT adi_sense_1000_WriteRegister | ( | ADI_SENSE_DEVICE_HANDLE const | hDevice, |
uint16_t const | nAddress, | ||
void *const | pData, | ||
unsigned const | nLength | ||
) |
Write one or more device registers at the specified register address.
- Parameters:
-
[in] hDevice ADISENSE 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
- ADI_SENSE_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 874 of file adi_sense_1000.c.
Generated on Tue Jul 12 2022 18:59:24 by 1.7.2