Scriptel ScripTouch ProScript C Library
This documentation contains information about the ScripTouch ProScript C Library.
example-reading.c

This is a simple example demonstrating how to get input from a device.

#include <stdio.h>
void input_callback(scriptel_device* device, scriptel_input_report* report, unsigned char report_id) {
//We got pen input, lets adjust the coordinates into screen aspect.
double x = device->display_info.width * ((report->extended_coordinate.x - range.x_min) / (double)(range.x_max - range.x_min));
double y = device->display_info.height * ((report->extended_coordinate.y - range.y_min) / (double)(range.y_max - range.y_min));
printf("Got a coordinate from the device: %4.2f, %4.2f\n", x, y);
} else if(report_id == SCRIPTEL_INPUT_BUTTONPRESS) {
//A button was pressed, if it's the OK button we'll close the device.
char* caption = report->button_press.region->button.caption;
printf("Button pressed: %s\n", caption);
if(strcmp(caption, "OK") == 0) {
//The OK button was hit, close the device.
}
}
}
int main() {
scriptel_device* device;
//Initialize the library.
//List the devices.
//Test to see if we have more than zero devices.
if(device != NULL) {
printf("Found %i devices.\n", scriptel_count_device_list(device));
//Lets open the first device and get some information from it.
printf("Successfully connected to %s - %s at: %s\n", device->manufacturer, device->model, device->path);
//Register an input callback, this will be called when we get input from the pad.
scriptel_register_input_callback(device, input_callback);
//Get the coordinate scaling information we'll need later.
//Wait for input from the pad.
while(device->open) {
}
} else {
printf("Problem opening device: %s\n", scriptel_get_last_error());
return 1;
}
} else {
printf("No devices found!\n");
return 2;
}
} else {
printf("Problem enumerating devices: %s\n", scriptel_get_last_error());
return 3;
}
}
@ SCRIPTEL_INPUT_BUTTONPRESS
The report identifier of the button press input report.
Definition: scriptel-hid-reports.h:297
@ SCRIPTEL_INPUT_EXTENDEDCOORDINATE
The report identifier of the extended coordinate input report.
Definition: scriptel-hid-reports.h:234
This file contains the headers for the core of the Scriptel ScripTouch ProScript library.
void scriptel_init(void)
This function should be called prior to using any other library functions.
unsigned int scriptel_count_device_list(scriptel_device *list)
This function counts the number of devices in a given device list.
scriptel_hid_feature_coordinate_range scriptel_get_coordinate_range(scriptel_device *device)
This function gets the logical coordinate range that will be returned from the device when points are...
scriptel_error_code scriptel_list_devices(scriptel_device **start)
This function takes a pointer and will attempt to enumerate any attached ScripTouch devices.
scriptel_error_code scriptel_close_device(scriptel_device *device)
This function attempts to close a local device that was previously opened.
scriptel_error_code scriptel_open_device(scriptel_device *device)
This function attempts to open a local device returned by scriptel_list_devices().
char * scriptel_get_last_error(void)
This function gets the last error message generated by the library.
void scriptel_free_device_list(scriptel_device *device_list)
This function crawls a scriptel_device list and attempts to free any library managed memory associate...
@ SCRIPTEL_CODE_SUCCESS
This code indicates that the function did succeed.
Definition: scriptel-proscript.h:96
scriptel_error_code scriptel_device_read(scriptel_device *device)
This function attempts to read from the passed in device.
void scriptel_register_input_callback(scriptel_device *device, scriptel_input_callback callback)
This function registers an input callback for a device.
char caption[100]
Caption of the button.
Definition: scriptel-hid-reports.h:2585
This structure represents a physically attached Scriptel ScripTouch device.
Definition: scriptel-proscript.h:284
char * path
The path to the device.
Definition: scriptel-proscript.h:290
unsigned char open
Indicates whether or not the device is in the open state.
Definition: scriptel-proscript.h:319
scriptel_hid_feature_display_info display_info
Cached display information from the device at open time.
Definition: scriptel-proscript.h:333
char * model
The textual name of the device as returned by the operating system's HID driver.
Definition: scriptel-proscript.h:305
char * manufacturer
The textual name of the manufacturer as returned by the operating system's HID driver.
Definition: scriptel-proscript.h:310
This report is capable of getting the coordinate range from the device.
Definition: scriptel-hid-reports.h:1582
unsigned short x_max
Maximum logical value in the horizontal direction to be returned by the device.
Definition: scriptel-hid-reports.h:1594
unsigned short y_max
Maximum logical value in the vertical direction to be returned by the device.
Definition: scriptel-hid-reports.h:1602
unsigned short y_min
Minimum logical value in the vertical direction to be returned by the device.
Definition: scriptel-hid-reports.h:1598
unsigned short x_min
Minimum logical value in the horizontal direction to be returned by the device.
Definition: scriptel-hid-reports.h:1590
unsigned short width
Width of the on board display in pixels.
Definition: scriptel-hid-reports.h:2341
unsigned short height
Height of the on board display in pixels.
Definition: scriptel-hid-reports.h:2347
scriptel_device_region_info * region
Button that was pressed.
Definition: scriptel-hid-reports.h:3712
unsigned short x
Horizontal component of the sample.
Definition: scriptel-hid-reports.h:897
unsigned short y
Vertical component of the sample.
Definition: scriptel-hid-reports.h:901
scriptel_device_region_button button
Button region information.
Definition: scriptel-hid-reports.h:2625
This union contains all valid input report types.
Definition: scriptel-hid-reports.h:3728
scriptel_hid_input_extended_coordinate extended_coordinate
Extended coordinate report.
Definition: scriptel-hid-reports.h:3740
scriptel_hid_input_button_press button_press
Button press report.
Definition: scriptel-hid-reports.h:3768