19. Référence de l'API de haut niveau
19.2. Interface de contrôle du module
Cette interface est la même pour tous les modules USB de Yoctopuce. Elle permet de contrôler les
paramètres généraux du module, et d'énumérer les fonctions fournies par chaque module.
Pour utiliser les fonctions décrites ici, vous devez inclure:
<script type='text/javascript' src='yocto_api.js'></script>
js
var yoctolib = require('yoctolib');
nodejs
var YAPI = yoctolib.YAPI;
var YModule = yoctolib.YModule;
require_once('yocto_api.php');
php
#include "yocto_api.h"
cpp
#import "yocto_api.h"
m
uses yocto_api;
pas
yocto_api.vb
vb
yocto_api.cs
cs
import com.yoctopuce.YoctoAPI.YModule;
java
from yocto_api import *
py
yFindModule(func)
Permet de retrouver un module d'après son numéro de série ou son nom logique.
yFirstModule()
Commence l'énumération des modules accessibles par la librairie.
module→checkFirmware(path, onlynew)
Test si le fichié byn est valid pour le module.
module→describe()
Retourne un court texte décrivant le module.
module→download(pathname)
Télécharge le fichier choisi du module et retourne son contenu.
module→functionCount()
Retourne le nombre de fonctions (sans compter l'interface "module") existant sur le module.
module→functionId(functionIndex)
Retourne l'identifiant matériel de la nième fonction du module.
module→functionName(functionIndex)
Retourne le nom logique de la nième fonction du module.
module→functionValue(functionIndex)
Retourne la valeur publiée par la nième fonction du module.
module→get_allSettings()
Retourne tous les paramètres du module.
module→get_beacon()
Retourne l'état de la balise de localisation.
module→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.
module→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.
module→get_firmwareRelease()
136
Fonction globales
Méthodes des objets
YModule
www.yoctopuce.com