Yoctolib Cs FR

Rfrence de l'API C# .
NET
Table des matires

Introduction Utilisation du YoctoDemo en C#
Installation Utilisation l'API yoctopuce dans un projet $LANG$ Contrle de la fonction Led Contrle de la partie module Gestion des erreurs 3 4 4 4 5 6 9 10 10 16 26 35 43 52 61 63 66 74 81 90 97 106 117 130 139 147 155 164 173 182 190
Reference
Fonctions gnrales Interface de la fonction AnButton Interface de la fonction CarbonDioxide Interface de la fonction ColorLed Interface de la fonction Current Interface de la fonction DataLogger Squence de donnes mise en forme Squence de donnes enregistres Interface de contrle de l'alimentation Interface d'un port de Yocto-hub Interface de la fonction Humidity Interface de la fonction Led Interface de la fonction LightSensor Interface de contrle du module Interface de la fonction Network Interface de la fonction Pressure Interface de la fonction Relay Interface de la fonction Servo Interface de la fonction Temperature Interface de la fonction Voltage Interface de la fonction Source de tension Interface de la fonction Wireless
Index
www.yoctopuce.com
1. Introduction
Ce manuel est votre rfrence pour l'utilisation de la librairie C# .NET de Yoctopuce pour interfacer vos senseurs et contrleurs USB. Le chapitre suivant reprend un chapitre du manuel du module USB gratuit YoctoDemo, afin d'illustrer l'utilisation de la librairie sur des exemples concrets. Le reste du manuel documente chaque fonction, classe et mthode de l'API. La premire section dcrit les fonctions globales d'ordre gnral, et les sections dcrivent les diffrentes classes, utiles selon le module Yoctopuce utilis. Pour plus d'informations sur la signification et l'utilisation d'un attribut particulier d'un module, il est recommand de se rfrer la documentation spcifique du module, qui contient plus de dtails.
www.yoctopuce.com
2. Utilisation du YoctoDemo en C#
C# (prononcez C-Sharp) est un langage orient objet promu par Microsoft qui n'est pas sans rappeller Java. Tout comme Visual Basic et Delphi, il permet de crer des applications Windows relativement facilement. Tous les exemples et les modles de projet sont tests avec Microsoft C# 2010 Express, disponible gratuitement sur le site de Microsoft 1.
2.1. Installation
Tlchargez la librairie Yoctopuce pour $LANG$ depuis le site web de Yoctopuce2. Il n'y a pas de programme d'installation, copiez simplement de contenu du fichier zip dans le rpertoire de votre choix. Vous avez besoin essentiellement du contenu du rpertoire Sources. Les autres rpertoires contiennent la documentation et quelques programmes d'exemple. Les projets d'exemple sont des projets $LANG$ 2010, si vous utilisez une version antrieure, il est possible que vous ayez reconstruire la structure de ces projets.
2.2. Utilisation l'API yoctopuce dans un projet $LANG$

La librairie Yoctopuce pour $LANG$ .NET se prsente sous la forme d'une DLL et de fichiers sources en $LANG$. La DLL n'est pas une DLL .NET mais une DLL classique, crite en C, qui gre les communications bas niveau avec les modules3. Les fichiers sources en $LANG$ grent la partie haut niveau de l'API. Vous avez donc besoin de cette DLL et des fichiers . $EXT$ du rpertoire Sources pour crer un projet grant des modules Yoctopuce.
Configuration d'un projet $LANG$

Les indications ci-dessous sont fournies pour Visual Studio express 2010, mais la procdure est semblable pour les autres versions. Commencez par crer votre projet, puis depuis le panneau Explorateur de solutions effectuez un clic droit sur votre projet, et choisissez Ajouter puis Elment existant. Une fentre de slection de fichiers apparat: slectionnez le fichier yocto_api.$EXT$ et les fichiers correspondant aux fonctions des modules Yoctopuce que votre projet va grer. Dans le doute, vous pouvez aussi slectionner tous les fichiers. Vous avez alors le choix entre simplement ajouter ces fichiers votre projet, ou les ajouter en tant que lien (le bouton Ajouter est en fait un menu droulant). Dans le premier cas, Visual Studio va copier les fichiers choisis dans votre projet, dans le second Visual Studio va simplement garder un lien sur les fichiers originaux. Il est recommand d'utiliser des liens, une ventuelle mise jour de la librairie sera ainsi beaucoup plus facile.
1 http://www.microsoft.com/visualstudio/en-us/products/2010-editions/visual-csharp-express 2 www.yoctopuce.com/FR/libraries.php 3 Les sources de cette DLL sont disponibles dans l'API C++
www.yoctopuce.com
Ensuite, ajoutez de la mme manire la dll yapi.dll, qui se trouve dans le rpertoire Sources/dll4. Puis depuis la fentre Explorateur de solutions, effectuez un clic droit sur la DLL, choisissez Proprit et dans le panneau Proprits, mettez l'option Copier dans le rpertoire de sortie toujours copier. Vous tes maintenant prt utiliser vos modules Yoctopuce depuis votre environnement Visual Studio. Afin de les garder simples, tous les exemples fournis dans cette documentation sont des applications consoles. Il va de soit que que les fonctionnement des librairies est strictement identiques si vous les intgrez dans une application dote d'une interface graphique.
2.3. Contrle de la fonction Led

Il suffit de quelques lignes de code pour piloter un YoctoDemo. Voici le squelette d'un fragment de code C# qui utilise la fonction Led.
[...] string errmsg = ""; YLed led; // On rcupre l'objet reprsentant le module (ici connect en local sur USB) YAPI.RegisterHub("usb", errmsg); led = YLed.FindLed("YCTOPOC1-123456.led"); // Pour grer le hot-plug, on vrifie que le module est l if (led.isOnline()) { // Utiliser led.set_power(): ... }
Voyons maintenant en dtail ce que font ces quelques lignes.
YAPI.RegisterHub
La fonction YAPI.RegisterHub initialise l'API de Yoctopuce en indiquant o les modules doivent tre recherchs. Utilise avec le paramtre "usb", elle permet de travailler avec les modules connects localement la machine. Si l'initialisation se passe mal, cette fonction renverra une valeur diffrente de YAPI.SUCCESS, et retournera via le paramtre errmsg une explication du problme.
YLed.FindLed
La fonction YLed.FindLed, permet de retrouver une led en fonction du numro de srie de son module hte et de son nom de fonction. Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez pralablement configurs. Imaginons un module YoctoDemo avec le numros de srie YCTOPOC1-123456 que vous auriez appel "MonModule" et dont vous auriez nomm la fonction led "MaFonction", les cinq appels suivants seront strictement quivalents (pour autant que MaFonction ne soit dfinie qu'une fois, pour viter toute ambigut):
led led led led led = = = = = YLed.FindLed("YCTOPOC1-123456.led"); YLed.FindLed("YCTOPOC1-123456.MaFonction"); YLed.FindLed("MonModule.led"); YLed.FindLed("MonModule.MaFonction"); YLed.FindLed("MaFonction");
YLed.FindLed renvoie un objet que vous pouvez ensuite utiliser loisir pour contrler la
led.
isOnline
La mthode YLed.isOnline() de l'objet renvoy par FindLed permet de savoir si le module correspondant est prsent et en tat de marche.
set_power
La fonction set_power() de l'objet renvoy par YLed.FindLed permet d'allumer et d'teindre la led. L'argument est YLed.POWER_ON ou YLed.POWER_OFF. Vous trouverez
4 Pensez
changer le filtre de la fentre de slection de fichiers, sinon la DLL n'apparatra pas 5
www.yoctopuce.com
dans la rfrence de l'interface de programmation d'autres mthodes permettant de contrler prcisment la luminosit et de faire clignoter automatiquement la led.
Un exemple rel
Lancez Visual C# et ouvrez le projet exemple correspondant, fourni dans le rpertoire Examples/Doc-GettingStarted-Yocto-Demo de la librairie Yoctopuce. Vous reconnatrez dans cet exemple l'utilisation des fonctions expliques ci-dessus, cette fois utilises avec le dcorum ncessaire en faire un petit programme d'exemple concret.
using System; using System.Collections.Generic; using System.Linq; using System.Text; namespace ConsoleApplication1 { class Program { static void usage() { Console.WriteLine("demo <serial_number> [ on | off ]"); Console.WriteLine("demo <logical_name> [ on | off ]"); Console.WriteLine("demo any [ on | off ] "); Environment.Exit(0); } static void Main(string[] args) { string errmsg = ""; string target; YLed led; string on_off; if (args.Length < 2) usage(); target = args[0].ToUpper(); on_off = args[1].ToUpper(); if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) { Console.WriteLine("RegisterHub error: " + errmsg); Environment.Exit(0); } if (target == "ANY") { led = YLed.FirstLed(); if (led == null) { Console.WriteLine("No module connected (check USB cable) "); Environment.Exit(0); } } else led = YLed.FindLed(target + ".led"); if (led.isOnline()) { if (on_off == "ON") led.set_power(YLed.POWER_ON); else led.set_power (YLed.POWER_OFF); } else Console.WriteLine("Module not connected (check identification and USB cable)"); } } }
2.4. Contrle de la partie module

Chaque module peut-tre contrl d'une manire similaire, vous trouverez ci-dessous un simple programme d'exemple affichant les principaux paramtres d'un module et permettant d'activer la balise de localisation.
using System; using System.Collections.Generic; using System.Linq; using System.Text;
www.yoctopuce.com
namespace ConsoleApplication1 { class Program { static void usage() { Console.WriteLine("usage: demo <serial or logical name> [ON/OFF]"); Environment.Exit(0); } static void Main(string[] args) { YModule m; string errmsg = ""; if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) { Console.WriteLine("RegisterHub error: " + errmsg); Environment.Exit(0); }
if (args.Length < 2)
usage();
m = YModule.FindModule(args[0]); // use serial or logical name if (m.isOnline()) { if (args.Length >= 2) { if (args[1].ToUpper() == "ON") { m.set_beacon(YModule.BEACON_ON); } if (args[1].ToUpper() == "OFF") { m.set_beacon(YModule.BEACON_OFF); } } Console.WriteLine("serial: " + m.get_serialNumber()); Console.WriteLine("logical name: " + m.get_logicalName()); Console.WriteLine("luminosity: " + m.get_luminosity().ToString()); Console.Write("beacon: "); if (m.get_beacon() == YModule.BEACON_ON) Console.WriteLine("ON"); else Console.WriteLine("OFF"); } else Console.WriteLine(args[0] + " not connected (check identification and USB cable)"); } } }
Chaque proprit xxx du module peut tre lue grce une mthode du type YModule.get_xxxx(), et les proprits qui se sont pas en lecture seule peuvent tre modifies l'aide de la mthode YModule.set_xxx() Pour plus de dtails concernant ces fonctions utilises, reportez-vous aux chapitre API
Modifications des rglages du module

Lorsque que vous souhaitez modifier les rglages d'un module, il suffit d'appeler la fonction YModule.set_xxx() correspondante, cependant cette modification n'a lieu que dans la mmoire vive du module: si le module redmarre, les modifications seront perdues. Pour qu'elle soient mmorises de manire persistante, il est ncessaire de demander au module de sauvegarder sa configuration courante dans sa mmoire non volatile. Pour cela il faut utiliser la mthode YModule.saveToFlash(). Inversement il est possible de forcer le module oublier ses rglages courants en utilisant la mthode YModule.revertFromFlash(). Ce petit exemple ci-dessous vous permet changer le nom logique d'un module.
using System; using System.Collections.Generic; using System.Linq; using System.Text; namespace ConsoleApplication1 { class Program
www.yoctopuce.com
{ static void usage() { Console.WriteLine("usage: demo <serial or logical name> <new logical name>"); Environment.Exit(0); } static void Main(string[] args) { YModule m; string errmsg = ""; string newname; if (args.Length != 2) usage(); if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) { Console.WriteLine("RegisterHub error: " + errmsg); Environment.Exit(0); } m = YModule.FindModule(args[0]); // use serial or logical name if (m.isOnline()) { newname = args[1]; if (!YAPI.CheckLogicalName(newname)) { Console.WriteLine("Invalid name (" + newname + ")"); Environment.Exit(0); } m.set_logicalName(newname); m.saveToFlash(); // do not forget this Console.Write("Module: serial= " + m.get_serialNumber()); Console.WriteLine(" / name= " + m.get_logicalName()); } else Console.Write("not connected (check identification and USB cable"); } } }
Attention, le nombre de cycles d'criture de la mmoire non volatile du module est limit. Pass cette limite plus rien ne garantit que la sauvegarde des rglages se passera correctement. Cette limite, lie la technologie employe par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour rsumer vous ne pouvez employer la fonction YModule.saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc ne pas appeler cette fonction depuis l'intrieur d'une boucle.
Enumeration des modules

Obtenir la liste des modules connects se fait l'aide de la fonction
YModule.yFirstModule() qui renvoie le premier module trouv, il suffit ensuite d'appeler la mthode nextModule() de cet objet pour trouver les modules suivants, et ce tant que la rponse n'est pas un null. Ci-dessous un petit exemple listant les module connects
using System; using System.Collections.Generic; using System.Linq; using System.Text; namespace ConsoleApplication1 { class Program { static void Main(string[] args) { YModule m; string errmsg = ""; if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) { Console.WriteLine("RegisterHub error: " + errmsg); Environment.Exit(0); } Console.WriteLine("Device list"); m = YModule.FirstModule();
www.yoctopuce.com
while (m!=null) { Console.WriteLine(m.get_serialNumber() + " (" + m.get_productName() + ")"); m = m.nextModule(); } } } }
2.5. Gestion des erreurs

Lorsque vous implmentez un programme qui doit interagir avec des modules USB, vous ne pouvez pas faire abstraction de la gestion des erreurs. Il y aura forcment une occasion o un utilisateur aura dbranch le priphrique, soit avant de lancer le programme, soit mme en pleine opration. La librairie Yoctopuce est prvue pour vous aider supporter ce genre de comportements, mais votre code doit nanmoins tre fait pour se comporter au mieux pour interprter les erreurs signales par la librairie. La manire la plus simple de contourner le problme est celle que nous avons employ pour les petits exemples prcdents de ce chapitre: avant d'accder un module, on vrifie qu'il est en ligne avec la mthode isOnline() et on suppose ensuite qu'il va y rester pendant la fraction de seconde ncessaire excuter les lignes de code suivantes. Ce n'est pas parfait, mais a peut suffire dans certains cas. Il faut toutefois tre conscient qu'on ne peut pas totalement exclure une erreur se produisant aprs le isOnline(), qui pourrait faire planter le programme. La seule manire de l'viter est d'implmenter une des deux techniques de gestion des erreurs dcrites ci-dessous. La mthode recommande par la plupart des langages de programmation pour la gestion des erreurs imprvisibles est l'utilisation d'exceptions. C'est le comportement par dfaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accder un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: Si votre code attrape l'exception au vol et la gre, et tout se passe bien. Si votre programme tourne dans le debugger, vous pourrez relativement facilement dterminer o le problme s'est produit, et voir le message explicatif li l'exception. Sinon... l'exception va crasher votre programme, boum! Comme cette dernire situation n'est pas la plus souhaitable, la librairie Yoctopuce offre une autre alternative pour la gestion des erreurs, permettant de faire un programme robuste sans devoir attraper les exceptions chaque ligne de code. Il suffit d'appeler la fonction yDisableExceptions() pour commuter la librairie dans un mode o les exceptions de chaque fonction sont systmatiquement remplaces par des valeurs de retour particulires, qui peuvent tre testes par l'appelant lorsque c'est pertinent. Le nom de la valeur de retour en cas d'erreur pour chaque fonction est systmatiquement document dans la rfrence de la librairie. Il suit toujours la mme logique: une mthode get_state() retournera une valeur Y_STATE_INVALID, une mthode get_currentValue retournera une valeur Y_CURRENTVALUE_INVALID, etc. Dans tous les cas, la valeur retourne sera du type attendu, et ne sera pas un pointeur nul qui risquerait de faire crasher votre programme. Au pire, si vous affichez la valeur sans la tester, elle sera hors du cadre attendu pour la valeur retourne. Dans le cas de fonctions qui ne retournent priori pas d'information, la valeur de retour sera YAPI_SUCCESS si tout va bien, et un code d'erreur diffrent en cas d'chec. Quand vous travaillez sans les exceptions, il est possible d'obtenir un code d'erreur et un message expliquant l'origine de l'erreur en le demandant l'objet qui a retourn une erreur l'aide des mthodes errType() et errMessage(). Ce sont les mme informations qui auraient t associes l'exception si elles avaient t actives.
www.yoctopuce.com
3. Reference
3.1. Fonctions gnrales
Ces quelques fonctions gnrales permettent l'initialisation et la configuration de la librairie Yoctopuce. Dans la plupart des cas, un appel yRegisterHub() suffira en tout et pour tout. Ensuite, vous pourrez appeler la fonction globale yFind...() ou yFirst...() correspondant votre module pour pouvoir interagir avec lui. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_api.cs
Fonction globales
yCheckLogicalName(name) Vrifie si un nom donn est valide comme nom logique pour un module ou une fonction. yDisableExceptions() Dsactive l'utilisation d'exceptions pour la gestion des erreurs. yEnableExceptions() Ractive l'utilisation d'exceptions pour la gestion des erreurs. yEnableUSBHost(osContext) Cette fonction est utilise uniquement sous Android. yFreeAPI() Libre la mmoire dynamique utilise par la librairie Yoctopuce. yGetAPIVersion() Retourne la version de la librairie Yoctopuce utilise. 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. yRegisterDeviceArrivalCallback(arrivalCallback) Enregistre une fonction de callback qui sera appele chaque fois qu'un module est branch. yRegisterDeviceRemovalCallback(removalCallback)
www.yoctopuce.com
10
Enregistre une fonction de callback qui sera appele chaque fois qu'un module est dbranch. yRegisterHub(url, errmsg) Configure la librairie Yoctopuce pour utiliser les modules connects sur une machine donne. yRegisterLogFunction(logfun) Enregistre une fonction de callback qui sera appelle chaque fois que l'API a quelque chose dire. ySetDelegate(object) (Objective-C uniquement) Enregistre un objet dlgu qui doit se conformer au procole YDeviceHotPlug. ySetTimeout(callback, ms_timeout, optional_arguments) Appelle le callback spcifi aprs un temps d'attente spcifi. ySleep(ms_duration, errmsg) Effectue une pause dans l'excution du programme pour une dure spcifie. yUnregisterHub(url) Configure la librairie Yoctopuce pour ne plus utiliser les modules connects sur une machine pralablement enregistrer avec RegisterHub. yUpdateDeviceList(errmsg) Force une mise--jour de la liste des modules Yoctopuce connects. yUpdateDeviceList_async(callback, context) Force une mise--jour de la liste des modules Yoctopuce connects.
YAPI.CheckLogicalName()
Vrifie si un nom donn est valide comme nom logique pour un module ou une fonction.
bool CheckLogicalName( string name)
Un nom logique valide est form de 19 caractres au maximum, choisis parmi A..Z, a..z, 0..9, _ et -. Lorsqu'on configure un nom logique avec une chane incorrecte, les caractres invalides sont ignors.
Paramtres : name une chane de caractres contenant le nom vrifier. Retourne : true si le nom est valide, false dans le cas contraire.
YAPI.DisableExceptions()
Dsactive l'utilisation d'exceptions pour la gestion des erreurs.
void DisableExceptions( )
Lorsque les exceptions sont dsactives, chaque fonction retourne une valeur d'erreur spcifique selon son type, documente dans ce manuel de rfrence.
YAPI.EnableExceptions()
Ractive l'utilisation d'exceptions pour la gestion des erreurs.
void EnableExceptions( )
www.yoctopuce.com
11
Attention, lorsque les exceptions sont actives, tout appel une fonction de la librairie qui choue dclenche une exception. Dans le cas o celle-ci n'est pas intercepte correctement par le code appelant, soit le debugger se lance, soit le programme de l'utilisateur est immdiatement stopp (crash). Cette fonction est utilise uniquement sous Android. Avant d'appeler yRegisterHub("usb") il faut activer le port USB host du systeme. Cette fonction prend en argument un objet de la classe android.content.Context (ou d'une sousclasse). Il n'est pas ncessaire d'appeler cette fonction pour accder au modules travers le rseau.
Paramtres : osContext un objet de classe android.content.Context (ou une sous-classe)
En cas d'erreur, dclenche une exception
YAPI.FreeAPI()
Libre la mmoire dynamique utilise par la librairie Yoctopuce.
void FreeAPI( )
Il n'est en gnral pas ncessaire d'appeler cette fonction, sauf si vous dsirez librer tous les blocs de mmoire allous dynamiquement dans le but d'identifier une source de blocs perdus par exemple. Vous ne devez plus appeler aucune fonction de la librairie aprs avoir appel yFreeAPI(), sous peine de crash.
YAPI.GetAPIVersion()
Retourne la version de la librairie Yoctopuce utilise.
String GetAPIVersion( )
La
version
est
retourne
sous
forme
d'une
chane
de
caractres
au
format
"Majeure.Mineure.NoBuild", par exemple "1.01.5535". Pour les langages utilisant

une DLL externe (par exemple C#, VisualBasic ou Delphi), la chane contient en outre la version de la DLL au mme format, par exemple "1.01.5535 (1.01.5439)". Si vous dsirez vrifier dans votre code que la version de la librairie est compatible avec celle que vous avez utilis durant le dveloppement, vrifiez que le numro majeur soit strictement gal et que le numro mineur soit gal ou suprieur. Le numro de build n'est pas significatif par rapport la compatibilit de la librairie.
Retourne : une chane de caractres dcrivant la version de la librairie.
YAPI.GetTickCount()
Retourne la valeur du compteur monotone de temps (en millisecondes).
long GetTickCount( )
Ce compteur peut tre utilis pour calculer des dlais en rapport avec les modules Yoctopuce, dont la base de temps est aussi la milliseconde.
Retourne : un long entier contenant la valeur du compteur de millisecondes.
www.yoctopuce.com
12
YAPI.HandleEvents()
Maintient la communication de la librairie avec les modules Yoctopuce.
YRETCODE HandleEvents( ref string errmsg)
Si votre programme inclut des longues boucles d'attente, vous pouvez y inclure un appel cette fonction pour que la librairie prenne en charge les informations mise en attente par les modules sur les canaux de communication. Ce n'est pas strictement indispensable mais cela peut amliorer la ractivit des la librairie pour les commandes suivantes. Cette fonction peut signaler une erreur au cas la communication avec un module Yoctopuce ne se passerait pas comme attendu.
Paramtres : errmsg une chane de caractres passe par rfrence, dans laquelle sera stock un ventuel message d'erreur. Retourne :
YAPI_SUCCESS si l'opration se droule sans erreur. En cas d'erreur, dclenche une exception
ou retourne un code d'erreur ngatif.
YAPI.InitAPI()
Initialise la librairie de programmation de Yoctopuce explicitement.
int InitAPI( int mode, ref string errmsg)
Il n'est pas indispensable d'appeler yInitAPI(), la librairie sera automatiquement initialise de toute manire au premier appel yRegisterHub(). Lorsque cette fonctin est utilise avec comme mode la valeur Y_DETECT_NONE, il faut explicitement appeler yRegisterHub() pour indiquer la librairie sur quel VirtualHub les modules sont connects, avant d'essayer d'y accder.
Paramtres : mode un entier spcifiant le type de dtection automatique de modules utiliser. Les valeurs possibles sont Y_DETECT_NONE, Y_DETECT_USB, Y_DETECT_NET et Y_DETECT_ALL. errmsg une chane de caractres passe par rfrence, dans laquelle sera stock un ventuel message d'erreur. Retourne :
YAPI.RegisterDeviceArrivalCallback()
Enregistre une fonction de callback qui sera appele chaque fois qu'un module est branch.
void RegisterDeviceArrivalCallback( yDeviceUpdateFunc arrivalCallback)
Le callback sera appel pendant l'xecution de la fonction yHandleDeviceList, que vous devrez appeler rgulirement.
Paramtres : arrivalCallback une procdure qui prend un YModule en paramtre, ou null
pour supprimer un callback dja enregistr.
www.yoctopuce.com
13
YAPI.RegisterDeviceRemovalCallback()
Enregistre une fonction de callback qui sera appele chaque fois qu'un module est dbranch.
void RegisterDeviceRemovalCallback( yDeviceUpdateFunc removalCallback)
Le callback sera appel pendant l'xecution de la fonction yHandleDeviceList, que vous devrez appeler rgulirement.
Paramtres : removalCallback une procdure qui prend un YModule en paramtre, ou null
pour supprimer un callback dja enregistr.
YAPI.RegisterHub()
Configure la librairie Yoctopuce pour utiliser les modules connects sur une machine donne.
int RegisterHub( string url, ref string errmsg)
Dans le cas d'une utilisation avec la passerelle VirtualHub, vous devez donner en paramtre l'adresse de la machine o tourne le VirtualHub (typiquement "http:// 127.0.0.1:4444", qui dsigne la machine locale). Si vous utilisez un langage qui a un accs direct USB, vous pouvez utiliser la pseudo-adresse "usb" la place. Attention, seule une application peut fonctionner la fois sur une machine donne en accs direct USB, sinon il y aurait un conflit d'accs aux modules. Cela signifie en particulier que vous devez stopper le VirtualHub avant de lancer une application utilisant l'accs direct USB. Cette limitation peut tre contourne en passant par un VirtualHub plutt que d'utiliser directement USB. Si vous dsirez vous connecter un VirtualHub sur lequel le controle d'accs a t activ, vous devez donner le paramtre url sous la forme: http://
nom:mot_de_passe@adresse:port
Paramtres : url une chane de caractres contenant "usb" ou l'URL racine du VirtualHub utiliser. errmsg une chane de caractres passe par rfrence, dans laquelle sera stock un ventuel message d'erreur. Retourne :
YAPI.RegisterLogFunction()
Enregistre une fonction de callback qui sera appelle chaque fois que l'API a quelque chose dire.
void RegisterLogFunction( yLogFunc logfun)
Utile pour dbugger le fonctionnement de l'API.

Paramtres : logfun une procedure qui prend une chane de caractre en paramtre,
ou null pour supprimer un callback dja enregistr.
(Objective-C uniquement) Enregistre un objet dlgu qui doit se conformer au procole YDeviceHotPlug.
www.yoctopuce.com
14
Les methodes yDeviceArrival et yDeviceRemoval seront appeles pendant l'xecution de la fonction yHandleDeviceList, que vous devrez appeler rgulirement.
Paramtres : object un objet qui soit se conformer au procol YAPIDelegate, ou nil
pour supprimer un objet dja enregistr.
Appelle le callback spcifi aprs un temps d'attente spcifi. Cette fonction se comporte plus ou moins comme la fonction Javascript setTimeout, mais durant le temps d'attente, elle va appeler yHandleEvents et yUpdateDeviceList priodiquement pour maintenir l'API jour avec les modules connects.
Paramtres : callback la fonction appeler lorsque le temps d'attente est coul. Sous Microsoft Internet Explorer, le callback doit tre spcifi sous forme d'une string valuer. ms_timeout un entier correspondant la dure de l'attente, en millisecondes optional_arguments des arguments supplmentaires peuvent tre fournis, pour tre passs la fonction de callback si ncessaire (pas support sous Microsoft Internet Explorer).
Retourne :
YAPI.Sleep()
Effectue une pause dans l'excution du programme pour une dure spcifie.
int Sleep( int ms_duration, ref string errmsg)
L'attente est passive, c'est--dire qu'elle n'occupe pas significativement le processeur, de sorte le laisser disponible pour les autres processus fonctionnant sur la machine. Durant l'attente, la librairie va nanmoins continuer lire priodiquement les informations en provenance des modules Yoctopuce en appelant la fonction yHandleEvents() afin de se maintenir jour. Cette fonction peut signaler une erreur au cas la communication avec un module Yoctopuce ne se passerait pas comme attendu.
Paramtres : ms_duration un entier correspondant la dure de la pause, en millisecondes errmsg une chane de caractres passe par rfrence, dans laquelle sera stock un ventuel message d'erreur. Retourne :
YAPI.UnregisterHub()
Configure la librairie Yoctopuce pour ne plus utiliser les modules connects sur une machine pralablement enregistrer avec RegisterHub.
void UnregisterHub( string url) Paramtres : url
une chane de caractres contenant "usb" ou
l'URL racine du VirtualHub ne plus utiliser.
www.yoctopuce.com
15
YAPI.UpdateDeviceList()
Force une mise--jour de la liste des modules Yoctopuce connects.
YRETCODE UpdateDeviceList( ref string errmsg)
La librairie va vrifier sur les machines ou ports USB prcdemment enregistrs en utilisant la fonction yRegisterHub si un module a t connect ou dconnect, et le cas chant appeler les fonctions de callback dfinies par l'utilisateur. Cette fonction peut tre appele aussi souvent que dsir, afin de rendre l'application ractive aux vnements de hot-plug.
Paramtres : errmsg une chane de caractres passe par rfrence, dans laquelle sera stock un ventuel message d'erreur. Retourne :
Force une mise--jour de la liste des modules Yoctopuce connects. La librairie va vrifier sur les machines ou ports USB prcdemment enregistrs en utilisant la fonction yRegisterHub si un module a t connect ou dconnect, et le cas chant appeler les fonctions de callback dfinies par l'utilisateur. Cette fonction peut tre appele aussi souvent que dsir, afin de rendre l'application ractive aux vnements de hot-plug. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
Paramtres : callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit deux arguments: le contexte fourni par l'appelant et le code de retour (YAPI_SUCCESS si l'opration se droule sans erreur). context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
3.2. Interface de la fonction AnButton

La librairie de programmation Yoctopuce permet aussi bien de mesurer l'tat d'un simple bouton que de lire un potentiomtre analogique (rsistance variable), comme par exmple bouton rotatif continue, une poigne de commande de gaz ou un joystick. Le module est capable de se calibrer sur les valeurs minimales et maximales du potentiomtre, et de restituer une valeur calibre variant proportionnellement avec la position du potentiomtre, indpendant de sa rsistance totale. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_anbutton.cs
Fonction globales
yFindAnButton(func) Permet de retrouver une entre analogique d'aprs un identifiant donn. yFirstAnButton() Commence l'numration des entres analogiques accessibles par la librairie.
www.yoctopuce.com
16
Mthodes des objets YAnButton

anbuttondescribe() Retourne un court texte dcrivant la fonction. anbuttonget_advertisedValue() Retourne la valeur courante de l'entre analogique (pas plus de 6 caractres). anbuttonget_analogCalibration() Permet de savoir si une procdure de calibration est actuellement en cours. anbuttonget_calibratedValue() Retourne la valeur calibre de l'entre (entre 0 et 1000 inclus). anbuttonget_calibrationMax() Retourne la valeur maximale observe durant la calibration (entre 0 et 4095 inclus). anbuttonget_calibrationMin() Retourne la valeur minimale observe durant la calibration (entre 0 et 4095 inclus). anbuttonget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. anbuttonget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. anbuttonget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. anbuttonget_hardwareId() Retourne l'identifiant unique de la fonction. anbuttonget_isPressed() Retourne vrai si l'entre (considre comme binaire) est active (contact ferm), et faux sinon. anbuttonget_lastTimePressed() Retourne le temps absolu (nombre de millisecondes) entre la mise sous tension du module et la dernire pression observe du bouton l'entre (transition du contact de ouvert ferm). anbuttonget_lastTimeReleased() Retourne le temps absolu (nombre de millisecondes) entre la mise sous tension du module et le dernier relchement observe du bouton l'entre (transition du contact de ferm ouvert). anbuttonget_logicalName() Retourne le nom logique de l'entre analogique. anbuttonget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. anbuttonget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. anbuttonget_rawValue() Retourne la valeur mesure de l'entre telle-quelle (entre 0 et 4095 inclus). anbuttonget_sensitivity() Retourne la sensibilit pour l'entre (entre 1 et 255 inclus) pour le dclanchement de callbacks. anbuttonget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. anbuttonisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur.
www.yoctopuce.com
17
anbuttonisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. anbuttonload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. anbuttonload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. anbuttonnextAnButton() Continue l'numration des entres analogiques commence l'aide de yFirstAnButton(). anbuttonregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. anbuttonset_analogCalibration(newval) Enclenche ou dclenche le procdure de calibration. anbuttonset_calibrationMax(newval) Modifie la valeur maximale de calibration pour l'entre (entre 0 et 4095 inclus), sans lancer la calibration automatique. anbuttonset_calibrationMin(newval) Modifie la valeur minimale de calibration pour l'entre (entre 0 et 4095 inclus), sans lancer la calibration automatique. anbuttonset_logicalName(newval) Modifie le nom logique de l'entre analogique. anbuttonset_sensitivity(newval) Modifie la sensibilit pour l'entre (entre 1 et 255 inclus) pour le dclanchement de callbacks. anbuttonset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YAnButton.FindAnButton()
Permet de retrouver une entre analogique d'aprs un identifiant donn.
YAnButton FindAnButton( string func)
L'identifiant peut tre spcifi sous plusieurs formes: NomLogiqueFonction NoSerieModule.IdentifiantFonction NoSerieModule.NomLogiqueFonction NomLogiqueModule.IdentifiantMatriel NomLogiqueModule.NomLogiqueFonction
Cette fonction n'exige pas que l'entre analogique soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YAnButton.isOnline() pour tester si l'entre analogique est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence l'entre analogique sans ambigut Retourne : un objet de classe YAnButton qui permet ensuite de contrler l'entre analogique.
www.yoctopuce.com
18
YAnButton.FirstAnButton()
Commence l'numration des entres analogiques accessibles par la librairie.
YAnButton FirstAnButton( )
Utiliser la fonction YAnButton.nextAnButton() pour itrer sur les autres entres analogiques.
Retourne : un pointeur sur un objet YAnButton, correspondant la premire entre analogique accessible en ligne, ou null si il n'y a pas de entres analogiques disponibles.
anbutton.describe()
Retourne un court texte dcrivant la fonction.
string describe( )
Ce texte inclut toujours le nom de la classe, et peut contenir en sus soit le nom logique de la fonction, soit son identifiant hardware.
Retourne : une chane de caractres dcrivant la fonction
anbutton.get_advertisedValue()
Retourne la valeur courante de l'entre analogique (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante de l'entre analogique (pas plus de 6 caractres)
En cas d'erreur, dclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID.
anbutton.get_analogCalibration()
Permet de savoir si une procdure de calibration est actuellement en cours.
int get_analogCalibration( ) Retourne : soit Y_ANALOGCALIBRATION_OFF, soit Y_ANALOGCALIBRATION_ON
En
cas
d'erreur,
dclenche
une
exception
ou
retourne
Y_ANALOGCALIBRATION_INVALID.
anbutton.get_calibratedValue()
Retourne la valeur calibre de l'entre (entre 0 et 1000 inclus).
int get_calibratedValue( ) Retourne : un entier reprsentant la valeur calibre de l'entre (entre 0 et 1000 inclus)
En cas d'erreur, dclenche une exception ou retourne Y_CALIBRATEDVALUE_INVALID.
www.yoctopuce.com
19
anbutton.get_calibrationMax()
Retourne la valeur maximale observe durant la calibration (entre 0 et 4095 inclus).
int get_calibrationMax( ) Retourne : un entier reprsentant la valeur maximale observe durant la calibration (entre 0 et 4095 inclus)
En cas d'erreur, dclenche une exception ou retourne Y_CALIBRATIONMAX_INVALID.
anbutton.get_calibrationMin()
Retourne la valeur minimale observe durant la calibration (entre 0 et 4095 inclus).
int get_calibrationMin( ) Retourne : un entier reprsentant la valeur minimale observe durant la calibration (entre 0 et 4095 inclus)
En cas d'erreur, dclenche une exception ou retourne Y_CALIBRATIONMIN_INVALID.
anbutton.get_errorMessage()
Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction.
string get_errorMessage( )
Cette mthode est principalement utile lorsque la librairie Yoctopuce est utilise en dsactivant la gestion des exceptions.
Retourne : une chane de caractres correspondant au message de la dernire erreur qui s'est produit lors de l'utilisation de la fonction
anbutton.get_errorType()
Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction.
YRETCODE get_errorType( )
Retourne : un nombre correspondant au code de la dernire erreur qui s'est produit lors de l'utilisation de la fonction
anbutton.get_anbuttonDescriptor()
Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction.
YFUN_DESCR get_functionDescriptor( )
Cet identifiant peut tre utilis pour tester si deux instance de YFunction rfrencent physiquement la mme fonction sur le mme module.
Retourne : un identifiant de type YFUN_DESCR. Si la fonction n'a jamais t contacte, la valeur retourne sera Y_FUNCTIONDESCRIPTOR_INVALID
www.yoctopuce.com
20
anbutton.get_hardwareId()
Retourne l'identifiant unique de la fonction.
string get_hardwareId( )
L'identifiant unique est compos du numro de srie du module et de l'identifiant matriel de la fonction.
Retourne : une chane de caractres identifiant la fonction En cas d'erreur, dclenche une exception ou retourne Y_HARDWAREID_INVALID.
anbutton.get_isPressed()
Retourne vrai si l'entre (considre comme binaire) est active (contact ferm), et faux sinon.
int get_isPressed( ) Retourne : soit Y_ISPRESSED_FALSE, soit Y_ISPRESSED_TRUE, selon vrai si l'entre (considre comme binaire) est active (contact ferm), et faux sinon
En cas d'erreur, dclenche une exception ou retourne Y_ISPRESSED_INVALID.
anbutton.get_lastTimePressed()
Retourne le temps absolu (nombre de millisecondes) entre la mise sous tension du module et la dernire pression observe du bouton l'entre (transition du contact de ouvert ferm).
long get_lastTimePressed( ) Retourne : un entier reprsentant le temps absolu (nombre de millisecondes) entre la mise sous tension du module et la dernire pression observe du bouton l'entre (transition du contact de ouvert ferm)
En cas d'erreur, dclenche une exception ou retourne Y_LASTTIMEPRESSED_INVALID.
anbutton.get_lastTimeReleased()
Retourne le temps absolu (nombre de millisecondes) entre la mise sous tension du module et le dernier relchement observe du bouton l'entre (transition du contact de ferm ouvert).
long get_lastTimeReleased( ) Retourne : un entier reprsentant le temps absolu (nombre de millisecondes) entre la mise sous tension du module et le dernier relchement observe du bouton l'entre (transition du contact de ferm ouvert)
En cas d'erreur, dclenche une exception ou retourne Y_LASTTIMERELEASED_INVALID.
anbutton.get_logicalName()
Retourne le nom logique de l'entre analogique.
string get_logicalName( ) Retourne :
www.yoctopuce.com 21
une chane de caractres reprsentant le nom logique de l'entre analogique
En cas d'erreur, dclenche une exception ou retourne Y_LOGICALNAME_INVALID.
anbutton.get_module()
Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction.
YModule get_module( )
Si la fonction ne peut tre trouve sur aucun module, l'instance de YModule retourne ne sera pas joignable.
Retourne : une instance de YModule
Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. Si la fonction ne peut tre trouve sur aucun module, l'instance de YModule retourne ne sera pas joignable. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
Paramtres : callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et l'instance demande de YModule context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
anbutton.get_rawValue()
Retourne la valeur mesure de l'entre telle-quelle (entre 0 et 4095 inclus).
int get_rawValue( ) Retourne : un entier reprsentant la valeur mesure de l'entre telle-quelle (entre 0 et 4095 inclus)
En cas d'erreur, dclenche une exception ou retourne Y_RAWVALUE_INVALID.
anbutton.get_sensitivity()
Retourne la sensibilit pour l'entre (entre 1 et 255 inclus) pour le dclanchement de callbacks.
int get_sensitivity( ) Retourne : un entier reprsentant la sensibilit pour l'entre (entre 1 et 255 inclus) pour le dclanchement de callbacks
En cas d'erreur, dclenche une exception ou retourne Y_SENSITIVITY_INVALID.
www.yoctopuce.com
22
anbutton.get_userData()
Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData.
object get_userData( )
Cet attribut n'es pas utilis directement par l'API. Il est la disposition de l'appelant pour stocker un contexte.
Retourne : l'objet stock prcdemment par l'appelant.
anbutton.isOnline()
Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur.
bool isOnline( )
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considr joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vrification de joignabilit.
Retourne : true si la fonction est joignable, false sinon
Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considr joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vrification de joignabilit. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
Paramtres : callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le rsultat boolen context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
anbutton.load()
Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie.
YRETCODE load( int msValidity)
Par dfaut, lorsqu'on accde un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dure standard (5 ms). Cette mthode peut tre utilise pour marquer occasionellement les donnes caches comme valides pour une plus longue priode, par exemple dans le but de rduire le trafic rseau.
Paramtres : msValidity un entier correspondant la dure de validit attribue aux les paramtres chargs, en millisecondes Retourne :
www.yoctopuce.com
23
Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. Par dfaut, lorsqu'on accde un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dure standard (5 ms). Cette mthode peut tre utilise pour marquer occasionellement les donnes caches comme valides pour une plus longue priode, par exemple dans le but de rduire le trafic rseau. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
Paramtres : msValidity un entier correspondant la dure de validit attribue aux les paramtres chargs, en millisecondes callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le code d'erreur (ou YAPI_SUCCESS) context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
anbutton.nextAnButton()
Continue l'numration des entres analogiques commence l'aide de
yFirstAnButton().
YAnButton nextAnButton( ) Retourne : un pointeur sur un objet YAnButton accessible en ligne, ou null lorsque l'numration est termine.
anbutton.registerValueCallback()
Enregistre la fonction de callback qui est appele chaque changement de la valeur publie.
void registerValueCallback( UpdateCallback callback)
Ce callback n'est appel que durant l'excution de ySleep ou yHandleEvents. Cela permet l'appelant de contrler quand les callback peuvent se produire. Il est important d'appeler l'une de ces deux fonctions priodiquement pour garantir que les callback ne soient pas appels trop tard. Pour dsactiver un callback, il suffit d'appeler cette mthode en lui passant un pointeur nul.
Paramtres : callback la fonction de callback rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a chang, et la chane de caractre dcrivant la nouvelle valeur publie.
anbutton.set_analogCalibration()
Enclenche ou dclenche le procdure de calibration.
int set_analogCalibration( int newval)
www.yoctopuce.com
24
N'oubliez pas d'appeler la mthode saveToFlash() du module la fin de la calibration si le rglage doit tre prserv.
Paramtres : newval soit Y_ANALOGCALIBRATION_OFF, soit Y_ANALOGCALIBRATION_ON Retourne :
YAPI_SUCCESS si l'opration se droule sans erreur.

En cas d'erreur, dclenche une exception ou retourne un code d'erreur ngatif.
anbutton.set_calibrationMax()
Modifie la valeur maximale de calibration pour l'entre (entre 0 et 4095 inclus), sans lancer la calibration automatique.
int set_calibrationMax( int newval)
N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres : newval un entier reprsentant la valeur maximale de calibration pour l'entre (entre 0 et 4095 inclus), sans lancer la calibration automatique Retourne :

anbutton.set_calibrationMin()
Modifie la valeur minimale de calibration pour l'entre (entre 0 et 4095 inclus), sans lancer la calibration automatique.
int set_calibrationMin( int newval)
Paramtres : newval un entier reprsentant la valeur minimale de calibration pour l'entre (entre 0 et 4095 inclus), sans lancer la calibration automatique Retourne :

anbutton.set_logicalName()
Modifie le nom logique de l'entre analogique.
int set_logicalName( string newval)
Vous pouvez utiliser yCheckLogicalName() pour vrifier si votre paramtre est valide. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres : newval une chane de caractres reprsentant le nom logique de l'entre analogique Retourne :

anbutton.set_sensitivity()
Modifie la sensibilit pour l'entre (entre 1 et 255 inclus) pour le dclanchement de callbacks.
int set_sensitivity( int newval)
Paramtres : newval un entier reprsentant la sensibilit pour l'entre (entre 1 et 255 inclus) pour le dclanchement de callbacks Retourne :

anbutton.set_userData()
Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
void set_userData( object data)
Paramtres : data objet quelconque mmoriser
3.3. Interface de la fonction CarbonDioxide

La librairie de programmation Yoctopuce permet lire une valeur instantane du capteur, ainsi que les extrmas atteints. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_carbondioxide.cs
Fonction globales
yFindCarbonDioxide(func) Permet de retrouver un capteur de CO2 d'aprs un identifiant donn. yFirstCarbonDioxide() Commence l'numration des capteurs de CO2 accessibles par la librairie.
Mthodes des objets YCarbonDioxide

carbondioxidecalibrateFromPoints(rawValues, refValues) Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur. carbondioxidedescribe() Retourne un court texte dcrivant la fonction. carbondioxideget_advertisedValue() Retourne la valeur courante du capteur de CO2 (pas plus de 6 caractres). carbondioxideget_currentRawValue()
www.yoctopuce.com
26
Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration). carbondioxideget_currentValue() Retourne la valeur mesure actuelle. carbondioxideget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. carbondioxideget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. carbondioxideget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. carbondioxideget_hardwareId() Retourne l'identifiant unique de la fonction. carbondioxideget_highestValue() Retourne la valeur maximale observe. carbondioxideget_logicalName() Retourne le nom logique du capteur de CO2. carbondioxideget_lowestValue() Retourne la valeur minimale observe. carbondioxideget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. carbondioxideget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. carbondioxideget_resolution() Retourne la rsolution des valeurs mesures. carbondioxideget_unit() Retourne l'unit dans laquelle la valeur mesure est exprime. carbondioxideget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. carbondioxideisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. carbondioxideisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. carbondioxideload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. carbondioxideload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. carbondioxidenextCarbonDioxide() Continue l'numration des yFirstCarbonDioxide().
capteurs
de
CO2
commence
l'aide
de
carbondioxideregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. carbondioxideset_highestValue(newval) Modifie la mmoire de valeur maximale observe.
www.yoctopuce.com
27
carbondioxideset_logicalName(newval) Modifie le nom logique du capteur de CO2. carbondioxideset_lowestValue(newval) Modifie la mmoire de valeur minimale observe. carbondioxideset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YCarbonDioxide.FindCarbonDioxide()
Permet de retrouver un capteur de CO2 d'aprs un identifiant donn.
YCarbonDioxide FindCarbonDioxide( string func)
Cette fonction n'exige pas que le capteur de CO2 soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YCarbonDioxide.isOnline () pour tester si le capteur de CO2 est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le capteur de CO2 sans ambigut Retourne : un objet de classe YCarbonDioxide qui permet ensuite de contrler le capteur de CO2.
YCarbonDioxide.FirstCarbonDioxide()
Commence l'numration des capteurs de CO2 accessibles par la librairie.
YCarbonDioxide FirstCarbonDioxide( )
Utiliser la fonction YCarbonDioxide.nextCarbonDioxide() pour itrer sur les autres capteurs de CO2.
Retourne : un pointeur sur un objet YCarbonDioxide, correspondant le premier capteur de CO2 accessible en ligne, ou null si il n'y a pas de capteurs de CO2 disponibles.
carbondioxide.calibrateFromPoints()
Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur.
int calibrateFromPoints( )
Il est possible d'enregistrer jusqu' cinq points de correction. Les points de correction doivent tre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation linaire de l'erreur entre les points spcifis. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
www.yoctopuce.com
28
Pour plus de plus amples possibilits d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.
Paramtres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction. refValues tableau de nombres flottants, correspondant aux valeurs corriges dsires pour les points de correction. Retourne :

carbondioxide.describe()
string describe( )
carbondioxide.get_advertisedValue()
Retourne la valeur courante du capteur de CO2 (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du capteur de CO2 (pas plus de 6 caractres)
carbondioxide.get_currentRawValue()
Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration).
double get_currentRawValue( ) Retourne : une valeur numrique reprsentant la valeur brute retourne par le capteur (sans arrondi ni calibration)
En cas d'erreur, dclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID.
carbondioxide.get_currentValue()
Retourne la valeur mesure actuelle.
double get_currentValue( ) Retourne : une valeur numrique reprsentant la valeur mesure actuelle
En cas d'erreur, dclenche une exception ou retourne Y_CURRENTVALUE_INVALID.
www.yoctopuce.com
29
carbondioxide.get_errorMessage()
carbondioxide.get_errorType()
carbondioxide.get_carbondioxideDescriptor()
carbondioxide.get_hardwareId()
carbondioxide.get_highestValue()
Retourne la valeur maximale observe.
double get_highestValue( ) Retourne : une valeur numrique reprsentant la valeur maximale observe
www.yoctopuce.com
30
En cas d'erreur, dclenche une exception ou retourne Y_HIGHESTVALUE_INVALID.
carbondioxide.get_logicalName()
Retourne le nom logique du capteur de CO2.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du capteur de CO2
carbondioxide.get_lowestValue()
Retourne la valeur minimale observe.
double get_lowestValue( ) Retourne : une valeur numrique reprsentant la valeur minimale observe
En cas d'erreur, dclenche une exception ou retourne Y_LOWESTVALUE_INVALID.
carbondioxide.get_module()
carbondioxide.get_resolution()
Retourne la rsolution des valeurs mesures.
double get_resolution( )
www.yoctopuce.com
31
La rsolution correspond la prcision de la reprsentation numrique des mesures. Elle n'est pas forcment identique la prcision relle du capteur.
Retourne : une valeur numrique reprsentant la rsolution des valeurs mesures
En cas d'erreur, dclenche une exception ou retourne Y_RESOLUTION_INVALID.
carbondioxide.get_unit()
Retourne l'unit dans laquelle la valeur mesure est exprime.
string get_unit( ) Retourne : une chane de caractres reprsentant l'unit dans laquelle la valeur mesure est exprime
En cas d'erreur, dclenche une exception ou retourne Y_UNIT_INVALID.
carbondioxide.get_userData()
carbondioxide.isOnline()
bool isOnline( )
Paramtres : callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le rsultat boolen context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne :
rien du tout : le rsultat sera pass en paramtre la fonction de callback.
carbondioxide.load()
carbondioxide.nextCarbonDioxide()
Continue l'numration des capteurs de CO2 commence l'aide de
yFirstCarbonDioxide().
YCarbonDioxide nextCarbonDioxide( ) Retourne : un pointeur sur un objet YCarbonDioxide accessible en ligne, ou null lorsque l'numration est termine.
carbondioxide.registerValueCallback()
www.yoctopuce.com
33
carbondioxide.set_highestValue()
Modifie la mmoire de valeur maximale observe.
int set_highestValue( double newval) Paramtres : newval une valeur numrique reprsentant la mmoire de valeur maximale observe Retourne :

carbondioxide.set_logicalName()
Modifie le nom logique du capteur de CO2.
Paramtres : newval une chane de caractres reprsentant le nom logique du capteur de CO2 Retourne :

carbondioxide.set_lowestValue()
Modifie la mmoire de valeur minimale observe.
int set_lowestValue( double newval) Paramtres : newval une valeur numrique reprsentant la mmoire de valeur minimale observe Retourne :

carbondioxide.set_userData()
www.yoctopuce.com
34
3.4. Interface de la fonction ColorLed

La librairie de programmation Yoctopuce permet de piloter une led couleur aussi bien en coordonnes RGB qu'en coordonnes HSL, les conversions RGB vers HSL tant faites automatiquement par le module. Ceci permet aisment d'allumer la led avec une certaine teinte et d'en faire progressivement varier la saturation ou la luminosit. Si ncessaire, vous trouverez plus d'information sur la diffrence entre RGB et HSL dans la section suivante. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_colorled.cs
Fonction globales
yFindColorLed(func) Permet de retrouver une led RGB d'aprs un identifiant donn. yFirstColorLed() Commence l'numration des leds RGB accessibles par la librairie.
Mthodes des objets YColorLed

colorleddescribe() Retourne un court texte dcrivant la fonction. colorledget_advertisedValue() Retourne la valeur courante de la led RGB (pas plus de 6 caractres). colorledget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. colorledget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. colorledget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. colorledget_hardwareId() Retourne l'identifiant unique de la fonction. colorledget_hslColor() Retourne la couleur HSL courante de la led. colorledget_logicalName() Retourne le nom logique de la led RGB. colorledget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. colorledget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. colorledget_rgbColor() Retourne la couleur RGB courante de la led. colorledget_rgbColorAtPowerOn()
www.yoctopuce.com
35
Retourne la couleur configure pour tre affichage l'allumage du module. colorledget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. colorledhslMove(hsl_target, ms_duration) Effectue une transition continue dans l'espace HSL entre la couleur courante et une nouvelle couleur. colorledisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. colorledisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. colorledload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. colorledload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. colorlednextColorLed() Continue l'numration des leds RGB commence l'aide de yFirstColorLed(). colorledregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. colorledrgbMove(rgb_target, ms_duration) Effectue une transition continue dans l'espace RGB entre la couleur courante et une nouvelle couleur. colorledset_hslColor(newval) Modifie la couleur courante de la led, en utilisant une couleur HSL spcifie. colorledset_logicalName(newval) Modifie le nom logique de la led RGB. colorledset_rgbColor(newval) Modifie la couleur courante de la led, en utilisant une couleur RGB (Rouge Vert Bleu). colorledset_rgbColorAtPowerOn(newval) Modifie la couleur que la led va afficher spontanment l'allumage du module. colorledset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YColorLed.FindColorLed()
Permet de retrouver une led RGB d'aprs un identifiant donn.
YColorLed FindColorLed( string func)
www.yoctopuce.com
36
Cette fonction n'exige pas que la led RGB soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YColorLed.isOnline() pour tester si la led RGB est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence la led RGB sans ambigut Retourne : un objet de classe YColorLed qui permet ensuite de contrler la led RGB.
YColorLed.FirstColorLed()
Commence l'numration des leds RGB accessibles par la librairie.
YColorLed FirstColorLed( )
Utiliser la fonction YColorLed.nextColorLed() pour itrer sur les autres leds RGB.
Retourne : un pointeur sur un objet YColorLed, correspondant la premire led RGB accessible en ligne, ou null si il n'y a pas de leds RGB disponibles.
colorled.describe()
string describe( )
colorled.get_advertisedValue()
Retourne la valeur courante de la led RGB (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante de la led RGB (pas plus de 6 caractres)
colorled.get_errorMessage()
www.yoctopuce.com
37
colorled.get_errorType()
colorled.get_colorledDescriptor()
colorled.get_hardwareId()
colorled.get_hslColor()
Retourne la couleur HSL courante de la led.
int get_hslColor( ) Retourne : un entier reprsentant la couleur HSL courante de la led
En cas d'erreur, dclenche une exception ou retourne Y_HSLCOLOR_INVALID.
colorled.get_logicalName()
Retourne le nom logique de la led RGB.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique de la led RGB
www.yoctopuce.com
38
colorled.get_module()
colorled.get_rgbColor()
Retourne la couleur RGB courante de la led.
int get_rgbColor( ) Retourne : un entier reprsentant la couleur RGB courante de la led
En cas d'erreur, dclenche une exception ou retourne Y_RGBCOLOR_INVALID.
colorled.get_rgbColorAtPowerOn()
Retourne la couleur configure pour tre affichage l'allumage du module.
int get_rgbColorAtPowerOn( ) Retourne : un entier reprsentant la couleur configure pour tre affichage l'allumage du module
En
cas
d'erreur,
dclenche
une
exception
ou
retourne
Y_RGBCOLORATPOWERON_INVALID.
colorled.get_userData()
www.yoctopuce.com
39
colorled.hslMove()
Effectue une transition continue dans l'espace HSL entre la couleur courante et une nouvelle couleur.
int hslMove( int hsl_target, int ms_duration) Paramtres : hsl_target couleur HSL dsire la fin de la transition ms_duration dure de la transition, en millisecondes Retourne :

colorled.isOnline()
bool isOnline( )
colorled.load()
www.yoctopuce.com
40
colorled.nextColorLed()
Continue l'numration des leds RGB commence l'aide de yFirstColorLed().
YColorLed nextColorLed( ) Retourne : un pointeur sur un objet YColorLed accessible en ligne, ou null lorsque l'numration est termine.
colorled.registerValueCallback()
www.yoctopuce.com
41
colorled.rgbMove()
Effectue une transition continue dans l'espace RGB entre la couleur courante et une nouvelle couleur.
int rgbMove( int rgb_target, int ms_duration) Paramtres : rgb_target couleur RGB dsire la fin de la transition ms_duration dure de la transition, en millisecondes Retourne :

colorled.set_hslColor()
Modifie la couleur courante de la led, en utilisant une couleur HSL spcifie.
int set_hslColor( int newval)
L'encodage est ralis de la manire suivante: 0xHHSSLL.

Paramtres : newval un entier reprsentant la couleur courante de la led, en utilisant une couleur HSL spcifie Retourne :

colorled.set_logicalName()
Modifie le nom logique de la led RGB.
Paramtres : newval une chane de caractres reprsentant le nom logique de la led RGB Retourne :

colorled.set_rgbColor()
Modifie la couleur courante de la led, en utilisant une couleur RGB (Rouge Vert Bleu).
int set_rgbColor( int newval)
L'encodage est ralis de la manire suivante: 0xRRGGBB.

Paramtres : newval un entier reprsentant la couleur courante de la led, en utilisant une couleur RGB (Rouge Vert Bleu) Retourne :

colorled.set_rgbColorAtPowerOn()
Modifie la couleur que la led va afficher spontanment l'allumage du module.
int set_rgbColorAtPowerOn( int newval)
Cette couleur sera affiche des que le module sera sous tension. Ne pas oublier d'appeler la fonction saveToFlash() du module correspondant pour que ce paramtre soit mmoris.
Paramtres : newval un entier reprsentant la couleur que la led va afficher spontanment l'allumage du module Retourne :

colorled.set_userData()
3.5. Interface de la fonction Current

yocto_current.cs
Fonction globales
yFindCurrent(func) Permet de retrouver un capteur de courant d'aprs un identifiant donn. yFirstCurrent() Commence l'numration des capteurs de courant accessibles par la librairie.
Mthodes des objets YCurrent

currentcalibrateFromPoints(rawValues, refValues) Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur. currentdescribe() Retourne un court texte dcrivant la fonction. currentget_advertisedValue() Retourne la valeur courante du capteur de courant (pas plus de 6 caractres). currentget_currentRawValue()
www.yoctopuce.com
43
Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration). currentget_currentValue() Retourne la valeur mesure actuelle. currentget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. currentget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. currentget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. currentget_hardwareId() Retourne l'identifiant unique de la fonction. currentget_highestValue() Retourne la valeur maximale observe. currentget_logicalName() Retourne le nom logique du capteur de courant. currentget_lowestValue() Retourne la valeur minimale observe. currentget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. currentget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. currentget_resolution() Retourne la rsolution des valeurs mesures. currentget_unit() Retourne l'unit dans laquelle la valeur mesure est exprime. currentget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. currentisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. currentisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. currentload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. currentload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. currentnextCurrent() Continue l'numration des capteurs de courant commence l'aide de yFirstCurrent(). currentregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. currentset_highestValue(newval) Modifie la mmoire de valeur maximale observe. currentset_logicalName(newval)
www.yoctopuce.com
44
Modifie le nom logique du capteur de courant. currentset_lowestValue(newval) Modifie la mmoire de valeur minimale observe. currentset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YCurrent.FindCurrent()
Permet de retrouver un capteur de courant d'aprs un identifiant donn.
YCurrent FindCurrent( string func)
Cette fonction n'exige pas que le capteur de courant soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YCurrent.isOnline () pour tester si le capteur de courant est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le capteur de courant sans ambigut Retourne : un objet de classe YCurrent qui permet ensuite de contrler le capteur de courant.
YCurrent.FirstCurrent()
Commence l'numration des capteurs de courant accessibles par la librairie.
YCurrent FirstCurrent( )
Utiliser la fonction YCurrent.nextCurrent() pour itrer sur les autres capteurs de courant.
Retourne : un pointeur sur un objet YCurrent, correspondant le premier capteur de courant accessible en ligne, ou null si il n'y a pas de capteurs de courant disponibles.
current.calibrateFromPoints()
Il est possible d'enregistrer jusqu' cinq points de correction. Les points de correction doivent tre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation linaire de l'erreur entre les points spcifis. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv. Pour plus de plus amples possibilits d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

current.describe()
string describe( )
current.get_advertisedValue()
Retourne la valeur courante du capteur de courant (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du capteur de courant (pas plus de 6 caractres)
current.get_currentRawValue()
current.get_currentValue()
current.get_errorMessage()
www.yoctopuce.com
46
current.get_errorType()
current.get_currentDescriptor()
current.get_hardwareId()
current.get_highestValue()
current.get_logicalName()
Retourne le nom logique du capteur de courant.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du capteur de courant
current.get_lowestValue()
current.get_module()
current.get_resolution()
www.yoctopuce.com
48
current.get_unit()
current.get_userData()
current.isOnline()
bool isOnline( )
current.load()
current.nextCurrent()
Continue l'numration des capteurs de courant commence l'aide de
yFirstCurrent().
YCurrent nextCurrent( ) Retourne : un pointeur sur un objet YCurrent accessible en ligne, ou null lorsque l'numration est termine.
current.registerValueCallback()
www.yoctopuce.com
50
current.set_highestValue()

current.set_logicalName()
Modifie le nom logique du capteur de courant.
Paramtres : newval une chane de caractres reprsentant le nom logique du capteur de courant Retourne :

current.set_lowestValue()

current.set_userData()
Paramtres :
www.yoctopuce.com
51
data objet quelconque mmoriser
3.6. Interface de la fonction DataLogger

Les capteurs de Yoctopuce sont quips d'une mmoire non-volatile permettant de mmoriser les donnes mesures d'une manire autonome, sans ncessiter le suivi permanent d'un ordinateur. La librairie de programmation Yoctopuce permet de contrler le fonctionnement de l'enregistreur de donnes interne. Dans la mesure o les capteurs n'ont pas de pile intgre, ils ne contiennent pas de rfrence de temps absolue. C'est pourquoi les mesures sont simplement indexes par le numro de Run (priode continue de fonctionnement lors d'une mise sous tension), et l'intervalle de temps depuis le dbut du Run. Il est par contre possible d'indiquer par logiciel l'enregistreur de donnes l'heure UTC un moment donne, afin qu'il en tienne compte jusqu' la prochaine mise hors tension. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_datalogger.cs
Fonction globales
yFindDataLogger(func) Permet de retrouver un enregistreur de donnes d'aprs un identifiant donn. yFirstDataLogger() Commence l'numration des enregistreurs de donnes accessibles par la librairie.
Mthodes des objets YDataLogger

dataloggerdescribe() Retourne un court texte dcrivant la fonction. dataloggerforgetAllDataStreams() Efface tout l'historique des mesures de l'enregistreur de donnes. dataloggerget_advertisedValue() Retourne la valeur courante de l'enregistreur de donnes (pas plus de 6 caractres). dataloggerget_autoStart() Retourne le mode d'activation automatique de l'enregistreur de donnes la mise sous tension. dataloggerget_currentRunIndex() Retourne le numro du Run actuel, correspondant au nombre de fois que le module a t mis sous tension avec la fonction d'enregistreur de donnes active. dataloggerget_dataRun(runIdx) Retourne un objet YDataRun contenant toutes les donnes mesures pour une priode d'enclanchement du module donne (un Run). dataloggerget_dataStreams(v) Construit une liste de toutes les squences de mesures mmorises par l'enregistreur. dataloggerget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. dataloggerget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. dataloggerget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. dataloggerget_hardwareId() Retourne l'identifiant unique de la fonction. dataloggerget_logicalName() Retourne le nom logique de l'enregistreur de donnes.
www.yoctopuce.com
52
dataloggerget_measureNames() Retourne les noms des valeurs mesures par l'enregistreur de donnes. dataloggerget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. dataloggerget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. dataloggerget_oldestRunIndex() Retourne le numro du Run le plus ancien pour lequel la mmoire non-volatile contient encore des donnes. dataloggerget_recording() Retourne l'tat d'activation de l'enregistreur de donnes. dataloggerget_timeUTC() Retourne le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue. dataloggerget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. dataloggerisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. dataloggerisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. dataloggerload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. dataloggerload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. dataloggernextDataLogger() Continue l'numration des yFirstDataLogger().
enregistreurs
de
donnes
commence
l'aide
de
dataloggerregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. dataloggerset_autoStart(newval) Modifie le mode d'activation automatique de l'enregistreur de donnes la mise sous tension. dataloggerset_logicalName(newval) Modifie le nom logique de l'enregistreur de donnes. dataloggerset_recording(newval) Modifie l'tat d'activation de l'enregistreur de donnes. dataloggerset_timeUTC(newval) Modifie la rfrence de temps UTC, afin de l'attacher aux donnes enregistres. dataloggerset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YDataLogger.FindDataLogger()
Permet de retrouver un enregistreur de donnes d'aprs un identifiant donn.
YDataLogger FindDataLogger( string func)
www.yoctopuce.com
53
Cette fonction n'exige pas que l'enregistreur de donnes soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YDataLogger.isOnline() pour tester si l'enregistreur de donnes est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence l'enregistreur de donnes sans ambigut Retourne : un objet de classe YDataLogger qui permet ensuite de contrler l'enregistreur de donnes.
YDataLogger.FirstDataLogger()
Commence l'numration des enregistreurs de donnes accessibles par la librairie.
YDataLogger FirstDataLogger( )
Utiliser la fonction YDataLogger.nextDataLogger() pour itrer sur les autres enregistreurs de donnes.
Retourne : un pointeur sur un objet YDataLogger, correspondant le premier enregistreur de donnes accessible en ligne, ou null si il n'y a pas de enregistreurs de donnes disponibles.
datalogger.describe()
string describe( )
datalogger.forgetAllDataStreams()
Efface tout l'historique des mesures de l'enregistreur de donnes.
int forgetAllDataStreams( )
Cette mthode remet aussi zro le compteur de Runs.

Retourne : YAPI_SUCCESS si l'opration se droule sans erreur.
datalogger.get_advertisedValue()
Retourne la valeur courante de l'enregistreur de donnes (pas plus de 6 caractres).
www.yoctopuce.com
54
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante de l'enregistreur de donnes (pas plus de 6 caractres)
datalogger.get_autoStart()
Retourne le mode d'activation automatique de l'enregistreur de donnes la mise sous tension.
int get_autoStart( ) Retourne : soit Y_AUTOSTART_OFF, soit Y_AUTOSTART_ON, selon le mode d'activation automatique de l'enregistreur de donnes la mise sous tension
En cas d'erreur, dclenche une exception ou retourne Y_AUTOSTART_INVALID.
datalogger.get_currentRunIndex()
Retourne le numro du Run actuel, correspondant au nombre de fois que le module a t mis sous tension avec la fonction d'enregistreur de donnes active.
int get_currentRunIndex( ) Retourne : un entier reprsentant le numro du Run actuel, correspondant au nombre de fois que le module a t mis sous tension avec la fonction d'enregistreur de donnes active
En cas d'erreur, dclenche une exception ou retourne Y_CURRENTRUNINDEX_INVALID. Retourne un objet YDataRun contenant toutes les donnes mesures pour une priode d'enclanchement du module donne (un Run).
Cet objet pourra tre utilis pour rcuprer les mesures (valeur min, valeur moyenne et valeur max) avec la granularit dsire.
Paramtres : runIdx l'index du Run dsir Retourne : un objet YDataRun
datalogger.get_dataStreams()
Construit une liste de toutes les squences de mesures mmorises par l'enregistreur.
int get_dataStreams( List<YDataStream> v)
L'appelant doit passer par rfrence un tableau vide pout stocker les objets YDataStream, et la mthode va les remplire avec des objets dcrivant les squences de donnes disponibles.
Paramtres : v un tableau de YDataStreams qui sera rempli avec les squences trouves Retourne :
www.yoctopuce.com
55
datalogger.get_errorMessage()
datalogger.get_errorType()
datalogger.get_dataloggerDescriptor()
datalogger.get_hardwareId()
datalogger.get_logicalName()
Retourne le nom logique de l'enregistreur de donnes.
string get_logicalName( )
www.yoctopuce.com
56
Retourne : une chane de caractres reprsentant le nom logique de l'enregistreur de donnes
En cas d'erreur, dclenche une exception ou retourne Y_LOGICALNAME_INVALID. Retourne les noms des valeurs mesures par l'enregistreur de donnes. Dans la plupart des cas, le nom des colonnes correspond l'identifiant matriel du capteur qui a produit la mesure.
Retourne : une liste de chane de caractres (les noms des mesures)
En cas d'erreur, dclenche une exception ou retourne une liste vide.
datalogger.get_module()
datalogger.get_oldestRunIndex()
Retourne le numro du Run le plus ancien pour lequel la mmoire non-volatile contient encore des donnes.
int get_oldestRunIndex( ) Retourne : un entier reprsentant le numro du Run le plus ancien pour lequel la mmoire non-volatile contient encore des donnes
En cas d'erreur, dclenche une exception ou retourne Y_OLDESTRUNINDEX_INVALID.
www.yoctopuce.com
57
datalogger.get_recording()
Retourne l'tat d'activation de l'enregistreur de donnes.
int get_recording( ) Retourne : soit Y_RECORDING_OFF, soit Y_RECORDING_ON, selon l'tat d'activation de l'enregistreur de donnes
En cas d'erreur, dclenche une exception ou retourne Y_RECORDING_INVALID.
datalogger.get_timeUTC()
Retourne le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue.
int get_timeUTC( ) Retourne : un entier reprsentant le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue
En cas d'erreur, dclenche une exception ou retourne Y_TIMEUTC_INVALID.
datalogger.get_userData()
datalogger.isOnline()
bool isOnline( )
Paramtres :
www.yoctopuce.com
58
callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le rsultat boolen context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
datalogger.load()
datalogger.nextDataLogger()
Continue l'numration des enregistreurs de donnes commence l'aide de yFirstDataLogger().
YDataLogger nextDataLogger( ) Retourne : un pointeur sur un objet YDataLogger accessible en ligne, ou null lorsque l'numration est termine.
www.yoctopuce.com
59
datalogger.registerValueCallback()
datalogger.set_autoStart()
Modifie le mode d'activation automatique de l'enregistreur de donnes la mise sous tension.
int set_autoStart( int newval)
Paramtres : newval soit Y_AUTOSTART_OFF, soit Y_AUTOSTART_ON, selon le mode d'activation automatique de l'enregistreur de donnes la mise sous tension Retourne :

datalogger.set_logicalName()
Modifie le nom logique de l'enregistreur de donnes.
Paramtres : newval une chane de caractres reprsentant le nom logique de l'enregistreur de donnes Retourne :

datalogger.set_recording()
Modifie l'tat d'activation de l'enregistreur de donnes.
int set_recording( int newval) Paramtres :
www.yoctopuce.com
60
newval soit Y_RECORDING_OFF, soit Y_RECORDING_ON, selon l'tat d'activation de l'enregistreur de donnes Retourne :

datalogger.set_timeUTC()
Modifie la rfrence de temps UTC, afin de l'attacher aux donnes enregistres.
int set_timeUTC( int newval) Paramtres : newval un entier reprsentant la rfrence de temps UTC, afin de l'attacher aux donnes enregistres Retourne :

datalogger.set_userData()
3.7. Squence de donnes mise en forme

Un Run est un intervalle de temps pendant lequel un module est sous tension. Les objets YDataRun fournissent un accs facilit toutes les mesures collectes durant un Run donn, y compris en permettant la lecture par mesure distantes d'un intervalle spcifi. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_datalogger.cs
Mthodes des objets YDataRun

datarunget_averageValue(measureName, pos) Retourne la valeur moyenne des mesures observes au moment choisi. datarunget_duration() Retourne la dure (en secondes) du Run. datarunget_maxValue(measureName, pos) Retourne la valeur maximale des mesures observes au moment choisi. datarunget_measureNames() Retourne les noms des valeurs mesures par l'enregistreur de donnes. datarunget_minValue(measureName, pos) Retourne la valeur minimale des mesures observes au moment choisi. datarunget_startTimeUTC()
www.yoctopuce.com
61
Retourne l'heure absolue du dbut du Run, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix). datarunget_valueCount() Retourne le nombre de valeurs accessibles dans ce Run, tant donn l'intervalle de temps choisi entre les valeurs. datarunget_valueInterval() Retourne l'intervalle de temps reprsent par chaque valeur de ce run. datarunset_valueInterval(valueInterval) Change l'intervalle de temps reprsent par chaque valeur de ce run.
Retourne la valeur moyenne des mesures observes au moment choisi.
Paramtres : measureName le nom de la mesure dsire (un des noms retourns par get_measureNames) pos l'index de la position dsire, entre 0 et la valeur de get_valueCount Retourne : une nombre flottant (la valeur moyenne).
En cas d'erreur, dclenche une exception ou retourne Y_AVERAGEVALUE_INVALID. Retourne la dure (en secondes) du Run.
Lorsque cette mthode est appelle dur le Run courant et que l'enregistreur de donnes est actif, l'appel cette mthode force un rechargement de la dernire squence du module pour s'assurer que la rponse prend en compte les dernires donnes enregistres.
Retourne : un entier positif correspondant au nombre de secondes coules entre le dbut du Run (quand le module a t mis sous tension) et la dernire mesure enregistre.
Retourne la valeur maximale des mesures observes au moment choisi.
Paramtres : measureName le nom de la mesure dsire (un des noms retourns par get_measureNames) pos l'index de la position dsire, entre 0 et la valeur de get_valueCount Retourne : une nombre flottant (la valeur maximale).
En cas d'erreur, dclenche une exception ou retourne Y_MAXVALUE_INVALID. Retourne les noms des valeurs mesures par l'enregistreur de donnes.
Dans la plupart des cas, le nom des colonnes correspond l'identifiant matriel du capteur qui a produit la mesure.
Retourne : une liste de chane de caractres (les noms des mesures)
En cas d'erreur, dclenche une exception ou retourne une liste vide. Retourne la valeur minimale des mesures observes au moment choisi.
Paramtres : measureName le nom de la mesure dsire (un des noms retourns par get_measureNames) pos l'index de la position dsire, entre 0 et la valeur de get_valueCount Retourne : une nombre flottant (la valeur minimale).
En cas d'erreur, dclenche une exception ou retourne Y_MINVALUE_INVALID. Retourne l'heure absolue du dbut du Run, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix). Si l'heure UTC n'a jamais t configure dans l'enregistreur de donnes durant le run, et si il ne s'agit pas du run courant, cette mthode retourne 0.
Retourne : un entier positif correspondant au nombre de secondes coules entre le 1er janvier 1970 et le dbut du Run.
Retourne le nombre de valeurs accessibles dans ce Run, tant donn l'intervalle de temps choisi entre les valeurs.
Lorsque cette mthode est appelle dur le Run courant et que l'enregistreur de donnes est actif, l'appel cette mthode force un rechargement de la dernire squence du module pour s'assurer que la rponse prend en compte les dernires donnes enregistres.
Retourne : un entier positif correspondant la dure du Run divise par l'intervalle entre les valeurs.
Retourne l'intervalle de temps reprsent par chaque valeur de ce run.
La valeur par dfaut correspond la plus grande granularit des mesures archives dans la flash de l'enregistreur de donnes pour ce Run, mais l'intervalle utiliser peut tre configur librement si dsir.
Retourne : un entier positif correspondant au nombre de secondes couvertes par chaque valeur reprsente dans le Run.
Change l'intervalle de temps reprsent par chaque valeur de ce run.
La valeur par dfaut correspond la plus grande granularit des mesures archives dans la flash de l'enregistreur de donnes pour ce Run, mais l'intervalle utiliser peut tre configur librement si dsir.
Paramtres : valueInterval un nombre entier de secondes. Retourne : nothing
3.8. Squence de donnes enregistres

Les objets DataStream reprsentent des squences de mesures enregistres. Ils sont retourns par l'enregistreur de donnes prsent dans les senseurs de Yoctopuce.
www.yoctopuce.com
63
Pour utiliser les fonctions dcrites ici, vous devez inclure:

yocto_datalogger.cs
Mthodes des objets YDataStream

datastreamget_columnCount() Retourne le nombre de colonnes de donnes contenus dans la squence. datastreamget_columnNames() Retourne le nom (la smantique) des colonnes de donnes contenus dans la squence. datastreamget_data(row, col) Retourne une mesure unique de la squence, spcifie par l'index de l'enregistrement (ligne) et de la mesure (colonne). datastreamget_dataRows() Retourne toutes les donnes mesures contenues dans la squence, sous forme d'une liste de vecteurs (table bidimensionnelle). datastreamget_dataSamplesInterval() Retourne le nombre de secondes entre chaque mesure de la squence. datastreamget_rowCount() Retourne le nombre d'enregistrement contenus dans la squence. datastreamget_runIndex() Retourne le numro de Run de la squence de donnes. datastreamget_startTime() Retourne le nombre de secondes entre le dbut du Run (mise sous tension du module) et le dbut de la squence de donnes. datastreamget_startTimeUTC() Retourne l'heure absolue du dbut de la squence de donnes, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix).
datastream.get_columnCount()
Retourne le nombre de colonnes de donnes contenus dans la squence.
int get_columnCount( )
La smantique des donnes prsentes dans chaque colonne peut tre obtenue l'aide de la mthode get_columnNames(). Cette mthode dclanche le chargement de toutes les donnes de la squence, si cela n'tait pas encore fait.
Retourne : un entier positif correspondant au nombre de colonnes.
En cas d'erreur, dclenche une exception ou retourne zro.
datastream.get_columnNames()
Retourne le nom (la smantique) des colonnes de donnes contenus dans la squence.
List<string> get_columnNames( )
Dans la plupart des cas, le nom des colonnes correspond l'identifiant matriel du capteur qui a produit la mesure. Pour les squences d'archivage rsumant des squence, un suffixe est ajout l'identifiant du capteur: _min pour la valeur minimale, _avg pour la valeur moyenne et _max pour la valeur maximale.
www.yoctopuce.com
64
Cette mthode dclanche le chargement de toutes les donnes de la squence, si cela n'tait pas encore fait.
Retourne : une liste de chane de caractres.
datastream.get_data()
Retourne une mesure unique de la squence, spcifie par l'index de l'enregistrement (ligne) et de la mesure (colonne).
double get_data( int row, int col)
La smentique des donnes prsentes dans chaque colonne peut tre obtenue l'aide de la mthode get_columnNames(). Cette mthode dclanche le chargement de toutes les donnes de la squence, si cela n'tait pas encore fait.
Paramtres : row index de l'enregistrement (ligne) col index de la mesure (colonne) Retourne : un nombre dcimal
En cas d'erreur, dclenche une exception ou retourne Y_DATA_INVALID. Retourne toutes les donnes mesures contenues dans la squence, sous forme d'une liste de vecteurs (table bidimensionnelle).
La smentique des donnes prsentes dans chaque colonne peut tre obtenue l'aide de la mthode get_columnNames(). Cette mthode dclanche le chargement de toutes les donnes de la squence, si cela n'tait pas encore fait.
Retourne : une liste d'enregistrements, chaque enregistrement tant lui-mme une liste de nombres dcimaux.
datastream.get_dataSamplesInterval()
Retourne le nombre de secondes entre chaque mesure de la squence.
int get_dataSamplesInterval( )
Par dfaut, l'enregistreur mmorise une mesure par seconde, mais la cration de squences d'archive synthtisant de plus longue priode peut produire des squences plus espaces. Cette mthode ne provoque pas d'accs au module, les donnes tant prcharges dans l'objet au moment o il est instanci.
Retourne : un entier positif correspondant au nombre de secondes entre deux mesures conscutives.
datastream.get_rowCount()
Retourne le nombre d'enregistrement contenus dans la squence.
www.yoctopuce.com
65
int get_rowCount( )
Cette mthode dclanche le chargement de toutes les donnes de la squence, si cela n'tait pas encore fait.
Retourne : un entier positif correspondant au nombre d'enregistrements.
En cas d'erreur, dclenche une exception ou retourne zro.
datastream.get_runIndex()
Retourne le numro de Run de la squence de donnes.
int get_runIndex( )
Un Run peut tre compos de plusieurs squences, couvrant diffrents intervalles de temps. Cette mthode ne provoque pas d'accs au module, les donnes tant prcharges dans l'objet au moment o il est instanci.
Retourne : un entier positif correspondant au numro du Run
datastream.get_startTime()
Retourne le nombre de secondes entre le dbut du Run (mise sous tension du module) et le dbut de la squence de donnes.
int get_startTime( )
Si
vous
dsirez
obtenir
l'heure
absolue
du
dbut
de
la
squence,
utilisez
get_startTimeUTC().
Cette mthode ne provoque pas d'accs au module, les donnes tant prcharges dans l'objet au moment o il est instanci.
Retourne : un entier positif correspondant au nombre de secondes coules entre le dbut du Run et le dbut de la squence enregistre.
datastream.get_startTimeUTC()
Retourne l'heure absolue du dbut de la squence de donnes, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix).
long get_startTimeUTC( )
Si l'heure UTC n'tait pas configure dans l'enregistreur de donnes au dbut de la squence, cette mthode retourne 0. Cette mthode ne provoque pas d'accs au module, les donnes tant prcharges dans l'objet au moment o il est instanci.
Retourne : un entier positif correspondant au nombre de secondes coules entre le 1er janvier 1970 et le dbut de la squence enregistre.
3.9. Interface de contrle de l'alimentation

La librairie de programmation Yoctopuce permet de contrler la source d'alimentation qui doit tre utilise pour les fonctions du module consommant beaucoup de courant. Le module est
www.yoctopuce.com
66
par ailleurs capable de couper automatiquement l'alimentation externe lorsqu'il dtecte que la tension a trop chut (batterie puise). Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_dualpower.cs
Fonction globales
yFindDualPower(func) Permet de retrouver un contrle d'alimentation d'aprs un identifiant donn. yFirstDualPower() Commence l'numration des contrles d'alimentation accessibles par la librairie.
Mthodes des objets YDualPower

dualpowerdescribe() Retourne un court texte dcrivant la fonction. dualpowerget_advertisedValue() Retourne la valeur courante du contrle d'alimentation (pas plus de 6 caractres). dualpowerget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. dualpowerget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. dualpowerget_extVoltage() Retourne la tension mesure sur l'alimentation de puissance externe, en millivolts. dualpowerget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. dualpowerget_hardwareId() Retourne l'identifiant unique de la fonction. dualpowerget_logicalName() Retourne le nom logique du contrle d'alimentation. dualpowerget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. dualpowerget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. dualpowerget_powerControl() Retourne le mode d'alimentation choisi pour les fonctions du module consommant beaucoup de courant. dualpowerget_powerState() Retourne la source d'alimentation active pour les fonctions du module consommant beaucoup de courant. dualpowerget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. dualpowerisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. dualpowerisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. dualpowerload(msValidity)
www.yoctopuce.com
67
Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. dualpowerload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. dualpowernextDualPower() Continue l'numration
des
contrles
d'alimentation
commence
l'aide
de
yFirstDualPower().
dualpowerregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. dualpowerset_logicalName(newval) Modifie le nom logique du contrle d'alimentation. dualpowerset_powerControl(newval) Modifie le mode d'alimentation choisi pour les fonctions du module consommant beaucoup de courant. dualpowerset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YDualPower.FindDualPower()
Permet de retrouver un contrle d'alimentation d'aprs un identifiant donn.
YDualPower FindDualPower( string func)
Cette fonction n'exige pas que le contrle d'alimentation soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YDualPower.isOnline() pour tester si le contrle d'alimentation est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le contrle d'alimentation sans ambigut Retourne : un objet de classe YDualPower qui permet ensuite de contrler le contrle d'alimentation.
YDualPower.FirstDualPower()
Commence l'numration des contrles d'alimentation accessibles par la librairie.
YDualPower FirstDualPower( )
Utiliser la fonction YDualPower.nextDualPower() pour itrer sur les autres contrles d'alimentation.
Retourne : un pointeur sur un objet YDualPower, correspondant le premier contrle d'alimentation accessible en ligne, ou null si il n'y a pas de contrles d'alimentation disponibles.
www.yoctopuce.com
68
dualpower.describe()
string describe( )
dualpower.get_advertisedValue()
Retourne la valeur courante du contrle d'alimentation (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du contrle d'alimentation (pas plus de 6 caractres)
dualpower.get_errorMessage()
dualpower.get_errorType()
dualpower.get_extVoltage()
Retourne la tension mesure sur l'alimentation de puissance externe, en millivolts.
int get_extVoltage( ) Retourne : un entier reprsentant la tension mesure sur l'alimentation de puissance externe, en millivolts
En cas d'erreur, dclenche une exception ou retourne Y_EXTVOLTAGE_INVALID.
www.yoctopuce.com
69
dualpower.get_dualpowerDescriptor()
dualpower.get_hardwareId()
dualpower.get_logicalName()
Retourne le nom logique du contrle d'alimentation.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du contrle d'alimentation
dualpower.get_module()
Paramtres :
www.yoctopuce.com
70
callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et l'instance demande de YModule context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
dualpower.get_powerControl()
Retourne le mode d'alimentation choisi pour les fonctions du module consommant beaucoup de courant.
int get_powerControl( ) Retourne : une valeur
parmi Y_POWERCONTROL_AUTO, Y_POWERCONTROL_FROM_USB, Y_POWERCONTROL_FROM_EXT et Y_POWERCONTROL_OFF reprsentant le mode d'alimentation choisi pour les fonctions du module consommant beaucoup de courant
En cas d'erreur, dclenche une exception ou retourne Y_POWERCONTROL_INVALID.
dualpower.get_powerState()
Retourne la source d'alimentation active pour les fonctions du module consommant beaucoup de courant.
int get_powerState( ) Retourne : une valeur
parmi Y_POWERSTATE_OFF, Y_POWERSTATE_FROM_USB et Y_POWERSTATE_FROM_EXT reprsentant la source d'alimentation active pour les fonctions du module consommant beaucoup de courant
En cas d'erreur, dclenche une exception ou retourne Y_POWERSTATE_INVALID.
dualpower.get_userData()
dualpower.isOnline()
bool isOnline( )
www.yoctopuce.com
71
dualpower.load()
www.yoctopuce.com
72
dualpower.nextDualPower()
Continue l'numration des contrles d'alimentation commence l'aide de
yFirstDualPower().
YDualPower nextDualPower( ) Retourne : un pointeur sur un objet YDualPower accessible en ligne, ou null lorsque l'numration est termine.
dualpower.registerValueCallback()
dualpower.set_logicalName()
Modifie le nom logique du contrle d'alimentation.
Paramtres : newval une chane de caractres reprsentant le nom logique du contrle d'alimentation Retourne :

dualpower.set_powerControl()
Modifie le mode d'alimentation choisi pour les fonctions du module consommant beaucoup de courant.
int set_powerControl( int newval) Paramtres : newval une valeur parmi Y_POWERCONTROL_AUTO, Y_POWERCONTROL_FROM_USB, Y_POWERCONTROL_FROM_EXT et Y_POWERCONTROL_OFF reprsentant le mode d'alimentation choisi pour les fonctions du module consommant beaucoup de courant Retourne :

dualpower.set_userData()
3.10. Interface d'un port de Yocto-hub

yocto_hubport.cs
Fonction globales
yFindHubPort(func) Permet de retrouver un port de Yocto-hub d'aprs un identifiant donn. yFirstHubPort() Commence l'numration des port de Yocto-hub accessibles par la librairie.
Mthodes des objets YHubPort

hubportdescribe() Retourne un court texte dcrivant la fonction. hubportget_advertisedValue() Retourne la valeur courante du port de Yocto-hub (pas plus de 6 caractres). hubportget_baudRate() Retourne la vitesse de transfert utilise par le port de Yocto-hub, en kbps. hubportget_enabled() Retourne vrai si le port du Yocto-hub est aliment, faux sinon. hubportget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. hubportget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. hubportget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. hubportget_hardwareId() Retourne l'identifiant unique de la fonction. hubportget_logicalName() Retourne le nom logique du port de Yocto-hub, qui est toujours le numro de srie du module qui y est connect. hubportget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. hubportget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. hubportget_portState()
www.yoctopuce.com
74
Retourne l'tat actuel du port de Yocto-hub. hubportget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. hubportisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. hubportisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. hubportload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. hubportload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. hubportnextHubPort() Continue l'numration des port de Yocto-hub commence l'aide de yFirstHubPort(). hubportregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. hubportset_enabled(newval) Modifie le mode d'activation du port du Yocto-hub. hubportset_logicalName(newval) Il n'est pas possible de configurer le nom logique d'un port de Yocto-hub. hubportset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YHubPort.FindHubPort()
Permet de retrouver un port de Yocto-hub d'aprs un identifiant donn.
YHubPort FindHubPort( string func)
Cette fonction n'exige pas que le port de Yocto-hub soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YHubPort.isOnline () pour tester si le port de Yocto-hub est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le port de Yocto-hub sans ambigut Retourne : un objet de classe YHubPort qui permet ensuite de contrler le port de Yocto-hub.
YHubPort.FirstHubPort()
Commence l'numration des port de Yocto-hub accessibles par la librairie.
YHubPort FirstHubPort( )
Utiliser la fonction YHubPort.nextHubPort() pour itrer sur les autres port de Yocto-hub.
Retourne : un pointeur sur un objet YHubPort, correspondant le premier port de Yocto-hub accessible en ligne, ou null si il n'y a pas de port de Yocto-hub disponibles.
hubport.describe()
string describe( )
hubport.get_advertisedValue()
Retourne la valeur courante du port de Yocto-hub (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du port de Yocto-hub (pas plus de 6 caractres)
hubport.get_baudRate()
Retourne la vitesse de transfert utilise par le port de Yocto-hub, en kbps.
int get_baudRate( )
La valeur par dfaut est 1000 kbps, une valeur infrieure rvle des problmes de communication.
Retourne : un entier reprsentant la vitesse de transfert utilise par le port de Yocto-hub, en kbps
En cas d'erreur, dclenche une exception ou retourne Y_BAUDRATE_INVALID.
hubport.get_enabled()
Retourne vrai si le port du Yocto-hub est aliment, faux sinon.
int get_enabled( ) Retourne : soit Y_ENABLED_FALSE, soit Y_ENABLED_TRUE, selon vrai si le port du Yocto-hub est aliment, faux sinon
En cas d'erreur, dclenche une exception ou retourne Y_ENABLED_INVALID.
hubport.get_errorMessage()
hubport.get_errorType()
hubport.get_hubportDescriptor()
hubport.get_hardwareId()
hubport.get_logicalName()
Retourne le nom logique du port de Yocto-hub, qui est toujours le numro de srie du module qui y est connect.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du port de Yocto-hub, qui est toujours le numro de srie du module qui y est connect
www.yoctopuce.com
77
hubport.get_module()
hubport.get_portState()
Retourne l'tat actuel du port de Yocto-hub.
int get_portState( ) Retourne : une valeur parmi Y_PORTSTATE_OFF, Y_PORTSTATE_ON et Y_PORTSTATE_RUN reprsentant l'tat actuel du port de Yocto-hub
En cas d'erreur, dclenche une exception ou retourne Y_PORTSTATE_INVALID.
hubport.get_userData()
hubport.isOnline()
www.yoctopuce.com
78
bool isOnline( )
hubport.load()
Paramtres :
www.yoctopuce.com
79
msValidity un entier correspondant la dure de validit attribue aux les paramtres chargs, en millisecondes callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le code d'erreur (ou YAPI_SUCCESS) context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
hubport.nextHubPort()
Continue l'numration des port de Yocto-hub commence l'aide de yFirstHubPort ().
YHubPort nextHubPort( ) Retourne : un pointeur sur un objet YHubPort accessible en ligne, ou null lorsque l'numration est termine.
hubport.registerValueCallback()
hubport.set_enabled()
Modifie le mode d'activation du port du Yocto-hub.
int set_enabled( int newval)
Si le port est actif, il * sera aliment. Sinon, l'alimentation du module est coupe.
Paramtres : newval soit Y_ENABLED_FALSE, soit Y_ENABLED_TRUE, selon le mode d'activation du port du Yocto-hub Retourne :

hubport.set_logicalName()
Il n'est pas possible de configurer le nom logique d'un port de Yocto-hub.
www.yoctopuce.com
80
Son nom est automatiquement configur comme le numro de srie du module qui y est connect.
Paramtres : newval une chane de caractres Retourne :

hubport.set_userData()
3.11. Interface de la fonction Humidity

yocto_humidity.cs
Fonction globales
yFindHumidity(func) Permet de retrouver un capteur d'humidit d'aprs un identifiant donn. yFirstHumidity() Commence l'numration des capteurs d'humidit accessibles par la librairie.
Mthodes des objets YHumidity

humiditycalibrateFromPoints(rawValues, refValues) Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur. humiditydescribe() Retourne un court texte dcrivant la fonction. humidityget_advertisedValue() Retourne la valeur courante du capteur d'humidit (pas plus de 6 caractres). humidityget_currentRawValue() Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration). humidityget_currentValue() Retourne la valeur mesure actuelle. humidityget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. humidityget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction.
www.yoctopuce.com
81
humidityget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. humidityget_hardwareId() Retourne l'identifiant unique de la fonction. humidityget_highestValue() Retourne la valeur maximale observe. humidityget_logicalName() Retourne le nom logique du capteur d'humidit. humidityget_lowestValue() Retourne la valeur minimale observe. humidityget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. humidityget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. humidityget_resolution() Retourne la rsolution des valeurs mesures. humidityget_unit() Retourne l'unit dans laquelle la valeur mesure est exprime. humidityget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. humidityisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. humidityisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. humidityload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. humidityload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. humiditynextHumidity() Continue l'numration des capteurs d'humidit commence l'aide de yFirstHumidity(). humidityregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. humidityset_highestValue(newval) Modifie la mmoire de valeur maximale observe. humidityset_logicalName(newval) Modifie le nom logique du capteur d'humidit. humidityset_lowestValue(newval) Modifie la mmoire de valeur minimale observe. humidityset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
www.yoctopuce.com
82
YHumidity.FindHumidity()
Permet de retrouver un capteur d'humidit d'aprs un identifiant donn.
YHumidity FindHumidity( string func)
Cette fonction n'exige pas que le capteur d'humidit soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YHumidity.isOnline () pour tester si le capteur d'humidit est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le capteur d'humidit sans ambigut Retourne : un objet de classe YHumidity qui permet ensuite de contrler le capteur d'humidit.
YHumidity.FirstHumidity()
Commence l'numration des capteurs d'humidit accessibles par la librairie.
YHumidity FirstHumidity( )
Utiliser la fonction YHumidity.nextHumidity() pour itrer sur les autres capteurs d'humidit.
Retourne : un pointeur sur un objet YHumidity, correspondant le premier capteur d'humidit accessible en ligne, ou null si il n'y a pas de capteurs d'humidit disponibles.
humidity.calibrateFromPoints()

humidity.describe()
string describe( )
humidity.get_advertisedValue()
Retourne la valeur courante du capteur d'humidit (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du capteur d'humidit (pas plus de 6 caractres)
humidity.get_currentRawValue()
humidity.get_currentValue()
humidity.get_errorMessage()
www.yoctopuce.com
84
humidity.get_errorType()
humidity.get_humidityDescriptor()
humidity.get_hardwareId()
humidity.get_highestValue()
humidity.get_logicalName()
Retourne le nom logique du capteur d'humidit.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du capteur d'humidit
www.yoctopuce.com
85
humidity.get_lowestValue()
humidity.get_module()
humidity.get_resolution()
humidity.get_unit()
www.yoctopuce.com
86
humidity.get_userData()
humidity.isOnline()
bool isOnline( )
humidity.load()
Par dfaut, lorsqu'on accde un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dure standard (5 ms). Cette mthode peut tre
www.yoctopuce.com
87
utilise pour marquer occasionellement les donnes caches comme valides pour une plus longue priode, par exemple dans le but de rduire le trafic rseau.
humidity.nextHumidity()
Continue l'numration des capteurs d'humidit commence l'aide de
yFirstHumidity().
YHumidity nextHumidity( ) Retourne : un pointeur sur un objet YHumidity accessible en ligne, ou null lorsque l'numration est termine.
humidity.registerValueCallback()
www.yoctopuce.com
88
humidity.set_highestValue()

humidity.set_logicalName()
Modifie le nom logique du capteur d'humidit.
Paramtres : newval une chane de caractres reprsentant le nom logique du capteur d'humidit Retourne :

humidity.set_lowestValue()

humidity.set_userData()
www.yoctopuce.com
89
3.12. Interface de la fonction Led

La librairie de programmation Yoctopuce permet non seulement d'allumer la led une intensit donne, mais aussi de la faire osciller plusieurs frquences. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_led.cs
Fonction globales
yFindLed(func) Permet de retrouver une led d'aprs un identifiant donn. yFirstLed() Commence l'numration des leds accessibles par la librairie.
Mthodes des objets YLed

leddescribe() Retourne un court texte dcrivant la fonction. ledget_advertisedValue() Retourne la valeur courante de la led (pas plus de 6 caractres). ledget_blinking() Retourne le mode de signalisation de la led. ledget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. ledget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. ledget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. ledget_hardwareId() Retourne l'identifiant unique de la fonction. ledget_logicalName() Retourne le nom logique de la led. ledget_luminosity() Retourne l'intensit de la led en pour cent. ledget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. ledget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. ledget_power() Retourne l'tat courant de la led. ledget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. ledisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. ledisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. ledload(msValidity)
www.yoctopuce.com
90
Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. ledload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. lednextLed() Continue l'numration des leds commence l'aide de yFirstLed(). ledregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. ledset_blinking(newval) Modifie le mode de signalisation de la led. ledset_logicalName(newval) Modifie le nom logique de la led. ledset_luminosity(newval) Modifie l'intensit lumineuse de la led (en pour cent). ledset_power(newval) Modifie l'tat courant de la led. ledset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YLed.FindLed()
Permet de retrouver une led d'aprs un identifiant donn.
YLed FindLed( string func)
Cette fonction n'exige pas que la led soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YLed.isOnline() pour tester si la led est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence la led sans ambigut Retourne : un objet de classe YLed qui permet ensuite de contrler la led.
YLed.FirstLed()
Commence l'numration des leds accessibles par la librairie.
YLed FirstLed( )
Utiliser la fonction YLed.nextLed() pour itrer sur les autres leds.

Retourne :
www.yoctopuce.com
91
un pointeur sur un objet YLed, correspondant la premire led accessible en ligne, ou null si il n'y a pas de leds disponibles.
led.describe()
string describe( )
led.get_advertisedValue()
Retourne la valeur courante de la led (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante de la led (pas plus de 6 caractres)
led.get_blinking()
Retourne le mode de signalisation de la led.
int get_blinking( ) Retourne : une valeur parmi Y_BLINKING_STILL, Y_BLINKING_RELAX, Y_BLINKING_AWARE, Y_BLINKING_RUN, Y_BLINKING_CALL et Y_BLINKING_PANIC reprsentant le mode de signalisation de la led
En cas d'erreur, dclenche une exception ou retourne Y_BLINKING_INVALID.
led.get_errorMessage()
led.get_errorType()
www.yoctopuce.com
92
led.get_ledDescriptor()
led.get_hardwareId()
led.get_logicalName()
Retourne le nom logique de la led.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique de la led
led.get_luminosity()
Retourne l'intensit de la led en pour cent.
int get_luminosity( ) Retourne : un entier reprsentant l'intensit de la led en pour cent
En cas d'erreur, dclenche une exception ou retourne Y_LUMINOSITY_INVALID.
led.get_module()
led.get_power()
Retourne l'tat courant de la led.
int get_power( ) Retourne : soit Y_POWER_OFF, soit Y_POWER_ON, selon l'tat courant de la led
En cas d'erreur, dclenche une exception ou retourne Y_POWER_INVALID.
led.get_userData()
led.isOnline()
bool isOnline( )
www.yoctopuce.com
94
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considr joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vrification de joignabilit. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
led.load()
led.nextLed()
Continue l'numration des leds commence l'aide de yFirstLed().
www.yoctopuce.com
95
YLed nextLed( ) Retourne : un pointeur sur un objet YLed accessible en ligne, ou null lorsque l'numration est termine.
led.registerValueCallback()
led.set_blinking()
Modifie le mode de signalisation de la led.
int set_blinking( int newval) Paramtres : newval une
valeur parmi Y_BLINKING_STILL, Y_BLINKING_RELAX, Y_BLINKING_AWARE, Y_BLINKING_RUN, Y_BLINKING_CALL et Y_BLINKING_PANIC reprsentant le mode de signalisation de la led
Retourne :

led.set_logicalName()
Modifie le nom logique de la led.
Paramtres : newval une chane de caractres reprsentant le nom logique de la led Retourne :

led.set_luminosity()
Modifie l'intensit lumineuse de la led (en pour cent).
www.yoctopuce.com
96
int set_luminosity( int newval) Paramtres : newval un entier reprsentant l'intensit lumineuse de la led (en pour cent) Retourne :

led.set_power()
Modifie l'tat courant de la led.
int set_power( int newval) Paramtres : newval soit Y_POWER_OFF, soit Y_POWER_ON, selon l'tat courant de la led Retourne :

led.set_userData()
3.13. Interface de la fonction LightSensor

yocto_lightsensor.cs
Fonction globales
yFindLightSensor(func) Permet de retrouver un capteur de lumire d'aprs un identifiant donn. yFirstLightSensor() Commence l'numration des capteurs de lumire accessibles par la librairie.
Mthodes des objets YLightSensor

lightsensorcalibrate(calibratedVal) Modifie le paramtre de calibration spcifique du senseur de sorte ce que la valeur actuelle corresponde une consigne donne (correction linaire). lightsensorcalibrateFromPoints(rawValues, refValues) Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur. lightsensordescribe()
www.yoctopuce.com
97
Retourne un court texte dcrivant la fonction. lightsensorget_advertisedValue() Retourne la valeur courante du capteur de lumire (pas plus de 6 caractres). lightsensorget_currentRawValue() Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration). lightsensorget_currentValue() Retourne la valeur mesure actuelle. lightsensorget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. lightsensorget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. lightsensorget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. lightsensorget_hardwareId() Retourne l'identifiant unique de la fonction. lightsensorget_highestValue() Retourne la valeur maximale observe. lightsensorget_logicalName() Retourne le nom logique du capteur de lumire. lightsensorget_lowestValue() Retourne la valeur minimale observe. lightsensorget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. lightsensorget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. lightsensorget_resolution() Retourne la rsolution des valeurs mesures. lightsensorget_unit() Retourne l'unit dans laquelle la valeur mesure est exprime. lightsensorget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. lightsensorisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. lightsensorisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. lightsensorload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. lightsensorload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. lightsensornextLightSensor() Continue l'numration des yFirstLightSensor().
capteurs
de
lumire
commence
l'aide
de
www.yoctopuce.com
98
lightsensorregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. lightsensorset_highestValue(newval) Modifie la mmoire de valeur maximale observe. lightsensorset_logicalName(newval) Modifie le nom logique du capteur de lumire. lightsensorset_lowestValue(newval) Modifie la mmoire de valeur minimale observe. lightsensorset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YLightSensor.FindLightSensor()
Permet de retrouver un capteur de lumire d'aprs un identifiant donn.
YLightSensor FindLightSensor( string func)
Cette fonction n'exige pas que le capteur de lumire soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YLightSensor.isOnline() pour tester si le capteur de lumire est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le capteur de lumire sans ambigut Retourne : un objet de classe YLightSensor qui permet ensuite de contrler le capteur de lumire.
YLightSensor.FirstLightSensor()
Commence l'numration des capteurs de lumire accessibles par la librairie.
YLightSensor FirstLightSensor( )
Utiliser la fonction YLightSensor.nextLightSensor() pour itrer sur les autres capteurs de lumire.
Retourne : un pointeur sur un objet YLightSensor, correspondant le premier capteur de lumire accessible en ligne, ou null si il n'y a pas de capteurs de lumire disponibles.
lightsensor.calibrate()
Modifie le paramtre de calibration spcifique du senseur de sorte ce que la valeur actuelle corresponde une consigne donne (correction linaire).
int calibrate( double calibratedVal)
www.yoctopuce.com
99
Paramtres : calibratedVal
la consigne de valeur dsire.
Retourne :

lightsensor.calibrateFromPoints()

lightsensor.describe()
string describe( )
lightsensor.get_advertisedValue()
Retourne la valeur courante du capteur de lumire (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du capteur de lumire (pas plus de 6 caractres)
lightsensor.get_currentRawValue()
lightsensor.get_currentValue()
lightsensor.get_errorMessage()
lightsensor.get_errorType()
lightsensor.get_lightsensorDescriptor()
lightsensor.get_hardwareId()
lightsensor.get_highestValue()
lightsensor.get_logicalName()
Retourne le nom logique du capteur de lumire.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du capteur de lumire
lightsensor.get_lowestValue()
lightsensor.get_module()
Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. Si la fonction ne peut tre trouve sur aucun module, l'instance de YModule retourne ne sera pas joignable.
www.yoctopuce.com
102
Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
lightsensor.get_resolution()
lightsensor.get_unit()
lightsensor.get_userData()
lightsensor.isOnline()
bool isOnline( )
Retourne :
www.yoctopuce.com
103
true si la fonction est joignable, false sinon

lightsensor.load()
lightsensor.nextLightSensor()
Continue l'numration des capteurs de lumire commence l'aide de
yFirstLightSensor().
YLightSensor nextLightSensor( ) Retourne : un pointeur sur un objet YLightSensor accessible en ligne, ou null lorsque l'numration est termine.
lightsensor.registerValueCallback()
lightsensor.set_highestValue()

lightsensor.set_logicalName()
Modifie le nom logique du capteur de lumire.
Paramtres : newval une chane de caractres reprsentant le nom logique du capteur de lumire Retourne :

www.yoctopuce.com
105
lightsensor.set_lowestValue()

lightsensor.set_userData()
3.14. Interface de contrle du module

Cette interface est la mme pour tous les modules USB de Yoctopuce. Elle permet de contrler les paramtres gnraux du module, et d'numrer les fonctions fournies par chaque module. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_api.cs
Fonction globales
yFindModule(func) Permet de retrouver un module d'aprs son numro de srie ou son nom logique. yFirstModule() Commence l'numration des modules accessibles par la librairie.
Mthodes des objets YModule

moduledescribe() Retourne un court texte dcrivant le module. modulefunctionCount() Retourne le nombre de fonctions (sans compter l'interface "module") existant sur le module. modulefunctionId(functionIndex) Retourne l'identifiant matriel de la nime fonction du module. modulefunctionName(functionIndex) Retourne le nom logique de la nime fonction du module. modulefunctionValue(functionIndex) Retourne la valeur publie par la nime fonction du module. moduleget_beacon() Retourne l'tat de la balise de localisation.
www.yoctopuce.com
106
moduleget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de l'objet module. moduleget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de l'objet module. moduleget_firmwareRelease() Retourne la version du logiciel embarqu du module. moduleget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. moduleget_hardwareId() Retourne l'identifiant unique du module. moduleget_icon2d() Retourne l'icone du module. moduleget_logicalName() Retourne le nom logique du module. moduleget_luminosity() Retourne la luminosit des leds informatives du module (valeur entre 0 et 100). moduleget_persistentSettings() Retourne l'tat courant des rglages persistents du module. moduleget_productId() Retourne l'identifiant USB du module, prprogramm en usine. moduleget_productName() Retourne le nom commercial du module, prprogramm en usine. moduleget_productRelease() Retourne le numro de version matriel du module, prprogramm en usine. moduleget_rebootCountdown() Retourne le nombre de secondes restantes avant un redmarrage du module, ou zro si aucun redmarrage n'a t agend. moduleget_serialNumber() Retourne le numro de srie du module, prprogramm en usine. moduleget_upTime() Retourne le numbre de millisecondes coules depuis la mise sous tension du module moduleget_usbBandwidth() Retourne le nombre d'interface USB utilis par le module. moduleget_usbCurrent() Retourne le courant consomm par le module sur le bus USB, en milliampres. moduleget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. moduleisOnline() Vrifie si le module est joignable, sans dclencher d'erreur. moduleisOnline_async(callback, context) Vrifie si le module est joignable, sans dclencher d'erreur. moduleload(msValidity)
www.yoctopuce.com
107
Met en cache les valeurs courantes du module, avec une dure de validit spcifie. moduleload_async(msValidity, callback, context) Met en cache les valeurs courantes du module, avec une dure de validit spcifie. modulenextModule() Continue l'numration des modules commence l'aide de yFirstModule(). modulereboot(secBeforeReboot) Agende un simple redmarrage du module dans un nombre donn de secondes. modulerevertFromFlash() Recharge les rglages stocks dans le mmoire non volatile du module, comme la mise sous tension du module. modulesaveToFlash() Sauve les rglages courants dans la mmoire non volatile du module. moduleset_beacon(newval) Allume ou teint la balise de localisation du module. moduleset_logicalName(newval) Change le nom logique du module. moduleset_luminosity(newval) Modifie la luminosit des leds informatives du module. moduleset_usbBandwidth(newval) Modifie le nombre d'interface USB utilis par le module. moduleset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData. moduletriggerFirmwareUpdate(secBeforeReboot) Agende un redmarrage du module en mode spcial de reprogrammation du logiciel embarqu.
YModule.FindModule()
Permet de retrouver un module d'aprs son numro de srie ou son nom logique.
YModule FindModule( string func)
Cette fonction n'exige pas que le module soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YModule.isOnline() pour tester si le module est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres contenant soit le numro de srie, soit le nom logique du module dsir Retourne : un objet de classe YModule qui permet ensuite de contrler le module ou d'obtenir de plus amples informations sur le module.
YModule.FirstModule()
Commence l'numration des modules accessibles par la librairie.
YModule FirstModule( )
www.yoctopuce.com
108
Utiliser la fonction YModule.nextModule() pour itrer sur les autres modules.

Retourne : un pointeur sur un objet YModule, correspondant au premier module accessible en ligne, ou null si aucun module n'a t trouv.
module.describe()
Retourne un court texte dcrivant le module.
string describe( )
Ce texte peut contenir soit le nom logique du module, soit son numro de srie.
Retourne : une chane de caractres dcrivant le module
module.functionCount()
Retourne le nombre de fonctions (sans compter l'interface "module") existant sur le module.
int functionCount( ) Retourne : le nombre de fonctions sur le module
module.functionId()
Retourne l'identifiant matriel de la nime fonction du module.
string functionId( int functionIndex) Paramtres : functionIndex l'index de la fonction pour laquelle l'information est dsire, en commenant 0 pour la premire fonction. Retourne : une chane de caractres correspondant l'identifiant matriel unique de la fonction dsire
En cas d'erreur, dclenche une exception ou retourne un chane vide.
module.functionName()
Retourne le nom logique de la nime fonction du module.
string functionName( int functionIndex) Paramtres : functionIndex l'index de la fonction pour laquelle l'information est dsire, en commenant 0 pour la premire fonction. Retourne : une chane de caractres correspondant au nom logique de la fonction dsire
module.functionValue()
Retourne la valeur publie par la nime fonction du module.
www.yoctopuce.com
109
string functionValue( int functionIndex) Paramtres : functionIndex l'index de la fonction pour laquelle l'information est dsire, en commenant 0 pour la premire fonction. Retourne : une chane de caractres correspondant la valeur publie par la fonction dsire
module.get_beacon()
Retourne l'tat de la balise de localisation.
int get_beacon( ) Retourne : soit Y_BEACON_OFF, soit Y_BEACON_ON, selon l'tat de la balise de localisation
En cas d'erreur, dclenche une exception ou retourne Y_BEACON_INVALID.
module.get_errorMessage()
Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de l'objet module.
Retourne : une chane de caractres correspondant au message de la dernire erreur qui s'est produit lors de l'utilisation du module
module.get_errorType()
Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de l'objet module.
Retourne : un nombre correspondant au code de la dernire erreur qui s'est produit lors de l'utilisation du module
module.get_firmwareRelease()
Retourne la version du logiciel embarqu du module.
string get_firmwareRelease( ) Retourne : une chane de caractres reprsentant la version du logiciel embarqu du module
En cas d'erreur, dclenche une exception ou retourne Y_FIRMWARERELEASE_INVALID.
www.yoctopuce.com
110
module.get_moduleDescriptor()
module.get_hardwareId()
Retourne l'identifiant unique du module.
L'identifiant unique est compos du numro de srie du module suivi de la chane ".module".
Retourne : une chane de caractres identifiant la fonction
Retourne l'icone du module. L'icone est au format png et a une taille maximale de 1024 octets.
Retourne : un buffer binaire contenant l'icone, au format png.
module.get_logicalName()
Retourne le nom logique du module.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du module
module.get_luminosity()
Retourne la luminosit des leds informatives du module (valeur entre 0 et 100).
int get_luminosity( ) Retourne : un entier reprsentant la luminosit des leds informatives du module (valeur entre 0 et 100)
En cas d'erreur, dclenche une exception ou retourne Y_LUMINOSITY_INVALID.
module.get_persistentSettings()
Retourne l'tat courant des rglages persistents du module.
int get_persistentSettings( ) Retourne :
www.yoctopuce.com
111
Y_PERSISTENTSETTINGS_LOADED, et Y_PERSISTENTSETTINGS_MODIFIED reprsentant l'tat courant des rglages persistents du module

une valeur parmi
Y_PERSISTENTSETTINGS_SAVED
En cas d'erreur,
dclenche
une
exception
ou
retourne
Y_PERSISTENTSETTINGS_INVALID.
module.get_productId()
Retourne l'identifiant USB du module, prprogramm en usine.
int get_productId( ) Retourne : un entier reprsentant l'identifiant USB du module, prprogramm en usine
En cas d'erreur, dclenche une exception ou retourne Y_PRODUCTID_INVALID.
module.get_productName()
Retourne le nom commercial du module, prprogramm en usine.
string get_productName( ) Retourne : une chane de caractres reprsentant le nom commercial du module, prprogramm en usine
En cas d'erreur, dclenche une exception ou retourne Y_PRODUCTNAME_INVALID.
module.get_productRelease()
Retourne le numro de version matriel du module, prprogramm en usine.
int get_productRelease( ) Retourne : un entier reprsentant le numro de version matriel du module, prprogramm en usine
En cas d'erreur, dclenche une exception ou retourne Y_PRODUCTRELEASE_INVALID.
module.get_rebootCountdown()
Retourne le nombre de secondes restantes avant un redmarrage du module, ou zro si aucun redmarrage n'a t agend.
int get_rebootCountdown( ) Retourne : un entier reprsentant le nombre de secondes restantes avant un redmarrage du module, ou zro si aucun redmarrage n'a t agend
En cas d'erreur, dclenche une exception ou retourne Y_REBOOTCOUNTDOWN_INVALID.
module.get_serialNumber()
Retourne le numro de srie du module, prprogramm en usine.
string get_serialNumber( ) Retourne : une chane de caractres reprsentant le numro de srie du module, prprogramm en usine
www.yoctopuce.com
112
En cas d'erreur, dclenche une exception ou retourne Y_SERIALNUMBER_INVALID.
module.get_upTime()
Retourne le numbre de millisecondes coules depuis la mise sous tension du module
long get_upTime( ) Retourne : un entier reprsentant le numbre de millisecondes coules depuis la mise sous tension du module
En cas d'erreur, dclenche une exception ou retourne Y_UPTIME_INVALID.
module.get_usbBandwidth()
Retourne le nombre d'interface USB utilis par le module.
int get_usbBandwidth( ) Retourne : soit Y_USBBANDWIDTH_SIMPLE, soit Y_USBBANDWIDTH_DOUBLE, selon le nombre d'interface USB utilis par le module
En cas d'erreur, dclenche une exception ou retourne Y_USBBANDWIDTH_INVALID.
module.get_usbCurrent()
Retourne le courant consomm par le module sur le bus USB, en milliampres.
int get_usbCurrent( ) Retourne : un entier reprsentant le courant consomm par le module sur le bus USB, en milliampres
En cas d'erreur, dclenche une exception ou retourne Y_USBCURRENT_INVALID.
module.get_userData()
module.isOnline()
Vrifie si le module est joignable, sans dclencher d'erreur.
bool isOnline( )
Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considr joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vrification de joignabilit.
Retourne : true si le module est joignable, false sinon
www.yoctopuce.com
113
Vrifie si le module est joignable, sans dclencher d'erreur. Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considr joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vrification de joignabilit. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
Paramtres : callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet module concern et le rsultat boolen context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
module.load()
Met en cache les valeurs courantes du module, avec une dure de validit spcifie.
Met en cache les valeurs courantes du module, avec une dure de validit spcifie. Par dfaut, lorsqu'on accde un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dure standard (5 ms). Cette mthode peut tre utilise pour marquer occasionellement les donnes caches comme valides pour une plus longue priode, par exemple dans le but de rduire le trafic rseau. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
Paramtres : msValidity un entier correspondant la dure de validit attribue aux les paramtres chargs, en millisecondes callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet module concern et le code d'erreur (ou YAPI_SUCCESS) context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
www.yoctopuce.com
114
module.nextModule()
Continue l'numration des modules commence l'aide de yFirstModule().
YModule nextModule( ) Retourne : un pointeur sur un objet YModule accessible en ligne, ou null lorsque l'numration est termine.
module.reboot()
Agende un simple redmarrage du module dans un nombre donn de secondes.
int reboot( int secBeforeReboot) Paramtres : secBeforeReboot nombre de secondes avant de redmarrer Retourne :

module.revertFromFlash()
Recharge les rglages stocks dans le mmoire non volatile du module, comme la mise sous tension du module.
int revertFromFlash( ) Retourne :

module.saveToFlash()
Sauve les rglages courants dans la mmoire non volatile du module.
int saveToFlash( )
Attention le nombre total de sauvegardes possibles durant la vie du module est limit (environ 100000 cycles). N'appelez pas cette fonction dans une boucle.
Retourne :

module.set_beacon()
Allume ou teint la balise de localisation du module.
int set_beacon( int newval) Paramtres : newval soit Y_BEACON_OFF, soit Y_BEACON_ON Retourne :
www.yoctopuce.com
115
module.set_logicalName()
Change le nom logique du module.
Paramtres : newval une chane de caractres Retourne :

module.set_luminosity()
Modifie la luminosit des leds informatives du module.
int set_luminosity( int newval)
Le paramtre est une valeur entre 0 et 100. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres : newval un entier reprsentant la luminosit des leds informatives du module Retourne :

module.set_usbBandwidth()
Modifie le nombre d'interface USB utilis par le module.
int set_usbBandwidth( int newval) Paramtres : newval soit Y_USBBANDWIDTH_SIMPLE, soit Y_USBBANDWIDTH_DOUBLE, selon le nombre d'interface USB utilis par le module Retourne :

module.set_userData()
Paramtres :
data objet quelconque mmoriser
module.triggerFirmwareUpdate()
Agende un redmarrage du module en mode spcial de reprogrammation du logiciel embarqu.
int triggerFirmwareUpdate( int secBeforeReboot) Paramtres : secBeforeReboot nombre de secondes avant de redmarrer Retourne :

3.15. Interface de la fonction Network

Les objets YNetwork permettent de controller les paramtres TCP/IP des modules Yoctopuce dots d'une interface rseau. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_network.cs
Fonction globales
yFindNetwork(func) Permet de retrouver une interface rseau d'aprs un identifiant donn. yFirstNetwork() Commence l'numration des interfaces rseau accessibles par la librairie.
Mthodes des objets YNetwork

networkcallbackLogin(username, password) Contacte le callback de notification et sauvegarde un laisser-passer pour s'y connecter. networkdescribe() Retourne un court texte dcrivant la fonction. networkget_adminPassword() Retourne une chane de hash si un mot de passe a t configur pour l'utilisateur "admin", ou sinon une chane vide. networkget_advertisedValue() Retourne la valeur courante de l'interface rseau (pas plus de 6 caractres). networkget_callbackCredentials() Retourne une version hashe du laisser-passer pour le callback de notification si il a t configur, ou sinon une chane vide. networkget_callbackMaxDelay() Retourne l'attente maximale entre deux notifications par callback, en secondes. networkget_callbackMinDelay() Retourne l'attente minimale entre deux notifications par callback, en secondes. networkget_callbackUrl() Retourne l'adresse (URL) de callback notifier lors de changement d'tat significatifs. networkget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. networkget_errorType()
www.yoctopuce.com
117
Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. networkget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. networkget_hardwareId() Retourne l'identifiant unique de la fonction. networkget_ipAddress() Retourne l'adresse IP utilise par le module Yoctopuce. networkget_logicalName() Retourne le nom logique de l'interface rseau, qui correspond au nom rseau du module. networkget_macAddress() Retourne l'adresse MAC de l'interface rseau, unique pour chaque module. networkget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. networkget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. networkget_primaryDNS() Retourne l'adresse IP du serveur de nom primaire que le module doit utiliser. networkget_readiness() Retourne l'tat de fonctionnement atteint par l'interface rseau. networkget_router() Retourne l'adresse IP du routeur (passerelle) utilis par le module (default gateway). networkget_secondaryDNS() Retourne l'adresse IP du serveur de nom secondaire que le module doit utiliser. networkget_subnetMask() Retourne le masque de sous-rseau utilis par le module. networkget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. networkget_userPassword() Retourne une chane de hash si un mot de passe a t configur pour l'utilisateur "user", ou sinon une chane vide. networkisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. networkisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. networkload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. networkload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. networknextNetwork() Continue l'numration des interfaces rseau commence l'aide de yFirstNetwork(). networkregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie.
www.yoctopuce.com
118
networkset_adminPassword(newval) Modifie le mot de passe pour l'utilisateur "admin", qui devient alors instantanment ncessaire pour toute altration de l'tat du module. networkset_callbackCredentials(newval) Modifie le laisser-passer pour se connecter l'adresse de callback. networkset_callbackMaxDelay(newval) Modifie l'attente maximale entre deux notifications par callback, en secondes. networkset_callbackMinDelay(newval) Modifie l'attente minimale entre deux notifications par callback, en secondes. networkset_callbackUrl(newval) Modifie l'adresse (URL) de callback notifier lors de changement d'tat significatifs. networkset_logicalName(newval) Modifie le nom logique de l'interface rseau, qui correspond au nom rseau du module. networkset_primaryDNS(newval) Modifie l'adresse IP du serveur de nom primaire que le module doit utiliser. networkset_secondaryDNS(newval) Modifie l'adresse IP du serveur de nom secondaire que le module doit utiliser. networkset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData. networkset_userPassword(newval) Modifie le mode de passe pour l'utilisateur "user", qui devient alors instantanment ncessaire pour tout accs au module. networkuseDHCP(fallbackIpAddr, fallbackSubnetMaskLen, fallbackRouter) Modifie la configuration de l'interface rseau pour utiliser une adresse assigne automatiquement par le serveur DHCP. networkuseStaticIP(ipAddress, subnetMaskLen, router) Modifie la configuration de l'interface rseau pour utiliser une adresse IP assigne manuellement (adresse IP statique).
YNetwork.FindNetwork()
Permet de retrouver une interface rseau d'aprs un identifiant donn.
YNetwork FindNetwork( string func)
Cette fonction n'exige pas que l'interface rseau soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YNetwork.isOnline() pour tester si l'interface rseau est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence l'interface rseau sans ambigut
www.yoctopuce.com
119
Retourne : un objet de classe YNetwork qui permet ensuite de contrler l'interface rseau.
YNetwork.FirstNetwork()
Commence l'numration des interfaces rseau accessibles par la librairie.
YNetwork FirstNetwork( )
Utiliser la fonction YNetwork.nextNetwork() pour itrer sur les autres interfaces rseau.
Retourne : un pointeur sur un objet YNetwork, correspondant la premire interface rseau accessible en ligne, ou null si il n'y a pas de interfaces rseau disponibles.
network.callbackLogin()
Contacte le callback de notification et sauvegarde un laisser-passer pour s'y connecter.
int callbackLogin( string username, string password)
Le mot de passe ne sera pas stock dans le module, mais seulement une version hashe non rversible. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres : username nom d'utilisateur pour s'identifier au callback password mot de passe pour s'identifier au callback Retourne :

network.describe()
string describe( )
network.get_adminPassword()
Retourne une chane de hash si un mot de passe a t configur pour l'utilisateur "admin", ou sinon une chane vide.
string get_adminPassword( ) Retourne : une chane de caractres reprsentant une chane de hash si un mot de passe a t configur pour l'utilisateur "admin", ou sinon une chane vide
En cas d'erreur, dclenche une exception ou retourne Y_ADMINPASSWORD_INVALID.
network.get_advertisedValue()
Retourne la valeur courante de l'interface rseau (pas plus de 6 caractres).
www.yoctopuce.com
120
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante de l'interface rseau (pas plus de 6 caractres)
network.get_callbackCredentials()
Retourne une version hashe du laisser-passer pour le callback de notification si il a t configur, ou sinon une chane vide.
string get_callbackCredentials( ) Retourne : une chane de caractres reprsentant une version hashe du laisser-passer pour le callback de notification si il a t configur, ou sinon une chane vide
En
cas
d'erreur,
dclenche
une
exception
ou
retourne
Y_CALLBACKCREDENTIALS_INVALID.
network.get_callbackMaxDelay()
Retourne l'attente maximale entre deux notifications par callback, en secondes.
int get_callbackMaxDelay( ) Retourne : un entier reprsentant l'attente maximale entre deux notifications par callback, en secondes
En cas d'erreur, dclenche une exception ou retourne Y_CALLBACKMAXDELAY_INVALID.
network.get_callbackMinDelay()
Retourne l'attente minimale entre deux notifications par callback, en secondes.
int get_callbackMinDelay( ) Retourne : un entier reprsentant l'attente minimale entre deux notifications par callback, en secondes
En cas d'erreur, dclenche une exception ou retourne Y_CALLBACKMINDELAY_INVALID.
network.get_callbackUrl()
Retourne l'adresse (URL) de callback notifier lors de changement d'tat significatifs.
string get_callbackUrl( ) Retourne : une chane de caractres reprsentant l'adresse (URL) de callback notifier lors de changement d'tat significatifs
En cas d'erreur, dclenche une exception ou retourne Y_CALLBACKURL_INVALID.
network.get_errorMessage()
www.yoctopuce.com
121
network.get_errorType()
network.get_networkDescriptor()
network.get_hardwareId()
network.get_ipAddress()
Retourne l'adresse IP utilise par le module Yoctopuce.
string get_ipAddress( )
Il peut s'agir d'une adresse configure statiquement, ou d'une adresse reue par un serveur DHCP.
Retourne : une chane de caractres reprsentant l'adresse IP utilise par le module Yoctopuce
En cas d'erreur, dclenche une exception ou retourne Y_IPADDRESS_INVALID.
www.yoctopuce.com
122
network.get_logicalName()
Retourne le nom logique de l'interface rseau, qui correspond au nom rseau du module.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique de l'interface rseau, qui correspond au nom rseau du module
network.get_macAddress()
Retourne l'adresse MAC de l'interface rseau, unique pour chaque module.
string get_macAddress( )
L'adresse MAC est aussi prsente sur un autocollant sur le module, reprsente en chiffres et en code-barres.
Retourne : une chane de caractres reprsentant l'adresse MAC de l'interface rseau, unique pour chaque module
En cas d'erreur, dclenche une exception ou retourne Y_MACADDRESS_INVALID.
network.get_module()
network.get_primaryDNS()
Retourne l'adresse IP du serveur de nom primaire que le module doit utiliser.
www.yoctopuce.com
123
string get_primaryDNS( ) Retourne : une chane de caractres reprsentant l'adresse IP du serveur de nom primaire que le module doit utiliser
En cas d'erreur, dclenche une exception ou retourne Y_PRIMARYDNS_INVALID.
network.get_readiness()
Retourne l'tat de fonctionnement atteint par l'interface rseau.
int get_readiness( )
Le niveau zro (DOWN_0) signifie qu'aucun support rseau matriel. Soit il n'y a pas de signal sur le cable rseau, soit le point d'accs sans fil choisi n'est pas dtect. Le niveau 1 (LIVE_1) est atteint lorsque le rseau est dtect, mais n'est pas encore connect. Pour un rseau sans fil, cela confirme la l'existence du SSID configur. Le niveau 2 (LINK_2) est atteint lorsque le support matriel du rseau est fonctionnel. Pour une connection rseau filaire, le niveau 2 signifie que le cable est connect aux deux bouts. Pour une connection un point d'accs rseau sans fil, il dmontre que les paramtres de scurits configurs sont corrects. Pour une connection sans fil en mode ad-hoc, cela signifie qu'il y a au moins un partenaire sur le rseau ad-hoc. Le niveau 3 (DHCP_3) est atteint lorsque qu'une adresse IP a t obtenue par DHCP. Le niveau 4 (DNS_4) est atteint lorsqu'un serveur DNS est joignable par le rseau. Le niveau 5 (WWW_5) est atteint lorsque la connectivit globale internet est avre par l'obtention de l'heure courante sur une serveur NTP.
Retourne : une valeur parmi
Y_READINESS_LINKED,
Y_READINESS_DOWN, Y_READINESS_LAN_OK et
Y_READINESS_EXISTS, Y_READINESS_WWW_OK
reprsentant l'tat de fonctionnement atteint par l'interface rseau
En cas d'erreur, dclenche une exception ou retourne Y_READINESS_INVALID.
network.get_router()
Retourne l'adresse IP du routeur (passerelle) utilis par le module (default gateway).
string get_router( ) Retourne : une chane de caractres reprsentant l'adresse IP du routeur (passerelle) utilis par le module (default gateway)
En cas d'erreur, dclenche une exception ou retourne Y_ROUTER_INVALID.
network.get_secondaryDNS()
Retourne l'adresse IP du serveur de nom secondaire que le module doit utiliser.
string get_secondaryDNS( ) Retourne : une chane de caractres reprsentant l'adresse IP du serveur de nom secondaire que le module doit utiliser
En cas d'erreur, dclenche une exception ou retourne Y_SECONDARYDNS_INVALID.
network.get_subnetMask()
Retourne le masque de sous-rseau utilis par le module.
www.yoctopuce.com
124
string get_subnetMask( ) Retourne : une chane de caractres reprsentant le masque de sous-rseau utilis par le module
En cas d'erreur, dclenche une exception ou retourne Y_SUBNETMASK_INVALID.
network.get_userData()
network.get_userPassword()
Retourne une chane de hash si un mot de passe a t configur pour l'utilisateur "user", ou sinon une chane vide.
string get_userPassword( ) Retourne : une chane de caractres reprsentant une chane de hash si un mot de passe a t configur pour l'utilisateur "user", ou sinon une chane vide
En cas d'erreur, dclenche une exception ou retourne Y_USERPASSWORD_INVALID.
network.isOnline()
bool isOnline( )
Paramtres : callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le rsultat boolen
www.yoctopuce.com
125
context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
network.load()
network.nextNetwork()
Continue l'numration des interfaces rseau commence l'aide de yFirstNetwork ().
YNetwork nextNetwork( ) Retourne : un pointeur sur un objet YNetwork accessible en ligne, ou null lorsque l'numration est termine.
network.registerValueCallback()
www.yoctopuce.com
126
network.set_adminPassword()
Modifie le mot de passe pour l'utilisateur "admin", qui devient alors instantanment ncessaire pour toute altration de l'tat du module.
int set_adminPassword( string newval)
Si la valeur fournie est une chane vide, plus aucun mot de passe n'est ncessaire. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres : newval une chane de caractres reprsentant le mot de passe pour l'utilisateur "admin", qui devient alors instantanment ncessaire pour toute altration de l'tat du module Retourne :

network.set_callbackCredentials()
Modifie le laisser-passer pour se connecter l'adresse de callback.
int set_callbackCredentials( string newval)
Le
laisser-passer
doit
tre
fourni
tel
que
retourn
par
la
fonction
get_callbackCredentials, sous la forme username:hash. La valeur du hash

dpend de la mthode d'autorisation implmente par le callback. Pour une autorisation de type Basic, le hash est le MD5 de la chane username:password. Pour une autorisation de type Digest, le hash est le MD5 de la chane username:realm:password. Pour une utilisation simplifie, utilisez la fonction callbackLogin. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres : newval une chane de caractres reprsentant le laisser-passer pour se connecter l'adresse de callback Retourne :

network.set_callbackMaxDelay()
Modifie l'attente maximale entre deux notifications par callback, en secondes.
int set_callbackMaxDelay( int newval) Paramtres :
www.yoctopuce.com
127
newval un entier reprsentant l'attente maximale entre deux notifications par callback, en secondes Retourne :

network.set_callbackMinDelay()
Modifie l'attente minimale entre deux notifications par callback, en secondes.
int set_callbackMinDelay( int newval) Paramtres : newval un entier reprsentant l'attente minimale entre deux notifications par callback, en secondes Retourne :

network.set_callbackUrl()
Modifie l'adresse (URL) de callback notifier lors de changement d'tat significatifs.
int set_callbackUrl( string newval)
Paramtres : newval une chane de caractres reprsentant l'adresse (URL) de callback notifier lors de changement d'tat significatifs Retourne :

network.set_logicalName()
Modifie le nom logique de l'interface rseau, qui correspond au nom rseau du module.
Paramtres : newval une chane de caractres reprsentant le nom logique de l'interface rseau, qui correspond au nom rseau du module Retourne :

network.set_primaryDNS()
Modifie l'adresse IP du serveur de nom primaire que le module doit utiliser.
www.yoctopuce.com
128
int set_primaryDNS( string newval)
En mode DHCP, si une valeur est spcifie, elle remplacera celle reue du serveur DHCP. N'oubliez pas d'appeler la mthode saveToFlash() et de redmarrer le module pour que le paramtre soit appliqu.
Paramtres : newval une chane de caractres reprsentant l'adresse IP du serveur de nom primaire que le module doit utiliser Retourne :

network.set_secondaryDNS()
Modifie l'adresse IP du serveur de nom secondaire que le module doit utiliser.
int set_secondaryDNS( string newval)
En mode DHCP, si une valeur est spcifie, elle remplacera celle reue du serveur DHCP. N'oubliez pas d'appeler la mthode saveToFlash() et de redmarrer le module pour que le paramtre soit appliqu.
Paramtres : newval une chane de caractres reprsentant l'adresse IP du serveur de nom secondaire que le module doit utiliser Retourne :

network.set_userData()
network.set_userPassword()
Modifie le mode de passe pour l'utilisateur "user", qui devient alors instantanment ncessaire pour tout accs au module.
int set_userPassword( string newval)
Si la valeur fournie est une chane vide, plus aucun mot de passe n'est ncessaire. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres : newval une chane de caractres reprsentant le mode de passe pour l'utilisateur "user", qui devient alors instantanment ncessaire pour tout accs au module Retourne :
www.yoctopuce.com
129
network.useDHCP()
Modifie la configuration de l'interface rseau pour utiliser une adresse assigne automatiquement par le serveur DHCP.
int useDHCP( string fallbackIpAddr, int fallbackSubnetMaskLen, string fallbackRouter)
En attendant qu'une adresse soit reue (et indfiniment si aucun serveur DHCP ne rpond), le module utilisera les paramtres IP spcifis cette fonction. N'oubliez pas d'appeler la mthode saveToFlash() et de redmarrer le module pour que le paramtre soit appliqu.
Paramtres : fallbackIpAddr adresse IP utiliser si aucun serveur DHCP ne rpond fallbackSubnetMaskLen longueur du masque de sous-rseau utiliser si aucun serveur DHCP ne rpond. Par exemple, la valeur 24 reprsente 255.255.255.0. fallbackRouter adresse de la passerelle utiliser si aucun serveur DHCP ne rpond Retourne :

network.useStaticIP()
Modifie la configuration de l'interface rseau pour utiliser une adresse IP assigne manuellement (adresse IP statique).
int useStaticIP( string ipAddress, int subnetMaskLen, string router)
N'oubliez pas d'appeler la mthode saveToFlash() et de redmarrer le module pour que le paramtre soit appliqu.
Paramtres : ipAddress adresse IP utiliser par le module subnetMaskLen longueur du masque de sous-rseau utiliser. Par exemple, la valeur 24 reprsente 255.255.255.0. router adresse IP de la passerelle utiliser ("default gateway") Retourne :

3.16. Interface de la fonction Pressure

yocto_pressure.cs
Fonction globales
yFindPressure(func) Permet de retrouver un capteur de pression d'aprs un identifiant donn. yFirstPressure()
www.yoctopuce.com
130
Commence l'numration des capteurs de pression accessibles par la librairie.
Mthodes des objets YPressure

pressurecalibrateFromPoints(rawValues, refValues) Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur. pressuredescribe() Retourne un court texte dcrivant la fonction. pressureget_advertisedValue() Retourne la valeur courante du capteur de pression (pas plus de 6 caractres). pressureget_currentRawValue() Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration). pressureget_currentValue() Retourne la valeur mesure actuelle. pressureget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. pressureget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. pressureget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. pressureget_hardwareId() Retourne l'identifiant unique de la fonction. pressureget_highestValue() Retourne la valeur maximale observe. pressureget_logicalName() Retourne le nom logique du capteur de pression. pressureget_lowestValue() Retourne la valeur minimale observe. pressureget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. pressureget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. pressureget_resolution() Retourne la rsolution des valeurs mesures. pressureget_unit() Retourne l'unit dans laquelle la valeur mesure est exprime. pressureget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. pressureisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. pressureisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. pressureload(msValidity)
www.yoctopuce.com
131
Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. pressureload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. pressurenextPressure() Continue l'numration des capteurs de pression commence l'aide de yFirstPressure (). pressureregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. pressureset_highestValue(newval) Modifie la mmoire de valeur maximale observe. pressureset_logicalName(newval) Modifie le nom logique du capteur de pression. pressureset_lowestValue(newval) Modifie la mmoire de valeur minimale observe. pressureset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YPressure.FindPressure()
Permet de retrouver un capteur de pression d'aprs un identifiant donn.
YPressure FindPressure( string func)
Cette fonction n'exige pas que le capteur de pression soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YPressure.isOnline () pour tester si le capteur de pression est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le capteur de pression sans ambigut Retourne : un objet de classe YPressure qui permet ensuite de contrler le capteur de pression.
YPressure.FirstPressure()
Commence l'numration des capteurs de pression accessibles par la librairie.
YPressure FirstPressure( )
Utiliser la fonction YPressure.nextPressure() pour itrer sur les autres capteurs de pression.
Retourne : un pointeur sur un objet YPressure, correspondant le premier capteur de pression accessible en ligne, ou null si il n'y a pas de capteurs de pression disponibles.
pressure.calibrateFromPoints()

pressure.describe()
string describe( )
pressure.get_advertisedValue()
Retourne la valeur courante du capteur de pression (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du capteur de pression (pas plus de 6 caractres)
pressure.get_currentRawValue()
www.yoctopuce.com
133
pressure.get_currentValue()
pressure.get_errorMessage()
pressure.get_errorType()
pressure.get_pressureDescriptor()
pressure.get_hardwareId()
Retourne :
www.yoctopuce.com
134
une chane de caractres identifiant la fonction En cas d'erreur, dclenche une exception ou retourne Y_HARDWAREID_INVALID.
pressure.get_highestValue()
pressure.get_logicalName()
Retourne le nom logique du capteur de pression.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du capteur de pression
pressure.get_lowestValue()
pressure.get_module()
Paramtres :
www.yoctopuce.com
135
callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et l'instance demande de YModule context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
pressure.get_resolution()
pressure.get_unit()
pressure.get_userData()
pressure.isOnline()
bool isOnline( )
www.yoctopuce.com
136
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considr joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vrification de joignabilit. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
pressure.load()
pressure.nextPressure()
Continue l'numration des capteurs de pression commence l'aide de
yFirstPressure().
YPressure nextPressure( ) Retourne : un pointeur sur un objet YPressure accessible en ligne, ou null lorsque l'numration est termine.
pressure.registerValueCallback()
pressure.set_highestValue()

pressure.set_logicalName()
Modifie le nom logique du capteur de pression.
Paramtres : newval une chane de caractres reprsentant le nom logique du capteur de pression Retourne :

pressure.set_lowestValue()
int set_lowestValue( double newval)
www.yoctopuce.com
138
Paramtres : newval une valeur numrique reprsentant la mmoire de valeur minimale observe Retourne :

pressure.set_userData()
3.17. Interface de la fonction Relay

La librairie de programmation Yoctopuce permet simplement de changer l'tat du relais. Le changement d'tat n'est pas persistant: le relais retournera spontanment sa position de repos ds que le module est mis hors tension ou redmarr. La librairie permet aussi de crer des courtes impulsions de dure dtermine. Pour les modules dots de deux sorties par relais (relais inverseur), les deux sorties sont appeles A et B, la sortie A correspondant a la position de repos (hors tension) et la sortie B correspondant l'tat actif. Si vous prfreriez l'tat par dfaut oppos, vous pouvez simplement changer vos fils sur le bornier. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_relay.cs
Fonction globales
yFindRelay(func) Permet de retrouver un relais d'aprs un identifiant donn. yFirstRelay() Commence l'numration des relais accessibles par la librairie.
Mthodes des objets YRelay

relaydescribe() Retourne un court texte dcrivant la fonction. relayget_advertisedValue() Retourne la valeur courante du relais (pas plus de 6 caractres). relayget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. relayget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. relayget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. relayget_hardwareId() Retourne l'identifiant unique de la fonction. relayget_logicalName()
www.yoctopuce.com
139
Retourne le nom logique du relais. relayget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. relayget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. relayget_output() Retourne l'tat de la sortie du relais, lorsqu'il est utilis comme un simple interrupteur. relayget_pulseTimer() Retourne le nombre de millisecondes restantes avant le retour la position de repos (tat A), durant la gnration d'une impulsion mesure. relayget_state() Retourne l'tat du relais (A pour la position de repos, B pour l'tat actif). relayget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. relayisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. relayisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. relayload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. relayload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. relaynextRelay() Continue l'numration des relais commence l'aide de yFirstRelay(). relaypulse(ms_duration) Commute le relais l'tat B (actif) pour un dure spcifie, puis revient ensuite spontanment vers l'tat A (tat de repos). relayregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. relayset_logicalName(newval) Modifie le nom logique du relais. relayset_output(newval) Modifie l'tat de la sortie du relais, lorsqu'il est utilis comme un simple interrupteur. relayset_state(newval) Modifie l'tat du relais (A pour la position de repos, B pour l'tat actif). relayset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YRelay.FindRelay()
Permet de retrouver un relais d'aprs un identifiant donn.
YRelay FindRelay( string func)
www.yoctopuce.com
140
Cette fonction n'exige pas que le relais soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YRelay.isOnline() pour tester si le relais est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le relais sans ambigut Retourne : un objet de classe YRelay qui permet ensuite de contrler le relais.
YRelay.FirstRelay()
Commence l'numration des relais accessibles par la librairie.
YRelay FirstRelay( )
Utiliser la fonction YRelay.nextRelay() pour itrer sur les autres relais.

Retourne : un pointeur sur un objet YRelay, correspondant le premier relais accessible en ligne, ou null si il n'y a pas de relais disponibles.
relay.describe()
string describe( )
relay.get_advertisedValue()
Retourne la valeur courante du relais (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du relais (pas plus de 6 caractres)
relay.get_errorMessage()
www.yoctopuce.com
141
relay.get_errorType()
relay.get_relayDescriptor()
relay.get_hardwareId()
relay.get_logicalName()
Retourne le nom logique du relais.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du relais
relay.get_module()
www.yoctopuce.com
142
relay.get_output()
Retourne l'tat de la sortie du relais, lorsqu'il est utilis comme un simple interrupteur.
int get_output( ) Retourne : soit Y_OUTPUT_OFF, soit Y_OUTPUT_ON, selon l'tat de la sortie du relais, lorsqu'il est utilis comme un simple interrupteur
En cas d'erreur, dclenche une exception ou retourne Y_OUTPUT_INVALID.
relay.get_pulseTimer()
Retourne le nombre de millisecondes restantes avant le retour la position de repos (tat A), durant la gnration d'une impulsion mesure.
long get_pulseTimer( )
Si aucune impulsion n'est en cours, retourne zro.

Retourne : un entier reprsentant le nombre de millisecondes restantes avant le retour la position de repos (tat A), durant la gnration d'une impulsion mesure
En cas d'erreur, dclenche une exception ou retourne Y_PULSETIMER_INVALID.
relay.get_state()
Retourne l'tat du relais (A pour la position de repos, B pour l'tat actif).
int get_state( ) Retourne :
www.yoctopuce.com
143
soit Y_STATE_A, soit Y_STATE_B, selon l'tat du relais (A pour la position de repos, B pour l'tat actif)
En cas d'erreur, dclenche une exception ou retourne Y_STATE_INVALID.
relay.get_userData()
relay.isOnline()
bool isOnline( )
relay.load()
Paramtres :
msValidity un entier correspondant la dure de validit attribue aux les paramtres chargs, en millisecondes Retourne :
relay.nextRelay()
Continue l'numration des relais commence l'aide de yFirstRelay().
YRelay nextRelay( ) Retourne : un pointeur sur un objet YRelay accessible en ligne, ou null lorsque l'numration est termine.
relay.pulse()
Commute le relais l'tat B (actif) pour un dure spcifie, puis revient ensuite spontanment vers l'tat A (tat de repos).
int pulse( int ms_duration) Paramtres : ms_duration dure de l'impulsion, en millisecondes Retourne :

relay.registerValueCallback()
www.yoctopuce.com
145
relay.set_logicalName()
Modifie le nom logique du relais.
Paramtres : newval une chane de caractres reprsentant le nom logique du relais Retourne :

relay.set_output()
Modifie l'tat de la sortie du relais, lorsqu'il est utilis comme un simple interrupteur.
int set_output( int newval) Paramtres : newval soit Y_OUTPUT_OFF, soit Y_OUTPUT_ON, selon l'tat de la sortie du relais, lorsqu'il est utilis comme un simple interrupteur Retourne :

relay.set_state()
Modifie l'tat du relais (A pour la position de repos, B pour l'tat actif).
int set_state( int newval) Paramtres : newval soit Y_STATE_A, soit Y_STATE_B, selon l'tat du relais (A pour la position de repos, B pour l'tat actif) Retourne :

relay.set_userData()
www.yoctopuce.com
146
3.18. Interface de la fonction Servo

La librairie de programmation Yoctopuce permet non seulement de dplacer le servo vers une position donne, mais aussi de spcifier l'interval de temps dans lequel le mouvement doit tre fait, de sorte pouvoir synchroniser un mouvement sur plusieurs servos. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_servo.cs
Fonction globales
yFindServo(func) Permet de retrouver un servo d'aprs un identifiant donn. yFirstServo() Commence l'numration des servo accessibles par la librairie.
Mthodes des objets YServo

servodescribe() Retourne un court texte dcrivant la fonction. servoget_advertisedValue() Retourne la valeur courante du servo (pas plus de 6 caractres). servoget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. servoget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. servoget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. servoget_hardwareId() Retourne l'identifiant unique de la fonction. servoget_logicalName() Retourne le nom logique du servo. servoget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. servoget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. servoget_neutral() Retourne la dure en microsecondes de l'impulsion correspondant au neutre du servo. servoget_position() Retourne la position courante du servo. servoget_range() Retourne la plage d'utilisation du servo. servoget_userData()
www.yoctopuce.com
147
Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. servoisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. servoisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. servoload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. servoload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. servomove(target, ms_duration) Dclenche un mouvement vitesse constante vers une position donne. servonextServo() Continue l'numration des servo commence l'aide de yFirstServo(). servoregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. servoset_logicalName(newval) Modifie le nom logique du servo. servoset_neutral(newval) Modifie la dure de l'impulsion correspondant la position neutre du servo. servoset_position(newval) Modifie immdiatement la consigne de position du servo. servoset_range(newval) Modifie la plage d'utilisation du servo, en pourcents. servoset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YServo.FindServo()
Permet de retrouver un servo d'aprs un identifiant donn.
YServo FindServo( string func)
Cette fonction n'exige pas que le servo soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YServo.isOnline() pour tester si le servo est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le servo sans ambigut Retourne :
un objet de classe YServo qui permet ensuite de contrler le servo.
YServo.FirstServo()
Commence l'numration des servo accessibles par la librairie.
YServo FirstServo( )
Utiliser la fonction YServo.nextServo() pour itrer sur les autres servo.

Retourne : un pointeur sur un objet YServo, correspondant le premier servo accessible en ligne, ou null si il n'y a pas de servo disponibles.
servo.describe()
string describe( )
servo.get_advertisedValue()
Retourne la valeur courante du servo (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du servo (pas plus de 6 caractres)
servo.get_errorMessage()
servo.get_errorType()
Retourne :
www.yoctopuce.com
149
un nombre correspondant au code de la dernire erreur qui s'est produit lors de l'utilisation de la fonction
servo.get_servoDescriptor()
servo.get_hardwareId()
servo.get_logicalName()
Retourne le nom logique du servo.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du servo
servo.get_module()
www.yoctopuce.com
150
servo.get_neutral()
Retourne la dure en microsecondes de l'impulsion correspondant au neutre du servo.
int get_neutral( ) Retourne : un entier reprsentant la dure en microsecondes de l'impulsion correspondant au neutre du servo
En cas d'erreur, dclenche une exception ou retourne Y_NEUTRAL_INVALID.
servo.get_position()
Retourne la position courante du servo.
int get_position( ) Retourne : un entier reprsentant la position courante du servo
En cas d'erreur, dclenche une exception ou retourne Y_POSITION_INVALID.
servo.get_range()
Retourne la plage d'utilisation du servo.
int get_range( ) Retourne : un entier reprsentant la plage d'utilisation du servo
En cas d'erreur, dclenche une exception ou retourne Y_RANGE_INVALID.
servo.get_userData()
servo.isOnline()
bool isOnline( )
www.yoctopuce.com
151
servo.load()
Paramtres : msValidity un entier correspondant la dure de validit attribue aux les paramtres chargs, en millisecondes
www.yoctopuce.com
152
callback
context
fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le code d'erreur (ou YAPI_SUCCESS) contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback
Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
servo.move()
Dclenche un mouvement vitesse constante vers une position donne.
int move( int target, int ms_duration) Paramtres : target nouvelle position la fin du mouvement ms_duration dure totale du mouvement, en millisecondes Retourne :

servo.nextServo()
Continue l'numration des servo commence l'aide de yFirstServo().
YServo nextServo( ) Retourne : un pointeur sur un objet YServo accessible en ligne, ou null lorsque l'numration est termine.
servo.registerValueCallback()
servo.set_logicalName()
Modifie le nom logique du servo.
Paramtres :
www.yoctopuce.com
153
newval une chane de caractres reprsentant le nom logique du servo Retourne :

servo.set_neutral()
Modifie la dure de l'impulsion correspondant la position neutre du servo.
int set_neutral( int newval)
La dure est spcifie en microsecondes, et la valeur standard est 1500 [us]. Ce rglage permet de dcaler la plage d'utilisation du servo. Attention, l'utilisation d'une plage suprieure aux caractristiques du servo risque fortement d'endommager le servo.
Paramtres : newval un entier reprsentant la dure de l'impulsion correspondant la position neutre du servo Retourne :

servo.set_position()
Modifie immdiatement la consigne de position du servo.
int set_position( int newval) Paramtres : newval un entier reprsentant immdiatement la consigne de position du servo Retourne :

servo.set_range()
Modifie la plage d'utilisation du servo, en pourcents.
int set_range( int newval)
La valeur 100% correspond un signal de commande standard, variant de 1 [ms] 2 [ms]. Pour les servos supportent une plage double, de 0.5 [ms] 2.5 [ms], vous pouvez utiliser une valeur allant jusqu' 200%. Attention, l'utilisation d'une plage suprieure aux caractristiques du servo risque fortement d'endommager le servo.
Paramtres : newval un entier reprsentant la plage d'utilisation du servo, en pourcents Retourne :

servo.set_userData()
www.yoctopuce.com
154
3.19. Interface de la fonction Temperature

yocto_temperature.cs
Fonction globales
yFindTemperature(func) Permet de retrouver un capteur de temprature d'aprs un identifiant donn. yFirstTemperature() Commence l'numration des capteurs de temprature accessibles par la librairie.
Mthodes des objets YTemperature

temperaturecalibrateFromPoints(rawValues, refValues) Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur. temperaturedescribe() Retourne un court texte dcrivant la fonction. temperatureget_advertisedValue() Retourne la valeur courante du capteur de temprature (pas plus de 6 caractres). temperatureget_currentRawValue() Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration). temperatureget_currentValue() Retourne la valeur mesure actuelle. temperatureget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. temperatureget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. temperatureget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. temperatureget_hardwareId() Retourne l'identifiant unique de la fonction. temperatureget_highestValue() Retourne la valeur maximale observe. temperatureget_logicalName() Retourne le nom logique du capteur de temprature. temperatureget_lowestValue() Retourne la valeur minimale observe. temperatureget_module()
www.yoctopuce.com
155
Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. temperatureget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. temperatureget_resolution() Retourne la rsolution des valeurs mesures. temperatureget_sensorType() Retourne le type de capteur de temprature utilis par le module temperatureget_unit() Retourne l'unit dans laquelle la valeur mesure est exprime. temperatureget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. temperatureisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. temperatureisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. temperatureload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. temperatureload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. temperaturenextTemperature() Continue l'numration des yFirstTemperature().
capteurs
de
temprature
commence
l'aide
de
temperatureregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. temperatureset_highestValue(newval) Modifie la mmoire de valeur maximale observe. temperatureset_logicalName(newval) Modifie le nom logique du capteur de temprature. temperatureset_lowestValue(newval) Modifie la mmoire de valeur minimale observe. temperatureset_sensorType(newval) Change le type de senseur utilis par le module. temperatureset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YTemperature.FindTemperature()
Permet de retrouver un capteur de temprature d'aprs un identifiant donn.
YTemperature FindTemperature( string func)
L'identifiant peut tre spcifi sous plusieurs formes: NomLogiqueFonction
www.yoctopuce.com
156
NoSerieModule.IdentifiantFonction NoSerieModule.NomLogiqueFonction NomLogiqueModule.IdentifiantMatriel NomLogiqueModule.NomLogiqueFonction
Cette fonction n'exige pas que le capteur de temprature soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YTemperature.isOnline() pour tester si le capteur de temprature est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le capteur de temprature sans ambigut Retourne : un objet de classe YTemperature qui permet ensuite de contrler le capteur de temprature.
YTemperature.FirstTemperature()
Commence l'numration des capteurs de temprature accessibles par la librairie.
YTemperature FirstTemperature( )
Utiliser la fonction YTemperature.nextTemperature() pour itrer sur les autres capteurs de temprature.
Retourne : un pointeur sur un objet YTemperature, correspondant le premier capteur de temprature accessible en ligne, ou null si il n'y a pas de capteurs de temprature disponibles.
temperature.calibrateFromPoints()

temperature.describe()
string describe( )
www.yoctopuce.com
157
temperature.get_advertisedValue()
Retourne la valeur courante du capteur de temprature (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du capteur de temprature (pas plus de 6 caractres)
temperature.get_currentRawValue()
temperature.get_currentValue()
temperature.get_errorMessage()
temperature.get_errorType()
www.yoctopuce.com
158
temperature.get_temperatureDescriptor()
temperature.get_hardwareId()
temperature.get_highestValue()
temperature.get_logicalName()
Retourne le nom logique du capteur de temprature.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du capteur de temprature
temperature.get_lowestValue()
temperature.get_module()
temperature.get_resolution()
temperature.get_sensorType()
Retourne le type de capteur de temprature utilis par le module
int get_sensorType( ) Retourne : une valeur
parmi Y_SENSORTYPE_DIGITAL, Y_SENSORTYPE_TYPE_K, Y_SENSORTYPE_TYPE_E, Y_SENSORTYPE_TYPE_J, Y_SENSORTYPE_TYPE_N, Y_SENSORTYPE_TYPE_R, Y_SENSORTYPE_TYPE_S et Y_SENSORTYPE_TYPE_T reprsentant le type de capteur de temprature utilis par le module
En cas d'erreur, dclenche une exception ou retourne Y_SENSORTYPE_INVALID.
www.yoctopuce.com
160
temperature.get_unit()
temperature.get_userData()
temperature.isOnline()
bool isOnline( )
temperature.load()
www.yoctopuce.com
161
temperature.nextTemperature()
Continue l'numration des capteurs de temprature commence l'aide de yFirstTemperature().
YTemperature nextTemperature( ) Retourne : un pointeur sur un objet YTemperature accessible en ligne, ou null lorsque l'numration est termine.
temperature.registerValueCallback()
Paramtres :
www.yoctopuce.com
162
callback la fonction de callback rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a chang, et la chane de caractre dcrivant la nouvelle valeur publie.
temperature.set_highestValue()

temperature.set_logicalName()
Modifie le nom logique du capteur de temprature.
Paramtres : newval une chane de caractres reprsentant le nom logique du capteur de temprature Retourne :

temperature.set_lowestValue()

temperature.set_sensorType()
Change le type de senseur utilis par le module.
int set_sensorType( int newval)
Cette function sert spcifier le type de thermocouple (K,E, etc..) raccord au module. Cette fonction n'aura pas d'effet si le module utilise un capteur digital. N'oubliez pas d'appeler la mthode saveToFlash() du module si le rglage doit tre prserv.
Paramtres :
www.yoctopuce.com
163
newval une
valeur parmi Y_SENSORTYPE_DIGITAL, Y_SENSORTYPE_TYPE_K, Y_SENSORTYPE_TYPE_E, Y_SENSORTYPE_TYPE_J, Y_SENSORTYPE_TYPE_N, Y_SENSORTYPE_TYPE_R, Y_SENSORTYPE_TYPE_S et Y_SENSORTYPE_TYPE_T
Retourne :

temperature.set_userData()
3.20. Interface de la fonction Voltage

yocto_voltage.cs
Fonction globales
yFindVoltage(func) Permet de retrouver un capteur de tension d'aprs un identifiant donn. yFirstVoltage() Commence l'numration des capteurs de tension accessibles par la librairie.
Mthodes des objets YVoltage

voltagecalibrateFromPoints(rawValues, refValues) Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un botier sur les mesures rendues par le capteur. voltagedescribe() Retourne un court texte dcrivant la fonction. voltageget_advertisedValue() Retourne la valeur courante du capteur de tension (pas plus de 6 caractres). voltageget_currentRawValue() Retourne la valeur brute retourne par le capteur (sans arrondi ni calibration). voltageget_currentValue() Retourne la valeur mesure actuelle. voltageget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. voltageget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. voltageget_functionDescriptor()
www.yoctopuce.com
164
Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. voltageget_hardwareId() Retourne l'identifiant unique de la fonction. voltageget_highestValue() Retourne la valeur maximale observe. voltageget_logicalName() Retourne le nom logique du capteur de tension. voltageget_lowestValue() Retourne la valeur minimale observe. voltageget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. voltageget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. voltageget_resolution() Retourne la rsolution des valeurs mesures. voltageget_unit() Retourne l'unit dans laquelle la valeur mesure est exprime. voltageget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. voltageisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. voltageisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. voltageload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. voltageload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. voltagenextVoltage() Continue l'numration des capteurs de tension commence l'aide de yFirstVoltage(). voltageregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. voltageset_highestValue(newval) Modifie la mmoire de valeur maximale observe. voltageset_logicalName(newval) Modifie le nom logique du capteur de tension. voltageset_lowestValue(newval) Modifie la mmoire de valeur minimale observe. voltageset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YVoltage.FindVoltage()
Permet de retrouver un capteur de tension d'aprs un identifiant donn.
YVoltage FindVoltage( string func)
Cette fonction n'exige pas que le capteur de tension soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YVoltage.isOnline () pour tester si le capteur de tension est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence le capteur de tension sans ambigut Retourne : un objet de classe YVoltage qui permet ensuite de contrler le capteur de tension.
YVoltage.FirstVoltage()
Commence l'numration des capteurs de tension accessibles par la librairie.
YVoltage FirstVoltage( )
Utiliser la fonction YVoltage.nextVoltage() pour itrer sur les autres capteurs de tension.
Retourne : un pointeur sur un objet YVoltage, correspondant le premier capteur de tension accessible en ligne, ou null si il n'y a pas de capteurs de tension disponibles.
voltage.calibrateFromPoints()

www.yoctopuce.com
166
voltage.describe()
string describe( )
voltage.get_advertisedValue()
Retourne la valeur courante du capteur de tension (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante du capteur de tension (pas plus de 6 caractres)
voltage.get_currentRawValue()
voltage.get_currentValue()
voltage.get_errorMessage()
www.yoctopuce.com
167
voltage.get_errorType()
voltage.get_voltageDescriptor()
voltage.get_hardwareId()
voltage.get_highestValue()
voltage.get_logicalName()
Retourne le nom logique du capteur de tension.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique du capteur de tension
www.yoctopuce.com
168
voltage.get_lowestValue()
voltage.get_module()
voltage.get_resolution()
voltage.get_unit()
www.yoctopuce.com
169
voltage.get_userData()
voltage.isOnline()
bool isOnline( )
voltage.load()
Par dfaut, lorsqu'on accde un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dure standard (5 ms). Cette mthode peut tre
www.yoctopuce.com
170
utilise pour marquer occasionellement les donnes caches comme valides pour une plus longue priode, par exemple dans le but de rduire le trafic rseau.
voltage.nextVoltage()
Continue l'numration des capteurs de tension commence l'aide de
yFirstVoltage().
YVoltage nextVoltage( ) Retourne : un pointeur sur un objet YVoltage accessible en ligne, ou null lorsque l'numration est termine.
voltage.registerValueCallback()
www.yoctopuce.com
171
voltage.set_highestValue()

voltage.set_logicalName()
Modifie le nom logique du capteur de tension.
Paramtres : newval une chane de caractres reprsentant le nom logique du capteur de tension Retourne :

voltage.set_lowestValue()

voltage.set_userData()
www.yoctopuce.com
172
3.21. Interface de la fonction Source de tension

La librairie de programmation Yoctopuce permet de commande la tension de srotir du module. Vous pouvez affecter une valeur fixe,ou faire des transition de voltage. Pour utiliser les fonctions dcrites ici, vous devez inclure:
yocto_vsource.cs
Fonction globales
yFindVSource(func) Permet de retrouver une source de tension d'aprs un identifiant donn. yFirstVSource() Commence l'numration des sources de tension accessibles par la librairie.
Mthodes des objets YVSource

vsourcedescribe() Retourne un court texte dcrivant la fonction. vsourceget_advertisedValue() Retourne la valeur courante de la source de tension (pas plus de 6 caractres). vsourceget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. vsourceget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. vsourceget_extPowerFailure() Rend TRUE si le voltage de l'alimentation externe est trop bas. vsourceget_failure() Indique si le module est en condition d'erreur. vsourceget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. vsourceget_hardwareId() Retourne l'identifiant unique de la fonction. vsourceget_logicalName() Retourne le nom logique de la source de tension. vsourceget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. vsourceget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. vsourceget_overCurrent() Rend TRUE si l'appareil connect la sortie du module consomme trop de courant. vsourceget_overHeat() Rend TRUE si le module est en surchauffe. vsourceget_overLoad() Rend TRUE si le module n'est pas capable de tenir la tension de sortie demande. vsourceget_regulationFailure() Rend TRUE si le voltage de sortie de trop lev par report la tension demande demande. vsourceget_unit()
www.yoctopuce.com
173
Retourne l'unit dans laquelle la tension est exprime. vsourceget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. vsourceget_voltage() Retourne la valeur de la commande de tension de sortie en mV vsourceisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. vsourceisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. vsourceload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. vsourceload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. vsourcenextVSource() Continue l'numration des sources de tension commence l'aide de yFirstVSource(). vsourcepulse(voltage, ms_duration) Active la sortie une tension donne, et pour dure spcifie, puis revient ensuite spontanment zro volt. vsourceregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. vsourcereset() Rinitilialise la sortie du module. vsourceset_logicalName(newval) Modifie le nom logique de la source de tension. vsourceset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData. vsourceset_voltage(newval) Rgle la tension de sortie du module (en milliVolts). vsourcevoltageMove(target, ms_duration) Dclenche une variation constante de la sortie vers une valeur donne.
YVSource.FindVSource()
Permet de retrouver une source de tension d'aprs un identifiant donn.
YVSource FindVSource( string func)
Cette fonction n'exige pas que la source de tension soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YVSource.isOnline
www.yoctopuce.com
174
() pour tester si la source de tension est utilisable un moment donn. En cas d'ambigut
lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
Paramtres : func une chane de caractres qui rfrence la source de tension sans ambigut Retourne : un objet de classe YVSource qui permet ensuite de contrler la source de tension.
YVSource.FirstVSource()
Commence l'numration des sources de tension accessibles par la librairie.
YVSource FirstVSource( )
Utiliser la fonction YVSource.nextVSource() pour itrer sur les autres sources de tension.
Retourne : un pointeur sur un objet YVSource, correspondant la premire source de tension accessible en ligne, ou null si il n'y a pas de sources de tension disponibles.
vsource.describe()
string describe( )
vsource.get_advertisedValue()
Retourne la valeur courante de la source de tension (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante de la source de tension (pas plus de 6 caractres)
vsource.get_errorMessage()
www.yoctopuce.com
175
vsource.get_errorType()
vsource.get_extPowerFailure()
Rend TRUE si le voltage de l'alimentation externe est trop bas.
int get_extPowerFailure( ) Retourne : soit Y_EXTPOWERFAILURE_FALSE, soit Y_EXTPOWERFAILURE_TRUE
En cas d'erreur, dclenche une exception ou retourne Y_EXTPOWERFAILURE_INVALID.
vsource.get_failure()
Indique si le module est en condition d'erreur.
int get_failure( )
Il possible de savoir de quelle erreur il s'agit en testant get_overheat, get_overcurrent etc... Lorsqu'un condition d'erreur est renconte, la tension de sortie est mise zro est ne peut pas tre change tant la fonction reset() n'aura pas appelle.
Retourne : soit Y_FAILURE_FALSE, soit Y_FAILURE_TRUE
En cas d'erreur, dclenche une exception ou retourne Y_FAILURE_INVALID.
vsource.get_vsourceDescriptor()
vsource.get_hardwareId()
Retourne :
une chane de caractres identifiant la fonction En cas d'erreur, dclenche une exception ou retourne Y_HARDWAREID_INVALID.
vsource.get_logicalName()
Retourne le nom logique de la source de tension.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique de la source de tension
vsource.get_module()
vsource.get_overCurrent()
Rend TRUE si l'appareil connect la sortie du module consomme trop de courant.
int get_overCurrent( ) Retourne : soit Y_OVERCURRENT_FALSE, soit Y_OVERCURRENT_TRUE
En cas d'erreur, dclenche une exception ou retourne Y_OVERCURRENT_INVALID.
vsource.get_overHeat()
Rend TRUE si le module est en surchauffe.
www.yoctopuce.com
177
int get_overHeat( ) Retourne : soit Y_OVERHEAT_FALSE, soit Y_OVERHEAT_TRUE
En cas d'erreur, dclenche une exception ou retourne Y_OVERHEAT_INVALID.
vsource.get_overLoad()
Rend TRUE si le module n'est pas capable de tenir la tension de sortie demande.
int get_overLoad( ) Retourne : soit Y_OVERLOAD_FALSE, soit Y_OVERLOAD_TRUE
En cas d'erreur, dclenche une exception ou retourne Y_OVERLOAD_INVALID.
vsource.get_regulationFailure()
Rend TRUE si le voltage de sortie de trop lev par report la tension demande demande.
int get_regulationFailure( ) Retourne : soit Y_REGULATIONFAILURE_FALSE, soit Y_REGULATIONFAILURE_TRUE
En
cas
d'erreur,
dclenche
une
exception
ou
retourne
Y_REGULATIONFAILURE_INVALID.
vsource.get_unit()
Retourne l'unit dans laquelle la tension est exprime.
string get_unit( ) Retourne : une chane de caractres reprsentant l'unit dans laquelle la tension est exprime
vsource.get_userData()
vsource.get_voltage()
Retourne la valeur de la commande de tension de sortie en mV
int get_voltage( ) Retourne :
un entier reprsentant la valeur de la commande de tension de sortie en mV
En cas d'erreur, dclenche une exception ou retourne Y_VOLTAGE_INVALID.
vsource.isOnline()
bool isOnline( )
vsource.load()
Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. Par dfaut, lorsqu'on accde un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dure standard (5 ms). Cette mthode peut tre
www.yoctopuce.com
179
utilise pour marquer occasionellement les donnes caches comme valides pour une plus longue priode, par exemple dans le but de rduire le trafic rseau. Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutt qu'une simple valeur de retour, pour viter de bloquer la VM Javascript de Firefox, qui n'implmente pas le passage de contrle entre threads durant les appels d'entre/sortie bloquants.
vsource.nextVSource()
Continue l'numration des sources de tension commence l'aide de yFirstVSource ().
YVSource nextVSource( ) Retourne : un pointeur sur un objet YVSource accessible en ligne, ou null lorsque l'numration est termine.
vsource.pulse()
Active la sortie une tension donne, et pour dure spcifie, puis revient ensuite spontanment zro volt.
int pulse( int voltage, int ms_duration) Paramtres : voltage tension demande, en millivolts ms_duration dure de l'impulsion, en millisecondes Retourne :

vsource.registerValueCallback()
www.yoctopuce.com
180
vsource.reset()
Rinitilialise la sortie du module.
int reset( )
Cette fonction doit tre appele aprs une condition d'erreur. Aprs toute condition d'erreur, le voltage de sortie est mis zro et ne peut pas tre chang tant que cette fonction n'aura pas t appele.
Retourne :

vsource.set_logicalName()
Modifie le nom logique de la source de tension.
Paramtres : newval une chane de caractres reprsentant le nom logique de la source de tension Retourne :

vsource.set_userData()
vsource.set_voltage()
Rgle la tension de sortie du module (en milliVolts).
int set_voltage( int newval) Paramtres : newval un entier Retourne :

www.yoctopuce.com
181
vsource.voltageMove()
Dclenche une variation constante de la sortie vers une valeur donne.
int voltageMove( int target, int ms_duration) Paramtres : target nouvelle valeur de sortie la fin de la transition, en milliVolts. ms_duration dure de la transition, en millisecondes Retourne :

3.22. Interface de la fonction Wireless

yocto_wireless.cs
Fonction globales
yFindWireless(func) Permet de retrouver une interface rseau sans fil d'aprs un identifiant donn. yFirstWireless() Commence l'numration des interfaces rseau sans fil accessibles par la librairie.
Mthodes des objets YWireless

wirelessadhocNetwork(ssid, securityKey) Modifie la configuration de l'interface rseau sans fil pour crer un rseau sans fil sans point d'accs, en mode "ad-hoc". wirelessdescribe() Retourne un court texte dcrivant la fonction. wirelessget_advertisedValue() Retourne la valeur courante de l'interface rseau sans fil (pas plus de 6 caractres). wirelessget_channel() Retourne le numro du canal 802. wirelessget_errorMessage() Retourne le message correspondant la dernire erreur survenue lors de l'utilisation de la fonction. wirelessget_errorType() Retourne le code d'erreur correspondant la dernire erreur survenue lors de l'utilisation de la fonction. wirelessget_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction. wirelessget_hardwareId() Retourne l'identifiant unique de la fonction. wirelessget_linkQuality() Retourne la qualit de la connection, exprime en pourcents. wirelessget_logicalName() Retourne le nom logique de l'interface rseau sans fil. wirelessget_module() Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction.
www.yoctopuce.com
182
wirelessget_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui hberge la fonction. wirelessget_security() Retourne l'algorithme de scurit utilis par le rseau sans-fil slectionn. wirelessget_ssid() Retourne le nom (SSID) du rseau sans-fil slectionn. wirelessget_userData() Retourne le contenu de l'attribut userData, prcdemment stock l'aide de la mthode set_userData. wirelessisOnline() Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. wirelessisOnline_async(callback, context) Vrifie si le module hbergeant la fonction est joignable, sans dclencher d'erreur. wirelessjoinNetwork(ssid, securityKey) Modifie la configuration de l'interface rseau sans fil pour se connecter un point d'accs sans fil existant (mode "infrastructure"). wirelessload(msValidity) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. wirelessload_async(msValidity, callback, context) Met en cache les valeurs courantes de la fonction, avec une dure de validit spcifie. wirelessnextWireless() Continue l'numration
des
interfaces
rseau
sans
fil
commence
l'aide
de
yFirstWireless().
wirelessregisterValueCallback(callback) Enregistre la fonction de callback qui est appele chaque changement de la valeur publie. wirelessset_logicalName(newval) Modifie le nom logique de l'interface rseau sans fil. wirelessset_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard l'aide de la mthode get_userData.
YWireless.FindWireless()
Permet de retrouver une interface rseau sans fil d'aprs un identifiant donn.
YWireless FindWireless( string func)
Cette fonction n'exige pas que l'interface rseau sans fil soit en ligne au moment ou elle est appele, l'objet retourn sera nanmoins valide. Utiliser la mthode YWireless.isOnline () pour tester si l'interface rseau sans fil est utilisable un moment donn. En cas d'ambigut lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifie: la premire instance trouve sera renvoye. La recherche se fait d'abord par nom matriel, puis par nom logique.
www.yoctopuce.com
183
Paramtres : func une chane de caractres qui rfrence l'interface rseau sans fil sans ambigut Retourne : un objet de classe YWireless qui permet ensuite de contrler l'interface rseau sans fil.
YWireless.FirstWireless()
Commence l'numration des interfaces rseau sans fil accessibles par la librairie.
YWireless FirstWireless( )
Utiliser la fonction YWireless.nextWireless() pour itrer sur les autres interfaces rseau sans fil.
Retourne : un pointeur sur un objet YWireless, correspondant la premire interface rseau sans fil accessible en ligne, ou null si il n'y a pas de interfaces rseau sans fil disponibles.
wireless.adhocNetwork()
Modifie la configuration de l'interface rseau sans fil pour crer un rseau sans fil sans point d'accs, en mode "ad-hoc".
int adhocNetwork( string ssid, string securityKey)
Si une clef d'accs est spcifie, le rseau sera protg par une scurit WEP128 (l'utilisation de WPA n'est pas standardise en mode ad-hoc). N'oubliez pas d'appeler la mthode saveToFlash() et de redmarrer le module pour que le paramtre soit appliqu.
Paramtres : ssid nom du rseau sans fil crer securityKey cl d'accs de rseau, sous forme de chane de caractres Retourne :

wireless.describe()
string describe( )
wireless.get_advertisedValue()
Retourne la valeur courante de l'interface rseau sans fil (pas plus de 6 caractres).
string get_advertisedValue( ) Retourne : une chane de caractres reprsentant la valeur courante de l'interface rseau sans fil (pas plus de 6 caractres)
www.yoctopuce.com
184
wireless.get_channel()
Retourne le numro du canal 802.
int get_channel( )
11 utilis, ou 0 si le rseau slectionn n'a pas t trouv.

Retourne : un entier reprsentant le numro du canal 802
En cas d'erreur, dclenche une exception ou retourne Y_CHANNEL_INVALID.
wireless.get_errorMessage()
wireless.get_errorType()
wireless.get_wirelessDescriptor()
wireless.get_hardwareId()
www.yoctopuce.com
185
wireless.get_linkQuality()
Retourne la qualit de la connection, exprime en pourcents.
int get_linkQuality( ) Retourne : un entier reprsentant la qualit de la connection, exprime en pourcents
En cas d'erreur, dclenche une exception ou retourne Y_LINKQUALITY_INVALID.
wireless.get_logicalName()
Retourne le nom logique de l'interface rseau sans fil.
string get_logicalName( ) Retourne : une chane de caractres reprsentant le nom logique de l'interface rseau sans fil
wireless.get_module()
wireless.get_security()
Retourne l'algorithme de scurit utilis par le rseau sans-fil slectionn.
www.yoctopuce.com
186
int get_security( ) Retourne : une valeur parmi Y_SECURITY_UNKNOWN, Y_SECURITY_OPEN, Y_SECURITY_WEP, Y_SECURITY_WPA et Y_SECURITY_WPA2 reprsentant l'algorithme de scurit utilis par le rseau sans-fil slectionn
En cas d'erreur, dclenche une exception ou retourne Y_SECURITY_INVALID.
wireless.get_ssid()
Retourne le nom (SSID) du rseau sans-fil slectionn.
string get_ssid( ) Retourne : une chane de caractres reprsentant le nom (SSID) du rseau sans-fil slectionn
En cas d'erreur, dclenche une exception ou retourne Y_SSID_INVALID.
wireless.get_userData()
wireless.isOnline()
bool isOnline( )
Paramtres : callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le rsultat boolen
www.yoctopuce.com
187
context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
wireless.joinNetwork()
Modifie la configuration de l'interface rseau sans fil pour se connecter un point d'accs sans fil existant (mode "infrastructure").
int joinNetwork( string ssid, string securityKey)
N'oubliez pas d'appeler la mthode saveToFlash() et de redmarrer le module pour que le paramtre soit appliqu.
Paramtres : ssid nom du rseau sans fil utiliser securityKey cl d'accs au rseau, sous forme de chane de caractres Retourne :

wireless.load()
Paramtres : msValidity un entier correspondant la dure de validit attribue aux les paramtres chargs, en millisecondes callback fonction de callback qui sera appele ds que le rsultat sera connu. La fonction callback reoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concern et le code d'erreur (ou YAPI_SUCCESS) context contexte fourni par l'appelant, et qui sera pass tel-quel la fonction de callback
www.yoctopuce.com
188
Retourne : rien du tout : le rsultat sera pass en paramtre la fonction de callback.
wireless.nextWireless()
Continue l'numration des interfaces rseau sans fil commence l'aide de yFirstWireless().
YWireless nextWireless( ) Retourne : un pointeur sur un objet YWireless accessible en ligne, ou null lorsque l'numration est termine.
wireless.registerValueCallback()
wireless.set_logicalName()
Modifie le nom logique de l'interface rseau sans fil.
Paramtres : newval une chane de caractres reprsentant le nom logique de l'interface rseau sans fil Retourne :

wireless.set_userData()
www.yoctopuce.com
189
4. Index
A adhocNetwork API C calibrate calibrateFromPoints callbackLogin CheckLogicalName D describe DisableExceptions E EnableExceptions EnableUSBHost F FindAnButton FindCarbonDioxide FindColorLed FindCurrent FindDataLogger FindDualPower FindHubPort FindHumidity FindLed FindLightSensor FindModule FindNetwork FindPressure FindRelay FindServo FindTemperature FindVoltage FindVSource FindWireless FirstAnButton FirstCarbonDioxide FirstColorLed FirstCurrent FirstDataLogger FirstDualPower FirstHubPort FirstHumidity FirstLed 184 10 99 28 120 11 19 11 11 12 18 28 36 45 53 68 75 82 91 99 108 119 132 140 148 156 165 174 183 18 28 37 45 54 68 75 83 91
www.yoctopuce.com
190
FirstLightSensor FirstModule FirstNetwork FirstPressure FirstRelay FirstServo FirstTemperature FirstVoltage FirstVSource FirstWireless forgetAllDataStreams FreeAPI functionCount functionId functionName functionValue G get_adminPassword get_advertisedValue get_analogCalibration get_autoStart get_averageValue get_baudRate get_beacon get_blinking get_calibratedValue get_calibrationMax get_calibrationMin get_callbackCredentials get_callbackMaxDelay get_callbackMinDelay get_callbackUrl get_channel get_columnCount get_columnNames get_currentRawValue get_currentRunIndex get_currentValue get_data get_dataRows get_dataRun get_dataSamplesInterval get_dataStreams get_duration get_enabled get_errorMessage get_errorType get_extPowerFailure get_extVoltage get_failure get_firmwareRelease get_functionDescriptor get_hardwareId get_highestValue get_hslColor get_icon2d get_ipAddress get_isPressed get_lastTimePressed get_lastTimeReleased get_linkQuality get_logicalName get_lowestValue get_luminosity
99 108 120 132 141 149 157 166 175 184 54 12 109 109 109 109 120 19 19 55 62 76 110 92 19 19 20 121 121 121 121 185 64 64 29 55 29 65 65 55 65 55 62 76 20 20 176 69 176 110 20 21 30 38 111 122 21 21 21 186 21 31 93
www.yoctopuce.com
191
get_macAddress get_maxValue get_measureNames get_minValue get_module get_module_async get_neutral get_oldestRunIndex get_output get_overCurrent get_overHeat get_overLoad get_persistentSettings get_portState get_position get_power get_powerControl get_powerState get_primaryDNS get_productId get_productName get_productRelease get_pulseTimer get_range get_rawValue get_readiness get_rebootCountdown get_recording get_regulationFailure get_resolution get_rgbColor get_rgbColorAtPowerOn get_router get_rowCount get_runIndex get_secondaryDNS get_security get_sensitivity get_sensorType get_serialNumber get_ssid get_startTime get_startTimeUTC get_state get_subnetMask get_timeUTC get_unit get_upTime get_usbBandwidth get_usbCurrent get_userData get_userPassword get_valueCount get_valueInterval get_voltage GetAPIVersion GetTickCount H HandleEvents hslMove I InitAPI isOnline isOnline_async
123 62 57 62 22 22 151 57 143 177 177 178 111 78 151 94 71 71 123 112 112 112 143 151 22 124 112 57 178 31 39 39 124 65 66 124 186 22 160 112 187 66 63 143 124 58 32 113 113 113 22 125 63 63 178 12 12 12 40 13 23 23
www.yoctopuce.com
192
J joinNetwork L load load_async M move N nextAnButton nextCarbonDioxide nextColorLed nextCurrent nextDataLogger nextDualPower nextHubPort nextHumidity nextLed nextLightSensor nextModule nextNetwork nextPressure nextRelay nextServo nextTemperature nextVoltage nextVSource nextWireless P pulse R reboot RegisterDeviceArrivalCallback RegisterDeviceRemovalCallback RegisterHub RegisterLogFunction registerValueCallback reset revertFromFlash rgbMove S saveToFlash set_adminPassword set_analogCalibration set_autoStart set_beacon set_blinking set_calibrationMax set_calibrationMin set_callbackCredentials set_callbackMaxDelay set_callbackMinDelay set_callbackUrl set_enabled set_highestValue set_hslColor set_logicalName set_lowestValue set_luminosity set_neutral set_output set_position set_power set_powerControl set_primaryDNS 23 24 153 24 33 41 50 59 72 80 88 95 105 114 126 137 145 153 162 171 180 189 145 115 13 13 14 14 24 181 115 42 115 127 24 60 115 96 25 25 127 127 128 128 80 34 42 25 34 96 154 146 154 97 73 128 188
www.yoctopuce.com
193
set_range set_recording set_rgbColor set_rgbColorAtPowerOn set_secondaryDNS set_sensitivity set_sensorType set_state set_timeUTC set_usbBandwidth set_userData set_userPassword set_valueInterval set_voltage SetDelegate SetTimeout Sleep T triggerFirmwareUpdate U UnregisterHub UpdateDeviceList UpdateDeviceList_async useDHCP useStaticIP V voltageMove Y YAnButton YCarbonDioxide YColorLed YCurrent YDataLogger YDataRun YDataStream YDualPower YHubPort YHumidity YLed YLightSensor YModule YNetwork YPressure YRelay YServo YTemperature YVoltage YVSource YWireless
154 60 42 43 129 26 163 146 61 116 26 129 63 181 14 15 15 117 15 15 16 130 130 181 16 26 35 43 52 61 63 66 74 81 90 97 106 117 130 139 147 155 164 173 182
www.yoctopuce.com
194

Yoctolib Cs FR

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Yoctolib Cs FR

Загружено:

Авторское право:

Доступные форматы

Rfrence de l'API C# .

Table des matires

2.2. Utilisation l'API yoctopuce dans un projet $LANG$

Configuration d'un projet $LANG$

2.3. Contrle de la fonction Led

Voyons maintenant en dtail ce que font ces quelques lignes.

changer le filtre de la fentre de slection de fichiers, sinon la DLL n'apparatra pas 5

2.4. Contrle de la partie module

Modifications des rglages du module

Enumeration des modules

while (m!=null) { Console.WriteLine(m.get_serialNumber() + " (" + m.get_productName() + ")"); m = m.nextModule(); } } } }

2.5. Gestion des erreurs

En cas d'erreur, dclenche une exception

"Majeure.Mineure.NoBuild", par exemple "1.01.5535". Pour les langages utilisant

pour supprimer un callback dja enregistr.

pour supprimer un callback dja enregistr.

Utile pour dbugger le fonctionnement de l'API.

ou null pour supprimer un callback dja enregistr.

pour supprimer un objet dja enregistr.

une chane de caractres contenant "usb" ou

l'URL racine du VirtualHub ne plus utiliser.

3.2. Interface de la fonction AnButton

Mthodes des objets YAnButton

En cas d'erreur, dclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_CALIBRATEDVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_CALIBRATIONMAX_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_CALIBRATIONMIN_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_ISPRESSED_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_LASTTIMEPRESSED_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_LASTTIMERELEASED_INVALID.

une chane de caractres reprsentant le nom logique de l'entre analogique

En cas d'erreur, dclenche une exception ou retourne Y_LOGICALNAME_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_RAWVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_SENSITIVITY_INVALID.

YAPI_SUCCESS si l'opration se droule sans erreur.

YAPI_SUCCESS si l'opration se droule sans erreur.

YAPI_SUCCESS si l'opration se droule sans erreur.

YAPI_SUCCESS si l'opration se droule sans erreur.

En cas d'erreur, dclenche une exception ou retourne un code d'erreur ngatif.

YAPI_SUCCESS si l'opration se droule sans erreur.

3.3. Interface de la fonction CarbonDioxide

Mthodes des objets YCarbonDioxide

YAPI_SUCCESS si l'opration se droule sans erreur.

En cas d'erreur, dclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_CURRENTVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_HIGHESTVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_LOGICALNAME_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_LOWESTVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_RESOLUTION_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_UNIT_INVALID.

rien du tout : le rsultat sera pass en paramtre la fonction de callback.

YAPI_SUCCESS si l'opration se droule sans erreur.

YAPI_SUCCESS si l'opration se droule sans erreur.

YAPI_SUCCESS si l'opration se droule sans erreur.

void set_userData( object data)

3.4. Interface de la fonction ColorLed

Mthodes des objets YColorLed

En cas d'erreur, dclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_HSLCOLOR_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_LOGICALNAME_INVALID.

En cas d'erreur, dclenche une exception ou retourne Y_RGBCOLOR_INVALID.

YAPI_SUCCESS si l'opration se droule sans erreur.

YAPI_SUCCESS si l'opration se droule sans erreur.