RTP Series API Programming Reference  1.2.1
Sensor Info

Functions

EXPORT int PwrSnsr_GetManufactureDate (SessionID Vi, const char *Channel, int ManufactureDateBufferSize, char ManufactureDate[])
 Date the sensor was manufactured in the following format YYYYmmDD. More...
 
EXPORT int PwrSnsr_GetImpedance (SessionID Vi, const char *Channel, float *Impedance)
 Input impedance of the sensor. More...
 
EXPORT int PwrSnsr_GetPeakPowerMax (SessionID Vi, const char *Channel, float *PeakPowerMax)
 Maximum power level the sensor can measure. More...
 
EXPORT int PwrSnsr_GetPeakPowerMin (SessionID Vi, const char *Channel, float *PeakPowerMin)
 Minimum power level the sensor can measure. More...
 
EXPORT int PwrSnsr_GetAttenuation (SessionID Vi, const char *Channel, float *Attenuation)
 Attenuation in dB for the sensor. More...
 
EXPORT int PwrSnsr_GetFactoryCalDate (SessionID Vi, const char *Channel, int FactoryCalDateBufferSize, char FactoryCalDate[])
 The date (YYYYmmDD) the last time the sensor was calibrated at the factory. More...
 
EXPORT int PwrSnsr_GetMinimumTrig (SessionID Vi, const char *Channel, float *MinimumTrig)
 Minimum internal trigger level in dBm. More...
 
EXPORT int PwrSnsr_GetMinFreqHighBandwidth (SessionID Vi, const char *Channel, float *MinFreqHighBandwidth)
 Minimum frequency of RF the sensor can measure in high bandwidth. More...
 
EXPORT int PwrSnsr_GetMaxFreqHighBandwidth (SessionID Vi, const char *Channel, float *MaxFreqHighBandwidth)
 Maximum frequency carrier the sensor can measure in high bandwidth. More...
 
EXPORT int PwrSnsr_GetMinFreqLowBandwidth (SessionID Vi, const char *Channel, float *MinFreqLowBandwidth)
 Minimum frequency carrier the sensor can measure in low bandwidth. More...
 
EXPORT int PwrSnsr_GetMaxFreqLowBandwidth (SessionID Vi, const char *Channel, float *MaxFreqLowBandwidth)
 Maximum frequency carrier the sensor can measure in low bandwidth. More...
 
EXPORT int PwrSnsr_GetFpgaVersion (SessionID Vi, const char *Channel, int ValBufferSize, char Val[])
 Get the sensor FPGA version. More...
 

Detailed Description

Sensor info functions

Function Documentation

◆ PwrSnsr_GetAttenuation()

EXPORT int PwrSnsr_GetAttenuation ( SessionID  Vi,
const char *  Channel,
float *  Attenuation 
)

Attenuation in dB for the sensor.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
Attenuation
Returns
Success (0) or error code.

◆ PwrSnsr_GetFactoryCalDate()

EXPORT int PwrSnsr_GetFactoryCalDate ( SessionID  Vi,
const char *  Channel,
int  FactoryCalDateBufferSize,
char  FactoryCalDate[] 
)

The date (YYYYmmDD) the last time the sensor was calibrated at the factory.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
FactoryCalDateBufferSizeSize of FactoryCalDate in bytes.
FactoryCalDate
Returns
Success (0) or error code.

◆ PwrSnsr_GetFpgaVersion()

EXPORT int PwrSnsr_GetFpgaVersion ( SessionID  Vi,
const char *  Channel,
int  ValBufferSize,
char  Val[] 
)

Get the sensor FPGA version.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
ValBufferSizeSize pf Val in bytes
ValBuffer for staoring the version
Returns
Success (0) or error code.

◆ PwrSnsr_GetImpedance()

EXPORT int PwrSnsr_GetImpedance ( SessionID  Vi,
const char *  Channel,
float *  Impedance 
)

Input impedance of the sensor.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
Impedance
Returns
Success (0) or error code.

◆ PwrSnsr_GetManufactureDate()

EXPORT int PwrSnsr_GetManufactureDate ( SessionID  Vi,
const char *  Channel,
int  ManufactureDateBufferSize,
char  ManufactureDate[] 
)

Date the sensor was manufactured in the following format YYYYmmDD.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
ManufactureDateBufferSizeSize of ManufactureDate in bytes.
ManufactureDateReturn value.
Returns
Success (0) or error code.

◆ PwrSnsr_GetMaxFreqHighBandwidth()

EXPORT int PwrSnsr_GetMaxFreqHighBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MaxFreqHighBandwidth 
)

Maximum frequency carrier the sensor can measure in high bandwidth.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MaxFreqHighBandwidth
Returns
Success (0) or error code.

◆ PwrSnsr_GetMaxFreqLowBandwidth()

EXPORT int PwrSnsr_GetMaxFreqLowBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MaxFreqLowBandwidth 
)

Maximum frequency carrier the sensor can measure in low bandwidth.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MaxFreqLowBandwidth
Returns
Success (0) or error code.

◆ PwrSnsr_GetMinFreqHighBandwidth()

EXPORT int PwrSnsr_GetMinFreqHighBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MinFreqHighBandwidth 
)

Minimum frequency of RF the sensor can measure in high bandwidth.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MinFreqHighBandwidth
Returns
Success (0) or error code.

◆ PwrSnsr_GetMinFreqLowBandwidth()

EXPORT int PwrSnsr_GetMinFreqLowBandwidth ( SessionID  Vi,
const char *  Channel,
float *  MinFreqLowBandwidth 
)

Minimum frequency carrier the sensor can measure in low bandwidth.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MinFreqLowBandwidth
Returns
Success (0) or error code.

◆ PwrSnsr_GetMinimumTrig()

EXPORT int PwrSnsr_GetMinimumTrig ( SessionID  Vi,
const char *  Channel,
float *  MinimumTrig 
)

Minimum internal trigger level in dBm.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
MinimumTrig
Returns
Success (0) or error code.

◆ PwrSnsr_GetPeakPowerMax()

EXPORT int PwrSnsr_GetPeakPowerMax ( SessionID  Vi,
const char *  Channel,
float *  PeakPowerMax 
)

Maximum power level the sensor can measure.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
PeakPowerMax
Returns
Success (0) or error code.

◆ PwrSnsr_GetPeakPowerMin()

EXPORT int PwrSnsr_GetPeakPowerMin ( SessionID  Vi,
const char *  Channel,
float *  PeakPowerMin 
)

Minimum power level the sensor can measure.

Parameters
ViThe SessionID handle that you obtain from the PwrSnsr_init function. The handle identifies a particular instrument session.
ChannelChannel number. For single instruments, set this to "CH1".
PeakPowerMin
Returns
Success (0) or error code.