Class: QgsSensorRegistry

Registry of available sensor types.

QgsSensorRegistry is not usually directly created, but rather accessed through QgsApplication.sensorRegistry().

A companion class, QgsSensorGuiRegistry, handles the GUI behavior of sensors.

Added in version 3.32.

Class Hierarchy

Base classes

QObject

class qgis.core.QgsSensorRegistry

Bases: QObject

__init__(parent: QObject | None = None)

Creates a new empty item registry.

QgsSensorRegistry is not usually directly created, but rather accessed through QgsApplication.sensorRegistry().

See also

populate()

Parameters:

parent (Optional[QObject] = None)

addSensorType(self, metadata: QgsSensorAbstractMetadata | None) → bool

Registers a new sensor type.

Note

Takes ownership of the metadata instance.

Parameters:

metadata (Optional[QgsSensorAbstractMetadata])

Return type:

bool

createSensor(self, type: str | None, parent: QObject | None = None) → QgsAbstractSensor | None

Creates a new instance of a sensor given the type.

Parameters:

• type (Optional[str])

• parent (Optional[QObject] = None)

Return type:

Optional[QgsAbstractSensor]

populate(self) → bool

Populates the registry with standard sensor types. If called on a non-empty registry then this will have no effect and will return False.

Return type:

bool

removeSensorType(self, type: str | None) → bool

Removes a new a sensor type from the registry.

Parameters:

type (Optional[str])

Return type:

bool

signal sensorAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

sensorMetadata(self, type: str | None) → QgsSensorAbstractMetadata | None

Returns the metadata for the specified sensor type. Returns None if a corresponding type was not found in the registry.

Parameters:

type (Optional[str])

Return type:

Optional[QgsSensorAbstractMetadata]

sensorTypes(self) → Dict[str, str]

Returns a map of available sensor types to translated name.

Return type:

Dict[str, str]