mirror of
https://github.com/0xFEEDC0DE64/arduino-esp32.git
synced 2025-10-26 03:31:43 +01:00
69f72eca84
* Update BLE lib * Update IDF to f586f5e * Restructure Bluetooth Serial includes * Update esptool and gen_esp32part * Add partition scheme selection for menuconfig * Add partition scheme selection for Arduino IDE * Fix BLE example * Second attempt BLE fix * Add exceptions to PIO
318 lines
10 KiB
C
318 lines
10 KiB
C
// Copyright 2015-2016 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.
|
|
|
|
#ifndef __ESP_NOW_H__
|
|
#define __ESP_NOW_H__
|
|
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
#include "esp_wifi_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** \defgroup WiFi_APIs WiFi Related APIs
|
|
* @brief WiFi APIs
|
|
*/
|
|
|
|
/** @addtogroup WiFi_APIs
|
|
* @{
|
|
*/
|
|
|
|
/** \defgroup ESPNOW_APIs ESPNOW APIs
|
|
* @brief ESP32 ESPNOW APIs
|
|
*
|
|
*/
|
|
|
|
/** @addtogroup ESPNOW_APIs
|
|
* @{
|
|
*/
|
|
|
|
#define ESP_ERR_ESPNOW_BASE (ESP_ERR_WIFI_BASE + 100) /*!< ESPNOW error number base. */
|
|
#define ESP_ERR_ESPNOW_NOT_INIT (ESP_ERR_ESPNOW_BASE + 1) /*!< ESPNOW is not initialized. */
|
|
#define ESP_ERR_ESPNOW_ARG (ESP_ERR_ESPNOW_BASE + 2) /*!< Invalid argument */
|
|
#define ESP_ERR_ESPNOW_NO_MEM (ESP_ERR_ESPNOW_BASE + 3) /*!< Out of memory */
|
|
#define ESP_ERR_ESPNOW_FULL (ESP_ERR_ESPNOW_BASE + 4) /*!< ESPNOW peer list is full */
|
|
#define ESP_ERR_ESPNOW_NOT_FOUND (ESP_ERR_ESPNOW_BASE + 5) /*!< ESPNOW peer is not found */
|
|
#define ESP_ERR_ESPNOW_INTERNAL (ESP_ERR_ESPNOW_BASE + 6) /*!< Internal error */
|
|
#define ESP_ERR_ESPNOW_EXIST (ESP_ERR_ESPNOW_BASE + 7) /*!< ESPNOW peer has existed */
|
|
#define ESP_ERR_ESPNOW_IF (ESP_ERR_ESPNOW_BASE + 8) /*!< Interface error */
|
|
|
|
#define ESP_NOW_ETH_ALEN 6 /*!< Length of ESPNOW peer MAC address */
|
|
#define ESP_NOW_KEY_LEN 16 /*!< Length of ESPNOW peer local master key */
|
|
|
|
#define ESP_NOW_MAX_TOTAL_PEER_NUM 20 /*!< Maximum number of ESPNOW total peers */
|
|
#define ESP_NOW_MAX_ENCRYPT_PEER_NUM 6 /*!< Maximum number of ESPNOW encrypted peers */
|
|
|
|
#define ESP_NOW_MAX_DATA_LEN 250 /*!< Maximum length of ESPNOW data which is sent very time */
|
|
|
|
/**
|
|
* @brief Status of sending ESPNOW data .
|
|
*/
|
|
typedef enum {
|
|
ESP_NOW_SEND_SUCCESS = 0, /**< Send ESPNOW data successfully */
|
|
ESP_NOW_SEND_FAIL, /**< Send ESPNOW data fail */
|
|
} esp_now_send_status_t;
|
|
|
|
/**
|
|
* @brief ESPNOW peer information parameters.
|
|
*/
|
|
typedef struct esp_now_peer_info {
|
|
uint8_t peer_addr[ESP_NOW_ETH_ALEN]; /**< ESPNOW peer MAC address that is also the MAC address of station or softap */
|
|
uint8_t lmk[ESP_NOW_KEY_LEN]; /**< ESPNOW peer local master key that is used to encrypt data */
|
|
uint8_t channel; /**< Wi-Fi channel that peer uses to send/receive ESPNOW data. If the value is 0,
|
|
use the current channel which station or softap is on. Otherwise, it must be
|
|
set as the channel that station or softap is on. */
|
|
wifi_interface_t ifidx; /**< Wi-Fi interface that peer uses to send/receive ESPNOW data */
|
|
bool encrypt; /**< ESPNOW data that this peer sends/receives is encrypted or not */
|
|
void *priv; /**< ESPNOW peer private data */
|
|
} esp_now_peer_info_t;
|
|
|
|
/**
|
|
* @brief Number of ESPNOW peers which exist currently.
|
|
*/
|
|
typedef struct esp_now_peer_num {
|
|
int total_num; /**< Total number of ESPNOW peers, maximum value is ESP_NOW_MAX_TOTAL_PEER_NUM */
|
|
int encrypt_num; /**< Number of encrypted ESPNOW peers, maximum value is ESP_NOW_MAX_ENCRYPT_PEER_NUM */
|
|
} esp_now_peer_num_t;
|
|
|
|
/**
|
|
* @brief Callback function of receiving ESPNOW data
|
|
* @param mac_addr peer MAC address
|
|
* @param data received data
|
|
* @param data_len length of received data
|
|
*/
|
|
typedef void (*esp_now_recv_cb_t)(const uint8_t *mac_addr, const uint8_t *data, int data_len);
|
|
|
|
/**
|
|
* @brief Callback function of sending ESPNOW data
|
|
* @param mac_addr peer MAC address
|
|
* @param status status of sending ESPNOW data (succeed or fail)
|
|
*/
|
|
typedef void (*esp_now_send_cb_t)(const uint8_t *mac_addr, esp_now_send_status_t status);
|
|
|
|
/**
|
|
* @brief Initialize ESPNOW function
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_INTERNAL : Internal error
|
|
*/
|
|
esp_err_t esp_now_init(void);
|
|
|
|
/**
|
|
* @brief De-initialize ESPNOW function
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
*/
|
|
esp_err_t esp_now_deinit(void);
|
|
|
|
/**
|
|
* @brief Get the version of ESPNOW
|
|
*
|
|
* @param version ESPNOW version
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
*/
|
|
esp_err_t esp_now_get_version(uint32_t *version);
|
|
|
|
/**
|
|
* @brief Register callback function of receiving ESPNOW data
|
|
*
|
|
* @param cb callback function of receiving ESPNOW data
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_INTERNAL : internal error
|
|
*/
|
|
esp_err_t esp_now_register_recv_cb(esp_now_recv_cb_t cb);
|
|
|
|
/**
|
|
* @brief Unregister callback function of receiving ESPNOW data
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
*/
|
|
esp_err_t esp_now_unregister_recv_cb(void);
|
|
|
|
/**
|
|
* @brief Register callback function of sending ESPNOW data
|
|
*
|
|
* @param cb callback function of sending ESPNOW data
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_INTERNAL : internal error
|
|
*/
|
|
esp_err_t esp_now_register_send_cb(esp_now_send_cb_t cb);
|
|
|
|
/**
|
|
* @brief Unregister callback function of sending ESPNOW data
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
*/
|
|
esp_err_t esp_now_unregister_send_cb(void);
|
|
|
|
/**
|
|
* @brief Send ESPNOW data
|
|
*
|
|
* @attention 1. If peer_addr is not NULL, send data to the peer whose MAC address matches peer_addr
|
|
* @attention 2. If peer_addr is NULL, send data to all of the peers that are added to the peer list
|
|
* @attention 3. The maximum length of data must be less than ESP_NOW_MAX_DATA_LEN
|
|
* @attention 4. The buffer pointed to by data argument does not need to be valid after esp_now_send returns
|
|
*
|
|
* @param peer_addr peer MAC address
|
|
* @param data data to send
|
|
* @param len length of data
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
* - ESP_ERR_ESPNOW_INTERNAL : internal error
|
|
* - ESP_ERR_ESPNOW_NO_MEM : out of memory
|
|
* - ESP_ERR_ESPNOW_NOT_FOUND : peer is not found
|
|
* - ESP_ERR_ESPNOW_IF : current WiFi interface doesn't match that of peer
|
|
*/
|
|
esp_err_t esp_now_send(const uint8_t *peer_addr, const uint8_t *data, size_t len);
|
|
|
|
/**
|
|
* @brief Add a peer to peer list
|
|
*
|
|
* @param peer peer information
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
* - ESP_ERR_ESPNOW_FULL : peer list is full
|
|
* - ESP_ERR_ESPNOW_NO_MEM : out of memory
|
|
* - ESP_ERR_ESPNOW_EXIST : peer has existed
|
|
*/
|
|
esp_err_t esp_now_add_peer(const esp_now_peer_info_t *peer);
|
|
|
|
/**
|
|
* @brief Delete a peer from peer list
|
|
*
|
|
* @param peer_addr peer MAC address
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
* - ESP_ERR_ESPNOW_NOT_FOUND : peer is not found
|
|
*/
|
|
esp_err_t esp_now_del_peer(const uint8_t *peer_addr);
|
|
|
|
/**
|
|
* @brief Modify a peer
|
|
*
|
|
* @param peer peer information
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
* - ESP_ERR_ESPNOW_FULL : peer list is full
|
|
*/
|
|
esp_err_t esp_now_mod_peer(const esp_now_peer_info_t *peer);
|
|
|
|
/**
|
|
* @brief Get a peer whose MAC address matches peer_addr from peer list
|
|
*
|
|
* @param peer_addr peer MAC address
|
|
* @param peer peer information
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
* - ESP_ERR_ESPNOW_NOT_FOUND : peer is not found
|
|
*/
|
|
esp_err_t esp_now_get_peer(const uint8_t *peer_addr, esp_now_peer_info_t *peer);
|
|
|
|
/**
|
|
* @brief Fetch a peer from peer list
|
|
*
|
|
* @param from_head fetch from head of list or not
|
|
* @param peer peer information
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
* - ESP_ERR_ESPNOW_NOT_FOUND : peer is not found
|
|
*/
|
|
esp_err_t esp_now_fetch_peer(bool from_head, esp_now_peer_info_t *peer);
|
|
|
|
/**
|
|
* @brief Peer exists or not
|
|
*
|
|
* @param peer_addr peer MAC address
|
|
*
|
|
* @return
|
|
* - true : peer exists
|
|
* - false : peer not exists
|
|
*/
|
|
bool esp_now_is_peer_exist(const uint8_t *peer_addr);
|
|
|
|
/**
|
|
* @brief Get the number of peers
|
|
*
|
|
* @param num number of peers
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
*/
|
|
esp_err_t esp_now_get_peer_num(esp_now_peer_num_t *num);
|
|
|
|
/**
|
|
* @brief Set the primary master key
|
|
*
|
|
* @param pmk primary master key
|
|
*
|
|
* @attention 1. primary master key is used to encrypt local master key
|
|
*
|
|
* @return
|
|
* - ESP_OK : succeed
|
|
* - ESP_ERR_ESPNOW_NOT_INIT : ESPNOW is not initialized
|
|
* - ESP_ERR_ESPNOW_ARG : invalid argument
|
|
*/
|
|
esp_err_t esp_now_set_pmk(const uint8_t *pmk);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ESP_NOW_H__ */
|