Studio 1.6.0

Runtime 2.8.0

REDY 16.4.0

Acteur Reflet Ternaire

L’acteur Reflet Ternaire permet d’afficher un des trois états distincts en fonction d’un reflet. Tous les reflet sont supportés mais le digital est privilégié.

C’est la version avec reflet de l’acteur Ternaire.

  1. État Vrai : Lorsque la valeur est vraie
  2. État Faux : Lorsque la valeur est fausse
  3. État de Défaut : Lorsque le reflet est en défaut (cet état a la priorité sur les autres).

Nous retrouvons les mêmes possibilités de personnalisation que pour l’acteur Ternaire classique, avec la possibilité de configurer une LED ou une image et un comportement de clignotement spécifique pour chaque état. Seule la propriété texte n’est pas personnalisable car elle est directement issue du reflet.

Sommaire

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

Propriétés

Ces propriétés contrôlent l’état global de l’acteur.

Auto rafraîchi?

this.properties.autoRefresh · boolean · défaut true

Active/désactive le rafraîchissement automatique de la donnée.

Indique si l’acteur doit automatiquement rafraîchir les données du reflet à intervalles réguliers.

Autonome?

this.properties.isAutonomous · boolean · défaut true

Indique si l’acteur fonctionne de manière autonome, sans nécessiter d’acteur requêteur.

Clignotant en défaut?

this.properties.isBlinkingFault · boolean · défaut true

Si true, la LED ou l’image de cet état se mettra à clignoter.

Clignotant faux?

this.properties.isBlinkingFalse · boolean · défaut false

Si true, la LED ou l’image de cet état se mettra à clignoter.

Clignotant vrai?

this.properties.isBlinkingTrue · boolean · défaut false

Si true, la LED ou l’image de cet état se mettra à clignoter.

Couleur LED en défaut

this.properties.ledColorFault · string · défaut '#ff1500'

La couleur de la LED pour cet état (ex: #00FF00, #FF5733).

Les couleurs CSS par mot-clé telles que red, green, etc., ne sont pas prises en charge.

Couleur LED faux

this.properties.ledColorFalse · string · défaut '#00ff5b'

La couleur de la LED pour cet état (ex: #00FF00, #FF5733).

Les couleurs CSS par mot-clé telles que red, green, etc., ne sont pas prises en charge.

Couleur LED vrai

this.properties.ledColorTrue · string · défaut '#00ff5b'

La couleur de la LED pour cet état (ex: #00FF00, #FF5733).

Les couleurs CSS par mot-clé telles que red, green, etc., ne sont pas prises en charge.

Délai

this.properties.autoRefreshDelay · number · défaut 30

Délai de rafraîchissement automatique de la donnée.

Le délai en secondes entre chaque rafraîchissement automatique des données du reflet.

Détails de reflet au clic

this.properties.withDetails · 'none' | 'top' | 'bottom' | 'left' | 'right' · défaut 'none'

Affiche le détail du reflet dans une modale au clic sur l’acteur, ouverte du côté indiqué (top, bottom, left ou right) ; none : pas de modale. Lorsque le reflet est commandable, ses commandes sont aussi disponibles dans la modale.

Permet d’ouvrir une modale avec le détail du reflet lorsque l’utilisateur clique sur l’acteur, si le reflet est commandable la modale proposera sa commande.

Image personnalisée en défaut

this.properties.pictureFault · any · défaut null · modifie : Gabarit

Permet de remplacer la LED par une image.

Image personnalisée faux

this.properties.pictureFalse · any · défaut null · modifie : Gabarit

Permet de remplacer la LED par une image.

Image personnalisée vrai

this.properties.pictureTrue · any · défaut null · modifie : Gabarit

Permet de remplacer la LED par une image.

LED en défaut allumée?

this.properties.ledIsOnFault · boolean · défaut true

Contrôle si la LED est allumée (true) ou éteinte (false) pour cet état.

LED faux allumée?

this.properties.ledIsOnFalse · boolean · défaut false

Contrôle si la LED est allumée (true) ou éteinte (false) pour cet état.

LED vrai allumée?

this.properties.ledIsOnTrue · boolean · défaut true

Contrôle si la LED est allumée (true) ou éteinte (false) pour cet état.

Reflet

this.properties.reflectPath · string · défaut ''

Le chemin vers le reflet REDY que cet acteur doit afficher.

Requêteur

this.properties.requesterKey · string · défaut ''

La clé de l’acteur requêteur responsable de la communication avec le REDY. Nécessaire si isAutonomous est désactivé (false).

Texte à afficher

this.properties.displayText · boolean · défaut true

Permet d’activer (true) ou de désactiver (false) l’affichage du texte pour l’état actuellement visible.

Informations

Accessibles par script, via this dans un script de l’acteur ou context.getActor('clé') depuis un autre acteur.

autoRefreshing

this.autoRefreshing · 🔒 lecture seule · Boolean

Indique si le rafraîchissement automatique est actif.

data

this.data

Donnée reçue par la dernière requête.

error

this.error · 🔒 lecture seule · String ou null

Erreur de requête.

fullPath

this.fullPath · 🔒 lecture seule

Obtient le chemin complet vers le reflet.

hasError

this.hasError · 🔒 lecture seule · Boolean

Indique s’il y a eu une erreur de requête.

isRequesting

this.isRequesting · 🔒 lecture seule · Boolean

Indique si la requête est en cours.

isValorized

this.isValorized · 🔒 lecture seule

Indique si la donnée a été valorisée.

lastRequestDate

this.lastRequestDate · 🔒 lecture seule · String ou null

Date de la dernière requête (ISO 8601), null avant la première.

reflect

this.reflect

Obtient le reflet chargé (alias en lecture seule de data).

reflectPath

this.reflectPath · 🔒 lecture seule

Obtient le chemin du reflet relatif au requêteur source (properties.reflectPath).

requesterSource

this.requesterSource

Obtient le requêteur de reflet source.

value

this.value · 🔒 lecture seule

État vrai/faux affiché, déduit du reflet selon son type : en marche (chaudière, vanne, brûleur, pompe), valeur ou valeur forcée (digital, analogique non nulle), sortie ou mode forcé (PID), mode autre que 3 (fil pilote) ; false sans reflet.

Méthodes

refresh()

this.refresh()

Effectue un rafraîchissement de la donnée.

request()

this.request()

Effectue une requête : celle de l’acteur s’il est autonome, sinon celle de son requêteur de reflet.

requestDebounce()

this.requestDebounce() · renvoie Promise<any>

Effectue une requête retardée : celle de l’acteur s’il est autonome, sinon celle de son requêteur de reflet.

Événements

Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.

onDidReflectChange

Se produit lorsque l’acteur reçoit un reflet alors qu’il n’en avait pas encore (premier chargement, ou après une requête sans reflet) ; les mises à jour suivantes du même reflet ne le déclenchent pas.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
reflect Object ou null Le reflet reçu (null si la requête n’en a pas trouvé)

onRequestDone

Se produit lorsque la requête s’est terminée.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
error String ou Object ou null Une erreur éventuelle
data any La donnée

Hérite de

Outre ce qui est décrit ici, l’acteur a tout ce que décrit l’acteur de base : propriétés communes (taille, disposition, aspect, texte, bordures, effets…), évènements communs (cycle de vie, souris, clavier…) et membres accessibles par script.

Il hérite aussi de :

  • BaseRequest : Acteur de base pour un acteur alimenté par requête.
  • Requesterable (comportement) : Attribut la possibilité à un acteur de réaliser des requêtes.