scriptel-hid-reports.h

Go to the documentation of this file.

/*******************************************************************************
 * scriptel-hid-reports.h - Copyright 2014 - Scriptel Corporation
 * ----
 * This header contains information about how to interact with ScripTouch
 * devices. Data structures and constants used by the devices are stored here.
 ******************************************************************************/
 
#ifndef _SCRIPTEL_HID_REPORTS_H_
#define _SCRIPTEL_HID_REPORTS_H_
 
#define SCRIPTEL_REGION_BASE_SIZE 28
 
typedef enum {
    SCRIPTEL_FEATURE_RUNMODE = 10,
    SCRIPTEL_FEATURE_CAPABILITIES = 11,
    SCRIPTEL_FEATURE_DEVICE_STATUS = 13,
    SCRIPTEL_FEATURE_DEVICECONFIGURE = 15,
    SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM = 16,
    SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE = 20,
    SCRIPTEL_FEATURE_POWERSTATE = 21,
    SCRIPTEL_FEATURE_VERSIONINFO = 22,
    SCRIPTEL_FEATURE_COORDINATERANGE = 23,
    SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD = 25,
    SCRIPTEL_FEATURE_ERRORCORRECTION = 26,
    SCRIPTEL_FEATURE_SERIALNUMBER = 27,
    SCRIPTEL_FEATURE_SAVECONFIGURATION = 28,
    SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS = 29,
    SCRIPTEL_FEATURE_OPERATINGMODE = 40,
    SCRIPTEL_FEATURE_GENERALPARAMETERS = 41,
    SCRIPTEL_FEATURE_ASICRESET = 42,
    SCRIPTEL_FEATURE_REGISTERGET = 43,
    SCRIPTEL_FEATURE_REGISTERSET = 44,
    SCRIPTEL_FEATURE_PENPARAMETERS = 50,
    SCRIPTEL_FEATURE_TOUCHPARAMETERS = 60,
    SCRIPTEL_FEATURE_OUTPUTCONFIGURATION = 91,
    SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION = 92,
    SCRIPTEL_FEATURE_CALIBRATION_DATA = 131,
    SCRIPTEL_FEATURE_DISPLAYINFO = 100,
    SCRIPTEL_FEATURE_DISPLAYCONTENT = 101,
    SCRIPTEL_FEATURE_DISPLAYSETTINGS = 102,
    SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK = 103,
    SCRIPTEL_FEATURE_REGIONGET = 110,
    SCRIPTEL_FEATURE_REGIONGETDEFAULT = 111,
    SCRIPTEL_FEATURE_REGIONSET = 112,
    SCRIPTEL_FEATURE_REGIONUPDATE = 113,
    SCRIPTEL_FEATURE_REGIONDELETE = 114,
    SCRIPTEL_FEATURE_REGIONEDITCOMPLETE = 115,
    SCRIPTEL_FEATURE_CALIBRATE = 130,
    SCRIPTEL_FEATURE_RESOURCE_IDX = 140,
    SCRIPTEL_FEATURE_RESOURCE_INFO = 141,
    SCRIPTEL_FEATURE_RESOURCE = 142,
    SCRIPTEL_FEATURE_DELETE_RESOURCE = 143,
    SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY = 144,
    SCRIPTEL_FEATURE_REGION_IDX = 150,
    SCRIPTEL_FEATURE_REGION = 152,
    SCRIPTEL_FEATURE_DELETE_REGION = 153,
    SCRIPTEL_FEATURE_SCREEN_IDX = 160,
    SCRIPTEL_FEATURE_SCREEN = 162,
    SCRIPTEL_FEATURE_DELETE_SCREEN = 163,
    SCRIPTEL_FEATURE_MODIFY_SCREEN = 164,
    SCRIPTEL_FEATURE_SCREEN_REGION_INFO = 170,
    SCRIPTEL_FEATURE_ACTIVE_SCREEN = 171,
    SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD = 172,
    SCRIPTEL_INPUT_COORDINATE = 1,
    SCRIPTEL_INPUT_EXTENDEDCOORDINATE = 2,
    SCRIPTEL_INPUT_ADCVALUES = 3,
    SCRIPTEL_INPUT_MOUSECOORDINATE = 4,
    SCRIPTEL_INPUT_DIGITIZERPENCOORDINATE = 5,
    SCRIPTEL_INPUT_DIGITIZERTOUCHCOORDINATE = 6,
    SCRIPTEL_INPUT_KEYBOARD = 7,
    SCRIPTEL_INPUT_MULTITOUCHCOORDINATE = 8,
    SCRIPTEL_INPUT_MAGCARDDATA = 12,
    SCRIPTEL_INPUT_DEBUGCOORDINATE = 254,
    SCRIPTEL_FEATURE_ENGINEERING_TEST = 253,
    SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION = 104,
    SCRIPTEL_FEATURE_PIXELS = 105,
 
    SCRIPTEL_INPUT_BUTTONDOWN = 250,
    SCRIPTEL_INPUT_BUTTONMOVE = 251,
    SCRIPTEL_INPUT_BUTTONUP = 252,
    SCRIPTEL_INPUT_BUTTONPRESS = 253,   // note this is overloaded with a real feature report
    SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS = 230
} scriptel_hid_report_id;
 
 typedef enum {
     SCRIPTEL_OUTPUT_CONFIGURATION_OEM = 0x00000001,
     SCRIPTEL_OUTPUT_CONFIGURATION_OEM_EXTENDED = 0x00000002,
     SCRIPTEL_OUTPUT_CONFIGURATION_MOUSE = 0x00000100,
     SCRIPTEL_OUTPUT_CONFIGURATION_PEN_DIGITIZER = 0x00000200,
     SCRIPTEL_OUTPUT_CONFIGURATION_TOUCH = 0x00000400,
     SCRIPTEL_OUTPUT_CONFIGURATION_KEYBOARD = 0x00010000,
     SCRIPTEL_OUTPUT_CONFIGURATION_RAW_DATA = 0x40000000,
     SCRIPTEL_OUTPUT_CONFIGURATION_DEBUG_DATA = 0x80000000
 } scriptel_ouput_configuration_flags;
 
typedef enum {
    SCRIPTEL_FEATURE_RUNMODE_SIZE = 2,
    SCRIPTEL_FEATURE_CAPABILITIES_SIZE = 65,
    SCRIPTEL_FEATURE_DEVICECONFIGURE_SIZE = 3,
    SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM_SIZE = 2,
    SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE_SIZE = 4,
    SCRIPTEL_FEATURE_POWERSTATE_SIZE = 2,
    SCRIPTEL_FEATURE_VERSIONINFO_SIZE = 9,
    SCRIPTEL_FEATURE_COORDINATERANGE_SIZE = 9,
    SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD_SIZE = 134,
    SCRIPTEL_FEATURE_ERRORCORRECTION_SIZE = 2049,
    SCRIPTEL_FEATURE_SERIALNUMBER_SIZE = 35,
    SCRIPTEL_FEATURE_SAVECONFIGURATION_SIZE = 2,
    SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS_SIZE = 3,
    SCRIPTEL_FEATURE_OPERATINGMODE_SIZE = 5,
    SCRIPTEL_FEATURE_GENERALPARAMETERS_SIZE = 6,
    SCRIPTEL_FEATURE_ASICRESET_SIZE = 2,
    SCRIPTEL_FEATURE_REGISTERGET_SIZE = 9,
    SCRIPTEL_FEATURE_REGISTERSET_SIZE = 3,
    SCRIPTEL_FEATURE_PENPARAMETERS_SIZE = 18,
    SCRIPTEL_FEATURE_TOUCHPARAMETERS_SIZE = 22,
    SCRIPTEL_FEATURE_OUTPUTCONFIGURATION_SIZE = 10,
    SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION_SIZE = 17,
    SCRIPTEL_FEATURE_DEVICE_STATUS_SIZE= 73,
     SCRIPTEL_FEATURE_CALIBRATION_DATA_SIZE = 49,
    SCRIPTEL_FEATURE_DISPLAYINFO_SIZE = 10,
    SCRIPTEL_FEATURE_DISPLAYCONTENT_SIZE = 2,
    SCRIPTEL_FEATURE_DISPLAYSETTINGS_SIZE = 7,
    SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK_SIZE = 2049,
    SCRIPTEL_FEATURE_REGIONUPDATE_SIZE = 12,
    SCRIPTEL_FEATURE_REGIONDELETE_SIZE = 2,
    SCRIPTEL_FEATURE_REGIONEDITCOMPLETE_SIZE = 2,
    SCRIPTEL_FEATURE_RESOURCE_IDX_SIZE = 2,
    SCRIPTEL_FEATURE_RESOURCE_INFO_SIZE = 20,
    SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY_SIZE = 18,
    SCRIPTEL_FEATURE_RESOURCE_SIZE = 1045,
    SCRIPTEL_FEATURE_DELETE_RESOURCE_SIZE = 2,
    SCRIPTEL_FEATURE_REGION_IDX_SIZE = 2,
    SCRIPTEL_FEATURE_SCREEN_IDX_SIZE = 2,
    SCRIPTEL_FEATURE_DELETE_REGION_SIZE = 2,
    SCRIPTEL_FEATURE_SCREEN_SIZE = 80,
    SCRIPTEL_FEATURE_DELETE_SCREEN_SIZE = 2,
    SCRIPTEL_FEATURE_MODIFY_SCREEN_SIZE = 13,
    SCRIPTEL_FEATURE_SCREEN_REGION_INFO_SIZE = 25,
    SCRIPTEL_FEATURE_ACTIVE_SCREEN_SIZE = 2,
    SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD_SIZE = 2,
    SCRIPTEL_FEATURE_CALIBRATE_SIZE = 2,
    SCRIPTEL_INPUT_COORDINATE_SIZE = 6,
    SCRIPTEL_INPUT_EXTENDEDCOORDINATE_SIZE = 7,
    SCRIPTEL_INPUT_ADCVALUES_SIZE = 11,
    SCRIPTEL_INPUT_MAGCARDDATA_SIZE = 231,
    SCRIPTEL_INPUT_DEBUGCOORDINATE_SIZE = 22,
    SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION_SIZE = 5,
    SCRIPTEL_FEATURE_PIXELS_SIZE = 1031,
    SCRIPTEL_FEATURE_ENGINEERING_TEST_SIZE = 67,
    SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS_SIZE = 69
} scriptel_hid_report_size;
 
typedef enum {
    SCRIPTEL_RUNMODE_COMMAND = 0,
    SCRIPTEL_RUNMODE_TOUCH = 1,
    SCRIPTEL_RUNMODE_PEN = 2,
    SCRIPTEL_RUNMODE_AUTOTOUCH = 4,
    SCRIPTEL_RUNMODE_TOUCHSINGLE = 8,
    SCRIPTEL_RUNMODE_TOUCHSTREAM = 10,
    SCRIPTEL_RUNMODE_PENSINGLE = 16,
    SCRIPTEL_RUNMODE_PENSTREAM = 18,
    SCRIPTEL_RUNMODE_PENCONTINUOUS = 20
} scriptel_device_run_mode;
 
typedef enum {
    SCRIPTEL_ACQMODE_TOUCH = 0,
    SCRIPTEL_ACQMODE_PEN = 1,
    SCRIPTEL_ACQMODE_AUTOTOUCH = 2,
    SCRIPTEL_ACQMODE_COMMAND = 3
} scriptel_device_acquisition_mode;
 
typedef enum {
    SCRIPTEL_PTMODE_SINGLE = 0,
    SCRIPTEL_PTMODE_SINGLE_LIFTOFF = 1,
    SCRIPTEL_PTMODE_STREAM = 2,
    SCRIPTEL_PTMODE_STREAM_LIFTOFF = 3,
    SCRIPTEL_PTMODE_CONTINUOUS = 4
} scriptel_device_pentouch_mode;
 
typedef enum {
    SCRIPTEL_REGION_TYPE_CONTAINER = 0,
    SCRIPTEL_REGION_TYPE_BUTTON = 1,
    SCRIPTEL_REGION_TYPE_LINE = 2,
    SCRIPTEL_REGION_TYPE_GRAPHIC = 3,
    SCRIPTEL_REGION_TYPE_TEXT = 4,
    SCRIPTEL_REGION_TYPE_NULL = 0xFF
} scriptel_region_type;
 
typedef enum {
    REAL_TIME = 0,
    TRANSMIT_ON_CONFIRM = 1,
    TRANSMIT_ON_HOST_COMMAND = 2
} scriptel_output_mode;
 
typedef enum {
    SCRIPTEL_OUTPUT_UNCOMPRESSED_LORES = 0,
    SCRIPTEL_OUTPUT_COMPRESSED_LORES = 1,
    SCRIPTEL_OUTPUT_UNCOMPRESSED_HIRES = 2,
    SCRIPTEL_OUTPUT_COMPRESSED_HIRES = 3
} scriptel_compression_mode;
 
typedef enum {
    SCRIPTEL_MAG_CARD_OEM_FORMAT = 0x01,
    SCRIPTEL_MAG_CARD_KEYBOARD = 0x04,
    SCRIPTEL_MAG_CARD_KEYBOARD_PREAMBLE = 0x08
} scriptel_mag_card_output;
 
typedef enum scriptel_displaysettings_command {
    SCRIPTEL_COMMAND_RUNTIME = 0,
    SCRIPTEL_COMMAND_COMMIT = 1,
    SCRIPTEL_COMMAND_RESTORE_DEFAULTS = 128
} scriptel_displaysettings_command;
 
typedef struct {
    unsigned char down;
    unsigned char reserved1;
    unsigned char data_source;
    unsigned char reserved2;
} scriptel_sample_info_common;
 
typedef struct {
    unsigned char tip_switch;
    unsigned char reserved1;
    unsigned char data_source;
    unsigned char reserved2;
} scriptel_sample_info_pen;
 
typedef struct {
    unsigned char contact;
    unsigned char contact_id;
    unsigned char reserved1;
    unsigned char data_source;
    unsigned char reserved2;
} scriptel_sample_info_touch;
 
typedef union {
    scriptel_sample_info_common common;
    scriptel_sample_info_pen pen;
    scriptel_sample_info_touch touch;
} scriptel_sample_info;
 
typedef struct {
    unsigned char report_id;
    scriptel_sample_info sample_info;
    unsigned short x;
    unsigned short y;
} scriptel_hid_input_coordinate;
 
typedef struct {
    unsigned char report_id;
    scriptel_sample_info sample_info;
    unsigned short x;
    unsigned short y;
    unsigned char region;
} scriptel_hid_input_extended_coordinate;
 
typedef enum {
    SCRIPTEL_ADC_DATA_TYPE_SCAN = 2,
    SCRIPTEL_ADC_DATA_TYPE_CHANNEL = 3
} scriptel_adc_data_type;
 
typedef struct {
    unsigned char report_id;
    scriptel_adc_data_type data_type;
    union {
        struct {
            scriptel_sample_info sample_info;
            unsigned short x_max;
            unsigned short x_min;
            unsigned short y_max;
            unsigned short y_min;
        } scan_values;
        struct {
            unsigned char channel_number;
            unsigned short sample1;
            unsigned short sample2;
            unsigned short sample3;
            unsigned short sample4;
        } channel_values;
    } adc_data;
} scriptel_hid_input_adc_values;
 
typedef enum {
    SCRIPTEL_CARDSWIPE_TYPE_FINANCIAL = 0x01,
    SCRIPTEL_CARDSWIPE_TYPE_IDENTIFICATION = 0x02,
    SCRIPTEL_CARDSWIPE_TYPE_UNKNOWN = 0xFF
} scriptel_cardswipe_type;
 
typedef enum {
    SCRIPTEL_CARDSWIPE_STATUS_VALID = 0x00,
    SCRIPTEL_CARDSWIPE_STATUS_PARITY_ERROR = 0x01,
    SCRIPTEL_CARDSWIPE_STATUS_UNKNOWN_FORMAT = 0x10,
    SCRIPTEL_CARDSWIPE_STATUS_CORRUPT = 0x11
} scriptel_cardswipe_track_status;
 
typedef enum {
    SCRIPTEL_ASIC_POWER_STATE_NORMAL = 0,
    SCRIPTEL_ASIC_POWER_STATE_POWERDOWN = 1,
    SCRIPTEL_ASIC_POWER_STATE_STANDBY = 2
} scriptel_asic_power_state;
 
typedef enum {
    SCRIPTEL_CALIBRATION_POINT_CENTER = 0,
    SCRIPTEL_CALIBRATION_POINT_UPPERLEFT = 2,
    SCRIPTEL_CALIBRATION_POINT_LOWERLEFT = 4,
    SCRIPTEL_CALIBRATION_POINT_LOWERRIGHT = 6,
    SCRIPTEL_CALIBRATION_POINT_UPPERRIGHT = 8
} scriptel_calibration_point;
 
typedef enum {
    SCRIPTEL_LOCATION_1_STYLUS_DOWN = 0,
    SCRIPTEL_LOCATION_1_STYLUS_UP = 1,
    SCRIPTEL_LOCATION_2_STYLUS_DOWN = 2,
    SCRIPTEL_LOCATION_2_STYLUS_UP = 3
}scriptel_tuning_state;
 
typedef struct {
    unsigned char report_id;
    scriptel_cardswipe_type card_format;
    scriptel_cardswipe_track_status track1_status;
    scriptel_cardswipe_track_status track2_status;
    scriptel_cardswipe_track_status track3_status;
    unsigned char track1[79];
    unsigned char track2[40];
    unsigned char track3[107];
} scriptel_hid_input_card_swipe;
 
typedef struct {
    unsigned char report_id;
    scriptel_sample_info sample_info;
    unsigned short offset;
    unsigned short x_max;
    unsigned short x_min;
    unsigned short y_max;
    unsigned short y_min;
    unsigned short x_errcor;
    unsigned short y_errcor;
    unsigned short x_mapped;
    unsigned short y_mapped;
    unsigned char region;
} scriptel_hid_input_debug_coordinate;
 
typedef struct {
    unsigned char report_id;
    scriptel_device_run_mode run_mode;
} scriptel_hid_feature_run_mode;
 
typedef enum {
    SCRIPTEL_SUPPORTED_REPORTS_HID = 1,
    SCRIPTEL_SUPPORTED_REPORTS_MOUSE = 2,
    SCRIPTEL_SUPPORTED_REPORTS_PEN = 4,
    SCRIPTEL_SUPPORTED_REPORTS_TOUCH = 8,
    SCRIPTEL_SUPPORTED_REPORTS_KEYBOARD = 16
} scriptel_supported_reports;
 
typedef enum {
    SCRIPTEL_MODE_STREAMING = 0x01,
    SCRIPTEL_MODE_BUFFERING = 0x02,
    SCRIPTEL_MODE_COMPRESSION = 0x04,
    SCRIPTEL_MODE_THROTTLING = 0x08
} scriptel_supported_transfer_modes;
 
typedef enum {
    SCRIPTEL_DISPLAY_TYPE_NONE = 0,
    SCRIPTEL_DISPLAY_TYPE_240X64_1X5_BLACKWHITE = 1,
    SCRIPTEL_DISPLAY_TYPE_240X64_1X5_GRAYSCALE = 2
} scriptel_display_type;
 
typedef enum {
    SCRIPTEL_CARDREADER_NONE = 0,
    SCRIPTEL_CARDREADER_HID = 1,
    SCRIPTEL_CARDREADER_KEYBOARD_BASIC = 2,
    SCRIPTEL_CARDREADER_KEYBOARD_PREAMBLE = 3,
    SCRIPTEL_CARDREADER_INTERCHANGEABLE = 131,
    SCRIPTEL_MAG_CARDREADER_HID = 0x01,
    SCRIPTEL_MAG_CARDREADER_KEYBOARD = 0x02,
    SCRIPTEL_MAG_CARDREADER_CHANGEABLE = 0x80
} scriptel_card_reader;
 
typedef enum {
    SCRIPTEL_ENGINEERING_TEST_DISPLAY = 1,  // Mike Bodnar calls this 'Local'
    SCRIPTEL_ENGINEERING_TEST_NATIVE = 2    // Mike Bodnar calls this 'Host'
} scriptel_engineering_test;
 
 
typedef struct {
    unsigned char report_id;
    unsigned short supported_reports;
    unsigned char coordinate_modes;
    unsigned char reserved1;
    scriptel_display_type display_id;
    unsigned char brightness_levels;
    unsigned char contrast_levels;
    unsigned char color_depth;
    unsigned short display_width;
    unsigned short display_height;
    unsigned short digitizer_width;
    unsigned short digitizer_height;
    unsigned short coordinate_xmin;
    unsigned short coordinate_xmax;
    unsigned short coordinate_ymin;
    unsigned short coordinate_ymax;
    unsigned short calibration_xmin;
    unsigned short calibration_xmax;
    unsigned short calibration_ymin;
    unsigned short calibration_ymax;
    unsigned int reserved_4;
    unsigned int reserved_5;
    scriptel_card_reader mag_reader_id;
    unsigned char reserved_6;
    unsigned short reserved_7;
    unsigned char supports_screens_resources;
    unsigned char reserved_9;
    unsigned int reserved_10;
    unsigned int reserved_11;
    unsigned int reserved_12;
    unsigned int reserved_13;
    unsigned int reserved_14;
} scriptel_hid_capabilities;
typedef struct {
    unsigned char report_id;
    unsigned char device_mode;
    unsigned char device_id;
} scriptel_hid_feature_device_configure;
 
typedef struct {
    unsigned char report_id;
    unsigned char contact_count_max;
} scriptel_hid_feature_contact_count_maximum;
 
typedef struct {
    unsigned char report_id;
    unsigned char frequency;
    unsigned char pen_amplitude;
    unsigned char touch_amplitude;
} scriptel_hid_feature_frequency_amplitude;
 
typedef struct {
    unsigned char report_id;
    unsigned char command_id;
    unsigned char tuning_mode;
    unsigned char tuning_aborted;
    scriptel_tuning_state tuning_state;
    unsigned char gain_setting;
} scriptel_hid_feature_tuning_status;
 
typedef struct {
    unsigned char report_id;
    scriptel_asic_power_state power_state;
} scriptel_hid_feature_power_state;
 
typedef struct {
    unsigned char report_id;
    unsigned char kernel_version[3];
    unsigned char firmware_version[3];
    unsigned short asic_signature;
} scriptel_hid_feature_version;
 
typedef struct {
    unsigned char report_id;
    unsigned short x_min;
    unsigned short x_max;
    unsigned short y_min;
    unsigned short y_max;
} scriptel_hid_feature_coordinate_range;
 
typedef struct {
    unsigned char report_id;
    unsigned int address;
    unsigned char data[128];
    unsigned char checksum;
} scriptel_hid_feature_firmware_download;
 
typedef struct {
    unsigned char report_id;
    unsigned char data[2048];
} scriptel_hid_feature_error_correction_table;
 
typedef struct {
    unsigned char report_id;
    unsigned char guid[16];
} scriptel_hid_feature_guid;
 
typedef struct {
    unsigned char report_id;
    unsigned char serial_number[32];
    unsigned char write_key_1;
    unsigned char write_key_2;
} scriptel_hid_feature_serial_number;
 
typedef struct {
    unsigned char report_id;
    scriptel_device_acquisition_mode startup_mode;
} scriptel_hid_feature_save_configuration;
 
typedef struct {
    unsigned char report_id;
    unsigned short command_status;
} scriptel_hid_feature_download_command_status;
 
typedef struct {
    unsigned char report_id;
    unsigned char supported_modes;
    unsigned char reserved;
    unsigned char acquisition_mode;
    unsigned char touch_mode;
    unsigned char pen_mode;
} scriptel_hid_feature_operating_modes;
 
typedef struct {
    unsigned char report_id;
    unsigned char xy_output_enable;
    unsigned char adc_output_enable;
    unsigned char map_coordinates;
    unsigned char channel_lock_enable;
    unsigned char channel_lock_number;
    unsigned char reserved;
    unsigned char corner_lower_left;
    unsigned char corner_upper_left;
    unsigned char corner_lower_right;
    unsigned char corner_upper_right;
    unsigned short samples;
    unsigned char filter_frequency;
} scriptel_hid_feature_general_parameters;
 
typedef struct {
    unsigned char report_id;
    unsigned char hardware_reset;
    unsigned char reserved;
} scriptel_hid_feature_asic_reset;
 
typedef struct {
    unsigned char report_id;
    unsigned char register_info[8];
} scriptel_hid_feature_register_get;
 
typedef struct {
    unsigned char report_id;
    unsigned char register_id;
    unsigned char register_value;
} scriptel_hid_feature_register_set;
 
typedef struct {
    unsigned char report_id;
    unsigned short proximity;
    unsigned short auto_pen_threshold;
    unsigned short auto_touch_threshold;
    unsigned char adc_average;
    unsigned char coordinate_average;
    unsigned short offset_interval;
    unsigned char debounce_pre_down;
    unsigned char debounce_post_down;
    unsigned char debounce_pre_up;
    unsigned char debounce_post_up;
    unsigned char error_correction_enable;
    unsigned char reserved_1;
    unsigned char offset_correction_enable;
    unsigned char reserved_2;
    unsigned char tip_inverted;
    unsigned char reserved_3;
    unsigned short interrupt_rate;
} scriptel_hid_feature_pen_parameters;
 
typedef struct {
    unsigned char report_id;
    unsigned short start_x;
    unsigned short start_y;
} scriptel_hid_feature_pixel_retrieval_location;
 
typedef struct {
    unsigned char a;
    unsigned char r;
    unsigned char g;
    unsigned char b;
} argb;
 
typedef struct {
    unsigned char report_id;
    unsigned short start_x;
    unsigned short start_y;
    unsigned short number_of_pixels;
    union color_data {
        unsigned long composit[256];
        argb color[256];
    } color_data;
} scriptel_hid_feature_pixel_values;
 
typedef struct {
    unsigned char report_id;
    unsigned char adc_average;
    unsigned char coordinate_average;
    short slope_down;
    short slope_liftoff;
    unsigned char slope_minimum;
    unsigned short pressure_single;
    unsigned short pressure_multiple;
    unsigned char gain;
    unsigned char error_correction_enable;
    unsigned char reserved;
    unsigned short scale_x;
    short offset_x;
    unsigned short scale_y;
    short offset_y;
} scriptel_hid_feature_touch_parameters;
 
typedef struct {
    unsigned char report_id;
    unsigned long output_report;
    scriptel_output_mode output_mode;
    scriptel_compression_mode compression;
    unsigned short packets_per_second;
    unsigned char save_as_default;
    unsigned char load_factory_settings;
} scriptel_hid_feature_output_parameters;
typedef struct {
    unsigned char report_id;
    scriptel_mag_card_output mag_card_output;
    unsigned char reserved1;
    unsigned char reserved2;
    unsigned char reserved3;
    unsigned char reserved4;
    unsigned char reserved5;
    unsigned char reserved6;
    unsigned char reserved7;
    unsigned char reserved8;
    unsigned char reserved9;
    unsigned char reserved10;
    unsigned char reserved11;
    unsigned char reserved12;
    unsigned char reserved13;
    unsigned char reserved14;
    unsigned char save_as_default;
    unsigned char load_factory_settings;
} scriptel_hid_feature_peripheral_configuration;
typedef struct {
    unsigned char report_id;
    unsigned char is_initializing;
    unsigned char is_idle;
    unsigned char calibration_required;
    unsigned char is_calibrating;
    unsigned char all_output_commands_locked;
    unsigned char operating_mode_commands_locked;
    unsigned char region_commands_locked;
    unsigned char screen_commands_locked;
    unsigned char display_commands_locked;
    unsigned char calibration_commands_locked;
    unsigned char reserved1;
    unsigned short reserved2;
    unsigned short last_error;
    char error_info[64];
} scriptel_hid_feature_device_status;
 
typedef struct {
    unsigned char report_id;
    unsigned char calibration_type;
    unsigned char is_calibrated;
    unsigned short rotation_scale;
    unsigned short local_multiplier_scale;
    unsigned short host_multiplier_scale;
    short rotation_sin_scaled;
    short rotation_cos_scaled;
    unsigned short local_width_calibrated;
    unsigned short local_height_calibrated;
    long local_x_multiplier_scaled;
    long local_x_offset;
    long local_y_multiplier_scaled;
    long local_y_offset;
    long host_x_multiplier_scaled;
    long host_x_offset;
    long host_y_multiplier_scaled;
    long host_y_offset;
} scriptel_hid_feature_calibration_data;
 
typedef struct {
    unsigned char alpha;
    unsigned char blue;
    unsigned char green;
    unsigned char red;
} scriptel_color;
 
typedef struct {
    unsigned char report_id;
    unsigned short width;
    unsigned short height;
    unsigned char color_depth;
    unsigned char text_width;
    unsigned char text_height;
    unsigned char region_count;
    unsigned char max_caption_length;
} scriptel_hid_feature_display_info;
 
typedef struct {
    unsigned char report_id;
    unsigned char content;
} scriptel_hid_feature_display_content;
 
typedef struct {
    unsigned char report_id;
    unsigned char brightness;
    unsigned char contrast;
    unsigned char red;
    unsigned char green;
    unsigned char blue;
    unsigned char set_command;
} scriptel_hid_feature_display_settings;
 
typedef struct {
    unsigned char report_id;
    unsigned short x;
    unsigned short y;
    unsigned short width;
    unsigned short height;
    unsigned char bits_per_pixel;
    unsigned char graphic[2039];
} scriptel_hid_feature_display_chunk;
 
typedef struct {
    unsigned char region_number;
    scriptel_region_type region_type;
    unsigned char accept_touch;
    unsigned char decode;
    unsigned char visible;
    unsigned char in_use;
    unsigned char has_frame;
    unsigned char reserved_1;
    unsigned int reserved_2;
    unsigned short x1;
    unsigned short x2;
    unsigned short y1;
    unsigned short y2;
    scriptel_color color_foreground;
    scriptel_color color_background;
} scriptel_device_region_common;
 
typedef struct {
    scriptel_device_region_common region_info;
    unsigned char ink_enable;
    unsigned char reserved_1;
    unsigned char reserved_2;
    unsigned short reserved_3;
} scriptel_device_region_container;
 
typedef struct {
    scriptel_device_region_common region_info;
    unsigned char parent;
    unsigned char enable;
    unsigned char highlight_on_select;
    unsigned char clear_on_select;
    unsigned short reserved;
    char caption[100];
} scriptel_device_region_button;
 
typedef struct {
    scriptel_device_region_common region_info;
    unsigned char parent;
    unsigned char width;
    unsigned short reserved;
} scriptel_device_region_line;
 
typedef union {
    scriptel_device_region_common common;
    scriptel_device_region_container container;
    scriptel_device_region_button button;
    scriptel_device_region_line line;
} scriptel_device_region_info;
 
typedef struct {
    unsigned char report_id;
    scriptel_device_region_info region;
} scriptel_hid_feature_report_region;
 
typedef struct {
    unsigned char report_id;
    unsigned char region_number;
    unsigned char function_enable;
    unsigned char visible;
    unsigned char reserved1;
    scriptel_color color_foreground;
    unsigned int reserved2;
} scriptel_hid_feature_region_update;
 
typedef struct {
    unsigned char report_id;
    unsigned char region_number;
} scriptel_hid_feature_region_delete;
 
typedef enum {
    SCRIPTEL_REGION_DISCARD_CHANGES = 0,
    SCRIPTEL_REGION_SAVE_CHANGES = 1
} scriptel_region_save_changes;
 
typedef enum {
    SCRIPTEL_SCREEN_REGION_DISCARD_CHANGES = 0,
    SCRIPTEL_SCREEN_REGION_SAVE_CHANGES = 1,
    SCRIPTEL_SCREEN_REGION_FACTORY_DEFAULTS = 90
 
} scriptel_screen_region_save_changes;
typedef struct {
    unsigned char report_id;
    scriptel_region_save_changes save_changes;
} scriptel_hid_feature_region_edit_complete;
typedef struct {
    unsigned char report_id;
    scriptel_screen_region_save_changes save_changes;
} scriptel_hid_feature_screen_region_edit_complete;
 
 
typedef struct {
    unsigned char report_id;
    unsigned char calibration_mode;
    scriptel_calibration_point point;
} scriptel_hid_feature_calibrate;
typedef enum {
    SCRIPTEL_RESOURCE_TYPE_TEXT = 0,
    SCRIPTEL_RESOURCE_TYPE_GRAPHIC = 1,
    SCRIPTEL_RESOURCE_TYPE_INVALID = 255
} scriptel_resource_type;
 
typedef struct {
    unsigned char report_id;
    unsigned char resource_number;
    scriptel_resource_type resource_type;
    unsigned char reserved_1;
    unsigned long resource_size;
    unsigned long resource_crc;
    unsigned char reserved_2;
    unsigned char reserved_3;
    unsigned char reserved_4;
    unsigned char reserved_5;
    unsigned char reserved_6;
    unsigned char reserved_7;
    unsigned char reserved_8;
    unsigned char reserved_9;
} scriptel_hid_feature_resource_info;
typedef struct {
    unsigned char report_id;
    unsigned char resource_number;
    scriptel_resource_type resource_type;
    unsigned char reserved_1;
    unsigned char reserved_2;
    unsigned long resource_size;
    unsigned long resource_crc;
    unsigned char reserved_3;
    unsigned char reserved_4;
    unsigned char reserved_5;
    unsigned char reserved_6;
    unsigned char reserved_7;
    unsigned char reserved_8;
    unsigned short bytes_valid;
    unsigned char resource_data[1024];
} scriptel_hid_feature_resource;
typedef struct {
    unsigned char report_id;
    unsigned char resource_number;
} scriptel_hid_feature_delete_resource;
typedef struct {
    unsigned char report_id;
    unsigned char number_available;
    unsigned long space_available;
    unsigned int reserved_1;
    unsigned int reserved_2;
    unsigned int reserved_3;
    unsigned int reserved_4;
    unsigned int reserved_5;
    unsigned int reserved_6;
    unsigned int reserved_7;
    unsigned int reserved_8;
    unsigned int reserved_9;
    unsigned int reserved_10;
    unsigned int reserved_11;
    unsigned int reserved_12;
} scriptel_hid_feature_resource_availability;
typedef struct {
    unsigned char report_id;
    unsigned char region_index;
    scriptel_region_type region_type;
    unsigned char accepts_touch;
    unsigned char decode_region;
    unsigned char has_frame;
    unsigned char output_to_host;
    unsigned char reserved_1;
    unsigned char reserved_2;
    unsigned char reserved_3;
    unsigned char reserved_4;
    unsigned char reserved_5;
    unsigned char reserved_6;
    unsigned char reserved_7;
    unsigned char reserved_8;
    unsigned char reserved_9;
    unsigned short x1;
    unsigned short x2;
    unsigned short y1;
    unsigned short y2;
    scriptel_color foreground_color;
    scriptel_color background_color;
} scriptel_hid_feature_region_common;
typedef struct {
    scriptel_hid_feature_region_common common;
    unsigned char ink_enabled;
    unsigned char ink_width;
    unsigned char reserved_1;
    unsigned char reserved_2;
} scriptel_hid_feature_region_container;
typedef struct {
    scriptel_hid_feature_region_common common;
    unsigned char enabled;
    unsigned char highlight_on_select;
    unsigned char clear_on_select;
    unsigned char confirm_on_select;
    unsigned char use_resource;
    unsigned char reserved_1;
    unsigned char reserved_2;
    unsigned char reserved_3;
    unsigned char resource_number_normal;
    unsigned char resource_number_selected;
    char caption[100];
} scriptel_hid_feature_region_button;
typedef struct {
    scriptel_hid_feature_region_common common;
    unsigned char reserved_1;
    unsigned char line_width;
    unsigned char reserved_2;
    unsigned char reserved_3;
} scriptel_hid_feature_region_line;
typedef enum {
    SCRIPTEL_JUSTIFICATION_LEFT = 0,
    SCRIPTEL_JUSTIFICATION_TOP = 0,
    SCRIPTEL_JUSTIFICATION_RIGHT = 1,
    SCRIPTEL_JUSTIFICATION_BOTTOM = 1,
    SCRIPTEL_JUSTIFICATION_CENTER = 8
} scriptel_resource_justification;
 
typedef enum {
    SCRIPTEL_PEN_COORD_DISPLAY_SPACE = 1,
    SCRIPTEL_PEN_COORD_DEVICE_SPACE = 2
} scriptel_pen_coord_type;
 
typedef struct {
    scriptel_hid_feature_region_common common;
    unsigned char reserved_1;
    unsigned char graphic_number;
    scriptel_resource_justification horizontal_justification;
    scriptel_resource_justification vertical_justification;
    unsigned char reserved_2;
} scriptel_hid_feature_region_graphic;
typedef struct {
    scriptel_hid_feature_region_common common;
    unsigned char reserved_1;
    unsigned char resource_number;
    unsigned char font_number;
    scriptel_resource_justification horizontal_justification;
    scriptel_resource_justification vertical_justification;
} scriptel_hid_feature_region_text;
typedef union {
    scriptel_hid_feature_region_common common;
    scriptel_hid_feature_region_container container;
    scriptel_hid_feature_region_button button;
    scriptel_hid_feature_region_line line;
    scriptel_hid_feature_region_graphic graphic;
    scriptel_hid_feature_region_text text;
} scriptel_hid_feature_region;
typedef struct {
    unsigned char report_id;
    unsigned char screen_number;
    unsigned char reset_timeout_on_activity;
    unsigned char reserved_1;
    unsigned char reserved_2;
    unsigned char reserved_3;
    unsigned char reserved_4;
    unsigned char reserved_5;
    unsigned char reserved_6;
    unsigned char reserved_7;
    unsigned char reserved_8;
    unsigned char reserved_9;
    unsigned char reserved_10;
    unsigned char reserved_11;
    unsigned char reserved_12;
    unsigned char reserved_13;
    unsigned char reserved_14;
    unsigned char timeout;
    unsigned char timeout_screen_next;
    unsigned char region_count;
    unsigned char region_list[100];
    unsigned char screen_next_list[100];
} scriptel_hid_feature_screen;
typedef struct {
    unsigned char report_id;
    unsigned char screen_index;
} scriptel_hid_feature_delete_screen;
typedef struct {
    unsigned char report_id;
    unsigned char reserved_1;
    unsigned char reserved_2;
    unsigned char reserved_3;
    unsigned char reserved_4;
    unsigned char reserved_5;
    unsigned char reserved_6;
    unsigned char region_add;
    unsigned char region_delete;
    unsigned char timeout_set;
    unsigned char screen_index;
    unsigned char region_index;
    unsigned char region_screen_next;
    unsigned char timeout;
    unsigned char timeout_screen_next;
} scriptel_hid_feature_edit_screen;
typedef struct {
    unsigned char report_id;
    unsigned char screen_count;
    unsigned char region_count;
    unsigned char regions_per_screen;
    unsigned char resource_count;
    unsigned char caption_length;
    unsigned char text_region_length;
    unsigned char text_width;
    unsigned char text_height;
    unsigned char reserved_1;
    unsigned char reserved_2;
    unsigned char reserved_3;
    unsigned char reserved_4;
    unsigned char reserved_5;
    unsigned char reserved_6;
    unsigned char reserved_7;
    unsigned char reserved_8;
    unsigned char reserved_9;
    unsigned char reserved_10;
    unsigned char reserved_11;
    unsigned char reserved_12;
    unsigned char reserved_13;
    unsigned char reserved_14;
    unsigned char reserved_15;
    unsigned char reserved_16;
} scriptel_hid_feature_screen_region_info;
 
typedef struct scriptel_pen_coordinate {
    unsigned char report_id;
    unsigned char coordinate_type;
    unsigned short x;
    unsigned short y;
    unsigned char pen_down;
} scriptel_pen_coordinate;
 
typedef struct {
    unsigned char report_id;
    unsigned short x;
    unsigned short y;
    scriptel_device_region_info* region;
} scriptel_hid_input_button_down;
 
typedef struct {
    unsigned char report_id;
    unsigned short x;
    unsigned short y;
    scriptel_device_region_info* region;
} scriptel_hid_input_button_move;
 
typedef struct {
    unsigned char report_id;
    unsigned short x;
    unsigned short y;
    scriptel_device_region_info* region;
} scriptel_hid_input_button_up;
 
typedef struct {
    unsigned char report_id;
    unsigned short x;
    unsigned short y;
    scriptel_device_region_info* region;
} scriptel_hid_input_button_press;
 
typedef struct {
    unsigned char report_id;
} scriptel_hid_input_type;
 
typedef union {
    scriptel_hid_input_type type;
    scriptel_hid_input_coordinate coordinate;
    scriptel_hid_input_extended_coordinate extended_coordinate;
    scriptel_hid_input_adc_values adc_values;
    scriptel_hid_input_card_swipe card_swipe;
    scriptel_hid_input_debug_coordinate debug_coordinate;
    scriptel_hid_input_button_down button_down;
    scriptel_hid_input_button_move button_move;
    scriptel_hid_input_button_up button_up;
    scriptel_hid_input_button_press button_press;
} scriptel_input_report;
 
#endif