HIDLCD
This driver library allows the host to communicate with HID-compliant Auxiliary Display for PC based on Arduino.
Classes | Macros | Enumerations | Functions
hidlcd.h File Reference

HIDLCD Driver API Header File. More...

#include <stdlib.h>
#include <string.h>
#include <hidapi/hidapi.h>
Include dependency graph for hidlcd.h:

Go to the source code of this file.

Classes

struct  HIDDisplayParams
 The structure holding the physical parameters and other capabilities of the LCD display. More...
 

Macros

#define HID_AUXD_ASCII_CHARSET   0x80
 Screen supports.
 
#define HID_AUXD_DATAREAD_BACK   0x40
 Character Report can be read back when set.
 
#define HID_AUXD_FONTREAD_BACK   0x20
 Font Report can be read back when set.
 
#define HID_AUXD_CLEAR   0x80
 Clear Display command.
 
#define HID_AUXD_ENABLE   0x40
 Display enable.
 
#define HID_AUXD_SSENABLE   0x20
 Screen Saver enable.
 
#define HID_AUXD_VSCROLL   0x10
 Vertical Scroll.
 
#define HID_AUXD_HSCROLL   0x08
 Horizintal Scroll.
 
#define HID_AUXD_DISABLE   0x0
 Display disable.
 
#define HID_ADCC_PIXELPOS   0x80
 Cursor Pixel Positioning.
 
#define HID_ADCC_INCREMENT   0x40
 Cursor Mode = Increment.
 
#define HID_ADCC_ENABLE   0x20
 Cursor Enable.
 
#define HID_ADCC_BLINK   0x10
 Cursor Blink.
 

Enumerations

enum  HID_AUXD_REPORT {
  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
}
 Supported HID reports for HID LCD Display. More...
 
enum  HID_ADCMD_MODE { HID_ADCMD_MODE_DEFAULT, HID_ADCMD_MODE_OFF, HID_ADCMD_MODE_OVERWRITE }
 Modes of setting the command flags to the LCD display. More...
 

Functions

HIDDisplayParams *HID_API_EXPORT HID_API_CALL hidlcd_get_display_params (hid_device *dev)
 Returns the physical parameters of the connected auxiliary LCD display. More...
 
HID_API_EXPORT hid_device *HID_API_CALL hidlcd_open (unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number)
 Returns the device handle. More...
 
void HID_API_EXPORT HID_API_CALL hidlcd_close (hid_device *dev)
 Closes the device handle and releases associated resources. More...
 
int HID_API_EXPORT HID_API_CALL hidlcd_exit (void)
 Closes the HIDLCD library and releases associated resources. More...
 
int HID_API_EXPORT HID_API_CALL hidlcd_init (void)
 Initialize the HIDLCD library. More...
 
int HID_API_EXPORT HID_API_CALL hidlcd_set_cursor (hid_device *dev, u_int8_t row, u_int8_t col)
 This function sets the cursor of the LCD display in the specified position. More...
 
int HID_API_EXPORT HID_API_CALL hidlcd_set_cursor_flags_ext (hid_device *dev, u_int8_t flags, HID_ADCMD_MODE mode)
 This function sets the cursor extended parameters and display mode. More...
 
int HID_API_EXPORT HID_API_CALL hidlcd_print (hid_device *dev, HIDDisplayParams *display_params, const char *string)
 Prints the text on the LCD screen. More...
 
int HID_API_EXPORT HID_API_CALL hidlcd_send_command_ext (hid_device *dev, u_int8_t command, HID_ADCMD_MODE mode)
 Sends the command to the LCD display with mode. More...
 
int HID_API_EXPORT HID_API_CALL hidlcd_send_command (hid_device *dev, u_int8_t command)
 Sends the command to the LCD display. More...
 

Detailed Description

HIDLCD Driver API Header File.

Author
Alex Bratchik

Enumeration Type Documentation

◆ HID_AUXD_REPORT

Supported HID reports for HID LCD Display.

Enumerator
HID_AUXD_DISPLAY_PARAMS 

Display parameters report.

HID_AUXD_CURSOR_POS 

Cursor position report.

HID_AUXD_CHAR_REPORT 

Character report.

HID_AUXD_FONT_REPORT 

Font report.

HID_AUXD_CTRL_REPORT 

Control report.

HID_AUXD_CURSOR_FLAGS 

Cursor flags.