hidapi.h

Go to the documentation of this file.

/*******************************************************
 HIDAPI - Multi-Platform library for
 communication with HID devices.
 
 Alan Ott
 Signal 11 Software
 
 libusb/hidapi Team
 
 Copyright 2023, All Rights Reserved.
 
 At the discretion of the user of this library,
 this software may be licensed under the terms of the
 GNU General Public License v3, a BSD-Style license, or the
 original HIDAPI license as outlined in the LICENSE.txt,
 LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt
 files located at the root of the source distribution.
 These files may also be found in the public source
 code repository located at:
        https://github.com/libusb/hidapi .
********************************************************/
 
#ifndef HIDAPI_H__
#define HIDAPI_H__
 
#include <wchar.h>
 
/* #480: this is to be refactored properly for v1.0 */
#ifdef _WIN32
   #ifndef HID_API_NO_EXPORT_DEFINE
      #define HID_API_EXPORT __declspec(dllexport)
   #endif
#endif
#ifndef HID_API_EXPORT
   #define HID_API_EXPORT 
#endif
/* To be removed in v1.0 */
#define HID_API_CALL 
#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL 
#define HID_API_VERSION_MAJOR 0
#define HID_API_VERSION_MINOR 15
#define HID_API_VERSION_PATCH 0
 
/* Helper macros */
#define HID_API_AS_STR_IMPL(x) #x
#define HID_API_AS_STR(x) HID_API_AS_STR_IMPL(x)
#define HID_API_TO_VERSION_STR(v1, v2, v3) HID_API_AS_STR(v1.v2.v3)
 
#define HID_API_MAKE_VERSION(mj, mn, p) (((mj) << 24) | ((mn) << 8) | (p))
 
#define HID_API_VERSION HID_API_MAKE_VERSION(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)
 
#define HID_API_VERSION_STR HID_API_TO_VERSION_STR(HID_API_VERSION_MAJOR, HID_API_VERSION_MINOR, HID_API_VERSION_PATCH)
 
#define HID_API_MAX_REPORT_DESCRIPTOR_SIZE 4096
 
#ifdef __cplusplus
extern "C" {
#endif
                struct hid_api_version {
                        int major; 
                        int minor; 
                        int patch; 
                };
 
                struct hid_device_;
                typedef struct hid_device_ hid_device; 
                typedef enum {
                        HID_API_BUS_UNKNOWN = 0x00,
 
                        HID_API_BUS_USB = 0x01,
 
                        HID_API_BUS_BLUETOOTH = 0x02,
 
                        HID_API_BUS_I2C = 0x03,
 
                        HID_API_BUS_SPI = 0x04,
                } hid_bus_type;
 
                struct hid_device_info {
                        char *path;
                        unsigned short vendor_id;
                        unsigned short product_id;
                        wchar_t *serial_number;
                        unsigned short release_number;
                        wchar_t *manufacturer_string;
                        wchar_t *product_string;
                        unsigned short usage_page;
                        unsigned short usage;
                        int interface_number;
 
                        struct hid_device_info *next;
 
                        hid_bus_type bus_type;
                };
 
 
                int HID_API_EXPORT HID_API_CALL hid_init(void);
 
                int HID_API_EXPORT HID_API_CALL hid_exit(void);
 
                struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id);
 
                void  HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs);
 
                HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number);
 
                HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path);
 
                int  HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length);
 
                int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds);
 
                int  HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length);
 
                int  HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock);
 
                int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length);
 
                int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length);
 
                int HID_API_EXPORT HID_API_CALL hid_send_output_report(hid_device* dev, const unsigned char* data, size_t length);
 
                int HID_API_EXPORT HID_API_CALL hid_get_input_report(hid_device *dev, unsigned char *data, size_t length);
 
                void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev);
 
                int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen);
 
                int HID_API_EXPORT_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen);
 
                int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen);
 
                struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_get_device_info(hid_device *dev);
 
                int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen);
 
                int HID_API_EXPORT_CALL hid_get_report_descriptor(hid_device *dev, unsigned char *buf, size_t buf_size);
 
                HID_API_EXPORT const wchar_t* HID_API_CALL hid_error(hid_device *dev);
 
                HID_API_EXPORT const  struct hid_api_version* HID_API_CALL hid_version(void);
 
 
                HID_API_EXPORT const char* HID_API_CALL hid_version_str(void);
 
#ifdef __cplusplus
}
#endif
 
#endif