pokitdiscoveryagent.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2022-2023 Paul Colby <git@colby.id.au>
// SPDX-License-Identifier: LGPL-3.0-or-later
 
/*!
 * \file
 * Defines the PokitDiscoveryAgent and PokitDiscoveryAgentPrivate classes.
 */
 
#include <qtpokit/pokitdiscoveryagent.h>
#include <qtpokit/pokitproducts.h>
#include "pokitdiscoveryagent_p.h"
 
#include <qtpokit/statusservice.h>
 
#include <QBluetoothUuid>
 
/*!
 * \class PokitDiscoveryAgent
 *
 * The PokitDiscoveryAgent class discovers nearby Pokit devices.
 *
 * After constructing a PokitDiscoveryAgent object, and subscribing to the relevant signals,
 * invoke start() to begin discovery.
 */
 
/*!
 * Constructs a new Pokit device discovery agent with \a parent, using \a deviceAdapter for the
 * search device.
 */
PokitDiscoveryAgent::PokitDiscoveryAgent(
    const QBluetoothAddress &deviceAdapter, QObject *parent)
    : QBluetoothDeviceDiscoveryAgent(deviceAdapter, parent),
      d_ptr(new PokitDiscoveryAgentPrivate(this))
{
 
}
 
/*!
 * Constructs a new Pokit device discovery agent with \a parent.
 */
PokitDiscoveryAgent::PokitDiscoveryAgent(QObject * parent)
    : QBluetoothDeviceDiscoveryAgent(parent),
      d_ptr(new PokitDiscoveryAgentPrivate(this))
{
 
}
 
/*!
 * \cond internal
 * Constructs a new Pokit device discovery agent with \a parent, using \a deviceAdapter for the
 * search device, and private implementation \a d.
 */
PokitDiscoveryAgent::PokitDiscoveryAgent(
    PokitDiscoveryAgentPrivate * const d, const QBluetoothAddress &deviceAdapter,
    QObject * const parent)
    : QBluetoothDeviceDiscoveryAgent(deviceAdapter, parent), d_ptr(d)
{
 
}
 
/*!
 * Constructs a new Pokit device discovery agent with \a parent, and private implementation \a d.
 */
PokitDiscoveryAgent::PokitDiscoveryAgent(
    PokitDiscoveryAgentPrivate * const d, QObject * const parent)
    : QBluetoothDeviceDiscoveryAgent(parent), d_ptr(d)
{
 
}
/// \endcond
 
/*!
 * Destroys this PokitDiscoveryAgent object.
 */
PokitDiscoveryAgent::~PokitDiscoveryAgent()
{
    delete d_ptr;
}
 
/*!
 * Starts Pokit device discovery.
 *
 * This override simply enforces that \a method must be \c LowEnergyMethod, as all Pokit devices
 * used Bluetooth Low Energy (BLE).
 */
void PokitDiscoveryAgent::start(QBluetoothDeviceDiscoveryAgent::DiscoveryMethods methods)
{
    Q_D(PokitDiscoveryAgent);
    Q_ASSERT(methods == QBluetoothDeviceDiscoveryAgent::LowEnergyMethod);
    qCDebug(d->lc).noquote() << tr("Scanning for Bluetooth Low Energy devices.");
    QBluetoothDeviceDiscoveryAgent::start(QBluetoothDeviceDiscoveryAgent::LowEnergyMethod);
}
 
/*!
 * Starts Pokit device discovery.
 */
void PokitDiscoveryAgent::start()
{
    Q_D(PokitDiscoveryAgent);
    qCDebug(d->lc).noquote() << tr("Scanning for Bluetooth Low Energy devices.");
    QBluetoothDeviceDiscoveryAgent::start(QBluetoothDeviceDiscoveryAgent::LowEnergyMethod);
}
 
/*!
 * \fn void PokitDiscoveryAgent::pokitDeviceDiscovered(const QBluetoothDeviceInfo &info)
 *
 * This signal is emitted when the Pokit device described by \a info is discovered.
 */
 
/*!
 * \fn void PokitDiscoveryAgent::pokitDeviceUpdated(const QBluetoothDeviceInfo &info, QBluetoothDeviceInfo::Fields updatedFields)
 *
 * This signal is emitted when the Pokit device described by \a info is updated. The
 * \a updatedFields flags tell which information has been updated.
 */
 
/*!
 * \cond internal
 * \class PokitDiscoveryAgentPrivate
 *
 * The PokitDiscoveryAgentPrivate class provides private implementation for
 * PokitDiscoveryAgent.
 */
 
/*!
 * \internal
 * Constructs a new PokitDiscoveryAgentPrivate object with public implementation \a q.
 */
PokitDiscoveryAgentPrivate::PokitDiscoveryAgentPrivate(PokitDiscoveryAgent * const q)
    : q_ptr(q)
{
    connect(q, &QBluetoothDeviceDiscoveryAgent::canceled,
            this, &PokitDiscoveryAgentPrivate::canceled);
 
    connect(q, &QBluetoothDeviceDiscoveryAgent::deviceDiscovered,
            this, &PokitDiscoveryAgentPrivate::deviceDiscovered);
 
    #if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)) // Signal added in Qt 5.12.
    connect(q, &QBluetoothDeviceDiscoveryAgent::deviceUpdated,
            this, &PokitDiscoveryAgentPrivate::deviceUpdated);
    #endif
 
    connect(q,
        #if (QT_VERSION < QT_VERSION_CHECK(6, 2, 0))
            QOverload<PokitDiscoveryAgent::Error>::of(&PokitDiscoveryAgent::error),
        #else
            &QBluetoothDeviceDiscoveryAgent::errorOccurred,
        #endif
        this, &PokitDiscoveryAgentPrivate::error);
 
    connect(q, &QBluetoothDeviceDiscoveryAgent::finished,
            this, &PokitDiscoveryAgentPrivate::finished);
}
 
/*!
 * Handle scan canceled signals, by simply logging the event for diagnostic purposes.
 */
void PokitDiscoveryAgentPrivate::canceled() const
{
    qCDebug(lc).noquote() << tr("Pokit device scan cancelled.");
}
 
/*!
 * Handle deviceDiscovered signals.
 *
 * Here we simply check if \a info describes a Pokit device, and if so, emit pokitDeviceDiscovered().
 */
void PokitDiscoveryAgentPrivate::deviceDiscovered(const QBluetoothDeviceInfo &info)
{
    Q_Q(PokitDiscoveryAgent);
    if (!isPokitProduct(info)) return;
    qCDebug(lc).noquote() << tr(R"(Discovered Pokit device "%1" at %2.)")
        .arg(info.name(), info.address().toString());
    Q_EMIT q->pokitDeviceDiscovered(info);
}
 
#if (QT_VERSION >= QT_VERSION_CHECK(5, 12, 0)) // Required signal, and Fields, added in Qt 5.12.
/*!
 * Handle deviceUpdated signals.
 *
 * Here we simply check if \a info describes a Pokit device, and if so, emit pokitDeviceUpdated().
 *
 * \since Qt 5.12.0
 */
void PokitDiscoveryAgentPrivate::deviceUpdated(
    const QBluetoothDeviceInfo &info, QBluetoothDeviceInfo::Fields updatedFields)
{
    Q_Q(PokitDiscoveryAgent);
    if (!isPokitProduct(info)) return;
    qCDebug(lc).noquote() << tr(R"(Pokit device "%1" at %2 updated with RSSI %3.)")
        .arg(info.name(), info.address().toString()).arg(info.rssi());
    Q_EMIT q->pokitDeviceUpdated(info, updatedFields);
}
#endif
 
/*!
 * Handle scan errors, by simply logging \a error for diagnostic purposes.
 */
void PokitDiscoveryAgentPrivate::error(const QBluetoothDeviceDiscoveryAgent::Error error) const
{
    qCWarning(lc).noquote() << tr("Pokit device scan error:") << error;
}
 
/*!
 * Handle scan finished signals, by simply logging the event for diagnostic purposes.
 */
void PokitDiscoveryAgentPrivate::finished() const
{
    qCDebug(lc).noquote() << tr("Pokit device scan finished.");
}
 
/// \endcond