Sommaire

Reflet

Objet qui représente un reflet d’un REDY : l’image, dans la synapp, d’une ressource du REDY (une mesure, une consigne, un équipement…), avec son état, sa valeur et, s’il est commandable, la commande à lui envoyer. Chaque type de reflet a ses propres champs, en plus des champs communs.

On le trouve :

  • dans l’information reflect des acteurs à reflet : Détails de reflet, reflets techniques ;
  • dans la donnée (data) d’un fournisseur de reflet, utilisable par liaison (data.value…) ;
  • dans les réponses du magasin REDY (getReflect(), searchReflects()).

Les types de reflet que les acteurs savent afficher sont listés avec l’acteur Détails de reflet.

🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule

Champs communs

Champs présents sur tous les reflets.

Libellé Studio Champ Type Description
  alarm 🔒   Alarme du reflet (non renseigné avec un REDY).
  allowCommand 🔒 Boolean Indique si le reflet est commandable.
  canEvent   Indique si le reflet lève des évènements dans le REDY (attribut raiseEvents).
  canSubmit 🔒   Indique si la commande préparée (command) peut être envoyée : elle diffère des valeurs actuelles et aucune commande n’est en cours.
  classID   ID de la classe REDY de la ressource du reflet.
  collectionIDs   Identifiants REDY des ensembles de la ressource du reflet.
  command 🔒   Objet de commande du reflet, créé avec les valeurs actuelles : ses champs (valueCmd, modeForcedCmd, manualCmd… selon le type) sont envoyés au REDY par la commande du reflet.
  description 🔒 String Obtient la description du reflet.
  deviceID   Identifiant REDY de l’équipement de la ressource du reflet.
  exchangeDate 🔒   Date du dernier échange de données du reflet (non renseigné avec un REDY).
  fault 🔒 Boolean Indique si le reflet est en défaut.
  groupIDs   Identifiants REDY des groupes de la ressource du reflet.
  hasPendingCommand 🔒   Indique si une commande est en attente sur le reflet (non renseigné avec un REDY).
  hasPendingEvent 🔒 Boolean Indique si le reflet possède un évènement en cours.
REDY
  id Number ou string Clé primaire.
  infraId 🔒   Identifiant de l’infrastructure du reflet (non renseigné avec un REDY).
  isForced 🔒 Boolean Indique si le reflet est forcé.
  isValorized 🔒   Indique si le reflet a reçu au moins une valeur du REDY.
  lastRefreshDate 🔒 String Obtient la date de fraîcheur du reflet.
  lastState 🔒   Dernier état brut reçu du serveur (utile pour lire les champs d’un reflet de type inconnu).
  mode   Mode de la ressource transmis par le REDY (auto, local, autoexception, autowarning…) ; isForced en est déduit.
  name 🔒 String Nom du reflet.
  nextCall 🔒   Date du prochain appel prévu (non renseigné avec un REDY).
  nodeId 🔒   Identifiant du nœud du reflet (non renseigné avec un REDY).
  note 🔒 String Obtient la note d’exploitation du reflet.
  path 🔒 String Chemin du reflet.
REDY
  pendingEventID 🔒 Number ou null ID REDY de l’évènement en cours du reflet.
REDY
  redyID 🔒 Number ID REDY du reflet.
REDY
  redyType   Type du reflet dans le REDY (ex. analog_Forced, HVACPump, setpoint_list), plus précis que type.
  smartLocalUnitId 🔒   Identifiant de l’unité locale du reflet (non renseigné avec un REDY).
  state 🔒 String Obtient l’état de la ressource.
  stateText 🔒 String Texte d’état du reflet, construit selon son type (peut contenir du HTML).
  status 🔒   Statut du reflet (non renseigné avec un REDY).
  tags 🔒   Tags du reflet (non renseigné avec un REDY).
  valueDate 🔒 String Obtient la date de valeur.
  witness 🔒 Boolean Obtient le témoin de la ressource.
  zoneID   Identifiant REDY de la zone de la ressource du reflet.

Méthodes

Méthode Renvoie Description
resetCommand()   Réinitialise l’objet de commande aux valeurs actuelles du reflet.

Commander un reflet

Un reflet est commandable quand son champ allowCommand est vrai. Sa commande se prépare dans son objet command, dont les champs (command.valueCmd…) dépendent du type de reflet, puis s’envoie avec la méthode commandReflect() du magasin REDY. resetCommand() remet l’objet de commande aux valeurs actuelles du reflet.

Types de reflet

Le type REDY d’un reflet est donné par son champ redyType. Seuls les champs propres au type sont listés ci-dessous.

Analogique

Reflet analogique : valeur numérique avec unité, décimales et bornes (avec seuils et valeur de forçage selon le type REDY).

Types REDY : analog, analog_thresholds (avec seuils), analog_Forced (avec seuils et forçage).

Libellé Studio Champ Type Description
  decimals 🔒 number Nombre de décimales de la valeur, défini dans le REDY.
  forcedValue 🔒 number Valeur de forçage (reflets forçables) ; se commande par command.valueForcedCmd.
  hasLimits 🔒 number Indique si le reflet a des bornes (min et max définis).
  isForcible 🔒 Boolean Indique si le reflet peut être forcé.
  isLinked 🔒 Boolean Indique si la valeur est liée (paramètre isLinked du REDY) : elle ne se commande alors pas directement (valueCmd n’est pas envoyé).
  max 🔒 number Borne maximale de la valeur ; null si le REDY donne 0 pour les deux bornes.
  min 🔒 number Borne minimale de la valeur ; null si le REDY donne 0 pour les deux bornes.
  unit 🔒 string Unité de la valeur (chaîne vide sans unité).
  value 🔒 number Valeur analogique du reflet ; se commande par command.valueCmd.
  withWitness 🔒 Boolean Indique si le reflet a des seuils témoins (witnessMin, witnessMax).
  witnessMax 🔒 number Seuil témoin maximal (reflets à seuils ou forçables) ; se commande par command.maxValueCmd.
  witnessMin 🔒 number Seuil témoin minimal (reflets à seuils ou forçables) ; se commande par command.minValueCmd.

Digital

Reflet digital : valeur logique vrai/faux avec ses textes « vrai » et « faux ».

Types REDY : digital, digital_Forced (forçable).

Libellé Studio Champ Type Description
  falseText 🔒 String Texte à afficher lorsque la valeur du reflet est false.
  forcedValue 🔒 Boolean Valeur de forçage (reflets forçables) ; se commande par command.valueForcedCmd.
  isForcible 🔒 Boolean Indique si le reflet peut être forcé.
  isLinked 🔒 Boolean Indique si la valeur est liée (paramètre isLinked du REDY) : elle ne se commande alors pas directement.
  text 🔒 String Obtient le texte correspondant à la valeur du reflet. Soit falseText, soit trueText.
  trueText 🔒 String Texte à afficher lorsque la valeur du reflet est true.
  value 🔒 Boolean Valeur logique du reflet ; se commande par command.valueCmd.

Texte

Reflet texte : valeur texte commandable.

Types REDY : text.

Libellé Studio Champ Type Description
  value 🔒 number Texte du reflet ; se commande par command.valueCmd.

État

Reflet d’état : seulement l’état de la ressource, sans valeur propre. Il n’est pas commandable.

Types REDY : state.

Tableau de consignes

Reflet de tableau de consignes : la consigne sélectionnée par son index dans une liste (libellé et valeur).

Types REDY : setpoint_list.

Libellé Studio Champ Type Description
  index   Index de la consigne sélectionnée, valeur de options ; se commande par command.indexCmd.
  options   Liste des consignes possibles (value : index, text : libellé, info : valeur).
  text 🔒   Libellé de la consigne sélectionnée.
  value 🔒   Valeur de la consigne sélectionnée (info de l’option), null sans correspondance.

Agenda

Reflet d’agenda : consignes précédente, actuelle et suivante. Il se commande par son mode forcé (modeForcedCmd) et son retour automatique (backToAutoCmd).

Types REDY : agenda, agenda_App.

Libellé Studio Champ Type Description
  autoIndex 🔒   Valeur de modeForced correspondant au mode automatique (première option de modeForcedOptions, 0 sinon).
  backToAuto   Indique si le retour automatique est actif (« Retour auto » / « Retour manuel ») ; se commande par command.backToAutoCmd.
  begin DateISOString Date de début de la consigne actuelle.
  firstIndex 🔒   Index de la première consigne de la liste (autoIndex + 1).
  index Number index de la consigne actuelle.
  modeForced   Mode forcé de l’agenda, valeur de modeForcedOptions ; vaut autoIndex en automatique. Se commande par command.modeForcedCmd.
  modeForcedOptions   Liste des modes forcés possibles (value, text, info).
  nextBegin DateISOString Date de début de la consigne suivante.
  nextIndex Number index de la consigne suivante.
  nextText 🔒 String Texte de la consigne suivante.
  nextValue 🔒 Number Valeur de la consigne suivante.
  options Array Liste des options de la consigne.
  previousBegin DateISOString Date de début de la consigne précédente.
  previousIndex Number index de la consigne précédente.
  previousText 🔒 String Texte de la consigne précédente.
  previousValue 🔒 Number Valeur de la consigne précédente.
  text 🔒 String Texte de la consigne actuelle.
  value 🔒 Number Valeur de la consigne actuelle.

PID

Reflet PID (régulation) : mesure, consigne, sortie en % et mode forcé (1 : automatique).

Types REDY : PID, PIDSVA.

Libellé Studio Champ Type Description
  consign 🔒   Texte de la sortie : outputText en automatique, sinon modeForcedText - outputText.
  decimals   Nombre de décimales de la sortie (0 par défaut).
  measure   Mesure de la régulation.
  modeForced   Mode forcé (1 : automatique), valeur de options ; se commande par command.modeForcedCmd.
  modeForcedText 🔒   Libellé du mode forcé (modeForced).
  options   Liste des modes forcés possibles (value, text, info).
  output   Sortie de la régulation (en %).
  outputText 🔒   Sortie formatée en pourcentage avec decimals décimales (ex. 42%).
  setPoint   Consigne de la régulation.

Courbe de chauffe

Reflet de courbe de chauffe (loi d’eau) : points de la courbe, décalage réduit, température extérieure, consigne calculée, mode en cours et mode forcé (1 : automatique).

Types REDY : HeatingCurve.

Libellé Studio Champ Type Description
  consignText 🔒   Texte (HTML, avec icônes) de la température extérieure et de la consigne calculée.
  coordCons   Points de la courbe au format du REDY (x;y séparés par |) ; se commande par command.coordConsCmd.
  fullText 🔒   Texte complet (HTML) : libellé du mode en cours suivi de la consigne (consignText) hors du mode 0.
  modeForced   Mode forcé (1 : automatique), valeur de modeForcedOptions ; se commande par command.modeForcedCmd.
  modeForcedOptions   Liste des modes forcés possibles (value, text, info).
  modeStatus   Mode en cours, valeur de modeStatusOptions ; son libellé est modeStatusText.
  modeStatusOptions   Liste des modes possibles pour modeStatus (value, text, info).
  modeStatusText 🔒   Libellé du mode en cours (modeStatus).
  outdoorTemp   Température extérieure (°C).
  points   Points de la courbe tirés de coordCons ({ x, y } : température extérieure, consigne), null pour un point non défini.
  redOffset   Décalage de consigne en mode réduit (°C) ; se commande par command.redOffsetCmd.
  reduced   Indique le fonctionnement en mode réduit (valeur reduced du REDY).
  setPoint   Consigne de température calculée (°C).
  stop   Indique l’arrêt (valeur stop du REDY) ; le mode n’est alors pas commandable.

Pompe

Reflet de pompe simple ou double : marche et défaut de chaque pompe, et mode manuel (0 : automatique).

Types REDY : HVACPump.

Libellé Studio Champ Type Description
  fault1   Indique si la pompe 1 est en défaut.
  fault2   Indique si la pompe 2 est en défaut (pompe double).
  isDual   Indique s’il s’agit d’une pompe double (run2 et fault2 ne sont renseignés que dans ce cas).
  isInFault 🔒   Indique si une des pompes est en défaut.
  isRunning 🔒   Indique si la pompe (ou une des deux pompes) est en marche.
  manual   Mode manuel (0 : automatique), valeur de manualOptions ; se commande par command.manualCmd.
  manualForcedText 🔒   Libellé du mode manuel (manual).
  manualOptions   Liste des modes manuels possibles (value, text, info).
  run1   Indique si la pompe 1 est en marche.
  run2   Indique si la pompe 2 est en marche (pompe double).
  runningText 🔒   Texte de marche traduit (ex. « Pompe 1 en marche », « En arrêt »).

Vanne

Reflet de vanne : état de marche, erreur (type, étape) et mode manuel (0 : automatique).

Types REDY : Valve.

Libellé Studio Champ Type Description
  errorStep 🔒 string Étape de l’erreur en cours (chaîne vide sans erreur).
  errorType 🔒 string Type de l’erreur en cours (chaîne vide sans erreur).
  manual 🔒 Number Mode manuel (0 : automatique), valeur de manualOptions ; se commande par command.manualCmd.
  manualOptions Array Liste des modes manuels possibles (value, text, info).
  manualText 🔒 String Libellé du mode manuel (manual).
  runID 🔒 number Code de l’état de marche de la vanne ; son libellé est runIDText.
  runIDOptions Array Liste des options de runID.
  runIDText 🔒 String Texte du runID.

Fil pilote

Reflet de fil pilote : mode en cours et mode forcé (-1 : pas de forçage), chacun avec son libellé.

Types REDY : FilPilote.

Libellé Studio Champ Type Description
  modeForced   Mode forcé (-1 : pas de forçage), valeur de modeForcedOptions ; se commande par command.modeForcedCmd.
  modeForcedOptions   Liste des modes forcés possibles (value, text, icon, info).
  modeStatus   Mode en cours du fil pilote, valeur de modeStatusOptions.
  modeStatusIcon 🔒   Icône du mode en cours (modeStatus), ? si inconnue.
  modeStatusOptions   Liste des modes possibles (value, text, icon, info).
  modeStatusText 🔒   Libellé du mode en cours (modeStatus).

Brûleur

Reflet de brûleur : état de marche, défaut, autorisation et erreur (type, étape). Non commandable.

Types REDY : Burner.

Libellé Studio Champ Type Description
  authorize 🔒 boolean Indique si le brûleur est autorisé à fonctionner (valeur authorize du REDY).
  errorStep 🔒 string Étape de l’erreur en cours (chaîne vide sans erreur).
  errorType 🔒 string Type de l’erreur en cours (chaîne vide sans erreur).
  faultReachSP 🔒 boolean Indique un défaut d’atteinte de la consigne (valeur faultReachSP du REDY).
  runID 🔒 number Code de l’état de marche du brûleur ; son libellé est runIDText.
  runIDOptions Array Liste des options de runID.
  runIDText 🔒 String Texte du runID.

Chaudière

Reflet de chaudière : état de marche, autorisation, erreur (type, étape) et mode forcé (0 : pas de forçage).

Types REDY : Boiler.

Libellé Studio Champ Type Description
  authorize 🔒 Boolean Indique si la chaudière est autorisée à fonctionner (valeur authorize du REDY).
  errorStep 🔒 string Étape de l’erreur en cours (chaîne vide sans erreur).
  errorType 🔒 string Type de l’erreur en cours (chaîne vide sans erreur).
  modeForced 🔒 number Mode forcé de la chaudière (0 : pas de forçage), valeur de modeForcedOptions ; se commande par command.modeForcedCmd.
  modeForcedOptions Array Liste des options de mode forcé.
  modeForcedText 🔒 String Texte du mode forcé.
  runID 🔒 number Code de l’état de marche de la chaudière ; son libellé est runIDText.
  runIDText 🔒 String Texte du runID.

Inconnu

Reflet d’un type non reconnu : pas de champ propre ; son texte d’état est construit à partir des valeurs brutes reçues.

Types REDY : tout type non reconnu.