hidapi.h

Go to the documentation of this file.

/*
 HIDAPI - Multi-Platform library for communication with HID devices.
 
 Copyright (c) 2009 by Alan Ott, Signal 11 Software (8/22/2009)
 All Rights Reserved.
 
 Changes for use with SX Filter Wheel INDI Driver by CloudMakers - 11/6/2012
 
 This program is free software; you can redistribute it and/or modify it
 under the terms of the GNU General Public License as published by the Free
 Software Foundation; either version 2 of the License, or (at your option)
 any later version.
 
 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 more details.
 
 You should have received a copy of the GNU General Public License along with
 this program; if not, write to the Free Software Foundation, Inc., 59
 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 The full GNU General Public License is included in this distribution in the
 file called LICENSE.
 
 These files may also be found in the public source code repository located:
 http://github.com/signal11/hidapi
*/
 
#pragma once
 
#include <wchar.h>
 
#ifdef _WIN32
#define HID_API_EXPORT __declspec(dllexport)
#define HID_API_CALL
#else
#define HID_API_EXPORT 
#define HID_API_CALL   
#endif
 
#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL 
#ifdef __cplusplus
extern "C" {
#endif
struct hid_device_;
typedef struct hid_device_ hid_device; 
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;
};
 
int HID_API_EXPORT HID_API_CALL hid_init();
 
int HID_API_EXPORT HID_API_CALL hid_exit();
 
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 *device, 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 *device, unsigned char *data, size_t length);
 
int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *device, int nonblock);
 
int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *device, const unsigned char *data, size_t length);
 
int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *device, unsigned char *data, size_t length);
 
void HID_API_EXPORT HID_API_CALL hid_close(hid_device *device);
 
int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *device, wchar_t *string, size_t maxlen);
 
int HID_API_EXPORT_CALL hid_get_product_string(hid_device *device, wchar_t *string, size_t maxlen);
 
int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *device, wchar_t *string, size_t maxlen);
 
int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *device, int string_index, wchar_t *string, size_t maxlen);
 
HID_API_EXPORT const wchar_t *HID_API_CALL hid_error(hid_device *device);
 
#ifdef __cplusplus
}
#endif