MAVRK Embedded Software 0.91
Software Libraries for the MAVRK motherboard and related components
Functions | Variables

ADS1259_Functions.c File Reference

#include "MAVRK_Arch.h"
#include "stdef.h"
#include "SPI_Functions.h"
#include "ADS1259.h"
#include "F5438_io.h"
#include "F5438_usci.h"
#include "MAVRK_Common.h"
#include "PC_Interface.h"
#include "F5438_Unified_Clock_system.h"
#include "F5438_ProMB_Modular_EVM_IO.h"
#include "ADS1259_Device_Interface.h"
#include "MAVRK_Return_Error_Codes.h"
#include "ADS1259_PC_Interface.h"

Functions

void mvk_Enable_ADS1259_Conversion (unsigned char device_slot)
 Set continuous conversion mode.
void mvk_Wake_Up_ADS1259 (unsigned char device_slot)
 Wake up a ADS1259 device.
void mvk_Put_ADS1259_In_Sleep (unsigned char device_slot)
 Place a ADS1259 device into sleep mode.
void mvk_Soft_Reset_ADS1259 (unsigned char device_slot)
 Reset a ADS1259 device.
void mvk_Start_Continuous_Read_Data_ADS1259 (unsigned char device_slot)
 Starts the continuous data read on a ADS1259 device.
void mvk_Stop_Continuous_Read_Data_ADS1259 (unsigned char device_slot)
 Stops the continuous data read on a ADS1259 device.
void mvk_Offset_System_Calibrate_ADS1259 (unsigned char device_slot)
 Perform the offset system calibration on the ADS1259 device.
void mvk_System_Gain_Calibration_ADS1259 (unsigned char device_slot)
 Perform the system gain calibration on the ADS1x4x device.
unsigned char mvk_Set_ADS1259_Data_Rate (unsigned char device_slot, unsigned char data_rate)
 Performs the setting of the ADS1259 data rate.
unsigned char mvk_Set_ADS1259_Sync_Filter (unsigned char device_slot, unsigned char sync_setting)
 Performs the setting of the ADS1259 Sync Filter.
unsigned int mvk_Calibration_Time (unsigned char data_rate, unsigned char sync_filter_type)
 Provide the amount of time required to perform calibration.
void mvk_Enable_ADS1259_Reference (unsigned char device_slot)
 Enable the External Reference Circuit of the ADS1259 device.
void mvk_Disable_ADS1259_Reference (unsigned char device_slot)
 Disable the External Reference Circuit of the ADS1259 device.
void mvk_Power_Down_ADS1259 (unsigned char device_slot)
 Perform a power down of the ADS1259 device.
void mvk_Reset_ADS1259 (unsigned char device_slot)
 Perform a reset of the ADS1259 device.
void mvk_Hard_Start_Restart_ADS1259 (unsigned char device_slot)
 Perform a hard restart on a ADS1259 device.
void mvk_Hard_Stop_ADS1259 (unsigned char device_slot)
 Perform a hard stop on a ADS1259 device.

Variables

unsigned char Continuous_Read_Data_ADS1259 = SET

Function Documentation

unsigned int mvk_Calibration_Time ( unsigned char  data_rate,
unsigned char  sync_filter_type 
)

Provide the amount of time required to perform calibration.

The function will return the amount of time required for calibration to complete

Parameters:
[in]data_rateDEFAULT_ADC_10_SPS, ADC_10_SPS, ADC_16_6_SPS, ADC_50_SPS, ADC_60_SPS, ADC_400_SPS, ADC_1200_SPS, ADC_3600_SPS, ADC_14400_SPS
[in]sync_filter_typeDEFAULT_SINC_FILTER_SETTLES_IN_ONE_CLOCK, SINC_FILTER_SETTLES_IN_TWO_CLOCKS
Returns:
calibration time in 1ms steps
void mvk_Disable_ADS1259_Reference ( unsigned char  device_slot)

Disable the External Reference Circuit of the ADS1259 device.

The function will Disable the Reference Circuit of the ADS1259 device

Returns:
None
void mvk_Enable_ADS1259_Conversion ( unsigned char  device_slot)

Set continuous conversion mode.

The function will place the indicated ADS1259 device into continuous conversion mode

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None
void mvk_Enable_ADS1259_Reference ( unsigned char  device_slot)

Enable the External Reference Circuit of the ADS1259 device.

The function will Enable the Reference Circuit of the ADS1259 device

Returns:
None
void mvk_Hard_Start_Restart_ADS1259 ( unsigned char  device_slot)

Perform a hard restart on a ADS1259 device.

The function will hard restart the indicated ADS1259 device

Returns:
None
void mvk_Hard_Stop_ADS1259 ( unsigned char  device_slot)

Perform a hard stop on a ADS1259 device.

The function will perform a hard stop on the ADS1259 device

Returns:
None
void mvk_Offset_System_Calibrate_ADS1259 ( unsigned char  device_slot)

Perform the offset system calibration on the ADS1259 device.

The function will calibrate the offset value for the ADS1259 system.

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None
void mvk_Power_Down_ADS1259 ( unsigned char  device_slot)

Perform a power down of the ADS1259 device.

The function will power down the indicated ADS1259 device

Returns:
None
void mvk_Put_ADS1259_In_Sleep ( unsigned char  device_slot)

Place a ADS1259 device into sleep mode.

The function will put the indicated ADS1259 device to sleep

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None
void mvk_Reset_ADS1259 ( unsigned char  device_slot)

Perform a reset of the ADS1259 device.

The function will reset the indicated ADS1259 device

Returns:
None
unsigned char mvk_Set_ADS1259_Data_Rate ( unsigned char  device_slot,
unsigned char  data_rate 
)

Performs the setting of the ADS1259 data rate.

The function will set the ADS1259 data rate.

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
[in]data_rateDEFAULT_ADC_10_SPS, ADC_10_SPS, ADC_16_6_SPS, ADC_50_SPS, ADC_60_SPS, ADC_400_SPS, ADC_1200_SPS, ADC_3600_SPS, ADC_14400_SPS
Returns:
ADS1259_INIT_SUCCESS Initialization successful
ADS1259_VERIFY_ERROR Initialization error
unsigned char mvk_Set_ADS1259_Sync_Filter ( unsigned char  device_slot,
unsigned char  sync_setting 
)

Performs the setting of the ADS1259 Sync Filter.

The function will set the ADS1259 Sinc filter affecting the conversion time and the filters performance.

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
[in]sync_settingDEFAULT_SINC_FILTER_SETTLES_IN_ONE_CLOCK, SINC_FILTER_SETTLES_IN_TWO_CLOCKS
Returns:
ADS1259_INIT_SUCCESS Initialization successful
ADS1259_VERIFY_ERROR Initialization error
void mvk_Soft_Reset_ADS1259 ( unsigned char  device_slot)

Reset a ADS1259 device.

The function will reset the indicated ADS1259 device

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None
void mvk_Start_Continuous_Read_Data_ADS1259 ( unsigned char  device_slot)

Starts the continuous data read on a ADS1259 device.

The function will start the continuous data read on the indicated ADS1x4x device

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None
void mvk_Stop_Continuous_Read_Data_ADS1259 ( unsigned char  device_slot)

Stops the continuous data read on a ADS1259 device.

The function will stop the continuous data read on the indicated ADS1259 device

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None
void mvk_System_Gain_Calibration_ADS1259 ( unsigned char  device_slot)

Perform the system gain calibration on the ADS1x4x device.

The function will calibrate the gain value for the ADS1x4x system.

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None
void mvk_Wake_Up_ADS1259 ( unsigned char  device_slot)

Wake up a ADS1259 device.

The function will wake the indicated ADS1259 device

Parameters:
[in]device_slotMAVRK slot occupied by the given device (MAVRK_RFx, MAVRK_AFEx, MAVRK_SCIx)
Returns:
None

Variable Documentation

unsigned char Continuous_Read_Data_ADS1259 = SET
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Generated on Wed Mar 28 2012 10:32:46 for MAVRK Embedded Software by  doxygen 1.7.3