dataloggerservice.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2022-2025 Paul Colby <git@colby.id.au>
// SPDX-License-Identifier: LGPL-3.0-or-later
 
/*!
 * \file
 * Declares the DataLoggerService class.
 */
 
#ifndef QTPOKIT_DATALOGGERSERVICE_H
#define QTPOKIT_DATALOGGERSERVICE_H
 
#include "abstractpokitservice.h"
 
#include <QBluetoothAddress>
#include <QBluetoothUuid>
#include <QVersionNumber>
 
QTPOKIT_BEGIN_NAMESPACE
 
class DataLoggerServicePrivate;
 
class QTPOKIT_EXPORT DataLoggerService : public AbstractPokitService
{
    Q_OBJECT
 
public:
    /// UUID of the "DataLogger" service.
    static inline const QBluetoothUuid serviceUuid { QStringLiteral("a5ff3566-1fd8-4e10-8362-590a578a4121") };
 
    /// Characteristics available via the `DataLogger` service.
    struct QTPOKIT_EXPORT CharacteristicUuids {
        /// UUID of the `DataLogger` service's `Settings` characterstic.
        static inline const QBluetoothUuid settings { QStringLiteral("5f97c62b-a83b-46c6-b9cd-cac59e130a78") };
 
        /// UUID of the `DataLogger` service's `Metadata` characterstic.
        static inline const QBluetoothUuid metadata { QStringLiteral("9acada2e-3936-430b-a8f7-da407d97ca6e") };
 
        /// UUID of the `DataLogger` service's `Reading` characterstic.
        static inline const QBluetoothUuid reading  { QStringLiteral("3c669dab-fc86-411c-9498-4f9415049cc0") };
    };
 
    /// Values supported by the `Command` attribute of the `Settings` characteristic.
    enum class Command : quint8 {
        Start   = 0, ///< Start the Data Logger.
        Stop    = 1, ///< Stop the Data Logger.
        Refresh = 2, ///< Refresh the Data Logger.
    };
 
    /// Values supported by the `Mode` attribute of the `Settings` and `Metadata` characteristics.
    enum class Mode : quint8 {
        Idle        = 0, ///< Make device idle.
        DcVoltage   = 1, ///< Measure DC voltage.
        AcVoltage   = 2, ///< Measure AC voltage.
        DcCurrent   = 3, ///< Measure DC current.
        AcCurrent   = 4, ///< Measure AC current.
        Temperature = 5, ///< Measure temperature.
    };
    static QString toString(const Mode &mode);
 
    static QString toString(const PokitProduct product, const quint8 range, const Mode mode);
    QString toString(const quint8 range, const Mode mode) const;
    static quint32 maxValue(const PokitProduct product, const quint8 range, const Mode mode);
    quint32 maxValue(const quint8 range, const Mode mode) const;
 
    /// Attributes included in the `Settings` characterstic.
    struct Settings {
        Command command;        ///< Custom operation request.
        quint16 arguments;      ///< Reserved to used along with #command in future.
        Mode mode;              ///< Desired operation mode.
        quint8 range;           ///< Desired range.
        quint32 updateInterval; ///< Desired update interval in milliseconds.
        quint32 timestamp;      ///< Custom timestamp for start time in retrieved metadata.
    };
 
    /// Values supported by the `Status` attribute of the `Metadata` characteristic.
    enum class LoggerStatus : quint8 {
        Done       = 0,   ///< Sampling has completed.
        Sampling   = 1,   ///< Actively sampling.
        BufferFull = 2,   ///< Buffer is full.
        Error      = 255  ///< An error has occurred.
    };
 
    /// Attributes included in the `Metadata` characterstic.
    struct Metadata {
        LoggerStatus status;     ///< Current data logger status.
        float scale;             ///< Scale to apply to read samples.
        Mode mode;               ///< Current operation mode.
        quint8 range;            ///< Current range.
        quint32 updateInterval;  ///< Current logging interval in milliseconds.
        quint16 numberOfSamples; ///< Number of samples acquired (1 to 6192).
        quint32 timestamp;       ///< Timestamp stored at the beginning of the logging session.
    };
 
    typedef QVector<qint16> Samples;
 
    DataLoggerService(QLowEnergyController * const pokitDevice, QObject * parent = nullptr);
    ~DataLoggerService() = default;
 
    bool readCharacteristics() override;
    bool readMetadataCharacteristic();
 
    // Settings characteristic (BLE write only).
    bool setSettings(const Settings &settings);
    bool startLogger(const Settings &settings);
    bool stopLogger();
    bool fetchSamples();
 
    // Metadata characteristic (BLE read/notify).
    Metadata metadata() const;
    bool enableMetadataNotifications();
    bool disableMetadataNotifications();
 
    // Reading characteristic (BLE notify only).
    bool enableReadingNotifications();
    bool disableReadingNotifications();
 
Q_SIGNALS:
    void settingsWritten();
    void metadataRead(const DataLoggerService::Metadata &meta);
    void samplesRead(const DataLoggerService::Samples &samples);
 
protected:
    /// \cond internal
    DataLoggerService(DataLoggerServicePrivate * const d, QObject * const parent);
    /// \endcond
 
private:
    Q_DECLARE_PRIVATE(DataLoggerService)
    Q_DISABLE_COPY(DataLoggerService)
    QTPOKIT_BEFRIEND_TEST(DataLoggerService)
};
 
QTPOKIT_END_NAMESPACE
 
#endif // QTPOKIT_DATALOGGERSERVICE_H