Skip to main content

Code transplant

TL;DR

  • Copy the generated code to your project, and call setupUI() to setup the UI
  • Copy the SDK code to your project if needed
  • Replace the dummy code to your project if needed

Overview​

Generally, anyui is majorly for UI design, and the UI code should be independent of the underlying hardware and tools like keil etc.

However, anyui provides more than just UI code. It also provides a SDK which you can utilize and extend to manage screens and communicate with the underlying hardware.

Transplant​

  • UI code

    All the UI code is generated under {root}/generated folder, including generated screens and converted images & fonts & lotties.

    This code is auto generated, so please don't manually modify it.

  • SDK

    The SDK code resides in {root}/sdk folder, which provides utilities for screen management and commmunication with the underlying hardware.

    You can extend the SDK to tackle specific requirements.

warning

Please notice that, we probably would update SDK code in the future release to provide more features, and you need to manage with the conflicts with your own modification if any.

  • dummy code

    The dummy code resides in {root}/simulator/dummy.c, which provides a dummy implementation of the SDK, and you need to replace it with real implementation for your device.

    The dummy code includes:

    • Handle of the communication command sending from UI
    • File system driver implementation for your external storage (in case you need to use external image file as source)
    • Timer for time update and battery status update (This is just for demo, you can replace it with real implementation, or just remove them)

  • lv_conf.h

    You should have your own copy of lv_conf.h file for the device image, which should at least include the following:

    /*
     * Here below are required
    */
    #define LV_HOR_RES_MAX (?) // Horizontal resolution
    #define LV_VER_RES_MAX (?) // Vertical resolution
    #define LV_COLOR_DEPTH 16
    /*Size of the memory available for 'lv_mem_alloc()' in bytes (>= 2kB)*/
    #define LV_MEM_SIZE (?) // Memory size in bytes

    /*
     * Here below are optional or as needed
     */
    #define LV_USE_LOG 1 // Enable log

    #define LV_USE_FS_STDIO 1 // Enable file system
    #define LV_USE_PNG 1 // Enable PNG decoder
    #define LV_USE_JPEG 1 // Enable JPEG decoder
    #define LV_USE_BMP 1 // Enable BMP decoder
    #define LV_USE_GIF 1 // Enable GIF decoder

    #define LV_USE_BTN 1 // Enable button
    #define LV_USE_IMG 1 // Enable image
    #define LV_USE_LABEL 1 // Enable label
    // others as needed

    /*
     * Here below should not be defined for device image
     *;
    //#define USE_SIMULATOR