5. Premiers pas .......................... 5.1. Prérequis ..........................5.2. Test de la connectivité USB ....................5.3. Localisation ........................5.4. Test du module ........................5.5. Configuration ........................6. Montage et connectique ....................6.1. Fixation ..........................6.2. Contraintes d'alimentation par USB ................www.yoctopuce.com...
Page 4
7.6. Files ............................. 7.7. Quelle interface: Native, DLL ou Service? ............... 7.8. Programmation, par où commencer? ................8. Utilisation du Yocto-MaxiDisplay en ligne de commande ......8.1. Installation .......................... 8.2. Utilisation: description générale ..................8.3. Contrôle de la fonction Display ..................
Page 5
16. Utilisation du Yocto-MaxiDisplay en JavaScript / EcmaScript ....16.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ....... 16.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ......16.3. Contrôle de la fonction Display ..................16.4. Contrôle de la partie module ..................
Page 6
20.3. Utilisation l'API Yoctopuce dans un projet Visual Studio .......... 20.4. Contrôle de la fonction Display ..................20.5. Un exemple concret ....................... 20.6. Contrôle de la partie module ..................20.7. Gestion des erreurs ....................... 21. Utilisation du Yocto-MaxiDisplay en Objective-C .........
Les ingénieurs Yoctopuce se sont donné beaucoup de mal pour que votre Yocto-MaxiDisplay 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-MaxiDisplay 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-MaxiDisplay, 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-MaxiDisplay 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 à...
Yocto-MaxiDisplay. Lorsque vous installez votre Yocto-MaxiDisplay veillez à ce que l'écran ne soit soumi à aucune contrainte mécanique. De plus la nappe qui sort de l'écran est particulièrement fragile au niveau de la jonction à l'écran, veillez court-court-court long-long-long court-court-court support@yoctopuce.com...
Il ne doit en aucun cas être mis en commun avec un circuit d'alimentation réseau. Vous voudrez probablement souder un connecteur à l'endroit prévu à cet effet. Pour accéder au pads, enlevez les vis situées au dos de votre Yocto-MaxiDisplay, écartez délicatement l'écran et soudez votre connecteur. Replacez l'écran ensuite.
Yoctopuce. Vis et entretoises Pour fixer le module Yocto-MaxiDisplay à un support, vous pouvez placer des petites vis de 3mm avec une tête de 8mm 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 à ce sujet dans le chapitre concernant le montage et la connectique.
Page 15
2. Présentation Vous pouvez installer votre Yocto-MaxiDisplay dans un boîtier optionnel. www.yoctopuce.com...
Yocto- MaxiDisplay, et ne plus s'occuper de rien, le reste est géré par le processeur du Yocto-MaxiDisplay. A ce titre le Yocto-MaxiDisplay fonctionne un peu comme un accélérateur graphique où les tâches graphiques sont effectuées par un processeur dédié...
Yocto-MaxiDisplay, et d'afficher ensuite ce bitmap d'un coup directement sur la couche graphique de votre choix. Cette opération est suffisamment rapide pour fabriquer des animations graphiques arbitraires en temps réel.
8x8.yfm Mode console Il existe une autre méthode pour afficher du texte sur votre Yocto-MaxiDisplay: le mode console. La console est une zone rectangulaire dont la position est paramétrable. Les textes affichés dans cette console sont affichés à la manière d'un terminal, les retours à la ligne et le défilement sont gérés automatiquement.
3.6. Format des fichiers de fontes Votre Yocto-MaxiDisplay contient quelques fontes intégrées, mais il a été conçu pour que vous puissiez créer vos propres fontes aussi facilement que possible. Un fichier de fonte pour votre Yocto- MaxiDisplay est essentiellement un gros bitmap où...
éléments de la séquence terminé, appeler saveSequece. La séquence sera alors sauvée dans le file system du Yocto-MaxiDisplay. Elle pourra être rejouée à volonté grâce à playSequence. Il est possible de créer des boucles en appelant playSequence à l'intérieur d'une séquence.
Cette lenteur est essentiellement due au protocole HID utilisé pour que le Yocto-MaxiDisplay puisse être piloté sans drivers. Le taux de transfert entre l'écran et l'ordinateur est limité à 64Ko par seconde. Chaque requête prends environ 3 ms. Il existe cependant des techniques pour optimiser l'affichage.
4. Le système de fichiers embarqué Votre Yocto-MaxiDisplay dispose d'un petit système de fichiers embarqué, qui permet de stocker des fichiers personnalisés utilisables par le Yocto-MaxiDisplay. Le système de fichier se manipule grâce à la libraire yocto_files. 4.1. Utilisation Utilisation interactive avec le virtual hub Le Virtual Hub fourni une interface sommaire pour manipuler le contenu du système de fichiers:...
"123456789" est 0xCBF43926. Utilisation par HTTP Les fichiers que vous avez chargés sur sur votre Yocto-MaxiDisplay sont accessibles par HTTP, à la racine du module (au même niveau que l'API REST). Cela permet de charger par exemple des pages d'interface HTML et Javascript personnalisées.
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-MaxiDisplay à 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-MaxiDisplay, 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. 5.3. Localisation Il est alors possible de localiser physiquement chacun des modules affichés en cliquant sur le bouton...
Firmware Le firmware du module peut être facilement mis à jour à l'aide de l'interface. Les firmwares destinés aux modules Yoctopuce se présentent sous la forme de fichiers .byn et peuvent être téléchargés depuis le site web de Yoctopuce. Pour mettre à jour un firmware, cliquez simplement sur le bouton upgrade de la fenêtre de configuration et suivez les instructions.
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-MaxiDisplay dispose de trous de montage 3mm. 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 8mm, sous peine d'endommager les circuits du module.
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...
Page 33
Toujours par rapport aux normes de compatibilité électromagnétique, la longueur maximale supportée du câble USB est de 3m. En plus de pouvoir causer des problèmes de chute de tension, l'utilisation de câbles plus long aurait des incidences sur les test d'immunité électromagnétiques à effectuer pour respecter les normes. www.yoctopuce.com...
7.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 à...
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.
7.2. Le module Yocto-MaxiDisplay Le module Yocto-MaxiDisplay est un écran OLED de 128x64 pixels. Il inclut un filesystem permettant de stocker des fichiers (images, polices, séquences) et six instances de la fonction AnButton, correspondant aux six entrées analogiques (lecture de potentiomètre ou de bouton) présentes sur le module.
Chaine de caractères contenant le numéro de série, unique et préprogrammé en usine. Pour un module Yocto-MaxiDisplay, ce numéro de série commence toujours par YD128X64. Il peut servir comme point de départ pour accéder par programmation à un module particulier.
écrans Yoctopuce. L'interface de contrôle des écrans YDisplay Yoctopuce est conçue pour afficher facilement des informations et des images. Le module est capable de gérer seul la superposition de plusieurs couches graphiques, qui peuvent être dessinées individuellement, sans affichage immédiat, puis librement positionnées sur l'écran.
7.5. AnButton Interface pour intéragir avec les entrées analogiques, disponibles par exemple dans le Yocto-Buzzer, le Yocto-Knob, le Yocto-MaxiBuzzer et le Yocto-MaxiDisplay La classe permet d'accéder à une entrée résistive simple. Cela permet aussi bien de YAnButton mesurer l'état d'un simple bouton que de lire un potentiomètre analogique (résistance variable),...
Page 41
Temps absolu de la dernière occurrence de "pression de bouton" observée sur l'entrée (transition du contact de ouvert à fermé). La base de temps est la même que l'attribut du module, c'est à upTime dire le temps écoulé depuis la dernière mise sous tension du module. www.yoctopuce.com...
Interface pour intéragir avec les systèmes de fichier, disponibles par exemple dans le Yocto-Color- V2, le Yocto-Serial, le YoctoHub-Ethernet et le YoctoHub-Wireless-n La class YFiles permet d'accéder au système de fichier embarqué sur certains modules Yoctopuce. Le stockage de fichiers permet par exemple de personnaliser un service web (dans le cas d'un module connecté...
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'à...
Page 44
✔ ✔ C# UWP ✔ ✔ LabVIEW ✔ ✔ Java ✔ ✔ Java pour Android ✔ TypeScript ✔ JavaScript / ECMAScript ✔ ✔ ✔ VisualBasic .Net ✔ ✔ Delphi ✔ ✔ Objective-C Méthode de support pour les différents langages. www.yoctopuce.com...
Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto- MaxiDisplay. 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 .
8. Utilisation du Yocto-MaxiDisplay en ligne de commande Lorsque vous désirez effectuer une opération ponctuelle sur votre Yocto-MaxiDisplay, 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. 8.3. Contrôle de la fonction Display Pour contrôler la fonction Display de votre Yocto-MaxiDisplay, vous avez besoin de l'exécutable YDisplay. Vous pouvez par exemple lancer: C:\>YDisplay -layer 0 drawText 64 16 CENTER "Hello world!"...
8. Utilisation du Yocto-MaxiDisplay en ligne de commande 8.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 50
8. Utilisation du Yocto-MaxiDisplay 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.
9. Utilisation du Yocto-MaxiDisplay en Python Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code Python qui utilise la fonction Display. [...] # On active la détection des modules sur USB errmsg=YRefParam() YAPI.RegisterHub("usb",errmsg)
Page 53
9. Utilisation du Yocto-MaxiDisplay en Python import os, from yocto_api import from yocto_display 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) <...
9. Utilisation du Yocto-MaxiDisplay en Python while disp.isOnline(): < > w - (h / 4): < > h - (h / 4): l1.setLayerPosition(x, y, 0) YAPI.Sleep(5, errmsg) YAPI.FreeAPI() 9.4. 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...
9. Utilisation du Yocto-MaxiDisplay en Python mémorisées 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 . Inversement il est possible de forcer le module à oublier ses réglages YModule.saveToFlash()
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: •...
à la création d'un projet à neuf linké avec les librairies Yoctopuce. 10.1. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code C++ qui utilise la fonction Display. #include "yocto_api.h"...
Page 58
Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-MaxiDisplay avec le numéros de série YD128X64-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
Page 59
10. Utilisation du Yocto-MaxiDisplay en C++ #include "yocto_api.h" #include "yocto_display.h" #include <iostream> #include <stdio.h> #include <stdlib.h> using namespace std; static void usage(void) cout << "Wrong command line arguments" << endl; cout << "usage: demo <serial_number>" << endl; cout << "...
10. Utilisation du Yocto-MaxiDisplay en C++ l0->lineTo(w 6, h - 1); l0->moveTo(w l0->lineTo(w l0->lineTo(w // draw a circle in the top left corner of layer 1 = disp->get_displayLayer(1); l1->clear(); l1->drawCircle(h 8, h 8, h / 8); // and animate the layer cout <<...
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.
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: •...
Windows. Ce script qui se situe à la racine de la librairie, détecte l'OS et build.bat recompile toutes les librairies ainsi que les exemples correspondants. Ensuite, pour intégrer la librairie statique Yoctopuce à votre projet, vous devez inclure le répertoire de la librairie Yoctopuce à votre IncludePath, et ajouter le sous-répertoire de Sources correspondant à...
11.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. 11.3. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code C# qui utilise la fonction Display. [...] // On active la détection des modules sur USB...
Page 67
11. Utilisation du Yocto-MaxiDisplay en C# display = YDisplay.FindDisplay("MonModule.MaFonction"); display = YDisplay.FindDisplay("MaFonction"); renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler YDisplay.FindDisplay l'ecran. isOnline La méthode de l'objet renvoyé par permet de savoir si le isOnline() YDisplay.FindDisplay module correspondant est présent et en état de marche.
11. Utilisation du Yocto-MaxiDisplay en C# //clean up disp.resetAll(); // retreive the display size = disp.get_displayWidth(); = disp.get_displayHeight(); // reteive the first layer = disp.get_displayLayer(0); // display a text in the middle of the screen l0.drawText(w 2, h 2, YDisplayLayer.ALIGN.CENTER, "Hello...
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: •...
11. Utilisation du Yocto-MaxiDisplay en C# méthodes . Ce sont les même informations qui auraient été errType() errMessage() associées à l'exception si elles avaient été actives. www.yoctopuce.com...
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 75
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.
à 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.
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 78
\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 12.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.
à 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.
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 83
12. Utilisation du Yocto-MaxiDisplay 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.
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 12.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...
12. Utilisation du Yocto-MaxiDisplay 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 12.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...
12. Utilisation du Yocto-MaxiDisplay avec LabVIEW 12.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. 13.2. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code Java qui utilise la fonction Display. [...] // On active l'accès aux modules locaux à...
Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-MaxiDisplay avec le numéros de série YD128X64-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
Page 93
13. Utilisation du Yocto-MaxiDisplay en Java layer0.moveTo(0, my); layer0.lineTo(l, my); layer0.drawText(mx, my, al, text); public static void main(String[] args) YDisplay disp; YDisplayLayer h, w, y, x, vx, // API init try { // setup the API to use local VirtualHub YAPI.RegisterHub("127.0.0.1");...
13. Utilisation du Yocto-MaxiDisplay en Java < 0) || > / 4))) { = -vy; l1.setLayerPosition(x, y, YAPI.Sleep(5); } catch (YAPI_Exception ex) { System.out.println("Exception durring execution (" + ex.getLocalizedMessage() + ")"); YAPI.FreeAPI(); System.exit(1); 13.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 95
13. Utilisation du Yocto-MaxiDisplay en Java } catch (YAPI_Exception ex) { System.out.println(args[1] + " not connected (check identification and USB cable)"); YAPI.FreeAPI(); Chaque propriété du module peut être lue grâce à une méthode du type YModule.get_xxxx , et les propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux...
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 97
13. Utilisation du Yocto-MaxiDisplay en Java www.yoctopuce.com...
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...
14. Utilisation du Yocto-MaxiDisplay 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é...
14. Utilisation du Yocto-MaxiDisplay avec Android 14.5. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code Java qui utilise la fonction Display. [...] // On active la détection des modules sur USB YAPI.EnableUSBHost(this);...
Page 103
14. Utilisation du Yocto-MaxiDisplay 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.
Page 108
14. Utilisation du Yocto-MaxiDisplay 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.
15.3. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code TypeScript qui utilise la fonction Display. // 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)
à en faire un petit programme d'exemple concret. Si le Yocto-MaxiDisplay 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 115
15. Utilisation du Yocto-MaxiDisplay en TypeScript let disp: YDisplay; let l1: YDisplayLayer; let h: number; let w: number; let y: number; let x: number; let vx: number; let vy: number; async function startDemo(): Promise<void> await YAPI.LogUnhandledPromiseRejections(); // Setup the API to use the VirtualHub on local machine...
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-MaxiDisplay. Vous y trouverez un fichier html , et un fichier TypeScript similaire au code ci-dessus, app.html...
15. Utilisation du Yocto-MaxiDisplay en TypeScript Comme pour l'exemple Node.js, la compilation produit un fichier qui permet de debugger .js.map dans le navigateur directement sur le fichier source TypeScript. Notez qu'au moment où cette documentation est rédigée, le debug en format source dans le navigateur fonctionne pour les browsers basés sur Chromium, mais pas encore dans Firefox.
Page 118
15. Utilisation du Yocto-MaxiDisplay en TypeScript import { YAPI, YErrorMsg, YModule } from 'yoctolib-cjs/yocto_api_nodejs.js'; async function startDemo(args: string[]): 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:...
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.
16. Utilisation du Yocto-MaxiDisplay en JavaScript / EcmaScript 16.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.
16. Utilisation du Yocto-MaxiDisplay 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); 16.3. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction Display. // En Node.js, on utilise la fonction require() // En HTML, on utiliserait <script src="...">...
Page 126
à en faire un petit programme d'exemple concret. Si le Yocto-MaxiDisplay 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ù...
Page 127
16. Utilisation du Yocto-MaxiDisplay en JavaScript / EcmaScript disp YDisplay.FindDisplay(serial + ".display"); //clean up await disp.resetAll(); // retreive the display size = await disp.get_displayWidth(); = await disp.get_displayHeight(); // reteive the first layer = await disp.get_displayLayer(0); // display a text in the middle of the screen await l0.drawText(w...
Page 128
16. Utilisation du Yocto-MaxiDisplay en JavaScript / EcmaScript trouverez un fichier html, avec une section JavaScript similaire au code précédent, mais avec quelques variantes pour permettre une interaction à travers la page HTML plutôt que sur la console JavaScript <!DOCTYPE html>...
16. Utilisation du Yocto-MaxiDisplay en JavaScript / EcmaScript async function refresh() { if (await disp.isOnline()) { x += vx; y += vy; if ((x < || (x > w - (h / 4))) vx = -vx; if ((y < || (y >...
Page 130
16. Utilisation du Yocto-MaxiDisplay en JavaScript / EcmaScript startDemo(process.argv.slice(2)); 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 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 132
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. 17.2. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code PHP qui utilise la fonction Display. include('yocto_api.php');...
Yocto-MaxiDisplay. 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é...
17. Utilisation du Yocto-MaxiDisplay en PHP browser favori. Vous trouverez aussi ce code dans le répertoire Examples/Doc-GettingStarted- Yocto-MaxiDisplay 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 136
17. Utilisation du Yocto-MaxiDisplay 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 137
17. Utilisation du Yocto-MaxiDisplay 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 139
17. Utilisation du Yocto-MaxiDisplay 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 140
17. Utilisation du Yocto-MaxiDisplay 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 142
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: •...
18.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 à...
18.3. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction Display. [...] ' On active la détection des modules sur USB...
18. Utilisation du Yocto-MaxiDisplay en VisualBasic .NET renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler YDisplay.FindDisplay l'ecran. isOnline La méthode de l'objet renvoyé par permet de savoir si le isOnline() YDisplay.FindDisplay module correspondant est présent et en état de marche.
18. Utilisation du Yocto-MaxiDisplay en VisualBasic .NET = disp.get_displayHeight() reteive the first layer = disp.get_displayLayer(0) display a text the middle the screen l0.drawText(CInt(w 2), CInt(h 2), Y_ALIGN.CENTER, "Hello world!") visualize each corner l0.moveTo(0, l0.lineTo(0, l0.lineTo(5, l0.moveTo(0, h - 6) l0.lineTo(0, h - 1) l0.lineTo(5, h...
Page 147
18. Utilisation du Yocto-MaxiDisplay en VisualBasic .NET argv.Length < Then usage() = YModule.FindModule(argv(1)) REM use serial logical name If (m.isOnline()) Then argv.Length > Then If argv(2) = "ON" Then m.set_beacon(Y_BEACON_ON) If argv(2) = "OFF" Then m.set_beacon(Y_BEACON_OFF) End If Console.WriteLine("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.
Page 149
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: •...
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 152
[...] Voyons maintenant en détail ce que font ces quelques lignes. yocto_api et yocto_display 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_display contenant un ecran, comme le Yocto-MaxiDisplay.
19. Utilisation du Yocto-MaxiDisplay en Delphi L1:=Disp.get_displaylayer(1); L1.clear(); L1.drawCircle(H 8, H 8, h // and animate the layer Writeln('Use Ctrl-C to stop'); x:=0; y:=0; vx:=1; vy:=1; while (disp.isOnline()) do begin x:=x+vx;y:=y+vy; if (x<0) or (x>w-(h div 4)) then vx:=-vx; if (y<0) or (y>h-(h...
Page 155
19. Utilisation du Yocto-MaxiDisplay en Delphi end; module := yFindModule(serial); refresh(module); repeat read(c); 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...
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 157
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: •...
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.
20.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.
20.4. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code c# qui utilise la fonction Display.
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 .
20. Utilisation du Yocto-MaxiDisplay avec Universal Windows Platform // reteive the first layer = await disp.get_displayLayer(0); // display a text in the middle of the screen await l0.drawText(w 2, h 2, YDisplayLayer.ALIGN.CENTER, Message); // visualize each corner await l0.moveTo(0, await l0.lineTo(0,...
Page 164
20. Utilisation du Yocto-MaxiDisplay avec Universal Windows Platform string errmsg = ""; if (await YAPI.RegisterHub(HubURL) != YAPI.SUCCESS) { WriteLine("RegisterHub error: " + errmsg); return -1; YModule.FindModule(Target + ".module"); // use serial or logical name if (await m.isOnline()) { if (Beacon) { await m.set_beacon(YModule.BEACON_ON);...
Page 165
20. Utilisation du Yocto-MaxiDisplay avec Universal Windows Platform if (await m.isOnline()) { if (!YAPI.CheckLogicalName(LogicalName)) { WriteLine("Invalid name (" LogicalName + ")"); return -1; await m.set_logicalName(LogicalName); await m.saveToFlash(); // do not forget this Write("Module: serial= " + await m.get_serialNumber()); WriteLine(" / name= "...
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. 21.1. Contrôle de la fonction Display Il suffit de quelques lignes de code pour piloter un Yocto-MaxiDisplay. Voici le squelette d'un fragment de code Objective-C qui utilise la fonction Display. #import "yocto_api.h"...
Page 168
Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-MaxiDisplay avec le numéros de série YD128X64-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
Page 169
21. Utilisation du Yocto-MaxiDisplay en Objective-C NSLog(@" demo <logical_name>"); NSLog(@" demo any (use any discovered device)"); exit(1); int main(int argc, const char * argv[]) NSError *error; YDisplay *disp; YDisplayLayer *l0, *l1; h, w, y, x, vx, vy; @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) {...
21. Utilisation du Yocto-MaxiDisplay en Objective-C [l1 setLayerPosition:x :y :0]; [YAPI Sleep:5 :&error]; [YAPI FreeAPI]; return 21.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 171
21. Utilisation du Yocto-MaxiDisplay en Objective-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: •...
Page 173
21. Utilisation du Yocto-MaxiDisplay en Objective-C , 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 type attendu, et ne sera pas un pointeur nul qui risquerait de faire crasher votre programme. Au pire, si vous affichez la valeur sans la tester, elle sera hors du cadre attendu pour la valeur retournée.
ê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.
22. 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é.
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-MaxiDisplay avec le numéro de de série YD128X64-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.
22.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 180
(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...
22. 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.
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 184
à 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 .
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-MaxiDisplay. 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 187
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 188
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.
. 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 190
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 191
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 192
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 193
(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 194
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 195
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 196
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 197
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 198
. 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 199
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 200
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 201
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 202
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.
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 204
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...
"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 206
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 207
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 208
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 209
"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 210
, 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 211
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 212
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 213
à 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 214
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 215
(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 216
à 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 217
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 218
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 219
ê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 220
ê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 221
à 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 222
é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 223
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 224
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 225
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 226
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 228
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 229
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 230
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 231
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 232
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 233
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 234
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 235
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 236
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 237
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 238
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 239
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 240
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 241
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 242
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 243
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 244
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 245
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 246
) 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 247
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...
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 249
à 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 250
) 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 251
à 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 252
à 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 253
à 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 254
à 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 255
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 256
): 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 257
) 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 258
) 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 259
' 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 260
$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 261
) 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 262
) 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 263
) 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 264
) 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 265
): 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 266
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 267
' 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 268
) 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 269
): 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 270
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 271
' 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 272
): 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 273
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...
): 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 275
): 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 276
): 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 277
) 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 278
) 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 279
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 280
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 281
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 282
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 283
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 284
ê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 285
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 286
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 287
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 288
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 289
$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 290
) 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 291
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 292
ê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 293
ê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 294
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 295
ê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 296
ê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 297
$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 298
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 299
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 300
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 301
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 302
à 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 303
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...
écrans Yoctopuce. L'interface de contrôle des écrans YDisplay Yoctopuce est conçue pour afficher facilement des informations et des images. Le module est capable de gérer seul la superposition de plusieurs couches graphiques, qui peuvent être dessinées individuellement, sans affichage immédiat, puis librement positionnées sur l'écran.
Page 305
Change la luminosité de l'écran en douceur, pour produire un effet de fade-in ou fade-out. display→get_advertisedValue() Retourne la valeur courante de l'ecran (pas plus de 6 caractères). display→get_brightness() Retourne la luminosité des leds informatives du module (valeur entre 0 et 100). www.yoctopuce.com...
Page 306
Retourne la largeur des couches affichables, en pixels. display→get_logicalName() Retourne le nom logique de l'ecran. display→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. display→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. display→get_orientation() Retourne l'orientation sélectionnée pour l'écran.
Page 307
Modifie le nom de la séquence à jouer à la mise sous tension de l'écran. display→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 display→stopSequence(sequenceName) Arrête immédiatement la séquence d'affichage actuellement jouée sur l'écran. display→swapLayerContent(layerIdA, layerIdB) www.yoctopuce.com...
Page 308
Télécharge un contenu arbitraire (par exemple une image GIF) vers le système de fichier de l'écran, au chemin d'accès spécifié. display→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 309
à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'ecran sans ambiguïté, par exemple YD128X32.display Retourne : YDisplay un objet de classe qui permet ensuite de contrôler l'ecran. www.yoctopuce.com...
Page 310
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'ecran sans ambiguïté, par exemple YD128X32.display Retourne : YDisplay un objet de classe qui permet ensuite de contrôler l'ecran. www.yoctopuce.com...
Page 311
FirstDisplay( ) Utiliser la fonction pour itérer sur les autres écrans. YDisplay.nextDisplay() Retourne : un pointeur sur un objet YDisplay , correspondant au premier écran accessible en ligne, ou null si il n'y a pas de écrans disponibles. www.yoctopuce.com...
Page 312
écrans. YDisplay.nextDisplay() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YDisplay , correspondant au premier écran accessible en ligne, ou null si il n'y a pas de écrans disponibles. www.yoctopuce.com...
Page 313
Chaque chaîne retournée peut être passée en argument à la méthode YDisplay.FindDisplay 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 314
24. Référence de l'API de haut niveau YDisplay display→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 315
Luminosité des leds informatives du module (valeur entre 0 et 100). int Brightness Modifiable. Modifie la luminositéde l'écran. 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 préservé. saveToFlash() www.yoctopuce.com...
Page 316
24. Référence de l'API de haut niveau YDisplay display→DisplayHeight Hauteur de l'écran, en pixels. int DisplayHeight www.yoctopuce.com...
Page 317
24. Référence de l'API de haut niveau YDisplay display→DisplayType Type de l'écran: monochrome, niveaux de gris ou couleur. int DisplayType www.yoctopuce.com...
Page 318
24. Référence de l'API de haut niveau YDisplay display→DisplayWidth Largeur de l'écran, en pixels. int DisplayWidth 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 YDisplay display→FunctionId Identifiant matériel de l'ecran, 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 YDisplay display→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
24. Référence de l'API de haut niveau YDisplay display→LayerCount Nombre des couches affichables disponibles. int LayerCount www.yoctopuce.com...
Page 324
24. Référence de l'API de haut niveau YDisplay display→LayerHeight Hauteur des couches affichables, en pixels. int LayerHeight www.yoctopuce.com...
Page 325
24. Référence de l'API de haut niveau YDisplay display→LayerWidth Largeur des couches affichables, en pixels. int LayerWidth www.yoctopuce.com...
Page 326
24. Référence de l'API de haut niveau YDisplay display→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 327
24. Référence de l'API de haut niveau YDisplay display→Orientation Orientation sélectionnée pour l'écran. int Orientation Modifiable. Modifie l'orientation de l'écran. N'oubliez pas d'appeler la méthode saveToFlash() module si le réglage doit être préservé. www.yoctopuce.com...
Page 328
24. Référence de l'API de haut niveau YDisplay display→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 329
24. Référence de l'API de haut niveau YDisplay display→StartupSeq Nom de la séquence à jouer à la mise sous tension de l'écran. string StartupSeq Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 330
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'ecran. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
(un chiffre parmi 0..layerCount-1) dstLayerId l'identifiant de la couche de destination (un chiffre parmi 0..layerCount-1) 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 332
î n e c a r a c t è r e s d é c r i v a n t l ' e c r a n ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 333
Paramètres : brightness nouvelle valeur de luminosité de l'écran duration durée en millisecondes de la transition. 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 334
' 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 YDisplay.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
): Promise<number> async get_brightness( ) int get_brightness( ) int get_brightness( ) YDisplay target get_brightness 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 YDisplay.BRIGHTNESS_INVALID www.yoctopuce.com...
Page 336
) async get_displayHeight( ): Promise<number> async get_displayHeight( ) int get_displayHeight( ) int get_displayHeight( ) YDisplay target get_displayHeight Retourne : un entier représentant la hauteur de l'écran, en pixels En cas d'erreur, déclenche une exception ou retourne YDisplay.DISPLAYHEIGHT_INVALID www.yoctopuce.com...
Page 337
Le contenu n'est visible sur l'écran que lorsque la couche est active sur l'écran (et non masquée par une couche supérieure). Paramètres : layerId l'identifiant de la couche d'affichage désirée (un chiffre parmi 0..layerCount-1) Retourne : un objet YDisplayLayer En cas d'erreur, déclenche une exception ou retourne null www.yoctopuce.com...
Page 338
) int get_displayType( ) int get_displayType( ) YDisplay target get_displayType Retourne : YDisplay.DISPLAYTYPE_MONO YDisplay.DISPLAYTYPE_GRAY une valeur parmi YDisplay.DISPLAYTYPE_RGB représentant le type de l'écran: monochrome, niveaux de gris ou couleur En cas d'erreur, déclenche une exception ou retourne YDisplay.DISPLAYTYPE_INVALID www.yoctopuce.com...
Page 339
) async get_displayWidth( ): Promise<number> async get_displayWidth( ) int get_displayWidth( ) int get_displayWidth( ) YDisplay target get_displayWidth Retourne : un entier représentant la largeur de l'écran, en pixels En cas d'erreur, déclenche une exception ou retourne YDisplay.DISPLAYWIDTH_INVALID www.yoctopuce.com...
Page 340
): Promise<YDisplay_Enabled> async get_enabled( ) int get_enabled( ) int get_enabled( ) YDisplay target get_enabled Retourne : YDisplay.ENABLED_FALSE YDisplay.ENABLED_TRUE soit , soit , selon vrai si le l'ecran est alimenté, faux sinon En cas d'erreur, déclenche une exception ou retourne YDisplay.ENABLED_INVALID www.yoctopuce.com...
Page 341
) 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'ecran.
Page 342
) 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'ecran.
Page 343
î n e d e c a r a c t è r e s i d e n t i f i a n t l ' e c r a n e n u t i l i s a n t l e s n o m s l o g i q u e s ( e x : MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YDisplay.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 344
é 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 345
) 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'ecran (ex: En cas d'erreur, déclenche une exception ou retourne YDisplay.FUNCTIONID_INVALID www.yoctopuce.com...
) L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'ecran (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'ecran (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YDisplay.HARDWAREID_INVALID www.yoctopuce.com...
Page 347
) async get_layerCount( ): Promise<number> async get_layerCount( ) int get_layerCount( ) int get_layerCount( ) YDisplay target get_layerCount Retourne : un entier représentant le nombre des couches affichables disponibles En cas d'erreur, déclenche une exception ou retourne YDisplay.LAYERCOUNT_INVALID www.yoctopuce.com...
Page 348
) async get_layerHeight( ): Promise<number> async get_layerHeight( ) int get_layerHeight( ) int get_layerHeight( ) YDisplay target get_layerHeight Retourne : un entier représentant la hauteur des couches affichables, en pixels En cas d'erreur, déclenche une exception ou retourne YDisplay.LAYERHEIGHT_INVALID www.yoctopuce.com...
Page 349
) async get_layerWidth( ): Promise<number> async get_layerWidth( ) int get_layerWidth( ) int get_layerWidth( ) YDisplay target get_layerWidth Retourne : un entier représentant la largeur des couches affichables, en pixels En cas d'erreur, déclenche une exception ou retourne YDisplay.LAYERWIDTH_INVALID www.yoctopuce.com...
Page 350
) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YDisplay target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'ecran. En cas d'erreur, déclenche une exception ou retourne YDisplay.LOGICALNAME_INVALID www.yoctopuce.com...
Page 351
24. Référence de l'API de haut niveau YDisplay display→get_module() display→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 352
24. Référence de l'API de haut niveau YDisplay display→get_module_async() display→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 353
): Promise<YDisplay_Orientation> async get_orientation( ) int get_orientation( ) int get_orientation( ) YDisplay target get_orientation Retourne : YDisplay.ORIENTATION_LEFT YDisplay.ORIENTATION_UP une valeur parmi YDisplay.ORIENTATION_RIGHT YDisplay.ORIENTATION_DOWN représentant l'orientation sélectionnée pour l'écran En cas d'erreur, déclenche une exception ou retourne YDisplay.ORIENTATION_INVALID www.yoctopuce.com...
Page 354
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YDisplay 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
) string get_startupSeq( ) YDisplay target get_startupSeq Retourne : une chaîne de caractères représentant le nom de la séquence à jouer à la mise sous tension de l'écran En cas d'erreur, déclenche une exception ou retourne YDisplay.STARTUPSEQ_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'ecran 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'ecran 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
) YDisplay 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
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...
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 362
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 363
é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 364
Le nom de la séquence sera donné au moment de l'appel à , une fois la séquence saveSequence() terminé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...
): YDisplay | null nextDisplay( ) Si vous souhaitez retrouver un ecran spécifique, utilisez Display.findDisplay() avec un hardwareID ou un nom logique. Retourne : YDisplay null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 366
Pour annuler une attente, appelez simplement la méthode avec une attente de zéro. Paramètres : delay_ms la durée de l'attente, en 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 367
YDisplay target playSequence sequenceName Paramètres : sequenceName le nom de la nouvelle séquence créé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 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
Utiliser cette fonction dans une sequence va tuer stopper l'affichage de la sequence: ne pas utiliser cette fonction pour réinitialiser l'écran au début d'une séquence. 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...
La séquence peut être rejouée ultérieurement à l'aide de la méthode playSequence() Paramètres : sequenceName le nom de la nouvelle séquence créé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 371
Le paramêtre est une valeur entre 0 et 100. N'oubliez pas d'appeler la méthode saveToFlash() module si le réglage doit être préservé. Paramètres : un entier représentant la luminositéde l'écran 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
YDisplay target set_enabled newval Paramètres : newval soit YDisplay.ENABLED_FALSE , soit YDisplay.ENABLED_TRUE , selon l'état d'activité de l'écran 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 : newval une chaîne de caractères représentant le nom logique de l'ecran. 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 374
être préservé. saveToFlash() Paramètres : newval YDisplay.ORIENTATION_LEFT YDisplay.ORIENTATION_UP une valeur parmi YDisplay.ORIENTATION_RIGHT YDisplay.ORIENTATION_DOWN représentant l'orientation de l'écran 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 375
à jouer à la mise sous tension de newval l'écran 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
$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 377
YDisplay target stopSequence L'affichage est laissé tel quel. Paramètres : sequenceName le nom de la nouvelle séquence créé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 378
(un chiffre parmi 0..layerCount-1) layerIdB l'identifiant de la deuxième couche (un chiffre parmi 0..layerCount-1) 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 379
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 380
Paramètres : nom complet du fichier, y compris le chemin d'accès. pathname content contenu du fichier à télécharger 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 381
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_display.js'></script> #include "yocto_display.h" #import "yocto_display.h" uses yocto_display; yocto_display.vb yocto_display.cs import com.yoctopuce.YoctoAPI.YDisplayLayer; java import com.yoctopuce.YoctoAPI.YDisplayLayer; from yocto_display import * require_once('yocto_display.php'); in HTML: import { YDisplayLayer } from '../../dist/esm/yocto_display.js'; in Node.js: import { YDisplayLayer } from 'yoctolib-cjs/yocto_display.js';...
Page 383
Configure les marges d'affichage pour la fonction displaylayer→setConsoleWordWrap(wordwrap) Configure le mode de retour à la ligne utilisé par la fonction consoleOut displaylayer→setLayerPosition(x, y, scrollTime) Déplace la position de la couche de dessin par rapport au coin supérieur gauche de l'écran. displaylayer→unhide() Affiche la couche. www.yoctopuce.com...
Page 384
Cette méthode ne change pas les réglages de le couche. Si vous désirez remettre la couche dans son état initial, utilisez plutôt la méthode reset() 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 385
): Promise<number> async clearConsole( ) int clearConsole( ) int clearConsole( ) YDisplay target [-layer layerId] clearConsole 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 386
à la nouvelle ligne de texte. Paramètres : text le message à afficher 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 387
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 388
à utiliser pour les bits à zéro (0 = noir, 255 = blanc), ou -1 pour lasser les pixels inchangés www.yoctopuce.com...
Page 389
24. Référence de l'API de haut niveau 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 390
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 391
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 392
GIF à afficher 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 393
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 394
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 395
Y D i s p l a y L a y e r . A L I G N _ B A S E L I N E _ R I G H T YDisplayLayer.ALIGN_BOTTOM_RIGHT text le texte à afficher www.yoctopuce.com...
Page 396
24. Référence de l'API de haut niveau 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 398
) async get_displayHeight( ): Promise<number> async get_displayHeight( ) int get_displayHeight( ) int get_displayHeight( ) YDisplay target [-layer layerId] get_displayHeight Retourne : un entier représentant la hauteur de l'écran, en pixels En cas d'erreur, déclenche une exception ou retourne Y_DISPLAYHEIGHT_INVALID. www.yoctopuce.com...
Page 399
) async get_displayWidth( ): Promise<number> async get_displayWidth( ) int get_displayWidth( ) int get_displayWidth( ) YDisplay target [-layer layerId] get_displayWidth Retourne : un entier représentant la largeur de l'écran, en pixels En cas d'erreur, déclenche une exception ou retourne Y_DISPLAYWIDTH_INVALID. www.yoctopuce.com...
Page 400
): Promise<number> async get_layerHeight( ) int get_layerHeight( ) int get_layerHeight( ) YDisplay target [-layer layerId] get_layerHeight Retourne : un entier représentant la hauteur des couches affichables, en pixels. En cas d'erreur, déclenche une exception ou retourne Y_LAYERHEIGHT_INVALID. www.yoctopuce.com...
Page 401
): Promise<number> async get_layerWidth( ) int get_layerWidth( ) int get_layerWidth( ) YDisplay target [-layer layerId] get_layerWidth Retourne : un entier représentant la largeur des couches affichables, en pixels En cas d'erreur, déclenche une exception ou retourne Y_LAYERWIDTH_INVALID. www.yoctopuce.com...
Page 402
évite de consacrer inutilement des cycles de calcul à afficher les états intermédiaires (technique de double-buffering). 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 403
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 404
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 405
Si vous désirez simplement effacer le contenu de la couche, utilisez plutôt la méthode clear() 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 406
Paramètres : color la couleur RGB désirée (sous forme d'entier 24 bits) 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 407
Tous les points dessinés à la gomme redeviennent transparents (comme ils l'étaient lorsque la couche était vide), rendant ainsi visibles les couches inférieures. 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 408
Les polices intégrées sont 8x8.yfm, Small.yfm, Medium.yfm, Large.yfm (sauf Yocto-MiniDisplay). 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 409
à 128 conduit à un point noir, et toue valeur supérieure ou égale à 128 devient un point lumineux. Paramètres : graylevel le niveau de gris désiré, de 0 à 255 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 410
écrans monochromes. Paramètres : mode true pour activer l'antialiasing, false pour le désactiver. 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 411
à utiliser pour le fond lors de défilement (0 = noir, 255 = blanc), ou -1 pour un fond transparent 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...
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...
à la ligne entre les mots seulements, false pour retourner à l'extrême droite de chaque ligne. 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 414
0 si le déplacement doit être immédiat. scrollTime 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 415
) int unhide( ) YDisplay target [-layer layerId] unhide Affiche a nouveau la couche après la command hide. 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...
24. Référence de l'API de haut niveau 24.5. La classe YAnButton Interface pour intéragir avec les entrées analogiques, disponibles par exemple dans le Yocto-Buzzer, le Yocto-Knob, le Yocto-MaxiBuzzer et le Yocto-MaxiDisplay La classe permet d'accéder à une entrée résistive simple. Cela permet aussi bien de YAnButton mesurer l'état d'un simple bouton que de lire un potentiomètre analogique (résistance variable), comme...
Page 417
Retourne la valeur minimale observée durant la calibration (entre 0 et 4095 inclus). anbutton→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'entrée analogique. anbutton→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'entrée analogique. anbutton→get_friendlyName() www.yoctopuce.com...
Page 418
à l'entrée (transition du contact de fermé à ouvert). anbutton→get_logicalName() Retourne le nom logique de l'entrée analogique. anbutton→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. anbutton→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. anbutton→get_pulseCounter() Retourne la valeur du compteur d'impulsions.
Page 419
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 anbutton→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. anbutton→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 420
à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'entrée analogique sans ambiguïté, par exemple YBUZZER2.anButton1 Retourne : YAnButton un objet de classe qui permet ensuite de contrôler l'entrée analogique. www.yoctopuce.com...
Page 421
Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'entrée analogique sans ambiguïté, par exemple YBUZZER2.anButton1 Retourne : YAnButton un objet de classe qui permet ensuite de contrôler l'entrée analogique. www.yoctopuce.com...
Page 422
Utiliser la fonction pour itérer sur les autres entrées analogiques. YAnButton.nextAnButton() Retourne : un pointeur sur un objet YAnButton , correspondant à la première entrée analogique accessible en ligne, null si il n'y a pas de entrées analogiques disponibles. www.yoctopuce.com...
Page 423
YAnButton.nextAnButton() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YAnButton , correspondant à la première entrée analogique accessible en ligne, null si il n'y a pas de entrées analogiques disponibles. www.yoctopuce.com...
Page 424
Chaque chaîne retournée peut être passée en argument à la méthode YAnButton.FindAnButton 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 425
24. Référence de l'API de haut niveau YAnButton anbutton→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 426
Permet de savoir si une procédure de calibration est actuellement en cours. int AnalogCalibration Modifiable. Enclenche ou déclenche le procédure de calibration. N'oubliez pas d'appeler la méthode du module à la fin de la calibration si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 427
24. Référence de l'API de haut niveau YAnButton anbutton→CalibratedValue Valeur calibrée de l'entrée (entre 0 et 1000 inclus). int CalibratedValue www.yoctopuce.com...
Page 428
Valeur maximale observée durant la calibration (entre 0 et 4095 inclus). int CalibrationMax Modifiable. Modifie la valeur maximale de calibration pour l'entrée (entre 0 et 4095 inclus), sans lancer la calibration automatique. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 429
Valeur minimale observée durant la calibration (entre 0 et 4095 inclus). int CalibrationMin Modifiable. Modifie la valeur minimale de calibration pour l'entrée (entre 0 et 4095 inclus), sans lancer la calibration automatique. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 430
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 431
24. Référence de l'API de haut niveau YAnButton anbutton→FunctionId Identifiant matériel de l'entrée analogique, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 432
24. Référence de l'API de haut niveau YAnButton anbutton→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 433
24. Référence de l'API de haut niveau YAnButton anbutton→InputType Type de décodage appliqué à l'entrée (entrée analogique ou entrées binaires multiplexées). int InputType Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 434
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 435
24. Référence de l'API de haut niveau YAnButton anbutton→IsPressed Vrai si l'entrée (considérée comme binaire) est active (contact fermé), et faux sinon. int IsPressed www.yoctopuce.com...
Page 436
24. Référence de l'API de haut niveau YAnButton anbutton→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 437
évolue constamment dans la même direction. Cas particulier: lorsque la valeur 1000 est utilisée, seuls les valeurs déclenchant une commutation d'état pressé/non-pressé sont transmises. N'oubliez pas d'appeler la méthode saveToFlash() module si le réglage doit être préservé. www.yoctopuce.com...
Page 438
24. Référence de l'API de haut niveau YAnButton anbutton→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 439
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'entrée analogique. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 440
è r e s d é c r i v a n t l ' e n t r é e a n a l o g i q u e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 441
' 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 YAnButton.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 442
' 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 YAnButton.ANALOGCALIBRATION_INVALID www.yoctopuce.com...
Page 443
' 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 YAnButton.CALIBRATEDVALUE_INVALID www.yoctopuce.com...
Page 444
' 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 YAnButton.CALIBRATIONMAX_INVALID www.yoctopuce.com...
Page 445
' 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 YAnButton.CALIBRATIONMIN_INVALID www.yoctopuce.com...
Page 446
) 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'entrée analogique.
Page 447
) 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'entrée analogique.
Page 448
(par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'entrée analogique en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YAnButton.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 449
é 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 450
) 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'entrée analogique (ex: En cas d'erreur, déclenche une exception ou retourne YAnButton.FUNCTIONID_INVALID www.yoctopuce.com...
L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'entrée analogique (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'entrée analogique (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YAnButton.HARDWAREID_INVALID www.yoctopuce.com...
Page 452
YAnButton.INPUTTYPE_DIGITAL4 YAnButton.INPUTTYPE_ANALOG_SMOOTH représentant le type de décodage appliqué à l'entrée (entrée analogique ou entrées binaires multiplexées) En cas d'erreur, déclenche une exception ou retourne YAnButton.INPUTTYPE_INVALID www.yoctopuce.com...
Page 453
) int get_isPressed( ) YAnButton target get_isPressed Retourne : YAnButton.ISPRESSED_FALSE YAnButton.ISPRESSED_TRUE soit , soit , selon vrai si l'entrée (considérée comme binaire) est active (contact fermé), et faux sinon En cas d'erreur, déclenche une exception ou retourne YAnButton.ISPRESSED_INVALID www.yoctopuce.com...
Page 454
' 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 YAnButton.LASTTIMEPRESSED_INVALID www.yoctopuce.com...
Page 455
' 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 YAnButton.LASTTIMERELEASED_INVALID www.yoctopuce.com...
Page 456
) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YAnButton target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'entrée analogique. En cas d'erreur, déclenche une exception ou retourne YAnButton.LOGICALNAME_INVALID www.yoctopuce.com...
Page 457
24. Référence de l'API de haut niveau YAnButton anbutton→get_module() anbutton→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 458
24. Référence de l'API de haut niveau YAnButton anbutton→get_module_async() anbutton→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 459
La valeur est codée sur 32 bits. En cas de dépassement de capacite (>=2^32), le compteur repart à zéro. Le compteur peut être réinitialisé en appelant la méthode resetCounter(). Retourne : un entier représentant la valeur du compteur d'impulsions En cas d'erreur, déclenche une exception ou retourne YAnButton.PULSECOUNTER_INVALID www.yoctopuce.com...
Page 460
) async get_pulseTimer( ): Promise<number> async get_pulseTimer( ) long get_pulseTimer( ) s64 get_pulseTimer( ) YAnButton target get_pulseTimer Retourne : un entier représentant le timer du compteur d'impulsions (ms) En cas d'erreur, déclenche une exception ou retourne YAnButton.PULSETIMER_INVALID www.yoctopuce.com...
Page 461
): Promise<number> async get_rawValue( ) int get_rawValue( ) int get_rawValue( ) YAnButton target get_rawValue Retourne : un entier représentant la valeur mesurée de l'entrée telle-quelle (entre 0 et 4095 inclus) En cas d'erreur, déclenche une exception ou retourne YAnButton.RAWVALUE_INVALID www.yoctopuce.com...
Page 462
) int get_sensitivity( ) int get_sensitivity( ) YAnButton target get_sensitivity Retourne : un entier représentant la sensibilité pour l'entrée (entre 1 et 1000) pour le déclanchement de callbacks En cas d'erreur, déclenche une exception ou retourne YAnButton.SENSITIVITY_INVALID www.yoctopuce.com...
Page 463
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YAnButton 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 464
) 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 465
Si les valeurs des attributs en cache de l'entrée analogique 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'entrée analogique est joignable, sinon www.yoctopuce.com...
Page 466
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 467
) YAnButton 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 468
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...
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 470
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 471
é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 472
): YAnButton | null nextAnButton( ) Si vous souhaitez retrouver une entrée analogique spécifique, utilisez AnButton.findAnButton() avec un hardwareID ou un nom logique. Retourne : YAnButton null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 473
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 474
) async resetCounter( ): Promise<number> async resetCounter( ) int resetCounter( ) int resetCounter( ) YAnButton target resetCounter 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 475
Y A n B u t t o n . A N A L O G C A L I B R A T I O N _ O F F s o i t s o i t YAnButton.ANALOGCALIBRATION_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 476
(entre 0 et 4095 inclus), sans newval lancer la calibration automatique 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 477
(entre 0 et 4095 inclus), sans newval lancer la calibration automatique 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 478
Y A n B u t t o n . I N P U T T Y P E _ D I G I T A L 4 YAnButton.INPUTTYPE_ANALOG_SMOOTH représentant le type de décodage appliqué à l'entrée (entrée analogique ou entrées binaires multiplexé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 479
être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'entrée analogique. 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 480
Paramètres : un entier représentant la sensibilité pour l'entrée (entre 1 et 1000) pour le déclanchement de newval callbacks 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 481
$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 482
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 483
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 systèmes de fichier, disponibles par exemple dans le Yocto-Color-V2, le Yocto-Serial, le YoctoHub-Ethernet et le YoctoHub-Wireless-n La class YFiles permet d'accéder au système de fichier embarqué sur certains modules Yoctopuce. Le stockage de fichiers permet par exemple de personnaliser un service web (dans le cas d'un module connecté...
Page 485
Retourne l'identifiant matériel du système de fichier, sans référence au module. files→get_hardwareId() SERIAL.FUNCTIONID Retourne l'identifiant matériel unique du système de fichier au format files→get_list(pattern) Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier. www.yoctopuce.com...
Page 486
24. Référence de l'API de haut niveau files→get_logicalName() Retourne le nom logique du système de fichier. files→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_serialNumber() Retourne le numéro de série du module, préprogrammé...
Page 487
à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
Page 488
Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
Page 489
YFiles.nextFiles() Retourne : un pointeur sur un objet YFiles , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
Page 490
YFiles.nextFiles() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YFiles , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
Page 491
Chaque chaîne retournée peut être passée en argument à la méthode pour YFiles.FindFiles 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 492
24. Référence de l'API de haut niveau YFiles files→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 493
24. Référence de l'API de haut niveau YFiles files→FilesCount Nombre de fichiers présents dans le système de fichier. int FilesCount www.yoctopuce.com...
Page 494
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 495
24. Référence de l'API de haut niveau YFiles files→FunctionId Identifiant matériel du système de fichier, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 496
24. Référence de l'API de haut niveau YFiles files→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 497
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 498
24. Référence de l'API de haut niveau YFiles files→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 499
24. Référence de l'API de haut niveau YFiles files→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 500
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du système de fichier. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 501
î n e c a r a c t è r e s d é c r i v a n t s y s t è m e f i c h i e r ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Paramètres : pathname nom complet du fichier à charger, y compris le chemin d'accès. Retourne : le contenu du fichier chargé sous forme d'objet binaire En cas d'erreur, déclenche une exception ou retourne un contenu vide. www.yoctopuce.com...
Page 503
La fonction callback doit prendre trois arguments: - la variable de contexte à disposition de l'utilisateur - l'objet YFiles dont la méthode download_async a été appelée - le contenu du fichier chargé sous forme d'objet binaire variable de contexte à disposition de l'utilisateur context Retourne : rien. www.yoctopuce.com...
Page 504
YFiles target fileExist filename Paramètres : filename le nom de fichier. Retourne : vrais si le fichier existe, et faux is le fichier n'existe pas. En cas d'erreur, déclenche une exception. www.yoctopuce.com...
Page 505
) int format_fs( ) YFiles target format_fs entièrement vide. Tous les fichiers précédemment chargés sont irrémédiablement effacés. 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...
) string get_advertisedValue( ) string get_advertisedValue( ) YFiles target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du système de fichier (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YFiles.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 507
) 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 système de fichier.
Page 508
) 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 système de fichier.
Page 509
): Promise<number> async get_filesCount( ) int get_filesCount( ) int get_filesCount( ) YFiles target get_filesCount Retourne : un entier représentant le nombre de fichiers présents dans le système de fichier En cas d'erreur, déclenche une exception ou retourne YFiles.FILESCOUNT_INVALID www.yoctopuce.com...
Page 510
) int get_freeSpace( ) int get_freeSpace( ) YFiles target get_freeSpace Retourne : un entier représentant l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets En cas d'erreur, déclenche une exception ou retourne YFiles.FREESPACE_INVALID www.yoctopuce.com...
Page 511
(par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le système de fichier en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YFiles.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 512
é 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 513
) 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 système de fichier (ex: En cas d'erreur, déclenche une exception ou retourne YFiles.FUNCTIONID_INVALID www.yoctopuce.com...
L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du système de fichier (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le système de fichier (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YFiles.HARDWAREID_INVALID www.yoctopuce.com...
Page 515
Retourne : YFileRecord une liste d'objets , contenant le nom complet (y compris le chemin d'accès), la taille en octets et le CRC 32-bit du contenu du fichier. En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
Page 516
): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YFiles target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du système de fichier. En cas d'erreur, déclenche une exception ou retourne YFiles.LOGICALNAME_INVALID www.yoctopuce.com...
Page 517
24. Référence de l'API de haut niveau YFiles files→get_module() files→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 518
24. Référence de l'API de haut niveau YFiles files→get_module_async() files→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 519
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YFiles 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 520
) 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 521
Si les valeurs des attributs en cache du système de fichier 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 système de fichier est joignable, sinon www.yoctopuce.com...
Page 522
à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 523
) YFiles 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 524
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 525
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 526
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 527
é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 528
): YFiles | null nextFiles( ) Si vous souhaitez retrouver un système de fichier spécifique, utilisez Files.findFiles() avec un hardwareID ou un nom logique. Retourne : YFiles null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 529
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 530
éventuellement pas été libéré. Pour s'assurer de libérer la totalité de l'espace du système de fichier, utilisez la fonction format_fs Paramètres : pathname nom complet du fichier, y compris le chemin d'accès. 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 531
être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du système de fichier. 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 532
$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 533
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 534
Paramètres : nom complet du fichier, y compris le chemin d'accès. pathname content contenu du fichier à télécharger 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 535
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...
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-MaxiDisplay 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-MaxiDisplay 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-MaxiDisplay Identifiant produit YD128X64 † Révision matérielle Zone affichable 57 x 29.5 mm Connecteur USB micro-B Largeur 58 mm Longueur 66 mm Poids 23 g Resolution 128 x 64 px...