esp-matter/components/esp_matter_rainmaker/esp_matter_rainmaker.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 <esp_log.h>
#include <string.h>

#include <esp_matter.h>
#include <esp_matter_console.h>
#include <esp_matter_rainmaker.h>
#include <esp_rmaker_core.h>
#include <esp_rmaker_user_mapping.h>

#define ESP_MATTER_RAINMAKER_COMMAND_LIMIT 5 /* This command can be called 5 times per reboot */
#define ESP_MATTER_RAINMAKER_MAX_DATA_LEN 40

static const char *TAG = "esp_matter_rainmaker";

namespace esp_matter {

namespace cluster {
namespace rainmaker {
static constexpr chip::EndpointId endpoint_id = 0x00000000; /* Same as root node endpoint. This will always be
                                                            endpoint_id 0. */
static constexpr chip::ClusterId Id = 0x131B0000; /* 0x131B == manufacturer code */

namespace attribute {
namespace status {
static constexpr chip::AttributeId Id = 0x00000000;
} /* status */
namespace node_id {
static constexpr chip::AttributeId Id = 0x00000001;
} /* node_id */
} /* attribute */

namespace command {
namespace configuration {
static constexpr chip::CommandId Id = 0x00000000;
} /* configuration */
} /* command */

} /* rainmaker */
} /* cluster */

namespace rainmaker {

static esp_err_t console_handler(int argc, char **argv)
{
    if (argc == 3 && strncmp(argv[0], "add-user", sizeof("add-user")) == 0) {
        printf("%s: Starting user-node mapping\n", TAG);
        if (esp_rmaker_start_user_node_mapping(argv[1], argv[2]) != ESP_OK) {
            return ESP_FAIL;
        }
    } else {
        printf("%s: Invalid Usage.\n", TAG);
        return ESP_ERR_INVALID_ARG;
    }
    return ESP_OK;
}

static void register_commands()
{
    esp_matter_console_command_t command = {
        .name = "rainmaker",
        .description = "Initiate ESP RainMaker User-Node mapping from the node. "
                       "Usage: matter esp rainmaker add-user <user_id> <secret_key>",
        .handler = console_handler,
    };
    esp_matter_console_add_command(&command);
}

static esp_err_t status_attribute_update(bool status)
{
    int endpoint_id = cluster::rainmaker::endpoint_id;
    int cluster_id = cluster::rainmaker::Id;
    int attribute_id = cluster::rainmaker::attribute::status::Id;
    esp_matter_attr_val_t val = esp_matter_bool(status);
    return attribute::update(endpoint_id, cluster_id, attribute_id, &val);
}

static esp_err_t node_id_attribute_update(char *node_id)
{
    int endpoint_id = cluster::rainmaker::endpoint_id;
    int cluster_id = cluster::rainmaker::Id;
    int attribute_id = cluster::rainmaker::attribute::node_id::Id;
    esp_matter_attr_val_t val = esp_matter_char_str(node_id, strlen(node_id));
    return attribute::update(endpoint_id, cluster_id, attribute_id, &val);
}

static void user_node_association_event_handler(void *arg, esp_event_base_t event_base, int32_t event_id,
                                                void *event_data)
{
    /* This event handler is only for user node association status */
    if (event_base == RMAKER_EVENT) {
        if (event_id == RMAKER_EVENT_USER_NODE_MAPPING_DONE) {
            ESP_LOGI(TAG, "User node association complete. Updating the status attribute.");
            status_attribute_update(true);
        } else if (event_id == RMAKER_EVENT_USER_NODE_MAPPING_RESET) {
            ESP_LOGI(TAG, "User node association reset. Updating the status attribute.");
            status_attribute_update(false);
        }
    }
}

static esp_err_t command_callback(const ConcreteCommandPath &command_path, TLVReader &tlv_data, void *opaque_ptr)
{
    /* Get ids */
    int endpoint_id = command_path.mEndpointId;
    int cluster_id = command_path.mClusterId;
    int command_id = command_path.mCommandId;

    /* Return if this is not the rainmaker configuration command */
    if (endpoint_id != cluster::rainmaker::endpoint_id || cluster_id != cluster::rainmaker::Id ||
        command_id != cluster::rainmaker::command::configuration::Id) {
        ESP_LOGE(TAG, "Got rainmaker command callback for some other command. This should not happen.");
        return ESP_FAIL;
    }
    ESP_LOGI(TAG, "RainMaker configuration command callback");
    static int command_count = ESP_MATTER_RAINMAKER_COMMAND_LIMIT;
    if (command_count <= 0) {
        ESP_LOGE(TAG, "This command has reached a limit. Please reboot to try again.");
        return ESP_FAIL;
    }
    command_count--;

    /* Parse the tlv data */
    chip::CharSpan config_value;
    chip::app::DataModel::Decode(tlv_data, config_value);
    const char *data = config_value.data();
    int size = config_value.size();
    if (!data || size <= 0) {
        ESP_LOGE(TAG, "Command data not found or was not decoded correctly. The expected data is a string or the"
                 "format is \"<user_id>::<secret_key>\"");
        return ESP_FAIL;
    }

    /* The expected format of the data is "<user_id>::<secret_key>" */
    char ch = ':';
    char *check = strchr(data, (int)ch);
    if (check == NULL) {
        ESP_LOGE(TAG, "':' not found in the received data: %.*s. The expected format is \"<user_id>::<secret_key>\"",
                 size, data);
        return ESP_FAIL;
    }

    /* Get sizes */
    int user_id_index = 0;
    int user_id_len = (int)(strchr(data, (int)ch) - data); /* (first ':') - (start of string) */
    int secret_key_index = (int)(strrchr(data, (int)ch) - data) + 1; /* (last ':') - (start of string) + 1 */
    int secret_key_len = size - secret_key_index;
    if (user_id_len <= 0 || user_id_len >= ESP_MATTER_RAINMAKER_MAX_DATA_LEN || secret_key_len <= 0 ||
        secret_key_len >= ESP_MATTER_RAINMAKER_MAX_DATA_LEN) {
        ESP_LOGE(TAG, "User id or secret key length invalid: user_id_len: %d, secret_key_len: %d", user_id_len,
                 secret_key_len);
        return ESP_FAIL;
    }

    /* Copy the data. This done to make the strings NULL terminated. */
    char user_id[ESP_MATTER_RAINMAKER_MAX_DATA_LEN] = {0};
    char secret_key[ESP_MATTER_RAINMAKER_MAX_DATA_LEN] = {0};
    strncpy(user_id, &data[user_id_index], user_id_len);
    strncpy(secret_key, &data[secret_key_index], secret_key_len);
    ESP_LOGI(TAG, "user_id: %s, secret_key: %s", user_id, secret_key);

    /* Call the rainmaker API */
    if (strlen(user_id) > 0 && strlen(secret_key) > 0) {
        esp_rmaker_start_user_node_mapping(user_id, secret_key);
    }
    return ESP_OK;
}

static esp_err_t custom_cluster_create()
{
    /* Get the endpoint */
    node_t *node = node::get();
    endpoint_t *endpoint = endpoint::get(node, cluster::rainmaker::endpoint_id);

    /* Create custom rainmaker cluster */
    cluster_t *cluster = esp_matter::cluster::create(endpoint, cluster::rainmaker::Id, CLUSTER_FLAG_SERVER);
    attribute::create(cluster, Globals::Attributes::ClusterRevision::Id, ATTRIBUTE_FLAG_NONE,
                      esp_matter_uint16(1));

    /* Create custom status attribute */
    /* Update the value of the attribute after esp_rmaker_node_init() is done */
    attribute::create(cluster, cluster::rainmaker::attribute::status::Id, ATTRIBUTE_FLAG_NONE,
                      esp_matter_bool(false));

    /* Create custom node_id attribute */
    /* Update the value of the attribute after esp_rmaker_node_init() is done */
    char node_id[32] = {0};
    attribute::create(cluster, cluster::rainmaker::attribute::node_id::Id, ATTRIBUTE_FLAG_NONE,
                      esp_matter_char_str(node_id, sizeof(node_id)));

    /* Create custom configuration command */
    command::create(cluster, cluster::rainmaker::command::configuration::Id,
                    COMMAND_FLAG_CLIENT_GENERATED | COMMAND_FLAG_CUSTOM, command_callback);
    return ESP_OK;
}

esp_err_t init()
{
    /* Add custom rainmaker cluster */
    register_commands();
    return custom_cluster_create();
}

esp_err_t start()
{
    /* Check user node association */
    if (esp_rmaker_user_node_mapping_get_state() == ESP_RMAKER_USER_MAPPING_DONE) {
        status_attribute_update(true);
    }

    /* Register an event handler and update the state later */
    esp_event_handler_register(RMAKER_EVENT, RMAKER_EVENT_USER_NODE_MAPPING_DONE, &user_node_association_event_handler,
                               NULL);
    esp_event_handler_register(RMAKER_EVENT, RMAKER_EVENT_USER_NODE_MAPPING_RESET,
                                &user_node_association_event_handler, NULL);

    /* Update node_id */
    node_id_attribute_update(esp_rmaker_get_node_id());
    return ESP_OK;
}

} /* rainmaker */
} /* esp_matter */