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

Data Structures | Macros | Typedefs | Enumerations
scriptel-hid-reports.h File Reference

This file contains the headers required for lower level communication with ScripTouch devices. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Data Structures
struct | scriptel_sample_info_common
| This structure contains information about a particular sample that is common to both pen and touch samples. More...
struct | scriptel_sample_info_pen
| This structure contains information about a pen sample. More...
struct | scriptel_sample_info_touch
| This structure contains information about a touch sample. More...
union | scriptel_sample_info
| This union represents all types of sample information that can be associated with a particular sample. More...
struct | scriptel_hid_input_coordinate
| This structure represents a basic coordinate without any region information. More...
struct | scriptel_hid_input_extended_coordinate
| This structure represents an extended coordinate that does contain region information. More...
struct | scriptel_hid_input_adc_values
| This structure represents a sample from the ADC. More...
struct | scriptel_hid_input_card_swipe
| This structure carries information regarding a magnetic card swipe. More...
struct | scriptel_hid_input_debug_coordinate
| This structure contains information about a debug coordinate from a ScripTouch device with debug firmware. More...
struct | scriptel_hid_feature_run_mode
| This report is capable of both sending and receiving the current device run mode. More...
struct | scriptel_hid_capabilities
| This structure describes the capabilities report of a ScripTouch device. More...
struct | scriptel_hid_feature_device_configure
| This report is capable of getting the device configuration. More...
struct | scriptel_hid_feature_contact_count_maximum
| This report is capable of retrieving the maximum number of track-able contacts in a multi-touch digitizer. More...
struct | scriptel_hid_feature_frequency_amplitude
| This report contains ASIC frequency and amplitude settings. More...
struct | scriptel_hid_feature_tuning_status
struct | scriptel_hid_feature_power_state
| This report is capable of getting and setting the ASIC power state. More...
struct | scriptel_hid_feature_version
| This report is capable of getting the device version information. More...
struct | scriptel_hid_feature_coordinate_range
| This report is capable of getting the coordinate range from the device. More...
struct | scriptel_hid_feature_firmware_download
| This report is capable of uploading a new page of firmware to the device. More...
struct | scriptel_hid_feature_error_correction_table
| This report is capable of getting and setting the internal error correction table on the device. More...
struct | scriptel_hid_feature_guid
| 16 byte char array holding the guid value for the device. More...
struct | scriptel_hid_feature_serial_number
| This report is capable of getting and setting the internal serial number on the device. More...
struct | scriptel_hid_feature_save_configuration
| This report is capable of setting the default run-mode on startup. More...
struct | scriptel_hid_feature_download_command_status
| This report indicates to the device that a firmware update session has been completed. More...
struct | scriptel_hid_feature_operating_modes
| This report gets the supported operating modes of the device. More...
struct | scriptel_hid_feature_general_parameters
| This report gets and sets general digitizer parameters for the device. More...
struct | scriptel_hid_feature_asic_reset
| This structure allows the reset of a device ASIC. More...
struct | scriptel_hid_feature_register_get
| This structure contains information from an ASIC register. More...
struct | scriptel_hid_feature_register_set
| This structure allows setting of ASIC registers. More...
struct | scriptel_hid_feature_pen_parameters
| This structure contains information about pen parameters. More...
struct | scriptel_hid_feature_pixel_retrieval_location
struct | argb
struct | scriptel_hid_feature_pixel_values
| This structure contains pixel information for getting or setting a portion of the screen. More...
union | scriptel_hid_feature_pixel_values::color_data
struct | scriptel_hid_feature_touch_parameters
| This structure contains information about touch parameters. More...
struct | scriptel_hid_feature_output_parameters
| This structure contains information about output configuration. More...
struct | scriptel_hid_feature_peripheral_configuration
| This structure contains information about peripheral configuration. More...
struct | scriptel_hid_feature_device_status
| This report contains information about a ScripTouch device's current running state. More...
struct | scriptel_hid_feature_calibration_data
| This report contains information about the current calibration state of a ScripTouch device. More...
struct | scriptel_color
| This structure describes a particular color in 32-bit space. More...
struct | scriptel_hid_feature_display_info
| This structure contains static information about a device's display and capabilities. More...
struct | scriptel_hid_feature_display_content
| This structure contains information related to display content. More...
struct | scriptel_hid_feature_display_settings
| This structure contains information about dynamic display settings. More...
struct | scriptel_hid_feature_display_chunk
| This structure contains information about a raster that should be displayed on the screen of a device. More...
struct | scriptel_device_region_common
| This structure contains all of the items that are common to all regions regardless of type. More...
struct | scriptel_device_region_container
| This structure contains all container specific information about a region. More...
struct | scriptel_device_region_button
| This structure contains all button specific information about a region. More...
struct | scriptel_device_region_line
| This structure contains all line specific region information. More...
union | scriptel_device_region_info
| This union contains all types of regions. More...
struct | scriptel_hid_feature_report_region
| This structure transports a single region. More...
struct | scriptel_hid_feature_region_update
| This structure describes an update to a region. More...
struct | scriptel_hid_feature_region_delete
| Describes a structure that can be used to delete a region. More...
struct | scriptel_hid_feature_region_edit_complete
| This structure allows for the saving or discarding of updated region information. More...
struct | scriptel_hid_feature_screen_region_edit_complete
| This structure allows for the saving or discarding of updated screen and region information. More...
struct | scriptel_hid_feature_calibrate
| This structure contains information about whether or not the device is currently calibrating. More...
struct | scriptel_hid_feature_resource_info
struct | scriptel_hid_feature_resource
| Defines a structure for a resource on the device. More...
struct | scriptel_hid_feature_delete_resource
| Structure that can be used to delete a resource. More...
struct | scriptel_hid_feature_resource_availability
| Defines a structure that represents the amount of open resources on the device. More...
struct | scriptel_hid_feature_region_common
| This structure represents a region on the device that can be get or set. More...
struct | scriptel_hid_feature_region_container
| Defines a structure that represents a container/ink region on the device. More...
struct | scriptel_hid_feature_region_button
| Defines a structure that represents a button region on the device. More...
struct | scriptel_hid_feature_region_line
| Defines a structure that represents a line region on the device. More...
struct | scriptel_hid_feature_region_graphic
| Defines a structure that represents a graphic region on the device. More...
struct | scriptel_hid_feature_region_text
| Defines a structure that represents a text region on the device. More...
union | scriptel_hid_feature_region
| This union contains all region information. More...
struct | scriptel_hid_feature_screen
| Structure that can be used to get or set a screen on the device. More...
struct | scriptel_hid_feature_delete_screen
| Structure that can be used to delete a screen. More...
struct | scriptel_hid_feature_edit_screen
| Structure that can be used to modify a screen. More...
struct | scriptel_hid_feature_screen_region_info
| Describes a structure that gets the screen and region limitations of the current device. More...
struct | scriptel_pen_coordinate
struct | scriptel_hid_input_button_down
| This structure contains a button down event. More...
struct | scriptel_hid_input_button_move
| This structure contains a button move event. More...
struct | scriptel_hid_input_button_up
| This structure contains a button up event. More...
struct | scriptel_hid_input_button_press
| This structure contains a button press event. More...
struct | scriptel_hid_input_type
| This structure is common to all input reports. More...
union | scriptel_input_report
| This union contains all valid input report types. More...

## Macros
#define | SCRIPTEL_REGION_BASE_SIZE 28
| Defines the "base" region size, before factoring in caption length.

## Typedefs
typedef enum scriptel_displaysettings_command | scriptel_displaysettings_command
| This enumeration contains valid flags for the command byte field in the set display settings report.
typedef struct scriptel_pen_coordinate | scriptel_pen_coordinate

## Enumerations
enum | scriptel_hid_report_id { SCRIPTEL_FEATURE_RUNMODE = 10 , SCRIPTEL_FEATURE_CAPABILITIES = 11 , SCRIPTEL_FEATURE_DEVICE_STATUS = 13 , SCRIPTEL_FEATURE_DEVICECONFIGURE = 15 , SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM = 16 , SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE = 20 , SCRIPTEL_FEATURE_POWERSTATE = 21 , SCRIPTEL_FEATURE_VERSIONINFO = 22 , SCRIPTEL_FEATURE_COORDINATERANGE = 23 , SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD = 25 , SCRIPTEL_FEATURE_ERRORCORRECTION = 26 , SCRIPTEL_FEATURE_SERIALNUMBER = 27 , SCRIPTEL_FEATURE_SAVECONFIGURATION = 28 , SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS = 29 , SCRIPTEL_FEATURE_OPERATINGMODE = 40 , SCRIPTEL_FEATURE_GENERALPARAMETERS = 41 , SCRIPTEL_FEATURE_ASICRESET = 42 , SCRIPTEL_FEATURE_REGISTERGET = 43 , SCRIPTEL_FEATURE_REGISTERSET = 44 , SCRIPTEL_FEATURE_PENPARAMETERS = 50 , SCRIPTEL_FEATURE_TOUCHPARAMETERS = 60 , SCRIPTEL_FEATURE_OUTPUTCONFIGURATION = 91 , SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION = 92 , SCRIPTEL_FEATURE_CALIBRATION_DATA = 131 , SCRIPTEL_FEATURE_DISPLAYINFO = 100 , SCRIPTEL_FEATURE_DISPLAYCONTENT = 101 , SCRIPTEL_FEATURE_DISPLAYSETTINGS = 102 , SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK = 103 , SCRIPTEL_FEATURE_REGIONGET = 110 , SCRIPTEL_FEATURE_REGIONGETDEFAULT = 111 , SCRIPTEL_FEATURE_REGIONSET = 112 , SCRIPTEL_FEATURE_REGIONUPDATE = 113 , SCRIPTEL_FEATURE_REGIONDELETE = 114 , SCRIPTEL_FEATURE_REGIONEDITCOMPLETE = 115 , SCRIPTEL_FEATURE_CALIBRATE = 130 , SCRIPTEL_FEATURE_RESOURCE_IDX = 140 , SCRIPTEL_FEATURE_RESOURCE_INFO = 141 , SCRIPTEL_FEATURE_RESOURCE = 142 , SCRIPTEL_FEATURE_DELETE_RESOURCE = 143 , SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY = 144 , SCRIPTEL_FEATURE_REGION_IDX = 150 , SCRIPTEL_FEATURE_REGION = 152 , SCRIPTEL_FEATURE_DELETE_REGION = 153 , SCRIPTEL_FEATURE_SCREEN_IDX = 160 , SCRIPTEL_FEATURE_SCREEN = 162 , SCRIPTEL_FEATURE_DELETE_SCREEN = 163 , SCRIPTEL_FEATURE_MODIFY_SCREEN = 164 , SCRIPTEL_FEATURE_SCREEN_REGION_INFO = 170 , SCRIPTEL_FEATURE_ACTIVE_SCREEN = 171 , SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD = 172 , SCRIPTEL_INPUT_COORDINATE = 1 , SCRIPTEL_INPUT_EXTENDEDCOORDINATE = 2 , SCRIPTEL_INPUT_ADCVALUES = 3 , SCRIPTEL_INPUT_MOUSECOORDINATE = 4 , SCRIPTEL_INPUT_DIGITIZERPENCOORDINATE = 5 , SCRIPTEL_INPUT_DIGITIZERTOUCHCOORDINATE = 6 , SCRIPTEL_INPUT_KEYBOARD = 7 , SCRIPTEL_INPUT_MULTITOUCHCOORDINATE = 8 , SCRIPTEL_INPUT_MAGCARDDATA = 12 , SCRIPTEL_INPUT_DEBUGCOORDINATE = 254 , SCRIPTEL_FEATURE_ENGINEERING_TEST = 253 , SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION = 104 , SCRIPTEL_FEATURE_PIXELS = 105 , SCRIPTEL_INPUT_BUTTONDOWN = 250 , SCRIPTEL_INPUT_BUTTONMOVE = 251 , SCRIPTEL_INPUT_BUTTONUP = 252 , SCRIPTEL_INPUT_BUTTONPRESS = 253 , SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS = 230 }
| This enumeration contains all of the valid reports identifiers for reports that the ScripTouch firmware can respond to. More...
enum | scriptel_ouput_configuration_flags { SCRIPTEL_OUTPUT_CONFIGURATION_OEM = 0x00000001 , SCRIPTEL_OUTPUT_CONFIGURATION_OEM_EXTENDED = 0x00000002 , SCRIPTEL_OUTPUT_CONFIGURATION_MOUSE = 0x00000100 , SCRIPTEL_OUTPUT_CONFIGURATION_PEN_DIGITIZER = 0x00000200 , SCRIPTEL_OUTPUT_CONFIGURATION_TOUCH = 0x00000400 , SCRIPTEL_OUTPUT_CONFIGURATION_KEYBOARD = 0x00010000 , SCRIPTEL_OUTPUT_CONFIGURATION_RAW_DATA = 0x40000000 , SCRIPTEL_OUTPUT_CONFIGURATION_DEBUG_DATA = 0x80000000 }
| This enumeration contains the output report flags. More...
enum | scriptel_hid_report_size { SCRIPTEL_FEATURE_RUNMODE_SIZE = 2 , SCRIPTEL_FEATURE_CAPABILITIES_SIZE = 65 , SCRIPTEL_FEATURE_DEVICECONFIGURE_SIZE = 3 , SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM_SIZE = 2 , SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE_SIZE = 4 , SCRIPTEL_FEATURE_POWERSTATE_SIZE = 2 , SCRIPTEL_FEATURE_VERSIONINFO_SIZE = 9 , SCRIPTEL_FEATURE_COORDINATERANGE_SIZE = 9 , SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD_SIZE = 134 , SCRIPTEL_FEATURE_ERRORCORRECTION_SIZE = 2049 , SCRIPTEL_FEATURE_SERIALNUMBER_SIZE = 35 , SCRIPTEL_FEATURE_SAVECONFIGURATION_SIZE = 2 , SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS_SIZE = 3 , SCRIPTEL_FEATURE_OPERATINGMODE_SIZE = 5 , SCRIPTEL_FEATURE_GENERALPARAMETERS_SIZE = 6 , SCRIPTEL_FEATURE_ASICRESET_SIZE = 2 , SCRIPTEL_FEATURE_REGISTERGET_SIZE = 9 , SCRIPTEL_FEATURE_REGISTERSET_SIZE = 3 , SCRIPTEL_FEATURE_PENPARAMETERS_SIZE = 18 , SCRIPTEL_FEATURE_TOUCHPARAMETERS_SIZE = 22 , SCRIPTEL_FEATURE_OUTPUTCONFIGURATION_SIZE = 10 , SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION_SIZE = 17 , SCRIPTEL_FEATURE_DEVICE_STATUS_SIZE = 73 , SCRIPTEL_FEATURE_CALIBRATION_DATA_SIZE = 49 , SCRIPTEL_FEATURE_DISPLAYINFO_SIZE = 10 , SCRIPTEL_FEATURE_DISPLAYCONTENT_SIZE = 2 , SCRIPTEL_FEATURE_DISPLAYSETTINGS_SIZE = 7 , SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK_SIZE = 2049 , SCRIPTEL_FEATURE_REGIONUPDATE_SIZE = 12 , SCRIPTEL_FEATURE_REGIONDELETE_SIZE = 2 , SCRIPTEL_FEATURE_REGIONEDITCOMPLETE_SIZE = 2 , SCRIPTEL_FEATURE_RESOURCE_IDX_SIZE = 2 , SCRIPTEL_FEATURE_RESOURCE_INFO_SIZE = 20 , SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY_SIZE = 18 , SCRIPTEL_FEATURE_RESOURCE_SIZE = 1045 , SCRIPTEL_FEATURE_DELETE_RESOURCE_SIZE = 2 , SCRIPTEL_FEATURE_REGION_IDX_SIZE = 2 , SCRIPTEL_FEATURE_SCREEN_IDX_SIZE = 2 , SCRIPTEL_FEATURE_DELETE_REGION_SIZE = 2 , SCRIPTEL_FEATURE_SCREEN_SIZE = 80 , SCRIPTEL_FEATURE_DELETE_SCREEN_SIZE = 2 , SCRIPTEL_FEATURE_MODIFY_SCREEN_SIZE = 13 , SCRIPTEL_FEATURE_SCREEN_REGION_INFO_SIZE = 25 , SCRIPTEL_FEATURE_ACTIVE_SCREEN_SIZE = 2 , SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD_SIZE = 2 , SCRIPTEL_FEATURE_CALIBRATE_SIZE = 2 , SCRIPTEL_INPUT_COORDINATE_SIZE = 6 , SCRIPTEL_INPUT_EXTENDEDCOORDINATE_SIZE = 7 , SCRIPTEL_INPUT_ADCVALUES_SIZE = 11 , SCRIPTEL_INPUT_MAGCARDDATA_SIZE = 231 , SCRIPTEL_INPUT_DEBUGCOORDINATE_SIZE = 22 , SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION_SIZE = 5 , SCRIPTEL_FEATURE_PIXELS_SIZE = 1031 , SCRIPTEL_FEATURE_ENGINEERING_TEST_SIZE = 67 , SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS_SIZE = 69 }
| This enumeration contains the sizes in bytes of all of the static sized reports. More...
enum | scriptel_device_run_mode { SCRIPTEL_RUNMODE_COMMAND = 0 , SCRIPTEL_RUNMODE_TOUCH = 1 , SCRIPTEL_RUNMODE_PEN = 2 , SCRIPTEL_RUNMODE_AUTOTOUCH = 4 , SCRIPTEL_RUNMODE_TOUCHSINGLE = 8 , SCRIPTEL_RUNMODE_TOUCHSTREAM = 10 , SCRIPTEL_RUNMODE_PENSINGLE = 16 , SCRIPTEL_RUNMODE_PENSTREAM = 18 , SCRIPTEL_RUNMODE_PENCONTINUOUS = 20 }
| This enumeration contains all of the valid run modes for ScripTouch firmware. More...
enum | scriptel_device_acquisition_mode { SCRIPTEL_ACQMODE_TOUCH = 0 , SCRIPTEL_ACQMODE_PEN = 1 , SCRIPTEL_ACQMODE_AUTOTOUCH = 2 , SCRIPTEL_ACQMODE_COMMAND = 3 }
| This enumeration contains all supported acquisition modes. More...
enum | scriptel_device_pentouch_mode { SCRIPTEL_PTMODE_SINGLE = 0 , SCRIPTEL_PTMODE_SINGLE_LIFTOFF = 1 , SCRIPTEL_PTMODE_STREAM = 2 , SCRIPTEL_PTMODE_STREAM_LIFTOFF = 3 , SCRIPTEL_PTMODE_CONTINUOUS = 4 }
| This enumeration contains all supported pen modes. More...
enum | scriptel_region_type { SCRIPTEL_REGION_TYPE_CONTAINER = 0 , SCRIPTEL_REGION_TYPE_BUTTON = 1 , SCRIPTEL_REGION_TYPE_LINE = 2 , SCRIPTEL_REGION_TYPE_GRAPHIC = 3 , SCRIPTEL_REGION_TYPE_TEXT = 4 , SCRIPTEL_REGION_TYPE_NULL = 0xFF }
| This enumeration contains all valid region types and their numeric identifiers. More...
enum | scriptel_output_mode { REAL_TIME = 0 , TRANSMIT_ON_CONFIRM = 1 , TRANSMIT_ON_HOST_COMMAND = 2 }
| This enumeration contains output modes; whether the output is to be held off, or sent immediatly. More...
enum | scriptel_compression_mode { SCRIPTEL_OUTPUT_UNCOMPRESSED_LORES = 0 , SCRIPTEL_OUTPUT_COMPRESSED_LORES = 1 , SCRIPTEL_OUTPUT_UNCOMPRESSED_HIRES = 2 , SCRIPTEL_OUTPUT_COMPRESSED_HIRES = 3 }
| This enumeration contains valid compression modes. More...
enum | scriptel_mag_card_output { SCRIPTEL_MAG_CARD_OEM_FORMAT = 0x01 , SCRIPTEL_MAG_CARD_KEYBOARD = 0x04 , SCRIPTEL_MAG_CARD_KEYBOARD_PREAMBLE = 0x08 }
enum | scriptel_displaysettings_command { SCRIPTEL_COMMAND_RUNTIME = 0 , SCRIPTEL_COMMAND_COMMIT = 1 , SCRIPTEL_COMMAND_RESTORE_DEFAULTS = 128 }
| This enumeration contains valid flags for the command byte field in the set display settings report. More...
enum | scriptel_adc_data_type { SCRIPTEL_ADC_DATA_TYPE_SCAN = 2 , SCRIPTEL_ADC_DATA_TYPE_CHANNEL = 3 }
| This enumeration contains all valid types of ADC data. More...
enum | scriptel_cardswipe_type { SCRIPTEL_CARDSWIPE_TYPE_FINANCIAL = 0x01 , SCRIPTEL_CARDSWIPE_TYPE_IDENTIFICATION = 0x02 , SCRIPTEL_CARDSWIPE_TYPE_UNKNOWN = 0xFF }
| This enumeration contains all of the valid magnetic card types. More...
enum | scriptel_cardswipe_track_status { SCRIPTEL_CARDSWIPE_STATUS_VALID = 0x00 , SCRIPTEL_CARDSWIPE_STATUS_PARITY_ERROR = 0x01 , SCRIPTEL_CARDSWIPE_STATUS_UNKNOWN_FORMAT = 0x10 , SCRIPTEL_CARDSWIPE_STATUS_CORRUPT = 0x11 }
| This enumeration contains error codes that can be passed back when reading magnetic card tracks. More...
enum | scriptel_asic_power_state { SCRIPTEL_ASIC_POWER_STATE_NORMAL = 0 , SCRIPTEL_ASIC_POWER_STATE_POWERDOWN = 1 , SCRIPTEL_ASIC_POWER_STATE_STANDBY = 2 }
| This enumeration contains all of the valid power states for the ASIC. More...
enum | scriptel_calibration_point { SCRIPTEL_CALIBRATION_POINT_CENTER = 0 , SCRIPTEL_CALIBRATION_POINT_UPPERLEFT = 2 , SCRIPTEL_CALIBRATION_POINT_LOWERLEFT = 4 , SCRIPTEL_CALIBRATION_POINT_LOWERRIGHT = 6 , SCRIPTEL_CALIBRATION_POINT_UPPERRIGHT = 8 }
| This enumeration contains all of the valid calibration points. More...
enum | scriptel_tuning_state { SCRIPTEL_LOCATION_1_STYLUS_DOWN = 0 , SCRIPTEL_LOCATION_1_STYLUS_UP = 1 , SCRIPTEL_LOCATION_2_STYLUS_DOWN = 2 , SCRIPTEL_LOCATION_2_STYLUS_UP = 3 }
enum | scriptel_supported_reports { SCRIPTEL_SUPPORTED_REPORTS_HID = 1 , SCRIPTEL_SUPPORTED_REPORTS_MOUSE = 2 , SCRIPTEL_SUPPORTED_REPORTS_PEN = 4 , SCRIPTEL_SUPPORTED_REPORTS_TOUCH = 8 , SCRIPTEL_SUPPORTED_REPORTS_KEYBOARD = 16 }
| This enumeration contains values for the capabilities bit-mask in the compatibility report. More...
enum | scriptel_supported_transfer_modes { SCRIPTEL_MODE_STREAMING = 0x01 , SCRIPTEL_MODE_BUFFERING = 0x02 , SCRIPTEL_MODE_COMPRESSION = 0x04 , SCRIPTEL_MODE_THROTTLING = 0x08 }
| This enumeration contains values for the coordinate_modes capabilities bit-mask. More...
enum | scriptel_display_type { SCRIPTEL_DISPLAY_TYPE_NONE = 0 , SCRIPTEL_DISPLAY_TYPE_240X64_1X5_BLACKWHITE = 1 , SCRIPTEL_DISPLAY_TYPE_240X64_1X5_GRAYSCALE = 2 }
| This enumeration contains the different types of screens that can be embedded in ScripTouch products. More...
enum | scriptel_card_reader { SCRIPTEL_CARDREADER_NONE = 0 , SCRIPTEL_CARDREADER_HID = 1 , SCRIPTEL_CARDREADER_KEYBOARD_BASIC = 2 , SCRIPTEL_CARDREADER_KEYBOARD_PREAMBLE = 3 , SCRIPTEL_CARDREADER_INTERCHANGEABLE = 131 , SCRIPTEL_MAG_CARDREADER_HID = 0x01 , SCRIPTEL_MAG_CARDREADER_KEYBOARD = 0x02 , SCRIPTEL_MAG_CARDREADER_CHANGEABLE = 0x80 }
| This enumeration contains the different types of card readers that can be embedded into a ScripTouch product. More...
enum | scriptel_engineering_test { SCRIPTEL_ENGINEERING_TEST_DISPLAY = 1 , SCRIPTEL_ENGINEERING_TEST_NATIVE = 2 }
enum | scriptel_region_save_changes { SCRIPTEL_REGION_DISCARD_CHANGES = 0 , SCRIPTEL_REGION_SAVE_CHANGES = 1 }
| This enumeration contains the valid options for region edit complete. More...
enum | scriptel_screen_region_save_changes { SCRIPTEL_SCREEN_REGION_DISCARD_CHANGES = 0 , SCRIPTEL_SCREEN_REGION_SAVE_CHANGES = 1 , SCRIPTEL_SCREEN_REGION_FACTORY_DEFAULTS = 90 }
enum | scriptel_resource_type { SCRIPTEL_RESOURCE_TYPE_TEXT = 0 , SCRIPTEL_RESOURCE_TYPE_GRAPHIC = 1 , SCRIPTEL_RESOURCE_TYPE_INVALID = 255 }
| Defines an enumeration of all the resource types. More...
enum | scriptel_resource_justification { SCRIPTEL_JUSTIFICATION_LEFT = 0 , SCRIPTEL_JUSTIFICATION_TOP = 0 , SCRIPTEL_JUSTIFICATION_RIGHT = 1 , SCRIPTEL_JUSTIFICATION_BOTTOM = 1 , SCRIPTEL_JUSTIFICATION_CENTER = 8 }
| Enum that is used to determine the vertical and horizontal justification of objects within a region. More...
enum | scriptel_pen_coord_type { SCRIPTEL_PEN_COORD_DISPLAY_SPACE = 1 , SCRIPTEL_PEN_COORD_DEVICE_SPACE = 2 }
| Enum that is used to specify the pen coordinate space. More...

## Detailed Description

This file contains the headers required for lower level communication with ScripTouch devices.

## Enumeration Type Documentation

## ◆ scriptel_adc_data_type

enum scriptel_adc_data_type

This enumeration contains all valid types of ADC data.

Enumerator
SCRIPTEL_ADC_DATA_TYPE_SCAN | Identifier for a scan sample.
SCRIPTEL_ADC_DATA_TYPE_CHANNEL | Identifier for a channel sample.

## ◆ scriptel_asic_power_state

enum scriptel_asic_power_state

This enumeration contains all of the valid power states for the ASIC.

Enumerator
SCRIPTEL_ASIC_POWER_STATE_NORMAL | The ASIC is on and running.
SCRIPTEL_ASIC_POWER_STATE_POWERDOWN | The ASIC is off.
SCRIPTEL_ASIC_POWER_STATE_STANDBY | The ASIC is in standby mode.

## ◆ scriptel_calibration_point

enum scriptel_calibration_point

This enumeration contains all of the valid calibration points.

Enumerator
SCRIPTEL_CALIBRATION_POINT_CENTER | Calibration point is in the center of the screen.
SCRIPTEL_CALIBRATION_POINT_UPPERLEFT | Calibration point is in the upper left of the screen.
SCRIPTEL_CALIBRATION_POINT_LOWERLEFT | Calibration point is in the lower left of the screen.
SCRIPTEL_CALIBRATION_POINT_LOWERRIGHT | Calibration point is in the lower right of the screen.
SCRIPTEL_CALIBRATION_POINT_UPPERRIGHT | Calibration point is in the upper right of the screen.

## ◆ scriptel_card_reader

enum scriptel_card_reader

This enumeration contains the different types of card readers that can be embedded into a ScripTouch product.

Enumerator
SCRIPTEL_CARDREADER_NONE | No card reader equipped.
SCRIPTEL_CARDREADER_HID | Vendor-specific HID card reader equipped.
SCRIPTEL_CARDREADER_KEYBOARD_BASIC | Keyboard card reader equipped - no preamble.
SCRIPTEL_CARDREADER_KEYBOARD_PREAMBLE | Keyboard card reader equipped - Scriptel preamble.
SCRIPTEL_CARDREADER_INTERCHANGEABLE | Card read can switch between HID and Keyboard.
SCRIPTEL_MAG_CARDREADER_HID | Vendor-specific HID card reader equipped.
SCRIPTEL_MAG_CARDREADER_KEYBOARD | Keyboard card reader equipped.
SCRIPTEL_MAG_CARDREADER_CHANGEABLE | Reader capable of switching output modes.

## ◆ scriptel_cardswipe_track_status

enum scriptel_cardswipe_track_status

This enumeration contains error codes that can be passed back when reading magnetic card tracks.

Enumerator
SCRIPTEL_CARDSWIPE_STATUS_VALID | The track read is valid and can be used.
SCRIPTEL_CARDSWIPE_STATUS_PARITY_ERROR | A parity error was found.
SCRIPTEL_CARDSWIPE_STATUS_UNKNOWN_FORMAT | The magnetic card is in an unknown format.
SCRIPTEL_CARDSWIPE_STATUS_CORRUPT | The checksum of the card was incorrect.

## ◆ scriptel_cardswipe_type

enum scriptel_cardswipe_type

This enumeration contains all of the valid magnetic card types.

Enumerator
SCRIPTEL_CARDSWIPE_TYPE_FINANCIAL | Identifier for financial (credit) cards.
SCRIPTEL_CARDSWIPE_TYPE_IDENTIFICATION | Identifier for identification (state identification) cards.
SCRIPTEL_CARDSWIPE_TYPE_UNKNOWN | Identifier for unknown.

## ◆ scriptel_compression_mode

enum scriptel_compression_mode

This enumeration contains valid compression modes.

Enumerator
SCRIPTEL_OUTPUT_UNCOMPRESSED_LORES | No compression, low resolution output.
SCRIPTEL_OUTPUT_COMPRESSED_LORES | Compressed, low resolution output (currently unsupported in firmware)
SCRIPTEL_OUTPUT_UNCOMPRESSED_HIRES | Uncompressed, high resolution output (currently unsupported in firmware)
SCRIPTEL_OUTPUT_COMPRESSED_HIRES | Compressed, high resolution output.

## ◆ scriptel_device_acquisition_mode

enum scriptel_device_acquisition_mode

This enumeration contains all supported acquisition modes.

Enumerator
SCRIPTEL_ACQMODE_TOUCH | Device is in the touch acquisition mode.
SCRIPTEL_ACQMODE_PEN | Device is in the pen acquisition mode.
SCRIPTEL_ACQMODE_AUTOTOUCH | Device is in the auto-touch acquisition mode.
SCRIPTEL_ACQMODE_COMMAND | Device is in command mode.

## ◆ scriptel_device_pentouch_mode

enum scriptel_device_pentouch_mode

This enumeration contains all supported pen modes.

Enumerator
SCRIPTEL_PTMODE_SINGLE | Pen is in single mode.
SCRIPTEL_PTMODE_SINGLE_LIFTOFF | Pen is in single liftoff mode.
SCRIPTEL_PTMODE_STREAM | Pen is in stream mode.
SCRIPTEL_PTMODE_STREAM_LIFTOFF | Pen is in stream liftoff mode.
SCRIPTEL_PTMODE_CONTINUOUS | Pen is in continuous mode.

## ◆ scriptel_device_run_mode

enum scriptel_device_run_mode

This enumeration contains all of the valid run modes for ScripTouch firmware.

Enumerator
SCRIPTEL_RUNMODE_COMMAND | Command mode, turns off the ASIC and accepts commands.
SCRIPTEL_RUNMODE_TOUCH | Touch mode, configures the digitizer to accept touch input. This mode may not be supported in all devices.
SCRIPTEL_RUNMODE_PEN | Pen mode, configures the digitizer to accept pen input.
SCRIPTEL_RUNMODE_AUTOTOUCH | Auto Touch mode, alternates quickly between pen and touch mode to detect either. This mode may not be supported in all devices.
SCRIPTEL_RUNMODE_TOUCHSINGLE | Defined but unused, reserved for later use.
SCRIPTEL_RUNMODE_TOUCHSTREAM | Defined but unused, reserved for later use.
SCRIPTEL_RUNMODE_PENSINGLE | Defined but unused, reserved for later use.
SCRIPTEL_RUNMODE_PENSTREAM | Defined but unused, reserved for later use.
SCRIPTEL_RUNMODE_PENCONTINUOUS | Defined but unused, reserved for later use.

## ◆ scriptel_display_type

enum scriptel_display_type

This enumeration contains the different types of screens that can be embedded in ScripTouch products.

Enumerator
SCRIPTEL_DISPLAY_TYPE_NONE | The device has no display equipped.
SCRIPTEL_DISPLAY_TYPE_240X64_1X5_BLACKWHITE | The device has a 5x1 inch 240x64 pixel black and white screen equipped.
SCRIPTEL_DISPLAY_TYPE_240X64_1X5_GRAYSCALE | The device has a 5x1 inch 240x64 pixel gray-scale screen equipped.

## ◆ scriptel_displaysettings_command

enum scriptel_displaysettings_command

This enumeration contains valid flags for the command byte field in the set display settings report.

Enumerator
SCRIPTEL_COMMAND_RUNTIME | The display settings will only persist during runtime. Resetting the device will cause the values to revert.
SCRIPTEL_COMMAND_COMMIT | This display settings will be commited to flash. A power reset will not change the values.
SCRIPTEL_COMMAND_RESTORE_DEFAULTS | Ignore the values in the report, restore the default values. The default values are not written to flash.

## ◆ scriptel_engineering_test

enum scriptel_engineering_test

Enumerator
SCRIPTEL_ENGINEERING_TEST_DISPLAY | Set pen coordinates in screen units.
SCRIPTEL_ENGINEERING_TEST_NATIVE | Set pen coordinates in the native output unit; e.g. 0-499 for EasyScript uncompressed, 0-2999 for EasyScript compressed, 0-65535 for ProScript

## ◆ scriptel_hid_report_id

enum scriptel_hid_report_id

This enumeration contains all of the valid reports identifiers for reports that the ScripTouch firmware can respond to.

Enumerator
SCRIPTEL_FEATURE_RUNMODE | The report identifier of the run mode feature report.
SCRIPTEL_FEATURE_CAPABILITIES | The report identifier of the capabilities feature report.
SCRIPTEL_FEATURE_DEVICE_STATUS | The report identifier of the device status and error clearer.
SCRIPTEL_FEATURE_DEVICECONFIGURE | The report identifier of the device configuration feature report.
SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM | The report identifier of the contact count maximum feature report.
SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE | The report identifier of the frequency amplitude feature report.
SCRIPTEL_FEATURE_POWERSTATE | The report identifier of the power state feature report.
SCRIPTEL_FEATURE_VERSIONINFO | The report identifier of the version information feature report.
SCRIPTEL_FEATURE_COORDINATERANGE | The report identifier of the coordinate range feature report.
SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD | The report identifier of the firmware download feature report.
SCRIPTEL_FEATURE_ERRORCORRECTION | The report identifier of the error correction feature report.
SCRIPTEL_FEATURE_SERIALNUMBER | The report identifier of the serial number feature report.
SCRIPTEL_FEATURE_SAVECONFIGURATION | The report identifier of the save configuration feature report.
SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS | The report identifier of the download command status feature report.
SCRIPTEL_FEATURE_OPERATINGMODE | The report identifier of the operating mode feature report.
SCRIPTEL_FEATURE_GENERALPARAMETERS | The report identifier of the general parameters feature report.
SCRIPTEL_FEATURE_ASICRESET | The report identifier of the ASIC reset feature report.
SCRIPTEL_FEATURE_REGISTERGET | The report identifier of the register get feature report.
SCRIPTEL_FEATURE_REGISTERSET | The report identifier of the register set feature report.
SCRIPTEL_FEATURE_PENPARAMETERS | The report identifier of the pen parameters feature report.
SCRIPTEL_FEATURE_TOUCHPARAMETERS | The report identifier of the touch parameters feature report.
SCRIPTEL_FEATURE_OUTPUTCONFIGURATION | The report identifier of the output configuration feature report.
SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION | The report identifier of the peripheral configuration feature report.
SCRIPTEL_FEATURE_CALIBRATION_DATA | The report identifier of the calibration data report.
SCRIPTEL_FEATURE_DISPLAYINFO | The report identifier of the display information feature report.
SCRIPTEL_FEATURE_DISPLAYCONTENT | The report identifier of the display content feature report.
SCRIPTEL_FEATURE_DISPLAYSETTINGS | The report identifier of the display settings feature report.
SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK | The report identifier of the update display chunk feature report.
SCRIPTEL_FEATURE_REGIONGET | The report identifier of the region get feature report.
SCRIPTEL_FEATURE_REGIONGETDEFAULT | The report identifier of the region default feature report.
SCRIPTEL_FEATURE_REGIONSET | The report identifier of the region set feature report.
SCRIPTEL_FEATURE_REGIONUPDATE | The report identifier of the region update feature report.
SCRIPTEL_FEATURE_REGIONDELETE | The report identifier of the region delete feature report.
SCRIPTEL_FEATURE_REGIONEDITCOMPLETE | The report identifier of the region edit complete feature report.
SCRIPTEL_FEATURE_CALIBRATE | The report identifier of the calibrate feature report.
SCRIPTEL_FEATURE_RESOURCE_IDX | The report identifier of the resource index feature report.
SCRIPTEL_FEATURE_RESOURCE_INFO | The report identifier of the resource info feature report.
SCRIPTEL_FEATURE_RESOURCE | The report identifier of the resource feature report.
SCRIPTEL_FEATURE_DELETE_RESOURCE | The report identifier of the delete resource feature report.
SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY | The report identifier of the resource availability feature report.
SCRIPTEL_FEATURE_REGION_IDX | The report identifier of the region index feature report.
SCRIPTEL_FEATURE_REGION | The report identifier of the region feature report.
SCRIPTEL_FEATURE_DELETE_REGION | The report identifier of the delete region feature report.
SCRIPTEL_FEATURE_SCREEN_IDX | The report identifier of the screen index feature report.
SCRIPTEL_FEATURE_SCREEN | The report identifier of the screen feature report.
SCRIPTEL_FEATURE_DELETE_SCREEN | The report identifier of the delete screen feature report.
SCRIPTEL_FEATURE_MODIFY_SCREEN | The report identifier of the modify screen feature report.
SCRIPTEL_FEATURE_SCREEN_REGION_INFO | The report identifier of the screen region info feature report.
SCRIPTEL_FEATURE_ACTIVE_SCREEN | The report identifier of the active screen feature report.
SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD | The report identifier of the screen region save reload report.
SCRIPTEL_INPUT_COORDINATE | The report identifier of the coordinate input report.
SCRIPTEL_INPUT_EXTENDEDCOORDINATE | The report identifier of the extended coordinate input report.
SCRIPTEL_INPUT_ADCVALUES | The report identifier of the adc values input report.
SCRIPTEL_INPUT_MOUSECOORDINATE | The report identifier of the mouse coordinate input report.
SCRIPTEL_INPUT_DIGITIZERPENCOORDINATE | The report identifier of the digitizer pen coordinate input report.
SCRIPTEL_INPUT_DIGITIZERTOUCHCOORDINATE | The report identifier of the digitizer touch coordinate input report.
SCRIPTEL_INPUT_KEYBOARD | The report identifier of the keyboard input report.
SCRIPTEL_INPUT_MULTITOUCHCOORDINATE | The report identifier of the multi-touch coordinate input report.
SCRIPTEL_INPUT_MAGCARDDATA | The report identifier of the magnetic card data input report.
SCRIPTEL_INPUT_DEBUGCOORDINATE | The report identifier of the debug coordinate input report.
SCRIPTEL_FEATURE_ENGINEERING_TEST | The report identifier of Engineering Use report.
SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION | The report identifier of Get/Set Picel Retrieval Location.
SCRIPTEL_FEATURE_PIXELS | The report itdentifier of Get/SET Pixels.
SCRIPTEL_INPUT_BUTTONDOWN | The following reports are fake input reports generated in the library. The report identifier of the button down input report.
SCRIPTEL_INPUT_BUTTONMOVE | The report identifier of the button move input report.
SCRIPTEL_INPUT_BUTTONUP | The report identifier of the button up input report.
SCRIPTEL_INPUT_BUTTONPRESS | The report identifier of the button press input report.
SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS | The report identifier for STGEN-II Configuration and Diagnostics.

## ◆ scriptel_hid_report_size

enum scriptel_hid_report_size

This enumeration contains the sizes in bytes of all of the static sized reports.

This size includes the report identifier.

Enumerator
SCRIPTEL_FEATURE_RUNMODE_SIZE | Size in bytes of the run mode feature report.
SCRIPTEL_FEATURE_CAPABILITIES_SIZE | Size in bytes of the capabilities feature report.
SCRIPTEL_FEATURE_DEVICECONFIGURE_SIZE | Size in bytes of the device configure feature report.
SCRIPTEL_FEATURE_CONTACTCOUNTMAXIMUM_SIZE | Size in bytes of the contact count maximum feature report.
SCRIPTEL_FEATURE_FREQUENCYAMPLITUDE_SIZE | Size in bytes of the frequency amplitude feature report.
SCRIPTEL_FEATURE_POWERSTATE_SIZE | Size in bytes of the power state feature report.
SCRIPTEL_FEATURE_VERSIONINFO_SIZE | Size in bytes of the version info feature report.
SCRIPTEL_FEATURE_COORDINATERANGE_SIZE | Size in bytes of the coordinate range feature report.
SCRIPTEL_FEATURE_FIRMWAREDOWNLOAD_SIZE | Size in bytes of the firmware download feature report.
SCRIPTEL_FEATURE_ERRORCORRECTION_SIZE | Size in bytes of the error correction feature report.
SCRIPTEL_FEATURE_SERIALNUMBER_SIZE | Size in bytes of the serial number feature report.
SCRIPTEL_FEATURE_SAVECONFIGURATION_SIZE | Size in bytes of the save configuration feature report.
SCRIPTEL_FEATURE_DOWNLOADCOMMANDSTATUS_SIZE | Size in bytes of the download command status feature report.
SCRIPTEL_FEATURE_OPERATINGMODE_SIZE | Size in bytes of the operating mode feature report.
SCRIPTEL_FEATURE_GENERALPARAMETERS_SIZE | Size in bytes of the general parameters feature report.
SCRIPTEL_FEATURE_ASICRESET_SIZE | Size in bytes of the ASIC reset feature report.
SCRIPTEL_FEATURE_REGISTERGET_SIZE | Size in bytes of the register get feature report.
SCRIPTEL_FEATURE_REGISTERSET_SIZE | Size in bytes of the register set feature report.
SCRIPTEL_FEATURE_PENPARAMETERS_SIZE | Size in bytes of the pen parameters feature report.
SCRIPTEL_FEATURE_TOUCHPARAMETERS_SIZE | Size in bytes of the touch parameters feature report.
SCRIPTEL_FEATURE_OUTPUTCONFIGURATION_SIZE | Size in bytes of the output configuration report.
SCRIPTEL_FEATURE_PERIPHERAL_CONFIGURATION_SIZE | Size in bytes of the peripheral configuration report.
SCRIPTEL_FEATURE_DEVICE_STATUS_SIZE | Size in bytes of the Device Status report.
SCRIPTEL_FEATURE_CALIBRATION_DATA_SIZE | Size in bytes of the calibration data report.
SCRIPTEL_FEATURE_DISPLAYINFO_SIZE | Size in bytes of the display info feature report.
SCRIPTEL_FEATURE_DISPLAYCONTENT_SIZE | Size in bytes of the display content feature report.
SCRIPTEL_FEATURE_DISPLAYSETTINGS_SIZE | Size in bytes of the display settings feature report.
SCRIPTEL_FEATURE_UPDATEDISPLAYCHUNK_SIZE | Size in bytes of the update display chunk feature report.
SCRIPTEL_FEATURE_REGIONUPDATE_SIZE | Size in bytes of the region update feature report.
SCRIPTEL_FEATURE_REGIONDELETE_SIZE | Size in bytes of the region delete feature report.
SCRIPTEL_FEATURE_REGIONEDITCOMPLETE_SIZE | Size in bytes of the region edit complete feature report.
SCRIPTEL_FEATURE_RESOURCE_IDX_SIZE | Size in bytes of the resource index feature report.
SCRIPTEL_FEATURE_RESOURCE_INFO_SIZE | Size in bytes of the resource info feature report.
SCRIPTEL_FEATURE_RESOURCE_AVAILABILITY_SIZE | Size in bytes of the resource availability feature report.
SCRIPTEL_FEATURE_RESOURCE_SIZE | Size in bytes of the resource feature report.
SCRIPTEL_FEATURE_DELETE_RESOURCE_SIZE | Size in bytes of the delete resource feature report.
SCRIPTEL_FEATURE_REGION_IDX_SIZE | Size in bytes of the region index feature report.
SCRIPTEL_FEATURE_SCREEN_IDX_SIZE | Size in bytes of the screen index feature report.
SCRIPTEL_FEATURE_DELETE_REGION_SIZE | Size in bytes of the delete region feature report.
SCRIPTEL_FEATURE_SCREEN_SIZE | Size in bytes of the screen feature report.
SCRIPTEL_FEATURE_DELETE_SCREEN_SIZE | Size in bytes of the delete screen feature report.
SCRIPTEL_FEATURE_MODIFY_SCREEN_SIZE | Size in bytes of the modify screen feature report.
SCRIPTEL_FEATURE_SCREEN_REGION_INFO_SIZE | Size in bytes of the screen region info feature report.
SCRIPTEL_FEATURE_ACTIVE_SCREEN_SIZE | Size in bytes of the active screen feature report.
SCRIPTEL_FEATURE_SCREEN_REGION_SAVE_RELOAD_SIZE | Size in bytes of the screen region commit feature report.
SCRIPTEL_FEATURE_CALIBRATE_SIZE | Size in bytes of the calibrate feature report.
SCRIPTEL_INPUT_COORDINATE_SIZE | Size in bytes of the coordinate size input report.
SCRIPTEL_INPUT_EXTENDEDCOORDINATE_SIZE | Size in bytes of the extended coordinate input report.
SCRIPTEL_INPUT_ADCVALUES_SIZE | Size in bytes of the ADC values input report.
SCRIPTEL_INPUT_MAGCARDDATA_SIZE | Size in bytes of the magnetic card data input report.
SCRIPTEL_INPUT_DEBUGCOORDINATE_SIZE | Size in bytes of the debug coordinate input report.
SCRIPTEL_FEATURE_PIXEL_RETRIEVAL_LOCATION_SIZE | Size in bytes of the get/set Pixel Retrieval Location feature report.
SCRIPTEL_FEATURE_PIXELS_SIZE | Size in bytes of the get/set pixels feature report.
SCRIPTEL_FEATURE_ENGINEERING_TEST_SIZE | Size in bytes of the engineering test feature report.
SCRIPTEL_FEATURE_GENII_CONFIGURATION_AND_DIAGNOSTICS_SIZE | Size in bytes of the genII configuration and diagnostics feature report.

## ◆ scriptel_mag_card_output

enum scriptel_mag_card_output

Enumerator
SCRIPTEL_MAG_CARD_OEM_FORMAT | Peripheral outputs data in OEM Format.
SCRIPTEL_MAG_CARD_KEYBOARD | Peripheral outputs data in Keyboard Format.
SCRIPTEL_MAG_CARD_KEYBOARD_PREAMBLE | Peripheral outputs data in Keyboard Format with Preamble, SCRIPTEL_MAG_CARD_KEYBOARD must be active.

## ◆ scriptel_ouput_configuration_flags

enum scriptel_ouput_configuration_flags

This enumeration contains the output report flags.

Enumerator
SCRIPTEL_OUTPUT_CONFIGURATION_OEM | Used by Scriptel, does not apply to signature pads.
SCRIPTEL_OUTPUT_CONFIGURATION_OEM_EXTENDED | ProScript mode.
SCRIPTEL_OUTPUT_CONFIGURATION_MOUSE | USB device type, not used on signature pads.
SCRIPTEL_OUTPUT_CONFIGURATION_PEN_DIGITIZER | USB device type, not used on signature pads.
SCRIPTEL_OUTPUT_CONFIGURATION_TOUCH | USB device type, not used on signature pads.
SCRIPTEL_OUTPUT_CONFIGURATION_KEYBOARD | EasyScript mode.
SCRIPTEL_OUTPUT_CONFIGURATION_RAW_DATA | Used for testing.
SCRIPTEL_OUTPUT_CONFIGURATION_DEBUG_DATA | Used for testing.

## ◆ scriptel_output_mode

enum scriptel_output_mode

This enumeration contains output modes; whether the output is to be held off, or sent immediatly.

Enumerator
REAL_TIME | Send coordinates as soon as possible.
TRANSMIT_ON_CONFIRM | Don't send coordinates until the OK button is pressed.
TRANSMIT_ON_HOST_COMMAND | Don't send coordinates until the host requests them.

## ◆ scriptel_pen_coord_type

enum scriptel_pen_coord_type

Enum that is used to specify the pen coordinate space.

Enumerator
SCRIPTEL_PEN_COORD_DISPLAY_SPACE | Use the coordinate system of display pixels.
SCRIPTEL_PEN_COORD_DEVICE_SPACE | Use the coordinate system of device output. This could be 0-499 for EasyScript 1.0, 0-2999 for EasyScript 3.0, or 0-65535 for ProScript.

## ◆ scriptel_region_save_changes

enum scriptel_region_save_changes

This enumeration contains the valid options for region edit complete.

Enumerator
SCRIPTEL_REGION_DISCARD_CHANGES | Discard all region changes.
SCRIPTEL_REGION_SAVE_CHANGES | Save all region changes persistently.

## ◆ scriptel_region_type

enum scriptel_region_type

This enumeration contains all valid region types and their numeric identifiers.

Enumerator
SCRIPTEL_REGION_TYPE_CONTAINER | Type for containers.
SCRIPTEL_REGION_TYPE_BUTTON | Type for buttons.
SCRIPTEL_REGION_TYPE_LINE | Type for lines.
SCRIPTEL_REGION_TYPE_GRAPHIC | Type for graphics.
SCRIPTEL_REGION_TYPE_TEXT | Type for text.
SCRIPTEL_REGION_TYPE_NULL | Type for null regions.

## ◆ scriptel_resource_justification

enum scriptel_resource_justification

Enum that is used to determine the vertical and horizontal justification of objects within a region.

Enumerator
SCRIPTEL_JUSTIFICATION_LEFT | Justifies the resouce to the left.
SCRIPTEL_JUSTIFICATION_TOP | Justifies the resouce to the top.
SCRIPTEL_JUSTIFICATION_RIGHT | Justifies the resouce to the right.
SCRIPTEL_JUSTIFICATION_BOTTOM | Justifies the resouce to the bottom.
SCRIPTEL_JUSTIFICATION_CENTER | Justifies the resouce to the center.

## ◆ scriptel_resource_type

enum scriptel_resource_type

Defines an enumeration of all the resource types.

Enumerator
SCRIPTEL_RESOURCE_TYPE_TEXT | Rext resource.
SCRIPTEL_RESOURCE_TYPE_GRAPHIC | Graphic resource.
SCRIPTEL_RESOURCE_TYPE_INVALID | Invalid/Null resource.

## ◆ scriptel_screen_region_save_changes

enum scriptel_screen_region_save_changes

Enumerator
SCRIPTEL_SCREEN_REGION_DISCARD_CHANGES | Discard all screen and region changes.
SCRIPTEL_SCREEN_REGION_SAVE_CHANGES | Save all screen and region changes persistently.
SCRIPTEL_SCREEN_REGION_FACTORY_DEFAULTS | Restore all screens and regions to factory defaults.

## ◆ scriptel_supported_reports

enum scriptel_supported_reports

This enumeration contains values for the capabilities bit-mask in the compatibility report.

Values indicate that a device supports a particular type of input report.

Enumerator
SCRIPTEL_SUPPORTED_REPORTS_HID | The device supports vendor-specific (Scriptel) HID input reports.
SCRIPTEL_SUPPORTED_REPORTS_MOUSE | The device supports HID mouse input reports.
SCRIPTEL_SUPPORTED_REPORTS_PEN | The device supports HID pen input reports.
SCRIPTEL_SUPPORTED_REPORTS_TOUCH | The device supports HID touch input reports.
SCRIPTEL_SUPPORTED_REPORTS_KEYBOARD | The device supports HID keyboard input reports.

## ◆ scriptel_supported_transfer_modes

enum scriptel_supported_transfer_modes

This enumeration contains values for the coordinate_modes capabilities bit-mask.

Enumerator
SCRIPTEL_MODE_STREAMING | The device supports streaming output.
SCRIPTEL_MODE_BUFFERING | The device supports coordinate buffering (batch) output.
SCRIPTEL_MODE_COMPRESSION | The device supports coordinate compression.
SCRIPTEL_MODE_THROTTLING | The device supports coordinate throttling.

## ◆ scriptel_tuning_state

enum scriptel_tuning_state

Enumerator
SCRIPTEL_LOCATION_1_STYLUS_DOWN | Stylus down at top left of the glass.
SCRIPTEL_LOCATION_1_STYLUS_UP | Waiting for stylus to press at top left of the glass.
SCRIPTEL_LOCATION_2_STYLUS_DOWN | Stylus down at bottom right of the glass.
SCRIPTEL_LOCATION_2_STYLUS_UP | Waiting for stylus to press at bottom right of the glass.