hidlcd.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 abratchik
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

/* 
 * File:   hidlcd.h
 * Author: abratchik
 *
 * Created on November 12, 2021, 5:48 PM
 */

#ifndef HIDLCD_H
#define HIDLCD_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdlib.h>
#include <string.h>
#include <hidapi/hidapi.h>

// Display params flags
#define HID_AUXD_ASCII_CHARSET      0x80 
#define HID_AUXD_DATAREAD_BACK      0x40 
#define HID_AUXD_FONTREAD_BACK      0x20 

// Display control flags
#define HID_AUXD_CLEAR              0x80 
#define HID_AUXD_ENABLE             0x40 
#define HID_AUXD_SSENABLE           0x20 
#define HID_AUXD_VSCROLL            0x10 
#define HID_AUXD_HSCROLL            0x08 
#define HID_AUXD_DISABLE            0x0  
    
// Cursor control flags
#define HID_ADCC_PIXELPOS           0x80 
#define HID_ADCC_INCREMENT          0x40 
#define HID_ADCC_ENABLE             0x20 
#define HID_ADCC_BLINK              0x10 


typedef enum {
    HID_AUXD_DISPLAY_PARAMS = 0x01, 
    HID_AUXD_CURSOR_POS     = 0x02, 
    HID_AUXD_CHAR_REPORT    = 0x03, 
    HID_AUXD_FONT_REPORT    = 0x04, 
    HID_AUXD_CTRL_REPORT    = 0x05, 
    HID_AUXD_CURSOR_FLAGS   = 0x06  
} HID_AUXD_REPORT;    
    
typedef enum {
    HID_ADCMD_MODE_DEFAULT,     
    HID_ADCMD_MODE_OFF,         
    HID_ADCMD_MODE_OVERWRITE    
} HID_ADCMD_MODE;   

typedef struct
{
  u_int8_t rows;     
  u_int8_t cols;     
  u_int8_t chrw;     
  u_int8_t chrh;     
  u_int8_t flags;    
} HIDDisplayParams;

HIDDisplayParams* HID_API_EXPORT HID_API_CALL hidlcd_get_display_params(hid_device *dev);

HID_API_EXPORT hid_device * HID_API_CALL hidlcd_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number);

void HID_API_EXPORT HID_API_CALL hidlcd_close(hid_device *dev);

int HID_API_EXPORT HID_API_CALL hidlcd_exit(void);

int HID_API_EXPORT HID_API_CALL hidlcd_init(void);

int HID_API_EXPORT HID_API_CALL hidlcd_set_cursor(hid_device *dev, u_int8_t row, u_int8_t col);

int HID_API_EXPORT HID_API_CALL hidlcd_set_cursor_flags_ext(hid_device *dev, u_int8_t flags, HID_ADCMD_MODE mode);

int HID_API_EXPORT HID_API_CALL hidlcd_print(hid_device *dev, 
                                            HIDDisplayParams *display_params, 
                                            const char *string);

int HID_API_EXPORT HID_API_CALL hidlcd_send_command_ext(hid_device *dev, u_int8_t command, HID_ADCMD_MODE mode);

int HID_API_EXPORT HID_API_CALL hidlcd_send_command(hid_device *dev, u_int8_t command);



#ifdef __cplusplus
}
#endif

#endif /* HIDLCD_H */