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¶
Base classes¶
Methods
Registers a new sensor. |
|
Deregisters and removes all sensors from the manager. |
|
Reads the manager's state from a DOM element, restoring all sensors present in the XML document. |
|
Removes a registered sensor matching a given id. |
|
Returns a registered sensor pointer matching a given id. |
|
Returns the last captured data from a registered sensor matching a given name. |
|
Returns a list of registered sensor names. |
|
Returns a list of pointers to all registered sensors. |
|
Returns the last captured data of all registered sensors. |
|
Returns a DOM element representing the state of the manager. |
Signals
Emitted when a sensor is about to be removed. |
|
Emitted when a sensor has been registered. |
|
Emitted when newly captured data from a sensor has occurred. |
|
Emitted when a sensor error has occurred. |
|
Emitted when a sensor name has changed. |
|
Emitted when a sensor has been removed. |
|
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])
- 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
- 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, aNone
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:
- 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 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]