21. Référence de l'API de haut niveau
21.1. Fonctions générales
Ces quelques fonctions générales permettent l'initialisation et la configuration de la librairie Yoctopuce.
Dans la plupart des cas, un appel à
pourrez appeler la fonction globale
pour pouvoir interagir avec lui.
Pour utiliser les fonctions décrites ici, vous devez inclure:
<script type='text/javascript' src='yocto_api.js'></script>
js
#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
import com.yoctopuce.YoctoAPI.YModule;
uwp
from yocto_api import *
py
require_once('yocto_api.php');
php
in HTML: <script src="../../lib/yocto_api.js"></script>
es
in node.js: require('yoctolib-es2017/yocto_api.js');
yCheckLogicalName(name)
Vérifie si un nom donné est valide comme nom logique pour un module ou une fonction.
yClearHTTPCallbackCacheDir(bool_removeFiles)
Désactive le cache de callback HTTP.
yDisableExceptions()
Désactive l'utilisation d'exceptions pour la gestion des erreurs.
yEnableExceptions()
Réactive l'utilisation d'exceptions pour la gestion des erreurs.
yEnableUSBHost(osContext)
Cette fonction est utilisée uniquement sous Android.
yFreeAPI()
Libère la mémoire dynamique utilisée par la librairie Yoctopuce.
yGetAPIVersion()
Retourne la version de la librairie Yoctopuce utilisée.
yGetCacheValidity()
Retourne la durée de validité des données chargée par la libraire.
yGetDeviceListValidity()
Retourne le délais entre chaque énumération forcée des YoctoHub utilisés.
yGetTickCount()
Retourne la valeur du compteur monotone de temps (en millisecondes).
yHandleEvents(errmsg)
Maintient la communication de la librairie avec les modules Yoctopuce.
yInitAPI(mode, errmsg)
Initialise la librairie de programmation de Yoctopuce explicitement.
yPreregisterHub(url, errmsg)
150
yRegisterHub()
ou
yFind...()
yFirst...()
Fonction globales
suffira en tout et pour tout. Ensuite, vous
correspondant à votre module
www.yoctopuce.com