Analog Devices / Mbed OS EVAL-ADMX2001

Dependencies:   ADMX2001

Embed: (wiki syntax)

« Back to documentation index

calibrate.h File Reference

calibrate.h File Reference

: This file contains type definitions and function prototype for calibrate.cpp More...

Go to the source code of this file.

Enumerations

enum  CAL_TYPE { CAL_TYPE_NO_CAL = 0, CAL_TYPE_OPEN, CAL_TYPE_SHORT, CAL_TYPE_LOAD }
 

enumeration for all calibration coeffs

More...

Functions

int32_t Calibrate (CAL_TYPE calType, float stdR, float stdX)
 Command to perform various calibration types.

Detailed Description

: This file contains type definitions and function prototype for calibrate.cpp

Definition in file calibrate.h.


Enumeration Type Documentation

enum CAL_TYPE

enumeration for all calibration coeffs

Enumerator:
CAL_TYPE_NO_CAL 

No Calibration.

CAL_TYPE_OPEN 

OPEN Calibration.

CAL_TYPE_SHORT 

SHORT Calibration.

CAL_TYPE_LOAD 

LOAD Calibration.

Definition at line 58 of file calibrate.h.


Function Documentation

int32_t Calibrate ( CAL_TYPE  calType,
float  stdR,
float  stdX 
)

Command to perform various calibration types.

perform specified cal type calibration .

Parameters:
[in]calType- type of calibration
[in]stdR- load value for Rt/Load calibration
[in]stdX- load value for Xt/Load calibration
Returns:
ADMX_LCR_STATUS_SUCCESS - Success
Parameters:
[in]calType- Type of Calibrate
[in]stdR- stdR value
[in]stdX- stdX value
Returns:
Returns 0 for success or negative error code.

Pointer to the handle

Send the RT data

Send the XT data

Send the Load Calibration command

Definition at line 84 of file calibrate.cpp.