1.2. Conditions environnementales ..................2. Présentation ..........................2.1. Les éléments communs ...................... 2.2. Les éléments spécifiques ....................3. Les fonctions du Yocto-Inclinometer ................3.1. Les trois inclinomètres ....................... 3.2. L'accéléromètre 3D ......................3.3. Le référentiel ........................3.4. Capteur de température ......................
Page 4
6.7. DataLogger ......................... 6.8. Quelle interface: Native, DLL ou Service? ............... 6.9. Programmation, par où commencer? ................7. Utilisation du Yocto-Inclinometer en ligne de commande ......7.1. Installation .......................... 7.2. Utilisation: description générale ..................7.3. Contrôle de la fonction Tilt ....................
Page 5
15. Utilisation du Yocto-Inclinometer en JavaScript / EcmaScript ..... 15.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ....... 15.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ......15.3. Contrôle de la fonction Tilt ................... 15.4. Contrôle de la partie module ..................
Page 6
25.5. Module alimenté mais invisible pour l'OS ..............25.6. Another process named xxx is already using yAPI ............ 25.7. Déconnexions, comportement erratique ..............25.8. RegisterHub d'un VirtualHub déconnecte le précédent ..........25.9. Commandes ignorées ....................25.10. Module endommagé ....................26. Caractéristiques ......................www.yoctopuce.com...
Les ingénieurs Yoctopuce se sont donné beaucoup de mal pour que votre Yocto-Inclinometer soit facile à installer n'importe où et soit facile à piloter depuis un maximum de langages de programmation. Néanmoins, si ce module venait à vous décevoir, ou si vous avez besoin d'informations supplémentaires, n'hésitez pas à...
Boîtier de protection Le Yocto-Inclinometer ne doit pas être utilisé sans boîtier de protection, en raison des composants électriques à nu. Pour une sécurité optimale, il devrait être mis dans un boîtier non métallique, non- inflammable, résistant à...
été déterminée en fonction des recommandations officielles des fabricants des composants utilisés dans le Yocto-Inclinometer, et par des tests de durée limitée (1h) dans les conditions extrêmes, en environnement controllé. Si vous envisagez d'utiliser le Yocto-Inclinometer dans des conditions de température extrêmes pour une période prolongée, il est recommandé...
Tous les Yocto-modules ont un certain nombre de fonctionnalités en commun. Le connecteur USB Les modules de Yoctopuce sont tous équipés d'une connectique USB 2.0 au format micro-B. Attention, le connecteur USB est simplement soudé en surface et peut être arraché si la prise USB venait à...
2.2. Les éléments spécifiques Les capteurs Le Yocto-Inclinometer utilise un capteur SCL3300 de Murata qui combine trois accéléromètres à bas bruit et utilise leur valeurs pour calculer l'orientation du module. Attention, il s'agit d'un composant relativement fragile: il peut être définitivement abîmé si il subit un choc tel qu'une chute sur une surface dure.
X et Y du module. Le troisième renvoie 90° moins l'angle entre la verticale et l'axe Z du module. Il est important de comprendre que le Yocto-Inclinometer ne contient pas de boussole, il ne peut pas mesurer l'orientation horizontale du module.
Z du module. Si on imagine que le Yocto-Inclinometer est monté dans une voiture, il peut être fixé sur la paroi de gauche (LEFT), sur la paroi de droite (RIGHT), sur le plancher (BOTTOM), au plafond (TOP), à...
Yoctopuce. Vis et entretoises Pour fixer le module Yocto-Inclinometer à un support, vous pouvez placer des petites vis de 2.5mm avec une tête de 4.5mm au maximum dans les trous prévus ad-hoc. Il est conseillé de les visser dans des entretoises filetées, que vous pourrez fixer sur le support. Vous trouverez plus de détail à...
Page 16
VirtualHub. Connecteurs 1.27mm (ou 1.25mm) Si vous désirez raccorder le module Yocto-Inclinometer à un Micro-hub USB ou a un YoctoHub en évitant l'encombrement d'un vrai cable USB, vous pouvez utiliser les 4 pads au pas 1.27mm juste derrière le connecteur USB.
Linux est fait via l'API standard de la libusb, disponible aussi pour FreeBSD par exemple. Yoctopuce teste régulièrement le bon fonctionnement des modules sur un kernel Linux 4.15 (Ubuntu 18.04 LTS).
Yoctopuce. Vous devez raccorder votre module Yocto-Inclinometer à l'aide d'un cable USB 2.0 de type A - micro B Si vous branchez un hub USB entre l'ordinateur et le module Yocto-Inclinometer, prenez garde à ne pas dépasser les limites de courant imposées par USB, sous peine de faire face des comportements...
. Lancez le Virtual Hub en ligne de commande, ouvrez votre browser préféré et tapez l'adresse http://127.0.0.1:4444. Vous devriez voir apparaître la liste des modules Yoctopuce raccordés à votre ordinateur. Liste des modules telle qu'elle apparaît dans votre browser. 4.3. Localisation Il est alors possible de localiser physiquement chacun des modules affichés en cliquant sur le bouton...
4. Premiers pas Cette fenêtre vous permet entre autres de jouer avec votre module pour en vérifier son fonctionnement. Les valeurs de mesurées par le Yocto-Inclinometer y sont en effet affichées en temps réel, sous forme numérique et sous forme graphique.
Page 21
Nom logique des fonctions Chaque module Yoctopuce a un numéro de série, et un nom logique. De manière analogue, chaque fonction présente sur chaque module Yoctopuce a un nom matériel et un nom logique, ce dernier pouvant être librement choisi par l'utilisateur. Utiliser des noms logiques pour les fonctions permet une plus grande flexibilité...
Exemples de montage sur un support. Le module Yocto-Inclinometer dispose de trous de montage 2.5mm. Vous pouvez utiliser ces trous pour y passer des vis. Le diamètre de la tête de ces vis ne devra pas dépasser 4.5mm, sous peine d'endommager les circuits du module.
Attention, les modules Yoctopuce sécables ont souvent des systèmes de connectique très semblables. Cependant les sous-modules ne sont pas du tout compatibles entre modèles différents. Si vous raccordez un sous module de votre Yocto-Inclinometer à un autre type de module, cela ne marchera pas, et vous risquez fort d'endommager votre matériel.
Page 25
2000mA, ça ne marche pas trop mal, et cela fait rarement des dégâts. Ce que vous devez en retenir: si vous branchez des modules Yoctopuce via un ou des hubs non alimentés, vous n'aurez aucun garde-fou et dépendrez entièrement du soin qu'aura mis le fabricant de votre ordinateur pour fournir un maximum de courant sur les ports USB et signaler les excès...
6.1. Paradigme de programmation L'API Yoctopuce est une API orientée objet. Mais dans un souci de simplicité, seules les bases de la programmation objet ont été utilisées. Même si la programmation objet ne vous est pas familière, il est peu probable que cela vous soit un obstacle à...
Page 28
Programmation Dans l'API Yoctopuce, la priorité a été mise sur la facilité d'accès aux fonctionnalités des modules en offrant la possibilité de faire abstraction des modules qui les implémentent. Ainsi, il est parfaitement possible de travailler avec un ensemble de fonctionnalités sans jamais savoir exactement quel module les héberge au niveau matériel.
6.2. Le module Yocto-Inclinometer Le module Yocto-Inclinometer fournit deux fonctions Tilt permettant de mesurer précisément l'angle du module par rapport au plan horizontal. module : Module attribut...
Page 30
Nombre (virgule fixe) lecture seule signalValue Texte lecture seule signalUnit Texte modifiable command dataLogger : DataLogger attribut type modifiable ? Texte modifiable logicalName Texte modifiable advertisedValue Nombre entier lecture seule currentRunIndex Heure UTC modifiable timeUTC Type énuméré modifiable recording www.yoctopuce.com...
Chaine de caractères contenant le numéro de série, unique et préprogrammé en usine. Pour un module Yocto-Inclinometer, ce numéro de série commence toujours par YCLINOM1. Il peut servir comme point de départ pour accéder par programmation à un module particulier.
Interface pour intéragir avec les inclinomètres, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La classe est la classe parente de tous les types de capteurs Yoctopuce. Elle permet de YSensor lire la valeur courante et l'unité de n'importe quel capteur, de lire les valeurs min/max, de configurer la fréquence d'enregistrement autonome des données et de récupérer les mesures enregistrées.
Interface pour intéragir avec les accéléromètres, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La classe permet de lire et de configurer les accéléromètres Yoctopuce. Elle YAccelerometer hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de YSensor mesures, callbacks, enregistreur de données.
Interface de configuration du référentiel 3D, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La class permet de configurer l'orientation des capteurs inertiels Yoctopuce. Cela YRefFrame permet aux fonctions d'orientation relatives au plan de la surface terrestre d'utiliser le référentiel approprié.
Algorithme de fusion utilisé pour combiner l'accéléromètre, le gyroscope et la boussole (si supporté). 6.7. DataLogger Interface de contrôle de l'enregistreur de données, présent sur la plupart des capteurs Yoctopuce. La plupart des capteurs Yoctopuce sont équipés d'une mémoire non-volatile. Elle permet de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un...
Attribut qui peut être mis à vrai pour effacer l'historique des mesures. 6.8. Quelle interface: Native, DLL ou Service? Il y existe plusieurs méthodes pour contrôler un module USB Yoctopuce depuis un programme. Contrôle natif Dans ce cas de figure le programme pilotant votre projet est directement compilé avec une librairie qui offre le contrôle des modules.
Page 37
Certain langages ne permettent tout simplement pas d'accéder facilement au niveau matériel de la machine. C'est le cas de Javascript par exemple. Pour gérer ce cas Yoctopuce offre la solution sous la forme d'un petit service, appelé VirtualHub qui lui est capable d'accéder aux modules, et votre application n'a plus qu'à...
Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto- Inclinometer. Il est temps de passer à la pratique. Il vous faut télécharger la librairie Yoctopuce pour votre language de programmation favori depuis le site web de Yoctopuce .
Page 39
6. Programmation, concepts généraux Une fois que vous maîtriserez la programmation de base de votre module, vous pourrez vous intéresser au chapitre concernant la programmation avancée qui décrit certaines techniques qui vous permettront d'exploiter au mieux votre Yocto-Inclinometer. www.yoctopuce.com...
7. Utilisation du Yocto-Inclinometer en ligne de commande Lorsque vous désirez effectuer une opération ponctuelle sur votre Yocto-Inclinometer, comme la lecture d'une valeur, le changement d'un nom logique, etc.. vous pouvez bien sur utiliser le Virtual Hub, mais il existe une méthode encore plus simple, rapide et efficace: l'API en ligne de commande.
C:\>executable commande /help Pour obtenir une description détaillée des paramètres d'une commande. 7.3. Contrôle de la fonction Tilt Pour contrôler la fonction Tilt de votre Yocto-Inclinometer, vous avez besoin de l'exécutable YTilt. Vous pouvez par exemple lancer: C:\>YTilt get_currentValue Cet exemple utilise la cible "any" pour signifier que l'on désire travailler sur la première fonction Tilt trouvée parmi toutes celles disponibles sur les modules Yoctopuce accessibles au moment de...
7. Utilisation du Yocto-Inclinometer en ligne de commande 7.4. Contrôle de la partie module Chaque module peut être contrôlé d'une manière similaire à l'aide de l'exécutable . Par YModule exemple, pour obtenir la liste de tous les modules connectés, utilisez: C:\>YModule inventory...
Page 44
7. Utilisation du Yocto-Inclinometer en ligne de commande Vous obtenez un inventaire des modules connectés par USB, en utilisant un accès natif. Si il y a déjà une autre commande en cours qui accède aux modules en natif, cela ne fonctionnera pas. Mais si vous lancez un virtual hub et que vous lancez votre commande sous la forme: C:\>YModule -r 127.0.0.1 inventory...
Windows qu'Unix. C'est un language idéal pour écrire des petits scripts sur un coin de table. La librairie Yoctopuce est compatible avec Python 2.6+ et 3+. Elle fonctionne sous Windows, Max OS X et Linux tant Intel qu'ARM.
Page 46
8. Utilisation du Yocto-Inclinometer en Python Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code Python qui utilise la fonction Tilt. [...] # On active la détection des modules sur USB errmsg=YRefParam() YAPI.RegisterHub("usb",errmsg)
8. Utilisation du Yocto-Inclinometer en Python from yocto_api import from yocto_tilt import usage(): scriptname = os.path.basename(sys.argv[0]) print("Usage:") print(scriptname + <serial_number>') print(scriptname + <logical_name>') print(scriptname + ' any sys.exit() die(msg): sys.exit(msg + ' (check USB cable)') errmsg = YRefParam() if len(sys.argv) <...
Page 48
8. Utilisation du Yocto-Inclinometer en Python from yocto_api import usage(): sys.exit("usage: demo <serial or logical name> [ON/OFF]") errmsg = YRefParam() if YAPI.RegisterHub("usb", errmsg) != YAPI.SUCCESS: sys.exit("RegisterHub error: " str(errmsg)) if len(sys.argv) < usage() = YModule.FindModule(sys.argv[1]) # # use serial or logical name m.isOnline():...
La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
Page 50
8. Utilisation du Yocto-Inclinometer en Python Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à 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 gère, et tout se passe bien.
à la création d'un projet à neuf linké avec les librairies Yoctopuce. 9.1. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code C++ qui utilise la fonction Tilt. #include "yocto_api.h"...
Page 52
Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Inclinometer avec le numéros de série YCLINOM1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
9. Utilisation du Yocto-Inclinometer en C++ 9.2. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
Page 55
9. Utilisation du Yocto-Inclinometer en C++ Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire vive du set_xxx() module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration...
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
ASCII, etc.); • Elle facilite le déboggage si vous cherchez la cause d'un problème lié à la librairie Yoctopuce • Elle réduit les dépendances sur des composants tiers, par exemple pour parer au cas où vous pourriez être mené...
Page 58
(...) -Wl,-Bstatic -lyocto-static -Wl,-Bdynamic -lm -lpthread -lusb-1.0 -lstdc++ Intégration en librairie dynamique L'intégration de la librairie Yoctopuce sous forme de librairie dynamique permet de produire un exécutable plus petit que les deux méthodes précédentes, et de mettre éventuellement à jour cette librairie si un correctif s'avérait nécessaire sans devoir recompiler le code source de l'application.
10.2. Utilisation l'API yoctopuce dans un projet Visual C# La librairie Yoctopuce pour Visual C# .NET se présente sous la forme d'une DLL et de fichiers sources en Visual C#. La DLL n'est pas une DLL .NET mais une DLL classique, écrite en C, qui gère les communications à...
Il va de soit que que les fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique. 10.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code C# qui utilise la fonction Tilt. [...] // On active la détection des modules sur USB...
Page 61
10. Utilisation du Yocto-Inclinometer en C# tilt = YTilt.FindTilt("MonModule.MaFonction"); tilt = YTilt.FindTilt("MaFonction"); renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler YTilt.FindTilt l'inclinomètre. isOnline La méthode de l'objet renvoyé par permet de savoir si le module isOnline() YTilt.FindTilt...
10. Utilisation du Yocto-Inclinometer en C# 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());...
Page 65
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
Virtual Instruments (VI) des programmes LabVIEW. Avec la programmation visuelle, dessiner des algorithmes complexes devient très vite fastidieux, c'est pourquoi la librairie Yoctopuce pour LabVIEW a été pensée pour être aussi simple de possible à utiliser. Autrement dit, LabVIEW étant un environnement extrêmement différent des autres langages supportés par l'API Yoctopuce, vous rencontrerez des différences majeures entre l'API LabVIEW et...
Yoctopuce, ces derniers doivent avoir au moins le firmware 37120 LabVIEW pour Linux et MacOS Au moment de l'écriture de ce manuel, l'API Yoctopuce pour LabVIEW n'a été testée que sous Windows. Il y a donc de fortes chances pour qu'elle ne fonctionne tout simplement pas avec les versions Linux et MacOS de LabVIEW.
Page 69
Pour pouvoir utiliser les exemples fournis avec l'API, vous aurez avantage à ajouter le répertoire des VIs Yoctopuce dans la liste des répertoires où LabVIEW doit chercher les VIs qu'il n'a pas trouvé. Cette liste est accessible via le menu Tools > Options > Paths > VI Search Path.
Page 70
à faire en sorte qu'ils ne soit pas effacés tant que vous en aurez besoin. Voici ce que fait exactement l'installeur quand cette option est choisie: • Toute référence à des répertoires contenant une version quelconque de la librairie Yoctopuce sont supprimés de l'option viSearchPath dans le fichier labview.ini.
Page 71
Notez cependant que les exemples de programmation ne sont pas copiés. Voici ce que fait l'installeur exactement: • Toute référence à des répertoires contenant une version quelconque de la librairie Yoctopuce sont supprimés de l'option viSearchPath dans le fichier labview.ini.
Page 72
\Yoctopuce\API que vous avez créé au point 1 et cliquez sur Current Folder Tous les VIs Yoctopuce vont apparaitre dans la fenêtre Yoctopuce. Par défaut, ils sont triés dans l'ordre alphabétique, mais vous pouvez les arranger comme bon vous semble en les glissant avec la souris.
Yoctopuce et avec tous les VIs de l'API 11.4. Présentation des VIs Yoctopuce La librairie Yoctopuce pour LabVIEW comprend un VI par classe de l'API Yoctopuce, plus quelques VI spéciaux. Tous les VIs disposent des connecteurs traditionnels Error IN et Error Out.
Page 74
à moins que le paramètre async ne soit mis à TRUE. Si async est mis à TRUE, aucune erreur ne sera générée, et les modules Yoctopuce correspondant à cette adresse IP seront automatiquement mis à disposition dès que la machine concernée sera joignable.
Page 75
Utilisation du VI YModule pour retrouver les fonctions hébergés sur le même module Les VI senseurs Tous les VI correspondant à des senseurs Yoctopuce ont exactement la même géométrie. Les deux sorties permettent de récupérer la valeur mesurée par le capteur correspondant ainsi que l'unité...
élevés utiliser la syntaxe (x/s). La fréquence de mise à jour du VI est un paramètre géré par le module Yoctopuce physique. Si plusieurs VI essayent de changer la fréquence d'un même capteur, la configuration retenue sera celle du dernier appel.
Page 77
11. Utilisation du Yocto-Inclinometer avec LabVIEW Utilisation des sorties hardware name et isOnline Les VIs de l'API Yoctopuce ne sont qu'une porte d'entrée sur la mécanique interne de la librairie Yoctopuce. Cette mécanique fonctionne indépendamment des VIs Yoctopuce. En effet, la plupart des communications avec les modules électroniques sont gérées automatiquement en arrière plan.
VI pour chacune d'entre elles. C'est pourquoi il y a un VI par classe qui expose les deux propriétés que Yoctopuce a jugé les plus utiles, mais cela ne veut pas dire que les autres ne sont pas accessibles.
Page 79
Vous trouverez la description de toutes les propriétés, fonctions et méthodes disponibles dans la documentation de l'API .NET Proxy. Utilisation en réseau Sur une même machine, il ne peut y avoir qu'un seul processus qui accède aux modules Yoctopuce locaux directement par USB (url mis à ). Par contre, plusieurs processus peuvent se "usb"...
Connexion asynchrone 11.7. Gestion du datalogger Quasiment tous les senseurs Yoctopuce disposent d'un enregistreur de données qui permet de stocker les mesures des senseurs dans la mémoire non volatile du module. La configuration de l'enregistreur de données peut être réalisée avec le VirtualHub, mais aussi à l'aide d'un peu de code...
11. Utilisation du Yocto-Inclinometer avec LabVIEW Le VI YDataLoggerContents Extraire les données de l'enregistreur d'un module Yoctopuce est un processus lent qui peut prendre plusieurs dizaines de secondes. C'est pourquoi le VI qui permet cette opération a été conçu pour fonctionner de manière itérative.
Récupération de la liste de tous les modules connectés 11.9. Un mot sur les performances L'API Yoctopuce pour LabVIEW été optimisée de manière à ce que les tous les VIs et les propriétés de objets Proxy génèrent un minimum de communication avec les modules Yoctopuce. Ainsi vous pouvez les utiliser dans des boucles sans prendre de précaution particulière: vous n'êtes pas obligés...
Yoctopuce pour LabVIEW 11.11. Différences avec les autres API Yoctopuce Yoctopuce fait tout son possible pour maintenir une forte cohérence entre les différentes librairies de programmation. Cependant, LabVIEW étant un environnement clairement à part, il en résulte des différences importantes avec les autres librairies.
Il va de soit que que le fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique. 12.2. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code Java qui utilise la fonction Tilt. [...] // On active l'accès aux modules locaux à...
Page 86
Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Inclinometer avec le numéros de série YCLINOM1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
12. Utilisation du Yocto-Inclinometer en Java (args.length == 0) { anytilt = YTilt.FirstTilt(); (anytilt == null) { System.out.println("No module connected (check USB cable)"); System.exit(1); } else { anytilt = YTilt.FindTilt(args[0] + ".tilt1"); if (!anytilt.isOnline()){ System.out.println("Module not connected (check identification and USB cable)");...
Page 88
12. Utilisation du Yocto-Inclinometer en Java (module == null) { System.out.println("No module connected (check USB cable)"); System.exit(1); } else { module = YModule.FindModule(args[0]); // use serial or logical name try { (args.length > 1) { if (args[1].equalsIgnoreCase("ON")) { module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF);...
Page 89
12. Utilisation du Yocto-Inclinometer en Java String newname; = YModule.FindModule(args[0]); // use serial or logical name try { newname = args[1]; if (!YAPI.CheckLogicalName(newname)) System.out.println("Invalid name (" newname + ")"); System.exit(1); m.set_logicalName(newname); m.saveToFlash(); // do not forget this System.out.println("Module: serial= "...
La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
En revanche, comme il n'existe pas de VirtualHub tournant sous Android, il n'est pas possible de prendre le contrôle à distance de modules Yoctopuce pilotés par une machine sous Android. Bien sûr, l'API Java pour Android reste parfaitement capable de se connecter à un VirtualHub tournant sur un autre OS.
"USB Host" en AndroidManifest.xml ajoutant le tag <uses-feature android:name="android.hardware.usb.host" /> dans la section manifest <manifest ...> <uses-feature android:name="android.hardware.usb.host" />; Les YoctoHub sont un moyen simple et efficace d'ajouter une connectivité réseau à vos modules Yoctopuce. http:// www.yoctopuce.com/FR/products/category/extensions-et-reseau www.yoctopuce.com...
Page 93
13. Utilisation du Yocto-Inclinometer avec Android </manifest> Lors du premier accès à un module Yoctopuce, Android va ouvrir une fenêtre pour informer l'utilisateur que l'application va accéder module connecté. L'utilisateur peut refuser ou autoriser l a c c è s au périphérique. Si l'utilisateur accepte, l'application pourra accéder au périphérique connecté...
13. Utilisation du Yocto-Inclinometer avec Android 13.5. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code Java qui utilise la fonction Tilt. [...] // On active la détection des modules sur USB YAPI.EnableUSBHost(this);...
Page 95
13. Utilisation du Yocto-Inclinometer avec Android Un exemple réel Lancez votre environnement java et ouvrez le projet correspondant, fourni dans le répertoire Examples/Doc-Examples de la librairie Yoctopuce. Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret.
13. Utilisation du Yocto-Inclinometer avec Android @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long serial = parent.getItemAtPosition(pos).toString(); @Override public void onNothingSelected(AdapterView<?> arg0) final Runnable = new Runnable() public void run() (serial != null) { YSensor tilt1 YTilt.FindTilt(serial + ".tilt1");...
Page 97
13. Utilisation du Yocto-Inclinometer avec Android public class ModuleControl extends Activity implements OnItemSelectedListener private ArrayAdapter<String> aa; private YModule module = null; @Override public void onCreate(Bundle savedInstanceState) super.onCreate(savedInstanceState); setContentView(R.layout.modulecontrol); Spinner my_spin = (Spinner) findViewById(R.id.spinner1); my_spin.setOnItemSelectedListener(this); = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_item); aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item); my_spin.setAdapter(aa);...
Page 98
13. Utilisation du Yocto-Inclinometer avec Android DisplayModuleInfo(); @Override public void onNothingSelected(AdapterView<?> arg0) public void refreshInfo(View view) DisplayModuleInfo(); public void toggleBeacon(View view) (module == null) return; boolean = ((Switch) view).isChecked(); try { if (on) { module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF); } catch...
Page 100
13. Utilisation du Yocto-Inclinometer avec Android module.set_logicalName(newname); module.saveToFlash(); // do not forget this edit.setText(""); } catch (YAPI_Exception ex) { ex.printStackTrace(); DisplayModuleInfo(); Attention, le nombre de cycles d'écriture de la mémoire non volatile du module est limité. Passé cette limite plus rien ne garantit que la sauvegarde des réglages se passera correctement. Cette limite, liée à...
La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
JavaScript avant l'exécution, pour être ensuite interprêté par n'importe quel navigateur Web ou par Node.js. Cette librairie de programmation Yoctopuce permet donc de coder des applications JavaScript tout en bénéficiant d'un typage fort. Comme notre librairie EcmaScript, elle utilise les fonctionnalités asynchrones introduites dans la version ECMAScript 2017 et qui sont maintenant disponibles nativement dans tous les environnements JavaScript modernes.
• Installez ensuite TypeScript sur votre machine à l'aide de la commande: npm install -g typescript 2. Connectez-vous ensuite sur le site Web de Yoctopuce et téléchargez les éléments suivants: • La librairie de programmation pour TypeScript • Le programme VirtualHub pour Windows, Mac OS X ou Linux selon l'OS que vous utilisez.
14.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code TypeScript qui utilise la fonction Tilt. // En Node.js, on référence la librairie via son package NPM // En HTML, on utiliserait plutôt un path relatif (selon l'environnement)
Page 106
à en faire un petit programme d'exemple concret. Si le Yocto-Inclinometer n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où est branché le 127.0.0.1...
Page 107
14. Utilisation du Yocto-Inclinometer en TypeScript let tilt2: YTilt; let tilt3: YTilt; let count: number; async function startDemo(): Promise<void> await YAPI.LogUnhandledPromiseRejections(); // Setup the API to use the VirtualHub on local machine let errmsg: YErrorMsg = new YErrorMsg(); if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) { console.log('Cannot contact VirtualHub on 127.0.0.1:...
Le même exemple, mais dans un navigateur Si vous voulez voir comment utiliser la librairie dans un navigateur plutôt que dans Node.js, changez de répertoire et allez dans example_html/Doc-GettingStarted-Yocto-Inclinometer. Vous y trouverez un fichier html , et un fichier TypeScript similaire au code ci-dessus, app.html...
La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
Page 111
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
JavaScript / EcmaScript 2017, afin de la différentier de la précédente Librairie pour JavaScript qu'elle remplace. Cette librairie permet d'accéder aux modules Yoctopuce depuis tous les environnements JavaScript modernes. Elle fonctionne aussi bien depuis un navigateur internet que dans un environnement Node.js.
15. Utilisation du Yocto-Inclinometer en JavaScript / EcmaScript 15.1. Fonctions bloquantes et fonctions asynchrones en JavaScript JavaScript a été conçu pour éviter toute situation de concurrence durant l'exécution. Il n'y a jamais qu'un seul thread en JavaScript. Cela signifie que si un programme effectue une attente active durant une communication réseau, par exemple pour lire un capteur, le programme entier se trouve...
JavaScript fait partie de ces langages qui ne vous permettront pas d'accéder directement aux couches matérielles de votre ordinateur. C'est pourquoi si vous désirez travailler avec des modules USB branchés par USB, vous devrez faire tourner la passerelle de Yoctopuce appelée VirtualHub sur la machine à laquelle sont branchés les modules.
Page 116
15. Utilisation du Yocto-Inclinometer en JavaScript / EcmaScript npm instal -g babel-cli npm instal babel-preset-env Normalement vous demanderez à Babel de poser les fichiers transpilés dans un autre répertoire, nommé par exemple. Pour ce faire, utilisez par exemple les commandes suivantes: comopat babel --presets env demo.js --out-dir compat/...
Ce dernier appel asynchrone peut aussi être formulé comme: myModule.get_syncProxy().then(logInfoProxy); 15.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction Tilt. // En Node.js, on utilise la fonction require() // En HTML, on utiliserait <script src="...">...
Page 118
à en faire un petit programme d'exemple concret. Si le Yocto-Inclinometer n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où...
15. Utilisation du Yocto-Inclinometer en JavaScript / EcmaScript if(serial == '') { // by default use any connected module suitable for the demo let anysensor = YTilt.FirstTilt(); if(anysensor) { let module = await anysensor.module(); serial = await module.get_serialNumber(); document.getElementById('serial').value = serial;...
Page 121
15. Utilisation du Yocto-Inclinometer en JavaScript / EcmaScript console.log('luminosity: '+await module.get_luminosity()+'%'); console.log('beacon: '+(await module.get_beacon()==YModule.BEACON_ON ?'ON':'OFF')); console.log('upTime: '+parseInt(await module.get_upTime()/1000)+' sec'); console.log('USB current: '+await module.get_usbCurrent()+' mA'); console.log('logs:'); console.log(await module.get_lastLogs()); } else { console.log("Module not connected (check identification and USB cable)\n"); await YAPI.FreeAPI();...
La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
Page 123
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
Vous n'avez pas besoin d'installer de driver. 16.2. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code PHP qui utilise la fonction Tilt. include('yocto_api.php');...
Page 126
Yocto-Inclinometer. YAPI::RegisterHub La fonction permet d'indiquer sur quelle machine se trouve les modules YAPI::RegisterHub Yoctopuce, ou plus exactemenent sur quelle machine tourne le programme VirtualHub. Dans notre cas l'adresse indique la machine locale, en utilisant le port (le port 127.0.0.1:4444 4444 standard utilisé...
16. Utilisation du Yocto-Inclinometer en PHP browser favori. Vous trouverez aussi ce code dans le répertoire Examples/Doc-GettingStarted- Yocto-Inclinometer de la librairie Yoctopuce. Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret.
Page 128
16. Utilisation du Yocto-Inclinometer en PHP <HTML> <HEAD> <TITLE>Module Control</TITLE> </HEAD> <BODY> <FORM method='get'> <?php include('yocto_api.php'); // Use explicit error handling rather than exceptions YAPI::DisableExceptions(); // Setup the API to use the VirtualHub on local machine if(YAPI::RegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI::SUCCESS) { die("Cannot contact VirtualHub on 127.0.0.1 :...
Page 129
16. Utilisation du Yocto-Inclinometer en PHP de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration courante dans sa mémoire non volatile. Pour cela il faut utiliser la méthode saveToFlash() Inversement il est possible de forcer le module à oublier ses réglages courants en utilisant la méthode...
La librairie PHP est capable de fonctionner dans un mode spécial appelé Yocto-API par callback HTTP. Ce mode permet de contrôler des modules Yoctopuce installés derrière un filtre NAT tel qu'un routeur DSL par exemple, et ce sans avoir à un ouvrir un port. L'application typique est le contrôle de modules Yoctopuce situés sur réseau privé...
Page 131
16. Utilisation du Yocto-Inclinometer en PHP Les réponses aux requêtes venant des machines du LAN sont routées. Mais les requêtes venant de l'extérieur sont bloquées. Voir Internet sans être vu représente un avantage de sécurité énorme. Cependant, cela signifie qu'a priori, on ne peut pas simplement monter son propre serveur Web publique chez soi pour une installation domotique et offrir un accès depuis l'extérieur.
Page 132
16. Utilisation du Yocto-Inclinometer en PHP Configuration L'API callback se sert donc du Virtual Hub comme passerelle. Toutes les communications sont initiées par le Virtual Hub, ce sont donc des communication sortantes, et par conséquent parfaitement autorisée par le routeur DSL.
VirtualHub pour fonctionner. Pour coder un site Web qui contrôle des modules Yoctopuce de manière interactive, il faudra créer une interface utilisateur qui stockera dans un fichier ou une base de données les actions à effectuer sur les modules Yoctopuce. Ces actions seront ensuite lues puis exécutés par le script de contrôle.
Page 134
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
17.2. Utilisation l'API yoctopuce dans un projet Visual Basic La librairie Yoctopuce pour Visual Basic .NET se présente sous la forme d'une DLL et de fichiers sources en Visual Basic. La DLL n'est pas une DLL .NET mais une DLL classique, écrite en C, qui gère les communications à...
17.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction Tilt. [...] ' On active la détection des modules sur USB...
Page 137
17. Utilisation du Yocto-Inclinometer en VisualBasic .NET renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler YTilt.FindTilt l'inclinomètre. isOnline La méthode de l'objet renvoyé par permet de savoir si le module isOnline() YTilt.FindTilt correspondant est présent et en état de marche.
17. Utilisation du Yocto-Inclinometer en VisualBasic .NET Console.WriteLine("Module disconnected") End If (count = 0) Then Console.WriteLine("tilt1" + Chr(9) + "tilt2" + Chr(9) + "tilt3" End If Console.Write(tilt1.get_currentValue().ToString() + Chr(9)) Console.Write(tilt2.get_currentValue().ToString() + Chr(9)) Console.WriteLine(tilt3.get_currentValue().ToString()) count count YAPI.Sleep(250, errmsg) End While YAPI.FreeAPI()
Page 139
17. Utilisation du Yocto-Inclinometer en VisualBasic .NET End Module Chaque propriété du module peut être lue grâce à une méthode du type , et les get_xxxx() propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode set_xxx Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux chapitre API...
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
Page 141
17. Utilisation du Yocto-Inclinometer en VisualBasic .NET d'erreur pour chaque fonction est systématiquement documenté dans la référence de la librairie. Il suit toujours même logique: méthode retournera valeur get_state() , une méthode retournera une valeur NomDeClasse.STATE_INVALID get_currentValue , etc. Dans tous les cas, la valeur retournée sera du NomDeClasse.CURRENTVALUE_INVALID...
Delphi Par défaut la librairie Yoctopuce pour Delphi utilise une DLL yapi.dll, toutes les applications que vous créerez avec Delphi devront avoir accès à cette DLL. Le plus simple est de faire en sorte qu'elle soit présente dans le même répertoire que l'exécutable de votre application.
Page 144
[...] Voyons maintenant en détail ce que font ces quelques lignes. yocto_api et yocto_tilt Ces deux unités permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. doit toujours être utilisé, est nécessaire pour gérer les modules yocto_api yocto_tilt contenant un inclinomètre, comme le Yocto-Inclinometer.
18. Utilisation du Yocto-Inclinometer en Delphi inc(count); Sleep(100); else begin Writeln('Module not connected (check identification and USB cable)'); done := true; end; until done; yFreeAPI(); end. 18.3. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la...
Page 147
18. Utilisation du Yocto-Inclinometer en Delphi case 'r': refresh(module); 'b': beacon(module,Y_BEACON_ON); ': beacon(module,Y_BEACON_OFF); end; until c = 'x'; yFreeAPI(); end. Chaque propriété du module peut être lue grâce à une méthode du type , et les get_xxxx() propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode set_xxx Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux chapitre API...
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
Page 149
18. Utilisation du Yocto-Inclinometer en Delphi • Sinon... l'exception va crasher votre programme, boum! Comme cette dernière 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...
Cependant, l'utilisation des nouvelles API UWP n'est pas sans conséquence: l'API Windows Runtime pour accéder aux ports USB est asynchrone, et par conséquent la librairie Yoctopuce doit aussi être asynchrone. Concrètement les méthodes asynchrones ne retournent pas directement le résultat mais un objet et le résultat peut être obtenu plus tard.
19.2. Installation Téléchargez la librairie Yoctopuce pour Universal Windows Platform depuis le site web de Yoctopuce . Il n'y a pas de programme d'installation, copiez simplement de contenu du fichier zip dans le répertoire de votre choix.
19.4. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code c# qui utilise la fonction Tilt.
Le projets Visual Studio contient de nombreux fichiers dont la plupart ne sont pas liés à l'utilisation de la librairie Yoctopuce. Pour simplifier la lecture du code nous avons regroupé tout le code qui utilise la librairie dans la classe qui se trouve dans le fichier .
19. Utilisation du Yocto-Inclinometer avec Universal Windows Platform WriteLine("error: " + ex.Message); YAPI.FreeAPI(); return 0; 19.6. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci-dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
Page 156
19. Utilisation du Yocto-Inclinometer avec Universal Windows Platform Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire YModule.set_xxx() vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa...
La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
à vos projets. 20.1. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-Inclinometer. Voici le squelette d'un fragment de code Objective-C qui utilise la fonction Tilt. #import "yocto_api.h"...
Page 160
Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Inclinometer avec le numéros de série YCLINOM1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
20. Utilisation du Yocto-Inclinometer en Objective-C NSLog(@" demo any (use any discovered device)"); exit(1); int main(int argc, const char * argv[]) NSError *error; (argc < 2) { usage(); @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) {...
Page 162
20. Utilisation du Yocto-Inclinometer en Objective-C NSLog(@"usage: %s <serial or logical name> [ON/OFF]\n", exe); exit(1); main (int argc, const char * argv[]) NSError *error; @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) { NSLog(@"RegisterHub error:...
Page 163
20. Utilisation du Yocto-Inclinometer en Objective-C main (int argc, const char * argv[]) NSError *error; @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb" :&error] != YAPI_SUCCESS) { NSLog(@"RegisterHub error: %@", [error localizedDescription]); return if(argc <...
La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
être utilisés par des applications tierces. Dans notre cas, c'est toute la librairie Yoctopuce qui est disponible dans l'Assembly .NET, de sorte à pouvoir être utilisée dans n'importe quel environnement qui supporte le chargement dynamique d'Assembly .NET.
Page 166
21. Utilisation avec des langages non supportés mécanismes de callbacks. A la place, cette librairie offre des objets miroirs, appelés Proxys, qui publient par le biais de Propriétés les principaux attributs des fonctions Yoctopuce tels que la mesure courante, les paramètres de configuration, l'état, etc.
Il se trouve que le Virtual Hub est en fait un petit serveur Web qui est capable de router des requêtes HTTP vers les modules Yoctopuce. Ce qui signifie que si vous pouvez faire une requête HTTP depuis votre langage de programmation, vous pouvez contrôler des modules Yoctopuce, même si ce langage n'est pas officiellement supporté.
Page 168
Contrôle d'un module par l'interface REST Chaque module Yoctopuce a sa propre interface REST disponible sous différentes formes. Imaginons un Yocto-Inclinometer avec le numéro de de série YCLINOM1-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.
21.4. Utilisation des librairies dynamiques L'API Yoctopuce bas niveau est disponible sous différents formats de librairie dynamiques écrites en C, dont les sources sont disponibles avec l'API C++. Utiliser une de ces librairies bas niveau vous permettra de vous passer du Virtual Hub.
Page 170
(yapiHTTPRequest(serial,getValue,data,sizeof(dataBuffer),fullsize,errmsg)<0) then begin writeln(errmsg); halt; end; // searches for the HTTP header end p := pos(#13#10#13#10,data); // displays the response minus the HTTP header writeln(copy(data,p+4,length(data)-p-3)); // change the luminosity if (yapiHTTPRequest(serial,setValue,data,sizeof(dataBuffer),fullsize,errmsg)<0) then begin writeln(errmsg); halt; end; www.yoctopuce.com...
Page 171
21. Utilisation avec des langages non supportés end. Inventaire des modules Pour procéder à l'inventaire des modules Yoctopuce, deux fonctions de la librairie dynamique sont nécessaires int yapiGetAllDevices(int *buffer,int maxsize,int *neededsize,char *errmsg); int yapiGetDeviceInfo(int devdesc,yDeviceSt *infos, char *errmsg); La fonction yapiGetAllDevices permet d'obtenir la liste des modules connectés sous la forme d'une liste de handles.
Yoctopuce sera alors en mesure de générer tous les autres fichiers. C'est pourquoi il est fortement recommandé de contacter le support Yoctopuce avant d'entreprendre le port de la librairie Yoctopuce dans un autre langage. Un travail collaboratif sera profitable aux deux parties.
"mise à jour" et sera listé en dessous des modules connectés. 22.2. La librairie ligne de commandes Tous les outils en lignes de commandes ont la possibilité de mettre à jour les modules Yoctopuce grâce à la commande .
(m.get_productName() == "YoctoHub-Wireless") { m.set_allSettings(default_config); = m.next(); Chercher le bon firmware La première étape pour mettre à jour un module Yoctopuce est de trouver quel firmware il faut utiliser, c'est le travail de la méthode de l'objet YModule. checkFirmware(path, onlynew) Cette méthode vérifie que le firmware passé...
Page 175
Il est aussi possible de passer la chaîne "www.yoctopuce.com" en argument pour vérifier s'il existe un firmware plus récent publié sur le site web de Yoctopuce. Dans ce cas, la méthode retournera l'URL du firmware. Vous pourrez soit utiliser cette URL pour télécharger le firmware sur votre disque, soit utiliser cette URL lors de la mise à...
à installer, et un tableau de bytes avec les paramètres à restaurer à la fin de la mise à jour (ou pour restaurer les paramètres d'origine). null YFirmwareUpdateupdate fw_update; fw_update = new YFirmwareUpdate(allBootLoader[0], newfirm, null); status = fw_update.startUpdate(); ..www.yoctopuce.com...
Pour pouvoir être prévenu dès qu'un module arrive, vous avez besoin de trois morceaux de code. Le callback Le callback est la fonction qui sera appelée à chaque fois qu'un nouveau module Yoctopuce sera branché. Elle prend en paramètre le module concerné. static void deviceArrival(YModule www.yoctopuce.com...
Page 178
à des moments où le programme principal n'est pas prêt à les recevoir, ce qui peut avoir des effets de bords indésirables comme des dead-locks et autres conditions de course. C'est pourquoi dans l'API Yoctopuce, les callbacks d'arrivée/départs de modules ne sont appelés que pendant l'exécution de la fonction .
Page 179
Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).
Prog-EventBased. 23.2. L'enregistreur de données Votre Yocto-Inclinometer est équipé d'un enregistreur de données, aussi appelé datalogger, capable d'enregistrer en continu les mesures effectuées par le module. La fréquence d'enregistrement maximale est de cent fois par secondes (i.e. "100/s"), et la fréquence minimale est de une fois par heure (i.e.
Page 181
Remarque: les modules Yoctopuce n'ont pas besoin d'une connection USB active pour fonctionner: ils commencent à fonctionner dès qu'ils sont alimentés. Le Yocto-Inclinometer peut enregistrer des données sans être forcément raccordé à un ordinateur: il suffit d'activer le démarrage automatique du datalogger et d'alimenter le module avec un simple chargeur USB.
Page 182
Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-Inclinometer n'ayant pas de batterie, il n'est pas capable de deviner tout seul l'heure qu'il est au moment de sa mise sous tension. Néanmoins, le Yocto-Inclinometer va automatiquement essayer de se mettre à...
L'API Yoctopuce offre le moyen de re-calibrer les valeurs mesurées par votre Yocto-Inclinometer. Il ne n'agit pas de modifier les réglages hardware du module, mais plutôt d'effectuer une transformation a posteriori des mesures effectuées par le capteur.
Page 184
Correction de 3 à 5 points Les corrections de 3 à 5 points ne sont qu'une généralisation de la méthode à deux points, permettant de ainsi de créer jusqu' 4 intervalles de correction pour plus de précision. Ces intervalles ne peuvent pas être disjoints. www.yoctopuce.com...
Page 185
Limitations En raison des limitations de stockage et de traitement des valeurs flottantes dans le module Yoctopuce, les valeurs des valeurs lues et des valeur corrigées doivent respecter certaines contraintes numériques: • Seules 3 décimales sont prises en compte (résolution de 0.001) •...
Page 186
23. Programmation avancée valeur avant de la renvoyer, permettant ainsi de corriger les mesures de manière totalement transparente. www.yoctopuce.com...
24. Référence de l'API de haut niveau Ce chapitre résume les fonctions de l'API de haut niveau pour commander votre Yocto-Inclinometer. La syntaxe et les types précis peuvent varier d'un langage à l'autre mais, sauf avis contraire toutes sont disponibles dans chaque language. Pour une information plus précise sur les types des arguments et des valeurs de retour dans un langage donné, veuillez vous référer au fichier de...
YAPI.EnableUSBHost(osContext) Cette fonction est utilisée uniquement sous Android. YAPI.FreeAPI() Attends que toutes les communications en cours avec les modules Yoctopuce soient terminées puis libère les ressources utilisées par la librairie Yoctopuce. YAPI.GetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée.
Page 189
Enregistre une fonction de callback qui sera appelée à chaque fois qu'un module est débranché. YAPI.RegisterHub(url, errmsg) Configure la librairie Yoctopuce pour utiliser les modules connectés sur une machine donnée. YAPI.RegisterHubDiscoveryCallback(hubDiscoveryCallback) Enregistre une fonction de callback qui est appelée chaque fois qu'un hub réseau s'annonce avec un message SSDP.
Page 190
Test si un hub est joignable. YAPI.TriggerHubDiscovery(errmsg) Relance une détection des hubs réseau. YAPI.UnregisterHub(url) Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. YAPI.UpdateDeviceList(errmsg) Force une mise-à-jour de la liste des modules Yoctopuce connectés.
Page 191
. Lorsqu'on configure un nom logique avec une chaîne incorrecte, les caractères invalides sont ignorés. Paramètres : name une chaîne de caractères contenant le nom vérifier. Retourne : true false si le nom est valide, dans le cas contraire. www.yoctopuce.com...
Page 192
Désactive le cache de callback HTTP. function ClearHTTPCallbackCacheDir( $bool_removeFiles) Cette méthode désctive la cache de callback HTTP, et permet également d'en effacer le contenu. Paramètres : Vrai pour effacer le contenu du répertoire de cache. bool_removeFiles Retourne : nothing. www.yoctopuce.com...
Page 193
DisableExceptions( ) void DisableExceptions( ) DisableExceptions( ) function DisableExceptions( ) async DisableExceptions( ): Promise<void> async DisableExceptions( ) Lorsque les exceptions sont désactivées, chaque fonction retourne une valeur d'erreur spécifique selon son type, documentée dans ce manuel de référence. www.yoctopuce.com...
Page 194
Attention, lorsque les exceptions sont activées, tout appel à une fonction de la librairie qui échoue déclenche une exception. Dans le cas où celle-ci n'est pas interceptée correctement par le code appelant, soit le debugger se lance, soit le programme de l'utilisateur est immédiatement stoppé (crash). www.yoctopuce.com...
Page 195
(ou d'une sous-classe). Il n'est pas nécessaire d'appeler cette fonction pour accéder au modules à travers le réseau. Paramètres : osContext un objet de classe android.content.Context (ou une sous-classe) www.yoctopuce.com...
Page 196
24. Référence de l'API de haut niveau YAPI.FreeAPI() YAPI YAPI.FreeAPI() Attends que toutes les communications en cours avec les modules Yoctopuce soient terminées puis libère les ressources utilisées par la librairie Yoctopuce. function yFreeAPI( ) void FreeAPI( ) +(void) FreeAPI...
Page 197
24. Référence de l'API de haut niveau YAPI.GetAPIVersion() YAPI YAPI.GetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée. function yGetAPIVersion( ) string GetAPIVersion( ) +(NSString*) GetAPIVersion string yGetAPIVersion( ): string function GetAPIVersion( ) As String static String GetAPIVersion( ) static String GetAPIVersion( )
Page 198
Cette méthode retourne la durée de mise en cache de tous les attributs des fonctions du module. Note: Cette fonction doit être appelée après yInitAPI Retourne : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes. www.yoctopuce.com...
Page 199
GetDeviceListValidity( ) int GetDeviceListValidity( ) java async Task<int> GetDeviceListValidity( ) GetDeviceListValidity( ) function GetDeviceListValidity( ) async GetDeviceListValidity( ): Promise<number> async GetDeviceListValidity( ) Note: Cette fonction doit être appelée après yInitAPI Retourne : le nombre de secondes entre chaque énumération. www.yoctopuce.com...
Page 200
. Pour les machines ARM, l'architecture "Win32" "Win64" . Pour les autres machines Linux, l'architecture est "Armhf32" "Aarch64" "Linux32" . Pour MacOS, l'architecture est "Linux64" "MacOs32" "MacOs64" Retourne : une chaîne de caractères décrivant l'architecture du binaire de la librairie de communication Yoctopuce utilisée. www.yoctopuce.com...
Page 201
YAPI.GetDllPath() YAPI YAPI.GetDllPath() Retourne l'emplacement sur le disque des librairies Yoctopuce utilisées. static string GetDllPath( ) Pour les architectures qui demandent l'utilisation de plusieurs DLLs, et en particulier dans le cadre de l'utilisation de la librairie sous forme de .NET Assembly, la chaîne retournée est au format suivant: , où...
Page 202
24. Référence de l'API de haut niveau YAPI.GetLog() YAPI YAPI.GetLog() Récupère les messages de logs de la librairie de communication Yoctopuce. static string GetLog( string lastLogLine) static string GetLog( string lastLogLine) Cette méthode permet de récupérer progressivement les messages de logs, ligne par ligne. La méthode doit être appelée en boucle, jusqu'à...
Page 203
Ce délai n'affecte que les YoctoHubs et VirtualHub qui sont accessibles par réseau. Par défaut, ce délai est de 20000 millisecondes, mais en fonction de votre réseau il peut être souhaitable de changer ce délai, par exemple, si votre infrastructure réseau utilise une connexion GSM. Retourne : le délai de connexion réseau en millisecondes. www.yoctopuce.com...
Page 204
GetTickCount( ) GetTickCount( ): number GetTickCount( ) Ce compteur peut être utilisé pour calculer des délais 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.
Page 205
Ce n'est pas strictement indispensable mais cela peut améliorer la réactivité 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.
Page 206
24. Référence de l'API de haut niveau YAPI.InitAPI() YAPI YAPI.InitAPI() Initialise la librairie de programmation de Yoctopuce explicitement. function yInitAPI( mode, errmsg) YRETCODE InitAPI( int mode, string errmsg) +(YRETCODE) InitAPI :(int) mode :(NSError**) errmsg integer yInitAPI( mode: integer, var errmsg: string): integer...
Page 207
"usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 208
RegisterDeviceArrivalCallback( $arrivalCallback) async RegisterDeviceArrivalCallback( arrivalCallback: YDeviceUpdateCallback| null): Promise<void> async RegisterDeviceArrivalCallback( arrivalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : arrivalCallback une procédure qui prend un YModule en paramètre, ou null www.yoctopuce.com...
Page 209
RegisterDeviceRemovalCallback( $removalCallback) async RegisterDeviceRemovalCallback( removalCallback: YDeviceUpdateCallback| null): Promise<void> async RegisterDeviceRemovalCallback( removalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : removalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
Page 210
C'est un mode spécial permettant, entre autres, de prendre le contrôle de modules Yoctopuce à travers un filtre NAT par l'intermédiaire d'un VirtualHub ou d'un Hub Yoctopuce. Il vous suffit de configuer le hub pour qu'il appelle votre script à intervalle régulier. Ce mode de fonctionnement n'est disponible actuellement qu'en PHP et en Node.JS.
Page 211
"usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 212
, que vous devrez appeler régulièrement. yUpdateDeviceList Paramètres : hubDiscoveryCallback une procédure qui prend deux chaîne de caractères en paramètre, le numéro de série et l'URL du hub découvert. Pour supprimer un callback déjà enregistré, www.yoctopuce.com...
Page 213
YAPI.RegisterHubWebsocketCallback() YAPI YAPI.RegisterHubWebsocketCallback() Variante de la fonction yRegisterHub() destinée à initialiser l'API Yoctopuce sur une session Websocket existante, dans le cadre d'un callback WebSocket entrant. Paramètres : l'objet WebSocket lié à au callback WebSocket entrant. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur.
Page 214
RegisterLogFunction( LogCallback logfun) java void RegisterLogFunction( LogHandler logfun) RegisterLogFunction( logfun) async RegisterLogFunction( logfun: YLogCallback): Promise<number> async RegisterLogFunction( logfun) Utile pour débugger le fonctionnement de l'API. Paramètres : logfun une procedure qui prend une chaîne de caractère en paramètre, www.yoctopuce.com...
Page 215
à la librairie pour forcer l'utilisation d'une SelectArchitecture() architecture spécifiée. Paramètres : arch une chaîne de caractère spécifiant l'architecture à utiliser. Les valeurs possibles sont "armhf" "armel" "aarch64" "i386" "x86_64" "32bit" "64bit" Retourne : rien. En cas d'erreur, déclenche une exception. www.yoctopuce.com...
Page 216
USB. Ce paramètre n'affecte pas les callbacks de changement de valeur Note: Cette fonction doit être appelée après yInitAPI Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en cacheValidityMs millisecondes. www.yoctopuce.com...
Page 217
(Objective-C uniquement) Enregistre un objet délégué qui doit se conformer au protocole YDeviceHotPlug +(void) SetDelegate :(id) object Les méthodes seront appelées pendant l’exécution de la yDeviceArrival yDeviceRemoval fonction , que vous devrez appeler régulièrement. yUpdateDeviceList Paramètres : object un objet qui soit se conformer au protocole YAPIDelegate , ou www.yoctopuce.com...
Page 218
à un réseau GSM où le trafic est facturé. Ce paramètre n'affecte pas les modules connectés par USB, ni le fonctionnement des callback de connexion/déconnexion de module. Note: Cette fonction doit être appelée après yInitAPI Paramètres : nombre de secondes entre chaque énumération. deviceListValidity www.yoctopuce.com...
Page 219
Il est recommandé d'utiliser un répertoire qui n'est pas accessible depuis le serveur Web, car la librairie va y stocker des données provenant des modules Yoctopuce. Note : Cette fonctionnalité est supportée par les YoctoHub et VirtualHub depuis la version 27750 Paramètres :...
Page 220
Ce délai n'affecte que les YoctoHubs et VirtualHub qui sont accessibles par réseau. Par défaut ce délai est de 20000 millisecondes, mais en fonction de votre réseau il peut être souhaitable de changer ce délai, par exemple si votre infrastructure réseau utilise une connexion GSM. Paramètres : networkMsTimeout le délais de connexion réseau en millisecondes. www.yoctopuce.com...
Page 221
être fournis, pour être passés à la fonction de callback si nécessaire. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 222
être activée que sur des tablette ou des téléphones qui posent problème. Un délais de 50 millisecondes est en général suffisant. En cas de doute contacter le support Yoctopuce. Pour désactiver la quittance des paquets USB, appeler cette fonction avec la valeur 0. Note : Cette fonctionnalité est disponible uniquement sous Android.
Page 223
à lire périodiquement 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. Paramètres : ms_duration un entier correspondant à...
Page 224
éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur retourne un code d'erreur négatif. www.yoctopuce.com...
Page 225
Paramètres : errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 226
24. Référence de l'API de haut niveau YAPI.UnregisterHub() YAPI YAPI.UnregisterHub() Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. function yUnregisterHub( url) void UnregisterHub( string url) +(void) UnregisterHub :(NSString *) yUnregisterHub( url: string)
Page 227
24. Référence de l'API de haut niveau YAPI.UpdateDeviceList() YAPI YAPI.UpdateDeviceList() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList( errmsg) YRETCODE UpdateDeviceList( string errmsg) +(YRETCODE) UpdateDeviceList :(NSError**) errmsg integer yUpdateDeviceList( var errmsg: string): integer function UpdateDeviceList( ByRef...
Page 228
YAPI.UpdateDeviceList_async() YAPI YAPI.UpdateDeviceList_async() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList_async( callback, context) La librairie va vérifier sur les machines ou ports USB précédemment enregistrés en utilisant la fonction si un module a été connecté ou déconnecté, et le cas échéant appeler les fonctions yRegisterHub de callback définies par l'utilisateur.
24.2. La classe YModule Interface de contrôle des paramètres généraux des modules Yoctopuce La classe est utilisable avec tous les modules USB de Yoctopuce. Elle permet de contrôler YModule les paramètres généraux du module, et d'énumérer les fonctions fournies par chaque module.
Page 230
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module. module→get_firmwareRelease() Retourne la version du logiciel embarqué du module. module→get_functionIds(funType) Retourne les identifiants matériels des fonctions correspondant au type passé en argument. module→get_hardwareId() Retourne l'identifiant unique du module. module→get_icon2d() www.yoctopuce.com...
Page 231
Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→load_async(msValidity, callback, context) Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→log(text) Ajoute un message arbitraire dans les logs du module. www.yoctopuce.com...
Page 232
Prepare une mise à jour de firmware du module. module→updateFirmwareEx(path, force) Prepare une mise à jour de firmware du module. module→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 233
Retourne : YModule un objet de classe qui permet ensuite de contrôler le module ou d'obtenir de plus amples informations sur le module. www.yoctopuce.com...
Page 234
Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le module sans ambiguïté, par exemple MyDevice.module Retourne : YModule un objet de classe qui permet ensuite de contrôler le module. www.yoctopuce.com...
Page 235
FirstModule( ): YModule | null static FirstModule( ) Utiliser la fonction pour itérer sur les autres modules. YModule.nextModule() Retourne : un pointeur sur un objet YModule , correspondant au premier module accessible en ligne, ou null aucun module n'a été trouvé. www.yoctopuce.com...
Page 236
24. Référence de l'API de haut niveau YModule module→Beacon état de la balise de localisation. int Beacon Modifiable. Allume ou éteint la balise de localisation du module. www.yoctopuce.com...
Page 237
24. Référence de l'API de haut niveau YModule module→FirmwareRelease Version du logiciel embarqué du module. string FirmwareRelease www.yoctopuce.com...
Page 238
24. Référence de l'API de haut niveau YModule module→FunctionId Identifiant matériel de la nième fonction du module. string FunctionId @param functionIndex : l'index de la fonction pour laquelle l'information est désirée, en commençant à 0 pour la première fonction. www.yoctopuce.com...
Page 239
24. Référence de l'API de haut niveau YModule module→HardwareId Identifiant unique du module. string HardwareId L'identifiant unique est composé du numéro de série du module suivi de la chaîne ".module". www.yoctopuce.com...
Page 240
Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 241
Nom logique du module. string LogicalName Modifiable. Change le nom logique du module. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module saveToFlash() si le réglage doit être préservé. www.yoctopuce.com...
Page 242
Luminosité des leds informatives du module (valeur entre 0 et 100). int Luminosity Modifiable. Modifie la luminosité des leds informatives du module. Le paramêtre est une valeur entre 0 et 100. N'oubliez pas d'appeler la méthode du module si le réglage doit être saveToFlash() préservé. www.yoctopuce.com...
Page 243
24. Référence de l'API de haut niveau YModule module→ProductId Identifiant USB du module, préprogrammé en usine. int ProductId www.yoctopuce.com...
Page 244
24. Référence de l'API de haut niveau YModule module→ProductName Nom commercial du module, préprogrammé en usine. string ProductName www.yoctopuce.com...
Page 245
24. Référence de l'API de haut niveau YModule module→ProductRelease Numéro uméro de révision du module hardware, préprogrammé en usine. int ProductRelease La révision originale du retourne la valeur 1, la révision B retourne la valeur 2, etc. www.yoctopuce.com...
Page 246
24. Référence de l'API de haut niveau YModule module→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 247
Retourne : le path du fichier .byn à utiliser, ou une chaîne vide si aucun firmware plus récent n'est disponible En cas d'erreur, déclenche une exception ou retourne une chaine de caractère qui comment par "error:". www.yoctopuce.com...
Page 248
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du module. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 249
String describe( ) java describe( ) function describe( ) async describe( ): Promise<string> async describe( ) Ce texte peut contenir soit le nom logique du module, soit son numéro de série. Retourne : une chaîne de caractères décrivant le module www.yoctopuce.com...
Page 250
Promise<Uint8Array> async download( pathname) byte[] download( string pathname) string download( string pathname) YModule target download pathname Paramètres : pathname nom complet du fichier Retourne : le contenu du fichier chargé En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
Page 251
à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant au type de base de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 252
) int functionCount( ) java functionCount( ) function functionCount( ) async functionCount( ): Promise<number> async functionCount( ) Retourne : le nombre de fonctions sur le module En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 253
à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant à l'identifiant matériel unique de la fonction désirée En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 254
à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant au nom logique de la fonction désirée En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 255
à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant au type de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 256
à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant à la valeur publiée par la fonction désirée En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 257
YModule target get_allSettings Utile pour sauvgarder les noms logiques, les calibrations et fichies uploadés d'un module. Retourne : un objet binaire avec tous les paramètres En cas d'erreur, déclenche une exception ou retourne un objet binaire de taille 0. www.yoctopuce.com...
Page 258
): Promise<YModule_Beacon> async get_beacon( ) int get_beacon( ) int get_beacon( ) YModule target get_beacon Retourne : YModule.BEACON_OFF YModule.BEACON_ON soit , soit , selon l'état de la balise de localisation En cas d'erreur, déclenche une exception ou retourne YModule.BEACON_INVALID www.yoctopuce.com...
Page 259
) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du module www.yoctopuce.com...
Page 260
) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du module...
Page 261
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.FIRMWARERELEASE_INVALID www.yoctopuce.com...
Page 262
$funType) async get_functionIds( funType: string): Promise<string[] async get_functionIds( funType) string[] get_functionIds( string funType) vector<string> get_functionIds( string funType) YModule target get_functionIds funType Paramètres : funType Le type de fonction (Relay, LightSensor, Voltage,...) Retourne : un tableau de chaînes de caractère. www.yoctopuce.com...
Page 263
) string get_hardwareId( ) string get_hardwareId( ): string async Task<string> get_hardwareId( ) YModule target get_hardwareId L'identifiant unique est composé du numéro de série du module suivi de la chaîne ".module". Retourne : une chaîne de caractères identifiant la fonction www.yoctopuce.com...
Page 264
) string get_icon2d( ) YModule target get_icon2d L'icone est au format PNG et a une taille maximale de 1536 octets. Retourne : un buffer binaire contenant l'icone, au format png. En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
Page 265
) YModule target get_lastLogs Cette méthode retourne les derniers logs qui sont encore stocké dans le module. Retourne : une chaîne de caractère contenant les derniers logs du module. En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
Page 266
) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YModule target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du module En cas d'erreur, déclenche une exception ou retourne YModule.LOGICALNAME_INVALID www.yoctopuce.com...
Page 267
): Promise<number> async get_luminosity( ) int get_luminosity( ) int get_luminosity( ) YModule target get_luminosity Retourne : un entier représentant la luminosité des leds informatives du module (valeur entre 0 et 100) En cas d'erreur, déclenche une exception ou retourne YModule.LUMINOSITY_INVALID www.yoctopuce.com...
Page 268
Si le module est connecté par USB, ou si le module est le YoctoHub racine, une chaîne vide est retournée. Retourne : une chaîne de caractères contenant le numéro de série du YoctoHub, ou une chaîne vide. www.yoctopuce.com...
Page 269
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.PERSISTENTSETTINGS_INVALID www.yoctopuce.com...
Page 270
) async get_productId( ): Promise<number> async get_productId( ) int get_productId( ) int get_productId( ) YModule target get_productId Retourne : un entier représentant l'identifiant USB du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTID_INVALID www.yoctopuce.com...
Page 271
): Promise<string> async get_productName( ) string get_productName( ) string get_productName( ) YModule target get_productName Retourne : une chaîne de caractères représentant le nom commercial du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTNAME_INVALID www.yoctopuce.com...
Page 272
La révision originale du retourne la valeur 1, la révision B retourne la valeur 2, etc. Retourne : un entier représentant le numéro uméro de révision du module hardware, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTRELEASE_INVALID www.yoctopuce.com...
Page 273
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...
Page 274
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YModule target get_serialNumber Retourne : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.SERIALNUMBER_INVALID www.yoctopuce.com...
Page 275
Cette fonction n'est pertinente que lorsqu'elle appelée pour un YoctoHub ou pour le VirtualHub. Dans le cas contraire, un tableau vide est retourné. Retourne : un tableau de chaînes de caractères contenant les numéros de série des sous-modules connectés au module www.yoctopuce.com...
Page 276
): Promise<number> async get_upTime( ) long get_upTime( ) s64 get_upTime( ) YModule target get_upTime Retourne : un entier représentant le numbre de millisecondes écoulées depuis la mise sous tension du module En cas d'erreur, déclenche une exception ou retourne YModule.UPTIME_INVALID www.yoctopuce.com...
Page 277
): Promise<string> async get_url( ) string get_url( ) string get_url( ) YModule target get_url Si le module est connecté par USB la chaîne de caractère 'usb' est retournée. Retourne : une chaîne de caractère contenant l'URL du module. www.yoctopuce.com...
Page 278
): Promise<number> async get_usbCurrent( ) int get_usbCurrent( ) int get_usbCurrent( ) YModule target get_usbCurrent Retourne : un entier représentant le courant consommé par le module sur le bus USB, en milliampères En cas d'erreur, déclenche une exception ou retourne YModule.USBCURRENT_INVALID www.yoctopuce.com...
Page 279
) function get_userData( ) async get_userData( ): Promise<object|null> async 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é précédemment par l'appelant. www.yoctopuce.com...
Page 280
) YModule target get_userVar Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Retourne : un entier représentant la valeur entière précédemment stockée dans cet attribut En cas d'erreur, déclenche une exception ou retourne YModule.USERVAR_INVALID www.yoctopuce.com...
Page 281
YModule target hasFunction funcId La méthode prend en paramètre l'identifiant de la fonction (relay1, voltage2,...) et retourne un booléen. Paramètres : funcId identifiant matériel de la fonction Retourne : vrai si le module inclut la fonction demandée www.yoctopuce.com...
Page 282
Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le module est joignable, sinon www.yoctopuce.com...
Page 283
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 284
Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 285
YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 286
être inclus dans la chaîne de caractère. Paramètres : text le message à ajouter aux logs du module. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 287
Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les modules sont retournés. Si vous souhaitez retrouver un module spécifique, utilisez Module.findModule() avec un hardwareID ou un nom logique. Retourne : YModule null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 288
YModule target reboot secBeforeReboot Paramètres : secBeforeReboot nombre de secondes avant de redémarrer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 289
La fonction de callback doit accepter deux arguments: l’objet YModule dont la balise a changé, et un entier représentant l'état de la balise de localisation. Paramètres : callback null la fonction de callback à rappeler, ou www.yoctopuce.com...
Page 290
ConfigChangeCallback callback) int registerConfigChangeCallback( ConfigChangeCallback callback) java async Task<int> registerConfigChangeCallback( ConfigChangeCallback callback) registerConfigChangeCallback( callback) function registerConfigChangeCallback( $callback) async registerConfigChangeCallback( callback: YModuleConfigChangeCallback | null): Promise<number> async registerConfigChangeCallback( callback) Paramètres : callback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
Page 291
$callback) async registerLogCallback( callback: YModuleLogCallback | null): Promise<number> async registerLogCallback( callback) Utile pour débugger le fonctionnement d'un module Yoctopuce. Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'objet module qui a produit un log, un chaîne de caractère qui contiens le log...
Page 292
) async revertFromFlash( ): Promise<number> async revertFromFlash( ) int revertFromFlash( ) int revertFromFlash( ) YModule target revertFromFlash Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 293
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 : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 294
être préservés. saveToFlash() Paramètres : un objet binaire avec touts les paramètres settings Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 295
être préservés. Paramètres : un buffer binaire avec touts les paramètres settings Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 296
YModule target set_beacon newval Paramètres : newval soit YModule.BEACON_OFF , soit YModule.BEACON_ON Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 297
être préservé. saveToFlash() Paramètres : newval une chaîne de caractères Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 298
être préservé. Paramètres : un entier représentant la luminosité des leds informatives du module newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 299
$data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 300
Cet attribut est à la disposition du programmeur pour y stocker par exemple une variable d'état. Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Paramètres : newval un entier Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 301
LongInt triggerConfigChangeCallback( ): LongInt function triggerConfigChangeCallback( ) As Integer int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) java async Task<int> triggerConfigChangeCallback( ) triggerConfigChangeCallback( ) function triggerConfigChangeCallback( ) async triggerConfigChangeCallback( ): Promise<number> async triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) YModule target triggerConfigChangeCallback www.yoctopuce.com...
Page 302
YModule target triggerFirmwareUpdate secBeforeReboot Paramètres : secBeforeReboot nombre de secondes avant de redémarrer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 303
Cette méthode retourne un object qui est utilisé pour mettre à jour le firmware du YFirmwareUpdate module. Paramètres : path le path du fichier .byn à utiliser Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
Page 304
à jour le firmware du YFirmwareUpdate module. Paramètres : path .byn le path du fichier à utiliser force vrai pour forceer la mise à jour même si un prérequis ne semble pas satisfait Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
Page 305
La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Interface pour intéragir avec les inclinomètres, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La classe est la classe parente de tous les types de capteurs Yoctopuce. Elle permet de lire YSensor la valeur courante et l'unité de n'importe quel capteur, de lire les valeurs min/max, de configurer la fréquence d'enregistrement autonome des données et de récupérer les mesures enregistrées.
Page 307
Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un boîtier sur les mesures rendues par le capteur. tilt→calibrateToZero() Calibre le zéro de la mesure d'angle (Yocto-Inclinometer seulement). tilt→clearCache() Invalide le cache. tilt→describe() Retourne un court texte décrivant de manière non-ambigüe l'instance de l'inclinomètre au format TYPE(NAME)=SERIAL.FUNCTIONID...
Page 308
Retourne la valeur minimale observée pour l'inclinaison depuis le démarrage du module. tilt→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. tilt→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. tilt→get_recordedData(startTime, endTime)
Page 309
Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée. tilt→restoreZeroCalibration() Annule tout réglage précédent du zéro de la mesure d'angle (Yocto-Inclinometer seulement). tilt→set_advMode(newval) Modifie le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue).
Page 310
Arrête l'enregistreur de données du module. tilt→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. tilt→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 311
à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'inclinomètre sans ambiguïté, par exemple Y3DMK002.tilt1 Retourne : YTilt un objet de classe qui permet ensuite de contrôler l'inclinomètre. www.yoctopuce.com...
Page 312
Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'inclinomètre sans ambiguïté, par exemple Y3DMK002.tilt1 Retourne : YTilt un objet de classe qui permet ensuite de contrôler l'inclinomètre. www.yoctopuce.com...
Page 313
FirstTilt( ) Utiliser la fonction pour itérer sur les autres inclinomètres. YTilt.nextTilt() Retourne : un pointeur sur un objet YTilt , correspondant au premier inclinomètre accessible en ligne, ou null si il n'y a pas de inclinomètres disponibles. www.yoctopuce.com...
Page 314
YTilt.nextTilt() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YTilt , correspondant au premier inclinomètre accessible en ligne, ou null si il n'y a pas de inclinomètres disponibles. www.yoctopuce.com...
Page 315
Chaque chaîne retournée peut être passée en argument à la méthode pour YTilt.FindTilt obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 316
24. Référence de l'API de haut niveau YTilt tilt→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 317
24. Référence de l'API de haut niveau YTilt tilt→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 318
24. Référence de l'API de haut niveau YTilt tilt→Bandwidth Fréquence de rafraîchissement de la mesure, en Hz. int Bandwidth Modifiable. Lorsque la fréquence est plus basse, un moyennage est effectué. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 319
Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 320
24. Référence de l'API de haut niveau YTilt tilt→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 321
24. Référence de l'API de haut niveau YTilt tilt→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 322
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 323
"OFF". Attention il est inutile, voir contre productif, de régler la fréquence d'enregistrement à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 324
24. Référence de l'API de haut niveau YTilt tilt→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 325
"OFF". Attention il est inutile, voir contre productif, de régler la fréquence de notification périodique à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 326
Modifiable. Modifie la résolution des valeurs physique mesurées. La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 327
24. Référence de l'API de haut niveau YTilt tilt→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 328
être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
Page 329
24. Référence de l'API de haut niveau YTilt tilt→calibrateToZero() Calibre le zéro de la mesure d'angle (Yocto-Inclinometer seulement). function calibrateToZero( ) int calibrateToZero( ) -(int) calibrateToZero LongInt calibrateToZero( ): LongInt function calibrateToZero( ) As Integer int calibrateToZero( ) int calibrateToZero( ) java async Task<int>...
Page 330
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'inclinomètre. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 331
î n e c a r a c t è r e s d é c r i v a n t l ' i n c l i n o m è t r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 332
) int get_advMode( ) YTilt target get_advMode Retourne : YTilt.ADVMODE_IMMEDIATE YTilt.ADVMODE_PERIOD_AVG une valeur parmi YTilt.ADVMODE_PERIOD_MIN YTilt.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne YTilt.ADVMODE_INVALID www.yoctopuce.com...
Page 333
): Promise<string> async get_advertisedValue( ) string get_advertisedValue( ) string get_advertisedValue( ) YTilt target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'inclinomètre (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YTilt.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 334
): Promise<number> async get_bandwidth( ) int get_bandwidth( ) int get_bandwidth( ) YTilt target get_bandwidth Retourne : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz En cas d'erreur, déclenche une exception ou retourne YTilt.BANDWIDTH_INVALID www.yoctopuce.com...
Page 335
) YTilt target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en degrés, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YTilt.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
Page 336
En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
Page 337
YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
Page 338
) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'inclinomètre.
Page 339
) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'inclinomètre.
Page 340
(par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'inclinomètre en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YTilt.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 341
é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 342
) function get_functionId( ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'inclinomètre (ex: En cas d'erreur, déclenche une exception ou retourne YTilt.FUNCTIONID_INVALID www.yoctopuce.com...
Page 343
) L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'inclinomètre (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'inclinomètre (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YTilt.HARDWAREID_INVALID www.yoctopuce.com...
Page 344
YTilt target get_highestValue Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour l'inclinaison depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YTilt.HIGHESTVALUE_INVALID www.yoctopuce.com...
Page 345
Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne YTilt.LOGFREQUENCY_INVALID www.yoctopuce.com...
Page 346
) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YTilt target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'inclinomètre. En cas d'erreur, déclenche une exception ou retourne YTilt.LOGICALNAME_INVALID www.yoctopuce.com...
Page 347
YTilt target get_lowestValue Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour l'inclinaison depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YTilt.LOWESTVALUE_INVALID www.yoctopuce.com...
Page 348
24. Référence de l'API de haut niveau YTilt tilt→get_module() tilt→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 349
24. Référence de l'API de haut niveau YTilt tilt→get_module_async() tilt→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
Page 350
à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 351
) YTilt target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne YTilt.REPORTFREQUENCY_INVALID www.yoctopuce.com...
Page 352
à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne YTilt.RESOLUTION_INVALID www.yoctopuce.com...
Page 353
En cas d'erreur, déclenche une exception ou retourne YTilt.SENSORSTATE_INVALID www.yoctopuce.com...
Page 354
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YTilt target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 355
) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YTilt target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle l'inclinaison est exprimée En cas d'erreur, déclenche une exception ou retourne YTilt.UNIT_INVALID www.yoctopuce.com...
Page 356
) function get_userData( ) async get_userData( ): Promise<object|null> async 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é précédemment par l'appelant. www.yoctopuce.com...
Page 357
Si les valeurs des attributs en cache de l'inclinomètre sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'inclinomètre est joignable, sinon www.yoctopuce.com...
Page 358
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 359
) YTilt target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 360
Retourne faux si le module n'est pas joignable, ou que le capteur n'a pas de mesure actuelle à communiquer. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur dispose d'une mesure actuelle, sinon www.yoctopuce.com...
Page 361
Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 362
Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 363
Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 364
YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 365
éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 366
): YTilt | null nextTilt( ) Si vous souhaitez retrouver un inclinomètre spécifique, utilisez Tilt.findTilt() avec un hardwareID ou un nom logique. Retourne : YTilt null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 367
Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux YMeasure arguments: l'object fonction dont la valeur a changé, et un objet décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 368
Paramètres : 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 chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 369
24. Référence de l'API de haut niveau YTilt tilt→restoreZeroCalibration() Annule tout réglage précédent du zéro de la mesure d'angle (Yocto-Inclinometer seulement). function restoreZeroCalibration( ) int restoreZeroCalibration( ) -(int) restoreZeroCalibration LongInt restoreZeroCalibration( ): LongInt function restoreZeroCalibration( ) As Integer int restoreZeroCalibration( )
Page 370
YTilt.ADVMODE_PERIOD_MIN YTilt.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 371
être préservé. saveToFlash() Paramètres : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 372
Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur maximale observée Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 373
être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 374
être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'inclinomètre. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 375
Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur minimale observée Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 376
être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 377
être préservé. Paramètres : une valeur numérique représentant la résolution des valeurs physique mesurées newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 378
$data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 379
) int startDataLogger( ) int startDataLogger( ) YTilt target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 380
) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YTilt target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 381
Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 382
La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Interface pour intéragir avec les accéléromètres, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La classe permet de lire et de configurer les accéléromètres Yoctopuce. Elle hérite YAccelerometer de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.
Page 384
Retourne la valeur actuelle de l'accélération, en g, sous forme de nombre à virgule. accelerometer→get_dataLogger() Retourne l'objet YDatalogger du module qui héberge le senseur. accelerometer→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'accéléromètre. accelerometer→get_errorType() www.yoctopuce.com...
Page 385
Retourne la valeur minimale observée pour l'accélération depuis le démarrage du module. accelerometer→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. accelerometer→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. accelerometer→get_recordedData(startTime, endTime)
Page 386
Modifie la fréquence de notification périodique des valeurs mesurées. accelerometer→set_resolution(newval) Modifie la résolution des valeurs physique mesurées. accelerometer→set_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la get_userData méthode accelerometer→startDataLogger() www.yoctopuce.com...
Page 387
Arrête l'enregistreur de données du module. accelerometer→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. accelerometer→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 388
à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'accéléromètre sans ambiguïté, par exemple Y3DMK002.accelerometer Retourne : YAccelerometer un objet de classe qui permet ensuite de contrôler l'accéléromètre. www.yoctopuce.com...
Page 389
Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'accéléromètre sans ambiguïté, par exemple Y3DMK002.accelerometer Retourne : YAccelerometer un objet de classe qui permet ensuite de contrôler l'accéléromètre. www.yoctopuce.com...
Page 390
FirstAccelerometer( ) Utiliser la fonction pour itérer sur les autres YAccelerometer.nextAccelerometer() accéléromètres. Retourne : un pointeur sur un objet YAccelerometer , correspondant au premier accéléromètre accessible en null ligne, ou si il n'y a pas de accéléromètres disponibles. www.yoctopuce.com...
Page 391
YAccelerometer.nextAccelerometer() accéléromètres. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YAccelerometer , correspondant au premier accéléromètre accessible en null ligne, ou si il n'y a pas de accéléromètres disponibles. www.yoctopuce.com...
Page 392
à m é t h o d e pour obtenir une objet permettant d'intéragir avec le YAccelerometer.FindAccelerometer module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 393
24. Référence de l'API de haut niveau YAccelerometer accelerometer→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 394
24. Référence de l'API de haut niveau YAccelerometer accelerometer→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
24. Référence de l'API de haut niveau YAccelerometer accelerometer→Bandwidth Fréquence de rafraîchissement de la mesure, en Hz. int Bandwidth Modifiable. Lorsque la fréquence est plus basse, un moyennage est effectué. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
24. Référence de l'API de haut niveau YAccelerometer accelerometer→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
24. Référence de l'API de haut niveau YAccelerometer accelerometer→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
"OFF". Attention il est inutile, voir contre productif, de régler la fréquence d'enregistrement à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
24. Référence de l'API de haut niveau YAccelerometer accelerometer→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
"OFF". Attention il est inutile, voir contre productif, de régler la fréquence de notification périodique à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Modifiable. Modifie la résolution des valeurs physique mesurées. La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
24. Référence de l'API de haut niveau YAccelerometer accelerometer→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 405
être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'accéléromètre. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
è r e s d é c r i v a n t l ' a c c é l é r o m è t r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 408
YAccelerometer.ADVMODE_PERIOD_AVG YAccelerometer.ADVMODE_PERIOD_MIN YAccelerometer.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne YAccelerometer.ADVMODE_INVALID www.yoctopuce.com...
En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'accéléromètre.
Page 415
) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'accéléromètre.
24. Référence de l'API de haut niveau YAccelerometer accelerometer→get_module() accelerometer→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
24. Référence de l'API de haut niveau YAccelerometer accelerometer→get_module_async() accelerometer→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YAccelerometer target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YAccelerometer target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle l'accélération est exprimée En cas d'erreur, déclenche une exception ou retourne YAccelerometer.UNIT_INVALID www.yoctopuce.com...
) function get_userData( ) async get_userData( ): Promise<object|null> async 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é précédemment par l'appelant. www.yoctopuce.com...
): Promise<number> async get_xValue( ) double get_xValue( ) double get_xValue( ) YAccelerometer target get_xValue Retourne : une valeur numérique représentant la composante X de l'accélération, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YAccelerometer.XVALUE_INVALID www.yoctopuce.com...
): Promise<number> async get_yValue( ) double get_yValue( ) double get_yValue( ) YAccelerometer target get_yValue Retourne : une valeur numérique représentant la composante Y de l'accélération, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YAccelerometer.YVALUE_INVALID www.yoctopuce.com...
): Promise<number> async get_zValue( ) double get_zValue( ) double get_zValue( ) YAccelerometer target get_zValue Retourne : une valeur numérique représentant la composante Z de l'accélération, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YAccelerometer.ZVALUE_INVALID www.yoctopuce.com...
Si les valeurs des attributs en cache de l'accéléromètre sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'accéléromètre est joignable, sinon www.yoctopuce.com...
Page 437
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 438
) YAccelerometer target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 439
Retourne faux si le module n'est pas joignable, ou que le capteur n'a pas de mesure actuelle à communiquer. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur dispose d'une mesure actuelle, sinon www.yoctopuce.com...
Page 440
Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 441
Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 442
Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 443
YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 444
éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 445
é c i f i q u e , u t i l i s e z Accelerometer.findAccelerometer() avec un hardwareID ou un nom logique. Retourne : YAccelerometer null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 446
Paramètres : 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 un objet YMeasure décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 447
Paramètres : 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 chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 448
Y A c c e l e r o m e t e r . A D V M O D E _ P E R I O D _ M I N YAccelerometer.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 449
être préservé. saveToFlash() Paramètres : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 450
Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur maximale observée Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 451
être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 452
être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'accéléromètre. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 453
Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur minimale observée Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 454
être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 455
être préservé. Paramètres : une valeur numérique représentant la résolution des valeurs physique mesurées newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 456
$data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 457
) int startDataLogger( ) int startDataLogger( ) YAccelerometer target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 458
) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YAccelerometer target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 459
Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 460
La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Interface de configuration du référentiel 3D, disponibles par exemple dans le Yocto-3D-V2 et le Yocto- Inclinometer La class permet de configurer l'orientation des capteurs inertiels Yoctopuce. Cela permet YRefFrame aux fonctions d'orientation relatives au plan de la surface terrestre d'utiliser le référentiel approprié.
Page 462
Retourne l'état de calibration des capteurs 3D (Yocto-3D-V2 seulement). refframe→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du référentiel. refframe→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du référentiel. refframe→get_friendlyName() www.yoctopuce.com...
Page 463
Retourne le nom logique du référentiel. refframe→get_measureQuality() Retourne l'estimation de qualité de la mesure d'orientation (Yocto-3D-V2 seulement). refframe→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. refframe→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. refframe→get_mountOrientation() Retourne l'orientation à...
Page 464
Initie le processus de calibration tridimensionnelle des capteurs. refframe→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. refframe→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 465
à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le référentiel sans ambiguïté, par exemple Y3DMK002.refFrame Retourne : YRefFrame un objet de classe qui permet ensuite de contrôler le référentiel. www.yoctopuce.com...
Page 466
Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le référentiel sans ambiguïté, par exemple Y3DMK002.refFrame Retourne : YRefFrame un objet de classe qui permet ensuite de contrôler le référentiel. www.yoctopuce.com...
Page 467
FirstRefFrame( ) Utiliser la fonction pour itérer sur les autres référentiels. YRefFrame.nextRefFrame() Retourne : un pointeur sur un objet YRefFrame , correspondant au premier référentiel accessible en ligne, ou null si il n'y a pas de référentiels disponibles. www.yoctopuce.com...
Page 468
YRefFrame.nextRefFrame() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YRefFrame , correspondant au premier référentiel accessible en ligne, ou null si il n'y a pas de référentiels disponibles. www.yoctopuce.com...
Page 469
Chaque chaîne retournée peut être passée en argument à la méthode YRefFrame.FindRefFrame pour obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 470
24. Référence de l'API de haut niveau YRefFrame refframe→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 471
De même, si le capteur n'est pas positionné dans une des directions standard à cause d'un angle de lacet supplémentaire, vous pouvez le configurer comme cap de référence afin que le compas donne la direction naturelle attendue. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 472
Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 473
24. Référence de l'API de haut niveau YRefFrame refframe→FunctionId Identifiant matériel du référentiel, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 474
Notez que les modes de fonctionnements disponibles dépendent du type de capteur. Modifiable. Notez que les modes de fonctionnements disponibles dépendent du type de capteur. N'oubliez pas d'appeler la méthode du module si vous désirez que le réglage soit saveToFlash() préservé au prochain redémarrage. www.yoctopuce.com...
Page 475
24. Référence de l'API de haut niveau YRefFrame refframe→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 476
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 477
24. Référence de l'API de haut niveau YRefFrame refframe→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 478
24. Référence de l'API de haut niveau YRefFrame refframe→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 479
) java async Task<int> cancel3DCalibration( ) cancel3DCalibration( ) function cancel3DCalibration( ) async cancel3DCalibration( ): Promise<number> async cancel3DCalibration( ) int cancel3DCalibration( ) int cancel3DCalibration( ) YRefFrame target cancel3DCalibration En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 480
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du référentiel. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 481
î n e c a r a c t è r e s d é c r i v a n t r é f é r e n t i e l ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 483
Task<string> get_3DCalibrationLogMsg( ) get_3DCalibrationLogMsg( ) function get_3DCalibrationLogMsg( ) async get_3DCalibrationLogMsg( ): Promise<string> async get_3DCalibrationLogMsg( ) string get_3DCalibrationLogMsg( ) string get_3DCalibrationLogMsg( ) YRefFrame target get_3DCalibrationLogMsg Si aucun nouveau message n'est disponible, retourne une chaîne vide. Retourne : une chaîne de caractères. www.yoctopuce.com...
Page 484
) java async Task<int> get_3DCalibrationProgress( ) get_3DCalibrationProgress( ) function get_3DCalibrationProgress( ) async get_3DCalibrationProgress( ): Promise<number> async get_3DCalibrationProgress( ) int get_3DCalibrationProgress( ) int get_3DCalibrationProgress( ) YRefFrame target get_3DCalibrationProgress Retourne : une nombre entier entre 0 (pas commencé) et 100 (terminé). www.yoctopuce.com...
Page 485
Task<int> get_3DCalibrationStage( ) get_3DCalibrationStage( ) function get_3DCalibrationStage( ) async get_3DCalibrationStage( ): Promise<number> async get_3DCalibrationStage( ) int get_3DCalibrationStage( ) int get_3DCalibrationStage( ) YRefFrame target get_3DCalibrationStage Retourne : une nombre entier, croissant au fur et à mesure de la complétion des étapes. www.yoctopuce.com...
Page 486
) java async Task<int> get_3DCalibrationStageProgress( ) get_3DCalibrationStageProgress( ) function get_3DCalibrationStageProgress( ) async get_3DCalibrationStageProgress( ): Promise<number> async get_3DCalibrationStageProgress( ) int get_3DCalibrationStageProgress( ) int get_3DCalibrationStageProgress( ) YRefFrame target get_3DCalibrationStageProgress Retourne : une nombre entier entre 0 (pas commencé) et 100 (terminé). www.yoctopuce.com...
Page 487
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRefFrame.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 488
Le cap relatif indiqué par le compas est la différence entre le Nord magnétique mesuré et le cap de référence spécifié ici. Retourne : une valeur numérique représentant le cap de référence utilisé par le compas En cas d'erreur, déclenche une exception ou retourne YRefFrame.BEARING_INVALID www.yoctopuce.com...
Page 489
Yocto-3D-V2: 333 quand il est entièrement calibré, 0 lorsqu'il n'est pas calibré du tout. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. Pour le Yocto-3D (V1), la valeur retournée est toujours -3 (fonction non supportée). www.yoctopuce.com...
Page 490
) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du référentiel.
Page 491
) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du référentiel.
Page 492
(par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le référentiel en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YRefFrame.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 493
é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 494
) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le référentiel (ex: En cas d'erreur, déclenche une exception ou retourne YRefFrame.FUNCTIONID_INVALID www.yoctopuce.com...
Page 495
Y R e f F r a m e . F U S I O N M O D E _ I N C L I N _ 9 0 D E G _ 3 G 6 YRefFrame.FUSIONMODE_INCLIN_10DEG représentant le mode de fonctionnement du capteur En cas d'erreur, déclenche une exception ou retourne YRefFrame.FUSIONMODE_INVALID www.yoctopuce.com...
Page 496
L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du référentiel (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le référentiel (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YRefFrame.HARDWAREID_INVALID www.yoctopuce.com...
Page 497
) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YRefFrame target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du référentiel. En cas d'erreur, déclenche une exception ou retourne YRefFrame.LOGICALNAME_INVALID www.yoctopuce.com...
Page 498
Retourne : un entier entre 0 et 3 (3 quand la mesure est fiable) En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. Pour le Yocto-3D (V1), la valeur retournée est toujours -3 (fonction non supportée). www.yoctopuce.com...
Page 499
24. Référence de l'API de haut niveau YRefFrame refframe→get_module() refframe→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 500
24. Référence de l'API de haut niveau YRefFrame refframe→get_module_async() refframe→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
Page 501
à la l'orientation de la flèche "X" sur le module par rapport à un cadran d'horloge vu par un observateur au centre de la boîte. Sur la face BOTTOM le 12h pointe vers l'avant, tandis que sur la face TOP le 12h pointe vers l'arrière. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 502
' é n u m é r a t i o n YRefFrame.MOUNTPOSITION_BOTTOM YRefFrame.MOUNTPOSITION_TOP YRefFrame.MOUNTPOSITION_FRONT YRefFrame.MOUNTPOSITION_RIGHT YRefFrame.MOUNTPOSITION_REAR YRefFrame.MOUNTPOSITION_LEFT ), correspondant à l'installation dans une boîte, sur l'une des six faces En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 503
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YRefFrame target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 504
) function get_userData( ) async get_userData( ): Promise<object|null> async 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é précédemment par l'appelant. www.yoctopuce.com...
Page 505
Si les valeurs des attributs en cache du référentiel sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le référentiel est joignable, sinon www.yoctopuce.com...
Page 506
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 507
) YRefFrame target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 508
Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 509
Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 510
YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 511
Cette méthode doit être appelée environ 5 fois par secondes après avoir positionné le module selon les instructions fournies par la méthode get_3DCalibrationHint (les instructions changent pendant la procédure de calibration). En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 512
éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 513
): YRefFrame | null nextRefFrame( ) Si vous souhaitez retrouver un référentiel spécifique, utilisez RefFrame.findRefFrame() avec un hardwareID ou un nom logique. Retourne : YRefFrame null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 514
Paramètres : 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 chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 515
) int save3DCalibration( ) YRefFrame target save3DCalibration N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé après saveToFlash() le redémarrage du module. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 516
être préservé. Paramètres : newval une valeur numérique représentant le cap de référence utilisé par le compas Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 517
Y R e f F r a m e . F U S I O N M O D E _ I N C L I N _ 9 0 D E G _ 3 G 6 YRefFrame.FUSIONMODE_INCLIN_10DEG représentant le mode de fonctionnement du capteur Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 518
être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du référentiel. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 519
"X" sur le module par rapport à un cadran d'horloge vu par un observateur au centre de la boîte. Sur la face BOTTOM le 12h pointe vers l'avant, tandis que sur la face TOP le 12h pointe vers l'arrière. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 520
$data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 521
100. Il est alors possible d'appliquer les paramètres get_3DCalibrationProgress calculés, à l'aide de la méthode save3DCalibration . A tout moment, la calibration peut être abandonnée à l'aide de cancel3DCalibration En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 522
Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 523
La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
24. Référence de l'API de haut niveau 24.6. La classe YDataLogger Interface de contrôle de l'enregistreur de données, présent sur la plupart des capteurs Yoctopuce. La plupart des capteurs Yoctopuce sont équipés d'une mémoire non-volatile. Elle permet de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un ordinateur. La classe contrôle les paramètres globaux de cet enregistreur de données.
Page 525
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données. datalogger→get_friendlyName() NOM_MODULE.NOM_FONCTION Retourne un identifiant global de l'enregistreur de données au format datalogger→get_functionDescriptor() YFUN_DESCR Retourne un identifiant unique de type correspondant à la fonction. www.yoctopuce.com...
Page 526
SERIAL.FUNCTIONID datalogger→get_logicalName() Retourne le nom logique de l'enregistreur de données. datalogger→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_recording() Retourne l'état d'activation de l'enregistreur de données.
Page 527
Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData datalogger→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. datalogger→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 528
à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple RX420MA1.dataLogger Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
Page 529
La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple RX420MA1.dataLogger Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
Page 530
YDataLogger.nextDataLogger() données. Retourne : un pointeur sur un objet YDataLogger , correspondant au premier enregistreur de données accessible null en ligne, ou si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
Page 531
YDataLogger.nextDataLogger() données. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YDataLogger , correspondant au premier enregistreur de données accessible null en ligne, ou si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
Page 532
à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YDataLogger.FindDataLogger correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 533
24. Référence de l'API de haut niveau YDataLogger datalogger→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 534
Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() pour sauver la modification de configuration. Attention si le module n'a pas de source de temps à sa disposition au démarrage, il va attendre environ 8 sec avant de démarrer automatiquement l'enregistrement avec un horodatage arbitraire. www.yoctopuce.com...
Page 535
Vrai si l'enregistreur de données est synchronisé avec la balise de localisation. int BeaconDriven Modifiable. Modifie le mode de synchronisation de l'enregistreur de données . N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 536
Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 537
24. Référence de l'API de haut niveau YDataLogger datalogger→FunctionId Identifiant matériel de l'enregistreur de données, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 538
24. Référence de l'API de haut niveau YDataLogger datalogger→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 539
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 540
24. Référence de l'API de haut niveau YDataLogger datalogger→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 541
24. Référence de l'API de haut niveau YDataLogger datalogger→Recording état d'activation de l'enregistreur de données. int Recording Modifiable. www.yoctopuce.com...
Page 542
24. Référence de l'API de haut niveau YDataLogger datalogger→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 543
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'enregistreur de données. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 544
è r e s d é c r i v a n t l ' e n r e g i s t r e u r d o n n é e s ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 545
) int forgetAllDataStreams( ) YDataLogger target forgetAllDataStreams Cette méthode remet aussi à zéro le compteur de Runs. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 546
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 547
) int get_autoStart( ) YDataLogger target get_autoStart Retourne : YDataLogger.AUTOSTART_OFF YDataLogger.AUTOSTART_ON soit , soit , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension En cas d'erreur, déclenche une exception ou retourne YDataLogger.AUTOSTART_INVALID www.yoctopuce.com...
Page 548
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.BEACONDRIVEN_INVALID www.yoctopuce.com...
Page 549
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.CURRENTRUNINDEX_INVALID www.yoctopuce.com...
Page 550
Cette méthode ne fonctionne que si le module utilise un firmware récent, car les objets YDataSet sont pas supportés par les firmwares antérieurs à la révision 13000. Retourne : YDataSet une liste d'objets En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
Page 551
Paramètres : un tableau de DataStream qui sera rempli avec les séquences trouvées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 552
) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
Page 553
) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
Page 554
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 555
é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 556
) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'enregistreur de données (ex: En cas d'erreur, déclenche une exception ou retourne YDataLogger.FUNCTIONID_INVALID www.yoctopuce.com...
Page 557
L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'enregistreur de données (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YDataLogger.HARDWAREID_INVALID www.yoctopuce.com...
Page 558
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.LOGICALNAME_INVALID www.yoctopuce.com...
Page 559
24. Référence de l'API de haut niveau YDataLogger datalogger→get_module() datalogger→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 560
24. Référence de l'API de haut niveau YDataLogger datalogger→get_module_async() datalogger→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
Page 561
): Promise<YDataLogger_Recording> async get_recording( ) int get_recording( ) int get_recording( ) YDataLogger target get_recording Retourne : YDataLogger.RECORDING_OFF YDataLogger.RECORDING_ON une valeur parmi YDataLogger.RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne YDataLogger.RECORDING_INVALID www.yoctopuce.com...
Page 562
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YDataLogger target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 563
): Promise<number> async get_timeUTC( ) long get_timeUTC( ) s64 get_timeUTC( ) YDataLogger target get_timeUTC Retourne : un entier représentant le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue En cas d'erreur, déclenche une exception ou retourne YDataLogger.TIMEUTC_INVALID www.yoctopuce.com...
Page 564
) async get_usage( ): Promise<number> async get_usage( ) int get_usage( ) int get_usage( ) YDataLogger target get_usage Retourne : un entier représentant le pourcentage d'utilisation de la mémoire d'enregistrement En cas d'erreur, déclenche une exception ou retourne YDataLogger.USAGE_INVALID www.yoctopuce.com...
Page 565
) function get_userData( ) async get_userData( ): Promise<object|null> async 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é précédemment par l'appelant. www.yoctopuce.com...
Page 566
Si les valeurs des attributs en cache de l'enregistreur de données sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'enregistreur de données est joignable, sinon www.yoctopuce.com...
Page 567
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 568
) YDataLogger target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 569
Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 570
Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 571
YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 572
éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 573
é c i f i q u e , u t i l i s e z DataLogger.findDataLogger() avec un hardwareID ou un nom logique. Retourne : YDataLogger null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 574
Paramètres : 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 chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 575
, soit , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 576
Paramètres : newval YDataLogger.BEACONDRIVEN_OFF YDataLogger.BEACONDRIVEN_ON soit , soit selon le mode de synchronisation de l'enregistreur de données Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 577
être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'enregistreur de données. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 578
Paramètres : newval une valeur parmi YDataLogger.RECORDING_OFF YDataLogger.RECORDING_ON YDataLogger.RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 579
Paramètres : newval un entier représentant la référence de temps UTC, afin de l'attacher aux données enregistrées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 580
$data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 581
Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 582
La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Pour utiliser les fonctions décrites ici, vous devez inclure: <script type='text/javascript' src='yocto_module.js'></script> #include "yocto_module.h" #import "yocto_module.h" uses yocto_module; yocto_module.vb yocto_module.cs import com.yoctopuce.YoctoAPI.YDataSet; java import com.yoctopuce.YoctoAPI.YDataSet; from yocto_module import * require_once('yocto_module.php'); in HTML: import { YDataSet } from '../../dist/esm/yocto_module.js'; in Node.js: import { YDataSet } from 'yoctolib-cjs/yocto_module.js';...
Page 584
Retourne l'état d'avancement du chargement des données, sur une échelle de 0 à 100. dataset→get_startTimeUTC() Retourne l'heure absolue du début des mesures disponibels, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix). dataset→get_summary() www.yoctopuce.com...
Page 585
Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, et met à jour l'indicateur d'avancement. dataset→loadMore_async(callback, context) Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, de manière asynchrone. www.yoctopuce.com...
Page 586
à dire en nombre de secondes depuis le 1er endTime janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : une instance de YDataSet , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 587
OBSOLÈTE: cette methode a été remplacé par get_summary() qui retoure des informations plus précises. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la dernière mesure. www.yoctopuce.com...
Page 588
String get_functionId( ) java async Task<string> get_functionId( ) get_functionId( ) function get_functionId( ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example temperature1 Retourne : temperature1 une chaîne de caractères identifiant la fonction (ex: www.yoctopuce.com...
Page 589
L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example THRMCPL1-123456.temperature1 Retourne : THRMCPL1-123456.temperature1 une chaîne de caractères identifiant la fonction (ex: En cas d'erreur, déclenche une exception ou retourne YDataSet.HARDWAREID_INVALID www.yoctopuce.com...
Page 590
UTC de l'enregistreur de données pendant l'enregistrement. Retourne : un tableau d'enregistrements, chaque enregistrement représentant une mesure effectuée à un moment précis. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
Page 591
Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
Page 592
Retourne la valeur moyenne observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 593
Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
Page 594
Retourne la plus grande valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 595
Retourne la plus petite valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 596
Le nombre total de mesures disponible n'est connu que lorsque toutes les mesures sont chargées, c'est-à-dire quand a été appelé en boucle jusqu'à ce que l'indicateur d'avancement loadMore() retourne 100. Retourne : un nombre entier correspondant au nombre d'entrées déjà chargées. www.yoctopuce.com...
Page 597
Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la début de la mesure. www.yoctopuce.com...
Page 598
Le résumé des mesures est disponible dès que loadMore() a été appelé pour la première fois. Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
Page 599
Retourne la valeur moyenne observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 600
Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
Page 601
Retourne la plus grande valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 602
Retourne la plus petite valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 603
24. Référence de l'API de haut niveau YDataSet dataset→get_previewRecordCount() dataset→previewRecordCount() Retourne le nombre d'entrées dans la version résumée des mesures qui pourront être obtenues dans ce YDataSet Retourne : un nombre entier correspondant au nombre d'entrées dans le résumé. www.yoctopuce.com...
Page 604
Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la début de la mesure. www.yoctopuce.com...
Page 605
, l'avancement est nul. Au fur et à mesure get_dataSet() des appels à loadMore() , l'avancement progresse pour atteindre la valeur 100 lorsque toutes les mesures ont été chargées. Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées. www.yoctopuce.com...
Page 606
à jour à la première mesure effectivement disponible dans l'enregistreur de données pour la plage spécifiée. OBSOLÈTE: cette methode a été remplacé par qui retoure des informations plus get_summary() précises. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la première mesure enregistrée. www.yoctopuce.com...
Page 607
- la valeur minimale observée dans l'intervalle de temps - la valeur moyenne observée dans l'intervalle de temps - la valeur maximale observée dans l'intervalle de temps Ce résumé des mesures est disponible dès que a été appelé pour la première fois. loadMore() Retourne : un objet YMeasure www.yoctopuce.com...
Page 608
24. Référence de l'API de haut niveau YDataSet dataset→get_summaryAvg() dataset→summaryAvg() Retourne la valeur moyenne observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 609
Lors que l'enregistrement de données se fait à une fréquence supérieure à une mesure par seconde, le timestamp peuvent inclurent une fraction décimale. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
Page 610
24. Référence de l'API de haut niveau YDataSet dataset→get_summaryMax() dataset→summaryMax() Retourne la plus grande valeur observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 611
24. Référence de l'API de haut niveau YDataSet dataset→get_summaryMin() dataset→summaryMin() Retourne la plus petite valeur observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 612
Lors que l'enregistrement de données se fait à une fréquence supérieure à une mesure par seconde, le timestamp peuvent inclurent une fraction décimale. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la début de la mesure. www.yoctopuce.com...
Page 613
Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) Retourne : une chaîne de caractères représentant une unité physique. En cas d'erreur, déclenche une exception ou retourne YDataSet.UNIT_INVALID www.yoctopuce.com...
Page 614
) Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées, ou un code d'erreur négatif en cas de problème. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 615
YDataSet dont la méthode loadMore_async a été appelée - le résultat de l'appel: soit l'état d'avancement du chargement (0...100), ou un code d'erreur négatif en cas de problème. variable de contexte à disposition de l'utilisateur context Retourne : rien. www.yoctopuce.com...
Valeur mesurée, retournée en particulier par les méthodes de la classe YDataSet Les objets sont utilisés dans l'interface de programmation Yoctopuce pour représenter une YMeasure valeur observée à un moment donnée. Ces objets sont utilisés en particulier en conjonction avec la classe , mais aussi par les notification périodique des capteurs configurées (voir...
Page 617
): double function get_averageValue( ) As Double double get_averageValue( ) double get_averageValue( ) java double get_averageValue( ) get_averageValue( ) function get_averageValue( ) get_averageValue( ): number get_averageValue( ) Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 618
Lors que l'enregistrement de données se fait à une fréquence supérieure à une mesure par seconde, le timestamp peuvent inclurent une fraction décimale. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
Page 619
): double function get_maxValue( ) As Double double get_maxValue( ) double get_maxValue( ) java double get_maxValue( ) get_maxValue( ) function get_maxValue( ) get_maxValue( ): number get_maxValue( ) Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 620
): double function get_minValue( ) As Double double get_minValue( ) double get_minValue( ) java double get_minValue( ) get_minValue( ) function get_minValue( ) get_minValue( ): number get_minValue( ) Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 621
Lors que l'enregistrement de données se fait à une fréquence supérieure à une mesure par seconde, le timestamp peuvent inclurent une fraction décimale. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la début de la mesure. www.yoctopuce.com...
25.1. Par où commencer ? Si c'est la première fois que vous utilisez un module Yoctopuce et ne savez pas trop par où commencer, allez donc jeter un coup d'œil sur le blog de Yoctopuce. Il y a une section dédiée aux débutants 25.2.
25.5. Module alimenté mais invisible pour l'OS Si votre Yocto-Inclinometer est branché par USB et que sa LED bleue s'allume, mais que le module n'est pas vu par le système d'exploitation, vérifiez que vous utilisez bien un vrai câble USB avec les fils pour les données, et non pas un câble de charge.
25. Problèmes courants 25.7. Déconnexions, comportement erratique Si votre Yocto-Inclinometer se comporte de manière erratique et/ou se déconnecte du bus USB sans raison apparente, vérifiez qu'il est alimenté correctement. Evitez les câbles d'une longueur supérieure à 2 mètres. Au besoin, intercalez un hub USB alimenté...
26. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module Yocto-Inclinometer Identifiant produit YCLINOM1 † Révision matérielle Connecteur USB micro-B Epaisseur 5 mm Largeur 20 mm Longueur 55 mm Poids 4.4 g Senseur SCL3300 (Murata) Fréquence 10 Hz Précision...