Sommaire

Magasin REDY

📖 Concept : Magasin de donnée

Le magasin de donnée du REDY auquel la synapp est connectée, accessible par context.dataStores.redy. Il charge les variables WOS, les reflets, les évènements et les curseurs du REDY, et leur envoie les écritures et les commandes. Les objets qu’il renvoie sont décrits dans les modèles de données.

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

Informations

host

context.dataStores.redy.host · 🔒 lecture seule

Obtient l’hôte.

session

context.dataStores.redy.session · 🔒 lecture seule

Obtient la session.

Méthodes

ackEvent(event)

context.dataStores.redy.ackEvent(event) · renvoie Promise<WosEvent>

Acquitte l’évènement WOS donné (avec sa consigne todo si renseignée) et le renvoie mis à jour.

  • event : Évènement WOS à acquitter (obtenu par loadWosEvents).

childrenOfVariable(variable)

context.dataStores.redy.childrenOfVariable(variable) · renvoie Array.<REDY.Synapps.WosVariable>

Renvoie les enfants déjà chargés de la variable donnée.

  • variable : Variable WOS parente.

commandReflect(reflect, withRefreshAfter?)

context.dataStores.redy.commandReflect(reflect, withRefreshAfter?) · renvoie Promise<ReflectBase>

Envoie au REDY la commande (command) du reflet donné, puis, par défaut (withRefreshAfter), recharge sa valeur ; échoue si le reflet n’est pas commandable.

  • reflect : Reflet à commander, sa commande renseignée dans command.
  • withRefreshAfter : Recharge la valeur du reflet après un court délai.

findWosVariable(path)

context.dataStores.redy.findWosVariable(path) · renvoie Promise<REDY.Synapps.WosVariable>

Renvoie la variable si elle est déjà chargée, sinon la charge depuis le REDY (comme loadWosVariable, sans options).

  • path : Chemin de la variable (ex. :easy.Zone).

findWosVariableByID(ID)

context.dataStores.redy.findWosVariableByID(ID) · renvoie Promise<REDY.Synapps.WosVariable>

Renvoie la variable de cet identifiant si elle est déjà chargée, sinon la charge depuis le REDY (comme loadWosVariableByID, sans options).

  • id : Identifiant REDY de la variable.

getClasses(params?)

context.dataStores.redy.getClasses(params?) · renvoie Promise<Array.<Object>>

Charge la liste des classes WOS.

  • params : Filtres.
  • params.classIds : Identifiants des classes voulues ; toutes les classes si vide.
  • params.disabled : Filtre sur l’état désactivé des classes.

getCursor(label)

context.dataStores.redy.getCursor(label) · renvoie Promise<Object>

Charge la définition du curseur REDY de ce libellé.

  • label : Libellé du curseur.

getReflect(path)

context.dataStores.redy.getReflect(path) · renvoie ReflectBase ou null

Renvoie le reflet déjà chargé de ce chemin, sans le charger.

  • path : Chemin du reflet.

getReflectByRedyID(redyID)

context.dataStores.redy.getReflectByRedyID(redyID) · renvoie ReflectBase ou null

Renvoie le reflet déjà chargé de cet identifiant REDY, sans le charger.

  • redyID : Identifiant REDY du reflet.

getWosVariable(path)

context.dataStores.redy.getWosVariable(path) · renvoie REDY.Synapps.WosVariable ou null

Renvoie la variable déjà chargée de ce chemin, sans la charger : null si elle ne l’est pas.

  • path : Chemin de la variable (ex. :easy.Zone).

getWosVariableByredyID(redyID)

context.dataStores.redy.getWosVariableByredyID(redyID) · renvoie REDY.Synapps.WosVariable ou null

Cherche une variable déjà chargée par son identifiant REDY, sans la charger.

  • redyID : Identifiant REDY de la variable.

loadCursors()

context.dataStores.redy.loadCursors() · renvoie Promise<Array.<Object>>

Charge la liste des curseurs définis dans le REDY.

loadWebFileBase64(path)

context.dataStores.redy.loadWebFileBase64(path) · renvoie Promise<string>

Charge un fichier web du REDY et renvoie son contenu encodé en base64.

  • path : Chemin du fichier sur le REDY, commençant par / (relatif à l’adresse du REDY).

loadWosEvents(params)

context.dataStores.redy.loadWosEvents(params) · renvoie Promise<Object>

Recherche des évènements WOS (filtres par origine, site, dates, groupes, équipement, zone, ensemble, acquittement, pagination) et renvoie { count, events }.

  • params : Critères de recherche.
  • params.originPath : Chemin de la variable à l’origine des évènements.
  • params.originID : Identifiant REDY de la variable à l’origine des évènements.
  • params.sitePath : Chemin du site.
  • params.dateMin : Date de début, au format ISO 8601 (ex. moment().subtract(1, 'day').toISOString()).
  • params.dateMax : Date de fin, au format ISO 8601.
  • params.sortedField : Champ de tri (d : date).
  • params.isSortAscending : Tri croissant ; par défaut, les plus récents d’abord.
  • params.groups : Groupes : leurs noms (sous :System.Attribute.Group) ou leurs identifiants REDY ; les groupes introuvables sont ignorés (aucun résultat si aucun n’est trouvé).
  • params.equipment : Équipement : son nom (sous :System.Attribute.Equipment) ou son identifiant REDY. Équipement introuvable : aucun résultat.
  • params.zone : Zone : son nom (sous :System.Attribute.Zone) ou son identifiant REDY. Zone introuvable : aucun résultat.
  • params.collection : Ensemble : son nom (sous :easy.Set) ou son identifiant REDY. Ensemble introuvable : aucun résultat.
  • params.pendingOnly : Seulement les évènements en cours.
  • params.ack : Acquittement : 0 tous, 1 non acquittés, 2 acquittés.
  • params.take : Nombre maximal de résultats (taille de la page).
  • params.skip : Nombre de résultats à sauter (début de la page).

loadWosVariable(path, options?)

context.dataStores.redy.loadWosVariable(path, options?) · renvoie Promise<REDY.Synapps.WosVariable>

Charge une variable depuis le REDY (avec ses sous-variables subPaths si demandé) et la renvoie.

  • path : Chemin de la variable (ex. :easy.Zone).
  • options : Options du chargement.
  • options.subPaths : Chemins complets de sous-variables (descendantes de path, ex. :easy.Zone.Temperature) à charger dans la même requête ; * remplace un libellé entier (ex. :easy.Zone.*.Temperature). S’il y en a, seules ces sous-variables sont chargées en plus de la variable, quel que soit leur niveau ; sinon, ses enfants directs le sont aussi.
  • options.withBlob : Charge aussi les valeurs binaires (blob), renvoyées encodées en base64 (à décoder avec atob).

loadWosVariableByID(id, options?)

context.dataStores.redy.loadWosVariableByID(id, options?) · renvoie Promise<REDY.Synapps.WosVariable>

Charge une variable depuis le REDY par son identifiant et la renvoie.

  • id : Identifiant REDY de la variable.
  • options : Options du chargement.
  • options.subPaths : Chemins de sous-variables, RELATIFS à la variable (ex. Temperature, Salon.Temperature ou *.Temperature, * remplaçant un libellé entier), à charger dans la même requête. S’il y en a, seules ces sous-variables sont chargées en plus de la variable ; sinon, ses enfants directs le sont aussi.
  • options.withBlob : Charge aussi les valeurs binaires (blob), renvoyées encodées en base64 (à décoder avec atob).

loadWosVariableChildren(path, queryDepth?)

context.dataStores.redy.loadWosVariableChildren(path, queryDepth?) · renvoie Promise<REDY.Synapps.WosVariable>

Charge une variable et ses descendants (3 niveaux par défaut) et renvoie la variable.

  • path : Chemin de la variable (ex. :easy.Zone).
  • queryDepth : Profondeur chargée : 0 tous les descendants, 1 les champs, 2 les champs et leurs propriétés, 3 champs et propriétés avec leurs enfants, etc.

logout()

context.dataStores.redy.logout()

Déconnecte la session puis affiche la page de déconnexion.

refreshWosVariable(path, options?)

context.dataStores.redy.refreshWosVariable(path, options?) · renvoie Promise<REDY.Synapps.WosVariable>

Recharge les valeurs d’une variable déjà chargée et la renvoie ; échoue si elle n’est pas chargée.

  • path : Chemin de la variable (ex. :easy.Zone).
  • options : Options du rechargement.
  • options.subPaths : Chemins complets de sous-variables (descendantes de path, ex. :easy.Zone.Temperature) à recharger dans la même requête ; * remplace un libellé entier (ex. :easy.Zone.*.Temperature). S’il y en a, seules ces sous-variables sont rechargées en plus de la variable, quel que soit leur niveau ; sinon, ses enfants directs le sont aussi.
  • options.withBlob : Recharge aussi les valeurs binaires (blob), renvoyées encodées en base64 (à décoder avec atob).

refreshWosVariableChildren(path, queryDepth?)

context.dataStores.redy.refreshWosVariableChildren(path, queryDepth?) · renvoie Promise<REDY.Synapps.WosVariable>

Recharge les valeurs d’une variable et de ses descendants et renvoie la variable.

  • path : Chemin de la variable (ex. :easy.Zone).
  • queryDepth : Profondeur rechargée : 0 tous les descendants, 1 les champs, 2 les champs et leurs propriétés, 3 champs et propriétés avec leurs enfants, etc.

runCursorInstruction(params)

context.dataStores.redy.runCursorInstruction(params) · renvoie Promise<Object>

Exécute un curseur d’instruction avec ses paramètres et renvoie le résultat.

  • params : Exécution.
  • params.label : Libellé du curseur.
  • params.parameters : Valeurs des paramètres du curseur, par nom.

runCursorRequest(params)

context.dataStores.redy.runCursorRequest(params) · renvoie Promise<Object>

Exécute un curseur de requête avec ses paramètres et sa pagination (limit, offset) et renvoie le résultat.

  • params : Exécution.
  • params.label : Libellé du curseur.
  • params.parameters : Valeurs des paramètres du curseur, par nom.
  • params.limit : Nombre maximal de lignes (taille de la page).
  • params.offset : Nombre de lignes à sauter (début de la page).

searchReflectEvents(params)

context.dataStores.redy.searchReflectEvents(params) · renvoie Promise<Object>

Recherche des évènements de reflets (filtres par reflet, dates, texte, type, groupes, équipement, zone, ensemble, pagination) et renvoie { count, events }.

  • params : Critères de recherche.
  • params.reflectPath : Chemin du reflet (ex. :easy.RESS.Chaudiere).
  • params.dateFrom : Date de début.
  • params.dateTo : Date de fin.
  • params.searchText : Filtre sur le nom des reflets.
  • params.reflectType : Type de reflet (ex. analog, digital, state, agenda).
  • params.isSortAscending : Tri croissant ; par défaut, les plus récents d’abord.
  • params.groups : Groupes : leurs noms (sous :System.Attribute.Group) ; les groupes introuvables sont ignorés (aucun résultat si aucun n’est trouvé).
  • params.equipment : Équipement : son nom (sous :System.Attribute.Equipment). Équipement introuvable : aucun résultat.
  • params.zone : Zone : son nom (sous :System.Attribute.Zone). Zone introuvable : aucun résultat.
  • params.collection : Ensemble : son nom (sous :easy.Set). Ensemble introuvable : aucun résultat.
  • params.pendingOnly : Seulement les évènements en cours.
  • params.take : Nombre maximal de résultats (taille de la page).
  • params.skip : Nombre de résultats à sauter (début de la page).

searchReflects(params)

context.dataStores.redy.searchReflects(params) · renvoie Promise<Object>

Recherche des reflets (filtres par identifiants, texte, type, zone, ensemble, pagination) et renvoie { count, reflects }.

  • params : Critères de recherche.
  • params.ids : Identifiants REDY des reflets.
  • params.searchText : Filtre sur le nom des reflets.
  • params.reflectType : Type de reflet (ex. analog, digital, state, agenda).
  • params.zone : Zone : son nom (sous :System.Attribute.Zone). Zone introuvable : aucun résultat.
  • params.collection : Ensemble : son nom (sous :easy.Set). Ensemble introuvable : aucun résultat.
  • params.pendingOnly : Seulement les reflets ayant un évènement en cours.
  • params.take : Nombre maximal de résultats (taille de la page).
  • params.skip : Nombre de résultats à sauter (début de la page).

searchReflectValues(params)

context.dataStores.redy.searchReflectValues(params) · renvoie Promise<Object>

Charge les valeurs des reflets correspondant aux filtres (identifiants, texte, type, zone, ensemble, pagination) et renvoie { count, reflects }.

  • params : Critères de recherche.
  • params.ids : Identifiants REDY des reflets.
  • params.searchText : Filtre sur le nom des reflets.
  • params.reflectType : Type de reflet (ex. analog, digital, state, agenda).
  • params.zone : Zone : son nom (sous :System.Attribute.Zone). Zone introuvable : aucun résultat.
  • params.collection : Ensemble : son nom (sous :easy.Set). Ensemble introuvable : aucun résultat.
  • params.pendingOnly : Seulement les reflets ayant un évènement en cours.
  • params.take : Nombre maximal de résultats (taille de la page).
  • params.skip : Nombre de résultats à sauter (début de la page).

searchRessources(params)

context.dataStores.redy.searchRessources(params) · renvoie Promise<Object>

Recherche des ressources (variables de classe ressource) sous un chemin et renvoie { count, variables }.

  • params : Critères de recherche.
  • params.path : Chemin sous lequel chercher (ex. :easy.RESS).
  • params.name : Seulement les variables dont le nom contient ce texte (sans tenir compte de la casse).
  • params.isClasses : Identifiants de classes WOS, ajoutés à la classe ressource (62) : seulement les variables de ces classes ou de classes qui en héritent.
  • params.matchClasses : Identifiants de classes WOS : seulement les variables de ces classes exactement (sans héritage).
  • params.collection : Ensemble : son nom (sous :easy.Set) ou son identifiant REDY. Ensemble introuvable : aucun résultat.
  • params.take : Nombre maximal de résultats (taille de la page).
  • params.skip : Nombre de résultats à sauter (début de la page).

searchWosVariables(params)

context.dataStores.redy.searchWosVariables(params) · renvoie Promise<Object>

Recherche des variables WOS sous un chemin (filtres par nom, classes, ensemble, profondeur, pagination) et renvoie { count, variables }.

  • params : Critères de recherche.
  • params.path : Chemin sous lequel chercher (ex. :easy.RESS).
  • params.name : Seulement les variables dont le nom contient ce texte (sans tenir compte de la casse).
  • params.isClasses : Identifiants de classes WOS : seulement les variables de ces classes ou de classes qui en héritent.
  • params.matchClasses : Identifiants de classes WOS : seulement les variables de ces classes exactement (sans héritage).
  • params.collection : Ensemble : son nom (sous :easy.Set) ou son identifiant REDY. Ensemble introuvable : aucun résultat.
  • params.depth : Profondeur de la structure chargée pour chaque variable trouvée : 0 tous ses descendants, 1 ses champs, 2 ses champs et leurs propriétés, 3 ses champs et propriétés avec leurs enfants, etc.
  • params.take : Nombre maximal de résultats (taille de la page).
  • params.skip : Nombre de résultats à sauter (début de la page).

writeWosVariableValue(path, params?)

context.dataStores.redy.writeWosVariableValue(path, params?) · renvoie Promise<REDY.Synapps.WosVariable>

Écrit dans le REDY la valeur courante (value) d’une variable déjà chargée ; échoue si l’utilisateur ne peut pas l’écrire.

  • path : Chemin de la variable (ex. :easy.Zone.Consigne).
  • params : Options de l’écriture.
  • params.withBlob : La valeur est binaire (blob) : elle est envoyée encodée en base64.
  • params.withoutReturnValue : Le REDY ne renvoie pas la valeur écrite : value n’est pas mise à jour avec la valeur réellement enregistrée.