MatterEndPoint.h

// Copyright 2024 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.

#pragma once
#include <sdkconfig.h>
#ifdef CONFIG_ESP_MATTER_ENABLE_DATA_MODEL

#include <Matter.h>
#include <functional>

using namespace esp_matter;

// Matter Endpoint Base Class. Controls the endpoint ID and allows the child class to overwrite attribute change call
class MatterEndPoint {
public:
  enum attrOperation_t {
    ATTR_SET = false,
    ATTR_UPDATE = true
  };

  uint16_t getEndPointId() {
    return endpoint_id;
  }

  void setEndPointId(uint16_t ep) {
    endpoint_id = ep;
  }

  // helper functions for attribute manipulation
  attribute_t *getAttribute(uint32_t cluster_id, uint32_t attribute_id) {
    if (endpoint_id == 0) {
      log_e("Endpoint ID is not set");
      return NULL;
    }
    endpoint_t *endpoint = endpoint::get(node::get(), endpoint_id);
    if (endpoint == NULL) {
      log_e("Endpoint [%d] not found", endpoint_id);
      return NULL;
    }
    cluster_t *cluster = cluster::get(endpoint, cluster_id);
    if (cluster == NULL) {
      log_e("Cluster [%d] not found", cluster_id);
      return NULL;
    }
    attribute_t *attribute = attribute::get(cluster, attribute_id);
    if (attribute == NULL) {
      log_e("Attribute [%d] not found", attribute_id);
      return NULL;
    }
    return attribute;
  }

  // get the value of an attribute from its cluster id and attribute it
  bool getAttributeVal(uint32_t cluster_id, uint32_t attribute_id, esp_matter_attr_val_t *attrVal) {
    attribute_t *attribute = getAttribute(cluster_id, attribute_id);
    if (attribute == NULL) {
      return false;
    }
    if (attribute::get_val(attribute, attrVal) == ESP_OK) {
      log_v("GET_VAL Success for cluster %d, attribute %d with value %d", cluster_id, attribute_id, attrVal->val.u32);
      return true;
    }
    log_e("GET_VAL FAILED! for cluster %d, attribute %d with value %d", cluster_id, attribute_id, attrVal->val.u32);
    return false;
  }

  // set the value of an attribute from its cluster id and attribute it
  bool setAttributeVal(uint32_t cluster_id, uint32_t attribute_id, esp_matter_attr_val_t *attrVal) {
    attribute_t *attribute = getAttribute(cluster_id, attribute_id);
    if (attribute == NULL) {
      return false;
    }
    if (attribute::set_val(attribute, attrVal) == ESP_OK) {
      log_v("SET_VAL Success for cluster %d, attribute %d with value %d", cluster_id, attribute_id, attrVal->val.u32);
      return true;
    }
    log_e("SET_VAL FAILED! for cluster %d, attribute %d with value %d", cluster_id, attribute_id, attrVal->val.u32);
    return false;
  }

  // update the value of an attribute from its cluster id and attribute it
  bool updateAttributeVal(uint32_t cluster_id, uint32_t attribute_id, esp_matter_attr_val_t *attrVal) {
    if (attribute::update(endpoint_id, cluster_id, attribute_id, attrVal) == ESP_OK) {
      log_v("Update Success for cluster %d, attribute %d with value %d", cluster_id, attribute_id, attrVal->val.u32);
      return true;
    }
    log_e("Update FAILED! for cluster %d, attribute %d with value %d", cluster_id, attribute_id, attrVal->val.u32);
    return false;
  }

  // this function is called by Matter internal event processor. It could be overwritten by the application, if necessary.
  virtual bool attributeChangeCB(uint16_t endpoint_id, uint32_t cluster_id, uint32_t attribute_id, esp_matter_attr_val_t *val) = 0;

protected:
  uint16_t endpoint_id = 0;
};
#endif /* CONFIG_ESP_MATTER_ENABLE_DATA_MODEL */