alexey.zholtikov/zh_espnow_sensor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

Version 1.0.1

Browse Source 
Updated some components.
Changed main code to support the new major version of zh_config.
Reducing the amount of memory used.
This commit is contained in:
Alexey Zholtikov
2024-06-09 14:30:15 +03:00
parent db2a33d47f
commit 6ecd5a59bd
30 changed files with 723 additions and 651 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/zh_vector/README.md
View File

@ -46,7 +46,7 @@ char example[10] = {0};
void app_main(void)
{
// esp_log_level_set("zh_vector", ESP_LOG_NONE);
esp_log_level_set("zh_vector", ESP_LOG_NONE);
zh_vector_init(&vector, sizeof(example), false);
printf("Initial vector size is: %d\n", zh_vector_get_size(&vector));
strcpy(example, "Item 1");

44
components/zh_vector/include/zh_vector.h
View File

@ -32,15 +32,15 @@ extern "C"
} zh_vector_t;
/**
* @brief Initialize vector.
* @brief Initialize vector.
*
* @param[in] vector Pointer to main structure of vector data.
* @param[in] unit Size of vector item.
* @param[in] spiram SPI RAM using (true - vector will be placed in SPI RAM, false - vector will be placed in RAM).
* @param[in] vector Pointer to main structure of vector data.
* @param[in] unit Size of vector item.
* @param[in] spiram SPI RAM using (true - vector will be placed in SPI RAM, false - vector will be placed in RAM).
*
* @attention For using SPI RAM select “Make RAM allocatable using heap_caps_malloc(…, MALLOC_CAP_SPIRAM)” from CONFIG_SPIRAM_USE. For ESP32 with external, SPI-connected RAM only.
*
* @note If SPI RAM is not supported or not initialised via menuconfig vector will be placed in RAM regardless of the set spiram value.
* @note If SPI RAM is not supported or not initialised via menuconfig vector will be placed in RAM regardless of the set spiram value.
*
* @return
* - ESP_OK if initialization was success
@ -50,9 +50,9 @@ extern "C"
esp_err_t zh_vector_init(zh_vector_t *vector, uint16_t unit, bool spiram);
/**
* @brief Deinitialize vector. Free all allocated memory.
* @brief Deinitialize vector. Free all allocated memory.
*
* @param[in] vector Pointer to main structure of vector data.
* @param[in] vector Pointer to main structure of vector data.
*
* @return
* - ESP_OK if deinitialization was success
@ -62,9 +62,9 @@ extern "C"
esp_err_t zh_vector_free(zh_vector_t *vector);
/**
* @brief Get current vector size.
* @brief Get current vector size.
*
* @param[in] vector Pointer to main structure of vector data.
* @param[in] vector Pointer to main structure of vector data.
*
* @return
* - Vector size
@ -73,10 +73,10 @@ extern "C"
esp_err_t zh_vector_get_size(zh_vector_t *vector);
/**
* @brief Add item at end of vector.
* @brief Add item at end of vector.
*
* @param[in] vector Pointer to main structure of vector data.
* @param[in] item Pointer to item for add.
* @param[in] vector Pointer to main structure of vector data.
* @param[in] item Pointer to item for add.
*
* @return
* - ESP_OK if add was success
@ -87,11 +87,11 @@ extern "C"
esp_err_t zh_vector_push_back(zh_vector_t *vector, void *item);
/**
* @brief Change item by index.
* @brief Change item by index.
*
* @param[in] vector Pointer to main structure of vector data.
* @param[in] index Index of item for change.
* @param[in] item Pointer to new data of item.
* @param[in] vector Pointer to main structure of vector data.
* @param[in] index Index of item for change.
* @param[in] item Pointer to new data of item.
*
* @return
* - ESP_OK if change was success
@ -102,10 +102,10 @@ extern "C"
esp_err_t zh_vector_change_item(zh_vector_t *vector, uint16_t index, void *item);
/**
* @brief Get item by index.
* @brief Get item by index.
*
* @param[in] vector Pointer to main structure of vector data.
* @param[in] index Index of item for get.
* @param[in] vector Pointer to main structure of vector data.
* @param[in] index Index of item for get.
*
* @return
* - Pointer to item
@ -114,10 +114,10 @@ extern "C"
void *zh_vector_get_item(zh_vector_t *vector, uint16_t index);
/**
* @brief Delete item by index and shifts all elements in vector.
* @brief Delete item by index and shifts all elements in vector.
*
* @param[in] vector Pointer to main structure of vector data.
* @param[in] index Index of item for delete.
* @param[in] vector Pointer to main structure of vector data.
* @param[in] index Index of item for delete.
*
* @return
* - ESP_OK if delete was success

2
components/zh_vector/version.txt
View File

@ -1 +1 @@
1.4.6
1.0.0

1
components/zh_vector/zh_vector.c
View File

@ -1,6 +1,7 @@
/**
* @file
* The main code of the zh_vector component.
*
*/
#include "zh_vector.h"