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

Methods

addSensorType	Registers a new sensor type.
createSensor	Creates a new instance of a sensor given the type.
populate	Populates the registry with standard sensor types.
removeSensorType	Removes a new a sensor type from the registry.
sensorMetadata	Returns the metadata for the specified sensor type.
sensorTypes	Returns a map of available sensor types to translated name.

Signals

sensorAdded

Emitted whenever a new sensor type is added to the registry, with the specified type and visible name.

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(type: str, name: str)

Emitted whenever a new sensor type is added to the registry, with the specified type and visible name.

Parameters:

• type (str)

• name (str)

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]