- Qt 6.4
- Qt Sensors
- Qt Sensors Examples
- Qt Sensors - Grue Sensor Example
- Qt 6.4.3 Reference Documentation

# Qt Sensors - Grue Sensor Example

The Qt Sensors - Grue sensor example demonstrates all the steps from creating a new sensor to using it.

The sensor definition and implementation are in a new sensor plugin that client apps can use for detecting Grues (imaginary monsters that live in the dark).

- Grue Sensor Plugin

The sensor plugin can be used by C++ applications as shown in the console application example.

- Grue Sensor Console Application

QML applications can use the new sensor by importing the QMLGrueSensor class.

- Grue Sensor QML Application

#### Grue Sensor Plugin

The Grue sensor is defined in a new sensor plugin that applications can use.

The plugin provides the sensor reading property that describes your chance of being eaten. This chance is increasing in the dark until it is 100% when you are eaten by the Grue and at that point the plugin stops further processing. In case of the plugin receiving light again before that happens the chance of being eaten resets to 0%.

This example was created using the make_sensor.pl script which can be found in src/sensors. As such, it contains some generated code that defines the convenience classes GrueFilter and GrueSensor.

#### Grue Sensor Implementation

The Grue sensor implementation lives in the plugin that is loaded by the Qt Sensors library. The source code is available in the `grue/plugin` subdirectory.

The Grue sensor needs a backend before it can be used. The backend provided is rather basic and it relies on some kind of light sensor to work but it gets the job done. If new hardware that can detect the actual presence of Grues becomes available a backend could be created that supports this hardware and applications using the Grue sensor would be able to use it without any changes.

There are a few mandatory parts to a backend. They are the start and stop methods and the setReading call. The start and stop methods are used to start and stop any underlying hardware. In the case of this backend they start and stop a light sensor. In the start method, the backend should call the `sensorStopped()` or `sensorBusy()` methods if it cannot start.

         lightSensor->setDataRate(sensor()->dataRate());
         lightSensor->start();
         // If the light sensor doesn't work we don't work either
         if (!lightSensor->isActive())
             sensorStopped();
         if (lightSensor->isBusy())
             sensorBusy();

The setReading method is needed so that the sensors library knows where the readings are coming from. This backend has a local copy of the reading so it passes a pointer to the function.

         // Register our reading instance
         setReading<GrueSensorReading>(&m_reading);

However it is also possible to pass null to the setReading method in which case the sensors library will create an instance and return a pointer.

     // Create a reading instance for us to use
     m_reading = setReading<GrueSensorReading>(0);

The Grue sensor backend also supplies some metadata.

The backend checks 2 things, how dark it is and how long you have been in the dark. It uses the `readingChanged()` signal to know when to check the light sensor's value. Once it is dark, it uses a timer to increase your chance of being eaten.

The Grue sensor backend is delivered as a plugin. The plugin has a factory object that registers the types available and does the actual instantiation of the backend.

#### Grue Sensor Console Application

The Grue sensor console application demonstrates use of the Grue sensor. The source code is available in the `grue/console_app` subdirectory.

This is a simple commandline application. It demonstrates how to use the generic access feature of Qt Sensors to avoid a link-time dependency on a library.

#### Grue Sensor C++ Class Registration for QML

The QMLGrueSensor class is registered for QML, so the class name can be used as an import and the class properties can be accessed from QML.

#### Grue Sensor QML Application

The Grue sensor QML application demonstrates the use of QMLGrueSensor QML type.

The application consists of a single QML file and an image. It is built as an executable with C++ code that runs the QML, but it can also be launched directly using the `qmlscene` tool.

     qmlscene -I . grue.qml

Example project @ code.qt.io