Signal Info contains metadata for a signal.

type: object

Properties

Name

Type

Default

Description

name

string

Same as Input ID

The default item display name.

type

string("numeric" || "enum")

"numeric"

The default item type.

description

string

""

The default item description.

labels

map of string(regex: "^[A-Za-z0-9-_/]{1,40}$") => array of string

{}

The default item labels.

annotations

map of string(regex: "^[A-Za-z0-9-_/]{1,40}$") => string

{}

Arbitrary configuration parameters. Customer-provided annotations should use a relevant prefix, e.g. company-domain/application-name/.

PS! This property is merged with existing values on save!

engUnit

string

""

Default item display unit, used in numeric representations.

enumValues

map of string(integer in range 0-9999) => string

{}

Default item enum values, used to replace numeric values with text in enumerated representations.

sourceType

string("measurement" || "aggregation" || "prediction")

"measurement"

Default item source type.

sampleInterval

null || string(RFC 3339 duration)

null

How often the signal is sampled (on average).

gapDetection

null || string(RFC 3339 duration)

null

The default item gap detection. A gap will be drawn whenever there is no data for a duration longer than the specified value.

{
    "name": "Ice Cream Temperature",
    "dataType": "numeric",
    "description": "Temperature measurement of the ice cream",
    "labels": {
      "flavours": [
        "sweet",
        "sour"
      ],
      "location": [
        "pier",
        "banana stand"
      ]
    },
    "engUnit": "°C",
    "sourceType": "measurement",
    "sampleInterval": "PT1M",
    "gapDetection": "PT5M"
  }