Les données sont publiées dans des streams ou flux de mesures temporelles.Il existe 2 types de données : les metrics (mesures) et les events (évènements).
Streams
IntentPlatform offre la possibilité aux clients API de passer directement par un stream (ou flux de données) pour lire ou écrire de la donnée.
2 paramètres sont obligatoires à la création d'un stream :
Sa référence
Son type (metrics ou events)
Unités
Lorsqu'il s'agit d'un stream metrics, un 3ème paramètre est alors obligatoire :
Son unité (unit)Ce paramètre est, par contre, interdit lorsqu'il s'agit d'un stream events.
Les unités disponibles sont :
Unité
Description
m3
Mètre cube
mps
Mètre par seconde
m3ps
Mètre cube par seconde
wm2
Watt par mètre carré
L
Litre
celsius
Degré Celsius
celsiusDay
Degré Jour en Celsius
kwh
Kilowatt heure
mwh
Mégawatt heure
kw
Kilowatt
V
Volt
A
Ampère
percentage
Pourcentage
pascal
Pascal
mn
Minute
h
Heure
s
seconde
kph
Kilomètre / heure
mbar
Millibars
euro
Euros
unit
unité
Tags descriptifs
Vous pouvez, par ailleurs, ajouter d'autres paramètres (facultatifs) à vos streams afin de mieux les définir.
Ces tags descriptifs sont de 2 sortes :
intent_tags : ces tags sont définis par IntentPlatform en tant que standards, pour faciliter leur adoption et partage. Ces tags sont standardisés, les valeurs peuvent être contraintes selon les cas.
tags libres : Le tag peut représenter une valeur à partager sur un élément de patrimoine donné.
La référence d'un contrat qui peut exister, ou non, sur IntentPlatform
intent_sourceEntity
L'entité créatrice du stream
Référence d'un streamLa référence ne peut pas contenir de "/" et ""Nous déconseillons l'utilisation de caractère spéciaux (@;#;&;^;*,etc.) et d'espace.
Fréquence des streamsLa fréquence des flux de données va permettre à intentPlatform de calculer des indicateurs sur la santé des flux et leur qualité.Si vous indiquez une fréquence nulle, ces indicateurs ne seront pas disponibles.La fréquence peut également avoir une importance dans l'affichage des données. Si vous indiquez une fréquence de 60 minutes et que vous envoyez des données toutes les 10 minutes, intentPlatform ne gardera qu' 1 donnée sur 6. intentPlatform ne gardera que la dernière donnée par tranche de 60 min.Pour des flux ayant une fréquence variable comme le relevé manuel d'index des compteurs, vous pouvez indiquer une fréquence de 0 ou alors ne pas indiquer de fréquence.
Partage des streams avec mes partenairesLe champ intent_contractReference est optionnel.Si vous souhaitez partager vos données avec un ou plusieurs partenaires, il vous faut absolument remplir ce champ. Si vous ne le faite pas, alors les données des streams seront uniquement accessible par le propriétaire du stream.
Activités
IntentPlatform prend en charge un certain nombre d’activités. Le tableau présenté ci-après indique les différents types d’activités gérés par le système. Sont précisés pour chaque type :
la clé d’activité, à spécifier dans les URL pour sélectionner la ou les activités correspondantes sur un élément de la base patrimoniale ;
le label ;
la nature des activités en question ;
l’unité des données qu’il est possible de publier dans les activités de ce type.
Température
Activité
Label
Description
Unité
AirTemp
Température air intérieur
Température intérieure en dégrés celsius
°C
OutsideAirTemp
Température air extérieur
Température extérieure en dégrés celsius
°C
AggSiteTemp
Température air (moyenne du site)
Moyenne de température pour les parties privatives d'un site
°C
SiteTempVar
Ecart température
Ecart entre les températures Min/Max des parties privatives d'un site
°C
DJU
Degrés jour unifiés
Degrés jour unifiés
n/a
Hygrométrie
Activité
Label
Description
Unité
OutsideAirHygro
Hygrométrie extérieure
Hygrométrie extérieure en pourcentage d'humidité
%
AirHygro
Hygrométrie intérieure
Hygrométrie intérieure en pourcentage d'humidité
%
Electricité
Activité
Label
Description
Unité
GlobalElecCons
Consommation générale Electricité
Consommation générale électrique en kilowatt-heure
kWh
ElecCons
Consommation Electricité
Consommation électrique en kilowatt-heure
kWh
LightingElecCons
Electricité éclairage
Consommation électrique de l'éclairage en kilowatt-heure
kWh
HeatingElecCons
Electricité chauffage
Consommation électrique du chauffage en kilowatt-heure
kWh
HVACElecCons
Electricité CVC
Consommation électrique des auxiliaires CVC
kWh
VentilationElecCons
Electricité VMC
Consommation électrique de la VMC en kilowatt-heure
kWh
ITElecCons
Electricité information
Consommation électrique des équipements informatiques en kilowatt-heure
kWh
WashingElecCons
Electricité lavage
Consommation électrique des équipements de lavage en kilowatt-heure
kWh
CookingElecCons
Electricité cuisson
Consommation électrique des appareils de cuisson en kilowatt-heure
kWh
HeatPumpElecCons
Electricité PAC
Consommation électrique des pompes à chaleur, en kilowatt-heure
kWh
WaterPumpElecCons
Electricité pompe à eau
Consommation électrique des pompes à eau, en kilowatt-heure
kWh
InverterOutletElecCons
Electricité prises détrompées
Consommation électrique des prises de courant détrompées en killowatt-heure
kWh
HotWaterProdElecCons
Electricité ECS
Consommation électrique pour la production d'eau chaude sanitaire en kilowatt-heure
kWh
OutletCons
Electricité prises
Consommation électrique des prises de courant en kilowatt-heure
kWh
ShuttersElecCons
Electricité volets
Consommation électrique des volets roulants en kilowatt-heure
kWh
OtherElecCons
Electricité autre
Consommation électrique des usages autres en kilowatt-heure
kWh
BuildingAuxElecCons
Electricité Aux. Bâtiment
Consommation électrique des équipements auxiliaires du bâtiment
kWh
TechnicalElecCons
Electricité Equip. Techniques
Consommation électrique des équipements techniques
kWh
CoolingElecCons
Electricité Rafraichissement
Consommation électrique des équipements de rafraichissement
kWh
ElecWithdrawal
Soutirage électricité
Soutirage électrique en kilowatt-heure
kWh
SolarElecProd
Production électricité solaire
Production électrique solaire en kilowatt-heure
kWh
ElecPower
Puissance électrique
Puissance électrique en killowatts
kW
ElecPowerProd
Puissance électrique produite
Puissance électrique produite en kW
kW
ElecPowerCons
Puissance électrique consommée
Puissance électrique consommée en kW
kW
ElecPowerSelfCons
Puissance électrique auto-consommée
Puissance électrique auto-consommée en kW
kW
ElecPowerProdSurplus
Puissance électrique produite en surplus
Puissance électrique produite en surplus en kW
kW
ElecVoltage
Tension électrique
Tension électrique en Volt
V
ElecCurrent
Intensité électrique
Intensité électrique en Ampère
A
Eau
Activité
Label
Description
Unité
GlobalWaterCons
Consommation générale Eau
Consommation générale d'eau en mètre-cube
m3
WaterCons
Consommation d'Eau
Consommation d'eau en mètre cube
m3
ColdWaterCons
Eau froide
Consommation d'eau froide en mètre cube
m3
ColdWaterTemp
Température eau froide
Température du circuit d'eau froide en degrés Celsius
°C
WaterTemp
Température eau
Température du circuit d'eau en degrés Celsius
°C
WaterFlow
Débit d'eau
Débit d'eau en mètre cube par seconde
m3/s
Gaz
Activité
Label
Description
Unité
GlobalGasCons
Consommation générale de Gaz
Consommation générale de gaz en mètre-cube
m3
GlobalConcessionaryGasEnergyCons
Energie gaz
Quantité d'énergie consommée (Gaz)
kWh
GasCons
Consommation de Gaz
Consommation de gaz en mètre cube
m3
HeatingGasCons
Gaz chauffage
Consommation de gaz pour le chauffage en mètre cube
m3
HotWaterProdGasCons
Gaz ECS
Consommation de gaz pour la production d'eau chaude sanitaire en mètre cube
m3
GlobalGasCons
Consommation de Gaz générale
Consommation générale de gaz en mètre cube
m3
Fioul
Activité
Label
Description
Unité
FuelCons
Fioul
Consommation de fioul en mètre cube
m3
HeatingFuelCons
Fioul chauffage
Consommation de fioul des équipements de chauffage
m3
HotWaterProdFuelCons
Fioul ECS
Consommation de fioul des équipements ECS
m3
RemainingFuelVolume
Fioul restant
Volume de fioul restant en mètre cube
m3
Chauffage
Activité
Label
Description
Unité
BoilerCalorimetry (dépréciée)
Calorimétrie chaudière
Quantité de chaleur produite par le chauffage en kilowatt-heure
kWh
HeatingCalorimetry
Calorimétrie chauffage
Quantité de chaleur produite ou consommée par le chauffage en kilowatt-heure
kWh
SolarHeatingCalorimetry
Calorimétrie chauffage solaire
Quantité de chaleur produite ou consommée par le chauffage solaire en kilowatt-heure
kWh
RCUCalorimetry
Calorimétrie réseau de chaleur urbain
Quantité de chaleur produite ou consommée par les réseaux de chaleur urbains
kWh
BoilerWaterCons (dépréciée)
Eau Circuit de chauffage
Consommation d'eau du chauffage en mètre cube
m3
HeatingWaterCons
Eau circuit chauffage
Consommation d'eau du circuit de chauffage
m3
BoilerTemp
Température circuit eau chauffage
Température du circuit d'eau du chauffage en degrés Celsius
°C
BoilerInboundTemp
Température chauffage (retour chauffage)
Température d'entrée du circuit de chauffage en degrés Celsius
°C
BoilerOutboundTemp
Température chauffage (départ chauffage)
Température de sortie du circuit chauffage en degrés Celsius
°C
BoilerOutboundTempSetPoint
Température de consigne départ chauffage
Température de consigne pour le départ du circuit chauffage en degrés Celsius
°C
BoilerOutboundSetPoint
Consigne de température départ - chauffe-eau/ECS
Température souhaitée pour le départ du circuit de chauffe-eau en degrés Celsius
°C
HeaterOutboundSetPoint
Consigne de température départ - chauffage
Température souhaitée pour le départ du circuit de chauffage en degrés Celsius
°C
TemperatureSetPoint
Température de consigne
Température souhaitée pour le local d'habitation desservi par la température de consigne en degrés Celsius
°C
SolarInboundTemp
Température entrée échangeur solaire
Température entrée échangeur solaire en degrés Celsius
°C
SolarOutboundTemp
Température sortie échangeur solaire
Température sortie échangeur solaire en degrés Celsius
°C
ECS
Activité
Label
Description
Unité
GlobalHotWaterCons
Conso ECS globale
Consommation générale d'eau chaude
m3
HotWaterCons
Conso ECS
Consommation d'eau chaude sanitaire en mètre cube
m3
HotWaterProd
Production ECS
Production d'Eau Chaude Sanitaire
m3
HeatingHotWaterCons
Conso ECS chauffage
Concommation d'ECS par les équipements de chauffage
m3
HotWaterProdWaterCons
Eau circuit ECS
Consommation d'eau du circuit ECS
m3
HotWaterTemp
Température eau chaude
Température du circuit d'eau chaude sanitaire en degrés Celsius
°C
HotWaterCalorimetry
Calorimétrie production ECS
Quantité de chaleur produite par la production d'eau chaude sanitaire en kilowatt-heure
kWh
HotWaterInboundTemp
Température ECS (retour ECS)
Température d'entrée du circuit d'eau chaude sanitaire en degrés Celsius
°C
HotWaterOutboundTemp
Température ECS (départ ECS)
Température de sortie du circuit d'eau chaude sanitaire en degrés Celsius
°C
Eau Glacée
Activité
Label
Description
Unité
GlobalChilledWaterCons
Eau glacée globale
Consommation d'eau glacée générale
m3
GlobalChilledWaterConsCalorimetry
Calorimétrie Eau glacée générale
Consommation d'eau glacée générale en kilowatt-heure
kWh
ChilledWaterCons
Eau glacée
Consommation d'eau glacée
m3
ChilledWaterConsCalorimetry
Calorimétrie Eau glacée
Consommation d'eau glacée en kilowatt-heure
kwh
CoolingChilledWaterCons
Conso eau glacée
Consommation d'eau glacée par les équipements de refroidissement
m3
CoolingChilledWaterProd
Production eau glacée
Production d'eau glacée par les équipements de refroidissement
m3
ITChilledWaterCons
Conso eau glacée IT
Consommation d'eau glacée par les équipements informatique
m3
ChilledWaterTemp
Température eau glacée
Température d'eau glacée en °C
°C
ChilledWaterOutboundTemp
Température eau glacée (départ)
Température départ du circuit d'eau glacée en °C
°C
ChilledWaterInboundTemp
Température eau glacée (retour)
Température retour du circuit d'eau glacée en °C
°C
RFC
Activité
Label
Description
Unité
RFCAssetIndex
Index RFC
Index sans grandeur associée à un asset
n/a
RFCAssetCharge
Charge répartie RFC
valeur en euro des provisions de charge
euro
VMC - CTA
Activité
Label
Description
Unité
VmcPressure
Pression moyenne VMC
Pression moyenne VMC
Pa
RejectedTempATS
Température Rejeté CTA
Température de rejet de la centrale de traitement de l'air
°C
TempExtractAirATS
Température Air Extrait CTA
Température de l'air extrait de la centrale de traitement d'air
°C
NewAirTempATS
Température Air Neuf CTA
Température de l'air neuf de la centrale de traitement d'air
°C
BlownAirTempATS
Température Air Soufflé CTA
Température de l'air soufflé par la centrale de traitement d'air
°C
AirFlow
Débit d'air
Débit d'air en mètre cube par seconde
m3/s
Pression
Activité
Label
Description
Unité
OutsideAirPressure
Pression extérieure
Pression extérieure en millibar
mbar
AirPressure
Pression interieure
Pression intérieure en millibar
mbar
Ascenseur
Activité
Label
Description
Unité
BrakeActivationTime
Durée activation de levée frein
Durée d’activation de levé du frein en minutes
minutes
NbMove
Démarrage ascenseur
Nombre de démarrage ascenseur
n/a
LiftState
Santé ascenseur
États de santé de l'ascenseur
n/a
Etat
Activité
Label
Description
Unité
AirQuality
Qualité de l'air
Qualité de l'air intérieur
n/a
AlarmReport
Rapport d'alarme
Rapport d'alarme
n/a
HealthState
Santé
Indicateurs de santé
n/a
SystemFailure
Panne
Rapport de panne
n/a
Intrusion
Intrusion
Rapport d'intrusion
n/a
SystemActivation
Activation
Rapport d'activation
n/a
LowLevel
Niveau bas
Rapport de niveau bas
n/a
SignalDuration
Durée signal état haut
Durée du signal à l'état haut en secondes
secondes
BatteryLevel
Niveau de batterie
Niveau de batterie restant
n/a
Fumée
Activité
Label
Description
Unité
SmokeDetection
Détection de fumée
Détection de fumée
n/a
Vent
Activité
Label
Description
Unité
WindSpeed
Vitesse du vent
Vitesse du vent en mètres par secondes
m/s
WindDirection
Direction du vent
Direction du vent
n/a
Autres
Activité
Label
Description
Unité
AirCO2
Concentration CO2
Concentration CO2 en ppm
ppm
SunPower
Ensoleillement
Ensoleillement en W/m2
W/m2
Humidex
Humidex
L'indice Humidex intègre les effets combinés de la chaleur et de l'humidité de l'air. C'est un indicateur de température d'extérieur. Moins de 30 : aucun inconfort. 30-39 : faible inconfort. 40-45 : inconfort. 45-54 : danger d'hyperthermie. 54+ : coup de chaleur imminent.
n/a
WatchState
État montre
État de la montre
n/a
GenericCount
Comptage unitaire générique
Comptage générique sans dimension - nombre d'unités.
unit
ItemCount
Nombre d'éléments
Nombre d'éléments
unit
Les types de données
Le système autorise la publication de différents types de données d’activité (matérialisés par le intent_dataType) :
Metrics
intent_dataType :
snapshot : désigne une mesure instantanée. Par exemple, un index de compteur de consommation électrique, ou la température intérieure d'un logement.
delta : désigne les valeurs mesurant la différence entre deux instants, comme une consommation ou une différence (ex: consommation d’eau entre deux mois)
average : désigne les valeurs présentant une moyenne sur une durée définie, comme une moyenne (ex: température moyenne sur un mois)
Ces données sont définies par 3 paramètres :
value : valeur exprimée dans l’unité associée au type de l’activité dans lequel la donnée est publiée
information : Objet optionnel contenant des informations supplémentaires, dépendant du type d'alerte. Par exemple:
pour une dépose de compteur : { compteurRef: référence compteur déposé, dernierIndex: index de dépose du compteur}
pour une installation de compteur : { nouveauCompteurRef: référence du nouveau compteur, nouveauIndex: index de pose du nouveau compteur}
Pensez aux utilisateursLes valeurs renseignées dans les champs "type" et "status" sont visibles des utilisateurs sur le web et le mobile. Il est donc important de penser à l'expérience utilisateur en indiquant des valeurs ayant un sens métier et compréhensible par tout profil d'utilisateur (gardien, locataire, responsable d'agence, centre d'appel, expert technique)
Pour toute requête attendant une réponse sous forme de liste, un critère limitant (pagination et/ou période de temps) est attendu.
Pagination des listes de résultatsIl est difficile d’anticiper avec exactitude l’évolution de la quantité de données qui sera retournée lors des différentes requêtes. Nous paginons donc nos ressources.De plus, la pagination étant une information importante, elle est positionnée dans la requête.(ex : page=1&countByPage=20)Le code retour HTTP correspondant au retour d’une requête paginée est 200 Ok.Dans le cas où la pagination demandée ne rentre pas dans les valeurs tolérées par l’API, la réponse HTTP sera un code erreur 400, avec une description explicite de l’erreur dans le body.
Péridode de consultation des metrics et eventsIl est obligatoire de spécifier une période de temps pour la consultation des metrics et events. Cette période (qu'il s'agisse de metrics ou d'events) est limitée à un an par requête.since : permet de récupérer toutes les données qui ont été modifiées par la plateforme Intent depuis le...from/to : permet de récupérer toutes les données d'IntentPlatform entre le ... et le ...