Consommation

Sur quel élément de patrimoine rattacher la consommation ?

Les données de consommation seront rattachées à un élément du bâti à savoir au logement, au local, à l'immeuble ou encore à la partie commune.

Index ou consommation ?

Vous pouvez choisir de transmettre l'une ou l'autre des informations. Tout va dépendre de la demande de votre client et des cas d'utilisation ensuite souhaitée.

Remplacement de compteur

Vous devez toujours conserver le même flux (stream). Si le compteur est remplacé, on ne crée pas de nouveau flux, on conserve le même.

Remise à 0 du compteur

Si vous choisissez de transmettre les index du compteur :
IntentPlatform attend à toujours avoir un index croissant. Si le compteur voit son index être remis à 0, vous devrez le prendre en compte afin de continuer à transmettre un index croissant et non un index à remis 0.

Comment transmettre les données

Pour transmettre les données, il vous faudra créer un stream de type metrics et l'alimenter en données.  ⁠⁠Mesures⁠ 
L'API à utiliser est l' API Data v1 .

Consommation

Il vous faut créer un stream de type metrics et avec un dataType = delta.
{
  "reference": "STREAM-metrics-1",
  "label": "Consommation d'eau froide du logement 213LO98",
  "type": "metrics",
  "tags": {
    "intent_unit": "m3",
    "intent_assetReference": "213LO98",
    "intent_activityKey": "GlobalWaterCons",
    "intent_dataType": "delta",
    "intent_frequency": 60,
    "intent_contractReference": "CONTRACT-10",
    "numéro de série": "16A8986765",
    "référence client": "G46245"
  }
}

Index

Il vous faut créer un stream de type metrics et avec un dataType = snapshot.

Caractéristique du stream

Toutes les caractéristiques :  doc api en ligne 
Référence : Vous êtes libre de fixer la référence du stream. Elle doit cependant être unique pour toute votre entité et donc pour tous vos clients.

Label : Le label doit être compréhensible par tous les utilisateurs.

Alimenter le stream Consommation en données

Une fois que votre stream est créé, vous pouvez l'alimenter en données au fil de l'eau.

POST /events
{
  "streamReference": "STREAM-metrics-1",
  "payload": [
    {
      "value": 12.4,
      "timestamp": 1504063834184
    },
    {
      "value": 13.4,
      "timestamp": 1505063834184
    },
    {
      "value": 14.4,
      "timestamp": 1506063834184
    }
  ]
}

Vous pouvez transmettre plusieurs données mesurées dans 1 seul appel API. Les différentes données mesurées sont à indiquer dans le payload. Ceci vous permet notamment de transmettre toutes les données mesurées sur les 24 dernières heures en 1 seul appel API.