mirror of
https://github.com/espressif/esp-matter.git
synced 2026-04-27 19:13:13 +00:00
Chirag Atal
a270477e16
This is a middle layer between application and chip submodule. esp_matter_core: Data model APIs in the form of linked lists. It also has the APIs for initialisations for matter. esp_matter_endpoint: APIs for endpoint. This adds the mandatory clusters for the endpoint. esp_matter_cluster: APIs for cluster. This adds the mandatory attributes and commands for the cluster. esp_matter_attribute: APIs for attribute value. It also manages the attribute related matter callbacks. esp_matter_command: Callback APIs for commands. esp_matter_attribute: Giving 2 callbacks to the application, pre_attribute and post_attribute. app_main: Dynamically creating the data model using the top level APIs. app_matter: Moved to esp_matter_start() in esp_matter. Also moved the post_attribute_callback to esp_matter_attribute and moved the event_callback to app_main. app_driver: Moved with app_main. Using IDs instead of macros. app_driver: Changing the console usage from names to IDs. app_rainmaker: Dynamically creating the rainmaker data model from the matter data model. The endpoint_id, cluster_id, attribute_id need to be handled accordingly. cmake: Moved the chip submodule sources and includes from app_main to esp_matter. zap-generated: Using esp_matter_command instead of IMClusterCommandHandler. Dynamically creating the data model instead of using macros from endpoint_config. zap-generated: Regenerated using the zap tool with matter_root_node and matter_color_dimmable_light device types. Also enabled wifi and thread for network commissioning cluster. device_hal: Added support for esp32s2 with hollow drivers. zap_light: Adding another example which uses the zap-generated data model instead of the esp_matter data model. ci: Added zap_light example to ci.
75 lines
2.0 KiB
C
75 lines
2.0 KiB
C
// Copyright 2021 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 <esp_err.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Callback for console commands
|
|
*
|
|
* This callback handler will be called when console command is triggered.
|
|
*
|
|
* @return ESP_OK on success.
|
|
* @return error in case of failure.
|
|
*/
|
|
typedef esp_err_t (*esp_matter_console_handler_t)(int argc, char **argv);
|
|
|
|
/** ESP Matter Console Command */
|
|
typedef struct {
|
|
/** Command Name */
|
|
const char *name;
|
|
/** Command Description/Help */
|
|
const char *description;
|
|
/** Command Handler */
|
|
esp_matter_console_handler_t handler;
|
|
} esp_matter_console_command_t;
|
|
|
|
/** Initialize Console
|
|
*
|
|
* This API internally initializes the matter shell.
|
|
*
|
|
* @return ESP_OK on success.
|
|
* @return error in case of failure.
|
|
*/
|
|
esp_err_t esp_matter_console_init(void);
|
|
|
|
/** Add Console Command
|
|
*
|
|
* Add a new console command.
|
|
* This can be done before calling `esp_matter_console_init()` but the commands will not work until initialized.
|
|
*
|
|
* @param[in] command Pointer to command struct
|
|
*
|
|
* @return ESP_OK on success.
|
|
* @return error in case of failure.
|
|
*/
|
|
esp_err_t esp_matter_console_add_command(esp_matter_console_command_t *command);
|
|
|
|
/** Add Diagnostics Commands
|
|
*
|
|
* Adds the default diagnostics commands.
|
|
*
|
|
* @return ESP_OK on success.
|
|
* @return error in case of failure.
|
|
*/
|
|
esp_err_t esp_matter_console_diagnostics_register_commands();
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|