Class: QgsSensorManager

Manages sensors.

QgsSensorManager handles the storage, serializing and deserializing of sensors. Usually this class is not constructed directly, but rather accessed through a QgsProject via QgsProject.sensorManager().

Added in version 3.32.

Class Hierarchy

Inheritance diagram of qgis.core.QgsSensorManager

Base classes

QObject

Methods

addSensor

Registers a new sensor.

clear

Deregisters and removes all sensors from the manager.

readXml

Reads the manager's state from a DOM element, restoring all sensors present in the XML document.

removeSensor

Removes a registered sensor matching a given id.

sensor

Returns a registered sensor pointer matching a given id.

sensorData

Returns the last captured data from a registered sensor matching a given name.

sensorNames

Returns a list of registered sensor names.

sensors

Returns a list of pointers to all registered sensors.

sensorsData

Returns the last captured data of all registered sensors.

writeXml

Returns a DOM element representing the state of the manager.

Signals

sensorAboutToBeRemoved

Emitted when a sensor is about to be removed.

sensorAdded

Emitted when a sensor has been registered.

sensorDataCaptured

Emitted when newly captured data from a sensor has occurred.

sensorErrorOccurred

Emitted when a sensor error has occurred.

sensorNameChanged

Emitted when a sensor name has changed.

sensorRemoved

Emitted when a sensor has been removed.

sensorStatusChanged

Emitted when a sensor status has changed.

class qgis.core.QgsSensorManager[source]

Bases: QObject

__init__(parent: QObject | None = None)

Constructor for QgsSensorManager, with the specified parent object.

Parameters:

parent (Optional[QObject] = None)

addSensor(self, sensor: QgsAbstractSensor | None)[source]

Registers a new sensor. The sensor name does not require uniqueness; sensors will the same name will store their data in the same sensor name key, allowing for registration of sensors to cover multiple devices (e.g. two serial port sensors with alternative port name to cover two machines).

Note

Takes ownership of the sensor.

Parameters:

sensor (Optional[QgsAbstractSensor])

clear(self)[source]

Deregisters and removes all sensors from the manager.

readXml(self, element: QDomElement, document: QDomDocument) bool[source]

Reads the manager’s state from a DOM element, restoring all sensors present in the XML document.

See also

writeXml()

Parameters:
  • element (QDomElement)

  • document (QDomDocument)

Return type:

bool

removeSensor(self, id: str | None) bool[source]

Removes a registered sensor matching a given id.

Return type:

bool

Returns:

True if a sensor was removed.

Parameters:

id (Optional[str])

sensor(self, id: str | None) QgsAbstractSensor | None[source]

Returns a registered sensor pointer matching a given id. If not matching sensor is found, a None will be returned.

Parameters:

id (Optional[str])

Return type:

Optional[QgsAbstractSensor]

signal sensorAboutToBeRemoved(id: str)[source]

Emitted when a sensor is about to be removed.

Parameters:

id (str)

signal sensorAdded(id: str)[source]

Emitted when a sensor has been registered.

Parameters:

id (str)

sensorData(self, name: str | None) QgsAbstractSensor.SensorData[source]

Returns the last captured data from a registered sensor matching a given name.

Parameters:

name (Optional[str])

Return type:

QgsAbstractSensor.SensorData

signal sensorDataCaptured(id: str)[source]

Emitted when newly captured data from a sensor has occurred.

Parameters:

id (str)

signal sensorErrorOccurred(id: str)[source]

Emitted when a sensor error has occurred.

Parameters:

id (str)

signal sensorNameChanged(id: str)[source]

Emitted when a sensor name has changed.

Parameters:

id (str)

sensorNames(self) List[str][source]

Returns a list of registered sensor names.

Return type:

List[str]

signal sensorRemoved(id: str)[source]

Emitted when a sensor has been removed.

Parameters:

id (str)

signal sensorStatusChanged(id: str)[source]

Emitted when a sensor status has changed.

Parameters:

id (str)

sensors(self) List[QgsAbstractSensor]

Returns a list of pointers to all registered sensors.

Return type:

List[QgsAbstractSensor]

sensorsData(self) Dict[str, QgsAbstractSensor.SensorData]

Returns the last captured data of all registered sensors.

Return type:

Dict[str, QgsAbstractSensor.SensorData]

writeXml(self, document: QDomDocument) QDomElement[source]

Returns a DOM element representing the state of the manager.

See also

readXml()

Parameters:

document (QDomDocument)

Return type:

QDomElement