forked from espressif/arduino-esp32
v2.0.0 Add support for ESP32S2 and update ESP-IDF to 4.4 (#4996)
This is very much still work in progress and much more will change before the final 2.0.0 Some APIs have changed. New libraries have been added. LittleFS included. Co-authored-by: Seon Rozenblum <seonr@3sprockets.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: geeksville <kevinh@geeksville.com> Co-authored-by: Mike Dunston <m_dunston@comcast.net> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Seon Rozenblum <seonr@3sprockets.com> Co-authored-by: microDev <70126934+microDev1@users.noreply.github.com> Co-authored-by: tobozo <tobozo@users.noreply.github.com> Co-authored-by: bobobo1618 <bobobo1618@users.noreply.github.com> Co-authored-by: lorol <lorolouis@gmail.com> Co-authored-by: geeksville <kevinh@geeksville.com> Co-authored-by: Limor "Ladyada" Fried <limor@ladyada.net> Co-authored-by: Sweety <switi.mhaiske@espressif.com> Co-authored-by: Loick MAHIEUX <loick111@gmail.com> Co-authored-by: Larry Bernstone <lbernstone@gmail.com> Co-authored-by: Valerii Koval <valeros@users.noreply.github.com> Co-authored-by: 快乐的我531 <2302004040@qq.com> Co-authored-by: chegewara <imperiaonline4@gmail.com> Co-authored-by: Clemens Kirchgatterer <clemens@1541.org> Co-authored-by: Aron Rubin <aronrubin@gmail.com> Co-authored-by: Pete Lewis <601236+lewispg228@users.noreply.github.com>
This commit is contained in:
Me No Dev
GitHub
294
tools/sdk/esp32/include/esp_hid/include/esp_hidh.h
Normal file
294
tools/sdk/esp32/include/esp_hid/include/esp_hidh.h
Normal file
@ -0,0 +1,294 @@
|
||||
// Copyright 2017-2019 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 "sdkconfig.h"
|
||||
#include "esp_err.h"
|
||||
#include "esp_log.h"
|
||||
#include "esp_event.h"
|
||||
#include "esp_hid_common.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief HIDH structure forward declaration
|
||||
*/
|
||||
struct esp_hidh_dev_s;
|
||||
typedef struct esp_hidh_dev_s esp_hidh_dev_t;
|
||||
|
||||
ESP_EVENT_DECLARE_BASE(ESP_HIDH_EVENTS);
|
||||
|
||||
/**
|
||||
* @brief HIDH callback events enum
|
||||
*/
|
||||
typedef enum {
|
||||
ESP_HIDH_ANY_EVENT = ESP_EVENT_ANY_ID, /*!< HID device any event */
|
||||
ESP_HIDH_OPEN_EVENT = 0, /*!< HID device opened */
|
||||
ESP_HIDH_BATTERY_EVENT, /*!< HID device battery level changed */
|
||||
ESP_HIDH_INPUT_EVENT, /*!< Received HID device INPUT report */
|
||||
ESP_HIDH_FEATURE_EVENT, /*!< Received HID device FEATURE report */
|
||||
ESP_HIDH_CLOSE_EVENT, /*!< HID device closed */
|
||||
ESP_HIDH_MAX_EVENT, /*!< HID events end marker */
|
||||
} esp_hidh_event_t;
|
||||
|
||||
/**
|
||||
* @brief HIDH callback parameters union
|
||||
*/
|
||||
typedef union {
|
||||
/**
|
||||
* @brief ESP_HIDH_OPEN_EVENT
|
||||
*/
|
||||
struct {
|
||||
esp_hidh_dev_t *dev; /*!< HID Remote bluetooth device */
|
||||
} open; /*!< HID callback param of ESP_HIDH_OPEN_EVENT */
|
||||
|
||||
/**
|
||||
* @brief ESP_HIDH_CLOSE_EVENT
|
||||
*/
|
||||
struct {
|
||||
esp_hidh_dev_t *dev; /*!< HID Remote bluetooth device. */
|
||||
int reason; /*!< Reason why the connection was closed. BLE Only */
|
||||
} close; /*!< HID callback param of ESP_HIDH_CLOSE_EVENT */
|
||||
|
||||
/**
|
||||
* @brief ESP_HIDH_BATTERY_EVENT
|
||||
*/
|
||||
struct {
|
||||
esp_hidh_dev_t *dev; /*!< HID Remote bluetooth device */
|
||||
uint8_t level; /*!< Battery Level (0-100%) */
|
||||
} battery; /*!< HID callback param of ESP_HIDH_BATTERY_EVENT */
|
||||
|
||||
/**
|
||||
* @brief ESP_HIDH_INPUT_EVENT
|
||||
*/
|
||||
struct {
|
||||
esp_hidh_dev_t *dev; /*!< HID Remote bluetooth device */
|
||||
esp_hid_usage_t usage; /*!< HID report usage */
|
||||
uint16_t report_id; /*!< HID report index */
|
||||
uint16_t length; /*!< HID data length */
|
||||
uint8_t *data; /*!< The pointer to the HID data */
|
||||
uint8_t map_index; /*!< HID report map index */
|
||||
} input; /*!< HID callback param of ESP_HIDH_INPUT_EVENT */
|
||||
|
||||
/**
|
||||
* @brief ESP_HIDH_FEATURE_EVENT
|
||||
*/
|
||||
struct {
|
||||
esp_hidh_dev_t *dev; /*!< HID Remote bluetooth device */
|
||||
esp_hid_usage_t usage; /*!< HID report usage */
|
||||
uint16_t report_id; /*!< HID report index */
|
||||
uint16_t length; /*!< HID data length */
|
||||
uint8_t *data; /*!< The pointer to the HID data */
|
||||
uint8_t map_index; /*!< HID report map index */
|
||||
} feature; /*!< HID callback param of ESP_HIDH_FEATURE_EVENT */
|
||||
|
||||
} esp_hidh_event_data_t;
|
||||
|
||||
typedef struct {
|
||||
esp_event_handler_t callback;
|
||||
} esp_hidh_config_t;
|
||||
|
||||
/**
|
||||
* @brief Initialize the HID Host component
|
||||
* @param config : pointer to esp_hidh_config_t structure
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_init(const esp_hidh_config_t *config);
|
||||
|
||||
/**
|
||||
* @brief De-initialize the HID Host component
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_deinit(void);
|
||||
|
||||
/**
|
||||
* @brief Close HID Device
|
||||
* @param dev : pointer to the device
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_dev_close(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Free HID Device Memory
|
||||
* This function MUST be called when handling ESP_HIDH_CLOSE_EVENT
|
||||
* Only then all memory used for the device will be freed.
|
||||
* @param dev : pointer to the device
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_dev_free(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Send an OUTPUT report to the device
|
||||
* @param dev : pointer to the device
|
||||
* @param map_index : index of the device report map
|
||||
* @param report_id : id of the HID OUTPUT report
|
||||
* @param data : pointer to the data to send
|
||||
* @param length : length of the data to send
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_dev_output_set(esp_hidh_dev_t *dev, size_t map_index, size_t report_id, uint8_t *data, size_t length);
|
||||
|
||||
/**
|
||||
* @brief Send a FEATURE report to the device
|
||||
* @param dev : pointer to the device
|
||||
* @param map_index : index of the device report map
|
||||
* @param report_id : id of the HID FEATURE report
|
||||
* @param data : pointer to the data to send
|
||||
* @param length : length of the data to send
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_dev_feature_set(esp_hidh_dev_t *dev, size_t map_index, size_t report_id, uint8_t *data, size_t length);
|
||||
|
||||
/**
|
||||
* @brief Get the value a FEATURE report from the device
|
||||
* @param dev : pointer to the device
|
||||
* @param map_index : index of the device report map
|
||||
* @param report_id : id of the HID FEATURE report
|
||||
* @param max_len : size of the buffer that will hold the data
|
||||
* @param data : pointer to the data buffer
|
||||
* @param length : pointer to the value that will be set to the number of bytes received
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_dev_feature_get(esp_hidh_dev_t *dev, size_t map_index, size_t report_id, size_t max_len, uint8_t *data, size_t *length);
|
||||
|
||||
/**
|
||||
* @brief Dump the properties of HID Device to UART
|
||||
* @param dev : pointer to the HID Device
|
||||
* @param fp : pointer to the output file
|
||||
*/
|
||||
void esp_hidh_dev_dump(esp_hidh_dev_t *dev, FILE *fp);
|
||||
|
||||
/**
|
||||
* @brief Get the BT Device Address of a HID Device
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: pointer to the BDA byte array or NULL
|
||||
*/
|
||||
const uint8_t *esp_hidh_dev_bda_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the HID Device Transport
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: the transport of the connected device or ESP_HID_TRANSPORT_MAX
|
||||
*/
|
||||
esp_hid_transport_t esp_hidh_dev_transport_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the HID Device Cofiguration
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: pointer to the config structure or NULL
|
||||
*/
|
||||
const esp_hid_device_config_t *esp_hidh_dev_config_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the name of a HID Device
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: pointer to the character array or NULL
|
||||
*/
|
||||
const char *esp_hidh_dev_name_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the manufacturer of a HID Device
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: pointer to the character array
|
||||
*/
|
||||
const char *esp_hidh_dev_manufacturer_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the serial number of a HID Device
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: pointer to the character array or NULL
|
||||
*/
|
||||
const char *esp_hidh_dev_serial_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the VID of a HID Device
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: the VID value
|
||||
*/
|
||||
uint16_t esp_hidh_dev_vendor_id_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the PID of a HID Device
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: the PID value
|
||||
*/
|
||||
uint16_t esp_hidh_dev_product_id_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the version HID Device
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: the version value
|
||||
*/
|
||||
uint16_t esp_hidh_dev_version_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get the appearance of BLE HID Device
|
||||
* @param dev : pointer to the BLE HID Device
|
||||
*
|
||||
* @return: the appearance value
|
||||
*/
|
||||
uint16_t esp_hidh_dev_appearance_get(esp_hidh_dev_t *dev); //BLE Only
|
||||
|
||||
/**
|
||||
* @brief Get the calculated HID Device usage type
|
||||
* @param dev : pointer to the HID Device
|
||||
*
|
||||
* @return: the hid usage type
|
||||
*/
|
||||
esp_hid_usage_t esp_hidh_dev_usage_get(esp_hidh_dev_t *dev);
|
||||
|
||||
/**
|
||||
* @brief Get an array of all reports found on a device
|
||||
* @param dev : pointer to the device
|
||||
* @param num_reports : pointer to the value that will be set to the number of reports
|
||||
* @param reports : location to set to the pointer of the reports array
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_dev_reports_get(esp_hidh_dev_t *dev, size_t *num_reports, esp_hid_report_item_t **reports);
|
||||
|
||||
/**
|
||||
* @brief Get an array of the report maps found on a device
|
||||
* @param dev : pointer to the device
|
||||
* @param num_maps : pointer to the value that will be set to the number of report maps found
|
||||
* @param maps : location to set to the pointer of the report maps array
|
||||
*
|
||||
* @return: ESP_OK on success
|
||||
*/
|
||||
esp_err_t esp_hidh_dev_report_maps_get(esp_hidh_dev_t *dev, size_t *num_maps, esp_hid_raw_report_map_t **maps);
|
||||
|
||||
#include "esp_hidh_transport.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
Reference in New Issue
Block a user