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:

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

App Manifest Attributes

  • appGuid – A string containing a UUID to identify the app. This should be unique to each FrontPanel Platform App, but you should keep this UUID the same for different releases (or versions) of the app.
  • 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.
  • icon – A resource for the application icon SVG with a square aspect ratio. This is shown in the application launcher.
  • permissions – Set of requested permissions for your app within the Platform.
    • network – Set to true if your application needs HTTP, HTTPS, or WebSocket access to external servers.
  • 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.