Add sorting tasks by core

Author: VPavlusha

example/CMakeLists.txt CMakeLists.txt

@@ -3,4 +3,4 @@
 cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(task_monitor)
+project(task_monitor_example)

README.md

@@ -18,16 +18,16 @@ The ESP32 Task Monitor is a project that provides a simple way to monitor the ta
  [7. License](#7-license)  
 
 ## 1. Features
-  - ESP-IDF v5.0.2
+  - ESP-IDF v5.3-dev-422-ga7fbf452fa 2nd stage bootloader
   - Real-time monitoring of running multiple tasks for ESP32 microcontrollers.
   - Written in C language.
   - MIT License.
 
 ## 2. ESP32 Task Monitor
-<img src="./doc/img/task_monitor.svg" alt="Task Monitor" width="650"/>
+<img src="./doc/img/task_monitor.png" alt="Task Monitor" width="650"/>
 
 ## 3. Basic Usage
-**NOTE:** USE_TRACE_FACILITY and GENERATE_RUN_TIME_STATS must be defined as **1** in FreeRTOSConfig.h for this API function task_monitor() to be available.
+**NOTE:** configUSE_TRACE_FACILITY and configGENERATE_RUN_TIME_STATS must be defined as **1** in FreeRTOSConfig.h for this API function task_monitor() to be available.
 ```C
 // 1. Include header:
 #include "task_monitor.h"
@@ -47,7 +47,7 @@ To get started with the ESP32 Task Monitor project, you'll need an ESP32 microco
 ```
 ### 4.2 Build the project:
 ```C
-    cd ESP32_Task_Monitor/example
+    cd ESP32_Task_Monitor
     idf.py build
 ```
 ### 4.3 Flash onto your ESP32 microcontroller:
@@ -65,7 +65,7 @@ Do not forget to replace PORT with your serial port name.
 More information how to build project: [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/v5.0.1/esp32/get-started/start-project.html).
 
 ## 5. Example
-This project includes an [example](https://github.com/VPavlusha/ESP32_Task_Monitor/tree/main/example) that showcases the functionality of the Task Monitor library. This example provides a practical demonstration of how to use the Task Monitor API to monitor tasks in your own applications.
+This project includes an [example](https://github.com/VPavlusha/ESP32_Task_Monitor/tree/main/main) that showcases the functionality of the Task Monitor library. This example provides a practical demonstration of how to use the Task Monitor API to monitor tasks in your own applications.
 
 ## 6. Contributing
 Contributions to the ESP32 Task Monitor project are welcome. If you find a bug or have a feature request, please submit an issue on the project's GitHub page. If you'd like to contribute code, please submit a pull request.

doc/img/task_monitor.png

@@ -1,18 +1,18 @@
 /*
  * MIT License
- * 
+ *
  * Copyright (c) 2023 Volodymyr Pavlusha
- * 
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included in all
  * copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -31,15 +31,15 @@
 extern "C" {
 #endif
 
-// NOTE: USE_TRACE_FACILITY and GENERATE_RUN_TIME_STATS must be defined as 1
+// NOTE: configUSE_TRACE_FACILITY and configGENERATE_RUN_TIME_STATS must be defined as 1
 // in FreeRTOSConfig.h for this API function task_monitor() to be available.
 
 /**
  * @brief Create a new task to monitor the status and activity of other FreeRTOS tasks in the system
  *
  * @return
- *         - ESP_OK           Success.
- *         - ESP_ERR_NO_MEM   Out of memory.
+ *      - ESP_OK           Success.
+ *      - ESP_ERR_NO_MEM   Out of memory.
  */
 esp_err_t task_monitor(void);
 

doc/img/task_monitor.svg

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "example.c" "../src/task_monitor.c"
+                       INCLUDE_DIRS "../include")

example/main/CMakeLists.txt

@@ -2,7 +2,7 @@
 
 void app_main(void)
 {
-    // NOTE: USE_TRACE_FACILITY and GENERATE_RUN_TIME_STATS must be defined as 1
+    // NOTE: configUSE_TRACE_FACILITY and configGENERATE_RUN_TIME_STATS must be defined as 1
     // in FreeRTOSConfig.h for this API function task_monitor() to be available.
     task_monitor();
 }