#include <indi_rtlsdr.h>

Inheritance diagram for RTLSDR:

Public Member Functions
	RTLSDR (int32_t index)

void	grabData ()

bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n) override
	Process the client newNumber command. More...

Public Member Functions inherited from INDI::Receiver
	Receiver ()

virtual	~Receiver ()

virtual void	ISGetProperties (const char *dev) override
	define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device. More...

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n) override
	Process the client newSwitch command. More...

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n) override
	Process the client newSwitch command. More...

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n) override
	Process the client newBLOB command. More...

virtual bool	ISSnoopDevice (XMLEle *root) override
	Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...

virtual void	addFITSKeywords (fitsfile fptr, uint8_t buf, int len) override
	Add FITS keywords to a fits file. More...

void	setSampleRate (double sr)
	setSampleRate Set depth of Receiver device. More...

void	setBandwidth (double bandwidth)
	setBandwidth Set bandwidth of Receiver device. More...

void	setGain (double gain)
	setGain Set gain of Receiver device. More...

void	setFrequency (double freq)
	setFrequency Set the frequency observed. More...

double	getBandwidth ()
	getBandwidth Get requested integration bandwidth for the sensor in Hz. More...

double	getGain ()
	getGain Get requested integration gain for the sensor. More...

double	getFrequency ()
	getFrequency Get requested integration frequency for the sensor in Hz. More...

double	getSampleRate ()
	getSampleRate Get requested sample rate for the sensor in Hz. More...

INumberVectorProperty *	getReceiverSettings ()
	Return Vector Info Property. More...

uint32_t	GetReceiverCapability () const
	GetReceiverCapability returns the Sensor capabilities. More...

void	SetReceiverCapability (uint32_t cap)
	SetReceiverCapability Set the Receiver capabilities. Al fields must be initialized. More...

virtual void	setMinMaxStep (const char property, const char element, double min, double max, double step, bool sendToClient=true) override
	setMinMaxStep for a number property element More...

Public Member Functions inherited from INDI::SensorInterface
	SensorInterface ()

	~SensorInterface ()

bool	initProperties ()
	Initilize properties initial state and value. The child class must implement this function. More...

bool	updateProperties ()
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More...

bool	processNumber (const char dev, const char name, double values[], char *names[], int n)

void	processProperties (const char *dev)

bool	processText (const char dev, const char name, char texts[], char names[], int n)

bool	processSwitch (const char dev, const char name, ISState states[], char *names[], int n)

bool	processBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)

bool	processSnoopDevice (XMLEle *root)

int	getBufferSize () const
	getContinuumBufferSize Get allocated continuum buffer size to hold the Sensor integrationd stream. More...

double	getIntegrationLeft () const
	getIntegrationLeft Get Integration time left in seconds. More...

double	getIntegrationTime () const
	getIntegrationTime Get requested Integration duration for the Sensor device in seconds. More...

const char *	getIntegrationStartTime ()
	getIntegrationStartTime More...

uint8_t *	getBuffer ()
	getBuffer Get raw buffer of the stream of the Sensor device. More...

void	setBuffer (uint8_t *buffer)
	setBuffer Set raw frame buffer pointer. More...

int	getBPS () const
	getBPS Get Sensor depth (bits per sample). More...

void	setBufferSize (int nbuf, bool allocMem=true)
	setBufferSize Set desired buffer size. The function will allocate memory accordingly. The frame size depends on the desired integration time, sampling frequency, and sample depth of the Sensor device (bps). You must set the frame size any time any of the prior parameters gets updated. More...

void	setBPS (int bps)
	setBPP Set depth of Sensor device. More...

void	setIntegrationTime (double duration)
	setIntegrationTime Set desired Sensor frame Integration duration for next Integration. You must call this function immediately before starting the actual Integration as it is used to calculate the timestamp used for the FITS header. More...

void	setIntegrationLeft (double duration)
	setIntegrationLeft Update Integration time left. Inform the client of the new Integration time left value. More...

void	setIntegrationFailed ()
	setIntegrationFailed Alert the client that the Integration failed. More...

int	getNAxis () const

void	setNAxis (int value)
	setNAxis Set FITS number of axis More...

void	setIntegrationFileExtension (const char *ext)
	setIntegrationExtension Set integration exntension More...

char *	getIntegrationFileExtension ()

bool	isCapturing () const

virtual int	SetTemperature (double temperature)
	Set Sensor temperature. More...

virtual bool	IntegrationComplete ()
	Uploads target Device exposed buffer as FITS to the client. Dervied classes should class this function when an Integration is complete. More...

void	setSensorConnection (const uint8_t &value)
	setSensorConnection Set Sensor connection mode. Child class should call this in the constructor before Sensor registers any connection interfaces More...

uint8_t	getSensorConnection ()

void	fits_update_key_s (fitsfile fptr, int type, std::string name, void p, std::string explanation, int *status)

Public Member Functions inherited from INDI::DefaultDevice
	DefaultDevice ()

virtual	~DefaultDevice () override=default

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver. More...

void	addDebugControl ()
	Add Debug control to the driver. More...

void	addSimulationControl ()
	Add Simulation control to the driver. More...

void	addConfigurationControl ()
	Add Configuration control to the driver. More...

void	addPollPeriodControl ()
	Add Polling period control to the driver. More...

void	resetProperties ()
	Set all properties to IDLE state. More...

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More...

void	defineProperty (INumberVectorProperty *property)

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More...

void	defineProperty (ITextVectorProperty *property)

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More...

void	defineProperty (ISwitchVectorProperty *property)

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More...

void	defineProperty (ILightVectorProperty *property)

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More...

void	defineProperty (IBLOBVectorProperty *property)

void	defineProperty (INDI::Property &property)

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. It will also be deleted from all clients. More...

bool	deleteProperty (INDI::Property &property)
	deleteProperty Delete a property and unregister it. It will also be deleted from all clients. More...

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...

void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...

uint16_t	getMajorVersion () const

uint16_t	getMinorVersion () const

uint16_t	getDriverInterface () const

void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More...

void	watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback)
	Add a device to the watch list. More...

Public Member Functions inherited from INDI::ParentDevice
	ParentDevice (Type type)

	~ParentDevice ()

	ParentDevice (ParentDevice &&other)=default

ParentDevice &	operator= (ParentDevice &&other)=default

Public Member Functions inherited from INDI::BaseDevice
	BaseDevice ()

virtual	~BaseDevice ()

void	registerProperty (const INDI::Property &property)
	Register the property to be able to observe and update. More...

void	registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property. More...

void	watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW)
	Call the callback function if property is available. More...

Property	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
	Return a property and its type given its name. More...

Properties	getProperties ()
	Return a list of all properties in the device. More...

const Properties	getProperties () const

INDI::PropertyNumber	getNumber (const char *name) const

INDI::PropertyText	getText (const char *name) const

INDI::PropertySwitch	getSwitch (const char *name) const

INDI::PropertyLight	getLight (const char *name) const

INDI::PropertyBlob	getBLOB (const char *name) const

IPState	getPropertyState (const char *name) const

IPerm	getPropertyPermission (const char *name) const

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
	Return a property and its type given its name. More...

void	addMessage (const std::string &msg)
	Add message to the driver's message queue. More...

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

const std::string &	messageQueue (size_t index) const

const std::string &	lastMessage () const

bool	isValid () const

bool	isConnected () const

void	attach ()
	indicates that the device is ready More...

void	detach ()
	indicates that the device is being removed More...

void	setMediator (INDI::BaseMediator *mediator)
	Set the driver's mediator to receive notification of news devices and updated property values. More...

INDI::BaseMediator *	getMediator () const

void	setDeviceName (const char *dev)
	Set the device name. More...

const char *	getDeviceName () const

bool	isDeviceNameMatch (const char *otherName) const
	Check that the device name matches the argument. More...

bool	isDeviceNameMatch (const std::string &otherName) const
	Check that the device name matches the argument. More...

const char *	getDriverName () const

const char *	getDriverExec () const

const char *	getDriverVersion () const

uint16_t	getDriverInterface () const
	getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. More...

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file. More...

int	buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
	Build a property given the supplied XML element (defXXX) More...

int	setValue (const INDI::LilXmlElement &root, char *errmsg)
	handle SetXXX commands from client More...

	operator BaseDevice * ()

BaseDevice *	operator-> ()

bool	operator!= (std::nullptr_t) const

bool	operator== (std::nullptr_t) const

	operator bool () const

	operator bool ()

Public Attributes
rtlsdr_dev *	rtl_dev = { nullptr }

int	to_read

bool	InIntegration

uint8_t *	buffer

int	b_read

int	n_read

Public Attributes inherited from INDI::Receiver
enum INDI::Receiver:: { ... }	ReceiverCapability

INumberVectorProperty	ReceiverSettingsNP

INumber	ReceiverSettingsN [7]

Public Attributes inherited from INDI::SensorInterface
enum INDI::SensorInterface:: { ... }	SensorCapability

enum INDI::SensorInterface:: { ... }	SensorConnection

Protected Member Functions
bool	Connect () override
	Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More...

bool	Disconnect () override
	Disconnect from device. More...

const char *	getDefaultName () override

bool	initProperties () override
	Initilize properties initial state and value. The child class must implement this function. More...

bool	updateProperties () override
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More...

bool	StartIntegration (double duration) override
	Start integration from the Sensor device. More...

void	setupParams (float sr, float freq, float gain)

bool	AbortIntegration () override
	Abort ongoing Integration. More...

void	TimerHit () override
	Callback function to be called once SetTimer duration elapses. More...

bool	StartStreaming () override
	StartStreaming Start live video streaming. More...

bool	StopStreaming () override
	StopStreaming Stop live video streaming. More...

void *	streamCapture ()

bool	Handshake () override
	perform handshake with device to check communication More...

Protected Member Functions inherited from INDI::SensorInterface
bool	HasShutter () const

bool	HasCooler () const

bool	CanAbort () const

bool	HasDSP ()

bool	HasStreaming ()

uint32_t	GetCapability () const
	GetCapability returns the Sensor capabilities. More...

void	SetCapability (uint32_t cap)
	SetCapability Set the Sensor capabilities. Al fields must be initialized. More...

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save configuration items in XML file. More...

virtual void	activeDevicesUpdated ()
	activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...

Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when űdeleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. More...

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file. More...

bool	loadConfig (INDI::Property &property)
	Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file. More...

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file. More...

bool	saveConfig (INDI::Property &property)
	Save a property in the configuration file. More...

virtual bool	purgeConfig ()
	purgeConfig Remove config file from disk. More...

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file More...

virtual bool	loadDefaultConfig ()
	Load the default configuration file. More...

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...

virtual void	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More...

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More...

bool	isDebug () const

bool	isSimulation () const

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More...

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool More...

Connection::Interface *	getActiveConnection ()

void	setActiveConnection (Connection::Interface *existingConnection)
	setActiveConnection Switch the active connection to the passed connection plugin More...

void	setDefaultPollingPeriod (uint32_t msec)
	setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More...

void	setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
	setPollingPeriodRange Set the range permitted by the polling range in milliseconds More...

uint32_t	getPollingPeriod () const
	getPollingPeriod Return the polling period. More...

void	setCurrentPollingPeriod (uint32_t msec)
	setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More...

uint32_t	getCurrentPollingPeriod () const
	getCurrentPollingPeriod Return the current polling period. More...

uint32_t &	refCurrentPollingPeriod () __attribute__((deprecated))

uint32_t	refCurrentPollingPeriod () const __attribute__((deprecated))

bool	isConfigLoading () const
	isConfigLoading Check if driver configuration is currently in the process of getting loaded. More...

bool	isInitializationComplete () const
	isInitializationComplete Check if driver initialization is complete. More...

void	syncDriverInfo ()
	syncDriverInfo sends the current driver information to the client. More...

	DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd)

Protected Member Functions inherited from INDI::ParentDevice
	ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd)

Protected Member Functions inherited from INDI::BaseDevice
	BaseDevice (BaseDevicePrivate &dd)

	BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd)

Additional Inherited Members
Public Types inherited from INDI::Receiver
enum	{ SPECTROGRAPH_MAX_CAPABILITY = SENSOR_MAX_CAPABILITY << 0 }

enum	RECEIVER_INFO_INDEX { RECEIVER_GAIN = 0 , RECEIVER_FREQUENCY , RECEIVER_BANDWIDTH , RECEIVER_BITSPERSAMPLE , RECEIVER_SAMPLERATE , RECEIVER_ANTENNA }

Public Types inherited from INDI::SensorInterface
enum	{ SENSOR_CAN_ABORT = 1 << 0 , SENSOR_HAS_STREAMING = 1 << 1 , SENSOR_HAS_SHUTTER = 1 << 2 , SENSOR_HAS_COOLER = 1 << 3 , SENSOR_HAS_DSP = 1 << 4 , SENSOR_MAX_CAPABILITY = 1 << 5 }

enum	{ CONNECTION_NONE = 1 << 0 , CONNECTION_SERIAL = 1 << 1 , CONNECTION_TCP = 1 << 2 }

Public Types inherited from INDI::ParentDevice
enum	Type { Valid , Invalid }

Public Types inherited from INDI::BaseDevice
enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1 , INDI_PROPERTY_INVALID = -2 , INDI_PROPERTY_DUPLICATED = -3 , INDI_DISPATCH_ERROR = -4 }

enum	{ INDI_ENABLED , INDI_DISABLED }

enum	WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0 , TELESCOPE_INTERFACE = (1 << 0) , CCD_INTERFACE = (1 << 1) , GUIDER_INTERFACE = (1 << 2) , FOCUSER_INTERFACE = (1 << 3) , FILTER_INTERFACE = (1 << 4) , DOME_INTERFACE = (1 << 5) , GPS_INTERFACE = (1 << 6) , WEATHER_INTERFACE = (1 << 7) , AO_INTERFACE = (1 << 8) , DUSTCAP_INTERFACE = (1 << 9) , LIGHTBOX_INTERFACE = (1 << 10) , DETECTOR_INTERFACE = (1 << 11) , ROTATOR_INTERFACE = (1 << 12) , SPECTROGRAPH_INTERFACE = (1 << 13) , CORRELATOR_INTERFACE = (1 << 14) , AUX_INTERFACE = (1 << 15) , SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE \| DETECTOR_INTERFACE \| CORRELATOR_INTERFACE }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...

typedef INDI::Properties	Properties

Static Public Member Functions inherited from INDI::BaseDevice
static std::string	getSharedFilePath (std::string fileName)

Protected Types inherited from INDI::SensorInterface
enum	{ TELESCOPE_PRIMARY }

enum	{ UPLOAD_DIR , UPLOAD_PREFIX }

enum	{ FITS_OBSERVER , FITS_OBJECT }

Protected Attributes inherited from INDI::SensorInterface
uint32_t	capability

INumberVectorProperty	FramedIntegrationNP

INumber	FramedIntegrationN [1]

ISwitchVectorProperty	AbortIntegrationSP

ISwitch	AbortIntegrationS [1]

IBLOB	FitsB

IBLOBVectorProperty	FitsBP

ITextVectorProperty	ActiveDeviceTP

IText	ActiveDeviceT [4] {}

IText	FileNameT [1] {}

ITextVectorProperty	FileNameTP

ISwitch	DatasetS [1]

ISwitchVectorProperty	DatasetSP

ISwitch	UploadS [3]

ISwitchVectorProperty	UploadSP

IText	UploadSettingsT [2] {}

ITextVectorProperty	UploadSettingsTP

ISwitch	TelescopeTypeS [2]

ISwitchVectorProperty	TelescopeTypeSP

IText	FITSHeaderT [2] {}

ITextVectorProperty	FITSHeaderTP

bool	InIntegration

INumberVectorProperty	EqNP

INumber	EqN [2]

double	RA

double	Dec

INumberVectorProperty	LocationNP

INumber	LocationN [3]

double	Latitude

double	Longitude

double	Elevation

INumberVectorProperty	ScopeParametersNP

INumber	ScopeParametersN [4]

double	primaryAperture

double	primaryFocalLength

bool	AutoLoop

bool	SendIntegration

bool	ShowMarker

double	IntegrationTime

double	MPSAS

INumber	TemperatureN [1]

INumberVectorProperty	TemperatureNP

std::mutex	detectorBufferLock

std::unique_ptr< StreamManager >	Streamer

std::unique_ptr< DSP::Manager >	DSP

Connection::Serial *	serialConnection = NULL

Connection::TCP *	tcpConnection = NULL

int	PortFD = -1
	For Serial & TCP connections. More...

Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivate >	d_ptr

Detailed Description

Definition at line 37 of file indi_rtlsdr.h.

Constructor & Destructor Documentation

◆ RTLSDR()

RTLSDR::RTLSDR ( int32_t index )

Definition at line 105 of file indi_rtlsdr.cpp.

Member Function Documentation

◆ AbortIntegration()

bool RTLSDR::AbortIntegration ( )

overrideprotectedvirtual

Abort ongoing Integration.

Returns: true is abort is successful, false otherwise.

Note: This function is not implemented in Sensor, it must be implemented in the child class

Reimplemented from INDI::SensorInterface.

Definition at line 331 of file indi_rtlsdr.cpp.

◆ Connect()

bool RTLSDR::Connect ( )

overrideprotectedvirtual

Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation.

Returns: True if connection is successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 124 of file indi_rtlsdr.cpp.

◆ Disconnect()

bool RTLSDR::Disconnect ( )

overrideprotectedvirtual

Disconnect from device.

Returns: True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 140 of file indi_rtlsdr.cpp.

◆ getDefaultName()

const char * RTLSDR::getDefaultName ( )

overrideprotectedvirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 162 of file indi_rtlsdr.cpp.

◆ grabData()

void RTLSDR::grabData ( )

Definition at line 389 of file indi_rtlsdr.cpp.

◆ Handshake()

bool RTLSDR::Handshake ( )

overrideprotectedvirtual

perform handshake with device to check communication

Reimplemented from INDI::SensorInterface.

Definition at line 442 of file indi_rtlsdr.cpp.

◆ initProperties()

bool RTLSDR::initProperties ( )

overrideprotectedvirtual

Initilize properties initial state and value. The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::Receiver.

Definition at line 170 of file indi_rtlsdr.cpp.

◆ ISNewNumber()

bool RTLSDR::ISNewNumber	(	const char *	dev,
		const char *	name,
		double	values[],
		char *	names[],
		int	n
	)

overridevirtual

Process the client newNumber command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Receiver.

Definition at line 277 of file indi_rtlsdr.cpp.

◆ setupParams()

void RTLSDR::setupParams	(	float	sr,
		float	freq,
		float	gain
	)

protected

Definition at line 215 of file indi_rtlsdr.cpp.

◆ StartIntegration()

bool RTLSDR::StartIntegration ( double duration )

overrideprotectedvirtual

Start integration from the Sensor device.

Parameters

duration Duration in seconds

Returns: true if OK and Integration will take some time to complete, false on error.

Note: This function is not implemented in Sensor, it must be implemented in the child class

Reimplemented from INDI::Receiver.

Definition at line 312 of file indi_rtlsdr.cpp.

◆ StartStreaming()

bool RTLSDR::StartStreaming ( )

overrideprotectedvirtual

StartStreaming Start live video streaming.

Returns: True if successful, false otherwise.

Reimplemented from INDI::SensorInterface.

Definition at line 421 of file indi_rtlsdr.cpp.

◆ StopStreaming()

bool RTLSDR::StopStreaming ( )

overrideprotectedvirtual

StopStreaming Stop live video streaming.

Returns: True if successful, false otherwise.

Reimplemented from INDI::SensorInterface.

Definition at line 432 of file indi_rtlsdr.cpp.

◆ streamCapture()

void* RTLSDR::streamCapture ( )

protected

◆ TimerHit()

void RTLSDR::TimerHit ( )

overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

Definition at line 361 of file indi_rtlsdr.cpp.

◆ updateProperties()

bool RTLSDR::updateProperties ( )

overrideprotectedvirtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns: True if update is successful, false otherwise.

Reimplemented from INDI::Receiver.

Definition at line 195 of file indi_rtlsdr.cpp.

Member Data Documentation

◆ b_read

int RTLSDR::b_read

Definition at line 48 of file indi_rtlsdr.h.

◆ buffer

uint8_t* RTLSDR::buffer

Definition at line 47 of file indi_rtlsdr.h.

◆ InIntegration

bool RTLSDR::InIntegration

Definition at line 46 of file indi_rtlsdr.h.

◆ n_read

int RTLSDR::n_read

Definition at line 48 of file indi_rtlsdr.h.

◆ rtl_dev

rtlsdr_dev* RTLSDR::rtl_dev = { nullptr }

Definition at line 43 of file indi_rtlsdr.h.

◆ to_read

int RTLSDR::to_read

Definition at line 44 of file indi_rtlsdr.h.

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

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RTLSDR()

Member Function Documentation

◆ AbortIntegration()

◆ Connect()

◆ Disconnect()

◆ getDefaultName()

◆ grabData()

◆ Handshake()

◆ initProperties()

◆ ISNewNumber()

◆ setupParams()

◆ StartIntegration()

◆ StartStreaming()

◆ StopStreaming()

◆ streamCapture()

◆ TimerHit()

◆ updateProperties()

Member Data Documentation

◆ b_read

◆ buffer

◆ InIntegration

◆ n_read

◆ rtl_dev

◆ to_read