Implements an USB interface to radios running the Open RTX firmware. More...

#include <openrtx.hh>

Inheritance diagram for OpenRTX:

Collaboration diagram for OpenRTX:

[legend]

Public Slots
bool	startDownload (bool blocking=false, const ErrorStack &err=ErrorStack())
	Starts the download of the codeplug and derives the generic configuration from it.

bool	startUpload (Config *config, bool blocking=false, const Codeplug::Flags &flags=Codeplug::Flags(), const ErrorStack &err=ErrorStack())
	Derives the device-specific codeplug from the generic configuration and uploads that codeplug to the radio.

bool	startUploadCallsignDB (UserDatabase *db, bool blocking=false, const CallsignDB::Selection &selection=CallsignDB::Selection(), const ErrorStack &err=ErrorStack())
	Encodes the given user-database and uploades it to the device.

Public Slots inherited from Radio
virtual bool	startDownload (bool blocking=false, const ErrorStack &err=ErrorStack())=0
	Starts the download of the codeplug. More...

virtual bool	startUpload (Config *config, bool blocking=false, const Codeplug::Flags &flags=Codeplug::Flags(), const ErrorStack &err=ErrorStack())=0
	Derives the device-specific codeplug from the generic configuration and uploads that codeplug to the radio.

virtual bool	startUploadCallsignDB (UserDatabase *db, bool blocking=false, const CallsignDB::Selection &selection=CallsignDB::Selection(), const ErrorStack &err=ErrorStack())=0
	Assembles the callsign DB from the given one and uploads it to the device.

Public Member Functions
	OpenRTX (OpenRTXInterface device=nullptr, QObject parent=nullptr)
	Do not construct this class directly, rather use `Radio::detect`.

const QString &	name () const
	Returns the name of the radio (e.g., device identifier).

const Codeplug &	codeplug () const
	Returns the codeplug instance.

Codeplug &	codeplug ()
	Returns the codeplug instance.

Public Member Functions inherited from Radio
	Radio (QObject *parent=nullptr)
	Default constructor.

virtual const RadioLimits &	limits () const =0
	Returns the limits for this radio. More...

virtual const CallsignDB *	callsignDB () const
	Returns the call-sign DB instance.

virtual CallsignDB *	callsignDB ()
	Returns the call-sign DB instance.

Status	status () const
	Returns the current status.

const ErrorStack &	errorStack () const
	Returns the error stack, passed to `startDownload`, `startUpload` or `startUploadCallsignDB`. More...

Static Public Member Functions
static RadioInfo	defaultRadioInfo ()
	Returns the default radio information. More...

Static Public Member Functions inherited from Radio
static Radio *	detect (const USBDeviceDescriptor &descr, const RadioInfo &force=RadioInfo(), const ErrorStack &err=ErrorStack())
	Tries to detect the radio connected to the specified interface or constructs the specified radio using the `RadioInfo` passed by `force`.

Protected Member Functions
void	run ()
	Thread main routine, performs all blocking IO operations for codeplug up- and download.

bool	connect (const ErrorStack &err=ErrorStack())
	Connects to the radio, if a radio interface is passed to the constructor, this interface instance is used.

bool	download (const ErrorStack &err=ErrorStack())
	Implements the actual download process.

bool	upload (const ErrorStack &err=ErrorStack())
	Implements the actual codeplug upload process.

Protected Attributes
QString	_name
	The device identifier.

OpenRTXInterface *	_dev
	The interface to the radio.

Config *	_config
	The generic configuration.

OpenRTXCodeplug	_codeplug
	The actual binary codeplug representation.

Protected Attributes inherited from Radio
Status	_task
	The current state/task.

ErrorStack	_errorStack
	The error stack.

Additional Inherited Members
Public Types inherited from Radio
enum	Status { StatusIdle , StatusDownload , StatusUpload , StatusUploadCallsigns , StatusError }
	Possible states of the radio object. More...

Signals inherited from Radio
void	downloadStarted ()
	Gets emitted once the codeplug download has been started.

void	downloadProgress (int percent)
	Gets emitted on download progress (e.g., for progress bars).

void	downloadFinished (Radio radio, Codeplug codeplug)
	Gets emitted once the codeplug download has been finished.

void	downloadError (Radio *radio)
	Gets emitted if there was an error during the codeplug download.

void	uploadStarted ()
	Gets emitted once the codeplug upload has been started.

void	uploadProgress (int percent)
	Gets emitted on upload progress (e.g., for progress bars).

void	uploadError (Radio *radio)
	Gets emitted if there was an error during the upload.

void	uploadComplete (Radio *radio)
	Gets emitted once the codeplug upload has been completed successfully.

Detailed Description

Implements an USB interface to radios running the Open RTX firmware.

Member Function Documentation

RadioInfo OpenRTX::defaultRadioInfo ( )

static

Returns the default radio information.

The actual instance may have different properties due to variants of the same radio.

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