Scriptel ScripTouch ProScript C Library This documentation contains information about the ScripTouch ProScript C Library.

scriptel-hid-reports.h
Go to the documentation of this file.
1 /*******************************************************************************
2 * scriptel-hid-reports.h - Copyright 2014 - Scriptel Corporation
3 * ----
4 * This header contains information about how to interact with ScripTouch
5 * devices. Data structures and constants used by the devices are stored here.
6 ******************************************************************************/
7
8 #ifndef _SCRIPTEL_HID_REPORTS_H_
9 #define _SCRIPTEL_HID_REPORTS_H_
10
14 #define SCRIPTEL_REGION_BASE_SIZE 28
15
26 typedef enum {
30 SCRIPTEL_FEATURE_RUNMODE = 10,
34 SCRIPTEL_FEATURE_CAPABILITIES = 11,
38 SCRIPTEL_FEATURE_DEVICE_STATUS = 13,
42 SCRIPTEL_FEATURE_DEVICECONFIGURE = 15,
46 SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM = 16,
50 SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE = 20,
54 SCRIPTEL_FEATURE_POWERSTATE = 21,
58 SCRIPTEL_FEATURE_VERSIONINFO = 22,
62 SCRIPTEL_FEATURE_COORDINATERANGE = 23,
66 SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD = 25,
70 SCRIPTEL_FEATURE_ERRORCORRECTION = 26,
74 SCRIPTEL_FEATURE_SERIALNUMBER = 27,
78 SCRIPTEL_FEATURE_SAVECONFIGURATION = 28,
82 SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS = 29,
86 SCRIPTEL_FEATURE_OPERATINGMODE = 40,
90 SCRIPTEL_FEATURE_GENERALPARAMETERS = 41,
94 SCRIPTEL_FEATURE_ASICRESET = 42,
98 SCRIPTEL_FEATURE_REGISTERGET = 43,
102 SCRIPTEL_FEATURE_REGISTERSET = 44,
106 SCRIPTEL_FEATURE_PENPARAMETERS = 50,
110 SCRIPTEL_FEATURE_TOUCHPARAMETERS = 60,
114 SCRIPTEL_FEATURE_OUTPUTCONFIGURATION = 91,
118 SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION = 92,
122 SCRIPTEL_FEATURE_CALIBRATION_DATA = 131,
126 SCRIPTEL_FEATURE_DISPLAYINFO = 100,
130 SCRIPTEL_FEATURE_DISPLAYCONTENT = 101,
134 SCRIPTEL_FEATURE_DISPLAYSETTINGS = 102,
138 SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK = 103,
142 SCRIPTEL_FEATURE_REGIONGET = 110,
146 SCRIPTEL_FEATURE_REGIONGETDEFAULT = 111,
150 SCRIPTEL_FEATURE_REGIONSET = 112,
154 SCRIPTEL_FEATURE_REGIONUPDATE = 113,
158 SCRIPTEL_FEATURE_REGIONDELETE = 114,
162 SCRIPTEL_FEATURE_REGIONEDITCOMPLETE = 115,
166 SCRIPTEL_FEATURE_CALIBRATE = 130,
170 SCRIPTEL_FEATURE_RESOURCE_IDX = 140,
174 SCRIPTEL_FEATURE_RESOURCE_INFO = 141,
178 SCRIPTEL_FEATURE_RESOURCE = 142,
182 SCRIPTEL_FEATURE_DELETE_RESOURCE = 143,
186 SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY = 144,
190 SCRIPTEL_FEATURE_REGION_IDX = 150,
194 SCRIPTEL_FEATURE_REGION = 152,
198 SCRIPTEL_FEATURE_DELETE_REGION = 153,
202 SCRIPTEL_FEATURE_SCREEN_IDX = 160,
206 SCRIPTEL_FEATURE_SCREEN = 162,
210 SCRIPTEL_FEATURE_DELETE_SCREEN = 163,
214 SCRIPTEL_FEATURE_MODIFY_SCREEN = 164,
218 SCRIPTEL_FEATURE_SCREEN_REGION_INFO = 170,
222 SCRIPTEL_FEATURE_ACTIVE_SCREEN = 171,
226 SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD = 172,
230 SCRIPTEL_INPUT_COORDINATE = 1,
234 SCRIPTEL_INPUT_EXTENDEDCOORDINATE = 2,
238 SCRIPTEL_INPUT_ADCVALUES = 3,
242 SCRIPTEL_INPUT_MOUSECOORDINATE = 4,
246 SCRIPTEL_INPUT_DIGITIZERPENCOORDINATE = 5,
250 SCRIPTEL_INPUT_DIGITIZERTOUCHCOORDINATE = 6,
254 SCRIPTEL_INPUT_KEYBOARD = 7,
258 SCRIPTEL_INPUT_MULTITOUCHCOORDINATE = 8,
262 SCRIPTEL_INPUT_MAGCARDDATA = 12,
266 SCRIPTEL_INPUT_DEBUGCOORDINATE = 254,
270 SCRIPTEL_FEATURE_ENGINEERING_TEST = 253,
274 SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION = 104,
278 SCRIPTEL_FEATURE_PIXELS = 105,
279
285 SCRIPTEL_INPUT_BUTTONDOWN = 250,
289 SCRIPTEL_INPUT_BUTTONMOVE = 251,
293 SCRIPTEL_INPUT_BUTTONUP = 252,
297 SCRIPTEL_INPUT_BUTTONPRESS = 253, // note this is overloaded with a real feature report
301 SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS = 230
302 } scriptel_hid_report_id;
303
307 typedef enum {
311 SCRIPTEL_OUTPUT_CONFIGURATION_OEM = 0x00000001,
315 SCRIPTEL_OUTPUT_CONFIGURATION_OEM_EXTENDED = 0x00000002,
319 SCRIPTEL_OUTPUT_CONFIGURATION_MOUSE = 0x00000100,
323 SCRIPTEL_OUTPUT_CONFIGURATION_PEN_DIGITIZER = 0x00000200,
327 SCRIPTEL_OUTPUT_CONFIGURATION_TOUCH = 0x00000400,
331 SCRIPTEL_OUTPUT_CONFIGURATION_KEYBOARD = 0x00010000,
335 SCRIPTEL_OUTPUT_CONFIGURATION_RAW_DATA = 0x40000000,
339 SCRIPTEL_OUTPUT_CONFIGURATION_DEBUG_DATA = 0x80000000
340 } scriptel_ouput_configuration_flags;
341
346 typedef enum {
350 SCRIPTEL_FEATURE_RUNMODE_SIZE = 2,
354 SCRIPTEL_FEATURE_CAPABILITIES_SIZE = 65,
358 SCRIPTEL_FEATURE_DEVICECONFIGURE_SIZE = 3,
362 SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM_SIZE = 2,
366 SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE_SIZE = 4,
370 SCRIPTEL_FEATURE_POWERSTATE_SIZE = 2,
374 SCRIPTEL_FEATURE_VERSIONINFO_SIZE = 9,
378 SCRIPTEL_FEATURE_COORDINATERANGE_SIZE = 9,
382 SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD_SIZE = 134,
386 SCRIPTEL_FEATURE_ERRORCORRECTION_SIZE = 2049,
390 SCRIPTEL_FEATURE_SERIALNUMBER_SIZE = 35,
394 SCRIPTEL_FEATURE_SAVECONFIGURATION_SIZE = 2,
398 SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS_SIZE = 3,
402 SCRIPTEL_FEATURE_OPERATINGMODE_SIZE = 5,
406 SCRIPTEL_FEATURE_GENERALPARAMETERS_SIZE = 6,
410 SCRIPTEL_FEATURE_ASICRESET_SIZE = 2,
414 SCRIPTEL_FEATURE_REGISTERGET_SIZE = 9,
418 SCRIPTEL_FEATURE_REGISTERSET_SIZE = 3,
422 SCRIPTEL_FEATURE_PENPARAMETERS_SIZE = 18,
426 SCRIPTEL_FEATURE_TOUCHPARAMETERS_SIZE = 22,
430 SCRIPTEL_FEATURE_OUTPUTCONFIGURATION_SIZE = 10,
434 SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION_SIZE = 17,
438 SCRIPTEL_FEATURE_DEVICE_STATUS_SIZE= 73,
442 SCRIPTEL_FEATURE_CALIBRATION_DATA_SIZE = 49,
446 SCRIPTEL_FEATURE_DISPLAYINFO_SIZE = 10,
450 SCRIPTEL_FEATURE_DISPLAYCONTENT_SIZE = 2,
454 SCRIPTEL_FEATURE_DISPLAYSETTINGS_SIZE = 7,
458 SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK_SIZE = 2049,
462 SCRIPTEL_FEATURE_REGIONUPDATE_SIZE = 12,
466 SCRIPTEL_FEATURE_REGIONDELETE_SIZE = 2,
470 SCRIPTEL_FEATURE_REGIONEDITCOMPLETE_SIZE = 2,
474 SCRIPTEL_FEATURE_RESOURCE_IDX_SIZE = 2,
478 SCRIPTEL_FEATURE_RESOURCE_INFO_SIZE = 20,
482 SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY_SIZE = 18,
486 SCRIPTEL_FEATURE_RESOURCE_SIZE = 1045,
490 SCRIPTEL_FEATURE_DELETE_RESOURCE_SIZE = 2,
494 SCRIPTEL_FEATURE_REGION_IDX_SIZE = 2,
498 SCRIPTEL_FEATURE_SCREEN_IDX_SIZE = 2,
502 SCRIPTEL_FEATURE_DELETE_REGION_SIZE = 2,
506 SCRIPTEL_FEATURE_SCREEN_SIZE = 80,
510 SCRIPTEL_FEATURE_DELETE_SCREEN_SIZE = 2,
514 SCRIPTEL_FEATURE_MODIFY_SCREEN_SIZE = 13,
518 SCRIPTEL_FEATURE_SCREEN_REGION_INFO_SIZE = 25,
522 SCRIPTEL_FEATURE_ACTIVE_SCREEN_SIZE = 2,
526 SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD_SIZE = 2,
530 SCRIPTEL_FEATURE_CALIBRATE_SIZE = 2,
534 SCRIPTEL_INPUT_COORDINATE_SIZE = 6,
538 SCRIPTEL_INPUT_EXTENDEDCOORDINATE_SIZE = 7,
542 SCRIPTEL_INPUT_ADCVALUES_SIZE = 11,
546 SCRIPTEL_INPUT_MAGCARDDATA_SIZE = 231,
550 SCRIPTEL_INPUT_DEBUGCOORDINATE_SIZE = 22,
554 SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION_SIZE = 5,
558 SCRIPTEL_FEATURE_PIXELS_SIZE = 1031,
562 SCRIPTEL_FEATURE_ENGINEERING_TEST_SIZE = 67,
566 SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS_SIZE = 69
567 } scriptel_hid_report_size;
568
572 typedef enum {
576 SCRIPTEL_RUNMODE_COMMAND = 0,
581 SCRIPTEL_RUNMODE_TOUCH = 1,
585 SCRIPTEL_RUNMODE_PEN = 2,
590 SCRIPTEL_RUNMODE_AUTOTOUCH = 4,
594 SCRIPTEL_RUNMODE_TOUCHSINGLE = 8,
598 SCRIPTEL_RUNMODE_TOUCHSTREAM = 10,
602 SCRIPTEL_RUNMODE_PENSINGLE = 16,
606 SCRIPTEL_RUNMODE_PENSTREAM = 18,
610 SCRIPTEL_RUNMODE_PENCONTINUOUS = 20
611 } scriptel_device_run_mode;
612
616 typedef enum {
620 SCRIPTEL_ACQMODE_TOUCH = 0,
624 SCRIPTEL_ACQMODE_PEN = 1,
628 SCRIPTEL_ACQMODE_AUTOTOUCH = 2,
632 SCRIPTEL_ACQMODE_COMMAND = 3
633 } scriptel_device_acquisition_mode;
634
638 typedef enum {
642 SCRIPTEL_PTMODE_SINGLE = 0,
646 SCRIPTEL_PTMODE_SINGLE_LIFTOFF = 1,
650 SCRIPTEL_PTMODE_STREAM = 2,
654 SCRIPTEL_PTMODE_STREAM_LIFTOFF = 3,
658 SCRIPTEL_PTMODE_CONTINUOUS = 4
659 } scriptel_device_pentouch_mode;
660
664 typedef enum {
668 SCRIPTEL_REGION_TYPE_CONTAINER = 0,
672 SCRIPTEL_REGION_TYPE_BUTTON = 1,
676 SCRIPTEL_REGION_TYPE_LINE = 2,
680 SCRIPTEL_REGION_TYPE_GRAPHIC = 3,
684 SCRIPTEL_REGION_TYPE_TEXT = 4,
688 SCRIPTEL_REGION_TYPE_NULL = 0xFF
689 } scriptel_region_type;
690
694 typedef enum {
698 REAL_TIME = 0,
702 TRANSMIT_ON_CONFIRM = 1,
706 TRANSMIT_ON_HOST_COMMAND = 2
707 } scriptel_output_mode;
708
712 typedef enum {
716 SCRIPTEL_OUTPUT_UNCOMPRESSED_LORES = 0,
720 SCRIPTEL_OUTPUT_COMPRESSED_LORES = 1,
724 SCRIPTEL_OUTPUT_UNCOMPRESSED_HIRES = 2,
728 SCRIPTEL_OUTPUT_COMPRESSED_HIRES = 3
729 } scriptel_compression_mode;
730
731 typedef enum {
735 SCRIPTEL_MAG_CARD_OEM_FORMAT = 0x01,
739 SCRIPTEL_MAG_CARD_KEYBOARD = 0x04,
743 SCRIPTEL_MAG_CARD_KEYBOARD_PREAMBLE = 0x08
744 } scriptel_mag_card_output;
745
750 typedef enum scriptel_displaysettings_command {
755 SCRIPTEL_COMMAND_RUNTIME = 0,
760 SCRIPTEL_COMMAND_COMMIT = 1,
765 SCRIPTEL_COMMAND_RESTORE_DEFAULTS = 128
766 } scriptel_displaysettings_command;
767
772 typedef struct {
777 unsigned char down;
781 unsigned char reserved1;
785 unsigned char data_source;
789 unsigned char reserved2;
790 } scriptel_sample_info_common;
791
795 typedef struct {
799 unsigned char tip_switch;
803 unsigned char reserved1;
807 unsigned char data_source;
811 unsigned char reserved2;
812 } scriptel_sample_info_pen;
813
817 typedef struct {
821 unsigned char contact;
826 unsigned char contact_id;
830 unsigned char reserved1;
834 unsigned char data_source;
838 unsigned char reserved2;
839 } scriptel_sample_info_touch;
840
845 typedef union {
849 scriptel_sample_info_common common;
853 scriptel_sample_info_pen pen;
857 scriptel_sample_info_touch touch;
858 } scriptel_sample_info;
859
863 typedef struct {
867 unsigned char report_id;
871 scriptel_sample_info sample_info;
875 unsigned short x;
879 unsigned short y;
880 } scriptel_hid_input_coordinate;
881
885 typedef struct {
889 unsigned char report_id;
893 scriptel_sample_info sample_info;
897 unsigned short x;
901 unsigned short y;
905 unsigned char region;
906 } scriptel_hid_input_extended_coordinate;
907
911 typedef enum {
915 SCRIPTEL_ADC_DATA_TYPE_SCAN = 2,
919 SCRIPTEL_ADC_DATA_TYPE_CHANNEL = 3
920 } scriptel_adc_data_type;
921
925 typedef struct {
929 unsigned char report_id;
933 scriptel_adc_data_type data_type;
937 union {
941 struct {
945 scriptel_sample_info sample_info;
949 unsigned short x_max;
953 unsigned short x_min;
957 unsigned short y_max;
961 unsigned short y_min;
962 } scan_values;
966 struct {
970 unsigned char channel_number;
974 unsigned short sample1;
978 unsigned short sample2;
982 unsigned short sample3;
986 unsigned short sample4;
987 } channel_values;
988 } adc_data;
989 } scriptel_hid_input_adc_values;
990
994 typedef enum {
998 SCRIPTEL_CARDSWIPE_TYPE_FINANCIAL = 0x01,
1002 SCRIPTEL_CARDSWIPE_TYPE_IDENTIFICATION = 0x02,
1006 SCRIPTEL_CARDSWIPE_TYPE_UNKNOWN = 0xFF
1007 } scriptel_cardswipe_type;
1008
1013 typedef enum {
1017 SCRIPTEL_CARDSWIPE_STATUS_VALID = 0x00,
1021 SCRIPTEL_CARDSWIPE_STATUS_PARITY_ERROR = 0x01,
1025 SCRIPTEL_CARDSWIPE_STATUS_UNKNOWN_FORMAT = 0x10,
1029 SCRIPTEL_CARDSWIPE_STATUS_CORRUPT = 0x11
1030 } scriptel_cardswipe_track_status;
1031
1035 typedef enum {
1039 SCRIPTEL_ASIC_POWER_STATE_NORMAL = 0,
1043 SCRIPTEL_ASIC_POWER_STATE_POWERDOWN = 1,
1047 SCRIPTEL_ASIC_POWER_STATE_STANDBY = 2
1048 } scriptel_asic_power_state;
1049
1053 typedef enum {
1057 SCRIPTEL_CALIBRATION_POINT_CENTER = 0,
1061 SCRIPTEL_CALIBRATION_POINT_UPPERLEFT = 2,
1065 SCRIPTEL_CALIBRATION_POINT_LOWERLEFT = 4,
1069 SCRIPTEL_CALIBRATION_POINT_LOWERRIGHT = 6,
1073 SCRIPTEL_CALIBRATION_POINT_UPPERRIGHT = 8
1074 } scriptel_calibration_point;
1075
1076 typedef enum {
1080 SCRIPTEL_LOCATION_1_STYLUS_DOWN = 0,
1084 SCRIPTEL_LOCATION_1_STYLUS_UP = 1,
1088 SCRIPTEL_LOCATION_2_STYLUS_DOWN = 2,
1092 SCRIPTEL_LOCATION_2_STYLUS_UP = 3
1093 }scriptel_tuning_state;
1094
1099 typedef struct {
1103 unsigned char report_id;
1107 scriptel_cardswipe_type card_format;
1111 scriptel_cardswipe_track_status track1_status;
1115 scriptel_cardswipe_track_status track2_status;
1119 scriptel_cardswipe_track_status track3_status;
1123 unsigned char track1[79];
1127 unsigned char track2[40];
1131 unsigned char track3[107];
1132 } scriptel_hid_input_card_swipe;
1133
1138 typedef struct {
1142 unsigned char report_id;
1146 scriptel_sample_info sample_info;
1150 unsigned short offset;
1154 unsigned short x_max;
1158 unsigned short x_min;
1162 unsigned short y_max;
1166 unsigned short y_min;
1170 unsigned short x_errcor;
1174 unsigned short y_errcor;
1178 unsigned short x_mapped;
1182 unsigned short y_mapped;
1186 unsigned char region;
1187 } scriptel_hid_input_debug_coordinate;
1188
1194 typedef struct {
1198 unsigned char report_id;
1202 scriptel_device_run_mode run_mode;
1203 } scriptel_hid_feature_run_mode;
1204
1210 typedef enum {
1214 SCRIPTEL_SUPPORTED_REPORTS_HID = 1,
1218 SCRIPTEL_SUPPORTED_REPORTS_MOUSE = 2,
1222 SCRIPTEL_SUPPORTED_REPORTS_PEN = 4,
1226 SCRIPTEL_SUPPORTED_REPORTS_TOUCH = 8,
1230 SCRIPTEL_SUPPORTED_REPORTS_KEYBOARD = 16
1231 } scriptel_supported_reports;
1232
1236 typedef enum {
1240 SCRIPTEL_MODE_STREAMING = 0x01,
1244 SCRIPTEL_MODE_BUFFERING = 0x02,
1248 SCRIPTEL_MODE_COMPRESSION = 0x04,
1252 SCRIPTEL_MODE_THROTTLING = 0x08
1253 } scriptel_supported_transfer_modes;
1254
1259 typedef enum {
1263 SCRIPTEL_DISPLAY_TYPE_NONE = 0,
1267 SCRIPTEL_DISPLAY_TYPE_240X64_1X5_BLACKWHITE = 1,
1271 SCRIPTEL_DISPLAY_TYPE_240X64_1X5_GRAYSCALE = 2
1272 } scriptel_display_type;
1273
1278 typedef enum {
1282 SCRIPTEL_CARDREADER_NONE = 0,
1286 SCRIPTEL_CARDREADER_HID = 1,
1290 SCRIPTEL_CARDREADER_KEYBOARD_BASIC = 2,
1294 SCRIPTEL_CARDREADER_KEYBOARD_PREAMBLE = 3,
1298 SCRIPTEL_CARDREADER_INTERCHANGEABLE = 131,
1302 SCRIPTEL_MAG_CARDREADER_HID = 0x01,
1306 SCRIPTEL_MAG_CARDREADER_KEYBOARD = 0x02,
1310 SCRIPTEL_MAG_CARDREADER_CHANGEABLE = 0x80
1311 } scriptel_card_reader;
1312
1313 typedef enum {
1317 SCRIPTEL_ENGINEERING_TEST_DISPLAY = 1, // Mike Bodnar calls this 'Local'
1321 SCRIPTEL_ENGINEERING_TEST_NATIVE = 2 // Mike Bodnar calls this 'Host'
1322 } scriptel_engineering_test;
1323
1324
1329 typedef struct {
1333 unsigned char report_id;
1338 unsigned short supported_reports;
1342 unsigned char coordinate_modes;
1346 unsigned char reserved1;
1350 scriptel_display_type display_id;
1354 unsigned char brightness_levels;
1358 unsigned char contrast_levels;
1362 unsigned char color_depth;
1366 unsigned short display_width;
1370 unsigned short display_height;
1374 unsigned short digitizer_width;
1378 unsigned short digitizer_height;
1382 unsigned short coordinate_xmin;
1386 unsigned short coordinate_xmax;
1390 unsigned short coordinate_ymin;
1394 unsigned short coordinate_ymax;
1398 unsigned short calibration_xmin;
1402 unsigned short calibration_xmax;
1406 unsigned short calibration_ymin;
1410 unsigned short calibration_ymax;
1414 unsigned int reserved_4;
1418 unsigned int reserved_5;
1422 scriptel_card_reader mag_reader_id;
1426 unsigned char reserved_6;
1430 unsigned short reserved_7;
1435 unsigned char supports_screens_resources;
1439 unsigned char reserved_9;
1443 unsigned int reserved_10;
1447 unsigned int reserved_11;
1451 unsigned int reserved_12;
1455 unsigned int reserved_13;
1459 unsigned int reserved_14;
1460 } scriptel_hid_capabilities;
1464 typedef struct {
1468 unsigned char report_id;
1472 unsigned char device_mode;
1476 unsigned char device_id;
1477 } scriptel_hid_feature_device_configure;
1478
1483 typedef struct {
1487 unsigned char report_id;
1491 unsigned char contact_count_max;
1492 } scriptel_hid_feature_contact_count_maximum;
1493
1497 typedef struct {
1501 unsigned char report_id;
1505 unsigned char frequency;
1509 unsigned char pen_amplitude;
1513 unsigned char touch_amplitude;
1514 } scriptel_hid_feature_frequency_amplitude;
1515
1516 typedef struct {
1520 unsigned char report_id;
1524 unsigned char command_id;
1528 unsigned char tuning_mode;
1532 unsigned char tuning_aborted;
1536 scriptel_tuning_state tuning_state;
1540 unsigned char gain_setting;
1541 } scriptel_hid_feature_tuning_status;
1542
1546 typedef struct {
1550 unsigned char report_id;
1554 scriptel_asic_power_state power_state;
1555 } scriptel_hid_feature_power_state;
1556
1560 typedef struct {
1564 unsigned char report_id;
1568 unsigned char kernel_version[3];
1572 unsigned char firmware_version[3];
1576 unsigned short asic_signature;
1577 } scriptel_hid_feature_version;
1578
1582 typedef struct {
1586 unsigned char report_id;
1590 unsigned short x_min;
1594 unsigned short x_max;
1598 unsigned short y_min;
1602 unsigned short y_max;
1603 } scriptel_hid_feature_coordinate_range;
1604
1608 typedef struct {
1612 unsigned char report_id;
1616 unsigned int address;
1620 unsigned char data[128];
1632 unsigned char checksum;
1633 } scriptel_hid_feature_firmware_download;
1634
1639 typedef struct {
1643 unsigned char report_id;
1647 unsigned char data[2048];
1648 } scriptel_hid_feature_error_correction_table;
1649
1653 typedef struct {
1657 unsigned char report_id;
1661 unsigned char guid[16];
1662 } scriptel_hid_feature_guid;
1663
1668 typedef struct {
1672 unsigned char report_id;
1679 unsigned char serial_number[32];
1683 unsigned char write_key_1;
1687 unsigned char write_key_2;
1688 } scriptel_hid_feature_serial_number;
1689
1693 typedef struct {
1697 unsigned char report_id;
1701 scriptel_device_acquisition_mode startup_mode;
1702 } scriptel_hid_feature_save_configuration;
1703
1708 typedef struct {
1712 unsigned char report_id;
1716 unsigned short command_status;
1717 } scriptel_hid_feature_download_command_status;
1718
1722 typedef struct {
1726 unsigned char report_id;
1730 unsigned char supported_modes;
1734 unsigned char reserved;
1738 unsigned char acquisition_mode;
1742 unsigned char touch_mode;
1746 unsigned char pen_mode;
1747 } scriptel_hid_feature_operating_modes;
1748
1752 typedef struct {
1756 unsigned char report_id;
1760 unsigned char xy_output_enable;
1764 unsigned char adc_output_enable;
1768 unsigned char map_coordinates;
1772 unsigned char channel_lock_enable;
1776 unsigned char channel_lock_number;
1780 unsigned char reserved;
1784 unsigned char corner_lower_left;
1788 unsigned char corner_upper_left;
1792 unsigned char corner_lower_right;
1796 unsigned char corner_upper_right;
1800 unsigned short samples;
1804 unsigned char filter_frequency;
1805 } scriptel_hid_feature_general_parameters;
1806
1810 typedef struct {
1814 unsigned char report_id;
1818 unsigned char hardware_reset;
1822 unsigned char reserved;
1823 } scriptel_hid_feature_asic_reset;
1824
1828 typedef struct {
1832 unsigned char report_id;
1836 unsigned char register_info[8];
1837 } scriptel_hid_feature_register_get;
1838
1842 typedef struct {
1846 unsigned char report_id;
1850 unsigned char register_id;
1854 unsigned char register_value;
1855 } scriptel_hid_feature_register_set;
1856
1860 typedef struct {
1864 unsigned char report_id;
1868 unsigned short proximity;
1872 unsigned short auto_pen_threshold;
1876 unsigned short auto_touch_threshold;
1880 unsigned char adc_average;
1884 unsigned char coordinate_average;
1888 unsigned short offset_interval;
1892 unsigned char debounce_pre_down;
1896 unsigned char debounce_post_down;
1900 unsigned char debounce_pre_up;
1904 unsigned char debounce_post_up;
1908 unsigned char error_correction_enable;
1912 unsigned char reserved_1;
1916 unsigned char offset_correction_enable;
1920 unsigned char reserved_2;
1924 unsigned char tip_inverted;
1928 unsigned char reserved_3;
1932 unsigned short interrupt_rate;
1933 } scriptel_hid_feature_pen_parameters;
1934
1935 typedef struct {
1939 unsigned char report_id;
1940 unsigned short start_x;
1941 unsigned short start_y;
1942 } scriptel_hid_feature_pixel_retrieval_location;
1943
1944 typedef struct {
1945 unsigned char a;
1946 unsigned char r;
1947 unsigned char g;
1948 unsigned char b;
1949 } argb;
1950
1954 typedef struct {
1958 unsigned char report_id;
1962 unsigned short start_x;
1966 unsigned short start_y;
1970 unsigned short number_of_pixels;
1971 union color_data {
1975 unsigned long composit[256];
1979 argb color[256];
1980 } color_data;
1981 } scriptel_hid_feature_pixel_values;
1982
1986 typedef struct {
1990 unsigned char report_id;
1994 unsigned char adc_average;
1998 unsigned char coordinate_average;
2002 short slope_down;
2006 short slope_liftoff;
2010 unsigned char slope_minimum;
2014 unsigned short pressure_single;
2018 unsigned short pressure_multiple;
2022 unsigned char gain;
2026 unsigned char error_correction_enable;
2030 unsigned char reserved;
2034 unsigned short scale_x;
2038 short offset_x;
2042 unsigned short scale_y;
2046 short offset_y;
2047 } scriptel_hid_feature_touch_parameters;
2048
2052 typedef struct {
2056 unsigned char report_id;
2060 unsigned long output_report;
2064 scriptel_output_mode output_mode;
2068 scriptel_compression_mode compression;
2072 unsigned short packets_per_second;
2076 unsigned char save_as_default;
2080 unsigned char load_factory_settings;
2081 } scriptel_hid_feature_output_parameters;
2085 typedef struct {
2089 unsigned char report_id;
2093 scriptel_mag_card_output mag_card_output;
2097 unsigned char reserved1;
2101 unsigned char reserved2;
2105 unsigned char reserved3;
2109 unsigned char reserved4;
2113 unsigned char reserved5;
2117 unsigned char reserved6;
2121 unsigned char reserved7;
2125 unsigned char reserved8;
2129 unsigned char reserved9;
2133 unsigned char reserved10;
2137 unsigned char reserved11;
2141 unsigned char reserved12;
2145 unsigned char reserved13;
2149 unsigned char reserved14;
2153 unsigned char save_as_default;
2157 unsigned char load_factory_settings;
2158 } scriptel_hid_feature_peripheral_configuration;
2163 typedef struct {
2167 unsigned char report_id;
2171 unsigned char is_initializing;
2175 unsigned char is_idle;
2179 unsigned char calibration_required;
2183 unsigned char is_calibrating;
2187 unsigned char all_output_commands_locked;
2191 unsigned char operating_mode_commands_locked;
2195 unsigned char region_commands_locked;
2199 unsigned char screen_commands_locked;
2203 unsigned char display_commands_locked;
2207 unsigned char calibration_commands_locked;
2211 unsigned char reserved1;
2215 unsigned short reserved2;
2219 unsigned short last_error;
2223 char error_info[64];
2224 } scriptel_hid_feature_device_status;
2225
2230 typedef struct {
2234 unsigned char report_id;
2238 unsigned char calibration_type;
2242 unsigned char is_calibrated;
2246 unsigned short rotation_scale;
2250 unsigned short local_multiplier_scale;
2254 unsigned short host_multiplier_scale;
2258 short rotation_sin_scaled;
2262 short rotation_cos_scaled;
2266 unsigned short local_width_calibrated;
2270 unsigned short local_height_calibrated;
2274 long local_x_multiplier_scaled;
2278 long local_x_offset;
2282 long local_y_multiplier_scaled;
2286 long local_y_offset;
2290 long host_x_multiplier_scaled;
2294 long host_x_offset;
2298 long host_y_multiplier_scaled;
2302 long host_y_offset;
2303 } scriptel_hid_feature_calibration_data;
2304
2308 typedef struct {
2312 unsigned char alpha;
2316 unsigned char blue;
2320 unsigned char green;
2324 unsigned char red;
2325 } scriptel_color;
2326
2331 typedef struct {
2335 unsigned char report_id;
2341 unsigned short width;
2347 unsigned short height;
2351 unsigned char color_depth;
2355 unsigned char text_width;
2359 unsigned char text_height;
2363 unsigned char region_count;
2367 unsigned char max_caption_length;
2368 } scriptel_hid_feature_display_info;
2369
2373 typedef struct {
2377 unsigned char report_id;
2381 unsigned char content;
2382 } scriptel_hid_feature_display_content;
2383
2387 typedef struct {
2391 unsigned char report_id;
2396 unsigned char brightness;
2401 unsigned char contrast;
2405 unsigned char red;
2409 unsigned char green;
2413 unsigned char blue;
2418 unsigned char set_command;
2419 } scriptel_hid_feature_display_settings;
2420
2425 typedef struct {
2429 unsigned char report_id;
2433 unsigned short x;
2437 unsigned short y;
2441 unsigned short width;
2445 unsigned short height;
2449 unsigned char bits_per_pixel;
2455 unsigned char graphic[2039];
2456 } scriptel_hid_feature_display_chunk;
2457
2462 typedef struct {
2466 unsigned char region_number;
2470 scriptel_region_type region_type;
2474 unsigned char accept_touch;
2480 unsigned char decode;
2484 unsigned char visible;
2488 unsigned char in_use;
2493 unsigned char has_frame;
2497 unsigned char reserved_1;
2501 unsigned int reserved_2;
2505 unsigned short x1;
2509 unsigned short x2;
2513 unsigned short y1;
2517 unsigned short y2;
2521 scriptel_color color_foreground;
2525 scriptel_color color_background;
2526 } scriptel_device_region_common;
2527
2531 typedef struct {
2535 scriptel_device_region_common region_info;
2539 unsigned char ink_enable;
2543 unsigned char reserved_1;
2547 unsigned char reserved_2;
2551 unsigned short reserved_3;
2552 } scriptel_device_region_container;
2553
2557 typedef struct {
2561 scriptel_device_region_common region_info;
2565 unsigned char parent;
2569 unsigned char enable;
2573 unsigned char highlight_on_select;
2577 unsigned char clear_on_select;
2581 unsigned short reserved;
2585 char caption[100];
2586 } scriptel_device_region_button;
2587
2591 typedef struct {
2595 scriptel_device_region_common region_info;
2599 unsigned char parent;
2603 unsigned char width;
2607 unsigned short reserved;
2608 } scriptel_device_region_line;
2609
2613 typedef union {
2617 scriptel_device_region_common common;
2621 scriptel_device_region_container container;
2625 scriptel_device_region_button button;
2629 scriptel_device_region_line line;
2630 } scriptel_device_region_info;
2631
2635 typedef struct {
2639 unsigned char report_id;
2643 scriptel_device_region_info region;
2644 } scriptel_hid_feature_report_region;
2645
2649 typedef struct {
2653 unsigned char report_id;
2657 unsigned char region_number;
2661 unsigned char function_enable;
2665 unsigned char visible;
2669 unsigned char reserved1;
2673 scriptel_color color_foreground;
2677 unsigned int reserved2;
2678 } scriptel_hid_feature_region_update;
2679
2683 typedef struct {
2687 unsigned char report_id;
2691 unsigned char region_number;
2692 } scriptel_hid_feature_region_delete;
2693
2697 typedef enum {
2701 SCRIPTEL_REGION_DISCARD_CHANGES = 0,
2705 SCRIPTEL_REGION_SAVE_CHANGES = 1
2706 } scriptel_region_save_changes;
2707
2708 typedef enum {
2712 SCRIPTEL_SCREEN_REGION_DISCARD_CHANGES = 0,
2716 SCRIPTEL_SCREEN_REGION_SAVE_CHANGES = 1,
2720 SCRIPTEL_SCREEN_REGION_FACTORY_DEFAULTS = 90
2721
2722 } scriptel_screen_region_save_changes;
2727 typedef struct {
2731 unsigned char report_id;
2735 scriptel_region_save_changes save_changes;
2736 } scriptel_hid_feature_region_edit_complete;
2741 typedef struct {
2745 unsigned char report_id;
2749 scriptel_screen_region_save_changes save_changes;
2750 } scriptel_hid_feature_screen_region_edit_complete;
2751
2752
2757 typedef struct {
2761 unsigned char report_id;
2765 unsigned char calibration_mode;
2770 scriptel_calibration_point point;
2771 } scriptel_hid_feature_calibrate;
2775 typedef enum {
2779 SCRIPTEL_RESOURCE_TYPE_TEXT = 0,
2783 SCRIPTEL_RESOURCE_TYPE_GRAPHIC = 1,
2787 SCRIPTEL_RESOURCE_TYPE_INVALID = 255
2788 } scriptel_resource_type;
2789
2790 typedef struct {
2794 unsigned char report_id;
2798 unsigned char resource_number;
2802 scriptel_resource_type resource_type;
2806 unsigned char reserved_1;
2810 unsigned long resource_size;
2814 unsigned long resource_crc;
2818 unsigned char reserved_2;
2822 unsigned char reserved_3;
2826 unsigned char reserved_4;
2830 unsigned char reserved_5;
2834 unsigned char reserved_6;
2838 unsigned char reserved_7;
2842 unsigned char reserved_8;
2846 unsigned char reserved_9;
2847 } scriptel_hid_feature_resource_info;
2855 typedef struct {
2859 unsigned char report_id;
2863 unsigned char resource_number;
2867 scriptel_resource_type resource_type;
2871 unsigned char reserved_1;
2875 unsigned char reserved_2;
2881 unsigned long resource_size;
2885 unsigned long resource_crc;
2889 unsigned char reserved_3;
2893 unsigned char reserved_4;
2897 unsigned char reserved_5;
2901 unsigned char reserved_6;
2905 unsigned char reserved_7;
2909 unsigned char reserved_8;
2913 unsigned short bytes_valid;
2917 unsigned char resource_data[1024];
2918 } scriptel_hid_feature_resource;
2922 typedef struct {
2926 unsigned char report_id;
2930 unsigned char resource_number;
2931 } scriptel_hid_feature_delete_resource;
2936 typedef struct {
2940 unsigned char report_id;
2944 unsigned char number_available;
2948 unsigned long space_available;
2952 unsigned int reserved_1;
2956 unsigned int reserved_2;
2960 unsigned int reserved_3;
2964 unsigned int reserved_4;
2968 unsigned int reserved_5;
2972 unsigned int reserved_6;
2976 unsigned int reserved_7;
2980 unsigned int reserved_8;
2984 unsigned int reserved_9;
2988 unsigned int reserved_10;
2992 unsigned int reserved_11;
2996 unsigned int reserved_12;
2997 } scriptel_hid_feature_resource_availability;
3002 typedef struct {
3006 unsigned char report_id;
3010 unsigned char region_index;
3014 scriptel_region_type region_type;
3018 unsigned char accepts_touch;
3024 unsigned char decode_region;
3028 unsigned char has_frame;
3032 unsigned char output_to_host;
3036 unsigned char reserved_1;
3040 unsigned char reserved_2;
3044 unsigned char reserved_3;
3048 unsigned char reserved_4;
3052 unsigned char reserved_5;
3056 unsigned char reserved_6;
3060 unsigned char reserved_7;
3064 unsigned char reserved_8;
3068 unsigned char reserved_9;
3072 unsigned short x1;
3076 unsigned short x2;
3080 unsigned short y1;
3084 unsigned short y2;
3088 scriptel_color foreground_color;
3092 scriptel_color background_color;
3093 } scriptel_hid_feature_region_common;
3097 typedef struct {
3101 scriptel_hid_feature_region_common common;
3105 unsigned char ink_enabled;
3109 unsigned char ink_width;
3113 unsigned char reserved_1;
3117 unsigned char reserved_2;
3118 } scriptel_hid_feature_region_container;
3122 typedef struct {
3126 scriptel_hid_feature_region_common common;
3130 unsigned char enabled;
3134 unsigned char highlight_on_select;
3138 unsigned char clear_on_select;
3142 unsigned char confirm_on_select;
3146 unsigned char use_resource;
3150 unsigned char reserved_1;
3154 unsigned char reserved_2;
3158 unsigned char reserved_3;
3162 unsigned char resource_number_normal;
3166 unsigned char resource_number_selected;
3170 char caption[100];
3171 } scriptel_hid_feature_region_button;
3175 typedef struct {
3179 scriptel_hid_feature_region_common common;
3183 unsigned char reserved_1;
3187 unsigned char line_width;
3191 unsigned char reserved_2;
3195 unsigned char reserved_3;
3196 } scriptel_hid_feature_region_line;
3201 typedef enum {
3205 SCRIPTEL_JUSTIFICATION_LEFT = 0,
3209 SCRIPTEL_JUSTIFICATION_TOP = 0,
3213 SCRIPTEL_JUSTIFICATION_RIGHT = 1,
3217 SCRIPTEL_JUSTIFICATION_BOTTOM = 1,
3221 SCRIPTEL_JUSTIFICATION_CENTER = 8
3222 } scriptel_resource_justification;
3223
3227 typedef enum {
3231 SCRIPTEL_PEN_COORD_DISPLAY_SPACE = 1,
3235 SCRIPTEL_PEN_COORD_DEVICE_SPACE = 2
3236 } scriptel_pen_coord_type;
3237
3241 typedef struct {
3245 scriptel_hid_feature_region_common common;
3249 unsigned char reserved_1;
3253 unsigned char graphic_number;
3257 scriptel_resource_justification horizontal_justification;
3261 scriptel_resource_justification vertical_justification;
3265 unsigned char reserved_2;
3266 } scriptel_hid_feature_region_graphic;
3270 typedef struct {
3274 scriptel_hid_feature_region_common common;
3278 unsigned char reserved_1;
3282 unsigned char resource_number;
3286 unsigned char font_number;
3290 scriptel_resource_justification horizontal_justification;
3294 scriptel_resource_justification vertical_justification;
3295 } scriptel_hid_feature_region_text;
3299 typedef union {
3303 scriptel_hid_feature_region_common common;
3307 scriptel_hid_feature_region_container container;
3311 scriptel_hid_feature_region_button button;
3315 scriptel_hid_feature_region_line line;
3319 scriptel_hid_feature_region_graphic graphic;
3323 scriptel_hid_feature_region_text text;
3324 } scriptel_hid_feature_region;
3329 typedef struct {
3333 unsigned char report_id;
3337 unsigned char screen_number;
3341 unsigned char reset_timeout_on_activity;
3345 unsigned char reserved_1;
3349 unsigned char reserved_2;
3353 unsigned char reserved_3;
3357 unsigned char reserved_4;
3361 unsigned char reserved_5;
3365 unsigned char reserved_6;
3369 unsigned char reserved_7;
3373 unsigned char reserved_8;
3377 unsigned char reserved_9;
3381 unsigned char reserved_10;
3385 unsigned char reserved_11;
3389 unsigned char reserved_12;
3393 unsigned char reserved_13;
3397 unsigned char reserved_14;
3401 unsigned char timeout;
3405 unsigned char timeout_screen_next;
3409 unsigned char region_count;
3413 unsigned char region_list[100];
3417 unsigned char screen_next_list[100];
3418 } scriptel_hid_feature_screen;
3422 typedef struct {
3426 unsigned char report_id;
3430 unsigned char screen_index;
3431 } scriptel_hid_feature_delete_screen;
3435 typedef struct {
3439 unsigned char report_id;
3443 unsigned char reserved_1;
3447 unsigned char reserved_2;
3451 unsigned char reserved_3;
3455 unsigned char reserved_4;
3459 unsigned char reserved_5;
3463 unsigned char reserved_6;
3467 unsigned char region_add;
3471 unsigned char region_delete;
3475 unsigned char timeout_set;
3479 unsigned char screen_index;
3483 unsigned char region_index;
3487 unsigned char region_screen_next;
3491 unsigned char timeout;
3495 unsigned char timeout_screen_next;
3496 } scriptel_hid_feature_edit_screen;
3501 typedef struct {
3505 unsigned char report_id;
3509 unsigned char screen_count;
3513 unsigned char region_count;
3517 unsigned char regions_per_screen;
3521 unsigned char resource_count;
3525 unsigned char caption_length;
3529 unsigned char text_region_length;
3533 unsigned char text_width;
3537 unsigned char text_height;
3541 unsigned char reserved_1;
3545 unsigned char reserved_2;
3549 unsigned char reserved_3;
3553 unsigned char reserved_4;
3557 unsigned char reserved_5;
3561 unsigned char reserved_6;
3565 unsigned char reserved_7;
3569 unsigned char reserved_8;
3573 unsigned char reserved_9;
3577 unsigned char reserved_10;
3581 unsigned char reserved_11;
3585 unsigned char reserved_12;
3589 unsigned char reserved_13;
3593 unsigned char reserved_14;
3597 unsigned char reserved_15;
3601 unsigned char reserved_16;
3602 } scriptel_hid_feature_screen_region_info;
3603
3604 typedef struct scriptel_pen_coordinate {
3608 unsigned char report_id;
3612 unsigned char coordinate_type;
3616 unsigned short x;
3620 unsigned short y;
3624 unsigned char pen_down;
3625 } scriptel_pen_coordinate;
3626
3630 typedef struct {
3634 unsigned char report_id;
3638 unsigned short x;
3642 unsigned short y;
3646 scriptel_device_region_info* region;
3647 } scriptel_hid_input_button_down;
3648
3652 typedef struct {
3656 unsigned char report_id;
3660 unsigned short x;
3664 unsigned short y;
3668 scriptel_device_region_info* region;
3669 } scriptel_hid_input_button_move;
3670
3674 typedef struct {
3678 unsigned char report_id;
3682 unsigned short x;
3686 unsigned short y;
3690 scriptel_device_region_info* region;
3691 } scriptel_hid_input_button_up;
3692
3696 typedef struct {
3700 unsigned char report_id;
3704 unsigned short x;
3708 unsigned short y;
3712 scriptel_device_region_info* region;
3713 } scriptel_hid_input_button_press;
3714
3718 typedef struct {
3722 unsigned char report_id;
3723 } scriptel_hid_input_type;
3724
3728 typedef union {
3732 scriptel_hid_input_type type;
3736 scriptel_hid_input_coordinate coordinate;
3740 scriptel_hid_input_extended_coordinate extended_coordinate;
3744 scriptel_hid_input_adc_values adc_values;
3748 scriptel_hid_input_card_swipe card_swipe;
3752 scriptel_hid_input_debug_coordinate debug_coordinate;
3756 scriptel_hid_input_button_down button_down;
3760 scriptel_hid_input_button_move button_move;
3764 scriptel_hid_input_button_up button_up;
3768 scriptel_hid_input_button_press button_press;
3769 } scriptel_input_report;
3770
3771 #endif
scriptel_region_save_changes
scriptel_region_save_changes
This enumeration contains the valid options for region edit complete.
Definition: scriptel-hid-reports.h:2697
SCRIPTEL_REGION_DISCARD_CHANGES
@ SCRIPTEL_REGION_DISCARD_CHANGES
Discard all region changes.
Definition: scriptel-hid-reports.h:2701
SCRIPTEL_REGION_SAVE_CHANGES
@ SCRIPTEL_REGION_SAVE_CHANGES
Save all region changes persistently.
Definition: scriptel-hid-reports.h:2705
scriptel_hid_report_id
scriptel_hid_report_id
This enumeration contains all of the valid reports identifiers for reports that the ScripTouch firmwa...
Definition: scriptel-hid-reports.h:26
SCRIPTEL_FEATURE_POWERSTATE
@ SCRIPTEL_FEATURE_POWERSTATE
The report identifier of the power state feature report.
Definition: scriptel-hid-reports.h:54
SCRIPTEL_FEATURE_DISPLAYINFO
@ SCRIPTEL_FEATURE_DISPLAYINFO
The report identifier of the display information feature report.
Definition: scriptel-hid-reports.h:126
SCRIPTEL_FEATURE_TOUCHPARAMETERS
@ SCRIPTEL_FEATURE_TOUCHPARAMETERS
The report identifier of the touch parameters feature report.
Definition: scriptel-hid-reports.h:110
SCRIPTEL_FEATURE_DELETE_SCREEN
@ SCRIPTEL_FEATURE_DELETE_SCREEN
The report identifier of the delete screen feature report.
Definition: scriptel-hid-reports.h:210
SCRIPTEL_INPUT_BUTTONPRESS
@ SCRIPTEL_INPUT_BUTTONPRESS
The report identifier of the button press input report.
Definition: scriptel-hid-reports.h:297
SCRIPTEL_FEATURE_ACTIVE_SCREEN
@ SCRIPTEL_FEATURE_ACTIVE_SCREEN
The report identifier of the active screen feature report.
Definition: scriptel-hid-reports.h:222
SCRIPTEL_FEATURE_CAPABILITIES
@ SCRIPTEL_FEATURE_CAPABILITIES
The report identifier of the capabilities feature report.
Definition: scriptel-hid-reports.h:34
SCRIPTEL_FEATURE_RUNMODE
@ SCRIPTEL_FEATURE_RUNMODE
The report identifier of the run mode feature report.
Definition: scriptel-hid-reports.h:30
SCRIPTEL_FEATURE_DEVICECONFIGURE
@ SCRIPTEL_FEATURE_DEVICECONFIGURE
The report identifier of the device configuration feature report.
Definition: scriptel-hid-reports.h:42
SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION
@ SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION
The report identifier of Get/Set Picel Retrieval Location.
Definition: scriptel-hid-reports.h:274
SCRIPTEL_FEATURE_REGION_IDX
@ SCRIPTEL_FEATURE_REGION_IDX
The report identifier of the region index feature report.
Definition: scriptel-hid-reports.h:190
SCRIPTEL_FEATURE_REGISTERGET
@ SCRIPTEL_FEATURE_REGISTERGET
The report identifier of the register get feature report.
Definition: scriptel-hid-reports.h:98
SCRIPTEL_FEATURE_GENERALPARAMETERS
@ SCRIPTEL_FEATURE_GENERALPARAMETERS
The report identifier of the general parameters feature report.
Definition: scriptel-hid-reports.h:90
SCRIPTEL_FEATURE_REGIONSET
@ SCRIPTEL_FEATURE_REGIONSET
The report identifier of the region set feature report.
Definition: scriptel-hid-reports.h:150
SCRIPTEL_FEATURE_REGIONGET
@ SCRIPTEL_FEATURE_REGIONGET
The report identifier of the region get feature report.
Definition: scriptel-hid-reports.h:142
SCRIPTEL_INPUT_BUTTONMOVE
@ SCRIPTEL_INPUT_BUTTONMOVE
The report identifier of the button move input report.
Definition: scriptel-hid-reports.h:289
SCRIPTEL_FEATURE_REGIONDELETE
@ SCRIPTEL_FEATURE_REGIONDELETE
The report identifier of the region delete feature report.
Definition: scriptel-hid-reports.h:158
SCRIPTEL_FEATURE_OUTPUTCONFIGURATION
@ SCRIPTEL_FEATURE_OUTPUTCONFIGURATION
The report identifier of the output configuration feature report.
Definition: scriptel-hid-reports.h:114
SCRIPTEL_INPUT_MOUSECOORDINATE
@ SCRIPTEL_INPUT_MOUSECOORDINATE
The report identifier of the mouse coordinate input report.
Definition: scriptel-hid-reports.h:242
SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD
@ SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD
The report identifier of the firmware download feature report.
Definition: scriptel-hid-reports.h:66
SCRIPTEL_FEATURE_MODIFY_SCREEN
@ SCRIPTEL_FEATURE_MODIFY_SCREEN
The report identifier of the modify screen feature report.
Definition: scriptel-hid-reports.h:214
SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS
@ SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS
The report identifier of the download command status feature report.
Definition: scriptel-hid-reports.h:82
SCRIPTEL_INPUT_MAGCARDDATA
@ SCRIPTEL_INPUT_MAGCARDDATA
The report identifier of the magnetic card data input report.
Definition: scriptel-hid-reports.h:262
SCRIPTEL_FEATURE_SCREEN_REGION_INFO
@ SCRIPTEL_FEATURE_SCREEN_REGION_INFO
The report identifier of the screen region info feature report.
Definition: scriptel-hid-reports.h:218
SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD
@ SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD
The report identifier of the screen region save reload report.
Definition: scriptel-hid-reports.h:226
SCRIPTEL_INPUT_DIGITIZERPENCOORDINATE
@ SCRIPTEL_INPUT_DIGITIZERPENCOORDINATE
The report identifier of the digitizer pen coordinate input report.
Definition: scriptel-hid-reports.h:246
SCRIPTEL_FEATURE_RESOURCE_INFO
@ SCRIPTEL_FEATURE_RESOURCE_INFO
The report identifier of the resource info feature report.
Definition: scriptel-hid-reports.h:174
SCRIPTEL_INPUT_KEYBOARD
@ SCRIPTEL_INPUT_KEYBOARD
The report identifier of the keyboard input report.
Definition: scriptel-hid-reports.h:254
SCRIPTEL_INPUT_DEBUGCOORDINATE
@ SCRIPTEL_INPUT_DEBUGCOORDINATE
The report identifier of the debug coordinate input report.
Definition: scriptel-hid-reports.h:266
SCRIPTEL_INPUT_MULTITOUCHCOORDINATE
@ SCRIPTEL_INPUT_MULTITOUCHCOORDINATE
The report identifier of the multi-touch coordinate input report.
Definition: scriptel-hid-reports.h:258
SCRIPTEL_FEATURE_PENPARAMETERS
@ SCRIPTEL_FEATURE_PENPARAMETERS
The report identifier of the pen parameters feature report.
Definition: scriptel-hid-reports.h:106
SCRIPTEL_FEATURE_VERSIONINFO
@ SCRIPTEL_FEATURE_VERSIONINFO
The report identifier of the version information feature report.
Definition: scriptel-hid-reports.h:58
SCRIPTEL_INPUT_BUTTONDOWN
@ SCRIPTEL_INPUT_BUTTONDOWN
The following reports are fake input reports generated in the library.
Definition: scriptel-hid-reports.h:285
SCRIPTEL_FEATURE_DELETE_RESOURCE
@ SCRIPTEL_FEATURE_DELETE_RESOURCE
The report identifier of the delete resource feature report.
Definition: scriptel-hid-reports.h:182
SCRIPTEL_FEATURE_REGION
@ SCRIPTEL_FEATURE_REGION
The report identifier of the region feature report.
Definition: scriptel-hid-reports.h:194
SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS
@ SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS
The report identifier for STGEN-II Configuration and Diagnostics.
Definition: scriptel-hid-reports.h:301
SCRIPTEL_INPUT_BUTTONUP
@ SCRIPTEL_INPUT_BUTTONUP
The report identifier of the button up input report.
Definition: scriptel-hid-reports.h:293
SCRIPTEL_FEATURE_DISPLAYSETTINGS
@ SCRIPTEL_FEATURE_DISPLAYSETTINGS
The report identifier of the display settings feature report.
Definition: scriptel-hid-reports.h:134
SCRIPTEL_FEATURE_ERRORCORRECTION
@ SCRIPTEL_FEATURE_ERRORCORRECTION
The report identifier of the error correction feature report.
Definition: scriptel-hid-reports.h:70
SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE
@ SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE
The report identifier of the frequency amplitude feature report.
Definition: scriptel-hid-reports.h:50
SCRIPTEL_FEATURE_ENGINEERING_TEST
@ SCRIPTEL_FEATURE_ENGINEERING_TEST
The report identifier of Engineering Use report.
Definition: scriptel-hid-reports.h:270
SCRIPTEL_FEATURE_PIXELS
@ SCRIPTEL_FEATURE_PIXELS
The report itdentifier of Get/SET Pixels.
Definition: scriptel-hid-reports.h:278
SCRIPTEL_INPUT_COORDINATE
@ SCRIPTEL_INPUT_COORDINATE
The report identifier of the coordinate input report.
Definition: scriptel-hid-reports.h:230
SCRIPTEL_FEATURE_CALIBRATE
@ SCRIPTEL_FEATURE_CALIBRATE
The report identifier of the calibrate feature report.
Definition: scriptel-hid-reports.h:166
SCRIPTEL_FEATURE_SERIALNUMBER
@ SCRIPTEL_FEATURE_SERIALNUMBER
The report identifier of the serial number feature report.
Definition: scriptel-hid-reports.h:74
SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY
@ SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY
The report identifier of the resource availability feature report.
Definition: scriptel-hid-reports.h:186
SCRIPTEL_FEATURE_DISPLAYCONTENT
@ SCRIPTEL_FEATURE_DISPLAYCONTENT
The report identifier of the display content feature report.
Definition: scriptel-hid-reports.h:130
SCRIPTEL_FEATURE_REGIONUPDATE
@ SCRIPTEL_FEATURE_REGIONUPDATE
The report identifier of the region update feature report.
Definition: scriptel-hid-reports.h:154
SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM
@ SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM
The report identifier of the contact count maximum feature report.
Definition: scriptel-hid-reports.h:46
SCRIPTEL_FEATURE_DELETE_REGION
@ SCRIPTEL_FEATURE_DELETE_REGION
The report identifier of the delete region feature report.
Definition: scriptel-hid-reports.h:198
SCRIPTEL_FEATURE_DEVICE_STATUS
@ SCRIPTEL_FEATURE_DEVICE_STATUS
The report identifier of the device status and error clearer.
Definition: scriptel-hid-reports.h:38
SCRIPTEL_FEATURE_OPERATINGMODE
@ SCRIPTEL_FEATURE_OPERATINGMODE
The report identifier of the operating mode feature report.
Definition: scriptel-hid-reports.h:86
SCRIPTEL_INPUT_DIGITIZERTOUCHCOORDINATE
@ SCRIPTEL_INPUT_DIGITIZERTOUCHCOORDINATE
The report identifier of the digitizer touch coordinate input report.
Definition: scriptel-hid-reports.h:250
SCRIPTEL_INPUT_ADCVALUES
@ SCRIPTEL_INPUT_ADCVALUES
The report identifier of the adc values input report.
Definition: scriptel-hid-reports.h:238
SCRIPTEL_FEATURE_SCREEN_IDX
@ SCRIPTEL_FEATURE_SCREEN_IDX
The report identifier of the screen index feature report.
Definition: scriptel-hid-reports.h:202
SCRIPTEL_FEATURE_SCREEN
@ SCRIPTEL_FEATURE_SCREEN
The report identifier of the screen feature report.
Definition: scriptel-hid-reports.h:206
SCRIPTEL_FEATURE_REGIONGETDEFAULT
@ SCRIPTEL_FEATURE_REGIONGETDEFAULT
The report identifier of the region default feature report.
Definition: scriptel-hid-reports.h:146
SCRIPTEL_FEATURE_ASICRESET
@ SCRIPTEL_FEATURE_ASICRESET
The report identifier of the ASIC reset feature report.
Definition: scriptel-hid-reports.h:94
SCRIPTEL_FEATURE_COORDINATERANGE
@ SCRIPTEL_FEATURE_COORDINATERANGE
The report identifier of the coordinate range feature report.
Definition: scriptel-hid-reports.h:62
SCRIPTEL_FEATURE_CALIBRATION_DATA
@ SCRIPTEL_FEATURE_CALIBRATION_DATA
The report identifier of the calibration data report.
Definition: scriptel-hid-reports.h:122
SCRIPTEL_FEATURE_SAVECONFIGURATION
@ SCRIPTEL_FEATURE_SAVECONFIGURATION
The report identifier of the save configuration feature report.
Definition: scriptel-hid-reports.h:78
SCRIPTEL_FEATURE_RESOURCE_IDX
@ SCRIPTEL_FEATURE_RESOURCE_IDX
The report identifier of the resource index feature report.
Definition: scriptel-hid-reports.h:170
SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK
@ SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK
The report identifier of the update display chunk feature report.
Definition: scriptel-hid-reports.h:138
SCRIPTEL_INPUT_EXTENDEDCOORDINATE
@ SCRIPTEL_INPUT_EXTENDEDCOORDINATE
The report identifier of the extended coordinate input report.
Definition: scriptel-hid-reports.h:234
SCRIPTEL_FEATURE_REGIONEDITCOMPLETE
@ SCRIPTEL_FEATURE_REGIONEDITCOMPLETE
The report identifier of the region edit complete feature report.
Definition: scriptel-hid-reports.h:162
SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION
@ SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION
The report identifier of the peripheral configuration feature report.
Definition: scriptel-hid-reports.h:118
SCRIPTEL_FEATURE_RESOURCE
@ SCRIPTEL_FEATURE_RESOURCE
The report identifier of the resource feature report.
Definition: scriptel-hid-reports.h:178
SCRIPTEL_FEATURE_REGISTERSET
@ SCRIPTEL_FEATURE_REGISTERSET
The report identifier of the register set feature report.
Definition: scriptel-hid-reports.h:102
scriptel_adc_data_type
scriptel_adc_data_type
This enumeration contains all valid types of ADC data.
Definition: scriptel-hid-reports.h:911
SCRIPTEL_ADC_DATA_TYPE_SCAN
@ SCRIPTEL_ADC_DATA_TYPE_SCAN
Identifier for a scan sample.
Definition: scriptel-hid-reports.h:915
SCRIPTEL_ADC_DATA_TYPE_CHANNEL
@ SCRIPTEL_ADC_DATA_TYPE_CHANNEL
Identifier for a channel sample.
Definition: scriptel-hid-reports.h:919
scriptel_cardswipe_track_status
scriptel_cardswipe_track_status
This enumeration contains error codes that can be passed back when reading magnetic card tracks.
Definition: scriptel-hid-reports.h:1013
SCRIPTEL_CARDSWIPE_STATUS_PARITY_ERROR
@ SCRIPTEL_CARDSWIPE_STATUS_PARITY_ERROR
A parity error was found.
Definition: scriptel-hid-reports.h:1021
SCRIPTEL_CARDSWIPE_STATUS_VALID
@ SCRIPTEL_CARDSWIPE_STATUS_VALID
The track read is valid and can be used.
Definition: scriptel-hid-reports.h:1017
SCRIPTEL_CARDSWIPE_STATUS_UNKNOWN_FORMAT
@ SCRIPTEL_CARDSWIPE_STATUS_UNKNOWN_FORMAT
The magnetic card is in an unknown format.
Definition: scriptel-hid-reports.h:1025
SCRIPTEL_CARDSWIPE_STATUS_CORRUPT
@ SCRIPTEL_CARDSWIPE_STATUS_CORRUPT
The checksum of the card was incorrect.
Definition: scriptel-hid-reports.h:1029
scriptel_card_reader
scriptel_card_reader
This enumeration contains the different types of card readers that can be embedded into a ScripTouch ...
Definition: scriptel-hid-reports.h:1278
SCRIPTEL_CARDREADER_HID
@ SCRIPTEL_CARDREADER_HID
Vendor-specific HID card reader equipped.
Definition: scriptel-hid-reports.h:1286
SCRIPTEL_CARDREADER_NONE
@ SCRIPTEL_CARDREADER_NONE
No card reader equipped.
Definition: scriptel-hid-reports.h:1282
SCRIPTEL_CARDREADER_KEYBOARD_PREAMBLE
@ SCRIPTEL_CARDREADER_KEYBOARD_PREAMBLE
Keyboard card reader equipped - Scriptel preamble.
Definition: scriptel-hid-reports.h:1294
SCRIPTEL_MAG_CARDREADER_CHANGEABLE
@ SCRIPTEL_MAG_CARDREADER_CHANGEABLE
Reader capable of switching output modes.
Definition: scriptel-hid-reports.h:1310
SCRIPTEL_MAG_CARDREADER_HID
@ SCRIPTEL_MAG_CARDREADER_HID
Vendor-specific HID card reader equipped.
Definition: scriptel-hid-reports.h:1302
SCRIPTEL_CARDREADER_INTERCHANGEABLE
@ SCRIPTEL_CARDREADER_INTERCHANGEABLE
Card read can switch between HID and Keyboard.
Definition: scriptel-hid-reports.h:1298
SCRIPTEL_MAG_CARDREADER_KEYBOARD
@ SCRIPTEL_MAG_CARDREADER_KEYBOARD
Keyboard card reader equipped.
Definition: scriptel-hid-reports.h:1306
SCRIPTEL_CARDREADER_KEYBOARD_BASIC
@ SCRIPTEL_CARDREADER_KEYBOARD_BASIC
Keyboard card reader equipped - no preamble.
Definition: scriptel-hid-reports.h:1290
scriptel_calibration_point
scriptel_calibration_point
This enumeration contains all of the valid calibration points.
Definition: scriptel-hid-reports.h:1053
SCRIPTEL_CALIBRATION_POINT_UPPERLEFT
@ SCRIPTEL_CALIBRATION_POINT_UPPERLEFT
Calibration point is in the upper left of the screen.
Definition: scriptel-hid-reports.h:1061
SCRIPTEL_CALIBRATION_POINT_UPPERRIGHT
@ SCRIPTEL_CALIBRATION_POINT_UPPERRIGHT
Calibration point is in the upper right of the screen.
Definition: scriptel-hid-reports.h:1073
SCRIPTEL_CALIBRATION_POINT_LOWERRIGHT
@ SCRIPTEL_CALIBRATION_POINT_LOWERRIGHT
Calibration point is in the lower right of the screen.
Definition: scriptel-hid-reports.h:1069
SCRIPTEL_CALIBRATION_POINT_LOWERLEFT
@ SCRIPTEL_CALIBRATION_POINT_LOWERLEFT
Calibration point is in the lower left of the screen.
Definition: scriptel-hid-reports.h:1065
SCRIPTEL_CALIBRATION_POINT_CENTER
@ SCRIPTEL_CALIBRATION_POINT_CENTER
Calibration point is in the center of the screen.
Definition: scriptel-hid-reports.h:1057
scriptel_mag_card_output
scriptel_mag_card_output
Definition: scriptel-hid-reports.h:731
SCRIPTEL_MAG_CARD_OEM_FORMAT
@ SCRIPTEL_MAG_CARD_OEM_FORMAT
Peripheral outputs data in OEM Format.
Definition: scriptel-hid-reports.h:735
SCRIPTEL_MAG_CARD_KEYBOARD_PREAMBLE
@ SCRIPTEL_MAG_CARD_KEYBOARD_PREAMBLE
Peripheral outputs data in Keyboard Format with Preamble, SCRIPTEL_MAG_CARD_KEYBOARD must be active.
Definition: scriptel-hid-reports.h:743
SCRIPTEL_MAG_CARD_KEYBOARD
@ SCRIPTEL_MAG_CARD_KEYBOARD
Peripheral outputs data in Keyboard Format.
Definition: scriptel-hid-reports.h:739
scriptel_compression_mode
scriptel_compression_mode
This enumeration contains valid compression modes.
Definition: scriptel-hid-reports.h:712
SCRIPTEL_OUTPUT_UNCOMPRESSED_LORES
@ SCRIPTEL_OUTPUT_UNCOMPRESSED_LORES
No compression, low resolution output.
Definition: scriptel-hid-reports.h:716
SCRIPTEL_OUTPUT_UNCOMPRESSED_HIRES
@ SCRIPTEL_OUTPUT_UNCOMPRESSED_HIRES
Uncompressed, high resolution output (currently unsupported in firmware)
Definition: scriptel-hid-reports.h:724
SCRIPTEL_OUTPUT_COMPRESSED_LORES
@ SCRIPTEL_OUTPUT_COMPRESSED_LORES
Compressed, low resolution output (currently unsupported in firmware)
Definition: scriptel-hid-reports.h:720
SCRIPTEL_OUTPUT_COMPRESSED_HIRES
@ SCRIPTEL_OUTPUT_COMPRESSED_HIRES
Compressed, high resolution output.
Definition: scriptel-hid-reports.h:728
scriptel_screen_region_save_changes
scriptel_screen_region_save_changes
Definition: scriptel-hid-reports.h:2708
SCRIPTEL_SCREEN_REGION_FACTORY_DEFAULTS
@ SCRIPTEL_SCREEN_REGION_FACTORY_DEFAULTS
Restore all screens and regions to factory defaults.
Definition: scriptel-hid-reports.h:2720
SCRIPTEL_SCREEN_REGION_SAVE_CHANGES
@ SCRIPTEL_SCREEN_REGION_SAVE_CHANGES
Save all screen and region changes persistently.
Definition: scriptel-hid-reports.h:2716
SCRIPTEL_SCREEN_REGION_DISCARD_CHANGES
@ SCRIPTEL_SCREEN_REGION_DISCARD_CHANGES
Discard all screen and region changes.
Definition: scriptel-hid-reports.h:2712
scriptel_ouput_configuration_flags
scriptel_ouput_configuration_flags
This enumeration contains the output report flags.
Definition: scriptel-hid-reports.h:307
SCRIPTEL_OUTPUT_CONFIGURATION_MOUSE
@ SCRIPTEL_OUTPUT_CONFIGURATION_MOUSE
USB device type, not used on signature pads.
Definition: scriptel-hid-reports.h:319
SCRIPTEL_OUTPUT_CONFIGURATION_OEM
@ SCRIPTEL_OUTPUT_CONFIGURATION_OEM
Used by Scriptel, does not apply to signature pads.
Definition: scriptel-hid-reports.h:311
SCRIPTEL_OUTPUT_CONFIGURATION_PEN_DIGITIZER
@ SCRIPTEL_OUTPUT_CONFIGURATION_PEN_DIGITIZER
USB device type, not used on signature pads.
Definition: scriptel-hid-reports.h:323
SCRIPTEL_OUTPUT_CONFIGURATION_DEBUG_DATA
@ SCRIPTEL_OUTPUT_CONFIGURATION_DEBUG_DATA
Used for testing.
Definition: scriptel-hid-reports.h:339
SCRIPTEL_OUTPUT_CONFIGURATION_KEYBOARD
@ SCRIPTEL_OUTPUT_CONFIGURATION_KEYBOARD
EasyScript mode.
Definition: scriptel-hid-reports.h:331
SCRIPTEL_OUTPUT_CONFIGURATION_TOUCH
@ SCRIPTEL_OUTPUT_CONFIGURATION_TOUCH
USB device type, not used on signature pads.
Definition: scriptel-hid-reports.h:327
SCRIPTEL_OUTPUT_CONFIGURATION_RAW_DATA
@ SCRIPTEL_OUTPUT_CONFIGURATION_RAW_DATA
Used for testing.
Definition: scriptel-hid-reports.h:335
SCRIPTEL_OUTPUT_CONFIGURATION_OEM_EXTENDED
@ SCRIPTEL_OUTPUT_CONFIGURATION_OEM_EXTENDED
ProScript mode.
Definition: scriptel-hid-reports.h:315
scriptel_device_run_mode
scriptel_device_run_mode
This enumeration contains all of the valid run modes for ScripTouch firmware.
Definition: scriptel-hid-reports.h:572
SCRIPTEL_RUNMODE_TOUCHSINGLE
@ SCRIPTEL_RUNMODE_TOUCHSINGLE
Defined but unused, reserved for later use.
Definition: scriptel-hid-reports.h:594
SCRIPTEL_RUNMODE_PEN
@ SCRIPTEL_RUNMODE_PEN
Pen mode, configures the digitizer to accept pen input.
Definition: scriptel-hid-reports.h:585
SCRIPTEL_RUNMODE_AUTOTOUCH
@ SCRIPTEL_RUNMODE_AUTOTOUCH
Auto Touch mode, alternates quickly between pen and touch mode to detect either.
Definition: scriptel-hid-reports.h:590
SCRIPTEL_RUNMODE_COMMAND
@ SCRIPTEL_RUNMODE_COMMAND
Command mode, turns off the ASIC and accepts commands.
Definition: scriptel-hid-reports.h:576
SCRIPTEL_RUNMODE_PENSINGLE
@ SCRIPTEL_RUNMODE_PENSINGLE
Defined but unused, reserved for later use.
Definition: scriptel-hid-reports.h:602
SCRIPTEL_RUNMODE_PENSTREAM
@ SCRIPTEL_RUNMODE_PENSTREAM
Defined but unused, reserved for later use.
Definition: scriptel-hid-reports.h:606
SCRIPTEL_RUNMODE_TOUCHSTREAM
@ SCRIPTEL_RUNMODE_TOUCHSTREAM
Defined but unused, reserved for later use.
Definition: scriptel-hid-reports.h:598
SCRIPTEL_RUNMODE_TOUCH
@ SCRIPTEL_RUNMODE_TOUCH
Touch mode, configures the digitizer to accept touch input.
Definition: scriptel-hid-reports.h:581
SCRIPTEL_RUNMODE_PENCONTINUOUS
@ SCRIPTEL_RUNMODE_PENCONTINUOUS
Defined but unused, reserved for later use.
Definition: scriptel-hid-reports.h:610
scriptel_hid_report_size
scriptel_hid_report_size
This enumeration contains the sizes in bytes of all of the static sized reports.
Definition: scriptel-hid-reports.h:346
SCRIPTEL_FEATURE_REGISTERSET_SIZE
@ SCRIPTEL_FEATURE_REGISTERSET_SIZE
Size in bytes of the register set feature report.
Definition: scriptel-hid-reports.h:418
SCRIPTEL_FEATURE_CAPABILITIES_SIZE
@ SCRIPTEL_FEATURE_CAPABILITIES_SIZE
Size in bytes of the capabilities feature report.
Definition: scriptel-hid-reports.h:354
SCRIPTEL_FEATURE_RESOURCE_IDX_SIZE
@ SCRIPTEL_FEATURE_RESOURCE_IDX_SIZE
Size in bytes of the resource index feature report.
Definition: scriptel-hid-reports.h:474
SCRIPTEL_FEATURE_REGIONUPDATE_SIZE
@ SCRIPTEL_FEATURE_REGIONUPDATE_SIZE
Size in bytes of the region update feature report.
Definition: scriptel-hid-reports.h:462
SCRIPTEL_FEATURE_ASICRESET_SIZE
@ SCRIPTEL_FEATURE_ASICRESET_SIZE
Size in bytes of the ASIC reset feature report.
Definition: scriptel-hid-reports.h:410
SCRIPTEL_FEATURE_ERRORCORRECTION_SIZE
@ SCRIPTEL_FEATURE_ERRORCORRECTION_SIZE
Size in bytes of the error correction feature report.
Definition: scriptel-hid-reports.h:386
SCRIPTEL_FEATURE_OUTPUTCONFIGURATION_SIZE
@ SCRIPTEL_FEATURE_OUTPUTCONFIGURATION_SIZE
Size in bytes of the output configuration report.
Definition: scriptel-hid-reports.h:430
SCRIPTEL_FEATURE_REGISTERGET_SIZE
@ SCRIPTEL_FEATURE_REGISTERGET_SIZE
Size in bytes of the register get feature report.
Definition: scriptel-hid-reports.h:414
SCRIPTEL_FEATURE_DEVICECONFIGURE_SIZE
@ SCRIPTEL_FEATURE_DEVICECONFIGURE_SIZE
Size in bytes of the device configure feature report.
Definition: scriptel-hid-reports.h:358
SCRIPTEL_FEATURE_VERSIONINFO_SIZE
@ SCRIPTEL_FEATURE_VERSIONINFO_SIZE
Size in bytes of the version info feature report.
Definition: scriptel-hid-reports.h:374
SCRIPTEL_INPUT_COORDINATE_SIZE
@ SCRIPTEL_INPUT_COORDINATE_SIZE
Size in bytes of the coordinate size input report.
Definition: scriptel-hid-reports.h:534
SCRIPTEL_INPUT_MAGCARDDATA_SIZE
@ SCRIPTEL_INPUT_MAGCARDDATA_SIZE
Size in bytes of the magnetic card data input report.
Definition: scriptel-hid-reports.h:546
SCRIPTEL_FEATURE_SCREEN_SIZE
@ SCRIPTEL_FEATURE_SCREEN_SIZE
Size in bytes of the screen feature report.
Definition: scriptel-hid-reports.h:506
SCRIPTEL_FEATURE_PIXELS_SIZE
@ SCRIPTEL_FEATURE_PIXELS_SIZE
Size in bytes of the get/set pixels feature report.
Definition: scriptel-hid-reports.h:558
SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD_SIZE
@ SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD_SIZE
Size in bytes of the screen region commit feature report.
Definition: scriptel-hid-reports.h:526
SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION_SIZE
@ SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION_SIZE
Size in bytes of the peripheral configuration report.
Definition: scriptel-hid-reports.h:434
SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS_SIZE
@ SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS_SIZE
Size in bytes of the download command status feature report.
Definition: scriptel-hid-reports.h:398
SCRIPTEL_FEATURE_CALIBRATION_DATA_SIZE
@ SCRIPTEL_FEATURE_CALIBRATION_DATA_SIZE
Size in bytes of the calibration data report.
Definition: scriptel-hid-reports.h:442
SCRIPTEL_FEATURE_SCREEN_IDX_SIZE
@ SCRIPTEL_FEATURE_SCREEN_IDX_SIZE
Size in bytes of the screen index feature report.
Definition: scriptel-hid-reports.h:498
SCRIPTEL_FEATURE_RESOURCE_INFO_SIZE
@ SCRIPTEL_FEATURE_RESOURCE_INFO_SIZE
Size in bytes of the resource info feature report.
Definition: scriptel-hid-reports.h:478
SCRIPTEL_FEATURE_SERIALNUMBER_SIZE
@ SCRIPTEL_FEATURE_SERIALNUMBER_SIZE
Size in bytes of the serial number feature report.
Definition: scriptel-hid-reports.h:390
SCRIPTEL_INPUT_DEBUGCOORDINATE_SIZE
@ SCRIPTEL_INPUT_DEBUGCOORDINATE_SIZE
Size in bytes of the debug coordinate input report.
Definition: scriptel-hid-reports.h:550
SCRIPTEL_FEATURE_COORDINATERANGE_SIZE
@ SCRIPTEL_FEATURE_COORDINATERANGE_SIZE
Size in bytes of the coordinate range feature report.
Definition: scriptel-hid-reports.h:378
SCRIPTEL_FEATURE_DELETE_SCREEN_SIZE
@ SCRIPTEL_FEATURE_DELETE_SCREEN_SIZE
Size in bytes of the delete screen feature report.
Definition: scriptel-hid-reports.h:510
SCRIPTEL_FEATURE_POWERSTATE_SIZE
@ SCRIPTEL_FEATURE_POWERSTATE_SIZE
Size in bytes of the power state feature report.
Definition: scriptel-hid-reports.h:370
SCRIPTEL_FEATURE_REGIONEDITCOMPLETE_SIZE
@ SCRIPTEL_FEATURE_REGIONEDITCOMPLETE_SIZE
Size in bytes of the region edit complete feature report.
Definition: scriptel-hid-reports.h:470
SCRIPTEL_FEATURE_DELETE_REGION_SIZE
@ SCRIPTEL_FEATURE_DELETE_REGION_SIZE
Size in bytes of the delete region feature report.
Definition: scriptel-hid-reports.h:502
SCRIPTEL_FEATURE_MODIFY_SCREEN_SIZE
@ SCRIPTEL_FEATURE_MODIFY_SCREEN_SIZE
Size in bytes of the modify screen feature report.
Definition: scriptel-hid-reports.h:514
SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION_SIZE
@ SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION_SIZE
Size in bytes of the get/set Pixel Retrieval Location feature report.
Definition: scriptel-hid-reports.h:554
SCRIPTEL_FEATURE_DEVICE_STATUS_SIZE
@ SCRIPTEL_FEATURE_DEVICE_STATUS_SIZE
Size in bytes of the Device Status report.
Definition: scriptel-hid-reports.h:438
SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE_SIZE
@ SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE_SIZE
Size in bytes of the frequency amplitude feature report.
Definition: scriptel-hid-reports.h:366
SCRIPTEL_FEATURE_CALIBRATE_SIZE
@ SCRIPTEL_FEATURE_CALIBRATE_SIZE
Size in bytes of the calibrate feature report.
Definition: scriptel-hid-reports.h:530
SCRIPTEL_FEATURE_RUNMODE_SIZE
@ SCRIPTEL_FEATURE_RUNMODE_SIZE
Size in bytes of the run mode feature report.
Definition: scriptel-hid-reports.h:350
SCRIPTEL_FEATURE_ACTIVE_SCREEN_SIZE
@ SCRIPTEL_FEATURE_ACTIVE_SCREEN_SIZE
Size in bytes of the active screen feature report.
Definition: scriptel-hid-reports.h:522
SCRIPTEL_INPUT_EXTENDEDCOORDINATE_SIZE
@ SCRIPTEL_INPUT_EXTENDEDCOORDINATE_SIZE
Size in bytes of the extended coordinate input report.
Definition: scriptel-hid-reports.h:538
SCRIPTEL_FEATURE_DELETE_RESOURCE_SIZE
@ SCRIPTEL_FEATURE_DELETE_RESOURCE_SIZE
Size in bytes of the delete resource feature report.
Definition: scriptel-hid-reports.h:490
SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK_SIZE
@ SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK_SIZE
Size in bytes of the update display chunk feature report.
Definition: scriptel-hid-reports.h:458
SCRIPTEL_FEATURE_DISPLAYSETTINGS_SIZE
@ SCRIPTEL_FEATURE_DISPLAYSETTINGS_SIZE
Size in bytes of the display settings feature report.
Definition: scriptel-hid-reports.h:454
SCRIPTEL_FEATURE_REGIONDELETE_SIZE
@ SCRIPTEL_FEATURE_REGIONDELETE_SIZE
Size in bytes of the region delete feature report.
Definition: scriptel-hid-reports.h:466
SCRIPTEL_FEATURE_SAVECONFIGURATION_SIZE
@ SCRIPTEL_FEATURE_SAVECONFIGURATION_SIZE
Size in bytes of the save configuration feature report.
Definition: scriptel-hid-reports.h:394
SCRIPTEL_FEATURE_RESOURCE_SIZE
@ SCRIPTEL_FEATURE_RESOURCE_SIZE
Size in bytes of the resource feature report.
Definition: scriptel-hid-reports.h:486
SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD_SIZE
@ SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD_SIZE
Size in bytes of the firmware download feature report.
Definition: scriptel-hid-reports.h:382
SCRIPTEL_FEATURE_SCREEN_REGION_INFO_SIZE
@ SCRIPTEL_FEATURE_SCREEN_REGION_INFO_SIZE
Size in bytes of the screen region info feature report.
Definition: scriptel-hid-reports.h:518
SCRIPTEL_INPUT_ADCVALUES_SIZE
@ SCRIPTEL_INPUT_ADCVALUES_SIZE
Size in bytes of the ADC values input report.
Definition: scriptel-hid-reports.h:542
SCRIPTEL_FEATURE_DISPLAYCONTENT_SIZE
@ SCRIPTEL_FEATURE_DISPLAYCONTENT_SIZE
Size in bytes of the display content feature report.
Definition: scriptel-hid-reports.h:450
SCRIPTEL_FEATURE_ENGINEERING_TEST_SIZE
@ SCRIPTEL_FEATURE_ENGINEERING_TEST_SIZE
Size in bytes of the engineering test feature report.
Definition: scriptel-hid-reports.h:562
SCRIPTEL_FEATURE_REGION_IDX_SIZE
@ SCRIPTEL_FEATURE_REGION_IDX_SIZE
Size in bytes of the region index feature report.
Definition: scriptel-hid-reports.h:494
SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY_SIZE
@ SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY_SIZE
Size in bytes of the resource availability feature report.
Definition: scriptel-hid-reports.h:482
SCRIPTEL_FEATURE_TOUCHPARAMETERS_SIZE
@ SCRIPTEL_FEATURE_TOUCHPARAMETERS_SIZE
Size in bytes of the touch parameters feature report.
Definition: scriptel-hid-reports.h:426
SCRIPTEL_FEATURE_GENERALPARAMETERS_SIZE
@ SCRIPTEL_FEATURE_GENERALPARAMETERS_SIZE
Size in bytes of the general parameters feature report.
Definition: scriptel-hid-reports.h:406
SCRIPTEL_FEATURE_OPERATINGMODE_SIZE
@ SCRIPTEL_FEATURE_OPERATINGMODE_SIZE
Size in bytes of the operating mode feature report.
Definition: scriptel-hid-reports.h:402
SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS_SIZE
@ SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS_SIZE
Size in bytes of the genII configuration and diagnostics feature report.
Definition: scriptel-hid-reports.h:566
SCRIPTEL_FEATURE_DISPLAYINFO_SIZE
@ SCRIPTEL_FEATURE_DISPLAYINFO_SIZE
Size in bytes of the display info feature report.
Definition: scriptel-hid-reports.h:446
SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM_SIZE
@ SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM_SIZE
Size in bytes of the contact count maximum feature report.
Definition: scriptel-hid-reports.h:362
SCRIPTEL_FEATURE_PENPARAMETERS_SIZE
@ SCRIPTEL_FEATURE_PENPARAMETERS_SIZE
Size in bytes of the pen parameters feature report.
Definition: scriptel-hid-reports.h:422
scriptel_supported_transfer_modes
scriptel_supported_transfer_modes
This enumeration contains values for the coordinate_modes capabilities bit-mask.
Definition: scriptel-hid-reports.h:1236
SCRIPTEL_MODE_THROTTLING
@ SCRIPTEL_MODE_THROTTLING
The device supports coordinate throttling.
Definition: scriptel-hid-reports.h:1252
SCRIPTEL_MODE_COMPRESSION
@ SCRIPTEL_MODE_COMPRESSION
The device supports coordinate compression.
Definition: scriptel-hid-reports.h:1248
SCRIPTEL_MODE_BUFFERING
@ SCRIPTEL_MODE_BUFFERING
The device supports coordinate buffering (batch) output.
Definition: scriptel-hid-reports.h:1244
SCRIPTEL_MODE_STREAMING
@ SCRIPTEL_MODE_STREAMING
The device supports streaming output.
Definition: scriptel-hid-reports.h:1240
scriptel_displaysettings_command
scriptel_displaysettings_command
This enumeration contains valid flags for the command byte field in the set display settings report.
Definition: scriptel-hid-reports.h:750
SCRIPTEL_COMMAND_COMMIT
@ SCRIPTEL_COMMAND_COMMIT
This display settings will be commited to flash.
Definition: scriptel-hid-reports.h:760
SCRIPTEL_COMMAND_RESTORE_DEFAULTS
@ SCRIPTEL_COMMAND_RESTORE_DEFAULTS
Ignore the values in the report, restore the default values.
Definition: scriptel-hid-reports.h:765
SCRIPTEL_COMMAND_RUNTIME
@ SCRIPTEL_COMMAND_RUNTIME
The display settings will only persist during runtime.
Definition: scriptel-hid-reports.h:755
scriptel_supported_reports
scriptel_supported_reports
This enumeration contains values for the capabilities bit-mask in the compatibility report.
Definition: scriptel-hid-reports.h:1210
SCRIPTEL_SUPPORTED_REPORTS_MOUSE
@ SCRIPTEL_SUPPORTED_REPORTS_MOUSE
The device supports HID mouse input reports.
Definition: scriptel-hid-reports.h:1218
SCRIPTEL_SUPPORTED_REPORTS_TOUCH
@ SCRIPTEL_SUPPORTED_REPORTS_TOUCH
The device supports HID touch input reports.
Definition: scriptel-hid-reports.h:1226
SCRIPTEL_SUPPORTED_REPORTS_KEYBOARD
@ SCRIPTEL_SUPPORTED_REPORTS_KEYBOARD
The device supports HID keyboard input reports.
Definition: scriptel-hid-reports.h:1230
SCRIPTEL_SUPPORTED_REPORTS_PEN
@ SCRIPTEL_SUPPORTED_REPORTS_PEN
The device supports HID pen input reports.
Definition: scriptel-hid-reports.h:1222
SCRIPTEL_SUPPORTED_REPORTS_HID
@ SCRIPTEL_SUPPORTED_REPORTS_HID
The device supports vendor-specific (Scriptel) HID input reports.
Definition: scriptel-hid-reports.h:1214
scriptel_cardswipe_type
scriptel_cardswipe_type
This enumeration contains all of the valid magnetic card types.
Definition: scriptel-hid-reports.h:994
SCRIPTEL_CARDSWIPE_TYPE_UNKNOWN
@ SCRIPTEL_CARDSWIPE_TYPE_UNKNOWN
Identifier for unknown.
Definition: scriptel-hid-reports.h:1006
SCRIPTEL_CARDSWIPE_TYPE_IDENTIFICATION
@ SCRIPTEL_CARDSWIPE_TYPE_IDENTIFICATION
Identifier for identification (state identification) cards.
Definition: scriptel-hid-reports.h:1002
SCRIPTEL_CARDSWIPE_TYPE_FINANCIAL
@ SCRIPTEL_CARDSWIPE_TYPE_FINANCIAL
Identifier for financial (credit) cards.
Definition: scriptel-hid-reports.h:998
scriptel_output_mode
scriptel_output_mode
This enumeration contains output modes; whether the output is to be held off, or sent immediatly.
Definition: scriptel-hid-reports.h:694
TRANSMIT_ON_CONFIRM
@ TRANSMIT_ON_CONFIRM
Don't send coordinates until the OK button is pressed.
Definition: scriptel-hid-reports.h:702
TRANSMIT_ON_HOST_COMMAND
@ TRANSMIT_ON_HOST_COMMAND
Don't send coordinates until the host requests them.
Definition: scriptel-hid-reports.h:706
REAL_TIME
@ REAL_TIME
Send coordinates as soon as possible.
Definition: scriptel-hid-reports.h:698
scriptel_asic_power_state
scriptel_asic_power_state
This enumeration contains all of the valid power states for the ASIC.
Definition: scriptel-hid-reports.h:1035
SCRIPTEL_ASIC_POWER_STATE_POWERDOWN
@ SCRIPTEL_ASIC_POWER_STATE_POWERDOWN
The ASIC is off.
Definition: scriptel-hid-reports.h:1043
SCRIPTEL_ASIC_POWER_STATE_STANDBY
@ SCRIPTEL_ASIC_POWER_STATE_STANDBY
The ASIC is in standby mode.
Definition: scriptel-hid-reports.h:1047
SCRIPTEL_ASIC_POWER_STATE_NORMAL
@ SCRIPTEL_ASIC_POWER_STATE_NORMAL
The ASIC is on and running.
Definition: scriptel-hid-reports.h:1039
scriptel_display_type
scriptel_display_type
This enumeration contains the different types of screens that can be embedded in ScripTouch products.
Definition: scriptel-hid-reports.h:1259
SCRIPTEL_DISPLAY_TYPE_240X64_1X5_BLACKWHITE
@ SCRIPTEL_DISPLAY_TYPE_240X64_1X5_BLACKWHITE
The device has a 5x1 inch 240x64 pixel black and white screen equipped.
Definition: scriptel-hid-reports.h:1267
SCRIPTEL_DISPLAY_TYPE_240X64_1X5_GRAYSCALE
@ SCRIPTEL_DISPLAY_TYPE_240X64_1X5_GRAYSCALE
The device has a 5x1 inch 240x64 pixel gray-scale screen equipped.
Definition: scriptel-hid-reports.h:1271
SCRIPTEL_DISPLAY_TYPE_NONE
@ SCRIPTEL_DISPLAY_TYPE_NONE
The device has no display equipped.
Definition: scriptel-hid-reports.h:1263
scriptel_resource_justification
scriptel_resource_justification
Enum that is used to determine the vertical and horizontal justification of objects within a region.
Definition: scriptel-hid-reports.h:3201
SCRIPTEL_JUSTIFICATION_CENTER
@ SCRIPTEL_JUSTIFICATION_CENTER
Justifies the resouce to the center.
Definition: scriptel-hid-reports.h:3221
SCRIPTEL_JUSTIFICATION_BOTTOM
@ SCRIPTEL_JUSTIFICATION_BOTTOM
Justifies the resouce to the bottom.
Definition: scriptel-hid-reports.h:3217
SCRIPTEL_JUSTIFICATION_TOP
@ SCRIPTEL_JUSTIFICATION_TOP
Justifies the resouce to the top.
Definition: scriptel-hid-reports.h:3209
SCRIPTEL_JUSTIFICATION_LEFT
@ SCRIPTEL_JUSTIFICATION_LEFT
Justifies the resouce to the left.
Definition: scriptel-hid-reports.h:3205
SCRIPTEL_JUSTIFICATION_RIGHT
@ SCRIPTEL_JUSTIFICATION_RIGHT
Justifies the resouce to the right.
Definition: scriptel-hid-reports.h:3213
scriptel_pen_coord_type
scriptel_pen_coord_type
Enum that is used to specify the pen coordinate space.
Definition: scriptel-hid-reports.h:3227
SCRIPTEL_PEN_COORD_DISPLAY_SPACE
@ SCRIPTEL_PEN_COORD_DISPLAY_SPACE
Use the coordinate system of display pixels.
Definition: scriptel-hid-reports.h:3231
SCRIPTEL_PEN_COORD_DEVICE_SPACE
@ SCRIPTEL_PEN_COORD_DEVICE_SPACE
Use the coordinate system of device output.
Definition: scriptel-hid-reports.h:3235
scriptel_engineering_test
scriptel_engineering_test
Definition: scriptel-hid-reports.h:1313
SCRIPTEL_ENGINEERING_TEST_DISPLAY
@ SCRIPTEL_ENGINEERING_TEST_DISPLAY
Set pen coordinates in screen units.
Definition: scriptel-hid-reports.h:1317
SCRIPTEL_ENGINEERING_TEST_NATIVE
@ SCRIPTEL_ENGINEERING_TEST_NATIVE
Set pen coordinates in the native output unit; e.g.
Definition: scriptel-hid-reports.h:1321
scriptel_device_pentouch_mode
scriptel_device_pentouch_mode
This enumeration contains all supported pen modes.
Definition: scriptel-hid-reports.h:638
SCRIPTEL_PTMODE_SINGLE
@ SCRIPTEL_PTMODE_SINGLE
Pen is in single mode.
Definition: scriptel-hid-reports.h:642
SCRIPTEL_PTMODE_STREAM
@ SCRIPTEL_PTMODE_STREAM
Pen is in stream mode.
Definition: scriptel-hid-reports.h:650
SCRIPTEL_PTMODE_SINGLE_LIFTOFF
@ SCRIPTEL_PTMODE_SINGLE_LIFTOFF
Pen is in single liftoff mode.
Definition: scriptel-hid-reports.h:646
SCRIPTEL_PTMODE_CONTINUOUS
@ SCRIPTEL_PTMODE_CONTINUOUS
Pen is in continuous mode.
Definition: scriptel-hid-reports.h:658
SCRIPTEL_PTMODE_STREAM_LIFTOFF
@ SCRIPTEL_PTMODE_STREAM_LIFTOFF
Pen is in stream liftoff mode.
Definition: scriptel-hid-reports.h:654
scriptel_device_acquisition_mode
scriptel_device_acquisition_mode
This enumeration contains all supported acquisition modes.
Definition: scriptel-hid-reports.h:616
SCRIPTEL_ACQMODE_COMMAND
@ SCRIPTEL_ACQMODE_COMMAND
Device is in command mode.
Definition: scriptel-hid-reports.h:632
SCRIPTEL_ACQMODE_TOUCH
@ SCRIPTEL_ACQMODE_TOUCH
Device is in the touch acquisition mode.
Definition: scriptel-hid-reports.h:620
SCRIPTEL_ACQMODE_PEN
@ SCRIPTEL_ACQMODE_PEN
Device is in the pen acquisition mode.
Definition: scriptel-hid-reports.h:624
SCRIPTEL_ACQMODE_AUTOTOUCH
@ SCRIPTEL_ACQMODE_AUTOTOUCH
Device is in the auto-touch acquisition mode.
Definition: scriptel-hid-reports.h:628
scriptel_tuning_state
scriptel_tuning_state
Definition: scriptel-hid-reports.h:1076
SCRIPTEL_LOCATION_2_STYLUS_UP
@ SCRIPTEL_LOCATION_2_STYLUS_UP
Waiting for stylus to press at bottom right of the glass.
Definition: scriptel-hid-reports.h:1092
SCRIPTEL_LOCATION_1_STYLUS_DOWN
@ SCRIPTEL_LOCATION_1_STYLUS_DOWN
Stylus down at top left of the glass.
Definition: scriptel-hid-reports.h:1080
SCRIPTEL_LOCATION_2_STYLUS_DOWN
@ SCRIPTEL_LOCATION_2_STYLUS_DOWN
Stylus down at bottom right of the glass.
Definition: scriptel-hid-reports.h:1088
SCRIPTEL_LOCATION_1_STYLUS_UP
@ SCRIPTEL_LOCATION_1_STYLUS_UP
Waiting for stylus to press at top left of the glass.
Definition: scriptel-hid-reports.h:1084
scriptel_region_type
scriptel_region_type
This enumeration contains all valid region types and their numeric identifiers.
Definition: scriptel-hid-reports.h:664
SCRIPTEL_REGION_TYPE_LINE
@ SCRIPTEL_REGION_TYPE_LINE
Type for lines.
Definition: scriptel-hid-reports.h:676
SCRIPTEL_REGION_TYPE_GRAPHIC
@ SCRIPTEL_REGION_TYPE_GRAPHIC
Type for graphics.
Definition: scriptel-hid-reports.h:680
SCRIPTEL_REGION_TYPE_CONTAINER
@ SCRIPTEL_REGION_TYPE_CONTAINER
Type for containers.
Definition: scriptel-hid-reports.h:668
SCRIPTEL_REGION_TYPE_NULL
@ SCRIPTEL_REGION_TYPE_NULL
Type for null regions.
Definition: scriptel-hid-reports.h:688
SCRIPTEL_REGION_TYPE_BUTTON
@ SCRIPTEL_REGION_TYPE_BUTTON
Type for buttons.
Definition: scriptel-hid-reports.h:672
SCRIPTEL_REGION_TYPE_TEXT
@ SCRIPTEL_REGION_TYPE_TEXT
Type for text.
Definition: scriptel-hid-reports.h:684
scriptel_resource_type
scriptel_resource_type
Defines an enumeration of all the resource types.
Definition: scriptel-hid-reports.h:2775
SCRIPTEL_RESOURCE_TYPE_GRAPHIC
@ SCRIPTEL_RESOURCE_TYPE_GRAPHIC
Graphic resource.
Definition: scriptel-hid-reports.h:2783
SCRIPTEL_RESOURCE_TYPE_INVALID
@ SCRIPTEL_RESOURCE_TYPE_INVALID
Invalid/Null resource.
Definition: scriptel-hid-reports.h:2787
SCRIPTEL_RESOURCE_TYPE_TEXT
@ SCRIPTEL_RESOURCE_TYPE_TEXT
Rext resource.
Definition: scriptel-hid-reports.h:2779
argb
Definition: scriptel-hid-reports.h:1944
scriptel_color
This structure describes a particular color in 32-bit space.
Definition: scriptel-hid-reports.h:2308
scriptel_color::red
unsigned char red
The red channel of this color.
Definition: scriptel-hid-reports.h:2324
scriptel_color::green
unsigned char green
The green channel of this color.
Definition: scriptel-hid-reports.h:2320
scriptel_color::blue
unsigned char blue
The blue channel of this color.
Definition: scriptel-hid-reports.h:2316
scriptel_color::alpha
unsigned char alpha
The alpha channel of this color.
Definition: scriptel-hid-reports.h:2312
scriptel_device_region_button
This structure contains all button specific information about a region.
Definition: scriptel-hid-reports.h:2557
scriptel_device_region_button::region_info
scriptel_device_region_common region_info
Common items to all regions.
Definition: scriptel-hid-reports.h:2561
scriptel_device_region_button::reserved
unsigned short reserved
Reserved for future use.
Definition: scriptel-hid-reports.h:2581
scriptel_device_region_button::enable
unsigned char enable
Whether or not this button is enabled.
Definition: scriptel-hid-reports.h:2569
scriptel_device_region_button::highlight_on_select
unsigned char highlight_on_select
Whether or not the button will highlight when selected.
Definition: scriptel-hid-reports.h:2573
scriptel_device_region_button::clear_on_select
unsigned char clear_on_select
Whether or not the button will clear when selected.
Definition: scriptel-hid-reports.h:2577
scriptel_device_region_button::parent
unsigned char parent
Parent region for this button.
Definition: scriptel-hid-reports.h:2565
scriptel_device_region_common
This structure contains all of the items that are common to all regions regardless of type.
Definition: scriptel-hid-reports.h:2462
scriptel_device_region_common::color_foreground
scriptel_color color_foreground
The foreground color of the region.
Definition: scriptel-hid-reports.h:2521
scriptel_device_region_common::x1
unsigned short x1
The left-most side of the region.
Definition: scriptel-hid-reports.h:2505
scriptel_device_region_common::region_type
scriptel_region_type region_type
The type of region this is.
Definition: scriptel-hid-reports.h:2470
scriptel_device_region_common::region_number
unsigned char region_number
The region number.
Definition: scriptel-hid-reports.h:2466
scriptel_device_region_common::reserved_2
unsigned int reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:2501
scriptel_device_region_common::in_use
unsigned char in_use
Flag for in use, has a similar effect to visible.
Definition: scriptel-hid-reports.h:2488
scriptel_device_region_common::visible
unsigned char visible
Whether or not this region is visible on the screen.
Definition: scriptel-hid-reports.h:2484
scriptel_device_region_common::y1
unsigned short y1
The top-most side of the region.
Definition: scriptel-hid-reports.h:2513
scriptel_device_region_common::accept_touch
unsigned char accept_touch
Whether or not this region accepts touch.
Definition: scriptel-hid-reports.h:2474
scriptel_device_region_common::decode
unsigned char decode
Whether or not this region gets decoded.
Definition: scriptel-hid-reports.h:2480
scriptel_device_region_common::x2
unsigned short x2
The right-most side of the region.
Definition: scriptel-hid-reports.h:2509
scriptel_device_region_common::color_background
scriptel_color color_background
The background color of the region.
Definition: scriptel-hid-reports.h:2525
scriptel_device_region_common::has_frame
unsigned char has_frame
Whether or not a one pixel frame should be drawn around this region.
Definition: scriptel-hid-reports.h:2493
scriptel_device_region_common::y2
unsigned short y2
The bottom-most side of the region.
Definition: scriptel-hid-reports.h:2517
scriptel_device_region_common::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:2497
scriptel_device_region_container
This structure contains all container specific information about a region.
Definition: scriptel-hid-reports.h:2531
scriptel_device_region_container::region_info
scriptel_device_region_common region_info
Common items to all regions.
Definition: scriptel-hid-reports.h:2535
scriptel_device_region_container::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:2547
scriptel_device_region_container::reserved_3
unsigned short reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:2551
scriptel_device_region_container::ink_enable
unsigned char ink_enable
Whether or not drawing in this area with the pen causes "ink" to be displayed.
Definition: scriptel-hid-reports.h:2539
scriptel_device_region_container::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:2543
scriptel_device_region_line
This structure contains all line specific region information.
Definition: scriptel-hid-reports.h:2591
scriptel_device_region_line::region_info
scriptel_device_region_common region_info
Common items to all regions.
Definition: scriptel-hid-reports.h:2595
scriptel_device_region_line::reserved
unsigned short reserved
Reserved for future use.
Definition: scriptel-hid-reports.h:2607
scriptel_device_region_line::width
unsigned char width
Line width, this is not implemented on all devices.
Definition: scriptel-hid-reports.h:2603
scriptel_device_region_line::parent
unsigned char parent
Parent region for this line.
Definition: scriptel-hid-reports.h:2599
scriptel_hid_capabilities
This structure describes the capabilities report of a ScripTouch device.
Definition: scriptel-hid-reports.h:1329
scriptel_hid_capabilities::reserved_13
unsigned int reserved_13
Reserved for future use.
Definition: scriptel-hid-reports.h:1455
scriptel_hid_capabilities::mag_reader_id
scriptel_card_reader mag_reader_id
The type of card reader the unit is equipped with.
Definition: scriptel-hid-reports.h:1422
scriptel_hid_capabilities::reserved_12
unsigned int reserved_12
Reserved for future use.
Definition: scriptel-hid-reports.h:1451
scriptel_hid_capabilities::coordinate_modes
unsigned char coordinate_modes
Bitmask indicating which coordinate output features are available.
Definition: scriptel-hid-reports.h:1342
scriptel_hid_capabilities::calibration_ymax
unsigned short calibration_ymax
Reserved for future use.
Definition: scriptel-hid-reports.h:1410
scriptel_hid_capabilities::reserved_7
unsigned short reserved_7
Reserved for future use.
Definition: scriptel-hid-reports.h:1430
scriptel_hid_capabilities::contrast_levels
unsigned char contrast_levels
The number of contrast levels the unit supports.
Definition: scriptel-hid-reports.h:1358
scriptel_hid_capabilities::supports_screens_resources
unsigned char supports_screens_resources
Defines additional features this device can use.
Definition: scriptel-hid-reports.h:1435
scriptel_hid_capabilities::reserved_14
unsigned int reserved_14
Reserved for future use.
Definition: scriptel-hid-reports.h:1459
scriptel_hid_capabilities::coordinate_ymin
unsigned short coordinate_ymin
The minimum coordinate that can be returned in the vertical direction.
Definition: scriptel-hid-reports.h:1390
scriptel_hid_capabilities::reserved_6
unsigned char reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:1426
scriptel_hid_capabilities::report_id
unsigned char report_id
Report ID, if successful should be set to SCRIPTEL_FEATURE_CAPABILITIES.
Definition: scriptel-hid-reports.h:1333
scriptel_hid_capabilities::coordinate_xmin
unsigned short coordinate_xmin
The minimum coordinate that can be returned in the horizontal direction.
Definition: scriptel-hid-reports.h:1382
scriptel_hid_capabilities::reserved_10
unsigned int reserved_10
Reserved for future use.
Definition: scriptel-hid-reports.h:1443
scriptel_hid_capabilities::digitizer_height
unsigned short digitizer_height
The width of the physical digitizer surface in millimeters.
Definition: scriptel-hid-reports.h:1378
scriptel_hid_capabilities::coordinate_xmax
unsigned short coordinate_xmax
The maximum coordinate that can be returned in the horizontal direction.
Definition: scriptel-hid-reports.h:1386
scriptel_hid_capabilities::color_depth
unsigned char color_depth
The color depth in bits of the unit's screen (if equipped).
Definition: scriptel-hid-reports.h:1362
scriptel_hid_capabilities::brightness_levels
unsigned char brightness_levels
The number of back-light brightness levels the unit supports.
Definition: scriptel-hid-reports.h:1354
scriptel_hid_capabilities::display_id
scriptel_display_type display_id
The type of display the unit is equipped with.
Definition: scriptel-hid-reports.h:1350
scriptel_hid_capabilities::display_height
unsigned short display_height
The height of the display in pixels.
Definition: scriptel-hid-reports.h:1370
scriptel_hid_capabilities::calibration_ymin
unsigned short calibration_ymin
Reserved for future use.
Definition: scriptel-hid-reports.h:1406
scriptel_hid_capabilities::reserved_5
unsigned int reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:1418
scriptel_hid_capabilities::reserved_9
unsigned char reserved_9
Reserved for future use.
Definition: scriptel-hid-reports.h:1439
scriptel_hid_capabilities::reserved_4
unsigned int reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:1414
scriptel_hid_capabilities::display_width
unsigned short display_width
The width of the display in pixels.
Definition: scriptel-hid-reports.h:1366
scriptel_hid_capabilities::calibration_xmin
unsigned short calibration_xmin
Reserved for future use.
Definition: scriptel-hid-reports.h:1398
scriptel_hid_capabilities::digitizer_width
unsigned short digitizer_width
The width of the physical digitizer surface in millimeters.
Definition: scriptel-hid-reports.h:1374
scriptel_hid_capabilities::coordinate_ymax
unsigned short coordinate_ymax
The maximum coordinate that can be returned in the vertical direction.
Definition: scriptel-hid-reports.h:1394
scriptel_hid_capabilities::reserved_11
unsigned int reserved_11
Reserved for future use.
Definition: scriptel-hid-reports.h:1447
scriptel_hid_capabilities::supported_reports
unsigned short supported_reports
A bit-mask of values contained in scriptel_supported_reports.
Definition: scriptel-hid-reports.h:1338
scriptel_hid_capabilities::calibration_xmax
unsigned short calibration_xmax
Reserved for future use.
Definition: scriptel-hid-reports.h:1402
scriptel_hid_capabilities::reserved1
unsigned char reserved1
Reserved for future use.
Definition: scriptel-hid-reports.h:1346
scriptel_hid_feature_asic_reset
This structure allows the reset of a device ASIC.
Definition: scriptel-hid-reports.h:1810
scriptel_hid_feature_asic_reset::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_ASICRESET.
Definition: scriptel-hid-reports.h:1814
scriptel_hid_feature_asic_reset::hardware_reset
unsigned char hardware_reset
Indicates whether or not a hardware reset (1) or software reset(0) should be used.
Definition: scriptel-hid-reports.h:1818
scriptel_hid_feature_asic_reset::reserved
unsigned char reserved
Reserved for later use.
Definition: scriptel-hid-reports.h:1822
scriptel_hid_feature_calibrate
This structure contains information about whether or not the device is currently calibrating.
Definition: scriptel-hid-reports.h:2757
scriptel_hid_feature_calibrate::point
scriptel_calibration_point point
If the device is in calibration mode, what point is the device waiting for?
Definition: scriptel-hid-reports.h:2770
scriptel_hid_feature_calibrate::calibration_mode
unsigned char calibration_mode
Whether or not the device is in calibration mode.
Definition: scriptel-hid-reports.h:2765
scriptel_hid_feature_calibrate::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_CALIBRATE.
Definition: scriptel-hid-reports.h:2761
scriptel_hid_feature_calibration_data
This report contains information about the current calibration state of a ScripTouch device.
Definition: scriptel-hid-reports.h:2230
scriptel_hid_feature_calibration_data::local_multiplier_scale
unsigned short local_multiplier_scale
local multiplier scale
Definition: scriptel-hid-reports.h:2250
scriptel_hid_feature_calibration_data::rotation_sin_scaled
short rotation_sin_scaled
rotation sine scaled
Definition: scriptel-hid-reports.h:2258
scriptel_hid_feature_calibration_data::local_y_offset
long local_y_offset
local Y offset
Definition: scriptel-hid-reports.h:2286
scriptel_hid_feature_calibration_data::local_y_multiplier_scaled
long local_y_multiplier_scaled
local Y multiplier scaled
Definition: scriptel-hid-reports.h:2282
scriptel_hid_feature_calibration_data::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_CALIBRATION_DATA.
Definition: scriptel-hid-reports.h:2234
scriptel_hid_feature_calibration_data::calibration_type
unsigned char calibration_type
The type of calibration this report is refering to.
Definition: scriptel-hid-reports.h:2238
scriptel_hid_feature_calibration_data::local_x_offset
long local_x_offset
local X offset
Definition: scriptel-hid-reports.h:2278
scriptel_hid_feature_calibration_data::local_width_calibrated
unsigned short local_width_calibrated
local width calibrated
Definition: scriptel-hid-reports.h:2266
scriptel_hid_feature_calibration_data::host_y_offset
long host_y_offset
host Y offset
Definition: scriptel-hid-reports.h:2302
scriptel_hid_feature_calibration_data::local_x_multiplier_scaled
long local_x_multiplier_scaled
local X multiplier scaled
Definition: scriptel-hid-reports.h:2274
scriptel_hid_feature_calibration_data::rotation_scale
unsigned short rotation_scale
rotation scale
Definition: scriptel-hid-reports.h:2246
scriptel_hid_feature_calibration_data::rotation_cos_scaled
short rotation_cos_scaled
rotation cosine scaled
Definition: scriptel-hid-reports.h:2262
scriptel_hid_feature_calibration_data::host_x_offset
long host_x_offset
host X offset
Definition: scriptel-hid-reports.h:2294
scriptel_hid_feature_calibration_data::host_x_multiplier_scaled
long host_x_multiplier_scaled
host X multiplier scaled
Definition: scriptel-hid-reports.h:2290
scriptel_hid_feature_calibration_data::local_height_calibrated
unsigned short local_height_calibrated
local height calibrated
Definition: scriptel-hid-reports.h:2270
scriptel_hid_feature_calibration_data::host_y_multiplier_scaled
long host_y_multiplier_scaled
host Y multiplier scaled
Definition: scriptel-hid-reports.h:2298
scriptel_hid_feature_calibration_data::host_multiplier_scale
unsigned short host_multiplier_scale
host multiplier scale
Definition: scriptel-hid-reports.h:2254
scriptel_hid_feature_calibration_data::is_calibrated
unsigned char is_calibrated
Whether the device is calibrated.
Definition: scriptel-hid-reports.h:2242
scriptel_hid_feature_contact_count_maximum
This report is capable of retrieving the maximum number of track-able contacts in a multi-touch digit...
Definition: scriptel-hid-reports.h:1483
scriptel_hid_feature_contact_count_maximum::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM.
Definition: scriptel-hid-reports.h:1487
scriptel_hid_feature_contact_count_maximum::contact_count_max
unsigned char contact_count_max
Number of supported simultaneous track-able digitizer contacts.
Definition: scriptel-hid-reports.h:1491
scriptel_hid_feature_coordinate_range
This report is capable of getting the coordinate range from the device.
Definition: scriptel-hid-reports.h:1582
scriptel_hid_feature_coordinate_range::x_max
unsigned short x_max
Maximum logical value in the horizontal direction to be returned by the device.
Definition: scriptel-hid-reports.h:1594
scriptel_hid_feature_coordinate_range::y_max
unsigned short y_max
Maximum logical value in the vertical direction to be returned by the device.
Definition: scriptel-hid-reports.h:1602
scriptel_hid_feature_coordinate_range::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_COORDINATERANGE.
Definition: scriptel-hid-reports.h:1586
scriptel_hid_feature_coordinate_range::y_min
unsigned short y_min
Minimum logical value in the vertical direction to be returned by the device.
Definition: scriptel-hid-reports.h:1598
scriptel_hid_feature_coordinate_range::x_min
unsigned short x_min
Minimum logical value in the horizontal direction to be returned by the device.
Definition: scriptel-hid-reports.h:1590
scriptel_hid_feature_delete_resource
Structure that can be used to delete a resource.
Definition: scriptel-hid-reports.h:2922
scriptel_hid_feature_delete_resource::resource_number
unsigned char resource_number
The index of the resource to be deleted.
Definition: scriptel-hid-reports.h:2930
scriptel_hid_feature_delete_resource::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_DELETE_RESOURCE.
Definition: scriptel-hid-reports.h:2926
scriptel_hid_feature_delete_screen
Structure that can be used to delete a screen.
Definition: scriptel-hid-reports.h:3422
scriptel_hid_feature_delete_screen::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_DELETE_SCREEN.
Definition: scriptel-hid-reports.h:3426
scriptel_hid_feature_delete_screen::screen_index
unsigned char screen_index
The index of the screen to be deleted from the device.
Definition: scriptel-hid-reports.h:3430
scriptel_hid_feature_device_configure
This report is capable of getting the device configuration.
Definition: scriptel-hid-reports.h:1464
scriptel_hid_feature_device_configure::report_id
unsigned char report_id
Report ID, should always be set to SCRIPTEL_FEATURE_DEVICECONFIGURE.
Definition: scriptel-hid-reports.h:1468
scriptel_hid_feature_device_configure::device_mode
unsigned char device_mode
Device Mode - Will be 1 if the device is configured to output pen digitizer reports,...
Definition: scriptel-hid-reports.h:1472
scriptel_hid_feature_device_configure::device_id
unsigned char device_id
Device ID - Presently unused.
Definition: scriptel-hid-reports.h:1476
scriptel_hid_feature_device_status
This report contains information about a ScripTouch device's current running state.
Definition: scriptel-hid-reports.h:2163
scriptel_hid_feature_device_status::is_idle
unsigned char is_idle
Is Idle (command mode)
Definition: scriptel-hid-reports.h:2175
scriptel_hid_feature_device_status::is_calibrating
unsigned char is_calibrating
Is calibrating.
Definition: scriptel-hid-reports.h:2183
scriptel_hid_feature_device_status::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_DEVICE_STATUS.
Definition: scriptel-hid-reports.h:2167
scriptel_hid_feature_device_status::all_output_commands_locked
unsigned char all_output_commands_locked
All output is locked.
Definition: scriptel-hid-reports.h:2187
scriptel_hid_feature_device_status::calibration_commands_locked
unsigned char calibration_commands_locked
Calibration commands locked.
Definition: scriptel-hid-reports.h:2207
scriptel_hid_feature_device_status::display_commands_locked
unsigned char display_commands_locked
Display commands locked.
Definition: scriptel-hid-reports.h:2203
scriptel_hid_feature_device_status::operating_mode_commands_locked
unsigned char operating_mode_commands_locked
Operating mode commands locked.
Definition: scriptel-hid-reports.h:2191
scriptel_hid_feature_device_status::calibration_required
unsigned char calibration_required
Calibration required (is not calibrated)
Definition: scriptel-hid-reports.h:2179
scriptel_hid_feature_device_status::screen_commands_locked
unsigned char screen_commands_locked
Screen commands locked.
Definition: scriptel-hid-reports.h:2199
scriptel_hid_feature_device_status::region_commands_locked
unsigned char region_commands_locked
Region commands locked.
Definition: scriptel-hid-reports.h:2195
scriptel_hid_feature_device_status::last_error
unsigned short last_error
The last error that occured, cleared on power up.
Definition: scriptel-hid-reports.h:2219
scriptel_hid_feature_device_status::is_initializing
unsigned char is_initializing
Is initializing.
Definition: scriptel-hid-reports.h:2171
scriptel_hid_feature_device_status::reserved2
unsigned short reserved2
Reserved for future use.
Definition: scriptel-hid-reports.h:2215
scriptel_hid_feature_device_status::reserved1
unsigned char reserved1
Reserved for future use.
Definition: scriptel-hid-reports.h:2211
scriptel_hid_feature_display_chunk
This structure contains information about a raster that should be displayed on the screen of a device...
Definition: scriptel-hid-reports.h:2425
scriptel_hid_feature_display_chunk::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK.
Definition: scriptel-hid-reports.h:2429
scriptel_hid_feature_display_chunk::bits_per_pixel
unsigned char bits_per_pixel
The number of bits per pixel, 1 for black and white, 4 for monochrome.
Definition: scriptel-hid-reports.h:2449
scriptel_hid_feature_display_chunk::x
unsigned short x
Where the bitmap should be positioned horizontally.
Definition: scriptel-hid-reports.h:2433
scriptel_hid_feature_display_chunk::width
unsigned short width
The width of the raster in pixels.
Definition: scriptel-hid-reports.h:2441
scriptel_hid_feature_display_chunk::y
unsigned short y
Where the bitmap should be positioned vertically.
Definition: scriptel-hid-reports.h:2437
scriptel_hid_feature_display_chunk::height
unsigned short height
The height of the raster in pixels.
Definition: scriptel-hid-reports.h:2445
scriptel_hid_feature_display_content
This structure contains information related to display content.
Definition: scriptel-hid-reports.h:2373
scriptel_hid_feature_display_content::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_DISPLAYCONTENT.
Definition: scriptel-hid-reports.h:2377
scriptel_hid_feature_display_content::content
unsigned char content
Content.
Definition: scriptel-hid-reports.h:2381
scriptel_hid_feature_display_info
This structure contains static information about a device's display and capabilities.
Definition: scriptel-hid-reports.h:2331
scriptel_hid_feature_display_info::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_DISPLAYINFO.
Definition: scriptel-hid-reports.h:2335
scriptel_hid_feature_display_info::color_depth
unsigned char color_depth
The color depth of the display in bits: 1 for black and white, 4 for monochrome.
Definition: scriptel-hid-reports.h:2351
scriptel_hid_feature_display_info::width
unsigned short width
Width of the on board display in pixels.
Definition: scriptel-hid-reports.h:2341
scriptel_hid_feature_display_info::max_caption_length
unsigned char max_caption_length
The maximum caption length supported on buttons.
Definition: scriptel-hid-reports.h:2367
scriptel_hid_feature_display_info::height
unsigned short height
Height of the on board display in pixels.
Definition: scriptel-hid-reports.h:2347
scriptel_hid_feature_display_info::text_height
unsigned char text_height
The height of a single character.
Definition: scriptel-hid-reports.h:2359
scriptel_hid_feature_display_info::text_width
unsigned char text_width
The width of a single character.
Definition: scriptel-hid-reports.h:2355
scriptel_hid_feature_display_info::region_count
unsigned char region_count
The number of regions this device supports.
Definition: scriptel-hid-reports.h:2363
scriptel_hid_feature_display_settings
This structure contains information about dynamic display settings.
Definition: scriptel-hid-reports.h:2387
scriptel_hid_feature_display_settings::red
unsigned char red
Red adjustment value, currently unused.
Definition: scriptel-hid-reports.h:2405
scriptel_hid_feature_display_settings::brightness
unsigned char brightness
Brightness of the screen's back-light (if equipped).
Definition: scriptel-hid-reports.h:2396
scriptel_hid_feature_display_settings::green
unsigned char green
Green adjustment value, currently unused.
Definition: scriptel-hid-reports.h:2409
scriptel_hid_feature_display_settings::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_DISPLAYSETTINGS.
Definition: scriptel-hid-reports.h:2391
scriptel_hid_feature_display_settings::blue
unsigned char blue
Blue adjustment value, currently unused.
Definition: scriptel-hid-reports.h:2413
scriptel_hid_feature_display_settings::contrast
unsigned char contrast
Contrast setting of the screen's display (if equipped).
Definition: scriptel-hid-reports.h:2401
scriptel_hid_feature_display_settings::set_command
unsigned char set_command
This flag determines the how the device will apply the settings in this report.
Definition: scriptel-hid-reports.h:2418
scriptel_hid_feature_download_command_status
This report indicates to the device that a firmware update session has been completed.
Definition: scriptel-hid-reports.h:1708
scriptel_hid_feature_download_command_status::report_id
unsigned char report_id
Report ID - Should always be SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS.
Definition: scriptel-hid-reports.h:1712
scriptel_hid_feature_download_command_status::command_status
unsigned short command_status
Command status – currently unused.
Definition: scriptel-hid-reports.h:1716
scriptel_hid_feature_edit_screen
Structure that can be used to modify a screen.
Definition: scriptel-hid-reports.h:3435
scriptel_hid_feature_edit_screen::timeout_set
unsigned char timeout_set
Used to declare we are changing the timeout value of this screen.
Definition: scriptel-hid-reports.h:3475
scriptel_hid_feature_edit_screen::region_screen_next
unsigned char region_screen_next
The screen that appears when this region is interacted with.
Definition: scriptel-hid-reports.h:3487
scriptel_hid_feature_edit_screen::timeout_screen_next
unsigned char timeout_screen_next
The index of the screen the device advances to when this screen times out.
Definition: scriptel-hid-reports.h:3495
scriptel_hid_feature_edit_screen::reserved_4
unsigned char reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:3455
scriptel_hid_feature_edit_screen::reserved_6
unsigned char reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:3463
scriptel_hid_feature_edit_screen::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_MODIFY_SCREEN.
Definition: scriptel-hid-reports.h:3439
scriptel_hid_feature_edit_screen::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:3451
scriptel_hid_feature_edit_screen::timeout
unsigned char timeout
The amount of time in seconds before this screen times out.
Definition: scriptel-hid-reports.h:3491
scriptel_hid_feature_edit_screen::reserved_5
unsigned char reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:3459
scriptel_hid_feature_edit_screen::screen_index
unsigned char screen_index
The screen we are modifying data on.
Definition: scriptel-hid-reports.h:3479
scriptel_hid_feature_edit_screen::region_add
unsigned char region_add
Used to add a region to the screen, cannot be used with region_delete.
Definition: scriptel-hid-reports.h:3467
scriptel_hid_feature_edit_screen::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3447
scriptel_hid_feature_edit_screen::region_index
unsigned char region_index
The region to be modified, if this report is being used for that.
Definition: scriptel-hid-reports.h:3483
scriptel_hid_feature_edit_screen::region_delete
unsigned char region_delete
Used to remove a region from the screen, cannot be used with region_add.
Definition: scriptel-hid-reports.h:3471
scriptel_hid_feature_edit_screen::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3443
scriptel_hid_feature_error_correction_table
This report is capable of getting and setting the internal error correction table on the device.
Definition: scriptel-hid-reports.h:1639
scriptel_hid_feature_error_correction_table::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_ERRORCORRECTION.
Definition: scriptel-hid-reports.h:1643
scriptel_hid_feature_firmware_download
This report is capable of uploading a new page of firmware to the device.
Definition: scriptel-hid-reports.h:1608
scriptel_hid_feature_firmware_download::address
unsigned int address
Address of the memory page to overwrite.
Definition: scriptel-hid-reports.h:1616
scriptel_hid_feature_firmware_download::report_id
unsigned char report_id
Report ID - Should always be SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD.
Definition: scriptel-hid-reports.h:1612
scriptel_hid_feature_firmware_download::checksum
unsigned char checksum
The checksum of the data.
Definition: scriptel-hid-reports.h:1632
scriptel_hid_feature_frequency_amplitude
This report contains ASIC frequency and amplitude settings.
Definition: scriptel-hid-reports.h:1497
scriptel_hid_feature_frequency_amplitude::pen_amplitude
unsigned char pen_amplitude
ASIC Pen Amplitude.
Definition: scriptel-hid-reports.h:1509
scriptel_hid_feature_frequency_amplitude::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE.
Definition: scriptel-hid-reports.h:1501
scriptel_hid_feature_frequency_amplitude::touch_amplitude
unsigned char touch_amplitude
ASIC Touch Amplitude.
Definition: scriptel-hid-reports.h:1513
scriptel_hid_feature_frequency_amplitude::frequency
unsigned char frequency
ASIC Frequency.
Definition: scriptel-hid-reports.h:1505
scriptel_hid_feature_general_parameters
This report gets and sets general digitizer parameters for the device.
Definition: scriptel-hid-reports.h:1752
scriptel_hid_feature_general_parameters::filter_frequency
unsigned char filter_frequency
Filter frequency.
Definition: scriptel-hid-reports.h:1804
scriptel_hid_feature_general_parameters::corner_upper_left
unsigned char corner_upper_left
Number of the upper left corner.
Definition: scriptel-hid-reports.h:1788
scriptel_hid_feature_general_parameters::map_coordinates
unsigned char map_coordinates
Whether or not coordinates get mapped to the host range.
Definition: scriptel-hid-reports.h:1768
scriptel_hid_feature_general_parameters::corner_lower_right
unsigned char corner_lower_right
Number of the lower right corner.
Definition: scriptel-hid-reports.h:1792
scriptel_hid_feature_general_parameters::report_id
unsigned char report_id
Report ID, Should always be SCRIPTEL_FEATURE_GENERALPARAMETERS.
Definition: scriptel-hid-reports.h:1756
scriptel_hid_feature_general_parameters::corner_lower_left
unsigned char corner_lower_left
Number of the lower left corner.
Definition: scriptel-hid-reports.h:1784
scriptel_hid_feature_general_parameters::corner_upper_right
unsigned char corner_upper_right
Number of the upper right corner.
Definition: scriptel-hid-reports.h:1796
scriptel_hid_feature_general_parameters::channel_lock_enable
unsigned char channel_lock_enable
Whether or not to use channel lock mode.
Definition: scriptel-hid-reports.h:1772
scriptel_hid_feature_general_parameters::adc_output_enable
unsigned char adc_output_enable
Whether or not to send ADC output.
Definition: scriptel-hid-reports.h:1764
scriptel_hid_feature_general_parameters::xy_output_enable
unsigned char xy_output_enable
Whether or not coordinates are going to be sent.
Definition: scriptel-hid-reports.h:1760
scriptel_hid_feature_general_parameters::reserved
unsigned char reserved
Reserved – currently unused.
Definition: scriptel-hid-reports.h:1780
scriptel_hid_feature_general_parameters::samples
unsigned short samples
Samples.
Definition: scriptel-hid-reports.h:1800
scriptel_hid_feature_general_parameters::channel_lock_number
unsigned char channel_lock_number
Channel index for channel lock mode.
Definition: scriptel-hid-reports.h:1776
scriptel_hid_feature_guid
16 byte char array holding the guid value for the device.
Definition: scriptel-hid-reports.h:1653
scriptel_hid_feature_guid::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS.
Definition: scriptel-hid-reports.h:1657
scriptel_hid_feature_operating_modes
This report gets the supported operating modes of the device.
Definition: scriptel-hid-reports.h:1722
scriptel_hid_feature_operating_modes::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_OPERATINGMODE.
Definition: scriptel-hid-reports.h:1726
scriptel_hid_feature_operating_modes::pen_mode
unsigned char pen_mode
Current pen mode, maps to scriptel_device_pentouch_mode.
Definition: scriptel-hid-reports.h:1746
scriptel_hid_feature_operating_modes::touch_mode
unsigned char touch_mode
Current touch mode, maps to scriptel_device_pentouch_mode.
Definition: scriptel-hid-reports.h:1742
scriptel_hid_feature_operating_modes::supported_modes
unsigned char supported_modes
Bit mask for supported capture modes, corresponds to scriptel_device_acquisition_mode.
Definition: scriptel-hid-reports.h:1730
scriptel_hid_feature_operating_modes::acquisition_mode
unsigned char acquisition_mode
Current acquisition mode maps to scriptel_device_acquisition_mode.
Definition: scriptel-hid-reports.h:1738
scriptel_hid_feature_operating_modes::reserved
unsigned char reserved
Reserved for future use.
Definition: scriptel-hid-reports.h:1734
scriptel_hid_feature_output_parameters
This structure contains information about output configuration.
Definition: scriptel-hid-reports.h:2052
scriptel_hid_feature_output_parameters::load_factory_settings
unsigned char load_factory_settings
Load Factory Settings.
Definition: scriptel-hid-reports.h:2080
scriptel_hid_feature_output_parameters::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_OUTPUTCONFIGURATION.
Definition: scriptel-hid-reports.h:2056
scriptel_hid_feature_output_parameters::save_as_default
unsigned char save_as_default
SaveAsDefault.
Definition: scriptel-hid-reports.h:2076
scriptel_hid_feature_output_parameters::compression
scriptel_compression_mode compression
The compression mode to use, see scriptel_compression_mode.
Definition: scriptel-hid-reports.h:2068
scriptel_hid_feature_output_parameters::output_mode
scriptel_output_mode output_mode
The output mode to use, see scriptel_output_mode.
Definition: scriptel-hid-reports.h:2064
scriptel_hid_feature_output_parameters::output_report
unsigned long output_report
OutputReport, flags for future use, set to 0.
Definition: scriptel-hid-reports.h:2060
scriptel_hid_feature_output_parameters::packets_per_second
unsigned short packets_per_second
Output rate, USB packets per second, 0 = as fast as possible.
Definition: scriptel-hid-reports.h:2072
scriptel_hid_feature_pen_parameters
This structure contains information about pen parameters.
Definition: scriptel-hid-reports.h:1860
scriptel_hid_feature_pen_parameters::debounce_post_up
unsigned char debounce_post_up
De-bounce post-up amount.
Definition: scriptel-hid-reports.h:1904
scriptel_hid_feature_pen_parameters::interrupt_rate
unsigned short interrupt_rate
Interrupt rate.
Definition: scriptel-hid-reports.h:1932
scriptel_hid_feature_pen_parameters::auto_pen_threshold
unsigned short auto_pen_threshold
Automatic pen threshold.
Definition: scriptel-hid-reports.h:1872
scriptel_hid_feature_pen_parameters::proximity
unsigned short proximity
Proximity of the pen.
Definition: scriptel-hid-reports.h:1868
scriptel_hid_feature_pen_parameters::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_PENPARAMETERS.
Definition: scriptel-hid-reports.h:1864
scriptel_hid_feature_pen_parameters::debounce_post_down
unsigned char debounce_post_down
De-bounce post-down amount.
Definition: scriptel-hid-reports.h:1896
scriptel_hid_feature_pen_parameters::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:1928
scriptel_hid_feature_pen_parameters::offset_correction_enable
unsigned char offset_correction_enable
Whether or not offset correction is enabled.
Definition: scriptel-hid-reports.h:1916
scriptel_hid_feature_pen_parameters::offset_interval
unsigned short offset_interval
Offset interval.
Definition: scriptel-hid-reports.h:1888
scriptel_hid_feature_pen_parameters::error_correction_enable
unsigned char error_correction_enable
Whether or not error correction is enabled.
Definition: scriptel-hid-reports.h:1908
scriptel_hid_feature_pen_parameters::tip_inverted
unsigned char tip_inverted
Whether or not the tip switch is inverted.
Definition: scriptel-hid-reports.h:1924
scriptel_hid_feature_pen_parameters::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:1920
scriptel_hid_feature_pen_parameters::debounce_pre_up
unsigned char debounce_pre_up
De-bounce pre-up amount.
Definition: scriptel-hid-reports.h:1900
scriptel_hid_feature_pen_parameters::adc_average
unsigned char adc_average
Amount of ADC averaging.
Definition: scriptel-hid-reports.h:1880
scriptel_hid_feature_pen_parameters::debounce_pre_down
unsigned char debounce_pre_down
De-bounce pre-down amount.
Definition: scriptel-hid-reports.h:1892
scriptel_hid_feature_pen_parameters::coordinate_average
unsigned char coordinate_average
Amount of Coordinate averaging.
Definition: scriptel-hid-reports.h:1884
scriptel_hid_feature_pen_parameters::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:1912
scriptel_hid_feature_pen_parameters::auto_touch_threshold
unsigned short auto_touch_threshold
Automatic touch threshold.
Definition: scriptel-hid-reports.h:1876
scriptel_hid_feature_peripheral_configuration
This structure contains information about peripheral configuration.
Definition: scriptel-hid-reports.h:2085
scriptel_hid_feature_peripheral_configuration::load_factory_settings
unsigned char load_factory_settings
Load Factory Settings.
Definition: scriptel-hid-reports.h:2157
scriptel_hid_feature_peripheral_configuration::reserved4
unsigned char reserved4
Reserved for future use.
Definition: scriptel-hid-reports.h:2109
scriptel_hid_feature_peripheral_configuration::reserved10
unsigned char reserved10
Reserved for future use.
Definition: scriptel-hid-reports.h:2133
scriptel_hid_feature_peripheral_configuration::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION.
Definition: scriptel-hid-reports.h:2089
scriptel_hid_feature_peripheral_configuration::reserved11
unsigned char reserved11
Reserved for future use.
Definition: scriptel-hid-reports.h:2137
scriptel_hid_feature_peripheral_configuration::reserved8
unsigned char reserved8
Reserved for future use.
Definition: scriptel-hid-reports.h:2125
scriptel_hid_feature_peripheral_configuration::reserved3
unsigned char reserved3
Reserved for future use.
Definition: scriptel-hid-reports.h:2105
scriptel_hid_feature_peripheral_configuration::reserved5
unsigned char reserved5
Reserved for future use.
Definition: scriptel-hid-reports.h:2113
scriptel_hid_feature_peripheral_configuration::reserved7
unsigned char reserved7
Reserved for future use.
Definition: scriptel-hid-reports.h:2121
scriptel_hid_feature_peripheral_configuration::save_as_default
unsigned char save_as_default
SaveAsDefault.
Definition: scriptel-hid-reports.h:2153
scriptel_hid_feature_peripheral_configuration::reserved9
unsigned char reserved9
Reserved for future use.
Definition: scriptel-hid-reports.h:2129
scriptel_hid_feature_peripheral_configuration::reserved6
unsigned char reserved6
Reserved for future use.
Definition: scriptel-hid-reports.h:2117
scriptel_hid_feature_peripheral_configuration::reserved2
unsigned char reserved2
Reserved for future use.
Definition: scriptel-hid-reports.h:2101
scriptel_hid_feature_peripheral_configuration::reserved13
unsigned char reserved13
Reserved for future use.
Definition: scriptel-hid-reports.h:2145
scriptel_hid_feature_peripheral_configuration::reserved12
unsigned char reserved12
Reserved for future use.
Definition: scriptel-hid-reports.h:2141
scriptel_hid_feature_peripheral_configuration::reserved14
unsigned char reserved14
Reserved for future use.
Definition: scriptel-hid-reports.h:2149
scriptel_hid_feature_peripheral_configuration::mag_card_output
scriptel_mag_card_output mag_card_output
The output mode used by the peripherals, see scriptel_peripheral_output.
Definition: scriptel-hid-reports.h:2093
scriptel_hid_feature_peripheral_configuration::reserved1
unsigned char reserved1
Reserved for future use.
Definition: scriptel-hid-reports.h:2097
scriptel_hid_feature_pixel_retrieval_location
Definition: scriptel-hid-reports.h:1935
scriptel_hid_feature_pixel_retrieval_location::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_REGISTERGET.
Definition: scriptel-hid-reports.h:1939
scriptel_hid_feature_pixel_values
This structure contains pixel information for getting or setting a portion of the screen.
Definition: scriptel-hid-reports.h:1954
scriptel_hid_feature_pixel_values::number_of_pixels
unsigned short number_of_pixels
The number of pixels to get or set.
Definition: scriptel-hid-reports.h:1970
scriptel_hid_feature_pixel_values::start_x
unsigned short start_x
The X position to begin at.
Definition: scriptel-hid-reports.h:1962
scriptel_hid_feature_pixel_values::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_REGISTERGET.
Definition: scriptel-hid-reports.h:1958
scriptel_hid_feature_pixel_values::start_y
unsigned short start_y
The y position to begin at.
Definition: scriptel-hid-reports.h:1966
scriptel_hid_feature_power_state
This report is capable of getting and setting the ASIC power state.
Definition: scriptel-hid-reports.h:1546
scriptel_hid_feature_power_state::power_state
scriptel_asic_power_state power_state
ASIC Power State - 1 for on, 0 otherwise.
Definition: scriptel-hid-reports.h:1554
scriptel_hid_feature_power_state::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_POWERSTATE.
Definition: scriptel-hid-reports.h:1550
scriptel_hid_feature_region_button
Defines a structure that represents a button region on the device.
Definition: scriptel-hid-reports.h:3122
scriptel_hid_feature_region_button::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:3158
scriptel_hid_feature_region_button::resource_number_normal
unsigned char resource_number_normal
Resource displayed when button is idle.
Definition: scriptel-hid-reports.h:3162
scriptel_hid_feature_region_button::highlight_on_select
unsigned char highlight_on_select
Button highlights when it is selected.
Definition: scriptel-hid-reports.h:3134
scriptel_hid_feature_region_button::resource_number_selected
unsigned char resource_number_selected
Resource displayed when button is selected.
Definition: scriptel-hid-reports.h:3166
scriptel_hid_feature_region_button::clear_on_select
unsigned char clear_on_select
Sends a clear message when selected.
Definition: scriptel-hid-reports.h:3138
scriptel_hid_feature_region_button::common
scriptel_hid_feature_region_common common
The common data of the region.
Definition: scriptel-hid-reports.h:3126
scriptel_hid_feature_region_button::use_resource
unsigned char use_resource
Use resource instead of a caption for this button.
Definition: scriptel-hid-reports.h:3146
scriptel_hid_feature_region_button::confirm_on_select
unsigned char confirm_on_select
Sends a confirm message when selected.
Definition: scriptel-hid-reports.h:3142
scriptel_hid_feature_region_button::enabled
unsigned char enabled
Button is enabled.
Definition: scriptel-hid-reports.h:3130
scriptel_hid_feature_region_button::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3154
scriptel_hid_feature_region_button::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3150
scriptel_hid_feature_region_common
This structure represents a region on the device that can be get or set.
Definition: scriptel-hid-reports.h:3002
scriptel_hid_feature_region_common::background_color
scriptel_color background_color
Background color of the region.
Definition: scriptel-hid-reports.h:3092
scriptel_hid_feature_region_common::reserved_8
unsigned char reserved_8
Reserved for future use.
Definition: scriptel-hid-reports.h:3064
scriptel_hid_feature_region_common::x1
unsigned short x1
X minimum of the region.
Definition: scriptel-hid-reports.h:3072
scriptel_hid_feature_region_common::reserved_4
unsigned char reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:3048
scriptel_hid_feature_region_common::reserved_6
unsigned char reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:3056
scriptel_hid_feature_region_common::region_type
scriptel_region_type region_type
The type of region this represents.
Definition: scriptel-hid-reports.h:3014
scriptel_hid_feature_region_common::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_REGION.
Definition: scriptel-hid-reports.h:3006
scriptel_hid_feature_region_common::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:3044
scriptel_hid_feature_region_common::decode_region
unsigned char decode_region
Whether or not this region gets decoded.
Definition: scriptel-hid-reports.h:3024
scriptel_hid_feature_region_common::output_to_host
unsigned char output_to_host
Determines if this region outputs data to the host.
Definition: scriptel-hid-reports.h:3032
scriptel_hid_feature_region_common::y1
unsigned short y1
Y minimum of the region.
Definition: scriptel-hid-reports.h:3080
scriptel_hid_feature_region_common::reserved_5
unsigned char reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:3052
scriptel_hid_feature_region_common::x2
unsigned short x2
X maximum of the region.
Definition: scriptel-hid-reports.h:3076
scriptel_hid_feature_region_common::reserved_9
unsigned char reserved_9
Reserved for future use.
Definition: scriptel-hid-reports.h:3068
scriptel_hid_feature_region_common::has_frame
unsigned char has_frame
Whether or not there is a frame around the region.
Definition: scriptel-hid-reports.h:3028
scriptel_hid_feature_region_common::reserved_7
unsigned char reserved_7
Reserved for future use.
Definition: scriptel-hid-reports.h:3060
scriptel_hid_feature_region_common::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3040
scriptel_hid_feature_region_common::region_index
unsigned char region_index
The region index on the device.
Definition: scriptel-hid-reports.h:3010
scriptel_hid_feature_region_common::foreground_color
scriptel_color foreground_color
Foreground color of the region.
Definition: scriptel-hid-reports.h:3088
scriptel_hid_feature_region_common::accepts_touch
unsigned char accepts_touch
Whether or not this region accepts touch.
Definition: scriptel-hid-reports.h:3018
scriptel_hid_feature_region_common::y2
unsigned short y2
Y maximum of the region.
Definition: scriptel-hid-reports.h:3084
scriptel_hid_feature_region_common::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3036
scriptel_hid_feature_region_container
Defines a structure that represents a container/ink region on the device.
Definition: scriptel-hid-reports.h:3097
scriptel_hid_feature_region_container::ink_enabled
unsigned char ink_enabled
Whether ink appears on the screen or not.
Definition: scriptel-hid-reports.h:3105
scriptel_hid_feature_region_container::common
scriptel_hid_feature_region_common common
The common data of the region.
Definition: scriptel-hid-reports.h:3101
scriptel_hid_feature_region_container::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3117
scriptel_hid_feature_region_container::ink_width
unsigned char ink_width
Width of the ink drawn on the screen.
Definition: scriptel-hid-reports.h:3109
scriptel_hid_feature_region_container::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3113
scriptel_hid_feature_region_delete
Describes a structure that can be used to delete a region.
Definition: scriptel-hid-reports.h:2683
scriptel_hid_feature_region_delete::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_REGIONDELETE.
Definition: scriptel-hid-reports.h:2687
scriptel_hid_feature_region_delete::region_number
unsigned char region_number
Region number to delete.
Definition: scriptel-hid-reports.h:2691
scriptel_hid_feature_region_edit_complete
This structure allows for the saving or discarding of updated region information.
Definition: scriptel-hid-reports.h:2727
scriptel_hid_feature_region_edit_complete::save_changes
scriptel_region_save_changes save_changes
Whether or not to save changes persistently.
Definition: scriptel-hid-reports.h:2735
scriptel_hid_feature_region_edit_complete::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_REGIONEDITCOMPLETE.
Definition: scriptel-hid-reports.h:2731
scriptel_hid_feature_region_graphic
Defines a structure that represents a graphic region on the device.
Definition: scriptel-hid-reports.h:3241
scriptel_hid_feature_region_graphic::graphic_number
unsigned char graphic_number
Resource number where the graphic is stored.
Definition: scriptel-hid-reports.h:3253
scriptel_hid_feature_region_graphic::common
scriptel_hid_feature_region_common common
The common data of the region.
Definition: scriptel-hid-reports.h:3245
scriptel_hid_feature_region_graphic::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3265
scriptel_hid_feature_region_graphic::vertical_justification
scriptel_resource_justification vertical_justification
Vertical justification of the graphic within the region.
Definition: scriptel-hid-reports.h:3261
scriptel_hid_feature_region_graphic::horizontal_justification
scriptel_resource_justification horizontal_justification
Horizontal justification of the graphic within the region.
Definition: scriptel-hid-reports.h:3257
scriptel_hid_feature_region_graphic::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3249
scriptel_hid_feature_region_line
Defines a structure that represents a line region on the device.
Definition: scriptel-hid-reports.h:3175
scriptel_hid_feature_region_line::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:3195
scriptel_hid_feature_region_line::common
scriptel_hid_feature_region_common common
The common data of the region.
Definition: scriptel-hid-reports.h:3179
scriptel_hid_feature_region_line::line_width
unsigned char line_width
Line width in pixels.
Definition: scriptel-hid-reports.h:3187
scriptel_hid_feature_region_line::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3191
scriptel_hid_feature_region_line::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3183
scriptel_hid_feature_region_text
Defines a structure that represents a text region on the device.
Definition: scriptel-hid-reports.h:3270
scriptel_hid_feature_region_text::resource_number
unsigned char resource_number
Resource number where the text is stored.
Definition: scriptel-hid-reports.h:3282
scriptel_hid_feature_region_text::common
scriptel_hid_feature_region_common common
The common data of the region.
Definition: scriptel-hid-reports.h:3274
scriptel_hid_feature_region_text::font_number
unsigned char font_number
The font used to write the characters to the screen.
Definition: scriptel-hid-reports.h:3286
scriptel_hid_feature_region_text::vertical_justification
scriptel_resource_justification vertical_justification
Vertical justification of the text in this region.
Definition: scriptel-hid-reports.h:3294
scriptel_hid_feature_region_text::horizontal_justification
scriptel_resource_justification horizontal_justification
Horizontal justification of the text in this region.
Definition: scriptel-hid-reports.h:3290
scriptel_hid_feature_region_text::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3278
scriptel_hid_feature_region_update
This structure describes an update to a region.
Definition: scriptel-hid-reports.h:2649
scriptel_hid_feature_region_update::color_foreground
scriptel_color color_foreground
Foreground color to use.
Definition: scriptel-hid-reports.h:2673
scriptel_hid_feature_region_update::reserved2
unsigned int reserved2
Reserved for future use.
Definition: scriptel-hid-reports.h:2677
scriptel_hid_feature_region_update::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_REGIONUPDATE.
Definition: scriptel-hid-reports.h:2653
scriptel_hid_feature_region_update::region_number
unsigned char region_number
Region number to update.
Definition: scriptel-hid-reports.h:2657
scriptel_hid_feature_region_update::visible
unsigned char visible
Whether or not this region should be visible.
Definition: scriptel-hid-reports.h:2665
scriptel_hid_feature_region_update::function_enable
unsigned char function_enable
Function enable.
Definition: scriptel-hid-reports.h:2661
scriptel_hid_feature_region_update::reserved1
unsigned char reserved1
Reserved for future use.
Definition: scriptel-hid-reports.h:2669
scriptel_hid_feature_register_get
This structure contains information from an ASIC register.
Definition: scriptel-hid-reports.h:1828
scriptel_hid_feature_register_get::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_REGISTERGET.
Definition: scriptel-hid-reports.h:1832
scriptel_hid_feature_register_set
This structure allows setting of ASIC registers.
Definition: scriptel-hid-reports.h:1842
scriptel_hid_feature_register_set::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_REGISTERSET.
Definition: scriptel-hid-reports.h:1846
scriptel_hid_feature_register_set::register_id
unsigned char register_id
Register to update.
Definition: scriptel-hid-reports.h:1850
scriptel_hid_feature_register_set::register_value
unsigned char register_value
Value to put into register.
Definition: scriptel-hid-reports.h:1854
scriptel_hid_feature_report_region
This structure transports a single region.
Definition: scriptel-hid-reports.h:2635
scriptel_hid_feature_report_region::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_REGIONSET.
Definition: scriptel-hid-reports.h:2639
scriptel_hid_feature_report_region::region
scriptel_device_region_info region
Region information.
Definition: scriptel-hid-reports.h:2643
scriptel_hid_feature_resource_availability
Defines a structure that represents the amount of open resources on the device.
Definition: scriptel-hid-reports.h:2936
scriptel_hid_feature_resource_availability::number_available
unsigned char number_available
Number of available resource saves available.
Definition: scriptel-hid-reports.h:2944
scriptel_hid_feature_resource_availability::reserved_12
unsigned int reserved_12
Reserved for future use.
Definition: scriptel-hid-reports.h:2996
scriptel_hid_feature_resource_availability::reserved_3
unsigned int reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:2960
scriptel_hid_feature_resource_availability::reserved_6
unsigned int reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:2972
scriptel_hid_feature_resource_availability::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY.
Definition: scriptel-hid-reports.h:2940
scriptel_hid_feature_resource_availability::reserved_2
unsigned int reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:2956
scriptel_hid_feature_resource_availability::reserved_10
unsigned int reserved_10
Reserved for future use.
Definition: scriptel-hid-reports.h:2988
scriptel_hid_feature_resource_availability::reserved_1
unsigned int reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:2952
scriptel_hid_feature_resource_availability::reserved_5
unsigned int reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:2968
scriptel_hid_feature_resource_availability::reserved_8
unsigned int reserved_8
Reserved for future use.
Definition: scriptel-hid-reports.h:2980
scriptel_hid_feature_resource_availability::reserved_4
unsigned int reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:2964
scriptel_hid_feature_resource_availability::reserved_9
unsigned int reserved_9
Reserved for future use.
Definition: scriptel-hid-reports.h:2984
scriptel_hid_feature_resource_availability::reserved_7
unsigned int reserved_7
Reserved for future use.
Definition: scriptel-hid-reports.h:2976
scriptel_hid_feature_resource_availability::reserved_11
unsigned int reserved_11
Reserved for future use.
Definition: scriptel-hid-reports.h:2992
scriptel_hid_feature_resource_availability::space_available
unsigned long space_available
Amount of space left in bytes.
Definition: scriptel-hid-reports.h:2948
scriptel_hid_feature_resource_info
Definition: scriptel-hid-reports.h:2790
scriptel_hid_feature_resource_info::reserved_8
unsigned char reserved_8
Reserved for future use.
Definition: scriptel-hid-reports.h:2842
scriptel_hid_feature_resource_info::resource_size
unsigned long resource_size
The total size of the resource in bytes.
Definition: scriptel-hid-reports.h:2810
scriptel_hid_feature_resource_info::resource_number
unsigned char resource_number
index of the resource on the device.
Definition: scriptel-hid-reports.h:2798
scriptel_hid_feature_resource_info::reserved_4
unsigned char reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:2826
scriptel_hid_feature_resource_info::reserved_6
unsigned char reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:2834
scriptel_hid_feature_resource_info::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_RESOURCE_INFO.
Definition: scriptel-hid-reports.h:2794
scriptel_hid_feature_resource_info::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:2822
scriptel_hid_feature_resource_info::reserved_5
unsigned char reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:2830
scriptel_hid_feature_resource_info::reserved_9
unsigned char reserved_9
Reserved for future use.
Definition: scriptel-hid-reports.h:2846
scriptel_hid_feature_resource_info::resource_crc
unsigned long resource_crc
CRC32 used to authenticate the resource.
Definition: scriptel-hid-reports.h:2814
scriptel_hid_feature_resource_info::reserved_7
unsigned char reserved_7
Reserved for future use.
Definition: scriptel-hid-reports.h:2838
scriptel_hid_feature_resource_info::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:2818
scriptel_hid_feature_resource_info::resource_type
scriptel_resource_type resource_type
Defines what kind of resource this currently represents.
Definition: scriptel-hid-reports.h:2802
scriptel_hid_feature_resource_info::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:2806
scriptel_hid_feature_resource
Defines a structure for a resource on the device.
Definition: scriptel-hid-reports.h:2855
scriptel_hid_feature_resource::reserved_8
unsigned char reserved_8
Reserved for future use.
Definition: scriptel-hid-reports.h:2909
scriptel_hid_feature_resource::resource_size
unsigned long resource_size
The total size of the resource in bytes.
Definition: scriptel-hid-reports.h:2881
scriptel_hid_feature_resource::resource_number
unsigned char resource_number
index of the resource on the device.
Definition: scriptel-hid-reports.h:2863
scriptel_hid_feature_resource::reserved_4
unsigned char reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:2893
scriptel_hid_feature_resource::reserved_6
unsigned char reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:2901
scriptel_hid_feature_resource::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_RESOURCE.
Definition: scriptel-hid-reports.h:2859
scriptel_hid_feature_resource::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:2889
scriptel_hid_feature_resource::reserved_5
unsigned char reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:2897
scriptel_hid_feature_resource::resource_crc
unsigned long resource_crc
CRC32 used to authenticate the resource.
Definition: scriptel-hid-reports.h:2885
scriptel_hid_feature_resource::reserved_7
unsigned char reserved_7
Reserved for future use.
Definition: scriptel-hid-reports.h:2905
scriptel_hid_feature_resource::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:2875
scriptel_hid_feature_resource::resource_type
scriptel_resource_type resource_type
Defines what kind of resource this currently represents.
Definition: scriptel-hid-reports.h:2867
scriptel_hid_feature_resource::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:2871
scriptel_hid_feature_resource::bytes_valid
unsigned short bytes_valid
Number of valid bytes incoming or outgoing in this structure.
Definition: scriptel-hid-reports.h:2913
scriptel_hid_feature_run_mode
This report is capable of both sending and receiving the current device run mode.
Definition: scriptel-hid-reports.h:1194
scriptel_hid_feature_run_mode::report_id
unsigned char report_id
Report ID, should always be set to SCRIPTEL_FEATURE_RUNMODE.
Definition: scriptel-hid-reports.h:1198
scriptel_hid_feature_run_mode::run_mode
scriptel_device_run_mode run_mode
Run mode the device is currently in or should be set to.
Definition: scriptel-hid-reports.h:1202
scriptel_hid_feature_save_configuration
This report is capable of setting the default run-mode on startup.
Definition: scriptel-hid-reports.h:1693
scriptel_hid_feature_save_configuration::startup_mode
scriptel_device_acquisition_mode startup_mode
Startup mode, should be one of scriptel_device_acquisition_mode.
Definition: scriptel-hid-reports.h:1701
scriptel_hid_feature_save_configuration::report_id
unsigned char report_id
Report ID - Should always be SCRIPTEL_FEATURE_SAVECONFIGURATION.
Definition: scriptel-hid-reports.h:1697
scriptel_hid_feature_screen_region_edit_complete
This structure allows for the saving or discarding of updated screen and region information.
Definition: scriptel-hid-reports.h:2741
scriptel_hid_feature_screen_region_edit_complete::save_changes
scriptel_screen_region_save_changes save_changes
Whether or not to save changes persistently.
Definition: scriptel-hid-reports.h:2749
scriptel_hid_feature_screen_region_edit_complete::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD.
Definition: scriptel-hid-reports.h:2745
scriptel_hid_feature_screen_region_info
Describes a structure that gets the screen and region limitations of the current device.
Definition: scriptel-hid-reports.h:3501
scriptel_hid_feature_screen_region_info::reserved_10
unsigned char reserved_10
Reserved for future use.
Definition: scriptel-hid-reports.h:3577
scriptel_hid_feature_screen_region_info::reserved_8
unsigned char reserved_8
Reserved for future use.
Definition: scriptel-hid-reports.h:3569
scriptel_hid_feature_screen_region_info::regions_per_screen
unsigned char regions_per_screen
Maximum number of regions that can be placed on a screen.
Definition: scriptel-hid-reports.h:3517
scriptel_hid_feature_screen_region_info::reserved_12
unsigned char reserved_12
Reserved for future use.
Definition: scriptel-hid-reports.h:3585
scriptel_hid_feature_screen_region_info::reserved_4
unsigned char reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:3553
scriptel_hid_feature_screen_region_info::reserved_6
unsigned char reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:3561
scriptel_hid_feature_screen_region_info::resource_count
unsigned char resource_count
Maximum number of resources that can be stored on the device.
Definition: scriptel-hid-reports.h:3521
scriptel_hid_feature_screen_region_info::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_SCREEN_REGION_INFO.
Definition: scriptel-hid-reports.h:3505
scriptel_hid_feature_screen_region_info::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:3549
scriptel_hid_feature_screen_region_info::reserved_5
unsigned char reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:3557
scriptel_hid_feature_screen_region_info::reserved_9
unsigned char reserved_9
Reserved for future use.
Definition: scriptel-hid-reports.h:3573
scriptel_hid_feature_screen_region_info::reserved_13
unsigned char reserved_13
Reserved for future use.
Definition: scriptel-hid-reports.h:3589
scriptel_hid_feature_screen_region_info::reserved_7
unsigned char reserved_7
Reserved for future use.
Definition: scriptel-hid-reports.h:3565
scriptel_hid_feature_screen_region_info::screen_count
unsigned char screen_count
Maximum number of screens that are stored on a device.
Definition: scriptel-hid-reports.h:3509
scriptel_hid_feature_screen_region_info::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3545
scriptel_hid_feature_screen_region_info::text_height
unsigned char text_height
Height in pixels of a character drawn on the device.
Definition: scriptel-hid-reports.h:3537
scriptel_hid_feature_screen_region_info::reserved_14
unsigned char reserved_14
Reserved for future use.
Definition: scriptel-hid-reports.h:3593
scriptel_hid_feature_screen_region_info::reserved_15
unsigned char reserved_15
Reserved for future use.
Definition: scriptel-hid-reports.h:3597
scriptel_hid_feature_screen_region_info::text_width
unsigned char text_width
Widths in pixels of the a character drawn on the device.
Definition: scriptel-hid-reports.h:3533
scriptel_hid_feature_screen_region_info::region_count
unsigned char region_count
Maximum number of regions that are stored on a device.
Definition: scriptel-hid-reports.h:3513
scriptel_hid_feature_screen_region_info::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3541
scriptel_hid_feature_screen_region_info::text_region_length
unsigned char text_region_length
Maximum length of a text region.
Definition: scriptel-hid-reports.h:3529
scriptel_hid_feature_screen_region_info::reserved_16
unsigned char reserved_16
Reserved for future use.
Definition: scriptel-hid-reports.h:3601
scriptel_hid_feature_screen_region_info::reserved_11
unsigned char reserved_11
Reserved for future use.
Definition: scriptel-hid-reports.h:3581
scriptel_hid_feature_screen_region_info::caption_length
unsigned char caption_length
Maximum length of a button caption.
Definition: scriptel-hid-reports.h:3525
scriptel_hid_feature_screen
Structure that can be used to get or set a screen on the device.
Definition: scriptel-hid-reports.h:3329
scriptel_hid_feature_screen::reserved_10
unsigned char reserved_10
Reserved for future use.
Definition: scriptel-hid-reports.h:3381
scriptel_hid_feature_screen::reserved_8
unsigned char reserved_8
Reserved for future use.
Definition: scriptel-hid-reports.h:3373
scriptel_hid_feature_screen::timeout_screen_next
unsigned char timeout_screen_next
The screen index that the device moves to when this screen times out.
Definition: scriptel-hid-reports.h:3405
scriptel_hid_feature_screen::reset_timeout_on_activity
unsigned char reset_timeout_on_activity
Resets the screen timeout if screen is interacted with.
Definition: scriptel-hid-reports.h:3341
scriptel_hid_feature_screen::reserved_12
unsigned char reserved_12
Reserved for future use.
Definition: scriptel-hid-reports.h:3389
scriptel_hid_feature_screen::reserved_4
unsigned char reserved_4
Reserved for future use.
Definition: scriptel-hid-reports.h:3357
scriptel_hid_feature_screen::reserved_6
unsigned char reserved_6
Reserved for future use.
Definition: scriptel-hid-reports.h:3365
scriptel_hid_feature_screen::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_SCREEN.
Definition: scriptel-hid-reports.h:3333
scriptel_hid_feature_screen::reserved_3
unsigned char reserved_3
Reserved for future use.
Definition: scriptel-hid-reports.h:3353
scriptel_hid_feature_screen::timeout
unsigned char timeout
The timeout in seconds for this screen.
Definition: scriptel-hid-reports.h:3401
scriptel_hid_feature_screen::screen_number
unsigned char screen_number
Index of the screen these variables represent.
Definition: scriptel-hid-reports.h:3337
scriptel_hid_feature_screen::reserved_5
unsigned char reserved_5
Reserved for future use.
Definition: scriptel-hid-reports.h:3361
scriptel_hid_feature_screen::reserved_9
unsigned char reserved_9
Reserved for future use.
Definition: scriptel-hid-reports.h:3377
scriptel_hid_feature_screen::reserved_13
unsigned char reserved_13
Reserved for future use.
Definition: scriptel-hid-reports.h:3393
scriptel_hid_feature_screen::reserved_7
unsigned char reserved_7
Reserved for future use.
Definition: scriptel-hid-reports.h:3369
scriptel_hid_feature_screen::reserved_2
unsigned char reserved_2
Reserved for future use.
Definition: scriptel-hid-reports.h:3349
scriptel_hid_feature_screen::reserved_14
unsigned char reserved_14
Reserved for future use.
Definition: scriptel-hid-reports.h:3397
scriptel_hid_feature_screen::region_count
unsigned char region_count
Number of regions on this screen.
Definition: scriptel-hid-reports.h:3409
scriptel_hid_feature_screen::reserved_1
unsigned char reserved_1
Reserved for future use.
Definition: scriptel-hid-reports.h:3345
scriptel_hid_feature_screen::reserved_11
unsigned char reserved_11
Reserved for future use.
Definition: scriptel-hid-reports.h:3385
scriptel_hid_feature_serial_number
This report is capable of getting and setting the internal serial number on the device.
Definition: scriptel-hid-reports.h:1668
scriptel_hid_feature_serial_number::write_key_2
unsigned char write_key_2
Write Key 2 - Should be 'N' for writing, cleared when reading.
Definition: scriptel-hid-reports.h:1687
scriptel_hid_feature_serial_number::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_SERIALNUMBER.
Definition: scriptel-hid-reports.h:1672
scriptel_hid_feature_serial_number::write_key_1
unsigned char write_key_1
Write Key 1 - Should be 'S' for writing, cleared when reading.
Definition: scriptel-hid-reports.h:1683
scriptel_hid_feature_touch_parameters
This structure contains information about touch parameters.
Definition: scriptel-hid-reports.h:1986
scriptel_hid_feature_touch_parameters::slope_liftoff
short slope_liftoff
Slope liftoff amount.
Definition: scriptel-hid-reports.h:2006
scriptel_hid_feature_touch_parameters::scale_x
unsigned short scale_x
Scale in the horizontal.
Definition: scriptel-hid-reports.h:2034
scriptel_hid_feature_touch_parameters::report_id
unsigned char report_id
Report ID, should be set to SCRIPTEL_FEATURE_TOUCHPARAMETERS.
Definition: scriptel-hid-reports.h:1990
scriptel_hid_feature_touch_parameters::offset_y
short offset_y
Offset the the vertical.
Definition: scriptel-hid-reports.h:2046
scriptel_hid_feature_touch_parameters::pressure_multiple
unsigned short pressure_multiple
Pressure multiple.
Definition: scriptel-hid-reports.h:2018
scriptel_hid_feature_touch_parameters::slope_minimum
unsigned char slope_minimum
Slope minimum.
Definition: scriptel-hid-reports.h:2010
scriptel_hid_feature_touch_parameters::error_correction_enable
unsigned char error_correction_enable
Whether or not error correction is enabled.
Definition: scriptel-hid-reports.h:2026
scriptel_hid_feature_touch_parameters::offset_x
short offset_x
Offset in the horizontal.
Definition: scriptel-hid-reports.h:2038
scriptel_hid_feature_touch_parameters::gain
unsigned char gain
Gain.
Definition: scriptel-hid-reports.h:2022
scriptel_hid_feature_touch_parameters::pressure_single
unsigned short pressure_single
Pressure Single.
Definition: scriptel-hid-reports.h:2014
scriptel_hid_feature_touch_parameters::scale_y
unsigned short scale_y
Scale in the vertical.
Definition: scriptel-hid-reports.h:2042
scriptel_hid_feature_touch_parameters::slope_down
short slope_down
Slope down amount.
Definition: scriptel-hid-reports.h:2002
scriptel_hid_feature_touch_parameters::reserved
unsigned char reserved
Reserved for future use.
Definition: scriptel-hid-reports.h:2030
scriptel_hid_feature_touch_parameters::adc_average
unsigned char adc_average
Amount of ADC averaging.
Definition: scriptel-hid-reports.h:1994
scriptel_hid_feature_touch_parameters::coordinate_average
unsigned char coordinate_average
Amount of coordinate averaging.
Definition: scriptel-hid-reports.h:1998
scriptel_hid_feature_tuning_status
Definition: scriptel-hid-reports.h:1516
scriptel_hid_feature_tuning_status::gain_setting
unsigned char gain_setting
Gain Setting.
Definition: scriptel-hid-reports.h:1540
scriptel_hid_feature_tuning_status::tuning_aborted
unsigned char tuning_aborted
tuning aborted indicates if tuning was previously aborted
Definition: scriptel-hid-reports.h:1532
scriptel_hid_feature_tuning_status::tuning_state
scriptel_tuning_state tuning_state
Indicates the current tuning step, only valid if tuning_mode indicates tuning is in progress.
Definition: scriptel-hid-reports.h:1536
scriptel_hid_feature_tuning_status::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS.
Definition: scriptel-hid-reports.h:1520
scriptel_hid_feature_tuning_status::tuning_mode
unsigned char tuning_mode
tuning mode indicates if tuning is in progress or not.
Definition: scriptel-hid-reports.h:1528
scriptel_hid_feature_tuning_status::command_id
unsigned char command_id
Command ID, should always be 0x54.
Definition: scriptel-hid-reports.h:1524
scriptel_hid_feature_version
This report is capable of getting the device version information.
Definition: scriptel-hid-reports.h:1560
scriptel_hid_feature_version::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_FEATURE_VERSIONINFO.
Definition: scriptel-hid-reports.h:1564
scriptel_hid_feature_version::asic_signature
unsigned short asic_signature
Signature of the ASIC.
Definition: scriptel-hid-reports.h:1576
scriptel_hid_input_adc_values
This structure represents a sample from the ADC.
Definition: scriptel-hid-reports.h:925
scriptel_hid_input_adc_values::sample1
unsigned short sample1
The first sample.
Definition: scriptel-hid-reports.h:974
scriptel_hid_input_adc_values::x_max
unsigned short x_max
Maximum horizontal scan.
Definition: scriptel-hid-reports.h:949
scriptel_hid_input_adc_values::y_max
unsigned short y_max
Maximum vertical scan.
Definition: scriptel-hid-reports.h:957
scriptel_hid_input_adc_values::report_id
unsigned char report_id
Report ID, should always be set to SCRIPTEL_INPUT_ADCVALUES.
Definition: scriptel-hid-reports.h:929
scriptel_hid_input_adc_values::y_min
unsigned short y_min
Minimum vertical scan.
Definition: scriptel-hid-reports.h:961
scriptel_hid_input_adc_values::sample4
unsigned short sample4
The forth sample.
Definition: scriptel-hid-reports.h:986
scriptel_hid_input_adc_values::x_min
unsigned short x_min
Minimum horizontal scan.
Definition: scriptel-hid-reports.h:953
scriptel_hid_input_adc_values::channel_number
unsigned char channel_number
The channel number of this sample.
Definition: scriptel-hid-reports.h:970
scriptel_hid_input_adc_values::data_type
scriptel_adc_data_type data_type
The data type of this sample.
Definition: scriptel-hid-reports.h:933
scriptel_hid_input_adc_values::sample_info
scriptel_sample_info sample_info
Sample information associated with this scan.
Definition: scriptel-hid-reports.h:945
scriptel_hid_input_adc_values::sample2
unsigned short sample2
The second sample.
Definition: scriptel-hid-reports.h:978
scriptel_hid_input_adc_values::sample3
unsigned short sample3
The third sample.
Definition: scriptel-hid-reports.h:982
scriptel_hid_input_button_down
This structure contains a button down event.
Definition: scriptel-hid-reports.h:3630
scriptel_hid_input_button_down::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_INPUT_BUTTONDOWN.
Definition: scriptel-hid-reports.h:3634
scriptel_hid_input_button_down::x
unsigned short x
Horizontal component.
Definition: scriptel-hid-reports.h:3638
scriptel_hid_input_button_down::y
unsigned short y
Vertical component.
Definition: scriptel-hid-reports.h:3642
scriptel_hid_input_button_down::region
scriptel_device_region_info * region
Button that was pushed down.
Definition: scriptel-hid-reports.h:3646
scriptel_hid_input_button_move
This structure contains a button move event.
Definition: scriptel-hid-reports.h:3652
scriptel_hid_input_button_move::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_INPUT_BUTTONMOVE.
Definition: scriptel-hid-reports.h:3656
scriptel_hid_input_button_move::x
unsigned short x
Horizontal Component.
Definition: scriptel-hid-reports.h:3660
scriptel_hid_input_button_move::y
unsigned short y
Vertical Component.
Definition: scriptel-hid-reports.h:3664
scriptel_hid_input_button_move::region
scriptel_device_region_info * region
Button that is being moved over.
Definition: scriptel-hid-reports.h:3668
scriptel_hid_input_button_press
This structure contains a button press event.
Definition: scriptel-hid-reports.h:3696
scriptel_hid_input_button_press::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_INPUT_BUTTONPRESS.
Definition: scriptel-hid-reports.h:3700
scriptel_hid_input_button_press::x
unsigned short x
Horizontal component.
Definition: scriptel-hid-reports.h:3704
scriptel_hid_input_button_press::y
unsigned short y
Vertical component.
Definition: scriptel-hid-reports.h:3708
scriptel_hid_input_button_press::region
scriptel_device_region_info * region
Button that was pressed.
Definition: scriptel-hid-reports.h:3712
scriptel_hid_input_button_up
This structure contains a button up event.
Definition: scriptel-hid-reports.h:3674
scriptel_hid_input_button_up::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_INPUT_BUTTONUP.
Definition: scriptel-hid-reports.h:3678
scriptel_hid_input_button_up::x
unsigned short x
Horizontal Component.
Definition: scriptel-hid-reports.h:3682
scriptel_hid_input_button_up::y
unsigned short y
Vertical component.
Definition: scriptel-hid-reports.h:3686
scriptel_hid_input_button_up::region
scriptel_device_region_info * region
Button that was released.
Definition: scriptel-hid-reports.h:3690
scriptel_hid_input_card_swipe
This structure carries information regarding a magnetic card swipe.
Definition: scriptel-hid-reports.h:1099
scriptel_hid_input_card_swipe::report_id
unsigned char report_id
Report ID, should always be set to SCRIPTEL_INPUT_MAGCARDDATA.
Definition: scriptel-hid-reports.h:1103
scriptel_hid_input_card_swipe::track1_status
scriptel_cardswipe_track_status track1_status
The status of track one.
Definition: scriptel-hid-reports.h:1111
scriptel_hid_input_card_swipe::track2_status
scriptel_cardswipe_track_status track2_status
The status of track two.
Definition: scriptel-hid-reports.h:1115
scriptel_hid_input_card_swipe::track3_status
scriptel_cardswipe_track_status track3_status
The status of track three.
Definition: scriptel-hid-reports.h:1119
scriptel_hid_input_card_swipe::card_format
scriptel_cardswipe_type card_format
The format of the card.
Definition: scriptel-hid-reports.h:1107
scriptel_hid_input_coordinate
This structure represents a basic coordinate without any region information.
Definition: scriptel-hid-reports.h:863
scriptel_hid_input_coordinate::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_INPUT_COORDINATE.
Definition: scriptel-hid-reports.h:867
scriptel_hid_input_coordinate::x
unsigned short x
Horizontal component of the sample.
Definition: scriptel-hid-reports.h:875
scriptel_hid_input_coordinate::y
unsigned short y
Vertical component of the sample.
Definition: scriptel-hid-reports.h:879
scriptel_hid_input_coordinate::sample_info
scriptel_sample_info sample_info
Information about the sample that produced this coordinate.
Definition: scriptel-hid-reports.h:871
scriptel_hid_input_debug_coordinate
This structure contains information about a debug coordinate from a ScripTouch device with debug firm...
Definition: scriptel-hid-reports.h:1138
scriptel_hid_input_debug_coordinate::x_max
unsigned short x_max
Maximum horizontal sample.
Definition: scriptel-hid-reports.h:1154
scriptel_hid_input_debug_coordinate::y_max
unsigned short y_max
Maximum vertical sample.
Definition: scriptel-hid-reports.h:1162
scriptel_hid_input_debug_coordinate::offset
unsigned short offset
Offset of the coordinate.
Definition: scriptel-hid-reports.h:1150
scriptel_hid_input_debug_coordinate::report_id
unsigned char report_id
Report ID, should always be set to SCRIPTEL_INPUT_DEBUGCOORDINATE.
Definition: scriptel-hid-reports.h:1142
scriptel_hid_input_debug_coordinate::y_min
unsigned short y_min
Minimum vertical sample.
Definition: scriptel-hid-reports.h:1166
scriptel_hid_input_debug_coordinate::y_errcor
unsigned short y_errcor
The vertical coordinate after error correction.
Definition: scriptel-hid-reports.h:1174
scriptel_hid_input_debug_coordinate::x_min
unsigned short x_min
Minimum horizontal sample.
Definition: scriptel-hid-reports.h:1158
scriptel_hid_input_debug_coordinate::sample_info
scriptel_sample_info sample_info
Information about the sample.
Definition: scriptel-hid-reports.h:1146
scriptel_hid_input_debug_coordinate::x_mapped
unsigned short x_mapped
The horizontal coordinate after being mapped.
Definition: scriptel-hid-reports.h:1178
scriptel_hid_input_debug_coordinate::region
unsigned char region
The region the last pen down even occurred in.
Definition: scriptel-hid-reports.h:1186
scriptel_hid_input_debug_coordinate::y_mapped
unsigned short y_mapped
The vertical coordinate after being mapped.
Definition: scriptel-hid-reports.h:1182
scriptel_hid_input_debug_coordinate::x_errcor
unsigned short x_errcor
The horizontal coordinate after error correction.
Definition: scriptel-hid-reports.h:1170
scriptel_hid_input_extended_coordinate
This structure represents an extended coordinate that does contain region information.
Definition: scriptel-hid-reports.h:885
scriptel_hid_input_extended_coordinate::report_id
unsigned char report_id
Report ID, should always be set to SCRIPTEL_INPUT_EXTENDEDCOORDINATE.
Definition: scriptel-hid-reports.h:889
scriptel_hid_input_extended_coordinate::x
unsigned short x
Horizontal component of the sample.
Definition: scriptel-hid-reports.h:897
scriptel_hid_input_extended_coordinate::y
unsigned short y
Vertical component of the sample.
Definition: scriptel-hid-reports.h:901
scriptel_hid_input_extended_coordinate::sample_info
scriptel_sample_info sample_info
Information about the sample that produced this coordinate.
Definition: scriptel-hid-reports.h:893
scriptel_hid_input_extended_coordinate::region
unsigned char region
The region number associated with the most recent stroke (since the last pen down event).
Definition: scriptel-hid-reports.h:905
scriptel_hid_input_type
This structure is common to all input reports.
Definition: scriptel-hid-reports.h:3718
scriptel_hid_input_type::report_id
unsigned char report_id
Report ID, will be one of any of the input report constants.
Definition: scriptel-hid-reports.h:3722
scriptel_pen_coordinate
Definition: scriptel-hid-reports.h:3604
scriptel_pen_coordinate::report_id
unsigned char report_id
Report ID, should always be SCRIPTEL_INPUT_BUTTONDOWN.
Definition: scriptel-hid-reports.h:3608
scriptel_pen_coordinate::coordinate_type
unsigned char coordinate_type
The coordinate space to use.
Definition: scriptel-hid-reports.h:3612
scriptel_pen_coordinate::x
unsigned short x
The x position to simulate a coordinate.
Definition: scriptel-hid-reports.h:3616
scriptel_pen_coordinate::y
unsigned short y
The y position to simulate a coordinate.
Definition: scriptel-hid-reports.h:3620
scriptel_pen_coordinate::pen_down
unsigned char pen_down
Whether the pen is simulated down (1) or up (0)
Definition: scriptel-hid-reports.h:3624
scriptel_sample_info_common
This structure contains information about a particular sample that is common to both pen and touch sa...
Definition: scriptel-hid-reports.h:772
scriptel_sample_info_common::data_source
unsigned char data_source
Data source of the sample.
Definition: scriptel-hid-reports.h:785
scriptel_sample_info_common::down
unsigned char down
This will be true if the pen (or finger) is currently against the screen.
Definition: scriptel-hid-reports.h:777
scriptel_sample_info_common::reserved2
unsigned char reserved2
Reserved for later use.
Definition: scriptel-hid-reports.h:789
scriptel_sample_info_common::reserved1
unsigned char reserved1
Reserved for later use.
Definition: scriptel-hid-reports.h:781
scriptel_sample_info_pen
This structure contains information about a pen sample.
Definition: scriptel-hid-reports.h:795
scriptel_sample_info_pen::tip_switch
unsigned char tip_switch
This will be true if the pen is currently against the screen.
Definition: scriptel-hid-reports.h:799
scriptel_sample_info_pen::data_source
unsigned char data_source
Data source of the sample.
Definition: scriptel-hid-reports.h:807
scriptel_sample_info_pen::reserved2
unsigned char reserved2
Reserved for later use.
Definition: scriptel-hid-reports.h:811
scriptel_sample_info_pen::reserved1
unsigned char reserved1
Reserved for later use.
Definition: scriptel-hid-reports.h:803
scriptel_sample_info_touch
This structure contains information about a touch sample.
Definition: scriptel-hid-reports.h:817
scriptel_sample_info_touch::contact_id
unsigned char contact_id
For multi-touch devices this will contain the identifier of the contact.
Definition: scriptel-hid-reports.h:826
scriptel_sample_info_touch::contact
unsigned char contact
This will be true if skin is currently contacting the glass.
Definition: scriptel-hid-reports.h:821
scriptel_sample_info_touch::data_source
unsigned char data_source
Data source of the touch event.
Definition: scriptel-hid-reports.h:834
scriptel_sample_info_touch::reserved2
unsigned char reserved2
Reserved for later use.
Definition: scriptel-hid-reports.h:838
scriptel_sample_info_touch::reserved1
unsigned char reserved1
Reserved for later use.
Definition: scriptel-hid-reports.h:830
scriptel_device_region_info
This union contains all types of regions.
Definition: scriptel-hid-reports.h:2613
scriptel_device_region_info::line
scriptel_device_region_line line
Line region information.
Definition: scriptel-hid-reports.h:2629
scriptel_device_region_info::button
scriptel_device_region_button button
Button region information.
Definition: scriptel-hid-reports.h:2625
scriptel_device_region_info::container
scriptel_device_region_container container
Container region information.
Definition: scriptel-hid-reports.h:2621
scriptel_device_region_info::common
scriptel_device_region_common common
Items common to all regions.
Definition: scriptel-hid-reports.h:2617
scriptel_hid_feature_pixel_values::color_data
Definition: scriptel-hid-reports.h:1971
scriptel_hid_feature_region
This union contains all region information.
Definition: scriptel-hid-reports.h:3299
scriptel_hid_feature_region::text
scriptel_hid_feature_region_text text
Text region.
Definition: scriptel-hid-reports.h:3323
scriptel_hid_feature_region::graphic
scriptel_hid_feature_region_graphic graphic
Graphic region.
Definition: scriptel-hid-reports.h:3319
scriptel_hid_feature_region::common
scriptel_hid_feature_region_common common
Common, the foundation of all regions.
Definition: scriptel-hid-reports.h:3303
scriptel_hid_feature_region::button
scriptel_hid_feature_region_button button
Button region.
Definition: scriptel-hid-reports.h:3311
scriptel_hid_feature_region::line
scriptel_hid_feature_region_line line
Line region.
Definition: scriptel-hid-reports.h:3315
scriptel_hid_feature_region::container
scriptel_hid_feature_region_container container
Container/Ink region.
Definition: scriptel-hid-reports.h:3307
scriptel_input_report
This union contains all valid input report types.
Definition: scriptel-hid-reports.h:3728
scriptel_input_report::card_swipe
scriptel_hid_input_card_swipe card_swipe
Magnetic card swipe report.
Definition: scriptel-hid-reports.h:3748
scriptel_input_report::extended_coordinate
scriptel_hid_input_extended_coordinate extended_coordinate
Extended coordinate report.
Definition: scriptel-hid-reports.h:3740
scriptel_input_report::button_up
scriptel_hid_input_button_up button_up
Button up report.
Definition: scriptel-hid-reports.h:3764
scriptel_input_report::adc_values
scriptel_hid_input_adc_values adc_values
ADC Value report.
Definition: scriptel-hid-reports.h:3744
scriptel_input_report::debug_coordinate
scriptel_hid_input_debug_coordinate debug_coordinate
Debug Coordinate report.
Definition: scriptel-hid-reports.h:3752
scriptel_input_report::button_move
scriptel_hid_input_button_move button_move
Button move report.
Definition: scriptel-hid-reports.h:3760
scriptel_input_report::coordinate
scriptel_hid_input_coordinate coordinate
Coordinate report.
Definition: scriptel-hid-reports.h:3736
scriptel_input_report::button_press
scriptel_hid_input_button_press button_press
Button press report.
Definition: scriptel-hid-reports.h:3768
scriptel_input_report::type
scriptel_hid_input_type type
Common items to all input types.
Definition: scriptel-hid-reports.h:3732
scriptel_input_report::button_down
scriptel_hid_input_button_down button_down
Button Down report.
Definition: scriptel-hid-reports.h:3756
scriptel_sample_info
This union represents all types of sample information that can be associated with a particular sample...
Definition: scriptel-hid-reports.h:845
scriptel_sample_info::common
scriptel_sample_info_common common
Sample information relevant to both pen and touch.
Definition: scriptel-hid-reports.h:849
scriptel_sample_info::touch
scriptel_sample_info_touch touch
Sample information relevant to only touch input.
Definition: scriptel-hid-reports.h:857
scriptel_sample_info::pen
scriptel_sample_info_pen pen
Sample information relevant to only pen input.
Definition: scriptel-hid-reports.h:853