24. Référence de l'API de haut niveau
Identifiant global de la fonction au format
refframe→FunctionId [lecture seule]
Identifiant matériel du référentiel, sans référence au module.
refframe→FusionMode [modifiable]
Mode de fonctionnement du capteur.
refframe→HardwareId [lecture seule]
Identifiant matériel unique de la fonction au format
refframe→IsOnline [lecture seule]
Vérifie si le module hébergeant la fonction est joignable, sans déclencher d'erreur.
refframe→LogicalName [modifiable]
Nom logique de la fonction.
refframe→SerialNumber [lecture seule]
Numéro de série du module, préprogrammé en usine.
refframe→cancel3DCalibration()
Annule la calibration tridimensionnelle en cours, et rétabli les réglages normaux.
refframe→clearCache()
Invalide le cache.
refframe→describe()
Retourne un court texte décrivant de manière non-ambigüe l'instance du référentiel au format
TYPE(NAME)=SERIAL.FUNCTIONID
refframe→get_3DCalibrationHint()
Retourne les instructions à suivre pour procéder à la calibration tridimensionnelle initiée avec la méthode
start3DCalibration
refframe→get_3DCalibrationLogMsg()
Retourne le dernier message de log produit par le processus de calibration.
refframe→get_3DCalibrationProgress()
Retourne l'avancement global du processus de calibration tridimensionnelle initié avec la méthode
start3DCalibration
refframe→get_3DCalibrationStage()
Retourne l'index de l'étape courante de la calibration initiée avec la méthode
refframe→get_3DCalibrationStageProgress()
Retourne l'avancement de l'étape courante de la calibration initiée avec la méthode
start3DCalibration
refframe→get_advertisedValue()
Retourne la valeur courante du référentiel (pas plus de 6 caractères).
refframe→get_bearing()
Retourne le cap de référence utilisé par le compas.
refframe→get_calibrationState()
Retourne l'état de calibration des capteurs 3D (Yocto-3D-V2 seulement).
refframe→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du référentiel.
refframe→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du référentiel.
refframe→get_friendlyName()
456
NOM_MODULE.NOM_FONCTION
SERIAL.FUNCTIONID
Méthodes des objets
.
.
.
.
.
.
YRefFrame
start3DCalibration
.
www.yoctopuce.com