Shared serial inventory and exclusive claims. Called on the application thread. More...

#include <SerialPortManager.h>

Inheritance diagram for SerialPortManager:

Collaboration diagram for SerialPortManager:

Classes
struct	Port

struct	Reservation

Public Types
using	ReservationPtr = std::shared_ptr< const Reservation >

using	Enumerator = std::function< QList< Port >()>

Signals
void	serialPortsChanged ()

void	portsEnumerated (const QStringList &availablePorts)
	Emitted only after a fresh scan, never for a retained Android snapshot. Includes native names and paths.

Public Member Functions
	SerialPortManager (QObject *parent=nullptr, Enumerator enumerator={})

QList< Port >	availablePorts ()

void	rescan ()
	As availablePorts(), without reusing a scan made less than a second ago.

QString	displayName (const QString &systemLocation)

QStringList	serialPorts () const

ReservationPtr	reservePort (const QString &systemLocation)

bool	canReservePort (const QString &systemLocation) const

bool	isPortReserved (const QString &systemLocation) const

bool	anyPortReserved () const

ReservationPtr	excludeFromAutoConnect (const QString &systemLocation)
	Routing exclusions survive reconnects without marking the hardware occupied.

bool	canAutoConnectPort (const QString &systemLocation) const

bool	isAutoConnectExcluded (const QString &systemLocation) const

void	setSinglePortOnly (bool enabled)

Static Public Member Functions
static SerialPortManager *	instance ()

static bool	isPrimaryInterface (const Port &port, QSet< QString > &seenDevices)

static QStringList	supportedBaudRates ()

Static Public Attributes
static constexpr std::chrono::milliseconds	NEW_PORT_SETTLE_DELAY {1000}
	How long a newly listed port settles before automatic connection opens it.

Detailed Description

Shared serial inventory and exclusive claims. Called on the application thread.

Definition at line 18 of file SerialPortManager.h.

Member Typedef Documentation

◆ Enumerator

using SerialPortManager::Enumerator = std::function<QList<Port>()>

Definition at line 47 of file SerialPortManager.h.

◆ ReservationPtr

using SerialPortManager::ReservationPtr = std::shared_ptr<const Reservation>

Definition at line 46 of file SerialPortManager.h.

Constructor & Destructor Documentation

◆ SerialPortManager()

SerialPortManager::SerialPortManager	(	QObject *	parent = `nullptr`,
		Enumerator	enumerator = `{}`
	)

explicit

Definition at line 15 of file SerialPortManager.cc.

Member Function Documentation

◆ anyPortReserved()

bool SerialPortManager::anyPortReserved ( ) const

Definition at line 125 of file SerialPortManager.cc.

Referenced by availablePorts(), and canReservePort().

◆ availablePorts()

QList< SerialPortManager::Port > SerialPortManager::availablePorts ( )

Definition at line 63 of file SerialPortManager.cc.

References anyPortReserved(), portsEnumerated(), serialPorts(), and serialPortsChanged().

Referenced by SerialConfiguration::connectionSettings(), displayName(), and rescan().

◆ canAutoConnectPort()

bool SerialPortManager::canAutoConnectPort ( const QString & systemLocation ) const

Definition at line 158 of file SerialPortManager.cc.

References canReservePort(), and isAutoConnectExcluded().

Referenced by SerialAutoConnect::update().

◆ canReservePort()

bool SerialPortManager::canReservePort ( const QString & systemLocation ) const

Definition at line 135 of file SerialPortManager.cc.

References anyPortReserved(), and isPortReserved().

Referenced by canAutoConnectPort(), and reservePort().

◆ displayName()

QString SerialPortManager::displayName ( const QString & systemLocation )

Definition at line 94 of file SerialPortManager.cc.

References availablePorts().

Referenced by SerialConfiguration::cleanPortDisplayName().

◆ excludeFromAutoConnect()

SerialPortManager::ReservationPtr SerialPortManager::excludeFromAutoConnect ( const QString & systemLocation )

Routing exclusions survive reconnects without marking the hardware occupied.

Definition at line 141 of file SerialPortManager.cc.

◆ instance()

SerialPortManager * SerialPortManager::instance ( )

static

Definition at line 19 of file SerialPortManager.cc.

Referenced by SerialConfiguration::cleanPortDisplayName(), SerialConfiguration::connectionSettings(), LinkManager::createConnectedLink(), LinkManager::init(), LinkManager::LinkManager(), Q_APPLICATION_STATIC(), SerialLink::SerialLink(), and QGroundControlQmlGlobal::serialPortManager().

◆ isAutoConnectExcluded()

bool SerialPortManager::isAutoConnectExcluded ( const QString & systemLocation ) const

Definition at line 218 of file SerialPortManager.cc.

Referenced by canAutoConnectPort(), and SerialAutoConnect::update().

◆ isPortReserved()

bool SerialPortManager::isPortReserved ( const QString & systemLocation ) const

Definition at line 120 of file SerialPortManager.cc.

Referenced by canReservePort().

◆ isPrimaryInterface()

bool SerialPortManager::isPrimaryInterface	(	const Port &	port,
		QSet< QString > &	seenDevices
	)

static

Whether port is the first interface listed of its physical device, which this records in seenDevices. A port without a device identity is always primary.

Definition at line 24 of file SerialPortManager.cc.

Referenced by SerialAutoConnect::update().