wsLyrtech Class Reference

Wraps interfaz namespace to present remote functionality through Web Services. More...

Inheritance diagram for wsLyrtech:

List of all members.

Public Member Functions
Boolean	node_isBusy ()
	Shows if the node is currently being used by other user.
string	node_SetTimeout (double Minutes)
	Sets default timeout set for this session.
string	node_GetTimeout ()
	Gets timeout set for this session.
string	node_SessionID ()
	Gets session ID.
Boolean	node_Unlock ()
	Unlocks the node to be used by other user.
Boolean	node_HasADC ()
	Shows if the node has an ADC board.
Boolean	node_HasDAC ()
	Shows if the node has a DAC board.
Boolean	node_HasRFFE ()
	Shows if the node has been connected to a RFFE.
String	node_Version ()
	Version information.
String	node_GetDescription (String BitFilename)
	Gets the description of a specified FPGA programming file (.txt file associated).
String[]	node_AvailableFiles ()
	List all available FPGA programming files (.bit files).
Boolean	node_refreshInfo ()
	Resets application state in case of abnormal functioning.
Boolean	node_Shutdown (String Password)
	Shutdowns node.
String	node_MATLABMulticommand (String ListOfCommands)
	Sends multiple MATLAB commands to be executed locally.
Boolean	adc_FPGAConf (String fileName)
	Configures FPGA (ADC board).
Boolean	adc_ChannelConf (int ChannelMask, uint SamplesPerChannel)
	Configures ADC channels.
float	adc_SamplingFreq (float SamplingFreq)
	Sets ADC sampling frequency.
string	adc_Acquire_SDRAMRead (uint SamplesPerChannel)
	Starts data acquisition and reads data from SDRAM.
Boolean	adc_Acquire ()
	Starts data acquisition.
string	adc_SDRAMRead (uint SamplesPerChannel)
	Reads data from SDRAM.
Boolean	adc_ChannelDeconf ()
	Deconfigures ADC channels.
uint	adc_ReadFPGAReg (uint Reg)
	Reads ADC board FPGA register.
uint	adc_WriteFPGAReg (uint Reg, uint Data)
	Writes ADC board FPGA register.
Boolean	dac_IsVirtex4 ()
	Shows whether the FPGA mounted on the board is a Virtex4 model.
Boolean	dac_FPGAConf (String FileName)
	Configures FPGA (DAC board).
unsafe int	dac_SDRAMWrite (string base64_Data)
	Writes data to SDRAM.
string	dac_SDRAMRead (uint SamplesPerChannel)
	Reads data from SDRAM.
Boolean	dac_ChannelConf (int ChannelMask, uint SamplesPerChannel)
	Configures DAC channels.
Boolean	dac_ChannelGains (String base64_Gains)
	Adjusts channel gains.
float	dac_SamplingFreq (float SamplingFreq)
	Sets DAC sampling frequency.
Boolean	dac_Play ()
	Starts data playback.
Boolean	dac_ChannelDeconf ()
	Deconfigures DAC channels.
uint	dac_ReadFPGAReg (uint Reg)
	Reads DAC board FPGA register.
uint	dac_WriteFPGAReg (uint Reg, uint Data)
	Writes DAC board FPGA register.
Boolean	rffe_Init (float LPFCornerFreq, float RF_Freq)
	Initializes RFFE, sets RF filter and frequency.
Boolean	rffe_TxGain (int PA_Gain, int Transceiver)
	Adjusts transceiver gain (only for TX).
Boolean	rffe_RxGain (int LNA_Gain, int VGA_Gain, int Transceiver)
	Adjusts transceiver gain (only for RX).
uint	rffe_WriteRFFEReg (int Transceiver, uint SPIReg, uint Data)
	Sets SPI register value for a given transceiver.

---

Detailed Description

Wraps interfaz namespace to present remote functionality through Web Services.

---

Member Function Documentation

Boolean node_isBusy

(

)

Shows if the node is currently being used by other user.

Returns:

True if the node is busy.

string node_SetTimeout

(

double

Minutes

)

Sets default timeout set for this session.

Parameters:

Minutes

Timeout in minutes.

Returns:

A string containing timeout in the format hh:mm:ss

string node_GetTimeout

(

)

Gets timeout set for this session.

Returns:

A string containing timeout in the format hh:mm:ss

string node_SessionID

(

)

Gets session ID.

Returns:

A string containing this session ID.

Boolean node_Unlock

(

)

Unlocks the node to be used by other user.

Returns:

True if the node has been succesfully unlocked.

Boolean node_HasADC

(

)

Shows if the node has an ADC board.

Returns:

True if an ADC board has been detected on this node.

Boolean node_HasDAC

(

)

Shows if the node has a DAC board.

Returns:

True if a DAC board has been detected on this node.

Boolean node_HasRFFE

(

)

Shows if the node has been connected to a RFFE.

Returns:

True if the configuration file indicates a connected RFFE.

String node_Version

(

)

Version information.

Wraps interfaz.node.Version

String node_GetDescription

(

String

BitFilename

)

Gets the description of a specified FPGA programming file (.txt file associated).

Parameters:

BitFilename

.bit file name which description is required.

Returns:

Text containing the description of the queried file

String [] node_AvailableFiles

(

)

List all available FPGA programming files (.bit files).

Returns:

Array of string containing .bit files names.

Boolean node_refreshInfo

(

)

Resets application state in case of abnormal functioning.

Returns:

True if successful.

Boolean node_Shutdown

(

String

Password

)

Shutdowns node.

Parameters:

Password

String containing password needed to shutdown the node.

Returns:

True if successful. False if wrong password.

String node_MATLABMulticommand

(

String

ListOfCommands

)

Sends multiple MATLAB commands to be executed locally.

Parameters:

ListOfCommands

List of commands separated by # symbols. Supported MATLAB commands Description dac_ReadFPGAReg dac_WriteFPGAReg adc_ReadFPGAReg adc_WriteFPGAReg

Returns:

Returned values converted to string and separated by # symbols,

Value	Meaning
Error 1	Missing characters or parenthesis
Error 2	Unknown command
Error 3	Invalid format or command exception

Boolean adc_FPGAConf

(

String

fileName

)

Configures FPGA (ADC board).

Wraps interfaz.adcBoard.FPGAConf

Boolean adc_ChannelConf	(	int	ChannelMask,
		uint	SamplesPerChannel
	)

Configures ADC channels.

Wraps interfaz.adcBoard.ChannelConf

float adc_SamplingFreq

(

float

SamplingFreq

)

Sets ADC sampling frequency.

Wraps interfaz.adcBoard.SamplingFreq

string adc_Acquire_SDRAMRead

(

uint

SamplesPerChannel

)

Starts data acquisition and reads data from SDRAM.

Parameters:

SamplesPerChannel

Number of samples per channel to be acquired.

Returns:

An array (base64 encoded) containing acquired samples in the following order:

adc_Acquire_SDRAMRead(SamplesPerChannel) is equivalent to adc_Acquire() + adc_SDRAMRead(SamplesPerChannel)

See also:

interfaz.adcBoard.Acquire_SDRAMRead

Boolean adc_Acquire

(

)

Starts data acquisition.

Wraps interfaz.adcBoard.Acquire

string adc_SDRAMRead

(

uint

SamplesPerChannel

)

Reads data from SDRAM.

Parameters:

SamplesPerChannel

Number of samples per channel to be acquired.

Returns:

An array (base64 encoded) containing acquired samples in the following order:

See also:

interfaz.adcBoard.SDRAMRead

Boolean adc_ChannelDeconf

(

)

Deconfigures ADC channels.

Wraps interfaz.adcBoard.ChannelDeconf

uint adc_ReadFPGAReg

(

uint

Reg

)

Reads ADC board FPGA register.

Wraps interfaz.adcBoard.ReadFPGAReg.

uint adc_WriteFPGAReg	(	uint	Reg,
		uint	Data
	)

Writes ADC board FPGA register.

Wraps interfaz.adcBoard.WriteFPGAReg.

Boolean dac_IsVirtex4

(

)

Shows whether the FPGA mounted on the board is a Virtex4 model.

Wraps interfaz.dacBoard.IsVirtex4

Boolean dac_FPGAConf

(

String

FileName

)

Configures FPGA (DAC board).

Wraps interfaz.dacBoard.FPGAConf

unsafe int dac_SDRAMWrite

(

string

base64_Data

)

Writes data to SDRAM.

Parameters:

base64_Data

Array containing data to be written (base64 encoded).

Returns:

Number of samples succesfully written.

See also:

interfaz.dacBoard.SDRAMWrite

string dac_SDRAMRead

(

uint

SamplesPerChannel

)

Reads data from SDRAM.

Parameters:

SamplesPerChannel

Number of samples per channel to be acquired.

Returns:

An array (base64 encoded) containing acquired samples in the following order:

See also:

interfaz.dacBoard.SDRAMRead

Boolean dac_ChannelConf	(	int	ChannelMask,
		uint	SamplesPerChannel
	)

Configures DAC channels.

Wraps interfaz.dacBoard.ChannelConf.

Boolean dac_ChannelGains

(

String

base64_Gains

)

Adjusts channel gains.

ADCs are DC coupled with no programmable gain.

Parameters:

base64_Gains

Gains values for all board channels (base64 encoded).

Returns:

True if successful.

See also:

interfaz.dacBoard.ChannelGains

float dac_SamplingFreq

(

float

SamplingFreq

)

Sets DAC sampling frequency.

Wraps interfaz.dacBoard.SamplingFreq

Boolean dac_Play

(

)

Starts data playback.

Wraps interfaz.dacBoard.Play.

Boolean dac_ChannelDeconf

(

)

Deconfigures DAC channels.

Wraps interfaz.dacBoard.ChannelDeconf.

uint dac_ReadFPGAReg

(

uint

Reg

)

Reads DAC board FPGA register.

Wraps interfaz.dacBoard.ReadFPGAReg.

uint dac_WriteFPGAReg	(	uint	Reg,
		uint	Data
	)

Writes DAC board FPGA register.

Wraps interfaz.dacBoard.WriteFPGAReg.

Boolean rffe_Init	(	float	LPFCornerFreq,
		float	RF_Freq
	)

Initializes RFFE, sets RF filter and frequency.

Wraps interfaz.frontEnd.Init

Boolean rffe_TxGain	(	int	PA_Gain,
		int	Transceiver
	)

Adjusts transceiver gain (only for TX).

Wraps interfaz.frontEnd.TxGain

Boolean rffe_RxGain	(	int	LNA_Gain,
		int	VGA_Gain,
		int	Transceiver
	)

Adjusts transceiver gain (only for RX).

Wraps interfaz.frontEnd.RxGain

uint rffe_WriteRFFEReg	(	int	Transceiver,
		uint	SPIReg,
		uint	Data
	)

Sets SPI register value for a given transceiver.

Wraps interfaz.frontEnd.WriteRFFEReg

---

The documentation for this class was generated from the following file:

• wsLyrtechClass.cs