example-screen-editing.c

This is a simple example of how to create screens, regions, and resources.
This example requires firmware 4.0.0 or greater.
This example will not make the screen edits permanent. To do so, please refer to scriptel_set_screen_region_commit().
This example will not expose the new screen to normal operations. To do so, you will need to edit the other screens.

#include <stdio.h>
#include "scriptel-proscript.h"
 
int main() {
    scriptel_device* device;
 
    //Initialize the library.
    scriptel_init();
 
    //List the devices.
    if(scriptel_list_devices(&device) == SCRIPTEL_CODE_SUCCESS) {
        //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.
            if(scriptel_open_device(device) == SCRIPTEL_CODE_SUCCESS) {
                printf("Successfully connected to %s - %s at: %s\n", device->manufacturer, device->model, device->path);
                
                //Basic black and white colors
                scriptel_color black;
                black.alpha = 255;
                black.red = 0;
                black.green = 0;
                black.blue = 0;
 
                scriptel_color white;
                white.alpha = 0;
                white.red = 255;
                white.green = 255;
                white.blue = 255;
 
                //Create a resource. In this example, we will create a text resource.
                scriptel_hid_feature_resource* text = malloc(sizeof(scriptel_hid_feature_resource));
                memset(text, 0, sizeof(scriptel_hid_feature_resource));
                text->resource_number = 3;
                text->resource_type = SCRIPTEL_RESOURCE_TYPE_TEXT;
                memcpy(text->resource_data, "Please select which screen you would like to appear.", 53);
                text->bytes_valid = 53;
                text->resource_size = 53;
                //When writing a resource to the device, the device must always be in command mode.
                scriptel_set_run_mode(device, SCRIPTEL_RUNMODE_COMMAND);
                scriptel_set_resource(device, text);
                free(text);
                scriptel_set_run_mode(device, SCRIPTEL_RUNMODE_PEN);
 
                //Create new regions. The buttons will serve as a connection back to the regular screens.
                //Text Region to hold the text resource.
                scriptel_hid_feature_region* textPrompt = malloc(sizeof(scriptel_hid_feature_region));
                memset(textPrompt, 0, sizeof(scriptel_hid_feature_region));
                textPrompt->common.region_index = 10;
                textPrompt->common.region_type = SCRIPTEL_REGION_TYPE_TEXT;
                textPrompt->common.x1 = 20;
                textPrompt->common.x2 = 220;
                textPrompt->common.y1 = 2;
                textPrompt->common.y2 = 30;
                textPrompt->common.foreground_color = black;
                textPrompt->common.background_color = white;
                textPrompt->text.resource_number = 3;
                textPrompt->text.horizontal_justification = SCRIPTEL_JUSTIFICATION_CENTER;
                textPrompt->text.vertical_justification = SCRIPTEL_JUSTIFICATION_TOP;
                scriptel_set_region_contents(device, textPrompt);
                free(textPrompt);
 
                //Button will lead back to the main splash screen.
                scriptel_hid_feature_region* splashButton = malloc(sizeof(scriptel_hid_feature_region));
                memset(splashButton, 0, sizeof(scriptel_hid_feature_region));
                splashButton->common.region_index = 11;
                splashButton->common.region_type = SCRIPTEL_REGION_TYPE_BUTTON;
                splashButton->common.accepts_touch = 1;
                splashButton->common.has_frame = 1;
                splashButton->common.decode_region = 1;
                splashButton->common.x1 = 40;
                splashButton->common.x2 = 100;
                splashButton->common.y1 = 40;
                splashButton->common.y2 = 55;
                splashButton->common.foreground_color = black;
                splashButton->common.background_color = white;
                splashButton->button.enabled = 1;
                splashButton->button.highlight_on_select = 1;
                memcpy(splashButton->button.caption, "Splash", sizeof("Splash"));
                scriptel_set_region_contents(device, splashButton);
                free(splashButton);
 
                //Button will lead back to the signature screen.
                scriptel_hid_feature_region* sigButton = malloc(sizeof(scriptel_hid_feature_region));
                memset(sigButton, 0, sizeof(scriptel_hid_feature_region));
                sigButton->common.region_index = 12;
                sigButton->common.region_type = SCRIPTEL_REGION_TYPE_BUTTON;
                sigButton->common.accepts_touch = 1;
                sigButton->common.has_frame = 1;
                sigButton->common.decode_region = 1;
                sigButton->common.x1 = 140;
                sigButton->common.x2 = 200;
                sigButton->common.y1 = 40;
                sigButton->common.y2 = 55;
                sigButton->common.foreground_color = black;
                sigButton->common.background_color = white;
                sigButton->button.enabled = 1;
                sigButton->button.highlight_on_select = 1;
                memcpy(sigButton->button.caption, "Signature", sizeof("Signature"));
                scriptel_set_region_contents(device, sigButton);
                free(sigButton);
 
                //Create a screen. This example will create screen number 4.
                //This screen won't appear once this demo is over.
                //Making this screen available requires editing the other screens.
                scriptel_hid_feature_screen* testScreen = malloc(sizeof(scriptel_hid_feature_screen));
                memset(testScreen, 0, sizeof(scriptel_hid_feature_screen));
                testScreen->screen_number = 4;
                testScreen->timeout_screen_next = 0xFF;
                testScreen->region_count = 3;
                memcpy(testScreen->region_list, (char[3]){ 10, 11, 12 }, 3);
                memcpy(testScreen->screen_next_list, (char[3]){ 0xFF, 1, 2 }, 3);
                scriptel_set_screen(device, testScreen);
 
                //Set the active screen to our new Screen.
                scriptel_set_active_screen(device, 4);
                
            } 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;
    }
}