Creating Your First Tizen Wearable Native Widget Application

Welcome to Tizen wearable native widget application development!

A wearable native widget application is created using the C language, and can be run on Tizen wearable devices. The application uses the native API, which provides various interfaces to the device hardware allowing you to take advantage of numerous capabilities tailored to run with limited device resources.

A widget application is one of the Tizen application types. It can be shown by specific UI applications (such as the home screen and lock screen) that can contain widget applications.

Figure: Widget application on a wearable device

Widget application on a wearable device

Study the following instructions to help familiarize yourself with the Tizen native application development process as well as using the Tizen Studio and installing the created application on the emulator or target device. With the instructions, you can create and run a basic wearable native widget application, which displays some text on the screen with no user interaction:

  1. Before you get started with developing Tizen applications, download and install the Tizen Studio.

    For more information on the installation process, see the installation guide.

  2. Create a wearable native widget project using the Tizen Studio.

    This step shows how you can use a predesigned project template that creates all the basic files and folders required for your project.

  3. Build the application.

    After you have implemented code for the features you want, this step shows how you can build the application to validate and compile the code.

  4. Run the application.

    This step shows how you can run the application on the emulator or a real target device.

  5. Build a UI.

    This step shows how you can make small alterations to the application UI to improve the usability of your application.

When you are developing a more complex application, you can take advantage of the native tools included in the Tizen Studio to ease the tasks of creating functionality and designing the application UI.

Creating a Project

The following example shows you how to create and configure a basic wearable native widget application project in the Tizen Studio. An application project contains all the files that make up an application.

Note

For user convenience, standalone widget application packages are not allowed in the Tizen market place.

Use a standalone widget application for testing purposes. If you want to publish the application in the Tizen market place, combine it with at least 1 UI application in the same package. For more information, see Developing Multiple Projects as a Combined Package.

The following figure illustrates the application to be created. The application screen displays the Hello widget text and no user interaction is provided.

Figure: Wearable native Widget application

Wearable native Widget application

To create the application project:

  1. Launch the Tizen Studio.

  2. Make sure the Native perspective is selected in the top right corner of the Tizen Studio window.

    Checking the perspective

    If not, select it. If the perspective is not visible, in the Tizen Studio menu, select Window > Perspective > Open Perspective > Other > Native, and click OK.

  3. In the Tizen Studio menu, select File > New > Tizen Project.

    Creating a new Tizen Native project

    The Project Wizard opens.

  4. In the Project Wizard, define the project details.

    The Project Wizard is used to create the basic application skeleton with the required folder structure and mandatory files. You can easily create different applications by selecting an applicable template or sample for the Project Wizard to use.

    1. Select the Template project type and click Next.

      Selecting the project type

    2. Select the profile (Wearable) and version from a drop-down list and click Next.

      The version depends on the platform version you have installed and with which you are developing the application.

      Selecting the profile and version

    3. Select the Native Application application type and click Next.

      Selecting the application type

    4. Select the Widget template and click Next.

      Selecting the template

    5. Define the project properties and click Finish.

      You can fill the project name (3-50 characters) and the unique package ID. You can also select the location and working sets by clicking More properties.

      Defining properties

    6. The Project Wizard sets up the project, creates the application files using the default content from the template, and closes. For more information on the Project Wizard and the available templates, see Creating Tizen Projects with Tizen Project Wizard.

You can see the created project in the Project Explorer view. The most important files and folders include:

  • inc: Default folder for included source files

  • res: Folder for resource files used by the application only

  • shared: Folder for resource files to be shared with other applications

  • src: Folder for source code files

  • lib: Folder for external library files

  • tizen-manifest.xml: Manifest file used by the platform to install and launch the application

Figure: Application in the Project Explorer

Application in the Project Explorer

NoteYou can view and modify the application configuration in the manifest editor. In this example, no configuration changes are required.

Your application project is now ready for further actions. Next, build the application.

Managing the Application Configuration

To view and modify the application configuration:

  1. In the Project Explorer view, double-click the tizen-manifest.xml file of the application. The Tizen Studio opens the file in the manifest editor.

  2. In the manifest editor, view and modify the configuration details using the various tabs:

    Configuring the application

    • Overview: Define general information, such as the package, label, and icon of the application.

    • Features: Define required software and hardware features. This information is used for application filtering in the Tizen market place.

    • Privileges: Define the security-sensitive APIs or API groups accessed and used by the application.

    • Localization: Define localized values for the application label, description, and icon.

    • Advanced: Define advanced features, such as application metadata, widget (preview image and supported size), and miscellaneous options.

    • Source: View and edit the source code of the tizen-manifest.xml file. Changes made and saved on the other tabs are reflected in the source code and vice versa.

      NoteThe tizen-manifest.xml file must conform to both the XML file format and the Tizen native application specification requirements. Editing the file in the Source tab is intended for advanced users only.
  3. To save any changes, in the Tizen Studio menu, select File > Save All.

For more information on configuring the application, see Setting the Application Manifest.

Building Your Application

After you have created the application project, you can implement the required features. In this example, only the default features from the project template are used, and no code changes are required.

When your application code is ready, you must build the application. The building process performs a validation check and compiles your files.

You can build the application in the following ways:

  • Automatically

    The automatic build means that the Tizen Studio automatically rebuilds the application whenever you change a source or resource file and save the application project.

    To use the automatic build:

    1. Select the project in the Project Explorer view.
    2. In the Tizen Studio menu, select Project > Build Automatically.

      Using the automatic build

      A check mark appears next to the menu option.

    You can toggle the automatic build on and off by reselecting Project > Build Automatically.

  • Manually

    The manual build means that you determine yourself when the application is built.

    To manually build the application, right-click the project in the Project Explorer view and select Build Project.

    Figure: Manually building the application

    Manually building the application

    Alternatively, you can also select the project in the Project Explorer view and do one of the following:

    • In the Tizen Studio menu, select Project > Build Project.
    • Press the F10 key.

You can have more than one build configuration. To see the current active configuration or change it, right-click the project in the Project Explorer view and select Build Configurations > Set Active. The default configuration is Debug. For more information, see Building Applications.

After you have built the application, run it.

Running Your Application

You can run the application on the emulator or a real target device.

Running on the Emulator

To run the application on the emulator:

  1. Launch an emulator instance in the Emulator Manager:
    1. In the Connection Explorer view, launch the Emulator Manager by clicking the related icon.

      Emulator Manager icon

    2. In the Emulator Manager, select a wearable emulator from the list and click Launch.

      If no applicable emulator instance exists, create a new one.

      Launching the emulator

      The emulator is launched in its own window. You can also see the new emulator instance in the Connection Explorer view. To view the emulator folder structure, click the arrow next to the emulator instance.

      Emulator

  2. Generate a security profile.

    Before you run the application, you must sign your application package with a certificate profile in the Tizen Studio.

  3. Run the application:
    1. In the Project Explorer view, right-click the project and select Run As > Tizen Native Application.

      Running the application

      Alternatively, you can also select the project in the Project Explorer view and do one of the following:

      • Press the Ctrl+F11 key.
      • Click the run icon in the toolbar.

      If you have created multiple emulator instances, select the instance you want from the combo box in the toolbar before selecting to run the application. If you select an offline emulator, it is automatically launched when you select to run the application.

      Selecting the emulator to use

    2. Confirm that the application launches on the emulator.

      Application running in the emulator

      NoteIf the emulator display has switched off, you cannot see the application launch. To switch the display on, click the Power key (in the right bottom corner of the emulator).

      The above screen is shown through the Viewer, to allow you to develop a lone widget application for testing purposes.

      To see the widget running on the home screen, add the widget there:

      1. Press the Back key (in the top right corner of the emulator device) to return to the home screen (showing a watch face).
      2. Swipe the home screen to the right and select +.
      3. Scroll down until you see your widget application, and select it.

      Adding to home screen

      You can see the added widget on the home screen. To access the widget from the home screen, swipe right.

      Home screen widget

      While the application is running, the Log view in the Tizen Studio shows the log, debug, and exception messages from the methods defined in the log macros. To see the view, in the Tizen Studio menu, go to Window > Show View > Log.

    For more information on using the emulator features, see Using Emulator Control Keys, Menu, and Panel and Using Extended Emulator Features.

    Running on a Target Device

    To run the application on a target device:

    1. Connect the wearable target device to your computer:
      1. Define settings in the device:
        • Go to Settings > Connections, and switch on Bluetooth.

          Switch on Bluetooth

          Switch on Bluetooth

        • Go to Settings > Connections, and switch on Wi-Fi.

          The device and the computer must be connected to the same Wi-Fi network.

          Note the IP address the device is using.

          Switch on Wi-Fi

        • Go to Settings > Gear info, and switch on the debugging mode.

          Switch on debugging

      2. In the terminal, enter the following commands:

        cd tizen-sdk/tools
        ./sdb connect <IP address of Gear S2>
        

        Use the IP address you noted before.

        Instead of the terminal, you can also use the Remote Device Manager for the connection.

      3. In the first attempt, the connection fails and the device asks for user confirmation. To allow Gear to read log data, copy files to and from your computer, and install the application manually, click the accept mark.

        Allow Gear to access data

      4. In the Connection Explorer view, confirm that the device is connected (shown in the device list).

        Device is connected

    2. Generate an author certificate.

      Before you run the application, you must sign your application package with a certificate profile in the Tizen Studio.

    3. Run the application:
      1. In the Connection Explorer view, select the device.
      2. In Project Explorer view, right-click the project and select Run As > Tizen Native Application.

        Run the application on a target device

        Alternatively, you can also select the project in the Project Explorer view and do one of the following:

        • Press the Ctrl+F11 key.
        • Click the run icon in the toolbar.

        If you have both a connected device and existing emulator instances, select the device from the combo box in the toolbar before selecting to run the application.

        Selecting the device to use

      3. Confirm that the application launches on the target device.

        Like with the emulator, you must add the widget to the home screen before you can see it.

      NoteThe application is launched using the default debug run configuration. To create and use another configuration:
      1. In the Project Explorer view, right-click the project and select Run As > Run Configurations.
      2. In the Run Configurations window, click the New Launch Configuration icon (New Launch Configuration icon), define the configuration details, and launch the application by clicking Run.

        Run Configurations window

      If you want to run your application without a local device, see Managing and Connecting Devices for Testing.

    Building a Simple UI

    The following example is based on a template project for a wearable widget application, which was introduced in Creating a Project.

    The template project makes it easy to create your widget application. Without modification, you can build and run the project. However, it is important to understand the following template code to customize it.

    Initializing the Widget Application

    To initialize the widget application:

    1. To use the functions and data types of the Widget Application API, include the <widget_app.h> header file in your application:
      #include <widget_app.h>
      

      All header files that you need are already included in the MyWidget.h file, which is generated by the Tizen Studio when the template project is created.

    2. Edit the widget application settings in the manifest file.

    Creating the Widget Application

    To create the widget application:

    1. Start and initialize the application with the main() function.

      Set up the widget_app_lifecycle_callback_s structure variable for the widget application life-cycle callbacks, define the functions themselves (widget_app_create() for initialization and widget_app_terminate() for termination), and call the widget_app_main() function to start the application event loop:

      int
      main(int argc, char *argv[])
      {
          widget_app_lifecycle_callback_s ops = {0,};
          int ret;
      
          ops.create = widget_app_create;
          ops.terminate = widget_app_terminate;
      
          ret = widget_app_main(argc, argv, &ops, NULL);
          if (ret != WIDGET_ERROR_NONE)
              dlog_print(DLOG_ERROR, LOG_TAG, "widget_app_main() failed. Err = %d", ret);
      
          return ret;
      }
      
    2. Use the widget_app_create() life-cycle function of the Widget Application API to initialize any resources that can be shared among widget instances. This function is called before the main event loop starts.
      static widget_class_h
      widget_app_create(void *user_data)
      {
          /* Hook to take necessary actions before the main event loop starts */
          widget_instance_lifecycle_callback_s ops = {NULL,};
      
    3. Register the callback functions and make a class for widget instances.

      At the end of the widget_app_create() function, remember to create a widget instance class and return a handle for it, so that the handle can be used for making widget instances.

          return widget_app_class_create(ops, user_data);
      }
      
    4. When you no longer need the widget application, release the resources and terminate the application:
      static void
      widget_app_terminate(void *user_data)
      {
          /* Release all resources */
      }
      

    Managing Widget Instance Life-cycle Callbacks

    The widget application provides a life-cycle and methods for making and managing a widget class. The application has one process, whose responsibility it is to make a class in the widget_app_create() callback function of the Widget Application API. With this class, the framework can make instances whenever applications for widget viewers (such as home screen or lock screen) request for a widget instance.

    The widget instance has its own life-cycle, which is similar to the widget application. However, the widget instance is just an object that is shown by the applications for widget viewers. Many widget instances can be running on the same widget application process.

    To manage the widget instance life-cycle:

    1. Define the widget instance life-cycle callbacks:
      • This callback is triggered when the widget instance is created.

        Initialize resources for the widget instance and draw the UI. If the bundle content is not NULL, restore the previous status.

        static int
        widget_instance_create(widget_context_h context, bundle *content,
                               int w, int h, void *user_data)
        {
            widget_instance_data_s *wid = (widget_instance_data_s*)
                                          malloc(sizeof(widget_instance_data_s));
            int ret;
        
            if (content != NULL)
                /* Recover the previous status with the bundle object */
        
            /* Create the UI */
        
            return WIDGET_ERROR_NONE;
        }
        
      • This callback is triggered when the widget instance is destroyed.

        Release all widget resources. If the reason for the termination is not WIDGET_APP_DESTROY_TYPE_PERMANENT, store the current status with the incoming bundle.

        static int
        widget_instance_destroy(widget_context_h context, widget_app_destroy_type_e reason,
                                bundle *content, void *user_data)
        {
            if (reason != WIDGET_APP_DESTROY_TYPE_PERMANENT)
                /* Save the current status at the bundle object */
        
            return WIDGET_ERROR_NONE;
        }
        
      • This callback is triggered when the widget instance is paused.

        Take the necessary actions since the widget instance becomes invisible. The framework can destroy a paused widget instance.

        static int
        widget_instance_pause(widget_context_h context, void *user_data)
        {
            return WIDGET_ERROR_NONE;
        }
        
      • This callback is triggered when the widget instance is resumed.

        Take the necessary actions since the widget instance becomes visible.

        static int
        widget_instance_resume(widget_context_h context, void *user_data)
        {
            return WIDGET_ERROR_NONE;
        }
        
      • This callback is triggered when a widget update event is received.

        Take the necessary actions for the widget update. If the force parameter is true, the widget can be updated even in the pause state.

        static int
        widget_instance_update(widget_context_h context, bundle *content, int force, void *user_data)
        {
            return WIDGET_ERROR_NONE;
        }
        
    2. Register the callbacks in the widget_instance_lifecycle_callback_s structure during the widget application initialization:
      static widget_class_h
      widget_app_create(void *user_data)
      {
          widget_instance_lifecycle_callback_s ops = {
              .create = widget_instance_create,
              .destroy = widget_instance_destroy,
              .pause = widget_instance_pause,
              .resume = widget_instance_resume,
              .update = widget_instance_update,
          };
      
          return widget_app_class_create(ops, user_data);
      }
      

    Drawing the Widget UI

    To draw the widget UI, you must get a window object with the widget_app_get_elm_win() function of the Widget Application API and create the UI on the home screen:

    #include <widget_app_efl.h>
    
    struct widget_instance_data {
        Evas_Object *win;
        Evas_Object *conform;
        Evas_Object *label;
    };
    typedef struct widget_instance_data widget_instance_data_s;
    
    static int
    widget_instance_create(widget_context_h context, bundle *content,
                           int w, int h, void *user_data)
    {
        widget_instance_data_s *wid = (widget_instance_data_s*)
                                      malloc(sizeof(widget_instance_data_s));
    
        int ret;
        if (content != NULL)
            /* Recover the previous status with the bundle object */
    
        /* Window */
        ret = widget_app_get_elm_win(context, &wid->win);
        if (ret != WIDGET_ERROR_NONE) {
            dlog_print(DLOG_ERROR, LOG_TAG, "failed to get window. err = %d", ret);
    
            return WIDGET_ERROR_FAULT;
        }
    
        evas_object_resize(wid->win, w, h);
    
        /* Conformant */
        wid->conform = elm_conformant_add(wid->win);
        evas_object_size_hint_weight_set(wid->conform, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
        elm_win_resize_object_add(wid->win, wid->conform);
        evas_object_show(wid->conform);
    
        /* Label */
        wid->label = elm_label_add(wid->conform);
        evas_object_resize(wid->label, w, h / 3);
        evas_object_move(wid->label, w / 4, h / 3);
        evas_object_show(wid->label);
        elm_object_text_set(wid->label, "Hello widget");
    
        /* Show the window after the base GUI is set up */
        evas_object_show(wid->win);
    
        widget_app_context_set_tag(context, wid);
    
        return WIDGET_ERROR_NONE;
    }
    

    Managing Private Data for the Widget Instance

    Widget instances can have private data. The data usually includes view objects to make a screen for each widget instance. The framework provides an easy way to find private data from the widget context handle, which is provided as a parameter in the callback functions. The following example shows how to make private data and use it:

    • You can define a private data structure and attach it to the widget instance by calling the widget_app_context_set_tag() function of the Widget Application API:
      struct widget_instance_data {
          Evas_Object *win;
          Evas_Object *conform;
          Evas_Object *label;
      };
      typedef struct widget_instance_data widget_instance_data_s;
      
      static int
      widget_instance_create(widget_context_h context, bundle *content,
                             int w, int h, void *user_data)
      {
          widget_instance_data_s *wid = (widget_instance_data_s*)
                                        malloc(sizeof(widget_instance_data_s));
      
          ret = widget_app_get_elm_win(context, &wid->win);
      
          wid->label = elm_label_add(wid->conform);
      
          widget_app_context_set_tag(context, wid);
      }
      
    • You can get the private data from the widget instance by calling the widget_app_context_get_tag() function of the Widget Application API.

      The following code within the widget_instance_update() callback is not included in the default application template in the Tizen Studio, but you can add it to test the data handling feature.

      static int
      widget_instance_update(widget_context_h context, bundle *content,
                             int force, void *user_data)
      {
          widget_instance_data_s *wid = NULL;
          widget_app_context_get_tag(context, (void**)&wid);
          if (wid->label)
              elm_object_text_set(wid->label, "Update Widget");
      
          return WIDGET_ERROR_NONE;
      }
      
    • Make sure that all the resources that you allocate are freed in the callback function for the widget instance destructor:
      static int
      widget_instance_destroy(widget_context_h context,
                              widget_app_destroy_type_e reason, bundle *content, void *user_data)
      {
          widget_instance_data_s *wid = NULL;
          widget_app_context_get_tag(context, (void**)&wid);
      
          if (wid->win)
              evas_object_del(wid->win);
      
          free(wid);
      
          return WIDGET_ERROR_NONE;
      }