简单CoAP客户端

创建一个与CoAP服务器通信的应用程序。

简单CoAP客户端演示了如何创建一个极简的CoAP客户端应用程序来发送和接收CoAP消息。

运行示例

要从Qt Creator运行示例，请打开欢迎模式并选择示例中的示例。更多信息，请访问构建和运行示例。

设置CoAP服务器

要使用该应用程序，您需要指定一个CoAP服务器。您有以下选项

使用位于coap://coap.me的CoAP测试服务器。
使用libcoap、FreeCoAP或其他CoAP服务器实现来创建一个CoAP服务器。
使用支持大多数CoAP功能的Californium plugtest服务器。您可以手动构建它或使用准备好Docker镜像，该镜像是构建并启动plugtest服务器。以下是如何使用基于Docker的服务器的步骤。

使用基于Docker的测试服务器

以下命令从Docker Hub提取CoAP服务器的docker容器并将其启动

docker run --name coap-test-server -d --rm -p 5683:5683/udp -p 5684:5684/udp tqtc/coap-californium-test-server:3.8.0

为了找到docker容器的IP地址，首先通过运行docker ps获取容器ID，这将输出类似以下内容

$ docker ps
CONTAINER ID        IMAGE
5e46502df88f        tqtc/coap-californium-test-server:3.8.0

然后您可以使用以下命令获取IP地址

docker inspect <container_id> | grep IPAddress

例如

$ docker inspect 5e46502df88f | grep IPAddress
...
"IPAddress": "172.17.0.2",
...

CoAP测试服务器将通过检索到的IP地址在端口5683（非安全）和5684（安全）上进行访问。

在使用后终止docker容器，请使用以下命令

docker stop <container_id>

这里的<container_id>与通过docker ps命令获取的相同。

创建客户端

第一步是使用QCoapClient类创建CoAP客户端。然后我们需要连接其信号，以便在收到CoAP回复或请求失败时获得通知

MainWindow::MainWindow(QWidget *parent) :
    QMainWindow(parent),
    ui(new Ui::MainWindow)
{
    m_client = new QCoapClient(QtCoap::SecurityMode::NoSecurity, this);
    connect(m_client, &QCoapClient::finished, this, &MainWindow::onFinished);
    connect(m_client, &QCoapClient::error, this, &MainWindow::onError);
    ...

发送请求

我们使用QCoapRequest类创建CoAP请求。此类提供用于构造CoAP帧的方法。

void MainWindow::on_runButton_clicked()
{
    const auto msgType = ui->msgTypeCheckBox->isChecked() ? QCoapMessage::Type::Confirmable
                                                          : QCoapMessage::Type::NonConfirmable;
    QUrl url;
    url.setHost(tryToResolveHostName(ui->hostComboBox->currentText()));
    url.setPort(ui->portSpinBox->value());
    url.setPath(ui->resourceComboBox->currentText());

    QCoapRequest request(url, msgType);
    for (const auto &option : std::as_const(m_options))
        request.addOption(option);
    ...

在此示例中，我们设置了URL以及消息类型，并向请求中添加了选项。还可能设置有效负载、消息ID、令牌等，但在此处我们使用默认值。请注意，默认情况下，消息ID和令牌是随机生成的。

根据所选请求方法，我们将向服务器发送一个 GET、PUT、POST 或 DELETE 请求

    ...
    switch (method) {
    case QtCoap::Method::Get:
        m_client->get(request);
        break;
    case QtCoap::Method::Put:
        m_client->put(request, m_currentData);
        break;
    case QtCoap::Method::Post:
        m_client->post(request, m_currentData);
        break;
    case QtCoap::Method::Delete:
        m_client->deleteResource(request);
        break;
    default:
        break;
    }
    ...

对于 PUT 和 POST 请求，我们还将 m_currentData 添加为请求的有效负载。

为了浏览服务器的内容并发现其上的资源，我们使用一个发现请求

void MainWindow::on_discoverButton_clicked()
{
    ...
    QCoapResourceDiscoveryReply *discoverReply =
            m_client->discover(url, ui->discoveryPathEdit->text());
    if (discoverReply) {
        connect(discoverReply, &QCoapResourceDiscoveryReply::discovered,
                this, &MainWindow::onDiscovered);
    ...

注意：我们不使用QCoapReply类，而是使用QCoapResourceDiscoveryReply来存储发现请求的响应。它具有QCoapResourceDiscoveryReply::discovered信号，该信号返回已发现的所有QCoapResources的列表。

如果服务器上有可观察的资源（意味着它们具有资源类型obs），我们可以通过运行一个观察请求来订阅该资源的更新

void MainWindow::on_observeButton_clicked()
{
    ...
    QCoapReply *observeReply = m_client->observe(url);
    ...
    connect(observeReply, &QCoapReply::notified, this, &MainWindow::onNotified);
    ...

客户端可以通过处理cancelObserveButton的clicked()信号来取消对资源的观察

    ...
    connect(ui->cancelObserveButton, &QPushButton::clicked, this, [this, url]() {
        m_client->cancelObserve(url);
        ui->cancelObserveButton->setEnabled(false);
    });

来自服务器的响应将在UI中显示

void MainWindow::addMessage(const QString &message, bool isError)
{
    const QString content = "--------------- %1 ---------------\n%2\n\n"_L1
                                .arg(QDateTime::currentDateTime().toString(), message);
    ui->textEdit->setTextColor(isError ? Qt::red : Qt::black);
    ui->textEdit->insertPlainText(content);
    ui->textEdit->ensureCursorVisible();
}

void MainWindow::onFinished(QCoapReply *reply)
{
    if (reply->errorReceived() == QtCoap::Error::Ok)
        addMessage(reply->message().payload());
}

static QString errorMessage(QtCoap::Error errorCode)
{
    const auto error = QMetaEnum::fromType<QtCoap::Error>().valueToKey(static_cast<int>(errorCode));
    return MainWindow::tr("Request failed with error: %1\n").arg(error);
}

void MainWindow::onError(QCoapReply *reply, QtCoap::Error error)
{
    const auto errorCode = reply ? reply->errorReceived() : error;
    addMessage(errorMessage(errorCode), true);
}

void MainWindow::onDiscovered(QCoapResourceDiscoveryReply *reply, QList<QCoapResource> resources)
{
    if (reply->errorReceived() != QtCoap::Error::Ok)
        return;

    QString message;
    for (const auto &resource : std::as_const(resources)) {
        ui->resourceComboBox->addItem(resource.path());
        message += tr("Discovered resource: \"%1\" on path %2\n")
                        .arg(resource.title(), resource.path());
    }
    addMessage(message);
}

void MainWindow::onNotified(QCoapReply *reply, const QCoapMessage &message)
{
    if (reply->errorReceived() == QtCoap::Error::Ok) {
        addMessage(tr("Received observe notification with payload: %1")
                        .arg(QString::fromUtf8(message.payload())));
    }
}

static QString tryToResolveHostName(const QString hostName)
{
    const auto hostInfo = QHostInfo::fromName(hostName);
    if (!hostInfo.addresses().empty())
        return hostInfo.addresses().first().toString();

    return hostName;
}

文件