Traffic receiver: Bluetooth LE connection to a FLARM/NMEA source via the "Nordic UART Service". More...

#include <TrafficDataSource_BluetoothLowEnergy.h>

Inheritance diagram for Traffic::TrafficDataSource_BluetoothLowEnergy:

Public Slots
void	connectToTrafficReceiver () override
	Start attempt to connect to traffic receiver.

void	disconnectFromTrafficReceiver () override
	Disconnect from traffic receiver.

Public Slots inherited from Traffic::TrafficDataSource_Abstract
virtual void	connectToTrafficReceiver ()=0
	Start attempt to connect to traffic receiver.

virtual void	disconnectFromTrafficReceiver ()=0
	Disconnect from traffic receiver.

virtual void	setPassword (const QString &SSID, const QString &password)
	Set password.

Public Member Functions
	TrafficDataSource_BluetoothLowEnergy (bool isCanonical, const QBluetoothDeviceInfo &info, QObject *parent)
	Default constructor.

Traffic::ConnectionInfo	connectionInfo () const override
	Getter function for the property with the same name.

QString	dataFormat () const override
	Getter function for the property with the same name.

QString	icon () const override
	Getter function for the property with the same name.

QString	sourceName () const override
	Getter function for the property with the same name.

QBluetoothDeviceInfo	sourceInfo () const
	Getter function for the property with the same name.

Public Member Functions inherited from Traffic::TrafficDataSource_AbstractSocket
	TrafficDataSource_AbstractSocket (bool isCanonical, QObject *parent)
	Default constructor.

Public Member Functions inherited from Traffic::TrafficDataSource_Abstract
	TrafficDataSource_Abstract (bool isCanonical, QObject *parent)
	Default constructor.

bool	canonical () const
	Getter function for the property with the same name.

QString	connectivityStatus () const
	Getter function for the property with the same name.

QString	errorString () const
	Getter function for the property with the same name.

Units::Distance	pressureAltitude () const
	Getter method for property with the same name.

QBindable< Units::Distance >	bindablePressureAltitude () const
	Getter method for property with the same name.

bool	receivingHeartbeat () const
	Getter function for the property with the same name.

QString	trafficReceiverRuntimeError () const
	Getter function for the property with the same name.

QString	trafficReceiverSelfTestError () const
	Getter function for the property with the same name.

Properties
QBluetoothDeviceInfo	sourceInfo
	Source info.

Properties inherited from Traffic::TrafficDataSource_Abstract
bool	canonical
	Canonicity.

QString	connectivityStatus
	Connectivity status.

Traffic::ConnectionInfo	connectionInfo
	Connection Info.

QString	dataFormat
	Data format.

QString	errorString
	String describing the last socket error.

QString	icon
	Icon that can be used to represent the connection in a GUI.

Units::Distance	pressureAltitude
	Pressure altitude.

bool	receivingHeartbeat
	Heartbeat indicator.

QString	sourceName
	Source name.

QString	trafficReceiverRuntimeError
	String describing the last traffic data receiver runtime error.

QString	trafficReceiverSelfTestError
	String describing the last traffic data receiver self-test error.

Additional Inherited Members
Signals inherited from Traffic::TrafficDataSource_Abstract
void	connectivityStatusChanged (QString newStatus)
	Notifier signal.

void	errorStringChanged (QString newError)
	Notifier signal.

void	factorWithoutPosition (const Traffic::TrafficFactor_DistanceOnly &factor)
	Traffic factor without position.

void	factorWithPosition (const Traffic::TrafficFactor_WithPosition &factor)
	Traffic factor with position.

void	positionUpdated (Positioning::PositionInfo pInfo)
	Position info.

void	receivingHeartbeatChanged (bool)
	Notifier signal.

void	trafficReceiverRuntimeErrorChanged ()
	Notifier signal.

void	trafficReceiverSelfTestErrorChanged ()
	Notifier signal.

void	trafficReceiverHwVersion (QString result)
	Traffic receiver hardware version.

void	trafficReceiverObVersion (QString result)
	Traffic receiver obstacle database version.

void	trafficReceiverSwVersion (QString result)
	Traffic receiver software version.

void	warning (const Traffic::Warning &warning)
	Traffic warning.

Protected Member Functions inherited from Traffic::TrafficDataSource_Abstract
void	processFLARMData (const QString &data)
	Process FLARM/NMEA data.

void	processGDLMessage (const QByteArray &message)
	Process one GDL90 message.

void	processXGPSString (const QByteArray &data)
	Process one XGPS string.

void	resetReceivingHeartbeat ()
	Resetter method for the property with the same name.

void	setConnectivityStatus (const QString &newConnectivityStatus)
	Setter function for the property with the same name.

void	setErrorString (const QString &newErrorString=QString())
	Setter function for the property with the same name.

void	setPressureAltitude (Units::Distance newPressureAltitude)
	Setter function for the property with the same name.

void	setReceivingHeartbeat (bool newReceivingHeartbeat)
	Setter method for the property with the same name.

void	setTrafficReceiverRuntimeError (const QString &newErrorString)
	Setter function for the property with the same name.

void	setTrafficReceiverSelfTestError (const QString &newErrorString)
	Setter function for the property with the same name.

Detailed Description

Traffic receiver: Bluetooth LE connection to a FLARM/NMEA source via the "Nordic UART Service".

This class connects to a traffic receiver via Bluetooth LE via the "Nordic UART Service" (NUS). This is a custom service developed by Nordic Semiconductor for Bluetooth Low Energy (BLE) devices. It acts as a bridge between BLE and UART (Universal Asynchronous Receiver/Transmitter) interfaces and allows for bidirectional communication between devices using a simple serial protocol over BLE.

Details are described here: https://docs.ruuvi.com/communication/bluetooth-connection/nordic-uart-service-nus

At the time of writing (early Mar 25), the implementation is not well-tested. The connection procedure is rather complicated.

Someone calls connectToTrafficReceiver(). The implementation calls m_control->connectToDevice().
Once a connection is established, signal/slots ensure that m_control->discoverServices() is called.
Once all services are found, the slot onDiscoveryFinished() is called. The implementation checks if the device offers the "Nordic UART Service" (NUS). If so, we need to find the service details. To start the search, the implementation calls m_NUSService->discoverDetails().
Once the service details are found, the slot onServiceStateChanged() is called with argument QLowEnergyService::RemoteServiceDiscovered. The implementation checks if the service offers the "TX" characteristic. If so, it switched notifications on.
Data will now flow in via the slot onCharacteristcChanged()

Definition at line 72 of file TrafficDataSource_BluetoothLowEnergy.h.

Constructor & Destructor Documentation

◆ TrafficDataSource_BluetoothLowEnergy()

Traffic::TrafficDataSource_BluetoothLowEnergy::TrafficDataSource_BluetoothLowEnergy	(	bool	isCanonical,
		const QBluetoothDeviceInfo &	info,
		QObject *	parent )

Default constructor.

Parameters

isCanonical	Intializer for property canonical
info	Description of a Bluetooth LE device
parent	The standard QObject parent pointer

Member Function Documentation

◆ connectionInfo()

Traffic::ConnectionInfo Traffic::TrafficDataSource_BluetoothLowEnergy::connectionInfo ( ) const

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

Returns: Property connectionInfo

Reimplemented from Traffic::TrafficDataSource_Abstract.

Definition at line 111 of file TrafficDataSource_BluetoothLowEnergy.h.

◆ connectToTrafficReceiver

void Traffic::TrafficDataSource_BluetoothLowEnergy::connectToTrafficReceiver ( )

overrideslot

Start attempt to connect to traffic receiver.

This method implements the pure virtual method declared by its superclass.

◆ dataFormat()

QString Traffic::TrafficDataSource_BluetoothLowEnergy::dataFormat ( ) const

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

Returns: Property dataFormat

Implements Traffic::TrafficDataSource_Abstract.

Definition at line 120 of file TrafficDataSource_BluetoothLowEnergy.h.

◆ disconnectFromTrafficReceiver

void Traffic::TrafficDataSource_BluetoothLowEnergy::disconnectFromTrafficReceiver ( )

overrideslot

Disconnect from traffic receiver.

This method implements the pure virtual method declared by its superclass.

◆ icon()

QString Traffic::TrafficDataSource_BluetoothLowEnergy::icon ( ) const

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

This method implements the pure virtual method declared by its superclass.

Returns: Property icon

Implements Traffic::TrafficDataSource_Abstract.

Definition at line 129 of file TrafficDataSource_BluetoothLowEnergy.h.

◆ sourceInfo()

QBluetoothDeviceInfo Traffic::TrafficDataSource_BluetoothLowEnergy::sourceInfo ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property sourceInfo

Definition at line 144 of file TrafficDataSource_BluetoothLowEnergy.h.

◆ sourceName()

QString Traffic::TrafficDataSource_BluetoothLowEnergy::sourceName ( ) const

nodiscardoverridevirtual

Getter function for the property with the same name.

This method implements the pure virtual method declared by its superclass.

Returns: Property sourceName

Implements Traffic::TrafficDataSource_Abstract.

Property Documentation

◆ sourceInfo

QBluetoothDeviceInfo Traffic::TrafficDataSource_BluetoothLowEnergy::sourceInfo

read

Source info.

Device info, as set in the constructor of this class.

Definition at line 99 of file TrafficDataSource_BluetoothLowEnergy.h.

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

/home/runner/work/enroute/enroute/src/traffic/TrafficDataSource_BluetoothLowEnergy.h

Public Slots

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrafficDataSource_BluetoothLowEnergy()

Member Function Documentation

◆ connectionInfo()

◆ connectToTrafficReceiver

◆ dataFormat()

◆ disconnectFromTrafficReceiver

◆ icon()

◆ sourceInfo()

◆ sourceName()

Property Documentation

◆ sourceInfo