24. Référence de l'API de haut niveau
24.1. La classe YAPI
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:
import com.yoctopuce.YoctoAPI.YAPI;
java
import YoctoProxyAPI.YAPIProxy
dnp
#include "yocto_api_proxy.h"
cp
import YoctoProxyAPI.YAPIProxy"
ml
<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;
uwp
from yocto_api import *
py
require_once('yocto_api.php');
php
in HTML: import { YAPI, YErrorMsg, YModule, YSensor } from '../../dist/esm/yocto_api_browser.js';
ts
in Node.js: import { YAPI, YErrorMsg, YModule, YSensor } from 'yoctolib-cjs/yocto_api_nodejs.js';
in HTML: <script src="../../lib/yocto_api.js"></script>
es
in node.js: require('yoctolib-es2017/yocto_api.js');
YModule.vi
vi
YAPI.CheckLogicalName(name)
Vérifie si un nom donné est valide comme nom logique pour un module ou une fonction.
YAPI.ClearHTTPCallbackCacheDir(bool_removeFiles)
Désactive le cache de callback HTTP.
YAPI.DisableExceptions()
Désactive l'utilisation d'exceptions pour la gestion des erreurs.
YAPI.EnableExceptions()
Réactive l'utilisation d'exceptions pour la gestion des erreurs.
YAPI.EnableUSBHost(osContext)
Cette fonction est utilisée uniquement sous Android.
YAPI.FreeAPI()
Attends que toutes les communications en cours avec les modules Yoctopuce soient terminées puis libère les
ressources utilisées par la librairie Yoctopuce.
YAPI.GetAPIVersion()
Retourne la version de la librairie Yoctopuce utilisée.
YAPI.GetCacheValidity()
Retourne la durée de validité des données chargée par la libraire.
YAPI.GetDeviceListValidity()
184
yRegisterHub()
ou
yFind...()
yFirst...()
Fonction globales
suffira en tout et pour tout. Ensuite, vous
correspondant à votre module
www.yoctopuce.com