Application Manifest

FrontPanel Platform apps are designed to share basic information with the App Launcher for both presentation and practical purposes. This information is provided in the app bundle in the form of a JSON file such as the one below:

{
    "id": "dac+adc-example-app",
    "name": "DAC-ADC",
    "version": "0.5.0",
    "author": "Opal Kelly Incorporated",
    "summary": "FFT-based signal generator, oscilloscope, and spectrum analyzer demonstration instruments",
    "description": "FFT-based signal generator, oscilloscope, and spectrum analyzer demonstration instruments",
    "icon": { "source": "assets/images/dac+adc-app-logo.svg" },
    "deviceBindings": [
        { "name": "DAC-ADC Device", "description": "DAC-ADC Device" }
    ],
    "initialContentSize": {
        "width": 1200,
        "height": 804
    }
}Code language: JSON / JSON with Comments (json)

App Manifest Attributes

  • id – A string identifier that uniquely identifies the application.
  • name – The name of the app as it will be shown in the app card on the launcher.
  • version – Basic version string. We recommend a common format: major, minor, sub-minor.
  • summary – The summary should be brief (e.g. one sentence) so that it fits neatly within the app card in the launcher.
  • description – The description is a longer description of the application similar to a README file on GitHub. This is shown in the app launcher when a user clicks on the information icon. This file supports Markdown formatting.
  • deviceBindings – Reserved for future use.
  • initialContentSize – The default size of the app window when launched from the app launcher as specified by a key/value pair.