[sensors] Add sensor error reporting capability

nirvn · nirvn · commit 56e33a9fb6f0 · 2023-04-01T16:59:55.000+07:00
diff --git a/python/core/auto_generated/sensor/qgsabstractsensor.sip.in b/python/core/auto_generated/sensor/qgsabstractsensor.sip.in
@@ -114,6 +114,11 @@ Returns the latest captured data from the sensor.
     void setData( const QgsAbstractSensor::SensorData &data );
 %Docstring
 Sets the latest captured data from the sensor.
+%End
+
+    QString errorString() const;
+%Docstring
+Returns the last error message.
 %End
 
     bool writeXml( QDomElement &parentElement, QDomDocument &document ) const;
@@ -163,6 +168,11 @@ Emitted when the sensor status has changed.
     void dataChanged();
 %Docstring
 Emitted when the captured sensor data has changed.
+%End
+
+    void errorOccurred( const QString &errorString );
+%Docstring
+Emitted when an error has occurred. The ``errorString`` describes the error.
 %End
 
   protected:
diff --git a/python/core/auto_generated/sensor/qgssensormanager.sip.in b/python/core/auto_generated/sensor/qgssensormanager.sip.in
@@ -131,6 +131,11 @@ Emitted when a sensor status has changed.
     void sensorDataCaptured( const QString &id );
 %Docstring
 Emitted when newly captured data from a sensor has occurred.
+%End
+
+    void sensorErrorOccurred( const QString &id );
+%Docstring
+Emitted when a sensor error has occurred.
 %End
 
 };
diff --git a/src/core/sensor/qgsabstractsensor.cpp b/src/core/sensor/qgsabstractsensor.cpp
@@ -63,6 +63,11 @@ void QgsAbstractSensor::setData( const QgsAbstractSensor::SensorData &data )
   emit dataChanged();
 }
 
+QString QgsAbstractSensor::errorString() const
+{
+  return mErrorString;
+}
+
 void QgsAbstractSensor::connectSensor()
 {
   setStatus( Qgis::DeviceConnectionStatus::Connecting );
diff --git a/src/core/sensor/qgsabstractsensor.h b/src/core/sensor/qgsabstractsensor.h
@@ -143,6 +143,11 @@ class CORE_EXPORT QgsAbstractSensor : public QObject
      */
     void setData( const QgsAbstractSensor::SensorData &data );
 
+    /**
+     * Returns the last error message.
+     */
+    QString errorString() const;
+
     /**
      * Write generic sensor properties into a DOM element.
      * \param parentElement parent DOM element (e.g 'Sensors' element)
@@ -182,6 +187,9 @@ class CORE_EXPORT QgsAbstractSensor : public QObject
     //! Emitted when the captured sensor data has changed.
     void dataChanged();
 
+    //! Emitted when an error has occurred. The \a errorString describes the error.
+    void errorOccurred( const QString &errorString );
+
   protected:
 
     /**
@@ -197,6 +205,7 @@ class CORE_EXPORT QgsAbstractSensor : public QObject
     virtual void handleDisconnect() = 0;
 
     QgsAbstractSensor::SensorData mData;
+    QString mErrorString;
 
   private:
 
diff --git a/src/core/sensor/qgsiodevicesensor.cpp b/src/core/sensor/qgsiodevicesensor.cpp
@@ -57,6 +57,13 @@ QgsTcpSocketSensor::QgsTcpSocketSensor( QObject *parent )
   , mTcpSocket( new QTcpSocket() )
 {
   connect( mTcpSocket, &QAbstractSocket::stateChanged, this, &QgsTcpSocketSensor::socketStateChanged );
+
+#if QT_VERSION < QT_VERSION_CHECK( 5, 15, 0 )
+  connect( mTcpSocket, qOverload<QAbstractSocket::SocketError>( &QAbstractSocket::error ), this, &QgsTcpSocketSensor::handleError );
+#else
+  connect( mTcpSocket, qOverload<QAbstractSocket::SocketError>( &QAbstractSocket::errorOccurred ), this, &QgsTcpSocketSensor::handleError );
+#endif
+
   initIODevice( mTcpSocket );
 }
 
@@ -112,6 +119,27 @@ void QgsTcpSocketSensor::handleDisconnect()
   mTcpSocket->close();
 }
 
+void QgsTcpSocketSensor::handleError( QAbstractSocket::SocketError error )
+{
+  switch ( error )
+  {
+    case QAbstractSocket::HostNotFoundError:
+      mErrorString = tr( "Could not find the remote host" );
+      break;
+    case QAbstractSocket::NetworkError:
+      mErrorString = tr( "Attempt to read or write from socket returned an error" );
+      break;
+    case QAbstractSocket::ConnectionRefusedError:
+      mErrorString = tr( "The connection was refused by the remote host" );
+      break;
+    default:
+      mErrorString = tr( "%1" ).arg( QMetaEnum::fromType<QAbstractSocket::SocketError>().valueToKey( error ) );
+      break;
+  }
+
+  emit errorOccurred( mErrorString );
+}
+
 void QgsTcpSocketSensor::socketStateChanged( const QAbstractSocket::SocketState socketState )
 {
   switch ( socketState )
@@ -178,6 +206,12 @@ QgsUdpSocketSensor::QgsUdpSocketSensor( QObject *parent )
     }
   } );
 
+#if QT_VERSION < QT_VERSION_CHECK( 5, 15, 0 )
+  connect( mUdpSocket.get(), qOverload<QAbstractSocket::SocketError>( &QAbstractSocket::error ), this, &QgsUdpSocketSensor::handleError );
+#else
+  connect( mUdpSocket.get(), qOverload<QAbstractSocket::SocketError>( &QAbstractSocket::errorOccurred ), this, &QgsUdpSocketSensor::handleError );
+#endif
+
   initIODevice( mBuffer );
 }
 
@@ -236,6 +270,27 @@ void QgsUdpSocketSensor::handleDisconnect()
   mBuffer->close();
 }
 
+void QgsUdpSocketSensor::handleError( QAbstractSocket::SocketError error )
+{
+  switch ( error )
+  {
+    case QAbstractSocket::HostNotFoundError:
+      mErrorString = tr( "Could not find the remote host" );
+      break;
+    case QAbstractSocket::NetworkError:
+      mErrorString = tr( "Attempt to read or write from socket returned an error" );
+      break;
+    case QAbstractSocket::ConnectionRefusedError:
+      mErrorString = tr( "The connection was refused by the remote host" );
+      break;
+    default:
+      mErrorString = tr( "%1" ).arg( QMetaEnum::fromType<QAbstractSocket::SocketError>().valueToKey( error ) );
+      break;
+  }
+
+  emit errorOccurred( mErrorString );
+}
+
 void QgsUdpSocketSensor::socketStateChanged( const QAbstractSocket::SocketState socketState )
 {
   switch ( socketState )
@@ -279,6 +334,8 @@ QgsSerialPortSensor::QgsSerialPortSensor( QObject *parent )
   : QgsIODeviceSensor( parent )
   , mSerialPort( new QSerialPort() )
 {
+  connect( mSerialPort, qOverload<QSerialPort::SerialPortError>( &QSerialPort::errorOccurred ), this, &QgsSerialPortSensor::handleError );
+
   initIODevice( mSerialPort );
 }
 
@@ -324,6 +381,32 @@ void QgsSerialPortSensor::handleDisconnect()
   mSerialPort->close();
 }
 
+void QgsSerialPortSensor::handleError( QSerialPort::SerialPortError error )
+{
+  if ( error == QSerialPort::NoError )
+  {
+    return;
+  }
+
+  switch ( error )
+  {
+    case QSerialPort::DeviceNotFoundError:
+      mErrorString = tr( "Could not find the serial port device" );
+      break;
+    case QSerialPort::ReadError:
+      mErrorString = tr( "Attempt to read from the serial port returned an error" );
+      break;
+    case QSerialPort::PermissionError:
+      mErrorString = tr( "The connection was refused due to not having enough permission" );
+      break;
+    default:
+      mErrorString = tr( "%1" ).arg( QMetaEnum::fromType<QSerialPort::SerialPortError>().valueToKey( error ) );
+      break;
+  }
+
+  emit errorOccurred( mErrorString );
+}
+
 bool QgsSerialPortSensor::writePropertiesToElement( QDomElement &element, QDomDocument & ) const
 {
   element.setAttribute( QStringLiteral( "portName" ), mPortName );
diff --git a/src/core/sensor/qgsiodevicesensor.h b/src/core/sensor/qgsiodevicesensor.h
@@ -135,7 +135,8 @@ class CORE_EXPORT QgsTcpSocketSensor : public QgsIODeviceSensor
 
   private slots:
 
-    virtual void socketStateChanged( const QAbstractSocket::SocketState socketState );
+    void socketStateChanged( const QAbstractSocket::SocketState socketState );
+    void handleError( QAbstractSocket::SocketError error );
 
   private:
 
@@ -205,7 +206,8 @@ class CORE_EXPORT QgsUdpSocketSensor : public QgsIODeviceSensor
 
   private slots:
 
-    virtual void socketStateChanged( const QAbstractSocket::SocketState socketState );
+    void socketStateChanged( const QAbstractSocket::SocketState socketState );
+    void handleError( QAbstractSocket::SocketError error );
 
   private:
 
@@ -266,6 +268,10 @@ class CORE_EXPORT QgsSerialPortSensor : public QgsIODeviceSensor
     void handleConnect() override;
     void handleDisconnect() override;
 
+  private slots:
+
+    void handleError( QSerialPort::SerialPortError error );
+
   private:
 
     QSerialPort *mSerialPort = nullptr;
diff --git a/src/core/sensor/qgssensormanager.cpp b/src/core/sensor/qgssensormanager.cpp
@@ -88,6 +88,7 @@ void QgsSensorManager::addSensor( QgsAbstractSensor *sensor )
   connect( sensor, &QgsAbstractSensor::nameChanged, this, &QgsSensorManager::handleSensorNameChanged );
   connect( sensor, &QgsAbstractSensor::statusChanged, this, &QgsSensorManager::handleSensorStatusChanged );
   connect( sensor, &QgsAbstractSensor::dataChanged, this, &QgsSensorManager::captureSensorData );
+  connect( sensor, &QgsAbstractSensor::errorOccurred, this, &QgsSensorManager::handleSensorErrorOccurred );
   mSensors << sensor;
 
   emit sensorAdded( sensor->id() );
@@ -147,6 +148,15 @@ void QgsSensorManager::captureSensorData()
   emit sensorDataCaptured( sensor->id() );
 }
 
+void QgsSensorManager::handleSensorErrorOccurred( const QString & )
+{
+  const QgsAbstractSensor *sensor = qobject_cast<QgsAbstractSensor *>( sender() );
+  if ( !sensor )
+    return;
+
+  emit sensorErrorOccurred( sensor->id() );
+}
+
 bool QgsSensorManager::readXml( const QDomElement &element, const QDomDocument &document )
 {
   clear();
diff --git a/src/core/sensor/qgssensormanager.h b/src/core/sensor/qgssensormanager.h
@@ -131,11 +131,15 @@ class CORE_EXPORT QgsSensorManager : public QObject
     //! Emitted when newly captured data from a sensor has occurred.
     void sensorDataCaptured( const QString &id );
 
+    //! Emitted when a sensor error has occurred.
+    void sensorErrorOccurred( const QString &id );
+
   private slots:
 
     void handleSensorNameChanged();
     void handleSensorStatusChanged();
     void captureSensorData();
+    void handleSensorErrorOccurred( const QString &errorMessage );
 
   private:
 

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,11 @@ void QgsAbstractSensor::setData( const QgsAbstractSensor::SensorData &data )`
`63`	`63`	`emit dataChanged();`
`64`	`64`	`}`
`65`	`65`
	`66`	`+QString QgsAbstractSensor::errorString() const`
	`67`	`+{`
	`68`	`+ return mErrorString;`
	`69`	`+}`
	`70`	`+`
`66`	`71`	`void QgsAbstractSensor::connectSensor()`
`67`	`72`	`{`
`68`	`73`	`setStatus( Qgis::DeviceConnectionStatus::Connecting );`