Variable

Identifiant d'une variable

L'identifiant d'une variable se présente sous la forme mbX/dxxxxxx. Il est fourni par Braincube, il est composé de l'identifiant de la base précédé de mb et de l'identifiant de la variable précédé de d.

Attributs d'une variable

Une variable est composée d'un identifiant et de définition de fréquence (LF et/ou HF). Elle peut aussi contenir différentes informations complémentaires selon les données demandées.

Paramètre	Description	Required
id	Identifiant de la variable au format Braincube	true
lf	Définition de la basse fréquence	false
hf	Définition de la haute fréquence	false
tag	Tag de la variable	false
local	Nom local de la variable	false
standard	Nom standard de la variable	false

{
    // Identifiant Braincube
    "id" : "mb1/d10000805",

    // Fréquence LF
    "lf" : {
      "id" : "mb1/d10000805",
      "type" : "NUMERIC",
      "reference" : "mb1/d10000001",
      "context" : {
        "dataSource" : "mb1"
      },
      "definition" : "d10000805"
    },

    // Fréquence HF
    "hf" : {
      "id" : "mb12/d1200000",
      "type" : "NUMERIC",
      "context" : {
        "dataSource" : "mb12"
      },
      "definition" : "d1200000"
    },

    // Tag Braincube
    "tag" : "tag1.pv",

    // Nom local Braincube
    "local" : "Définition de tag1.pv",

    // Nom standard Braincube
    "standard" : "Définition de tag1.pv | tag1.pv"
  }

Définition des différents types d'une variable

• NUMERIC : Variable numérique
• DISCRET : Variable discrète
• DATETIME : Variable date / heure

Définition d'une variable de fréquence

Attributs communs à toutes les variables.

Name	Description	Required
id	Nom de la variable au format Braincube	true
type	Type de la variable (NUMERIC, DISCRET, DATETIME)	true
context	Context définissant la Data source	true

Variable en base de données

Attribut d'une variable stockée en base de données :

Name	Description	Required
definition	Identifiant de la variable dans la Data source	true

// Définition d'une variable de fréquence stockée en base de données
{
  "id" : "mb1/d10000805",
  "type" : "NUMERIC",
  "context" : {
    "dataSource" : "mb1"
  },
  "definition" : "d10000805"
}

Variable calculée

Attribut d'une variable calculée :

Paramètre	Description	Required
formula	Formule de la variable	true

// Définition d'une variable de fréquence calculée à la volée
{
  "id" : "mb1/d10000805",
  "type" : "NUMERIC",
  "context" : {
    "dataSource" : "mb1"
  },
  "formula" : {
    "SUM" : [ "mb2/d200493", "mb2/d200001" ]
  }
}