Jake Greaves / Mbed OS AdiSense1000_V21

Test, please delete

Embed: (wiki syntax)

« Back to documentation index

ADISENSE Host Library API
Data Structures | Modules | Typedefs | Enumerations | Functions

ADISENSE Host Library API

Data Structures

struct  ADI_SENSE_CONNECTION
struct  ADI_SENSE_STATUS
struct  ADI_SENSE_DATA_SAMPLE
struct  ADI_SENSE_CONFIG_VERSION_ID
struct  ADI_SENSE_CONFIG

Modules

 ADSNS1000 Host Library API

Typedefs

typedef void * ADI_SENSE_DEVICE_HANDLE

Enumerations

enum  ADI_SENSE_CONNECTION_TYPE { ADI_SENSE_CONNECTION_TYPE_SPI = 1 }
enum  ADI_SENSE_DEVICE_STATUS_FLAGS {
  ADI_SENSE_DEVICE_STATUS_BUSY = (1 << 0), ADI_SENSE_DEVICE_STATUS_DATAREADY = (1 << 1), ADI_SENSE_DEVICE_STATUS_ERROR = (1 << 2), ADI_SENSE_DEVICE_STATUS_ALERT = (1 << 3),
  ADI_SENSE_DEVICE_STATUS_FIFO_ERROR = (1 << 4), ADI_SENSE_DEVICE_STATUS_CONFIG_ERROR = (1 << 5), ADI_SENSE_DEVICE_STATUS_LUT_ERROR = (1 << 6), ADI_SENSE_DEVICE_STATUS_EXT_FLASH_ERROR = (1 << 7)
}
enum  ADI_SENSE_DIAGNOSTICS_STATUS_FLAGS {
  ADI_SENSE_DIAGNOSTICS_STATUS_CHECKSUM_ERROR = (1 << 0), ADI_SENSE_DIAGNOSTICS_STATUS_COMMS_ERROR = (1 << 1), ADI_SENSE_DIAGNOSTICS_STATUS_SUPPLY_MONITOR_ERROR = (1 << 2), ADI_SENSE_DIAGNOSTICS_STATUS_SUPPLY_CAP_ERROR = (1 << 3),
  ADI_SENSE_DIAGNOSTICS_STATUS_CONVERSION_ERROR = (1 << 8), ADI_SENSE_DIAGNOSTICS_STATUS_CALIBRATION_ERROR = (1 << 9)
}
enum  ADI_SENSE_CHANNEL_ALERT_FLAGS {
  ADI_SENSE_CHANNEL_ALERT_TIMEOUT = (1 << 0), ADI_SENSE_CHANNEL_ALERT_UNDER_RANGE = (1 << 1), ADI_SENSE_CHANNEL_ALERT_OVER_RANGE = (1 << 2), ADI_SENSE_CHANNEL_ALERT_LOW_LIMIT = (1 << 3),
  ADI_SENSE_CHANNEL_ALERT_HIGH_LIMIT = (1 << 4), ADI_SENSE_CHANNEL_ALERT_SENSOR_OPEN = (1 << 5), ADI_SENSE_CHANNEL_ALERT_REF_DETECT = (1 << 6), ADI_SENSE_CHANNEL_ALERT_CONFIG_ERR = (1 << 7),
  ADI_SENSE_CHANNEL_ALERT_LUT_ERR = (1 << 8), ADI_SENSE_CHANNEL_ALERT_SENSOR_NOT_READY = (1 << 9), ADI_SENSE_CHANNEL_ALERT_COMP_NOT_READY = (1 << 10), ADI_SENSE_CHANNEL_ALERT_LUT_UNDER_RANGE = (1 << 13),
  ADI_SENSE_CHANNEL_ALERT_LUT_OVER_RANGE = (1 << 14)
}
enum  ADI_SENSE_MEASUREMENT_MODE { ADI_SENSE_MEASUREMENT_MODE_HEALTHCHECK = 1, ADI_SENSE_MEASUREMENT_MODE_NORMAL, ADI_SENSE_MEASUREMENT_MODE_OMIT_RAW, ADI_SENSE_MEASUREMENT_MODE_FFT }
enum  ADI_SENSE_USER_CONFIG_SLOT
enum  ADI_SENSE_PRODUCT_ID { ADI_SENSE_PRODUCT_ID_ADSNS1000 = 0x0020 }

Functions

ADI_SENSE_RESULT adi_sense_Open (unsigned const nDeviceIndex, ADI_SENSE_CONNECTION *const pConnectionInfo, ADI_SENSE_DEVICE_HANDLE *const phDevice)
 Open ADISENSE device handle and set up communication interface.
ADI_SENSE_RESULT adi_sense_Close (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Close ADISENSE device context and free resources.
ADI_SENSE_RESULT adi_sense_GetGpioState (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_GPIO_PIN const ePinId, bool_t *const pbAsserted)
 Get the current state of the specified GPIO input signal.
ADI_SENSE_RESULT adi_sense_RegisterGpioCallback (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_GPIO_PIN const ePinId, ADI_SENSE_GPIO_CALLBACK const callbackFunction, void *const pCallbackParam)
 Register an application-defined callback function for GPIO interrupts.
ADI_SENSE_RESULT adi_sense_Shutdown (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Trigger a shut down of the device.
ADI_SENSE_RESULT adi_sense_Reset (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Reset the ADISENSE device.
ADI_SENSE_RESULT adi_sense_GetDeviceReadyState (ADI_SENSE_DEVICE_HANDLE const hDevice, bool_t *const pbReady)
 Check if the device is ready, following power-up or a reset.
ADI_SENSE_RESULT adi_sense_GetProductID (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_PRODUCT_ID *const pProductId)
 Obtain the product ID from the device.
ADI_SENSE_RESULT adi_sense_SetConfig (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_CONFIG *const pConfig)
 Write full configuration settings to the device registers.
ADI_SENSE_RESULT adi_sense_ApplyConfigUpdates (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Apply the configuration settings currently stored in device registers.
ADI_SENSE_RESULT adi_sense_SaveConfig (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_USER_CONFIG_SLOT const eSlotId)
 Store the configuration settings to persistent memory on the device.
ADI_SENSE_RESULT adi_sense_RestoreConfig (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_USER_CONFIG_SLOT const eSlotId)
 Restore configuration settings from persistent memory on the device.
ADI_SENSE_RESULT adi_sense_EraseExternalFlash (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Erases the external flash memory.
ADI_SENSE_RESULT adi_sense_GetExternalFlashSampleCount (ADI_SENSE_DEVICE_HANDLE const hDevice, uint32_t *nSampleCount)
 Gets the number of samples stored in the external flash memory.
ADI_SENSE_RESULT adi_sense_GetExternalFlashData (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_DATA_SAMPLE *const pSamples, uint32_t const nIndex, uint32_t const nRequested, uint32_t *const pnReturned)
 Read measurement samples stored in the the external flash memory.
ADI_SENSE_RESULT adi_sense_SaveLutData (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Store the LUT data to persistent memory on the device.
ADI_SENSE_RESULT adi_sense_RestoreLutData (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Restore LUT data from persistent memory on the device.
ADI_SENSE_RESULT adi_sense_StartMeasurement (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_MEASUREMENT_MODE const eMeasurementMode)
 Start the measurement cycles on the device.
ADI_SENSE_RESULT adi_sense_StopMeasurement (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Stop the measurement cycles on the device.
ADI_SENSE_RESULT adi_sense_RunDiagnostics (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Run built-in diagnostic checks on the device.
ADI_SENSE_RESULT adi_sense_RunCalibration (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Run built-in calibration on the device.
ADI_SENSE_RESULT adi_sense_RunDigitalCalibration (ADI_SENSE_DEVICE_HANDLE const hDevice)
 Run built-in digital calibration on the device.
ADI_SENSE_RESULT adi_sense_GetStatus (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_STATUS *const pStatus)
 Read the current status from the device registers.
ADI_SENSE_RESULT adi_sense_GetData (ADI_SENSE_DEVICE_HANDLE const hDevice, ADI_SENSE_MEASUREMENT_MODE const eMeasurementMode, ADI_SENSE_DATA_SAMPLE *const pSamples, uint8_t const nBytesPerSample, uint32_t const nRequested, uint32_t *const pnReturned)
 Read measurement data samples from the device registers.
ADI_SENSE_RESULT adi_sense_GetCommandRunningState (ADI_SENSE_DEVICE_HANDLE hDevice, bool_t *pbCommandRunning)
 Check if a command is currently running on the device.

Detailed Description

Host library API common to the ADISENSE product family.

Typedef Documentation

typedef void* ADI_SENSE_DEVICE_HANDLE

A handle used in all API functions to identify the ADISENSE device.

Definition at line 68 of file adi_sense_api.h.

Enumeration Type Documentation

enum ADI_SENSE_CHANNEL_ALERT_FLAGS

Bit masks (flags) for the different channel alert indicators.

Enumerator:
ADI_SENSE_CHANNEL_ALERT_TIMEOUT 

Indicates timeout condition detected on the channel

ADI_SENSE_CHANNEL_ALERT_UNDER_RANGE 

Indicates raw sample under valid input range, possibly clamped

ADI_SENSE_CHANNEL_ALERT_OVER_RANGE 

Indicates raw sample over valid input range, possibly clamped

ADI_SENSE_CHANNEL_ALERT_LOW_LIMIT 

Indicates measurement result was below configured minimum threshold

ADI_SENSE_CHANNEL_ALERT_HIGH_LIMIT 

Indicates measurement result was above configured maximum threshold

ADI_SENSE_CHANNEL_ALERT_SENSOR_OPEN 

Indicates open circuit or mis-wire condition detected on the channel

ADI_SENSE_CHANNEL_ALERT_REF_DETECT 

Indicates reference-detect error condition detected on the channel

ADI_SENSE_CHANNEL_ALERT_CONFIG_ERR 

Indicates configuration error condition detected on the channel

ADI_SENSE_CHANNEL_ALERT_LUT_ERR 

Indicates look-up table error condition detected on the channel

ADI_SENSE_CHANNEL_ALERT_SENSOR_NOT_READY 

Indicates digital sensor not-ready error condition detected on the channel

ADI_SENSE_CHANNEL_ALERT_COMP_NOT_READY 

Indicates compensation channel not-ready error condition detected on the channel

ADI_SENSE_CHANNEL_ALERT_LUT_UNDER_RANGE 

Indicates raw sample was under the available LUT/equation range

ADI_SENSE_CHANNEL_ALERT_LUT_OVER_RANGE 

Indicates raw sample was over the available LUT/equation range

Definition at line 125 of file adi_sense_api.h.

enum ADI_SENSE_CONNECTION_TYPE

Supported connection types for communication with the ADISENSE device.

Enumerator:
ADI_SENSE_CONNECTION_TYPE_SPI 

Serial Peripheral Interface (SPI) connection type

Definition at line 71 of file adi_sense_api.h.

enum ADI_SENSE_DEVICE_STATUS_FLAGS

Bit masks (flags) for the different device status indicators.

Enumerator:
ADI_SENSE_DEVICE_STATUS_BUSY 

Indicates that a command is currently running on the device

ADI_SENSE_DEVICE_STATUS_DATAREADY 

Indicates the availability of measurement data for retrieval

ADI_SENSE_DEVICE_STATUS_ERROR 

Indicates that an error condition has been detected by the device

ADI_SENSE_DEVICE_STATUS_ALERT 

Indicates that an alert condition has been detected by the device

ADI_SENSE_DEVICE_STATUS_FIFO_ERROR 

Indicates that a FIFO error condition has been detected by the device

ADI_SENSE_DEVICE_STATUS_CONFIG_ERROR 

Indicates that a configuration error condition has been detected by the device

ADI_SENSE_DEVICE_STATUS_LUT_ERROR 

Indicates that a look-up table error condition has been detected by the device

ADI_SENSE_DEVICE_STATUS_EXT_FLASH_ERROR 

Indicates that an external flash memory error condition has been detected by the device

Definition at line 89 of file adi_sense_api.h.

enum ADI_SENSE_DIAGNOSTICS_STATUS_FLAGS

Bit masks (flags) for the different diagnostics status indicators.

Enumerator:
ADI_SENSE_DIAGNOSTICS_STATUS_CHECKSUM_ERROR 

Indicates Error on Internal Checksum Calculations

ADI_SENSE_DIAGNOSTICS_STATUS_COMMS_ERROR 

Indicates Error on Internal Device Communications

ADI_SENSE_DIAGNOSTICS_STATUS_SUPPLY_MONITOR_ERROR 

Indicates Low Voltage on Internal Supply Voltages

ADI_SENSE_DIAGNOSTICS_STATUS_SUPPLY_CAP_ERROR 

Indicates Fault on Internal Supply Regulator Capacitor

ADI_SENSE_DIAGNOSTICS_STATUS_CONVERSION_ERROR 

Indicates Error During Internal ADC Conversions

ADI_SENSE_DIAGNOSTICS_STATUS_CALIBRATION_ERROR 

Indicates Error During Internal Device Calibrations

Definition at line 109 of file adi_sense_api.h.

enum ADI_SENSE_MEASUREMENT_MODE

Measurement mode options for the ADISENSE device. adi_sense_StartMeasurement

Enumerator:
ADI_SENSE_MEASUREMENT_MODE_HEALTHCHECK 

In this mode, a special health-check measurement cycle is executed, carrying out a single conversion per channel with measurement diagnostics enabled, intended for use as a system health check.

ADI_SENSE_MEASUREMENT_MODE_NORMAL 

In this mode, normal measurement cycle(s) are executed and data samples are returned with raw measurement values included.

ADI_SENSE_MEASUREMENT_MODE_OMIT_RAW 

In this mode, normal measurement cycle(s) are executed and data samples are returned with raw measurement values omitted for efficiency.

ADI_SENSE_MEASUREMENT_MODE_FFT 

In this mode, FFT mode measurement cycle(s) are executed and data samples are returned based on FFT-specific configuration parameters.

Definition at line 190 of file adi_sense_api.h.

enum ADI_SENSE_PRODUCT_ID

A list of supported product identifiers

Enumerator:
ADI_SENSE_PRODUCT_ID_ADSNS1000 

ADSNS1000

Definition at line 62 of file adi_sense_config_types.h.

enum ADI_SENSE_USER_CONFIG_SLOT

Identifiers for the user configuration slots in persistent memory.

Definition at line 207 of file adi_sense_api.h.

Function Documentation

ADI_SENSE_RESULT adi_sense_ApplyConfigUpdates ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Apply the configuration settings currently stored in device registers.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to reload and apply configuration from the device configuration registers. Changes to configuration registers are ignored by the device until this function is called.

Note:
No other command must be running when this is called.

Definition at line 483 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_Close ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Close ADISENSE device context and free resources.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Definition at line 862 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_EraseExternalFlash ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Erases the external flash memory.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Sends the bulk erase instruction to the external flash device. All stored samples are deleted. It is a blocking operation and takes tens of seconds to complete.

Note:
No other command must be running when this is called.

Definition at line 578 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetCommandRunningState ( ADI_SENSE_DEVICE_HANDLE  hDevice,
bool_t *  pbCommandRunning 
)

Check if a command is currently running on the device.

Parameters:
[in]hDeviceADISENSE device context handle
[out]pbCommandRunningPointer to return the command running status
Returns:
Status

Reads the device status register to check if a command is running.

Definition at line 419 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetData ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_MEASUREMENT_MODE const   eMeasurementMode,
ADI_SENSE_DATA_SAMPLE *const   pSamples,
uint8_t const   nBytesPerSample,
uint32_t const   nRequested,
uint32_t *const   pnReturned 
)

Read measurement data samples from the device registers.

Parameters:
[in]hDeviceADISENSE device context handle
[in]eMeasurementModeMust be set to the same value used for adi_sense_StartMeasurement().
[out]pSamplesPointer to return a set of requested data samples.
[in]nBytesPerSampleThe size, in bytes, of each sample.
[in]nRequestedNumber of requested data samples.
[out]pnReturnedNumber of valid data samples successfully retrieved.
Returns:
Status

Reads the status registers and extracts the relevant information to return to the caller.

Note:
This is intended to be called only when the DATAREADY status signal is asserted.

Definition at line 768 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetDeviceReadyState ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
bool_t *const   pbReady 
)

Check if the device is ready, following power-up or a reset.

Parameters:
[in]hDeviceADISENSE device context handle
[out]pbReadyPointer to return true if the device is ready, or false otherwise
Returns:
Status

This function attempts to read a fixed-value device register via the communication interface.

Definition at line 971 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetExternalFlashData ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_DATA_SAMPLE *const   pSamples,
uint32_t const   nIndex,
uint32_t const   nRequested,
uint32_t *const   pnReturned 
)

Read measurement samples stored in the the external flash memory.

Parameters:
[in]hDeviceADISENSE device context handle
[out]pSamplesPointer to return a set of requested data samples.
[in]nStartIndexIndex of first sample to retrieve.
[in]nBytesPerSampleThe size, in bytes, of each sample.
[in]nRequestedNumber of requested data samples.
[out]pnReturnedNumber of valid data samples successfully retrieved.
Returns:
Status

Reads the status registers and extracts the relevant information to return to the caller.

Definition at line 615 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetExternalFlashSampleCount ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
uint32_t *  nSampleCount 
)

Gets the number of samples stored in the external flash memory.

Parameters:
[in]hDeviceADISENSE device context handle
[in]pSampleCountAddress of the return value.
Returns:
Status
Note:
No other command must be running when this is called.

Definition at line 588 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetGpioState ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_GPIO_PIN const   ePinId,
bool_t *const   pbAsserted 
)

Get the current state of the specified GPIO input signal.

Parameters:
[in]hDeviceADISENSE device context handle
[in]ePinIdGPIO pin to query
[out]pbAssertedPointer to return the state of the status signal GPIO pin
Returns:
Status

Sets *pbAsserted to true if the status signal is asserted, or false otherwise.

Definition at line 248 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetProductID ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_PRODUCT_ID *const   pProductId 
)

Obtain the product ID from the device.

Parameters:
[in]hDeviceADISENSE device context handle
[out]pProductIdPointer to return the product ID value
Returns:
Status

Reads the product ID registers on the device and returns the value.

Definition at line 1130 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_GetStatus ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_STATUS *const   pStatus 
)

Read the current status from the device registers.

Parameters:
[in]hDeviceADISENSE device context handle
[out]pStatusPointer to return the status summary obtained from the device.
Returns:
Status

Reads the status registers and extracts the relevant information to return to the caller.

Note:
This may be called at any time, assuming the device is ready.

Read the current status from the device registers.

Parameters:
[in]@param[out]pStatus : Pointer to CORE Status struct.
Returns:
Status

Read the general status register for the ADISense module. Indicates Error, Alert conditions, data ready and command running.

Definition at line 316 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_Open ( unsigned const   nDeviceIndex,
ADI_SENSE_CONNECTION *const   pConnectionInfo,
ADI_SENSE_DEVICE_HANDLE *const   phDevice 
)

Open ADISENSE device handle and set up communication interface.

Parameters:
[in]nDeviceIndexZero-based index number identifying this device instance. Note that this will be used to retrieve a specific device configuration for this device (see adi_sense_SetConfig and ADI_SENSE_CONFIG)
[in]pConnectionInfoHost-specific connection details (e.g. SPI, GPIO)
[out]phDevicePointer to return an ADISENSE device handle
Returns:
Status

Configure and initialise the Log interface and the SPI/GPIO communication interface to the ADISense module.

Definition at line 215 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_RegisterGpioCallback ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_GPIO_PIN const   ePinId,
ADI_SENSE_GPIO_CALLBACK const   callbackFunction,
void *const   pCallbackParam 
)

Register an application-defined callback function for GPIO interrupts.

Parameters:
[in]hDeviceADISENSE context handle (adi_sense_Open)
[in]ePinIdGPIO pin on which to enable/disable interrupts
[in]callbackFunctionFunction to be called when an interrupt occurs. Specify NULL here to disable interrupts.
[in]pCallbackParamOptional opaque parameter passed to the callback
Returns:
Status

Definition at line 261 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_Reset ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Reset the ADISENSE device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Trigger a hardware-reset of the ADISENSE device.

Note:
The device may require several seconds before it is ready for use again. adi_sense_GetDeviceReadyState may be used to check if the device is ready.

Definition at line 280 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_RestoreConfig ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_USER_CONFIG_SLOT const   eSlotId 
)

Restore configuration settings from persistent memory on the device.

Parameters:
[in]hDeviceADISENSE device context handle
[in]eSlotIdUser configuration slot in persistent memory
Returns:
Status

Instructs the ADISENSE device to restore the contents of its device configuration registers from non-volatile memory.

Note:
No other command must be running when this is called.

Definition at line 554 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_RestoreLutData ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Restore LUT data from persistent memory on the device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to restore the contents of its LUT data, previously stored with adi_sense_SaveLutData, from non-volatile memory.

Note:
No other command must be running when this is called.

Definition at line 715 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_RunCalibration ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Run built-in calibration on the device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to execute its self-calibration routines, on any enabled measurement channels, according to the current applied configuration settings. Device status registers will be updated to indicate if any errors were detected.

Note:
No other command must be running when this is called.

Definition at line 747 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_RunDiagnostics ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Run built-in diagnostic checks on the device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to execute its built-in diagnostic tests, on any enabled measurement channels, according to the current applied configuration settings. Device status registers will be updated to indicate if any errors were detected by the diagnostics.

Note:
No other command must be running when this is called.

Definition at line 736 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_RunDigitalCalibration ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Run built-in digital calibration on the device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to execute its calibration routines, on any enabled digital channels, according to the current applied configuration settings. Device status registers will be updated to indicate if any errors were detected.

Note:
No other command must be running when this is called.

Definition at line 758 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_SaveConfig ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_USER_CONFIG_SLOT const   eSlotId 
)

Store the configuration settings to persistent memory on the device.

Parameters:
[in]hDeviceADISENSE device context handle
[in]eSlotIdUser configuration slot in persistent memory
Returns:
Status

Instructs the ADISENSE device to save the current contents of its device configuration registers to non-volatile memory.

Note:
No other command must be running when this is called.
Do not power down the device while this command is running.

Definition at line 530 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_SaveLutData ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Store the LUT data to persistent memory on the device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to save the current contents of its LUT data buffer, set using adi_sense_SetLutData, to non-volatile memory.

Note:
No other command must be running when this is called.
Do not power down the device while this command is running.

Definition at line 705 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_SetConfig ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_CONFIG *const   pConfig 
)

Write full configuration settings to the device registers.

Parameters:
[in]hDeviceADISENSE device context handle
[out]pConfigPointer to the configuration data structure
Returns:
Status

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 2824 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_Shutdown ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Trigger a shut down of the device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to initiate a shut down, typically used to conserve power when the device is not in use. The device may be restarted by calling adi_sense_Reset(). Note that active configuration settings are not preserved during shutdown and must be reloaded after the device has become ready again.

Note:
No other command must be running when this is called.

Definition at line 476 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_StartMeasurement ( ADI_SENSE_DEVICE_HANDLE const   hDevice,
ADI_SENSE_MEASUREMENT_MODE const   eMeasurementMode 
)

Start the measurement cycles on the device.

Parameters:
[in]hDeviceADISENSE device context handle
[in]eMeasurementModeAllows a choice of special modes for the measurement. See ADI_SENSE_MEASUREMENT_MODE for further information.
Returns:
Status

Instructs the ADISENSE device to start executing measurement cycles according to the current applied configuration settings. The DATAREADY status signal will be asserted whenever new measurement data is published, according to selected settings. Measurement cycles may be stopped by calling adi_sense_StopMeasurement.

Note:
No other command must be running when this is called.

Start the measurement cycles on the device.

Parameters:
[out]
Returns:
Status

Sends the latch config command. Configuration for channels in conversion cycle should be completed before this function. Channel enabled bit should be set before this function. Starts a conversion and configures the format of the sample.

Definition at line 504 of file adi_sense_1000.c.

ADI_SENSE_RESULT adi_sense_StopMeasurement ( ADI_SENSE_DEVICE_HANDLE const   hDevice )

Stop the measurement cycles on the device.

Parameters:
[in]hDeviceADISENSE device context handle
Returns:
Status

Instructs the ADISENSE device to stop executing measurement cycles. The command may be delayed until the current conversion, if any, has been completed and published.

Note:
To be used only if a measurement command is currently running.

Definition at line 725 of file adi_sense_1000.c.

Generated on Tue Jul 12 2022 18:59:24 by  doxygen 1.7.2