esp-matter/components/esp_matter_controller/esp_matter_controller_subscribe_command.cpp

// Copyright 2022 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <controller/CommissioneeDeviceProxy.h>
#include <esp_log.h>
#if CONFIG_ESP_MATTER_COMMISSIONER_ENABLE
#include <esp_matter_commissioner.h>
#else
#include <app/server/Server.h>
#endif
#include <esp_matter_controller_subscribe_command.h>

#include "DataModelLogger.h"

using namespace chip::app::Clusters;
using chip::DeviceProxy;
using chip::app::InteractionModelEngine;
using chip::app::ReadClient;
using chip::app::ReadPrepareParams;

static const char *TAG = "read_command";

static const uint8_t k_max_resubscribe_retries = 2;

namespace esp_matter {
namespace controller {

void subscribe_command::on_device_connected_fcn(void *context, ExchangeManager &exchangeMgr,
                                                const SessionHandle &sessionHandle)
{
    subscribe_command *cmd = (subscribe_command *)context;
    ReadPrepareParams params(sessionHandle);
    CHIP_ERROR err = CHIP_NO_ERROR;

    if (cmd->m_command_type == SUBSCRIBE_ATTRIBUTE) {
        params.mpEventPathParamsList = nullptr;
        params.mEventPathParamsListSize = 0;
        params.mpAttributePathParamsList = &cmd->m_attr_path;
        params.mAttributePathParamsListSize = 1;
    } else if (cmd->m_command_type == SUBSCRIBE_EVENT) {
        params.mpEventPathParamsList = &cmd->m_event_path;
        params.mEventPathParamsListSize = 1;
        params.mpAttributePathParamsList = nullptr;
        params.mAttributePathParamsListSize = 0;
    }
    params.mIsFabricFiltered = 0;
    params.mpDataVersionFilterList = nullptr;
    params.mDataVersionFilterListSize = 0;
    params.mMinIntervalFloorSeconds = cmd->m_min_interval;
    params.mMaxIntervalCeilingSeconds = cmd->m_max_interval;
    params.mKeepSubscriptions = true;

    ReadClient *client =
        chip::Platform::New<ReadClient>(InteractionModelEngine::GetInstance(), &exchangeMgr, cmd->m_buffered_read_cb,
                                        ReadClient::InteractionType::Subscribe);
    if (!client) {
        ESP_LOGE(TAG, "Failed to alloc memory for read client");
        chip::Platform::Delete(cmd);
    }
    if (cmd->m_auto_resubscribe) {
        err = client->SendAutoResubscribeRequest(std::move(params));
    } else {
        err = client->SendRequest(params);
    }
    if (err != CHIP_NO_ERROR) {
        ESP_LOGE(TAG, "Failed to send read request");
        chip::Platform::Delete(client);
        chip::Platform::Delete(cmd);
    }
    return;
}

void subscribe_command::on_device_connection_failure_fcn(void *context, const ScopedNodeId &peerId, CHIP_ERROR error)
{
    subscribe_command *cmd = (subscribe_command *)context;

    if (cmd->subscribe_failure_cb)
        cmd->subscribe_failure_cb((void *)cmd);

    chip::Platform::Delete(cmd);
    return;
}

esp_err_t subscribe_command::send_command()
{
#if CONFIG_ESP_MATTER_COMMISSIONER_ENABLE
    if (CHIP_NO_ERROR ==
        commissioner::get_device_commissioner()->GetConnectedDevice(m_node_id, &on_device_connected_cb,
                                                                    &on_device_connection_failure_cb)) {
        return ESP_OK;
    }
#else
    chip::Server *server = &(chip::Server::GetInstance());
    server->GetCASESessionManager()->FindOrEstablishSession(ScopedNodeId(m_node_id, get_fabric_index()),
                                                            &on_device_connected_cb, &on_device_connection_failure_cb);
    return ESP_OK;
#endif
    chip::Platform::Delete(this);
    return ESP_FAIL;
}

// ReadClient Callback Interface
void subscribe_command::OnAttributeData(const chip::app::ConcreteDataAttributePath &path, chip::TLV::TLVReader *data,
                                        const chip::app::StatusIB &status)
{
    CHIP_ERROR error = status.ToChipError();
    if (CHIP_NO_ERROR != error) {
        ESP_LOGE(TAG, "Response Failure: %s", chip::ErrorStr(error));
        return;
    }
    if (data == nullptr) {
        ESP_LOGE(TAG, "Response Failure: No Data");
        return;
    }

    chip::TLV::TLVReader log_data;
    log_data.Init(*data);
    error = DataModelLogger::LogAttribute(path, &log_data);
    if (CHIP_NO_ERROR != error) {
        ESP_LOGE(TAG, "Response Failure: Can not decode Data");
    }

    if (attribute_data_cb) {
        attribute_data_cb(m_node_id, path, data);
    }
}

void subscribe_command::OnEventData(const chip::app::EventHeader &event_header, chip::TLV::TLVReader *data,
                                    const chip::app::StatusIB *status)
{
    CHIP_ERROR error = CHIP_NO_ERROR;
    if (status != nullptr) {
        error = status->ToChipError();
        if (CHIP_NO_ERROR != error) {
            ESP_LOGE(TAG, "Response Failure: %s", chip::ErrorStr(error));
            return;
        }
    }
    if (data == nullptr) {
        ESP_LOGE(TAG, "Response Failure: No Data");
        return;
    }

    chip::TLV::TLVReader log_data;
    log_data.Init(*data);
    error = DataModelLogger::LogEvent(event_header, &log_data);
    if (CHIP_NO_ERROR != error) {
        ESP_LOGE(TAG, "Response Failure: Can not decode Data");
    }

    if (event_data_cb) {
        event_data_cb(m_node_id, event_header, data);
    }
}

void subscribe_command::OnError(CHIP_ERROR error)
{
    ESP_LOGE(TAG, "Subscribe Error: %s", chip::ErrorStr(error));
}

void subscribe_command::OnDeallocatePaths(chip::app::ReadPrepareParams &&aReadPrepareParams)
{
    // Intentionally empty because the AttributePathParamsList or EventPathParamsList will be deleted with the
    // subscribe_command.
}

void subscribe_command::OnSubscriptionEstablished(chip::SubscriptionId subscriptionId)
{
    m_subscription_id = subscriptionId;
    m_resubscribe_retries = 0;
    ESP_LOGI(TAG, "Subscription 0x%" PRIx32 " established", subscriptionId);
}

CHIP_ERROR subscribe_command::OnResubscriptionNeeded(ReadClient *apReadClient, CHIP_ERROR aTerminationCause)
{
    m_resubscribe_retries++;
    if (m_resubscribe_retries > k_max_resubscribe_retries) {
        ESP_LOGE(TAG, "Could not find the devices in %d retries, terminate the subscription", k_max_resubscribe_retries);
        return aTerminationCause;
    }
    return apReadClient->DefaultResubscribePolicy(aTerminationCause);
}

void subscribe_command::OnDone(ReadClient *apReadClient)
{
    ESP_LOGI(TAG, "Subscription 0x%" PRIx32 " Done for remote node 0x%" PRIx64, m_subscription_id, m_node_id);
    chip::Platform::Delete(apReadClient);
    if (subscribe_done_cb) {
        // This will be called when the subscription is terminated.
        subscribe_done_cb(m_node_id, m_subscription_id);
    }
    chip::Platform::Delete(this);
}

esp_err_t send_subscribe_attr_command(uint64_t node_id, uint16_t endpoint_id, uint32_t cluster_id,
                                      uint32_t attribute_id, uint16_t min_interval, uint16_t max_interval,
                                      bool auto_resubscribe)
{
    subscribe_command *cmd =
        chip::Platform::New<subscribe_command>(node_id, endpoint_id, cluster_id, attribute_id, SUBSCRIBE_ATTRIBUTE,
                                               min_interval, max_interval, auto_resubscribe);
    if (!cmd) {
        ESP_LOGE(TAG, "Failed to alloc memory for subscribe_command");
        return ESP_ERR_NO_MEM;
    }

    return cmd->send_command();
}

esp_err_t send_subscribe_event_command(uint64_t node_id, uint16_t endpoint_id, uint32_t cluster_id, uint32_t event_id,
                                       uint16_t min_interval, uint16_t max_interval, bool auto_resubscribe)
{
    subscribe_command *cmd = chip::Platform::New<subscribe_command>(
        node_id, endpoint_id, cluster_id, event_id, SUBSCRIBE_EVENT, min_interval, max_interval, auto_resubscribe);
    if (!cmd) {
        ESP_LOGE(TAG, "Failed to alloc memory for subscribe_command");
        return ESP_ERR_NO_MEM;
    }

    return cmd->send_command();
}

esp_err_t send_shutdown_subscription(uint64_t node_id, uint32_t subscription_id)
{
    if (CHIP_NO_ERROR !=
        InteractionModelEngine::GetInstance()->ShutdownSubscription(
#if CONFIG_ESP_MATTER_COMMISSIONER_ENABLE
            ScopedNodeId(node_id, commissioner::get_device_commissioner()->GetFabricIndex()), subscription_id)) {
#else
            ScopedNodeId(node_id, /* fabric index */ 1), subscription_id)) {
#endif
        ESP_LOGE(TAG, "Shutdown Subscription Failed");
        return ESP_FAIL;
    }
    return ESP_OK;
}

} // namespace controller
} // namespace esp_matter