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

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

@ -35,7 +35,6 @@
* @note Value range from 1 to 218. Smaller size - higher transmission speed.
*
* @attention All devices on the network must have the same ZH_NETWORK_MAX_MESSAGE_SIZE.
*
*/
#define ZH_NETWORK_MAX_MESSAGE_SIZE 218
@ -52,8 +51,7 @@
.max_waiting_time = 1000, \
.id_vector_size = 100, \
.route_vector_size = 100, \
.wifi_interface = WIFI_IF_STA, \
.wifi_channel = 1 \
.wifi_interface = WIFI_IF_STA \
}
#ifdef __cplusplus
@ -66,9 +64,7 @@ extern "C"
*
* @note Before initialize ESP-NOW interface recommend initialize zh_network_init_config_t structure with default values.
*
* @code
* zh_network_init_config_t config = ZH_NETWORK_INIT_CONFIG_DEFAULT()
* @endcode
* @code zh_network_init_config_t config = ZH_NETWORK_INIT_CONFIG_DEFAULT() @endcode
*/
typedef struct
{
@ -80,8 +76,7 @@ extern "C"
uint16_t id_vector_size; ///< Maximum size of unique ID of received messages. @note If the size is exceeded, the first value will be deleted. Minimum recommended value: number of planned nodes in the network + 10%.
uint16_t route_vector_size; ///< The maximum size of the routing table. @note If the size is exceeded, the first route will be deleted. Minimum recommended value: number of planned nodes in the network + 10%.
wifi_interface_t wifi_interface; ///< WiFi interface (STA or AP) used for ESP-NOW operation. @note The MAC address of the device depends on the selected WiFi interface.
uint8_t wifi_channel; ///< Wi-Fi channel uses to send/receive ESPNOW data. @note Values from 1 to 14.
} __attribute__((packed)) zh_network_init_config_t;
} zh_network_init_config_t;
/// \cond
ESP_EVENT_DECLARE_BASE(ESP_EVENT_BASE);
@ -95,7 +90,7 @@ extern "C"
{
ZH_NETWORK_ON_RECV_EVENT, ///< The event when the ESP-NOW message was received.
ZH_NETWORK_ON_SEND_EVENT ///< The event when the ESP-NOW message was sent.
} __attribute__((packed)) zh_network_event_type_t;
} zh_network_event_type_t;
/**
* @brief Enumeration of possible status of sent ESP-NOW message.
@ -105,19 +100,18 @@ extern "C"
{
ZH_NETWORK_SEND_SUCCESS, ///< If ESP-NOW message was sent success.
ZH_NETWORK_SEND_FAIL ///< If ESP-NOW message was sent fail.
} __attribute__((packed)) zh_network_on_send_event_type_t;
} zh_network_on_send_event_type_t;
/**
* @brief Structure for sending data to the event handler when an ESP-NOW message was sent.
*
* @note Should be used with ZH_NETWORK event base and ZH_NETWORK_ON_SEND_EVENT event.
*
*/
typedef struct
{
uint8_t mac_addr[6]; ///< MAC address of the device to which the ESP-NOW message was sent. @note
zh_network_on_send_event_type_t status; ///< Status of sent ESP-NOW message. @note
} __attribute__((packed)) zh_network_event_on_send_t;
} zh_network_event_on_send_t;
/**
* @brief Structure for sending data to the event handler when an ESP-NOW message was received.
@ -129,18 +123,16 @@ extern "C"
uint8_t mac_addr[6]; ///< MAC address of the sender ESP-NOW message. @note
uint8_t *data; ///< Pointer to the data of the received ESP-NOW message. @note
uint8_t data_len; ///< Size of the received ESP-NOW message. @note
} __attribute__((packed)) zh_network_event_on_recv_t;
} zh_network_event_on_recv_t;
/**
* @brief Initialize ESP-NOW interface.
* @brief Initialize ESP-NOW interface.
*
* @note Before initialize ESP-NOW interface recommend initialize zh_network_init_config_t structure with default values.
* @note Before initialize ESP-NOW interface recommend initialize zh_network_init_config_t structure with default values.
*
* @code
* zh_network_init_config_t config = ZH_NETWORK_INIT_CONFIG_DEFAULT()
* @endcode
* @code zh_network_init_config_t config = ZH_NETWORK_INIT_CONFIG_DEFAULT() @endcode
*
* @param[in] config Pointer to ESP-NOW initialized configuration structure. Can point to a temporary variable.
* @param[in] config Pointer to ESP-NOW initialized configuration structure. Can point to a temporary variable.
*
* @return
* - ESP_OK if initialization was success
@ -148,10 +140,10 @@ extern "C"
* - ESP_ERR_WIFI_NOT_INIT if WiFi is not initialized
* - ESP_FAIL if any internal error
*/
esp_err_t zh_network_init(const zh_network_init_config_t *config);
esp_err_t zh_network_init(zh_network_init_config_t *config);
/**
* @brief Deinitialize ESP-NOW interface.
* @brief Deinitialize ESP-NOW interface.
*
* @return
* - ESP_OK if deinitialization was success
@ -160,11 +152,11 @@ extern "C"
esp_err_t zh_network_deinit(void);
/**
* @brief Send ESP-NOW data.
* @brief Send ESP-NOW data.
*
* @param[in] target Pointer to a buffer containing an eight-byte target MAC. Can be NULL for broadcast.
* @param[in] data Pointer to a buffer containing the data for send.
* @param[in] data_len Sending data length.
* @param[in] target Pointer to a buffer containing an eight-byte target MAC. Can be NULL for broadcast.
* @param[in] data Pointer to a buffer containing the data for send.
* @param[in] data_len Sending data length.
*
* @note The function will return an ESP_ERR_INVALID_STATE error if less than 50% of the size set at initialization remains in the message queue.
*
@ -172,7 +164,7 @@ extern "C"
* - ESP_OK if sent was success
* - ESP_ERR_INVALID_ARG if parameter error
* - ESP_ERR_INVALID_STATE if queue for outgoing data is almost full
* - ESP_FAIL if ESP-NOW is not initialized or any internal error
* - ESP_FAIL if ESP-NOW is not initialized
*/
esp_err_t zh_network_send(const uint8_t *target, const uint8_t *data, const uint8_t data_len);