client

Documentation

Index

• type Callback
• type RadioClient
  • func MakeRadioClient(address, name, application string) *RadioClient
  • func (f *RadioClient) Connect()
  • func (f *RadioClient) Disconnect()
  • func (f *RadioClient) GetAvailableSampleRates() []uint32
  • func (f *RadioClient) GetCenterFrequency() uint32
  • func (f *RadioClient) GetGain() uint32
  • func (f *RadioClient) GetName() string
  • func (f *RadioClient) GetSampleRate() uint32
  • func (f *RadioClient) GetSmartCenterFrequency() uint32
  • func (f *RadioClient) GetSmartSampleRate() uint32
  • func (f *RadioClient) SetCallback(cb Callback)
  • func (f *RadioClient) SetCenterFrequency(centerFrequency uint32) uint32
  • func (f *RadioClient) SetDecimationStage(decimation uint32) uint32
  • func (f *RadioClient) SetGain(gain uint32) uint32
  • func (f *RadioClient) SetIQEnabled(iqEnabled bool)
  • func (f *RadioClient) SetSampleRate(sampleRate uint32) uint32
  • func (f *RadioClient) SetSmartCenterFrequency(centerFrequency uint32) uint32
  • func (f *RadioClient) SetSmartDecimation(decimation uint32) uint32
  • func (f *RadioClient) SetSmartIQEnabled(smartIqEnabled bool)
  • func (f *RadioClient) SetSmartSampleRate(sampleRate uint32) uint32
  • func (f *RadioClient) Start()
  • func (f *RadioClient) Stop()

Types

type Callback

type Callback interface {
	OnData([]complex64)
	OnSmartData([]complex64)
}

type RadioClient

type RadioClient struct {
	// contains filtered or unexported fields
}

func MakeRadioClient

func MakeRadioClient(address, name, application string) *RadioClient

func (*RadioClient) Connect

func (f *RadioClient) Connect()

Connect initiates the connection with RadioClient. It panics if the connection fails for some reason.

func (*RadioClient) Disconnect

func (f *RadioClient) Disconnect()

Disconnect disconnects from current connected RadioClient.

func (*RadioClient) GetAvailableSampleRates

func (f *RadioClient) GetAvailableSampleRates() []uint32

GetAvailableSampleRates returns a list of available sample rates for the current connection.

func (*RadioClient) GetCenterFrequency

func (f *RadioClient) GetCenterFrequency() uint32

GetCenterFrequency returns the IQ Channel Center Frequency in Hz

func (*RadioClient) GetGain

func (f *RadioClient) GetGain() uint32

GetGain returns the current gain stage of the server.

func (*RadioClient) GetName

func (f *RadioClient) GetName() string

GetName returns the name of the active device in RadioClient

func (*RadioClient) GetSampleRate

func (f *RadioClient) GetSampleRate() uint32

GetSampleRate returns the sample rate of the IQ channel in Hertz

func (*RadioClient) GetSmartCenterFrequency

func (f *RadioClient) GetSmartCenterFrequency() uint32

GetSmartCenterFrequency returns the Smart IQ Center Frequency in Hertz

func (*RadioClient) GetSmartSampleRate

func (f *RadioClient) GetSmartSampleRate() uint32

GetSmartSampleRate returns the sample rate of Smart IQ in Hertz

func (*RadioClient) SetCallback

func (f *RadioClient) SetCallback(cb Callback)

SetCallback sets the callbacks for server data

func (*RadioClient) SetCenterFrequency

func (f *RadioClient) SetCenterFrequency(centerFrequency uint32) uint32

SetCenterFrequency sets the IQ Channel Center Frequency in Hertz and returns it.

func (*RadioClient) SetDecimationStage

func (f *RadioClient) SetDecimationStage(decimation uint32) uint32

SetDecimationStage sets the sample rate by using the number of decimation stages. Each decimation stage decimates by two, then the total decimation will be defined by 2^stages. This is the same as SetSampleRate, but SetSampleRate instead, looks at a pre-filled table of all 2^stages decimations that the server supports and applies into the original device sample rate.

func (*RadioClient) SetGain

func (f *RadioClient) SetGain(gain uint32) uint32

SetGain sets the gain stage of the server. The actual gain in dB varies from device to device. Returns Invalid in case of a invalid value in the input

func (*RadioClient) SetIQEnabled

func (f *RadioClient) SetIQEnabled(iqEnabled bool)

func (*RadioClient) SetSampleRate

func (f *RadioClient) SetSampleRate(sampleRate uint32) uint32

SetSampleRate sets the sample rate of the IQ Channel in Hertz Check the available sample rates using GetAvailableSampleRates Returns Invalid in case of a invalid value in the input

func (*RadioClient) SetSmartCenterFrequency

func (f *RadioClient) SetSmartCenterFrequency(centerFrequency uint32) uint32

SetSmartCenterFrequency sets the Smart IQ Center Frequency in Hertz and returns it.

func (*RadioClient) SetSmartDecimation

func (f *RadioClient) SetSmartDecimation(decimation uint32) uint32

SetSmartDecimation sets the sample rate of the Smart IQ by using the number of decimation stages. Each decimation stage decimates by two, then the total decimation will be defined by 2^stages. This is the same as SetSampleRate, but SetSampleRate instead, looks at a pre-filled table of all 2^stages decimations that the server supports and applies into the original device sample rate. Returns Invalid in case of a invalid value in the input

func (*RadioClient) SetSmartIQEnabled

func (f *RadioClient) SetSmartIQEnabled(smartIqEnabled bool)

func (*RadioClient) SetSmartSampleRate

func (f *RadioClient) SetSmartSampleRate(sampleRate uint32) uint32

SetSmartSampleRate sets the sample rate of the SmartIQ Channel in Hertz Check the available sample rates using GetAvailableSampleRates Returns Invalid in case of a invalid value in the input

func (*RadioClient) Start

func (f *RadioClient) Start()

Start starts the streaming process (if not already started)

func (*RadioClient) Stop

func (f *RadioClient) Stop()

Stop stop the streaming process (if started)