Skip to content

Application architecture

  • When Vobot Dock starts, it will retrieve the /apps folder in the file system. Each subfolder is treated as a separate App, and Mini Dock will try to load these customized applications.
    /apps
       |-- your_app1
       |-- your_app2
       |-- your_app3
    
  • When developing applications in Thonny, store your application in the /apps/your-app folder. It is recommended that you develop in the following directory and use __init__.py as the entry file of the application. You can think of your-app as a Python module.

Folder structure

  • As a minimum requirement, new applications typically have the following folder structure:
    your_app
       |-- manifest.yml
       |-- __init__.py
    
  • __init__.py serves as the entry file for the application (must be implemented);

  • manifest.yml is a manifest description file (optional implementation) used for automatic packaging when publishing your application in Vobot App Gallery.

Size of App

  • When installed, the maximum size allowed for an application is 200KB, including all resource files. The file system space occupied by all applications is limited to 900KB.

App folder (optional)

  • If your application is very large, it is recommended to use the following structure:
    your_app
       |-- manifest.yml
       |-- __init__.py
       |-- app
       |-- resources
       |-- settings
    
  • Application

    • /app/
      • Contains application logic to access companion APIs and interact with presentation layers such as LVGL.
  • Settings

    • /settings/
      • Contains application settings declarations written using the Settings API, allowing users to configure the application.