ADMW Host Library API

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

Definition at line 66 of file admw_api.h.

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

Enumerator:

ADMW_ALERT_DETAIL_CH_RESULT_VALID	Indicates valid result in the channel
ADMW_ALERT_DETAIL_CH_ADC_NEAR_OVERRANGE	Indicates ADC is near overrange in the channel
ADMW_ALERT_DETAIL_CH_SENSOR_UNDERRANGE	Indicates sensor underrange in the channel
ADMW_ALERT_DETAIL_CH_SENSOR_OVERRANGE	Indicates sensor overrange in the channel
ADMW_ALERT_DETAIL_CH_CJ_SOFT_FAULT	Indicates Cold Junction soft fault in the channel
ADMW_ALERT_DETAIL_CH_CJ_HARD_FAULT	Indicates Cold Junction Hard Fault in the channel
ADMW_ALERT_DETAIL_CH_ADC_INPUT_OVERRANGE	Indicates ADC Input overrange in the channel
ADMW_ALERT_DETAIL_CH_SENSOR_HARDFAULT	Indicates Hard Fault in the channel

Definition at line 118 of file admw_api.h.

Supported connection types for communication with the ADMW device.

Enumerator:

ADMW_CONNECTION_TYPE_SPI

Serial Peripheral Interface (SPI) connection type

Definition at line 75 of file admw_api.h.

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

Enumerator:

ADMW_DEVICE_STATUS_BUSY	Indicates that a command is currently running on the device
ADMW_DEVICE_STATUS_DATAREADY	Indicates the availability of measurement data for retrieval
ADMW_DEVICE_STATUS_ERROR	Indicates that an error condition has been detected by the device
ADMW_DEVICE_STATUS_ALERT	Indicates that an alert condition has been detected by the device
ADMW_DEVICE_STATUS_FIFO_ERROR	Indicates that a FIFO error condition has been detected by the device
ADMW_DEVICE_STATUS_CONFIG_ERROR	Indicates that a configuration error condition has been detected by the device
ADMW_DEVICE_STATUS_LUT_ERROR	Indicates that a look-up table error condition has been detected by the device

Definition at line 97 of file admw_api.h.

Measurement mode options for the ADMW device. admw_StartMeasurement

Enumerator:

ADMW_MEASUREMENT_MODE_NORMAL	In this mode, normal measurement cycle(s) are executed and data samples are returned with raw measurement values included.
ADMW_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.

Definition at line 181 of file admw_api.h.

A list of supported product identifiers

Enumerator:

ADMW_PRODUCT_ID_ADMW1001

ADSNS1000

Definition at line 62 of file admw_config_types.h.

Identifiers for the user configuration slots in persistent memory.

Definition at line 193 of file admw_api.h.

Identifiers for the user configuration slots in persistent memory.

Definition at line 200 of file admw_api.h.

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

• ADMW_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 admw1001_SetLutData.

Definition at line 2106 of file admw_1001.c.

Write Look-Up Table data to the device memory.

Parameters:

[in]	hDevice	ADMW1001 device context handle
[out]	pLutData	Pointer to the Look-Up Table data structure

Returns:

Status

• ADMW_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 admw_ApplyConfigUpdates() is called

Definition at line 2165 of file admw_1001.c.

Write Look-Up Table raw data to the device memory.

Parameters:

[in]	hDevice	ADMW device context handle
[out]	pLutData	Pointer to the Look-Up Table raw data structure

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

This can be used instead of admw1001_SetLutData for loading LUT data from the alternative raw data format. See admw1001_SetLutData for more information.

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Definition at line 2080 of file admw_1001.c.

Apply the configuration settings currently stored in device registers.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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 446 of file admw_1001.c.

Close ADMW device context and free resources.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Definition at line 688 of file admw_1001.c.

Check if a command is currently running on the device.

Parameters:

[in]	hDevice	ADMW device context handle
[out]	pbCommandRunning	Pointer to return the command running status

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

Definition at line 371 of file admw_1001.c.

Read measurement data samples from the device registers.

Parameters:

[in]	hDevice	ADMW device context handle
[in]	eMeasurementMode	Must be set to the same value used for admw_StartMeasurement().
[out]	pSamples	Pointer to return a set of requested data samples.
[in]	nBytesPerSample	The size, in bytes, of each sample.
[in]	nRequested	Number of requested data samples.
[out]	pnReturned	Number of valid data samples successfully retrieved.

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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 616 of file admw_1001.c.

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

Parameters:

[in]	hDevice	ADMW device context handle
[out]	pbReady	Pointer to return true if the device is ready, or false otherwise

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

Definition at line 741 of file admw_1001.c.

Get the current state of the specified GPIO input signal.

Parameters:

[in]	hDevice	ADMW device context handle
[in]	ePinId	GPIO pin to query
[out]	pbAsserted	Pointer to return the state of the status signal GPIO pin

Returns:

Status

• ADMW_SUCCESS Call completed successfully.
• ADMW_INVALID_DEVICE_NUM Invalid GPIO pin specified.

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

Definition at line 232 of file admw_1001.c.

Obtain the product ID from the device.

Parameters:

[in]	hDevice	ADMW device context handle
[out]	pProductId	Pointer to return the product ID value

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

Definition at line 880 of file admw_1001.c.

Read the current status from the device registers.

Parameters:

[in]	hDevice	ADMW device context handle
[out]	pStatus	Pointer to return the status summary obtained from the device.

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

• ADMW_SUCCESS Call completed successfully.
• ADMW_FAILURE If status register read fails.

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

Definition at line 308 of file admw_1001.c.

Open ADMW device handle and set up communication interface.

Parameters:

[in]	nDeviceIndex	Zero-based index number identifying this device instance. Note that this will be used to retrieve a specific device configuration for this device (see admw_SetConfig and ADMW_CONFIG)
[in]	pConnectionInfo	Host-specific connection details (e.g. SPI, GPIO)
[out]	phDevice	Pointer to return an ADMW device handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.
• ADMW_NO_MEM Failed to allocate memory resources.
• ADMW_INVALID_DEVICE_NUM Invalid device index specified

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

Definition at line 199 of file admw_1001.c.

Register an application-defined callback function for GPIO interrupts.

Parameters:

[in]	hDevice	ADMW context handle (admw_Open)
[in]	ePinId	GPIO pin on which to enable/disable interrupts
[in]	callbackFunction	Function to be called when an interrupt occurs. Specify NULL here to disable interrupts.
[in]	pCallbackParam	Optional opaque parameter passed to the callback

Returns:

Status

• ADMW_SUCCESS Call completed successfully.
• ADMW_INVALID_DEVICE_NUM Invalid GPIO pin specified.

Definition at line 245 of file admw_1001.c.

Reset the ADMW device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Trigger a hardware-reset of the ADMW device.

Note:

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

Reset the ADMW device.

Parameters:

[in]

hDevice

- handle of ADMW device to reset.

Returns:

Status

• ADMW_SUCCESS Call completed successfully.
• ADMW_FAILURE If reseet faisl

Toggle reset pin of the ADMW device low for a minimum of 4 usec.

Definition at line 274 of file admw_1001.c.

Restore configuration settings from persistent memory on the device.

Parameters:

[in]	hDevice	ADMW device context handle
[in]	eSlotId	User configuration slot in persistent memory

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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 507 of file admw_1001.c.

Restore LUT data from persistent memory on the device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

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

Note:

No other command must be running when this is called.

Definition at line 536 of file admw_1001.c.

Run built-in calibration on the device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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.

Run built-in diagnostic checks on the device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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.

Run built-in digital calibration on the device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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.

Store the configuration settings to persistent memory on the device.

Parameters:

[in]	hDevice	ADMW device context handle
[in]	eSlotId	User configuration slot in persistent memory

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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 489 of file admw_1001.c.

Store the LUT data to persistent memory on the device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW device to save the current contents of its LUT data buffer, set using admw_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 526 of file admw_1001.c.

Write full configuration settings to the device registers.

Parameters:

[in]	hDevice	ADMW device context handle
[out]	pConfig	Pointer to the configuration data structure

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Translates configuration details provided into device-specific register settings and updates device configuration registers.

Note:

Settings are not applied until admw_ApplyConfigUpdates() is called

Definition at line 2011 of file admw_1001.c.

Trigger a shut down of the device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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 admw_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.

Start the measurement cycles on the device.

Parameters:

[in]	hDevice	ADMW device context handle
[in]	eMeasurementMode	Allows a choice of special modes for the measurement. See ADMW_MEASUREMENT_MODE for further information.

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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 admw_StopMeasurement.

Note:

No other command must be running when this is called.

Start the measurement cycles on the device.

Parameters:

[out]

Returns:

Status

• ADMW_SUCCESS Call completed successfully.
• ADMW_FAILURE

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 467 of file admw_1001.c.

Stop the measurement cycles on the device.

Parameters:

[in]

hDevice

ADMW device context handle

Returns:

Status

• ADMW_SUCCESS Call completed successfully.

Instructs the ADMW 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 546 of file admw_1001.c.