User interface configuration

Type: object

The User Interface configuration

Type: array

The list of assets

All items must be unique

No Additional Items

Each item of this array must be:

Asset

Type: object

The asset class

Type: array

The datapoints associated with the asset

All items must be unique

No Additional Items

Each item of this array must be:

Datapoint associated with an asset

Type: object

Datapoint associated with an asset

Type: string

The datapoint identifier

Type: string

Optional key name for the datapoint (defaults to the datapoint name if not provided)

Type: string

The description of the asset

Type: string

The name of the asset, must be unique

Type: string

The unique identifier of the asset

SMV metadata

Type: object

SMV Metadata

Type: string

SMV Application ID

Type: integerFormat: uint32

Frequency in Hz

Value must be greater or equal to 0.0

Type: string

SMV Sample Rate

Type: string

SMV Stream Identifier

Type: enum (of string)

Must be one of:

  • "smv_stream"

Default: null

The list of widgets

Type: object

Dashboard configuration

Type: string

Dashboard description

Type: object

Dashboard grid configuration

Type: integerFormat: uint32

Number of columns

Value must be greater or equal to 0.0

Type: integerFormat: uint32

Number of rows

Value must be greater or equal to 0.0

Type: string

Dashboard identifier

Type: string

Dashboard title

Type: array

Dashboard variables

No Additional Items

Each item of this array must be:

Type: object

Dashboard variable This variable can be referenced anywhere in the dashboard configuration as a replacement string Eg: ${variable_id}

Type: string Default: ""

Default value

Type: string Default: ""

Description for the variable (currently unused)

Type: string

Variable identifier

Type: string Default: ""

Label for the variable (currently unused)

Type: array

Widgets included in the dashboard

No Additional Items

Each item of this array must be:

Type: object

Dashboard widget

Type: array

Datapoints associated with the widget

No Additional Items

Each item of this array must be:

Type: object

Datapoint reference for a widget A datapoint can be referenced directly or via an asset reference

Type: object

Direct datapoint reference

Type: string or null

Key name for the datapoint (defaults to the datapoint name if not provided)

Type: boolean or null

Whether to request data for this datapoint (default true)

Type: object

Asset datapoint reference

Type: string or null

Optional asset's datapoint key, if this is not provided, all the asset's datapoints will be used

Type: string or null

Key name for the datapoint

Type: boolean or null

Whether to request data for this datapoint (default true)

Type: string

Widget identifier

Type: object

Widget options as a JSON value

Type: object

Widget position in the dashboard grid

Type: integerFormat: uint32

Height in grid units

Value must be greater or equal to 0.0

Type: integerFormat: uint32

Width in grid units

Value must be greater or equal to 0.0

Type: integerFormat: uint32

X position

Value must be greater or equal to 0.0

Type: integerFormat: uint32

Y position

Value must be greater or equal to 0.0

Type: string or null Default: null

Widget type

Type: null