Yocto-altimeter : manuel d'utilisation

Yocto-Altimeter : Manuel d'utilisation

1. Introduction

Le Yocto-Altimeter est un module électronique de 60x20mm qui permet d'estimer l'altitude à laquelle il se trouve sur la base d'une mesure de pression atmosphérique. Le module Yocto-Altimeter indique aussi la pression et la température ambiante. La précision de l'estimation d'altitude relative est de l'ordre de 25cm.

Le module Yocto-Altimeter

Le Yocto-Altimeter n'est pas en lui-même un produit complet. C'est un composant destiné à être intégré dans une solution d'automatisation en laboratoire, ou pour le contrôle de procédés industriels, ou pour des applications similaires en milieu résidentiel ou commercial. Pour pouvoir l'utiliser, il faut au minimum l'installer à l'intérieur d'un boîtier de protection et le raccorder à un ordinateur de contrôle.

Yoctopuce vous remercie d'avoir fait l'acquisition de ce Yocto-Altimeter et espère sincèrement qu'il vous donnera entière satisfaction. Les ingénieurs Yoctopuce se sont donné beaucoup de mal pour que votre Yocto-Altimeter 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 à contacter Yoctopuce:

Adresse e-mail:	support@yoctopuce.com
Site Internet:	www.yoctopuce.com
Adresse postale:	Chemin des Journaliers, 1
Localité:	1236 Cartigny
Pays:	Suisse

1.1. Informations de sécurité

Le Yocto-Altimeter est conçu pour respecter la norme de sécurité IEC 61010-1:2010. Il ne causera pas de danger majeur pour l'opérateur et la zone environnante, même en condition de premier défaut, pour autant qu'il soit intégré et utilisé conformément aux instructions contenues dans cette documentation, et en particulier dans cette section.

Boîtier de protection

Le Yocto-Altimeter 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 à un choc de 5 J, par exemple en polycarbonate (LEXAN ou autre) d'indice de protection IK08 et classifié V-1 ou mieux selon la norme IEC 60695-11-10. L'utilisation d'un boîtier de qualité inférieure peut nécessiter des avertissements spécifiques pour l'utilisateur et/ou compromettre la conformité avec la norme de sécurité.

Entretien

Si un dégat est constaté sur le circuit électronique ou sur le boîtier, il doit être remplacé afin de ne pas compromettre la sécurité d'utilisation et d'éviter d'endommager d'autres parties du système par les surcharges éventuelles que pourrait causer un court-circuit.

Identification

Pour faciliter l'entretien du circuit et l'identification des risques lors de la maintenance, vous devriez coller l'étiquette autocollante synthétique identifiant le Yocto-Altimeter, fournie avec le circuit électronique, à proximité immédiate du module. Si le module est dans un boîtier dédié, l'étiquette devrait être collée sur la surface extérieur du boîtier. L'étiquette est résistante à l'eau et au frottement usuel qui peut survenir durant un entretien usuel.

Applications

La norme de sécurité vérifiée correspond aux instruments de laboratoire, pour le contrôle de procédés industriels, ou pour des applications similaires en milieu résidentiel ou commercial. Si vous comptez l'utiliser le Yocto-Altimeter pour un autre type d'applications, vous devrez vérifier les critères de conformité en fonction de la norme applicable à votre application.

En particulier, le Yocto-Altimeter n'est pas certifié pour utilisation dans un environnement médical, ni pour les applications critiques à la santé, ni pour toute autre application menaçant la vie humaine.

Environnement

Le Yocto-Altimeter n'est pas certifié pour utilisation dans les zones dangereuses, ni pour les environnements explosifs. Les conditions environnementales assignées sont décrites ci-dessous.

1.2. Conditions environnementales

Les produits Yoctopuce sont conçus pour une utilisation intérieure dans un environnement usuel de bureau ou de laboratoire (degré de pollution 2 selon IEC 60664): la pollution de l'air doit être faible et essentiellement non conductrice. L'humidité relative prévue est de 10% à 90% RH, sans condensation. L'utilisation dans un environnement avec une pollution solide ou conductrice significative exige de protéger le module contre cette pollution par un boîtier certifié IP67 ou IP68. Les produits sont conçus pour une utilisation jusqu'à une altitude de 2000m.

Le fonctionnement de tous les modules Yoctopuce est garanti conforme à la documentation et aux spécifications de précision pour des conditions de température ambiante normales selon IEC61010-1, soit 5°C à 40°C. De plus, la plupart des modules peuvent aussi être utilisés sur une plage de température étendue, à laquelle quelques limitations peuvent s'appliquer selon les cas.

La plage de température de fonctionnement étendue du Yocto-Altimeter est -10...85°C. Cette plage de température a été déterminée en fonction des recommandations officielles des fabricants des composants utilisés dans le Yocto-Altimeter, 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-Altimeter dans des conditions de température extrêmes pour une période prolongée, il est recommandé de faire des tests extensifs avant la mise en production.

2. Présentation

1:	Prise USB micro-B	4:	Capteur de pression
2:	Yocto-bouton	5:	Emplacements pour les embases Picoflex
3:	Yocto-led

2.1. Les éléments communs

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 à faire levier. Si les pistes sont restées en place, le connecteur peut être ressoudé à l'aide d'un bon fer et de flux. Alternativement, vous pouvez souder un fil USB directement dans les trous espacés de 1.27mm prévus à cet effet, prêt du connecteur.

Si vous utilisez une source de tension autre qu'un port USB hôte standard pour alimenter le module par le connecteur USB, vous devez respecter les caractéristiques assignées par le standard USB 2.0:

Tension min.: 4.75 V DC
Tension max.: 5.25 V DC
Protection contre les surintensités: max. 5.0 A

Le Yocto-bouton

Le Yocto-bouton a deux fonctions. Premièrement, il permet d'activer la Yocto-balise (voir la Yocto-led ci-dessous). Deuxièmement, si vous branchez un Yocto-module en maintenant ce bouton appuyé, il vous sera possible de reprogrammer son firmware avec une nouvelle version. Notez qu'il existe une méthode plus simple pour mettre à jour le firmware depuis l'interface utilisateur, mais cette méthode-là peut fonctionner même lorsque le firmware chargé sur le module est incomplet ou corrompu.

La Yocto-Led

En temps normal la Yocto-Led sert à indiquer le bon fonctionnement du module: elle émet alors une faible lumière bleue qui varie lentement mimant ainsi une respiration. La Yocto-Led cesse de respirer lorsque le module ne communique plus, par exemple si il est alimenté par un hub sans connexion avec un ordinateur allumé.

Lorsque vous appuyez sur le Yocto-bouton, la Led passe en mode Yocto-balise: elle se met alors à flasher plus vite et beaucoup plus fort, dans le but de permettre une localisation facile d'un module lorsqu'on en a plusieurs identiques. Il est en effet possible de déclencher la Yocto-balise par logiciel, tout comme il est possible de détecter par logiciel une Yocto-balise allumée.

La Yocto-Led a une troisième fonctionnalité moins plaisante: lorsque ce logiciel interne qui contrôle le module rencontre une erreur fatale, elle se met à flasher SOS en morse¹. Si cela arrivait débranchez puis rebranchez le module. Si le problème venait à se reproduire vérifiez que le module contient bien la dernière version du firmware, et dans l'affirmative contactez le support Yoctopuce².

La sonde de courant

Chaque Yocto-module est capable de mesurer sa propre consommation de courant sur le bus USB. La distribution du courant sur un bus USB étant relativement critique, cette fonctionnalité peut être d'un grand secours. La consommation de courant du module est consultable par logiciel uniquement.

Le numéro de série

Chaque Yocto-module a un numéro de série unique attribué en usine, pour les modules Yocto-Altimeter ce numéro commence par YALTIMK1. Le module peut être piloté par logiciel en utilisant ce numéro de série. Ce numéro de série ne peut pas être changé.

Le nom logique

Le nom logique est similaire au numéro de série, c'est une chaine de caractère sensée être unique qui permet référencer le module par logiciel. Cependant, contrairement au numéro de série, le nom logique peut être modifié à volonté. L'intérêt est de pouvoir fabriquer plusieurs exemplaire du même projet sans avoir à modifier le logiciel de pilotage. Il suffit de programmer les même noms logique dans chaque exemplaire. Attention le comportement d'un projet devient imprévisible s'il contient plusieurs modules avec le même nom logique et que le logiciel de pilotage essaye d'accéder à l'un de ces module à l'aide de son nom logique. A leur sortie d'usine, les modules n'ont pas de nom logique assigné, c'est à vous de le définir.

2.2. Les éléments spécifiques

Le capteur

Le capteur MPL3115A2 est fabriqué par Freescale. Il permet de mesurer très precisément la pression atmosphérique entre 500 et 1100 millibars³, ce qui correspond en atmosphère standard à une plage de -2300m à 5500m, mais il continuera à fonctionner correctement jusqu'à 200 millibars, soit environ 11500 mètres...

2.3. Accessoires optionnels

Les accessoires ci-dessous ne sont pas nécessaires à l'utilisation du module Yocto-Altimeter, mais pourraient vous être utiles selon l'utilisation que vous en faites. Il s'agit en général de produits courants que vous pouvez vous procurer chez vos fournisseurs habituels de matériel de bricolage. Pour vous éviter des recherches, ces produits sont en général aussi disponibles sur le shop de Yoctopuce.

Vis et entretoises

Pour fixer le module Yocto-Altimeter à un support, vous pouvez placer des petites vis de 2.5mm avec une tête de 4.5mm au maximum dans les trous prévus ad-hoc. Il est conseillé de les visser dans des entretoises filetées, que vous pourrez fixer sur le support. Vous trouverez plus de détail à ce sujet dans le chapitre concernant le montage et la connectique.

Micro-hub USB

Si vous désirez placer plusieurs modules Yoctopuce dans un espace très restreint, vous pouvez les connecter ensemble à l'aide d'un micro-hub USB. Yoctopuce fabrique des hubs particulièrement petits précisément destinés à cet usage, dont la taille peut être réduite à 20mm par 36mm, et qui se montent en soudant directement les modules au hub via des connecteurs droits ou des câbles nappe. Pour plus de détails, consulter la fiche produit du micro-hub USB.

YoctoHub-Ethernet, YoctoHub-Wireless and YoctoHub-GSM

Vous pouvez ajouter une connectivité réseau à votre Yocto-Altimeter grâce aux hubs YoctoHub-Ethernet, YoctoHub-Wireless et YoctoHub-GSM qui offrent respectivement une connectivité Ethernet, Wifi et GSM. Chacun de ces hubs peut piloter jusqu'à trois modules Yoctopuce et se comporte exactement comme un ordinateur normal qui ferait tourner un VirtualHub.

Connecteurs 1.27mm (ou 1.25mm)

Si vous désirez raccorder le module Yocto-Altimeter à un Micro-hub USB ou a un YoctoHub en évitant l'encombrement d'un vrai cable USB, vous pouvez utiliser les 4 pads au pas 1.27mm juste derrière le connecteur USB. Vous avez alors deux possibilités.

Vous pouvez monter directement le module sur le hub à l'aide d'un jeu de vis et entretoises, et les connecter à l'aide de connecteurs board-to-board au pas 1.27mm. Pour éviter les court-circuits, soudez de préférence le connecteur femelle sur le hub et le connecteur mâle sur le Yocto-Altimeter.

Vous pouvez aussi utiliser un petit câble à 4 fils doté de connecteurs au pas 1.27mm (ou 1.25mm, la différence est négligeable pour 4 pins), ce qui vous permet de déporter le module d'une dizaine de centimètres. N'allongez pas trop la distance si vous utilisez ce genre de câble, car il n'est pas blindé et risque donc de provoquer des émissions électromagnétiques indésirables.

Boîtier

Votre Yocto-Altimeter a été conçu pour pouvoir être installé tel quel dans votre projet. Néanmoins Yoctopuce commercialise des boîtiers spécialement conçus pour les modules Yoctopuce. Ces boîtiers sont munis de pattes de fixation amovibles et d'aimants de fixation. Vous trouverez plus d'informations à propos de ces boîtiers sur le site de Yoctopuce⁴. Le boîtier recommandé pour votre Yocto-Altimeter est le modèle YoctoBox-Long-Thin-Black-Vents

Vous pouvez installer votre Yocto-Altimeter dans un boîtier optionnel.

Connecteurs Picoflex et cable nappe souple

Si vous désirez déporter la partie capteur du module Yocto-Altimeter à l'aide d'un câble à connecteur enfichable, vous aurez besoin de câble nappe souple à 4 fils espacés de 1.27mm et de connecteurs Picoflex.⁵ Vous trouverez plus de détail à ce sujet dans le chapitre concernant le montage et la connectique.

3. Fonctionnement d'un altimètre barométrique

Un altimètre barométrique mesure la pression atmosphérique à l'endroit où il se trouve, calcule la différence par rapport à la pression au niveau de la mer puis en déduit l'altitude. En effet, plus on monte haut dans l'atmosphère, plus la pression baisse.

Variation de la pression en fonction de l'altitude en atmosphère standard.

L'atmosphère considérée comme standard au niveau de la mer est à une pression 1013.25 millibars à 15°C. Mais en réalité cette pression de référence au niveau de la mer subit des variations significatives en fonction des conditions météo.

C'est pourquoi, pour être précis, un altimètre doit régulièrement être réglé. Deux méthodes peuvent être utilisées en fonction des informations disponibles:

L'altitude actuelle est connue: on calibre l'altimètre sur cette altitude, et tout changement d'altitude ultérieur sera alors mesuré précisément. Ainsi, à la mise en route, les avions règlent toujours leur altimètre à l'altitude de l'aéroport où ils se trouvent.
La pression au niveau de la mer est connue. Une fois cette pression de référence donnée à l'altimètre, il sera capable de calculer précisément l'altitude. En aviation, cette pression de référence est appelée le QNH. Il très utilisé, au point que chaque aéroport le communique à chaque avion qui entre en contact avec lui. Un avion en vol peut ainsi recalibrer régulièrement son altimètre, ce qui est indispensable en raison des changements de météo et donc de pression d'un endroit à l'autre. Par conséquent, si vous désirez connaître le QNH de l'endroit ou vous vous trouvez, vous pourrez l'obtenir grâce aux informations météorologiques de l'aéroport le plus proche (cherchez sur Google le code de l'aéroport suivi de QNH).

Pour résumer l'altitude, la pression ambiante et le QNH sont interdépendants: lorsque l'altitude et la pression ambiante sont connues, on peut en déduire le QNH, de même lorsque le QNH et la pression ambiante sont connus, on peut en déduire déduire l'altitude.

Un altimètre d'avion affiche toujours à la fois l'altitude et le QNH.

4. Premiers pas

Par design, tous les modules Yoctopuce se pilotent de la même façon, c'est pourquoi les documentations des modules de la gamme sont très semblables. Si vous avez déjà épluché la documentation d'un autre module Yoctopuce, vous pouvez directement sauter à la description de sa configuration.

4.1. Prérequis

Pour pouvoir profiter pleinement de votre module Yocto-Altimeter, vous devriez disposer des éléments suivants.

Un ordinateur

Les modules de Yoctopuce sont destinés à être pilotés par un ordinateur (ou éventuellement un microprocesseur embarqué). Vous écrirez vous-même le programme qui pilotera le module selon vos besoin, à l'aide des informations fournies dans ce manuel.

Yoctopuce fourni les librairies logicielles permettant de piloter ses modules pour les systèmes d'exploitation suivants: Windows, macOS, Linux et Android. Les modules Yoctopuce ne nécessitent pas l'installation de driver (ou pilote) spécifiques, car ils utilisent le driver HID⁶ fourni en standard dans tous les systèmes d'exploitation.

Les versions de Windows actuellement supportées sont Windows XP, Windows 2003, Windows Vista, Windows 7, Windows 8 et Windows 10. Les versions 32 bit et 64 bit sont supportées. La librairie de programmation est aussi disponible pour la Plateforme Windows Universelle (UWP) supportées par toutes les versions Windows 10, y compris Windows 10 IoT. Yoctopuce teste régulièrement le bon fonctionnement des modules sur Windows 7 et Windows 10.

Les versions de macOS actuellement supportées sont Mac OS X 10.9 (Maverick), 10.10 (Yosemite), 10.11 (El Capitan), macOS 10.12 (Sierra), macOS 10.13 (High Sierra) and macOS 10.14 (Mojave). Yoctopuce teste régulièrement le bon fonctionnement des modules sur macOS 10.14.

Les versions de Linux supportées sont les kernels 2.6, 3.x et 4.x. D'autre versions du kernel et même d'autres variantes d'Unix sont très susceptibles d'être utilisées sans problème, puisque le support de 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).

Les versions de Android actuellement supportées sont 3.1 et suivantes. De plus, il est nécessaire que la tablette ou le téléphone supporte le mode USB Host. Yoctopuce teste régulièrement le bon fonctionnement des modules avec Android 7.x sur un Samsung Galaxy A6 avec la librairie Java pour Android.

Un cable USB 2.0 de type A-micro B

Il existe trois tailles de connecteurs USB 2.0, la taille "normale" que vous utilisez probablement pour brancher votre imprimante. La taille mini encore très courante et enfin la taille micro, souvent utilisée pour raccorder les téléphones portables, pour autant qu'ils n'arborent pas une pomme. Les modules de Yoctopuce sont tous équipés d'une connectique au format micro-USB.

Les connecteurs USB 2.0 les plus courants: A, B, Mini B, Micro A, Micro B. ⁷

Pour connecter votre module Yocto-Altimeter à un ordinateur, vous avez besoin d'un cable USB 2.0 de type A-micro B. Vous trouverez ce cable en vente à des prix très variables selon les sources, sous la dénomination USB A to micro B Data cable. Prenez garde à ne pas acheter par mégarde un simple câble de charge, qui ne fournirait que le courant mais sans les fils de données. Le bon câble est disponible sur le shop de Yoctopuce.

Vous devez raccorder votre module Yocto-Altimeter à 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-Altimeter, prenez garde à ne pas dépasser les limites de courant imposées par USB, sous peine de faire face des comportements instables non prévisibles. Vous trouverez plus de détail à ce sujet dans le chapitre concernant le montage et la connectique.

4.2. Test de la connectivité USB

Arrivé à ce point, votre Yocto-Altimeter devrait être branché à votre ordinateur, qui devrait l'avoir reconnu. Il est temps de le faire fonctionner.

Rendez-vous sur le site de Yoctopuce et téléchargez le programme Virtual Hub⁸, Il est disponible pour Windows, Linux et Mac OS X. En temps normal le programme Virtual Hub sert de couche d'abstraction pour les langages qui ne peuvent pas accéder aux couches matérielles de votre ordinateur. Mais il offre aussi une interface sommaire pour configurer vos modules et tester les fonctions de base, on accède à cette interface à l'aide d'un simple browser web ⁹. Lancez le Virtual Hub en ligne de commande, ouvrez votre browser préféré et tapez l'adresse http://127.0.0.1:4444. Vous devriez voir apparaître la liste des modules Yoctopuce raccordés à votre ordinateur.

Liste des modules telle qu'elle apparaît dans votre browser.

4.3. Localisation

Il est alors possible de localiser physiquement chacun des modules affichés en cliquant sur le bouton beacon, cela a pour effet de mettre la Yocto-Led du module correspondant en mode "balise", elle se met alors à clignoter ce qui permet de la localiser facilement. Cela a aussi pour effet d'afficher une petite pastille bleue à l'écran. Vous obtiendrez le même comportement en appuyant sur le Yocto-bouton d'un module.

4.4. Test du module

La première chose à vérifier est le bon fonctionnement de votre module: cliquez sur le numéro de série correspondant à votre module, et une fenêtre résumant les propriétés de votre Yocto-Altimeter.

Propriétés du module Yocto-Altimeter.

Cette fenêtre vous permet entre autres de jouer avec votre module pour en vérifier son fonctionnement, les valeurs d'altitude, de pression et de température y sont en effet affichées en temps réel.

4.5. Configuration

Si, dans la liste de modules, vous cliquez sur le bouton configure correspondant à votre module, la fenêtre de configuration apparaît.

Configuration du module Yocto-Altimeter.

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. Si pour une raison ou une autre, la mise à jour venait à échouer, débranchez puis rebranchez le module. Recommencer la procédure devrait résoudre alors le problème. Si le module a été débranché alors qu'il était en cours de reprogrammation, il ne fonctionnera probablement plus et ne sera plus listé dans l'interface. Mais il sera toujours possible de le reprogrammer correctement en utilisant le programme Virtual Hub¹⁰ en ligne de commande ¹¹.

Nom logique du module

Le nom logique est un nom choisi par vous, qui vous permettra d'accéder à votre module, de la même manière qu'un nom de fichier vous permet d'accéder à son contenu. Un nom logique doit faire au maximum 19 caractères, les caractères autorisés sont les caractères A..Z a..z 0..9 _ et -. Si vous donnez le même nom logique à deux modules raccordés au même ordinateur, et que vous tentez d'accéder à l'un des modules à l'aide de ce nom logique, le comportement est indéterminé: vous n'avez aucun moyen de savoir lequel des deux va répondre.

Luminosité

Ce paramètre vous permet d'agir sur l'intensité maximale des leds présentes sur le module. Ce qui vous permet, si nécessaire, de le rendre un peu plus discret tout en limitant sa consommation. Notez que ce paramètre agit sur toutes les leds de signalisation du module, y compris la Yocto-Led. Si vous branchez un module et que rien ne s'allume, cela veut peut être dire que sa luminosité a été réglée à zéro.

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é au niveau de la programmation des modules

Le module Yocto-Altimeter dispose de trois fonctions: "altitude", "temperature" et "pressure". Cliquez simplement sur le bouton "rename" correspondant pour leur affecter un nouveau nom logique.

La fenêtre de configuration permet aussi de régler l'altimètre, soit en forçant l'altitude à une valeur connue, ce qui permet au module d'en déduire le QNH; soit en réglant directement QNH. Le QNH est sauvé dans la mémoire flash du module, ce qui signifie que le module s'en rappellera même s'il a été privé de courant.

5. Montage et connectique

Ce chapitre fournit des explications importantes pour utiliser votre module Yocto-Altimeter en situation réelle. Prenez soin de le lire avant d'aller trop loin dans votre projet si vous voulez éviter les mauvaises surprises.

5.1. Fixation

Pendant la mise au point de votre projet vous pouvez vous contenter de laisser le module se promener au bout de son câble. Veillez simplement à ce qu'il ne soit pas en contact avec quoi que soit de conducteur (comme vos outils). Une fois votre projet pratiquement terminé il faudra penser à faire en sorte que vos modules ne puissent pas se promener à l'intérieur.

Exemples de montage sur un support.

Le module Yocto-Altimeter dispose de trous de montage 2.5mm. Vous pouvez utiliser ces trous pour y passer des vis. Le diamètre de la tête de ces vis ne devra pas dépasser 4.5mm, sous peine d'endommager les circuits du module. Veillez à que la surface inférieure du module ne soit pas en contact avec le support. La méthode recommandée consiste à utiliser des entretoises, mais il en existe d'autres. Rien ne vous empêche de le fixer au pistolet à colle; ça ne sera pas très joli mais ça tiendra.

Si vous comptez visser votre module directement contre une paroi conductrice, un chassis métallique par exemple, intercalez une couche isolante entre les deux. Sinon vous aller à coup sûr provoquer un court-circuit: il y a des pads à nu sous votre module. Du simple ruban adhésif isolant devrait faire l'affaire.

5.2. Déporter le capteur

Le module Yocto-Altimeter est conçu pour pouvoir être séparé en deux morceaux afin de vous permettre de déporter le capteur. Vous pouvez les séparer en cassant simplement le circuit, mais vous obtiendrez un meilleur résultat en utilisant une bonne paire de tenailles, ou une grosse pince coupante. Une fois les deux sous-modules séparés vous pouvez poncer sans risque les parties qui dépassent.

Le module Yocto-Altimeter est conçu pour pouvoir être séparé en deux parties.

.. et vous avez deux possibilités en fonction du type de connexion que vous désirer utiliser.

Câblage des sous modules une fois ceux-ci séparés.

Une fois les modules séparés vous allez devoir les re-câbler. Plusieurs solutions s'offrent à vous. Vous pouvez raccorder les sous-modules en soudant des fils électriques tout simples, mais vous obtiendrez un meilleur résultat avec du câble nappe au pas 1.27 mm. Utilisez de préférence du cable avec des conducteurs mono-brin plutôt que du multi-brin: les câbles mono-brin sont un peu moins souples, mais nettement plus facile à souder.

Déport du capteur à l'aide de simple câble nappe.

Vous pouvez aussi utiliser des câbles nappe munis de connecteurs Picoflex, Vous obtiendrez un système un peu plus gros, mais les embases Picoflex sont beaucoup plus faciles à souder que des câbles nappe. De plus le résultat sera démontable.

Déport du capteur à l'aide de connecteurs Picoflex.

Veillez à ne pas placer la partie capteur trop près d'une source de chaleur où dans un courant d'air ce qui pourrait altérer les mesure de manière significative..

Attention, les modules Yoctopuce sécables ont souvent des systèmes de connectique très semblables. Cependant les sous-modules ne sont pas du tout compatibles entre modèles différents. Si vous raccordez un sous module de votre Yocto-Altimeter à un autre type de module, par exemple un Yocto-Temperature, cela ne marchera pas, et vous risquez fort d'endommager votre matériel.

5.3. Contraintes d'alimentation par USB

Bien que USB signifie Universal Serial BUS, les périphériques USB ne sont pas organisés physiquement en bus mais en arbre, avec des connections point-à-point. Cela a des conséquences en termes de distribution électrique: en simplifiant, chaque port USB doit alimenter électriquement tous les périphériques qui lui sont directement ou indirectement connectés. Et USB impose des limites.

En théorie, un port USB fournit 100mA, et peut lui fournir (à sa guise) jusqu'à 500mA si le périphérique les réclame explicitement. Dans le cas d'un hub non-alimenté, il a droit à 100mA pour lui-même et doit permettre à chacun de ses 4 ports d'utiliser 100mA au maximum. C'est tout, et c'est pas beaucoup. Cela veut dire en particulier qu'en théorie, brancher deux hub USB non-alimentés en cascade ne marche pas. Pour cascader des hubs USB, il faut utiliser des hubs USB alimentés, qui offriront 500mA sur chaque port.

En pratique, USB n'aurait pas eu le succès qu'il a si il était si contraignant. Il se trouve que par économie, les fabricants de hubs omettent presque toujours d'implémenter la limitation de courant sur les ports: ils se contentent de connecter l'alimentation de tous les ports directement à l'ordinateur, tout en se déclarant comme hub alimenté même lorsqu'ils ne le sont pas (afin de désactiver tous les contrôles de consommation dans le système d'exploitation). C'est assez malpropre, mais dans la mesure où les ports des ordinateurs sont eux en général protégés par une limitation de courant matérielle vers 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 avant qu'ils ne conduisent à des pannes ou des dégâts matériels. Si les modules sont sous-alimentés, ils pourraient avoir un comportement bizarre et produire des pannes ou des bugs peu reproductibles. Si vous voulez éviter tout risque, ne cascadez pas les hubs non-alimentés, et ne branchez pas de périphérique consommant plus de 100mA derrière un hub non-alimenté.

Pour vous faciliter le contrôle et la planification de la consommation totale de votre projet, tous les modules Yoctopuce sont équipés d'une sonde de courant qui indique (à 5mA près) la consommation du module sur le bus USB.

Notez enfin que le câble USB lui-même peut aussi représenter une cause de problème d'alimentation, en particulier si les fils sont trop fins ou si le câble est trop long ¹². Les bons câbles utilisent en général des fils AWG 26 ou AWG 28 pour les fils de données et des fils AWG 24 pour les fils d'alimentation.

5.4. Compatibilité électromagnétique (EMI)

Les choix de connectique pour intégrer le Yocto-Altimeter ont naturellement une incidence sur les émissions électromagnétiques du système, et donc sur la conformité avec les normes concernées.

Les mesures de référence que nous effectuons pour valider la conformité avec la norme IEC CISPR 11 sont faites sans aucun boîtier, mais en raccordant les modules par un câble USB blindé, conforme à la spécification USB 2.0: le blindage du câble est relié au blindage des deux connecteurs, et la résistance totale entre le blindage des deux connecteurs est inférieure 0.6Ω. Le câble utilisé fait 3m, de sorte à exposer un segment d'un mètre horizontal, un segment d'un mètre vertical et de garder le dernier mètre le plus proche de l'ordinateur hôte à l'intérieur d'un bloc de ferrite.

Si vous utilisez un câble non blindé ou incorrectement blindé, votre système fonctionnera sans problème mais vous risquez de n'être pas conforme à la norme. Dans le cadre de systèmes composés de plusieurs modules raccordés par des câbles au pas 1.27mm, ou de capteurs déportés, vous pourrez en général récupérer la conformité avec la norme d'émission en utilisant un boîtier métallique offrant une enveloppe de blindage externe.

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.

6. Programmation, concepts généraux

L'API Yoctopuce a été pensée pour être à la fois simple à utiliser, et suffisamment générique pour que les concepts utilisés soient valables pour tous les modules de la gamme Yoctopuce et ce dans tous les langages de programmation disponibles. Ainsi, une fois que vous aurez compris comment piloter votre Yocto-Altimeter dans votre langage de programmation favori, il est très probable qu'apprendre à utiliser un autre module, même dans un autre langage, ne vous prendra qu'un minimum de temps.

6.1. Paradigme de programmation

L'API Yoctopuce est une API orientée objet. Mais dans un souci de simplicité, seules les bases de la programmation objet ont été utilisées. Même si la programmation objet ne vous est pas familière, il est peu probable que cela vous soit un obstacle à l'utilisation des produits Yoctopuce. Notez que vous n'aurez jamais à allouer ou désallouer un objet lié à l'API Yoctopuce: cela est géré automatiquement.

Il existe une classe par type de fonctionnalité Yoctopuce. Le nom de ces classes commence toujours par un Y suivi du nom de la fonctionnalité, par exemple YTemperature, YRelay, YPressure, etc.. Il existe aussi une classe YModule, dédiée à la gestion des modules en temps que tels, et enfin il existe la classe statique YAPI, qui supervise le fonctionnement global de l'API et gère les communications à bas niveau.

Structure de l'API Yoctopuce.

La classe YSensor

A chaque fonctionnalité d'un module Yoctopuce, correspond une classe: YTemperature pour mesurer la température, YVoltage pour mesurer une tension, YRelay pour contrôler un relais, etc. Il existe cependant une classe spéciale qui peut faire plus: YSensor.

Cette classe YSensor est la classe parente de tous les senseurs Yoctopuce, elle permet de contrôler n'importe quel senseur, quel que soit son type, en donnant accès au fonctions communes à tous les senseurs. Cette classe permet de simplifier la programmation d'applications qui utilisent beaucoup de senseurs différents. Mieux encore, si vous programmez une application basée sur la classe YSensor elle sera compatible avec tous les senseurs Yoctopuce, y compris ceux qui n'existent pas encore.

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. Cela permet de considérablement simplifier la programmation de projets comprenant un nombre important de modules.

Du point de vue programmation, votre Yocto-Altimeter se présente sous la forme d'un module hébergeant un certain nombre de fonctionnalités. Dans l'API , ces fonctionnalités se présentent sous la forme d'objets qui peuvent être retrouvés de manière indépendante, et ce de plusieurs manières.

Accès aux fonctionnalités d'un module

Accès par nom logique

Chacune des fonctionnalités peut se voir assigner un nom logique arbitraire et persistant: il restera stocké dans la mémoire flash du module, même si ce dernier est débranché. Un objet correspondant à une fonctionnalité Xxx munie d'un nom logique pourra ensuite être retrouvée directement à l'aide de ce nom logique et de la méthode YXxx.FindXxx. Notez cependant qu'un nom logique doit être unique parmi tous les modules connectés.

Accès par énumération

Vous pouvez énumérer toutes les fonctionnalités d'un même type sur l'ensemble des modules connectés à l'aide des fonctions classiques d'énumération FirstXxx et nextXxxx disponibles dans chacune des classes YXxx.

Accès par nom hardware

Chaque fonctionnalité d'un module dispose d'un nom hardware, assigné en usine qui ne peut être modifié. Les fonctionnalités d'un module peuvent aussi être retrouvées directement à l'aide de ce nom hardware et de la fonction YXxx.FindXxx de la classe correspondante.

Différence entre Find et First

Les méthodes YXxx.FindXxxx et YXxx.FirstXxxx ne fonctionnent pas exactement de la même manière. Si aucun module n'est disponible YXxx.FirstXxxx renvoie une valeur nulle. En revanche, même si aucun module ne correspond, YXxx.FindXxxx renverra objet valide, qui ne sera pas "online" mais qui pourra le devenir, si le module correspondant est connecté plus tard.

Manipulation des fonctionnalités

Une fois l'objet correspondant à une fonctionnalité retrouvé, ses méthodes sont disponibles de manière tout à fait classique. Notez que la plupart de ces sous-fonctions nécessitent que le module hébergeant la fonctionnalité soit branché pour pouvoir être manipulées. Ce qui n'est en général jamais garanti, puisqu'un module USB peut être débranché après le démarrage du programme de contrôle. La méthode isOnline(), disponible dans chaque classe, vous sera alors d'un grand secours.

Accès aux modules

Bien qu'il soit parfaitement possible de construire un projet en faisant abstraction de la répartition des fonctionnalités sur les différents modules, ces derniers peuvent être facilement retrouvés à l'aide de l'API. En fait, ils se manipulent d'une manière assez semblable aux fonctionnalités. Ils disposent d'un numéro de série affecté en usine qui permet de retrouver l'objet correspondant à l'aide de YModule.Find(). Les modules peuvent aussi se voir affecter un nom logique arbitraire qui permettra de les retrouver ensuite plus facilement. Et enfin la classe YModule comprend les méthodes d'énumération YModule.FirstModule() et nextModule() qui permettent de dresser la liste des modules connectés.

Interaction Function / Module

Du point de vue de l'API, les modules et leurs fonctionnalités sont donc fortement décorrélés à dessein. Mais l'API offre néanmoins la possibilité de passer de l'un à l'autre. Ainsi la méthode get_module(), disponible dans chaque classe de fonctionnalité, permet de retrouver l'objet correspondant au module hébergeant cette fonctionnalité. Inversement, la classe YModule dispose d'un certain nombre de méthodes permettant d'énumérer les fonctionnalités disponibles sur un module.

6.2. Le module Yocto-Altimeter

Le module Yocto-Altimeter offre une instance de la fonction Altitude correspondant à une estimation de l'altitude, avec une sensibilité d'environ 0.25m. Il indique aussi la pression atmosphérique et la température mesurée.

module : Module

attribut	type	modifiable ?
`productName`	Texte	lecture seule
`serialNumber`	Texte	lecture seule
`logicalName`	Texte	modifiable
`productId`	Entier (hexadécimal)	lecture seule
`productRelease`	Entier (hexadécimal)	lecture seule
`firmwareRelease`	Texte	lecture seule
`persistentSettings`	Type énuméré	modifiable
`luminosity`	0..100%	modifiable
`beacon`	On/Off	modifiable
`upTime`	Temps	lecture seule
`usbCurrent`	Courant consommé (en mA)	lecture seule
`rebootCountdown`	Nombre entier	modifiable
`userVar`	Nombre entier	modifiable

altitude : Altitude

attribut	type	modifiable ?
`logicalName`	Texte	modifiable
`advertisedValue`	Texte	modifiable
`unit`	Texte	lecture seule
`currentValue`	Nombre (virgule fixe)	modifiable
`lowestValue`	Nombre (virgule fixe)	modifiable
`highestValue`	Nombre (virgule fixe)	modifiable
`currentRawValue`	Nombre (virgule fixe)	lecture seule
`logFrequency`	Fréquence	modifiable
`reportFrequency`	Fréquence	modifiable
`advMode`	Type énuméré	modifiable
`calibrationParam`	Paramètrs de calibration	modifiable
`resolution`	Nombre (virgule fixe)	modifiable
`sensorState`	Nombre entier	lecture seule
`qnh`	Nombre (virgule fixe)	modifiable
`technology`	Texte	lecture seule

temperature : Temperature

attribut	type	modifiable ?
`logicalName`	Texte	modifiable
`advertisedValue`	Texte	modifiable
`unit`	Texte	modifiable
`currentValue`	Nombre (virgule fixe)	lecture seule
`lowestValue`	Nombre (virgule fixe)	modifiable
`highestValue`	Nombre (virgule fixe)	modifiable
`currentRawValue`	Nombre (virgule fixe)	lecture seule
`logFrequency`	Fréquence	modifiable
`reportFrequency`	Fréquence	modifiable
`advMode`	Type énuméré	modifiable
`calibrationParam`	Paramètrs de calibration	modifiable
`resolution`	Nombre (virgule fixe)	modifiable
`sensorState`	Nombre entier	lecture seule
`sensorType`	Type énuméré	modifiable
`signalValue`	Nombre (virgule fixe)	lecture seule
`signalUnit`	Texte	lecture seule
`command`	Texte	modifiable

pressure : Pressure

attribut	type	modifiable ?
`logicalName`	Texte	modifiable
`advertisedValue`	Texte	modifiable
`unit`	Texte	lecture seule
`currentValue`	Nombre (virgule fixe)	lecture seule
`lowestValue`	Nombre (virgule fixe)	modifiable
`highestValue`	Nombre (virgule fixe)	modifiable
`currentRawValue`	Nombre (virgule fixe)	lecture seule
`logFrequency`	Fréquence	modifiable
`reportFrequency`	Fréquence	modifiable
`advMode`	Type énuméré	modifiable
`calibrationParam`	Paramètrs de calibration	modifiable
`resolution`	Nombre (virgule fixe)	modifiable
`sensorState`	Nombre entier	lecture seule

dataLogger : DataLogger

attribut	type	modifiable ?
`logicalName`	Texte	modifiable
`advertisedValue`	Texte	modifiable
`currentRunIndex`	Nombre entier	lecture seule
`timeUTC`	Heure UTC	modifiable
`recording`	Type énuméré	modifiable
`autoStart`	On/Off	modifiable
`beaconDriven`	On/Off	modifiable
`clearHistory`	Booléen	modifiable

6.3. Interface de contrôle du module

Cette interface est la même pour tous les modules USB de Yoctopuce. Elle permet de contrôler les paramètres généraux du module, et d'énumérer les fonctions fournies par chaque module.

productName

Chaîne de caractères contenant le nom commercial du module, préprogrammé en usine.

serialNumber

Chaine de caractères contenant le numéro de série, unique et préprogrammé en usine. Pour un module Yocto-Altimeter, ce numéro de série commence toujours par YALTIMK1. Il peut servir comme point de départ pour accéder par programmation à un module particulier.

logicalName

Chaine de caractères contenant le nom logique du module, initialement vide. Cet attribut peut être changé au bon vouloir de l'utilisateur. Une fois initialisé à une valeur non vide, il peut servir de point de départ pour accéder à un module particulier. Si deux modules avec le même nom logique se trouvent sur le même montage, il n'y a pas moyen de déterminer lequel va répondre si l'on tente un accès par ce nom logique. Le nom logique du module est limité à 19 caractères parmi A..Z,a..z,0..9,_ et -.

productId

Identifiant USB du module, préprogrammé à la valeur 63 en usine.

productRelease

Numéro de révision du module hardware, préprogrammé en usine.

firmwareRelease

Version du logiciel embarqué du module, elle change à chaque fois que le logiciel embarqué est mis à jour.

persistentSettings

Etat des réglages persistants du module: chargés depuis la mémoire non-volatile, modifiés par l'utilisateur ou sauvegardés dans la mémoire non volatile.

luminosity

Intensité lumineuse maximale des leds informatives (comme la Yocto-Led) présentes sur le module. C'est une valeur entière variant entre 0 (leds éteintes) et 100 (leds à l'intensité maximum). La valeur par défaut est 50. Pour changer l'intensité maximale des leds de signalisation du module, ou les éteindre complètement, il suffit donc de modifier cette valeur.

beacon

Etat de la balise de localisation du module.

upTime

Temps écoulé depuis la dernière mise sous tension du module.

usbCurrent

Courant consommé par le module sur le bus USB, en milli-ampères.

rebootCountdown

Compte à rebours pour déclencher un redémarrage spontané du module.

userVar

Attribut de type entier 32 bits à disposition de l'utilisateur.

6.4. Interface de la fonction Altitude

La classe YAltitude permet de lire et de configurer les capteurs d'altitude Yoctopuce. Elle hérite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de données. De plus, pour les capteurs barométriques, elle permet de faire la configuration de la pression de référence au niveau de la mer (QNH).

logicalName

Chaîne de caractères contenant le nom logique de l'altimètre, initialement vide. Cet attribut peut être changé au bon vouloir de l'utilisateur. Un fois initialisé à une valeur non vide, il peut servir de point de départ pour accéder à directement à l'altimètre. Si deux altimètres portent le même nom logique dans un projet, il n'y a pas moyen de déterminer lequel va répondre si l'on tente un accès par ce nom logique. Le nom logique du module est limité à 19 caractères parmi A..Z,a..z,0..9,_ et -.

advertisedValue

Courte chaîne de caractères résumant l'état actuel de l'altimètre, et qui sera publiée automatiquement jusqu'au hub parent. Pour un altimetre, la valeur publiée est la valeur courante de l'altitude.

unit

Courte chaîne de catactères représentant l'unité dans laquelle l'altitude est exprimée.

currentValue

Valeur actuelle de l'altitude, en mètres, sous forme de nombre à virgule.

lowestValue

Valeur minimale de l'altitude, en mètres, sous forme de nombre à virgule.

highestValue

Valeur maximale de l'altitude, en mètres, sous forme de nombre à virgule.

currentRawValue

Valeur brute mesurée par le capteur (sans arrondi ni calibration), sous forme de nombre à virgule.

logFrequency

Fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne doivent pas être stockées dans la mémoire de l'enregistreur de données.

reportFrequency

Fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques de valeurs sont désactivées.

advMode

Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue).

calibrationParam

Paramètres de calibration supplémentaires (par exemple pour compenser l'effet d'un boîtier), sous forme de tableau d'entiers 16 bit.

resolution

Résolution de la mesure (précision de la représentation, mais pas forcément de la mesure elle-même).

sensorState

Etat du capteur (zero lorsque qu'une mesure actuelle est disponible).

qnh

Pression altmosphérique actuelle au niveau de la mer.

technology

Technologie utilisée

6.5. Interface de la fonction Pressure

La classe YPressure permet de lire et de configurer les capteurs de pression Yoctopuce. Elle hérite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de données.

logicalName

Chaîne de caractères contenant le nom logique du capteur de pression, initialement vide. Cet attribut peut être changé au bon vouloir de l'utilisateur. Un fois initialisé à une valeur non vide, il peut servir de point de départ pour accéder à directement au capteur de pression. Si deux capteurs de pression portent le même nom logique dans un projet, il n'y a pas moyen de déterminer lequel va répondre si l'on tente un accès par ce nom logique. Le nom logique du module est limité à 19 caractères parmi A..Z,a..z,0..9,_ et -.

advertisedValue

Courte chaîne de caractères résumant l'état actuel du capteur de pression, et qui sera publiée automatiquement jusqu'au hub parent. Pour un capteur de pression, la valeur publiée est la valeur courante de la pression.

unit

Courte chaîne de catactères représentant l'unité dans laquelle la pression est exprimée.

currentValue

Valeur actuelle de la pression, en millibar (hPa), sous forme de nombre à virgule.

lowestValue

Valeur minimale de la pression, en millibar (hPa), sous forme de nombre à virgule.

highestValue

Valeur maximale de la pression, en millibar (hPa), sous forme de nombre à virgule.

currentRawValue

Valeur brute mesurée par le capteur (sans arrondi ni calibration), sous forme de nombre à virgule.

logFrequency

Fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne doivent pas être stockées dans la mémoire de l'enregistreur de données.

reportFrequency

Fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques de valeurs sont désactivées.

advMode

Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue).

calibrationParam

Paramètres de calibration supplémentaires (par exemple pour compenser l'effet d'un boîtier), sous forme de tableau d'entiers 16 bit.

resolution

Résolution de la mesure (précision de la représentation, mais pas forcément de la mesure elle-même).

sensorState

Etat du capteur (zero lorsque qu'une mesure actuelle est disponible).

6.6. Interface de la fonction Temperature

La classe YTemperature permet de lire et de configurer les capteurs de température Yoctopuce. Elle hérite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de données. De plus, elle permet de configurer les paramètres spécifiques de certains types de capteur (type de connection, table d'étalonnage).

logicalName

Chaîne de caractères contenant le nom logique du capteur de température, initialement vide. Cet attribut peut être changé au bon vouloir de l'utilisateur. Un fois initialisé à une valeur non vide, il peut servir de point de départ pour accéder à directement au capteur de température. Si deux capteurs de température portent le même nom logique dans un projet, il n'y a pas moyen de déterminer lequel va répondre si l'on tente un accès par ce nom logique. Le nom logique du module est limité à 19 caractères parmi A..Z,a..z,0..9,_ et -.

advertisedValue

Courte chaîne de caractères résumant l'état actuel du capteur de température, et qui sera publiée automatiquement jusqu'au hub parent. Pour un capteur de température, la valeur publiée est la valeur courante de la température.

unit

Courte chaîne de catactères représentant l'unité dans laquelle la température est exprimée.

currentValue

Valeur actuelle de la température, en degrés Celsius, sous forme de nombre à virgule.

lowestValue

Valeur minimale de la température, en degrés Celsius, sous forme de nombre à virgule.

highestValue

Valeur maximale de la température, en degrés Celsius, sous forme de nombre à virgule.

currentRawValue

Valeur brute mesurée par le capteur (sans arrondi ni calibration), sous forme de nombre à virgule.

logFrequency

Fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne doivent pas être stockées dans la mémoire de l'enregistreur de données.

reportFrequency

Fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques de valeurs sont désactivées.

advMode

Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue).

calibrationParam

Paramètres de calibration supplémentaires (par exemple pour compenser l'effet d'un boîtier), sous forme de tableau d'entiers 16 bit.

resolution

Résolution de la mesure (précision de la représentation, mais pas forcément de la mesure elle-même).

sensorState

Etat du capteur (zero lorsque qu'une mesure actuelle est disponible).

sensorType

Type de senseur utilisé pour réaliser la mesure de température. Le senseur peut être digital, un type de thermocouple, un type de PT100 ou encore un thermistor.

signalValue

Valeur actuelle du signal électrique mesuré par le capteur (sauf pour les senseurs digitaux) sous forme de nombre à virgule.

signalUnit

Courte chaîne de catactères représentant l'unité du signal électrique utilisé par le capteur.

command

Attribut magique permettant de configurer les paramètres physiques du capteur de température.

6.7. Interface de la fonction DataLogger

Les capteurs de Yoctopuce sont équipés d'une mémoire non-volatile permettant de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un ordinateur. La fonction DataLogger contrôle les paramètres globaux de cet enregistreur de données.

logicalName

Chaîne de caractères contenant le nom logique de l'enregistreur de données, initialement vide. Cet attribut peut être changé au bon vouloir de l'utilisateur. Un fois initialisé à une valeur non vide, il peut servir de point de départ pour accéder à directement à l'enregistreur de données. Si deux enregistreurs de données portent le même nom logique dans un projet, il n'y a pas moyen de déterminer lequel va répondre si l'on tente un accès par ce nom logique. Le nom logique du module est limité à 19 caractères parmi A..Z,a..z,0..9,_ et -.

advertisedValue

Courte chaîne de caractères résumant l'état actuel de l'enregistreur de données, et qui sera publiée automatiquement jusqu'au hub parent. Pour un enregistreur de données, la valeur publiée est son état d'activation (ON ou OFF).

currentRunIndex

Numéro du Run actuel, correspondant au nombre de fois que le module a été mis sous tension avec la fonction d'enregistreur de données active.

timeUTC

Heure UTC courante, lorsque l'on désire associer une référence temporelle absolue aux données enregistrées. Cette heure doit être configurée explicitement par logiciel.

recording

Etat d'activité de l'enregistreur de données. L'enregistreur peut être enclanché ou déclanché à volonté par cet attribut, mais son état à la mise sous tension est déterminé par l'attribut persistent autoStart. Lorsque l'enregistreur est enclenché mais qu'il n'est pas encore prêt pour enregistrer, son état est PENDING.

autoStart

Enclenchement automatique de l'enregistreur de données à la mise sous tension. Cet attribut permet d'activer systématiquement l'enregistreur à la mise sous tension, sans devoir l'activer par une commande logicielle.

beaconDriven

Permet de synchroniser l’état de la balise de localisation avec l’état de l'enregistreur de données. Quand cet attribut est activé il est possible de démarrer et arrêter l'enregistrement en utilisant le Yocto-bouton du module ou l’attribut beacon de la fonction YModule. De la même manière si l'attribut recording de la fonction datalogger est modifié, l’état de la balise de localisation est mis à jour. Note: quand cet attribut est activé balise de localisation du module clignote deux fois plus lentement.

clearHistory

Attribut qui peut être mis à vrai pour effacer l'historique des mesures.

6.8. Quelle interface: Native, DLL ou Service?

Il y existe plusieurs méthodes pour contrôler un module USB Yoctopuce depuis un programme.

Contrôle natif

Dans ce cas de figure le programme pilotant votre projet est directement compilé avec une librairie qui offre le contrôle des modules. C'est objectivement la solution la plus simple et la plus élégante pour l'utilisateur final. Il lui suffira de brancher le câble USB et de lancer votre programme pour que tout fonctionne. Malheureusement, cette technique n'est pas toujours disponible ou même possible.

L'application utilise la librairie native pour contrôler le module connecté en local

Contrôle natif par DLL

Ici l'essentiel du code permettant de contrôler les modules se trouve dans une DLL, et le programme est compilé avec une petite librairie permettant de contrôler cette DLL. C'est la manière la plus rapide pour coder le support des modules dans un language particulier. En effet la partie "utile" du code de contrôle se trouve dans la DLL qui est la même pour tous les langages, offrir le support pour un nouveau langage se limite à coder la petite librairie qui contrôle la DLL. Du point de de l'utilisateur final, il y a peu de différence: il faut simplement être sur que la DLL sera installée sur son ordinateur en même temps que le programme principal.

L'application utilise la DLL pour contrôler nativement le module connecté en local

Contrôle par un service

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'à utiliser une librairie qui offrira toutes les fonctions nécessaires au contrôle des modules en passant par l'intermédiaire de ce VirtualHub. L'utilisateur final se verra obligé de lancer le VirtualHub avant de lancer le programme de contrôle du projet proprement dit, à moins qu'il ne décide d'installer le VirtualHub sous la forme d'un service/démon, auquel cas le VirtualHub se lancera automatiquement au démarrage de la machine..

L'application se connecte au service VirtualHub pour connecter le module.

En revanche la méthode de contrôle par un service offre un avantage non négligeable: l'application n'est pas n'obligé de tourner sur la machine où se trouvent les modules: elle peut parfaitement se trouver sur un autre machine qui se connectera au service pour piloter les module. De plus les librairie natives et DLL évoquées plus haut sont aussi capables de se connecter à distance à un ou plusieurs VirtualHub.

Lorsqu'on utilise un VirtualHub, l'application de contrôle n'a plus besoin d'être sur la même machine que le module.

Quel que soit langage de programmation choisi et le paradigme de contrôle utilisé; la programmation reste strictement identique. D'un langage à l'autre les fonctions ont exactement le même nom, prennent les mêmes paramètres. Les seules différences sont liées aux contraintes des langages eux-mêmes.

Language	Natif	Natif avec .DLL/.so	Hub virtuel
C++	✔	✔	✔
Objective-C	✔	-	✔
Delphi	-	✔	✔
Python	-	✔	✔
VisualBasic .Net	-	✔	✔
C# .Net	-	✔	✔
C# UWP	✔	-	✔
EcmaScript / JavaScript	-	-	✔
PHP	-	-	✔
Java	-	✔	✔
Java pour Android	✔	-	✔
Ligne de commande	✔	-	✔

Méthode de support pour les différents langages.

Limitation des librairies Yoctopuce

Les librairies Natives et DLL ont une limitation technique. Sur une même machine, vous ne pouvez pas faire tourner en même temps plusieurs applications qui accèdent nativement aux modules Yoctopuce. Si vous désirez contrôler plusieurs projets depuis la même machine, codez vos applications pour qu'elle accèdent aux modules via un VirtualHub plutôt que nativement. Le changement de mode de fonctionnement est trivial: il suffit de changer un paramètre dans l'appel à yRegisterHub().

6.9. Programmation, par où commencer?

Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto-Altimeter. 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¹³. Puis sautez directement au chapitre correspondant au langage de programmation que vous avez choisi.

Tous les exemples décrits dans ce manuel sont présents dans les librairies de programmation. Dans certains langages, les librairies comprennent aussi quelques applications graphiques complètes avec leur code source.

Une fois que vous maîtriserez la programmation de base de votre module, vous pourrez vous intéresser au chapitre concernant la programmation avancée qui décrit certaines techniques qui vous permettront d'exploiter au mieux votre Yocto-Altimeter.

7. Utilisation du Yocto-Altimeter en ligne de commande

Lorsque vous désirez effectuer une opération ponctuelle sur votre Yocto-Altimeter, 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.

L'API en ligne de commande se présente sous la forme d'un ensemble d'exécutables, un par type de fonctionnalité offerte par l'ensemble des produits Yoctopuce. Ces exécutables sont fournis pré-compilés pour toutes les plateformes/OS officiellement supportés par Yoctopuce. Bien entendu, les sources de ces exécutables sont aussi fournies¹⁴.

7.1. Installation

Téléchargez l'API en ligne de commande¹⁵. Il n'y a pas de programme d'installation à lancer, copiez simplement les exécutables correspondant à votre plateforme/OS dans le répertoire de votre choix. Ajoutez éventuellement ce répertoire à votre variable environnement PATH pour avoir accès aux exécutables depuis n'importe où. C'est tout, il ne vous reste plus qu'à brancher votre Yocto-Altimeter, ouvrir un shell et commencer à travailler en tapant par exemple:

C:\>YAltitude any get_currentValue

Sous Linux, pour utiliser l'API en ligne de commande, vous devez soit être root, soit définir une règle udev pour votre système. Vous trouverez plus de détails au chapitre Problèmes courants.

7.2. Utilisation: description générale

Tous les exécutables de l'API en ligne de commande fonctionnent sur le même principe: ils doivent être appelés de la manière suivante:

C:\>Executable [options] [cible] commande [paramètres]

Les [options] gèrent le fonctionnement global des commandes , elles permettent par exemple de piloter des modules à distance à travers le réseau, ou encore elles peuvent forcer les modules à sauver leur configuration après l'exécution de la commande.

La [cible] est le nom du module ou de la fonction auquel la commande va s'appliquer. Certaines commandes très génériques n'ont pas besoin de cible. Vous pouvez aussi utiliser les alias "any" ou "all", ou encore une liste de noms, séparés par des virgules, sans espace.

La commande est la commande que l'on souhaite exécuter. La quasi-totalité des fonctions disponibles dans les API de programmation classiques sont disponibles sous forme de commandes. Vous n'êtes pas obligé des respecter les minuscules/majuscules et les caractères soulignés dans le nom de la commande.

Les [paramètres] sont, assez logiquement, les paramètres dont la commande a besoin.

A tout moment les exécutables de l'API en ligne de commande sont capables de fournir une aide assez détaillée: Utilisez par exemple

C:\>executable /help

pour connaître la liste de commandes disponibles pour un exécutable particulier de l'API en ligne de commande, ou encore:

C:\>executable commande /help

Pour obtenir une description détaillée des paramètres d'une commande.

7.3. Contrôle de la fonction Altitude

Pour contrôler la fonction Altitude de votre Yocto-Altimeter, vous avez besoin de l'exécutable YAltitude.

Vous pouvez par exemple lancer:

C:\>YAltitude any get_currentValue

Cet exemple utilise la cible "any" pour signifier que l'on désire travailler sur la première fonction Altitude trouvée parmi toutes celles disponibles sur les modules Yoctopuce accessibles au moment de l'exécution. Cela vous évite d'avoir à connaître le nom exact de votre fonction et celui de votre module.

Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Altimeter avec le numéros de série YALTIMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction altitude "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute ambiguïté).

C:\>YAltitude YALTIMK1-123456.altitude describe

C:\>YAltitude YALTIMK1-123456.MaFonction describe

C:\>YAltitude MonModule.altitude describe

C:\>YAltitude MonModule.MaFonction describe

C:\>YAltitude MaFonction describe

Pour travailler sur toutes les fonctions Altitude à la fois, utilisez la cible "all".

C:\>YAltitude all describe

Pour plus de détails sur les possibilités de l'exécutableYAltitude, utilisez:

C:\>YAltitude /help

7.4. Contrôle de la partie module

Chaque module peut être contrôlé d'une manière similaire à l'aide de l'exécutable YModule. Par exemple, pour obtenir la liste de tous les modules connectés, utilisez:

C:\>YModule inventory

Vous pouvez aussi utiliser la commande suivante pour obtenir une liste encore plus détaillée des modules connectés:

C:\>YModule all describe

Chaque propriété xxx du module peut être obtenue grâce à une commande du type get_xxxx(), et les propriétés qui ne sont pas en lecture seule peuvent être modifiées à l'aide de la commande set_xxx(). Par exemple:

C:\>YModule YALTIMK1-12346 set_logicalName MonPremierModule

C:\>YModule YALTIMK1-12346 get_logicalName

Modifications des réglages du module

Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'utiliser la commande set_xxx correspondante, cependant cette modification n'a lieu que dans la mémoire vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration courante dans sa mémoire non volatile. Pour cela il faut utiliser la commande saveToFlash. Inversement il est possible de forcer le module à oublier ses réglages courants en utilisant la méthode revertFromFlash. Par exemple:

C:\>YModule YALTIMK1-12346 set_logicalName MonPremierModule
C:\>YModule YALTIMK1-12346 saveToFlash

Notez que vous pouvez faire la même chose en seule fois à l'aide de l'option -s

C:\>YModule -s YALTIMK1-12346 set_logicalName MonPremierModule

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la commande saveToFlash que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette commande depuis l'intérieur d'une boucle.

7.5. Limitations

L'API en ligne de commande est sujette à la même limitation que les autres API: il ne peut y avoir q'une seule application à la fois qui accède aux modules de manière native. Par défaut l'API en ligne de commande fonctionne en natif.

Cette limitation peut aisément être contournée en utilisant un Virtual Hub: il suffit de faire tourner le VirtualHub¹⁶ sur la machine concernée et d'utiliser les executables de l'API en ligne de commande avec l'option -r par exemple, si vous utilisez:

C:\>YModule inventory

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

cela marchera parce que la commande ne sera plus exécutée nativement, mais à travers le Virtual Hub. Notez que le Virtual Hub compte comme une application native.

8. Utilisation du Yocto-Altimeter en JavaScript / EcmaScript

EcmaScript est le nom officiel de la version standardisée du langage de programmation communément appelé JavaScript. Cette librairie de programmation Yoctopuce utilise les nouvelles fonctionnalités introduites dans la version EcmaScript 2017. La librairie porte ainsi le nom Librairie pour 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. La librairie détecte automatiquement à l'initialisation si le contexte d'utilisation est un browser ou une machine virtuelle Node.js, et utilise les librairies systèmes les plus appropriées en conséquence.

Les communications asynchrones avec les modules sont gérées dans toute la librairie à l'aide d'objets Promise, en utilisant la nouvelle syntaxe EcmaScript 2017 async / await non bloquante pour la gestion des entrées/sorties asynchrones (voir ci-dessous). Cette syntaxe est désormais disponible sans autres dans la plupart des moteurs JavaScript: il n'est plus nécessaire de transpiler le code avec Babel ou jspm. Voici la version minimum requise de vos moteurs JavaScript préférés, tous disponibles au téléchargement:

Node.js v7.6 and later
Firefox 52
Opera 42 (incl. Android version)
Chrome 55 (incl. Android version)
Safari 10.1 (incl. iOS version)
Android WebView 55
Google V8 Javascript engine v5.5

Si vous avez besoin de la compatibilité avec des anciennes versions, vous pouvez toujours utiliser Babel pour transpiler votre code et la libriairie vers un standard antérieur de JavaScript, comme décrit un peu plus bas.

Nous ne recommendons plus l'utilisation de jspm 0.17 puisque cet outil est toujours en version Beta après 18 mois, et que solliciter l'utilisation d'un outil supplémentaire pour utiliser notre librairie ne se justifie plus dès lors que async / await sont standardisés.

8.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 bloqué. Dans un navigateur, cela peut se traduire par un blocage complet de l'interface utilisateur. C'est pourquoi l'utilisation de fonctions d'entrée/sortie bloquantes en JavaScript est sévèrement découragée de nos jours, et les API bloquantes se font toutes déclarer deprecated.

Plutôt que d'utiliser des threads parallèles, JavaScript utilise les opérations asynchrones pour gérer les attentes dans les entrées/sorties: lorsqu'une fonction potentiellement bloquante doit être appelée, l'opération est uniquement déclenchée mais le flot d'exécution est immédiatement terminé. La moteur JavaScript est alors libre pour exécuter d'autres tâches, comme la gestion de l'interface utilisateur par exemple. Lorsque l'opération bloquante se termine finalement, le système relance le code en appelant une fonction de callback, en passant en paramètre le résultat de l'opération, pour permettre de continuer la tâche originale.

Lorsqu'on les utilises avec des simples fonctions de callback, comme c'est fait quasi systématiquement dans les librairies Node.js, les opérations asynchrones ont la fâcheuse tendance de rentre le code illisible puisqu'elles découpent systématiquement le flot du code en petites fonctions de callback déconnectées les unes des autres. Heureusement, de nouvelles idées sont apparues récemment pour améliorer la situation. En particulier, l'utilisation d'objets Promise pour travailler avec les opérations asynchrones aide beaucoup. N'importe quelle fonction qui effectue une opération potentiellement longue peut retourner une promesse de se terminer, et cet objet Promise peut être utilisé par l'appelant pour chaîner d'autres opérations en un flot d'exécution. La classe Promise fait partie du standard EcmaScript 2015.

Les objets Promise sont utiles, mais ce qui les rend vraiment pratique est la nouvelle syntaxe async / await pour la gestion des appels asynchrones:

une fonction déclarée async encapsule automatiquement son résultat dans une promesse
dans une fonction async, tout appel préfixé par await a pour effet de chaîner automatiquement la promesses retournées par la fonction appelée à une promesse de continue l'exécution de l'appelant
tout exception durant l'exécution d'une fonction async déclenche le flot de traitrment d'erreur de la promesse.

En clair, async et await permettent d'écrire du code EcmaScript avec tous les avantages des entrées/sorties asynchrones, mais sans interrompre le flot d'écriture du code. Cela revient quasiment à une exécution multi-tâche, mais en garantissant que le passage de contrôle d'une tâche à l'autre ne se produira que là où le mot-clé await apparaît.

Nous avons donc décidé d'écrire cette nouvelle librairie EcmaScript en utilisant les objets Promise et des fonctions async, pour vous permettre d'utiliser la notation await si pratique. Et pour ne pas devoir vous poser la question pour chaque méthode de savoir si elle est asynchrone ou pas, la convention est la suivante: toutes les méthodes publiques de la librairie EcmaScript sont async, c'est-à-dire qu'elles retournent un objet Promise, sauf:

GetTickCount(), parce que mesurer le temps de manière asynchrone n'a pas beaucoup de sens...
FindModule(), FirstModule(), nextModule(), ... parce que la détection et l'énumération des modules est faite en tâche de fond sur des structures internes qui sont gérées de manière transparente, et qu'il n'est donc pas nécessaire de faire des opérations bloquantes durant le simple parcours de ces listes de modules.

8.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017

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.

Connectez vous sur le site de Yoctopuce et téléchargez les éléments suivants:

La librairie de programmation pour Javascript / EcmaScript 2017¹⁷
Le programme VirtualHub¹⁸ pour Windows, Mac OS X ou Linux selon l'OS que vous utilisez

Décompressez les fichiers de la librairie dans un répertoire de votre choix, branchez vos modules et lancez le programme VirtualHub. Vous n'avez pas besoin d'installer de driver.

Utiliser la librairie Yoctopuce officielle pour node.js

Commencez par installer sur votre machine de développement la version actuelle de Node.js (7.6 ou plus récente), C'est très simple. Vous pouvez l'obtenir sur le site officiel: http://nodejs.org. Assurez vous de l'installer entièrement, y compris npm, et de l'ajouter à votre system path.

Vous pouvez ensuite prendre l'exemple de votre choix dans le répertoire example_nodejs (par exemple example_nodejs/Doc-Inventory). Allez dans ce répertoire. Vous y trouverez un fichier décrivant l'application (package.json) et le code source de l'application (demo.js). Pour charger automatiquement et configurer les librairies nécessaires à l'exemple, tapez simplement:

npm install

Une fois que c'est fait, vous pouvez directement lancer le code de l'application:

node demo.js

Utiliser une copie locale de la librairie Yoctopuce avec node.js

Si pour une raison ou une autre vous devez faire des modifications au code de la librairie, vous pouvez facilement configurer votre projet pour utiliser le code source de la librairie qui se trouve dans le répertoire lib/ plutôt que le package npm officiel. Pour cela, lancez simplement la commande suivante dans le répertoire de votre projet:

npm link ../../lib

Utiliser la librairie Yoctopuce dans un navigateur (HTML)

Pour les exemples HTML, c'est encore plus simple: il n'y a rien à installer. Chaque exemple est un simple fichier HTML que vous pouvez ouvrir directement avec un navigateur pour l'essayer. L'inclusion de la librairie Yoctopuce ne demande rien de plus qu'un simple tag HTML <script>.

Utiliser la librairie Yoctopuce avec des anciennes version de JavaScript

Si vous avez besoin d'utiliser cette librairie avec des moteurs JavaScript plus anciens, vous pouvez utiliser Babel¹⁹ pour transpiler votre code et la librairie dans une version antérieure du langage. Pour installer Babel avec les réglages usuels, tapez:

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é comopat par exemple. Pour ce faire, utilisez par exemple les commandes suivantes:

babel --presets env demo.js --out-dir compat/
babel --presets env ../../lib --out-dir compat/

Bien que ces outils de transpilation soient basés sur node.js, ils fonctionnent en réalité pour traduire n'importe quel type de fichier JavaScript, y compris du code destiné à fonctionner dans un navigateur. La seule chose qui ne peut pas être faite aussi facilement est la transpilation de sciptes codés en dure à l'intérieur même d'une page HTML. Il vous faudra donc sortir ce code dans un fichier .js externe si il utiliser la syntaxe EcmaScript 2017, afin de le transpiler séparément avec Babel.

Babel dipose de nombreuses fonctionnalités intéressantes, comme un mode de surveillance qui traduite automatiquement au vol vos fichiers dès qu'il détecte qu'un fichier source a changé. Consultez les détails dans la documentation de Babel.

Compatibilité avec l'ancienne librairie JavaScript

Cette nouvelle librairie n'est pas compatible avec l'ancienne librairie JavaScript, car il n'existe pas de possibilité d'implémenter l'ancienne API bloquante sur la base d'une API asynchrone. Toutefois, les noms des méthodes sont les mêmes, et l'ancien code source synchrone peut facilement être rendu asynchrone simplement en ajoutant le mot-clé await devant les appels de méthode. Remplacez par exemple:

beaconState = module.get_beacon();

par

beaconState = await module.get_beacon();

Mis à part quelques exceptions, la plupart des méthodes redondantes XXX_async ont été supprimées, car elles auraient introduit de la confusion sur la manière correcte de gérer les appels asynchrones. Si toutefois vous avez besoin d'appeler un callback explicitement, il est très facile de faire appeler une fonction de callback à la résolution d'une méthode async, en utilisant l'objet Promise retourné. Par exemple, vous pouvez réécrire:

module.get_beacon_async(callback, myContext);

par

module.get_beacon().then(function(res) { callback(myContext, module, res); });

Si vous portez une application vers la nouvelle librairie, vous pourriez être amené à désirer des méthodes synchrones similaires à l'ancienne librairie (sans objet Promise), quitte à ce qu'elles retournent la dernière valeur reçue du capteur telle que stockée en cache, puisqu'il n'est pas possible de faire des communications bloquantes. Pour cela, la nouvelle librairie introduit un nouveau type de classes appelés proxys synchrones. Un proxy synchrone est un objet qui reflète la dernière value connue d'un objet d'interface, mais peut être accédé à l'aide de fonctions synchrones habituelles. Par exemple, plutôt que d'utiliser:

async function logInfo(module)
{
console.log('Name: '+await module.get_logicalName());
console.log('Beacon: '+await module.get_beacon());
}

...
logInfo(myModule);
...

on peut utiliser:

function logInfoProxy(moduleSyncProxy)
{
console.log('Name: '+moduleProxy.get_logicalName());
console.log('Beacon: '+moduleProxy.get_beacon());
}

logInfoSync(await myModule.get_syncProxy());

Ce dernier appel asynchrone peut aussi être formulé comme:

myModule.get_syncProxy().then(logInfoProxy);

8.3. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction Altitude.

// En Node.js, on utilise la fonction require()
// En HTML, on utiliserait <script src="...">
require('yoctolib-es2017/yocto_api.js');
require('yoctolib-es2017/yocto_altitude.js');

// On récupère l'objet représentant le module, à travers le VirtualHub local
await YAPI.RegisterHub('127.0.0.1');
var altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude");

// Pour gérer le hot-plug, on vérifie que le module est là
if(await altitude.isOnline())
{
// Utiliser altitude.get_currentValue()
[...]
}

Voyons maintenant en détail ce que font ces quelques lignes.

Require de yocto_api et yocto_altitude

Ces deux imports permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. yocto_api doit toujours être inclus, yocto_altitude est nécessaire pour gérer les modules contenant un altimetre, comme le Yocto-Altimeter. D'autres classes peuvent être utiles dans d'autres cas, comme YModule qui vous permet de faire une énumération de n'importe quel type de module Yoctopuce.

YAPI.RegisterHub

La méthode RegisterHub permet d'indiquer sur quelle machine se trouvent les modules Yoctopuce, ou plus exactement la machine sur laquelle tourne le programme VirtualHub. Dans notre cas l'adresse 127.0.0.1:4444 indique la machine locale, en utilisant le port 4444 (le port standard utilisé par Yoctopuce). Vous pouvez parfaitement changer cette adresse, et mettre l'adresse d'une autre machine sur laquelle tournerait un autre VirtualHub, ou d'un YoctoHub. Si l'hôte n'est pas joignable, la fonction déclanche une exception.

YAltitude.FindAltitude

La méthode FindAltitude, permet de retrouver un altimetre en fonction du numéro de série de son module hôte et de son nom de fonction. Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Altimeter avec le numéros de série YALTIMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction altitude "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute ambiguïté):

altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude")
altitude = YAltitude.FindAltitude("YALTIMK1-123456.MaFonction")
altitude = YAltitude.FindAltitude("MonModule.altitude")
altitude = YAltitude.FindAltitude("MonModule.MaFonction")
altitude = YAltitude.FindAltitude("MaFonction")

YAltitude.FindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode isOnline() de l'objet renvoyé par FindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par YAltitude.FindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

YTemperature.FindTemperature et YPressure.FindPressure

Les fonctions YTemperature.FindTemperature et YPressure.FindPressure permettent de travailler respectivement avec les mesures de temperature et de pression, et se manipulent exactement comme YAltitude.FindAltitude.

Un exemple concret, en Node.js

Ouvrez une fenêtre de commande (un terminal, un shell...) et allez dans le répertoire example_nodejs/Doc-GettingStarted-Yocto-Altimeter de la librairie Yoctopuce pour JavaScript / EcmaScript 2017. Vous y trouverez un fichier nommé demo.js avec le code d'exemple ci-dessous, qui reprend les fonctions expliquées précédemment, mais cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret.

Si le Yocto-Altimeter n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse 127.0.0.1 par l'adresse IP de la machine où est branché le Yocto-Altimeter et où vous avez lancé le VirtualHub.

"use strict";

require('yoctolib-es2017/yocto_api.js');
require('yoctolib-es2017/yocto_altitude.js');
require('yoctolib-es2017/yocto_temperature.js');
require('yoctolib-es2017/yocto_pressure.js');

let alti, temp, pres;

async function startDemo()
{
await YAPI.LogUnhandledPromiseRejections();
await YAPI.DisableExceptions();

// Setup the API to use the VirtualHub on local machine
let errmsg = new YErrorMsg();
if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) {
console.log('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg);
return;
}

// Select specified device, or use first available one
let serial = process.argv[process.argv.length-1];
if(serial[8] != '-') {
// by default use any connected module suitable for the demo
let anysensor = YAltitude.FirstAltitude();
if(anysensor) {
let module = await anysensor.module();
serial = await module.get_serialNumber();
} else {
console.log('No matching sensor connected, check cable !');
return;
}
}
console.log('Using device '+serial);
alti = YAltitude.FindAltitude(serial+".altitude");
temp = YTemperature.FindTemperature(serial+".temperature");
pres = YPressure.FindPressure(serial+".pressure");

refresh();
}

async function refresh()
{
if (await alti.isOnline()) {
console.log('Altitude : '+(await alti.get_currentValue()) + ' m ' +
'(QNH = '+(await alti.get_qnh())+' hPa)');
console.log('Temperature : '+(await temp.get_currentValue()) + ' Â°C');
console.log('Pressure : '+(await pres.get_currentValue()) + ' hPa');
} else {
console.log('Module not connected');
}
setTimeout(refresh, 500);
}

startDemo();

Comme décrit au début de ce chapitre, vous devez avoir installé Node.js v7.6 ou suivant pour essayer ces exemples. Si vous l'avez fait, vous pouvez maintenant taper les deux commandes suivantes pour télécharger automatiquement les librairies dont cet exemple dépend:

npm install

Une fois terminé, vous pouvez lancer votre code d'exemple dans Node.js avec la commande suivante, en remplaçant les [...] par les arguments que vous voulez passer au programme:

node demo.js [...]

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-Altimeter. Vous y 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>
<html>
<head>
<meta charset="UTF-8">
<title>Hello World</title>
<script src="../../lib/yocto_api.js"></script>
<script src="../../lib/yocto_temperature.js"></script>
<script src="../../lib/yocto_altitude.js"></script>
<script src="../../lib/yocto_pressure.js"></script>
<script>
async function startDemo()
{
await YAPI.LogUnhandledPromiseRejections();
await YAPI.DisableExceptions();

// Setup the API to use the VirtualHub on local machine
let errmsg = new YErrorMsg();
if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) {
alert('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg);
}
refresh();
}

async function refresh()
{
let serial = document.getElementById('serial').value;
if(serial == '') {
// by default use any connected module suitable for the demo
let anysensor = YAltitude.FirstAltitude();
if(anysensor) {
let module = await anysensor.module();
serial = await module.get_serialNumber();
document.getElementById('serial').value = serial;
}
}
let alti = YAltitude.FindAltitude(serial+".altitude");
let temp = YTemperature.FindTemperature(serial+".temperature");
let pres = YPressure.FindPressure(serial+".pressure");

if (await alti.isOnline()) {
document.getElementById('msg').value = '';
document.getElementById("qnh").value = await alti.get_qnh();
document.getElementById("alti").value = await alti.get_currentValue();
document.getElementById("temp").value = await temp.get_currentValue();
document.getElementById("pres").value = await pres.get_currentValue();
} else {
document.getElementById('msg').value = 'Module not connected';
}
setTimeout(refresh, 500);
}

startDemo();
</script>
</head>
<body>
Module to use: <input id='serial'>
<input id='msg' style='color:red;border:none;' readonly><br>
Current altitude : <input id='alti' readonly> m
(QNH: <input id='qnh' readonly></span> hPa)<br>
Current temperature : <input id='temp' readonly> °<br>
Current pressure : <input id='pres' readonly> hPa<br>
</body>
</html>

Aucune installation n'est nécessaire pout utiliser cet exemple, il suffit d'ouvrir la page HTML avec un navigateur web.

8.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 balise de localisation.

"use strict";

require('yoctolib-es2017/yocto_api.js');

async function startDemo(args)
{
await YAPI.LogUnhandledPromiseRejections();

// Setup the API to use the VirtualHub on local machine
let errmsg = new YErrorMsg();
if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) {
console.log('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg);
return;
}

// Select the relay to use
let module = YModule.FindModule(args[0]);
if(await module.isOnline()) {
if(args.length > 1) {
if(args[1] == 'ON') {
await module.set_beacon(YModule.BEACON_ON);
} else {
await module.set_beacon(YModule.BEACON_OFF);
}
}
console.log('serial: '+await module.get_serialNumber());
console.log('logical name: '+await module.get_logicalName());
console.log('luminosity: '+await module.get_luminosity()+'%');
console.log('beacon: '+(await module.get_beacon()==YModule.BEACON_ON?'ON':'OFF'));
console.log('upTime: '+parseInt(await module.get_upTime()/1000)+' sec');
console.log('USB current: '+await module.get_usbCurrent()+' mA');
console.log('logs:');
console.log(await module.get_lastLogs());
} else {
console.log("Module not connected (check identification and USB cable)\n");
}
await YAPI.FreeAPI();
}

if(process.argv.length < 2) {
console.log("usage: node demo.js <serial or logicalname> [ ON | OFF ]");
} else {
startDemo(process.argv.slice(2));
}

Chaque propriété xxx du module peut être lue grâce à une méthode du type get_xxxx(), et les 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

Modifications des réglages du module

Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction set_xxx() correspondante, cependant cette modification n'a lieu que dans la mémoire vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa 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 revertFromFlash(). Ce petit exemple ci-dessous vous permet changer le nom logique d'un module.

"use strict";

require('yoctolib-es2017/yocto_api.js');

async function startDemo(args)
{
await YAPI.LogUnhandledPromiseRejections();

// Setup the API to use the VirtualHub on local machine
let errmsg = new YErrorMsg();
if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) {
console.log('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg);
return;
}

// Select the relay to use
let module = YModule.FindModule(args[0]);
if(await module.isOnline()) {
if(args.length > 1) {
let newname = args[1];
if (!await YAPI.CheckLogicalName(newname)) {
console.log("Invalid name (" + newname + ")");
process.exit(1);
}
await module.set_logicalName(newname);
await module.saveToFlash();
}
console.log('Current name: '+await module.get_logicalName());
} else {
console.log("Module not connected (check identification and USB cable)\n");
}
await YAPI.FreeAPI();
}

if(process.argv.length < 2) {
console.log("usage: node demo.js <serial> [newLogicalName]");
} else {
startDemo(process.argv.slice(2));
}

Attention, le nombre de cycle d'écriture de la mémoire non volatile du module est limité. Passé cette limite plus rien ne garantit de que la sauvegarde des réglages se passera correctement. Cette limite, liée à la technologie employé par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Énumération des modules

Obtenir la liste des modules connectés se fait à l'aide de la fonction YModule.FirstModule() qui renvoie le premier module trouvé, il suffit ensuite d'appeler la fonction nextModule() de cet objet pour trouver les modules suivants, et ce tant que la réponse n'est pas un null. Ci-dessous un petit exemple listant les module connectés

"use strict";

require('yoctolib-es2017/yocto_api.js');

async function startDemo()
{
await YAPI.LogUnhandledPromiseRejections();
await YAPI.DisableExceptions();

// Setup the API to use the VirtualHub on local machine
let errmsg = new YErrorMsg();
if (await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) {
console.log('Cannot contact VirtualHub on 127.0.0.1');
return;
}
refresh();
}

async function refresh()
{
try {
let errmsg = new YErrorMsg();
await YAPI.UpdateDeviceList(errmsg);

let module = YModule.FirstModule();
while(module) {
let line = await module.get_serialNumber();
line += '(' + (await module.get_productName()) + ')';
console.log(line);
module = module.nextModule();
}
setTimeout(refresh, 500);
} catch(e) {
console.log(e);
}
}

try {
startDemo();
} catch(e) {
console.log(e);
}

8.5. Gestion des erreurs

Lorsque vous implémentez un programme qui doit interagir avec des modules USB, vous ne pouvez pas faire abstraction de la gestion des erreurs. Il y aura forcément une occasion où un utilisateur aura débranché le périphérique, soit avant de lancer le programme, soit même en pleine opération. 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 manière la plus simple de contourner le problème est celle que nous avons employé pour les petits exemples précédents de ce chapitre: avant d'accéder à un module, on vérifie qu'il est en ligne avec la méthode isOnline() et on suppose ensuite qu'il va y rester pendant la fraction de seconde nécessaire à exécuter les lignes de code suivantes. Ce n'est pas parfait, mais ça peut suffire dans certains cas. Il faut toutefois être conscient qu'on ne peut pas totalement exclure une erreur se produisant après le isOnline(), qui pourrait faire planter le programme. La seule manière de l'éviter est d'implémenter une des deux techniques de gestion des erreurs décrites ci-dessous.

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:

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

Comme cette dernière situation n'est pas la plus souhaitable, la librairie Yoctopuce offre une autre alternative pour la gestion des erreurs, permettant de faire un programme robuste sans devoir attraper les exceptions à chaque ligne de code. Il suffit d'appeler la fonction YAPI.DisableExceptions() pour commuter la librairie dans un mode où les exceptions de chaque fonction sont systématiquement remplacées par des valeurs de retour particulières, qui peuvent être testées par l'appelant lorsque c'est pertinent. Le nom de la valeur de retour en cas d'erreur pour chaque fonction est systématiquement documenté dans la référence de la librairie. Il suit toujours la même logique: une méthode get_state() retournera une valeur Y_STATE_INVALID, une méthode get_currentValue retournera une valeur Y_CURRENTVALUE_INVALID, etc. Dans tous les cas, la valeur retournée sera du type attendu, et ne sera pas un pointeur nul qui risquerait de faire crasher votre programme. Au pire, si vous affichez la valeur sans la tester, elle sera hors du cadre attendu pour la valeur retournée. Dans le cas de fonctions qui ne retournent à priori pas d'information, la valeur de retour sera YAPI_SUCCESS si tout va bien, et un code d'erreur différent en cas d'échec.

Quand vous travaillez sans les exceptions, il est possible d'obtenir un code d'erreur et un message expliquant l'origine de l'erreur en le demandant à l'objet qui a retourné une erreur à l'aide des méthodes errType() et errMessage(). Ce sont les même informations qui auraient été associées à l'exception si elles avaient été actives.

9. Utilisation du Yocto-Altimeter en PHP

PHP est, tout comme Javascript, un langage assez atypique lorsqu'il s'agit de discuter avec du hardware. Néanmoins, utiliser PHP avec des modules Yoctopuce offre l'opportunité de construire très facilement des sites web capables d'interagir avec leur environnement physique, ce qui n'est pas donné à tous les serveurs web. Cette technique trouve une application directe dans la domotique: quelques modules Yoctopuce, un serveur PHP et vous pourrez interagir avec votre maison depuis n'importe ou dans le monde. Pour autant que vous ayez une connexion internet.

PHP fait lui aussi partie de ces langages qui ne vous permettront pas d'accéder directement aux couches matérielles de votre ordinateur. C'est pourquoi vous devrez faire tourner un hub virtuel sur la machine à laquelle sont branchés les modules

Pour démarrer vos essais en PHP, vous allez avoir besoin d'un serveur PHP 5.3 ou plus ²⁰ de préférence en local sur votre machine. Si vous souhaiter utiliser celui qui se trouve chez votre provider internet, c'est possible, mais vous devrez probablement configurer votre routeur ADSL pour qu'il accepte et forwarde les requêtes TCP sur le port 4444.

9.1. Préparation

Connectez vous sur le site de Yoctopuce et téléchargez les éléments suivants:

La librairie de programmation pour PHP²¹
Le programme VirtualHub²² pour Windows, Mac OS X ou Linux selon l'OS que vous utilisez

Décompressez les fichiers de la librairie dans un répertoire de votre choix accessible à votre serveur web, branchez vos modules, lancez le programme VirtualHub, et vous pouvez commencer vos premiers test. Vous n'avez pas besoin d'installer de driver.

9.2. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code PHP qui utilise la fonction Altitude.

include('yocto_api.php');
include('yocto_altitude.php');

// On récupère l'objet représentant le module, à travers le VirtualHub local
yRegisterHub('http://127.0.0.1:4444/',$errmsg);
$altitude = yFindAltitude("YALTIMK1-123456.altitude");

// Pour gérer le hot-plug, on vérifie que le module est là
if(altitude->isOnline())
{
// Utiliser altitude->get_currentValue(), ...
}

Voyons maintenant en détail ce que font ces quelques lignes.

yocto_api.php et yocto_altitude.php

Ces deux includes PHP permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. yocto_api.php doit toujours être inclus, yocto_altitude.php est nécessaire pour gérer les modules contenant un altimetre, comme le Yocto-Altimeter.

yRegisterHub

La fonction yRegisterHub permet d'indiquer sur quelle machine se trouve les modules Yoctopuce, ou plus exactemenent sur quelle machine tourne le programme VirtualHub. Dans notre cas l'adresse 127.0.0.1:4444 indique la machine locale, en utilisant le port 4444 (le port standard utilisé par Yoctopuce). Vous pouvez parfaitement changer cette adresse, et mettre l'adresse d'une autre machine sur laquelle tournerait un autre VirtualHub.

yFindAltitude

La fonction yFindAltitude, permet de retrouver un altimetre en fonction du numéro de série de son module hôte et de son nom de fonction. Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Altimeter avec le numéros de série YALTIMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction altitude "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute ambiguïté):

$altitude = yFindAltitude("YALTIMK1-123456.altitude");
$altitude = yFindAltitude("YALTIMK1-123456.MaFonction");
$altitude = yFindAltitude("MonModule.altitude");
$altitude = yFindAltitude("MonModule.MaFonction");
$altitude = yFindAltitude("MaFonction");

yFindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode isOnline() de l'objet renvoyé par yFindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par yFindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

yFindTemperature et yFindPressure

Les fonctions yFindTemperature et yFindPressure permettent de travailler respectivement avec les mesures de température et de pression, et se manipulent exactement comme yFindAltitude.

Un exemple réel

Ouvrez votre éditeur de texte préféré²³, recopiez le code ci dessous, sauvez-le dans un répertoire accessible par votre serveur web/PHP avec les fichiers de la librairie, et ouvrez-la page avec votre browser favori. Vous trouverez aussi ce code dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter 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.

<HTML>
<HEAD>
<TITLE> Hello World</TITLE>
</HEAD>
<BODY>
<?php
include('yocto_api.php');
include('yocto_altitude.php');
include('yocto_pressure.php');
include('yocto_temperature.php');

// Use explicit error handling rather than exceptions
yDisableExceptions();

// Setup the API to use the VirtualHub on local machine
if(yRegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI_SUCCESS) {
die("Cannot contact VirtualHub on 127.0.0.1");
}

@$serial = $_GET['serial'];
if ($serial != '') {
// Check if a specified module is available online
$alt = yFindAltitude("$serial.altitude");
if (!$alt->isOnline()) {
die("Module not connected (check serial and USB cable)");
}
} else {
// or use any connected module suitable for the demo
$alt = yFirstAltitude();
if(is_null($alt)) {
die("No module connected (check USB cable)");
} else {
$serial = $alt->module()->get_serialnumber();
}
}
Print("Module to use: <input name='serial' value='$serial'><br>");

// Get altitude and temperature as well
$alt = yFindAltitude("$serial.altitude");
$temp = yFindTemperature("$serial.temperature");
$press = yFindPressure("$serial.pressure");

$hvalue = $alt->get_currentValue();
$qvalue = $alt->get_qnh();
$pvalue = $press->get_currentValue();
$tvalue = $temp->get_currentValue();
Print("Altitude: $hvalue m (QNH=$qvalue hPa)<br>");
Print("Temperature: $tvalue deg C <br>");
Print("Pressure: $pvalue hPa<br>");
yFreeAPI();

// trigger auto-refresh after one second
Print("<script language='javascript1.5' type='text/JavaScript'>\n");
Print("setTimeout('window.location.reload()',1000);");
Print("</script>\n");
?>
</BODY>
</HTML>

9.3. Contrôle de la partie module

<HTML>
<HEAD>
<TITLE>Module Control</TITLE>
</HEAD>
<BODY>
<FORM method='get'>
<?php
include('yocto_api.php');

// Use explicit error handling rather than exceptions
yDisableExceptions();

// Setup the API to use the VirtualHub on local machine
if(yRegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI_SUCCESS) {
die("Cannot contact VirtualHub on 127.0.0.1 : ".$errmsg);
}

@$serial = $_GET['serial'];
if ($serial != '') {
// Check if a specified module is available online
$module = yFindModule("$serial");
if (!$module->isOnline()) {
die("Module not connected (check serial and USB cable)");
}
} else {
// or use any connected module suitable for the demo
$module = yFirstModule();
if($module) { // skip VirtualHub
$module = $module->nextModule();
}
if(is_null($module)) {
die("No module connected (check USB cable)");
} else {
$serial = $module->get_serialnumber();
}
}
Print("Module to use: <input name='serial' value='$serial'><br>");

if (isset($_GET['beacon'])) {
if ($_GET['beacon']=='ON')
$module->set_beacon(Y_BEACON_ON);
else
$module->set_beacon(Y_BEACON_OFF);
}
printf('serial: %s<br>',$module->get_serialNumber());
printf('logical name: %s<br>',$module->get_logicalName());
printf('luminosity: %s<br>',$module->get_luminosity());
print('beacon: ');
if($module->get_beacon() == Y_BEACON_ON) {
printf("<input type='radio' name='beacon' value='ON' checked>ON ");
printf("<input type='radio' name='beacon' value='OFF'>OFF<br>");
} else {
printf("<input type='radio' name='beacon' value='ON'>ON ");
printf("<input type='radio' name='beacon' value='OFF' checked>OFF<br>");
}
printf('upTime: %s sec<br>',intVal($module->get_upTime()/1000));
printf('USB current: %smA<br>',$module->get_usbCurrent());
printf('logs:<br><pre>%s</pre>',$module->get_lastLogs());
yFreeAPI();
?>
<input type='submit' value='refresh'>
</FORM>
</BODY>
</HTML>

Modifications des réglages du module

<HTML>
<HEAD>
<TITLE>save settings</TITLE>
<BODY>
<FORM method='get'>
<?php
include('yocto_api.php');

// Use explicit error handling rather than exceptions
yDisableExceptions();

// Setup the API to use the VirtualHub on local machine
if(yRegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI_SUCCESS) {
die("Cannot contact VirtualHub on 127.0.0.1");
}

@$serial = $_GET['serial'];
if ($serial != '') {
// Check if a specified module is available online
$module = yFindModule("$serial");
if (!$module->isOnline()) {
die("Module not connected (check serial and USB cable)");
}
} else {
// or use any connected module suitable for the demo
$module = yFirstModule();
if($module) { // skip VirtualHub
$module = $module->nextModule();
}
if(is_null($module)) {
die("No module connected (check USB cable)");
} else {
$serial = $module->get_serialnumber();
}
}
Print("Module to use: <input name='serial' value='$serial'><br>");

if (isset($_GET['newname'])){
$newname = $_GET['newname'];
if (!yCheckLogicalName($newname))
die('Invalid name');
$module->set_logicalName($newname);
$module->saveToFlash();
}
printf("Current name: %s<br>", $module->get_logicalName());
print("New name: <input name='newname' value='' maxlength=19><br>");
yFreeAPI();
?>
<input type='submit'>
</FORM>
</BODY>
</HTML>

Attention, le nombre de cycle d'écriture de la mémoire non volatile du module est limité. Passé cette limite plus rien ne garantit de que la sauvegarde des réglages se passera correctement. Cette limite, lié à la technologie employé par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumération des modules

Obtenir la liste des modules connectés se fait à l'aide de la fonction yFirstModule() qui renvoie le premier module trouvé, il suffit ensuite d'appeler la fonction nextModule() de cet objet pour trouver les modules suivants, et ce tant que la réponse n'est pas un NULL. Ci-dessous un petit exemple listant les module connectés

<HTML>
<HEAD>
<TITLE>inventory</TITLE>
</HEAD>
<BODY>
<H1>Device list</H1>
<TT>
<?php
include('yocto_api.php');
yRegisterHub("http://127.0.0.1:4444/");
$module = yFirstModule();
while (!is_null($module)) {
printf("%s (%s)<br>", $module->get_serialNumber(),
$module->get_productName());
$module=$module->nextModule();
}
yFreeAPI();
?>
</TT>
</BODY>
</HTML>

9.4. API par callback HTTP et filtres NAT

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é depuis un site Web publique.

Le filtre NAT, avantages et inconvénients

Un routeur DSL qui effectue de la traduction d'adresse réseau (NAT) fonctionne un peu comme un petit central téléphonique privé: les postes internes peuvent s'appeler l'un l'autre ainsi que faire des appels vers l'extérieur, mais vu de l'extérieur, il n'existe qu'un numéro de téléphone officiel, attribué au central téléphonique lui-même. Les postes internes ne sont pas atteignables depuis l'extérieur.

Configuration DSL typique, les machines du LAN sont isolées de l'extérieur par le router DSL

Ce qui, transposé en terme de réseau, donne : les appareils connectés sur un réseau domestique peuvent communiquer entre eux en utilisant une adresse IP locale (du genre 192.168.xxx.yyy), et contacter des serveurs sur Internet par leur adresse publique, mais vu de l'extérieur, il n'y a qu'une seule adresse IP officielle, attribuée au routeur DSL exclusivement. Les différents appareils réseau ne sont pas directement atteignables depuis l'extérieur. C'est assez contraignant, mais c'est une protection relativement efficace contre les intrusions.

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. Une solution à ce problème, préconisée par de nombreux vendeurs de domotique, consiste à donner une visibilité externe au serveur de domotique lui-même, en ouvrant un port et en ajoutant une règle de routage dans la configuration NAT du routeur DSL. Le problème de cette solution est qu'il expose le serveur de domotique aux attaques externes.

L'API par callback HTTP résoud ce problème sans qu'il soit nécessaire de modifier la configuration du routeur DSL. Le script de contrôle des modules est placé sur un site externe, et c'est le Virtual Hub qui est chargé de l'appeler à intervalle régulier.

L'API par callback HTTP utilise le VirtualHub, et c'est lui qui initie les requêtes.

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.

Il faut configurer le VirtualHub pour qu'il appelle le script PHP régulièrement. Pour cela il faut:

Lancer un VirtualHub
Accéder à son interface, généralement 127.0.0.1:4444
Cliquer sur le bouton configure de la ligne correspondant au VirtualHub lui-même
Cliquer sur le bouton edit de la section Outgoing callbacks

Cliquer sur le bouton "configure" de la première ligne

Cliquer sur le bouton "edit" de la section Outgoing callbacks.

Et choisir "Yocto-API callback".

Il suffit alors de définir l'URL du script PHP et, si nécessaire, le nom d'utilisateur et le mot de passe pour accéder à cette URL. Les méthodes d'authentification supportées sont basic et digest. La seconde est plus sûre que la première car elle permet de ne pas transférer le mot de passe sur le réseau.

Utilisation

Du point de vue du programmeur, la seule différence se trouve au niveau de l'appel à la fonction yRegisterHub; au lieu d'utiliser une adresse IP, il faut utiliser la chaîne callback (ou http://callback, qui est équivalent).

include("yocto_api.php");
yRegisterHub("callback");

La suite du code reste strictement identique. Sur l'interface du VirtualHub, il y a en bas de la fenêtre de configuration de l'API par callback HTTP un bouton qui permet de tester l'appel au script PHP.

Il est à noter que le script PHP qui contrôle les modules à distance via l'API par callback HTTP ne peut être appelé que par le VirtualHub. En effet, il a besoin des informations postées par le 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.

Problèmes courants

Pour que l'API par callback HTTP fonctionne, l'option de PHP allow_url_fopen doit être activée. Certains hébergeurs de site web ne l'activent pas par défaut. Le problème se manifeste alors avec l'erreur suivante:

error: URL file-access is disabled in the server configuration

Pour activer cette option, il suffit de créer dans le même répertoire que le script PHP de contrôle un fichier .htaccess contenant la ligne suivante:
php_flag "allow_url_fopen" "On"
Selon la politique de sécurité de l'hébergeur, il n'est parfois pas possible d'autoriser cette option à la racine du site web, où même d'installer des scripts PHP recevant des données par un POST HTTP. Dans ce cas il suffit de placer le script PHP dans un sous-répertoire.

Limitations

Cette méthode de fonctionnement qui permet de passer les filtres NAT à moindre frais a malgré tout un prix. Les communications étant initiées par le Virtual Hub à intervalle plus ou moins régulier, le temps de réaction à un événement est nettement plus grand que si les modules Yoctopuce étaient pilotés en direct. Vous pouvez configurer le temps de réaction dans la fenêtre ad-hoc du Virtual Hub, mais il sera nécessairement de quelques secondes dans le meilleur des cas.

Le mode Yocto-API par callback HTTP n'est pour l'instant disponible qu'en PHP, EcmaScript (Node.JS) et Java.

9.5. Gestion des erreurs

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

10. Utilisation du Yocto-Altimeter en C++

Le C++ n'est pas le langage le plus simple à maîtriser. Pourtant, si on prend soin à se limiter aux fonctionnalités essentielles, c'est un langage tout à fait utilisable pour des petits programmes vite faits, et qui a l'avantage d'être très portable d'un système d'exploitation à l'autre. Sous Windows, tous les exemples et les modèles de projet sont testés avec Microsoft Visual Studio 2010 Express, disponible gratuitement sur le site de Microsoft ²⁴. Sous Mac OS X, tous les exemples et les modèles de projet sont testés avec XCode 4, disponible sur l'App Store. Par ailleurs, aussi bien sous Mac OS X que sous Linux, vous pouvez compiler les exemples en ligne de commande avec GCC en utilisant le GNUmakefile fourni. De même, sous Windows, un Makefile pour permet de compiler les exemples en ligne de commande, et en pleine connaissance des arguments de compilation et link.

Les librairies Yoctopuce²⁵ pour C++ vous sont fournies au format source dans leur intégralité. Une partie de la librairie de bas-niveau est écrite en C pur sucre, mais vous n'aurez à priori pas besoin d'interagir directement avec elle: tout a été fait pour que l'interaction soit le plus simple possible depuis le C++. La librairie vous est fournie bien entendu aussi sous forme binaire, de sorte à pouvoir la linker directement si vous le préférez.

Vous allez rapidement vous rendre compte que l'API C++ defini beaucoup de fonctions qui retournent des objets. Vous ne devez jamais désallouer ces objets vous-même. Ils seront désalloués automatiquement par l'API à la fin de l'application.

Afin des les garder simples, tous les exemples fournis dans cette documentation sont des applications consoles. Il va de soit que que les fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique. Vous trouverez dans la dernière section de ce chapitre toutes les informations nécessaires à la création d'un projet à neuf linké avec les librairies Yoctopuce.

10.1. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code C++ qui utilise la fonction Altitude.

#include "yocto_api.h"
#include "yocto_altitude.h"

[...]
String errmsg;
YAltitude *altitude;

// On récupère l'objet représentant le module (ici connecté en local sur USB)
yRegisterHub("usb", errmsg);
altitude = yFindAltitude("YALTIMK1-123456.altitude");

// Pour gérer le hot-plug, on vérifie que le module est là
if(altitude->isOnline())
{
// Utiliser altitude->get_currentValue(), ...
}

Voyons maintenant en détail ce que font ces quelques lignes.

yocto_api.h et yocto_altitude.h

Ces deux fichiers inclus permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. yocto_api.h doit toujours être utilisé, yocto_altitude.h est nécessaire pour gérer les modules contenant un altimetre, comme le Yocto-Altimeter.

yRegisterHub

La fonction yRegisterHub initialise l'API de Yoctopuce en indiquant où les modules doivent être recherchés. Utilisée avec le paramètre "usb", elle permet de travailler avec les modules connectés localement à la machine. Si l'initialisation se passe mal, cette fonction renverra une valeur différente de YAPI_SUCCESS, et retournera via le paramètre errmsg un explication du problème.

yFindAltitude

YAltitude *altitude = yFindAltitude("YALTIMK1-123456.altitude");
YAltitude *altitude = yFindAltitude("YALTIMK1-123456.MaFonction");
YAltitude *altitude = yFindAltitude("MonModule.altitude");
YAltitude *altitude = yFindAltitude("MonModule.MaFonction");
YAltitude *altitude = yFindAltitude("MaFonction");

yFindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode isOnline() de l'objet renvoyé par yFindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par yFindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

yFindTemperature et yFindPressure

Les fonctions yFindTemperature et yFindPressure permettent de travailler respectivement avec les mesures de température et de pression, et se manipulent exactement comme yFindAltitude.

Un exemple réel

Lancez votre environnement C++ et ouvrez le projet exemple correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter de la librairie Yoctopuce. Si vous préférez travailler avec votre éditeur de texte préféré, ouvrez le fichier main.cpp, vous taperez simplement make dans le répertoire de l'exemple pour le compiler.

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.

#include "yocto_api.h"
#include "yocto_altitude.h"
#include "yocto_temperature.h"
#include "yocto_pressure.h"
#include <iostream>
#include <stdlib.h>

using namespace std;

static void usage(void)
{
cout << "usage: demo <serial_number> " << endl;
cout << " demo <logical_name>" << endl;
cout << " demo any" << endl;
u64 now = yGetTickCount();
while (yGetTickCount() - now < 3000) {
// wait 3 sec to show the message
}
exit(1);
}

int main(int argc, const char * argv[])
{
string errmsg, target;
YAltitude *asensor;
YTemperature *tsensor;
YPressure *psensor;

if(argc < 2) {
usage();
}
target = (string) argv[1];

// Setup the API to use local USB devices
if(yRegisterHub("usb", errmsg) != YAPI_SUCCESS) {
cerr << "RegisterHub error: " << errmsg << endl;
return 1;
}

if(target == "any") {
asensor = yFirstAltitude();
tsensor = yFirstTemperature();
psensor = yFirstPressure();
if (asensor == NULL || tsensor == NULL || psensor == NULL) {
cout << "No module connected (check USB cable)" << endl;
return 1;
}
} else {
asensor = yFindAltitude(target + ".altitude");
tsensor = yFindTemperature(target + ".temperature");
psensor = yFindPressure(target + ".pressure");
}

while(1) {
if(!asensor->isOnline()) {
cout << "Module not connected (check identification and USB cable)";
break;
}

cout << "Current altitude: " << asensor->get_currentValue() << " m (QNH= " <<
asensor->get_qnh() << " hPa)" << endl;
cout << "Current temperature: " << tsensor->get_currentValue() << " Â°C" << endl;
cout << "Current pressure: " << psensor->get_currentValue() << " hPa" << endl;

cout << " (press Ctrl-C to exit)" << endl;
ySleep(1000, errmsg);
};

yFreeAPI();
return 0;
}

10.2. Contrôle de la partie module

#include <iostream>
#include <stdlib.h>

#include "yocto_api.h"

using namespace std;

static void usage(const char *exe)
{
cout << "usage: " << exe << " <serial or logical name> [ON/OFF]" << endl;
exit(1);
}

int main(int argc, const char * argv[])
{
string errmsg;

// Setup the API to use local USB devices
if(yRegisterHub("usb", errmsg) != YAPI_SUCCESS) {
cerr << "RegisterHub error: " << errmsg << endl;
return 1;
}

if(argc < 2)
usage(argv[0]);

YModule *module = yFindModule(argv[1]); // use serial or logical name

if (module->isOnline()) {
if (argc > 2) {
if (string(argv[2]) == "ON")
module->set_beacon(Y_BEACON_ON);
else
module->set_beacon(Y_BEACON_OFF);
}
cout << "serial: " << module->get_serialNumber() << endl;
cout << "logical name: " << module->get_logicalName() << endl;
cout << "luminosity: " << module->get_luminosity() << endl;
cout << "beacon: ";
if (module->get_beacon() == Y_BEACON_ON)
cout << "ON" << endl;
else
cout << "OFF" << endl;
cout << "upTime: " << module->get_upTime() / 1000 << " sec" << endl;
cout << "USB current: " << module->get_usbCurrent() << " mA" << endl;
cout << "Logs:" << endl << module->get_lastLogs() << endl;
} else {
cout << argv[1] << " not connected (check identification and USB cable)"
<< endl;
}
yFreeAPI();
return 0;
}

Modifications des réglages du module

#include <iostream>
#include <stdlib.h>

#include "yocto_api.h"

using namespace std;

static void usage(const char *exe)
{
cerr << "usage: " << exe << " <serial> <newLogicalName>" << endl;
exit(1);
}

int main(int argc, const char * argv[])
{
string errmsg;

// Setup the API to use local USB devices
if(yRegisterHub("usb", errmsg) != YAPI_SUCCESS) {
cerr << "RegisterHub error: " << errmsg << endl;
return 1;
}

if(argc < 2)
usage(argv[0]);

YModule *module = yFindModule(argv[1]); // use serial or logical name

if (module->isOnline()) {
if (argc >= 3) {
string newname = argv[2];
if (!yCheckLogicalName(newname)) {
cerr << "Invalid name (" << newname << ")" << endl;
usage(argv[0]);
}
module->set_logicalName(newname);
module->saveToFlash();
}
cout << "Current name: " << module->get_logicalName() << endl;
} else {
cout << argv[1] << " not connected (check identification and USB cable)"
<< endl;
}
yFreeAPI();
return 0;
}

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

#include <iostream>

#include "yocto_api.h"

using namespace std;

int main(int argc, const char * argv[])
{
string errmsg;

// Setup the API to use local USB devices
if(YAPI::RegisterHub("usb", errmsg) != YAPI_SUCCESS) {
cerr << "RegisterHub error: " << errmsg << endl;
return 1;
}

cout << "Device list: " << endl;

YModule *module = YModule::FirstModule();
while (module != NULL) {
cout << module->get_serialNumber() << " ";
cout << module->get_productName() << endl;
module = module->nextModule();
}
yFreeAPI();
return 0;
}

10.3. Gestion des erreurs

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

10.4. Intégration de la librairie Yoctopuce en C++

Selon vos besoins et vos préférences, vous pouvez être mené à intégrer de différentes manières la librairie à vos projets. Cette section explique comment implémenter les différentes options.

Intégration au format source

L'intégration de toutes les sources de la librairie dans vos projets a plusieurs avantages:

Elle garanti le respect des conventions de compilation de votre projet (32/64 bits, inclusion des symboles de debug, caractères unicode ou ASCII, etc.);
Elle facilite le déboggage si vous cherchez la cause d'un problème lié à la librairie Yoctopuce
Elle réduit les dépendances sur des composants tiers, par exemple pour parer au cas où vous pourriez être mené à recompiler ce projet pour une architecture différente dans de nombreuses années.
Elle ne requiert pas l'installation d'une librairie dynamique spécifique à Yoctopuce sur le système final, tout est dans l'exécutable.

Pour intégrer le code source, le plus simple est d'inclure simplement le répertoire Sources de la librairie Yoctopuce à votre IncludePath, et d'ajouter tous les fichiers de ce répertoire (y compris le sous-répertoire yapi) à votre projet.

Pour que votre projet se construise ensuite correctement, il faudra linker avec votre projet les librairies systèmes requises, à savoir:

Pour Windows: les librairies sont mises automatiquement
Pour Mac OS X: IOKit.framework et CoreFoundation.framework
Pour Linux: libm, libpthread, libusb1.0 et libstdc++

Intégration en librairie statique

L'intégration de de la librairie Yoctopuce sous forme de librairie statique est une manière plus simple de construire un petit exécutable utilisant des modules Yoctopuce. Elle permet une compilation rapide du programme en une seule commande. Elle ne requiert pas non plus l'installation d'une librairie dynamique spécifique à Yoctopuce sur le système final, tout est dans l'exécutable.

Pour intégrer la librairie statique Yoctopuce à votre projet, vous devez inclure le répertoire Sources de la librairie Yoctopuce à votre IncludePath, et ajouter le sous-répertoire de Binaries/... correspondant à votre système d'exploitation à votre LibPath.

Ensuite, pour que votre projet se construise ensuite correctement, il faudra linker avec votre projet la librairie Yoctopuce et les librairies systèmes requises:

Pour Windows: yocto-static.lib
Pour Mac OS X: libyocto-static.a. IOKit.framework et CoreFoundation.framework
Pour Linux: libyocto-static.a, libm, libpthread, libusb1.0 et libstdc++.

Attention, sous Linux, si vous voulez compiler en ligne de commande avec GCC, il est en général souhaitable de linker les librairies systèmes en dynamique et non en statique. Pour mélanger sur la même ligne de commande des librairies statiques et dynamiques, il faut passer les arguments suivants:

gcc (...) -Wl,-Bstatic -lyocto-static -Wl,-Bdynamic -lm -lpthread -lusb-1.0 -lstdc++

Intégration en librairie dynamique

L'intégration de la librairie Yoctopuce sous forme de librairie dynamique permet de produire un exécutable plus petit que les deux méthodes précédentes, et de mettre éventuellement à jour cette librairie si un correctif s'avérait nécessaire sans devoir recompiler le code source de l'application. Par contre, c'est un mode d'intégration qui exigera systématiquement de copier la librairie dynamique sur la machine cible ou l'application devra être lancée (yocto.dll sous Windows, libyocto.so.1.0.1 sous Mac OS X et Linux).

Pour intégrer la librairie dynamique Yoctopuce à votre projet, vous devez inclure le répertoire Sources de la librairie Yoctopuce à votre IncludePath, et ajouter le sous-répertoire de Binaries/... correspondant à votre système d'exploitation à votre LibPath.

Ensuite, pour que votre projet se construise ensuite correctement, il faudra linker avec votre projet la librairie dynamique Yoctopuce et les librairies systèmes requises:

Pour Windows: yocto.lib
Pour Mac OS X: libyocto, IOKit.framework et CoreFoundation.framework
Pour Linux: libyocto, libm, libpthread, libusb1.0 et libstdc++.

Avec GCC, la ligne de commande de compilation est simplement:

gcc (...) -lyocto -lm -lpthread -lusb-1.0 -lstdc++

11. Utilisation du Yocto-Altimeter en Objective-C

Objective-C est le langage de prédilection pour programmer sous Mac OS X, en raison de son intégration avec le générateur d'interfaces Cocoa. Pour pouvoir utiliser la libraire Objective-C vous aurez impérativement besoin de XCode 4.2, qui est disponible gratuitement sous Lion. Si vous êtes encore sous Snow Leopard il vous faudra être enregistré comme développeur auprès d'Apple pour pourvoir télécharger XCode 4.2. La librairie Yoctopuce est compatible ARC. Il vous sera donc possible de coder vos projet soit en utilisant la traditionnelle méthode de retain / release, soit en activant l'Automatic Reference Counting.

Les librairies Yoctopuce²⁶ pour Objective-C vous sont fournies au format source dans leur intégralité. Une partie de la librairie de bas-niveau est écrite en C pur sucre, mais vous n'aurez à priori pas besoin d'interagir directement avec elle: tout a été fait pour que l'interaction soit le plus simple possible depuis Objective-C.

Vous allez rapidement vous rendre compte que l'API Objective-C définit beaucoup de fonctions qui retournent des objets. Vous ne devez jamais désallouer ces objets vous-même. Ils seront désalloués automatiquement par l'API à la fin de l'application.

Afin des les garder simples, tous les exemples fournis dans cette documentation sont des applications consoles. Il va de soit que que les fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique. Vous trouverez sur le blog de Yoctopuce un exemple détaillé²⁷ avec des séquences vidéo montrant comment intégrer les fichiers de la librairie à vos projets.

11.1. Contrôle de la fonction Altitude

Lancez Xcode 4.2 et ouvrez le projet exemple correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter de la librairie Yoctopuce.

#import <Foundation/Foundation.h>
#import "yocto_api.h"
#import "yocto_altitude.h"
#import "yocto_temperature.h"
#import "yocto_pressure.h"

static void usage(void)
{
NSLog(@"usage: demo <serial_number> ");
NSLog(@" demo <logical_name>");
NSLog(@" demo any (use any discovered device)");
exit(1);
}

int main(int argc, const char * argv[])
{
NSError *error;

if (argc < 2) {
usage();
}

@autoreleasepool {
// Setup the API to use local USB devices
if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) {
NSLog(@"RegisterHub error: %@", [error localizedDescription]);
return 1;
}

NSString *target = [NSString stringWithUTF8String:argv[1]];
YAltitude *asensor;
YTemperature *tsensor;
YPressure *psensor;

if([target isEqualToString:@"any"]) {
asensor = [YAltitude FirstAltitude];
tsensor = [YTemperature FirstTemperature];
psensor = [YPressure FirstPressure];
if (asensor == NULL || tsensor == NULL || psensor == NULL) {
NSLog(@"No module connected (check USB cable)");
return 1;
}
} else {
asensor = [YAltitude FindAltitude:[target stringByAppendingString:@".altitude"]];
tsensor = [YTemperature FindTemperature:[target stringByAppendingString:@".temperature"]];
psensor = [YPressure FindPressure:[target stringByAppendingString:@".pressure"]];
}
while(1) {
if(![asensor isOnline]) {
NSLog(@"Module not connected (check identification and USB cable)\n");
break;
}
NSLog(@"Current altitude: %f m (QNH=%f)\n", [asensor get_currentValue], [asensor
get_qnh]);
NSLog(@"Current pressure: %f hPa\n", [psensor get_currentValue]);
NSLog(@"Current temperature: %f C\n", [tsensor get_currentValue]);
NSLog(@" (press Ctrl-C to exit)\n");
[YAPI Sleep:1000:NULL];
}
[YAPI FreeAPI];
}

return 0;
}

Il n'y a que peu de lignes véritablement importantes dans le code précédent. Nous allons les expliquer en détail.

yocto_api.h et yocto_altitude.h

Ces deux fichiers importés permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. yocto_api.h doit toujours être utilisé, yocto_altitude.h est nécessaire pour gérer les modules contenant un altimetre, comme le Yocto-Altimeter.

[YAPI RegisterHub]

La fonction [YAPI RegisterHub] initialise l'API de Yoctopuce en indiquant où les modules doivent être recherchés. Utilisée avec le paramètre @"usb", elle permet de travailler avec les modules connectés localement à la machine. Si l'initialisation se passe mal, cette fonction renverra une valeur différente de YAPI_SUCCESS, et retournera via le paramètre errmsg un explication du problème.

[Altitude FindAltitude]

La fonction [Altitude FindAltitude], permet de retrouver un altimetre en fonction du numéro de série de son module hôte et de son nom de fonction. Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Altimeter avec le numéros de série YALTIMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction altitude "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute ambiguïté):

YAltitude *altitude = [YAltitude FindAltitude:@"YALTIMK1-123456.altitude"];
YAltitude *altitude = [YAltitude FindAltitude:@"YALTIMK1-123456.MaFonction"];
YAltitude *altitude = [YAltitude FindAltitude:@"MonModule.altitude"];
YAltitude *altitude = [YAltitude FindAltitude:@"MonModule.MaFonction"];
YAltitude *altitude = [YAltitude FindAltitude:@"MaFonction"];

[YAltitude FindAltitude] renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode isOnline de l'objet renvoyé par [YAltitude FindAltitude] permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par YAltitude.FindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

YTemperature.FindTemperature et YPressure.FindPressure

11.2. Contrôle de la partie module

#import <Foundation/Foundation.h>
#import "yocto_api.h"

static void usage(const char *exe)
{
NSLog(@"usage: %s <serial or logical name> [ON/OFF]\n", exe);
exit(1);
}

int main (int argc, const char * argv[])
{
NSError *error;

@autoreleasepool {
// Setup the API to use local USB devices
if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) {
NSLog(@"RegisterHub error: %@", [error localizedDescription]);
return 1;
}
if(argc < 2)
usage(argv[0]);
NSString *serial_or_name = [NSString stringWithUTF8String:argv[1]];
// use serial or logical name
YModule *module = [YModule FindModule:serial_or_name];
if ([module isOnline]) {
if (argc > 2) {
if (strcmp(argv[2], "ON") == 0)
[module setBeacon:Y_BEACON_ON];
else
[module setBeacon:Y_BEACON_OFF];
}
NSLog(@"serial: %@\n", [module serialNumber]);
NSLog(@"logical name: %@\n", [module logicalName]);
NSLog(@"luminosity: %d\n", [module luminosity]);
NSLog(@"beacon: ");
if ([module beacon] == Y_BEACON_ON)
NSLog(@"ON\n");
else
NSLog(@"OFF\n");
NSLog(@"upTime: %ld sec\n", [module upTime] / 1000);
NSLog(@"USB current: %d mA\n", [module usbCurrent]);
NSLog(@"logs: %@\n", [module get_lastLogs]);
} else {
NSLog(@"%@ not connected (check identification and USB cable)\n",
serial_or_name);
}
[YAPI FreeAPI];
}
return 0;
}

Chaque propriété xxx du module peut être lue grâce à une méthode du type get_xxxx, et les 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

Modifications des réglages du module

Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction set_xxx: correspondante, cependant cette modification n'a lieu que dans la mémoire vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa 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 revertFromFlash. Ce petit exemple ci-dessous vous permet changer le nom logique d'un module.

#import <Foundation/Foundation.h>
#import "yocto_api.h"

static void usage(const char *exe)
{
NSLog(@"usage: %s <serial> <newLogicalName>\n", exe);
exit(1);
}

int main (int argc, const char * argv[])
{
NSError *error;

@autoreleasepool {
// Setup the API to use local USB devices
if([YAPI RegisterHub:@"usb" :&error] != YAPI_SUCCESS) {
NSLog(@"RegisterHub error: %@", [error localizedDescription]);
return 1;
}

if(argc < 2)
usage(argv[0]);

NSString *serial_or_name = [NSString stringWithUTF8String:argv[1]];
// use serial or logical name
YModule *module = [YModule FindModule:serial_or_name];

if (module.isOnline) {
if (argc >= 3) {
NSString *newname = [NSString stringWithUTF8String:argv[2]];
if (![YAPI CheckLogicalName:newname]) {
NSLog(@"Invalid name (%@)\n", newname);
usage(argv[0]);
}
module.logicalName = newname;
[module saveToFlash];
}
NSLog(@"Current name: %@\n", module.logicalName);
} else {
NSLog(@"%@ not connected (check identification and USB cable)\n",
serial_or_name);
}
[YAPI FreeAPI];
}
return 0;
}

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction saveToFlash que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

#import <Foundation/Foundation.h>
#import "yocto_api.h"

int main (int argc, const char * argv[])
{
NSError *error;

@autoreleasepool {
// Setup the API to use local USB devices
if([YAPI RegisterHub:@"usb" :&error] != YAPI_SUCCESS) {
NSLog(@"RegisterHub error: %@\n", [error localizedDescription]);
return 1;
}

NSLog(@"Device list:\n");

YModule *module = [YModule FirstModule];
while (module != nil) {
NSLog(@"%@ %@", module.serialNumber, module.productName);
module = [module nextModule];
}
[YAPI FreeAPI];
}
return 0;
}

11.3. Gestion des erreurs

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

12. Utilisation du Yocto-Altimeter en VisualBasic .NET

VisualBasic a longtemps été la porte d'entrée privilégiée vers le monde Microsoft. Nous nous devions donc d'offrir notre interface pour ce langage, même si la nouvelle tendance est le C#. Tous les exemples et les modèles de projet sont testés avec Microsoft Visual Basic 2010 Express, disponible gratuitement sur le site de Microsoft ²⁸.

12.1. Installation

Téléchargez la librairie Yoctopuce pour Visual Basic 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. Vous avez besoin essentiellement du contenu du répertoire Sources. Les autres répertoires contiennent la documentation et quelques programmes d'exemple. Les projets d'exemple sont des projets Visual Basic 2010, si vous utilisez une version antérieure, il est possible que vous ayez à reconstruire la structure de ces projets.

12.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 à bas niveau avec les modules³⁰. Les fichiers sources en Visual Basic gèrent la partie haut niveau de l'API. Vous avez donc besoin de cette DLL et des fichiers .vb du répertoire Sources pour créer un projet gérant des modules Yoctopuce.

Configuration d'un projet Visual Basic

Les indications ci-dessous sont fournies pour Visual Studio express 2010, mais la procédure est semblable pour les autres versions.

Commencez par créer votre projet, puis depuis le panneau Explorateur de solutions effectuez un clic droit sur votre projet, et choisissez Ajouter puis Elément existant.

Une fenêtre de sélection de fichiers apparaît: sélectionnez le fichier yocto_api.vb et les fichiers correspondant aux fonctions des modules Yoctopuce que votre projet va gérer. Dans le doute, vous pouvez aussi sélectionner tous les fichiers.

Vous avez alors le choix entre simplement ajouter ces fichiers à votre projet, ou les ajouter en tant que lien (le bouton Ajouter est en fait un menu déroulant). Dans le premier cas, Visual Studio va copier les fichiers choisis dans votre projet, dans le second Visual Studio va simplement garder un lien sur les fichiers originaux. Il est recommandé d'utiliser des liens, une éventuelle mise à jour de la librairie sera ainsi beaucoup plus facile.

Ensuite, ajoutez de la même manière la dll yapi.dll, qui se trouve dans le répertoire Sources/dll³¹. Puis depuis la fenêtre Explorateur de solutions, effectuez un clic droit sur la DLL, choisissez Propriété et dans le panneau Propriétés, mettez l'option Copier dans le répertoire de sortie à toujours copier. Vous êtes maintenant prêt à utiliser vos modules Yoctopuce depuis votre environnement Visual Studio.

Afin de les garder simples, tous les exemples fournis dans cette documentation sont des applications consoles. Il va de soit que que les fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique.

12.3. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction Altitude.

[...]
Dim errmsg As String
Dim altitude As YAltitude

REM On récupère l'objet représentant le module (ici connecté en local sur USB)
yRegisterHub("usb", errmsg)
altitude = yFindAltitude("YALTIMK1-123456.altitude")

REM Pour gérer le hot-plug, on vérifie que le module est là
If (altitude.isOnline()) Then
REM Utiliser altitude.get_currentValue(), ...
End If

Voyons maintenant en détail ce que font ces quelques lignes.

yRegisterHub

yFindAltitude

altitude = yFindAltitude("YALTIMK1-123456.altitude")
altitude = yFindAltitude("YALTIMK1-123456.MaFonction")
altitude = yFindAltitude("MonModule.altitude")
altitude = yFindAltitude("MonModule.MaFonction")
altitude = yFindAltitude("MaFonction")

yFindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode isOnline() de l'objet renvoyé par yFindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par yFindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

yFindTemperature et yFindPressure

Les fonctions yFindTemperature et yFindPressure permettent de travailler respectivement avec les mesures de température et de pression, et se manipulent exactement comme yFindAltitude.

Un exemple réel

Lancez Microsoft VisualBasic et ouvrez le projet exemple correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter 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.

Module Module1

Private Sub Usage()
Dim execname = System.AppDomain.CurrentDomain.FriendlyName
Console.WriteLine("Usage:")
Console.WriteLine(execname + " <serial_number>")
Console.WriteLine(execname + " <logical_name>")
Console.WriteLine(execname + " any ")
System.Threading.Thread.Sleep(2500)

End
End Sub

Sub Main()
Dim argv() As String = System.Environment.GetCommandLineArgs()
Dim errmsg As String = ""
Dim target As String
Dim asensor As YAltitude
Dim tsensor As YTemperature
Dim psensor As YPressure

If argv.Length < 2 Then Usage()

target = argv(1)

REM Setup the API to use local USB devices
If (yRegisterHub("usb", errmsg) <> YAPI_SUCCESS) Then
Console.WriteLine("RegisterHub error: " + errmsg)
End
End If

If target = "any" Then
asensor = yFirstAltitude()
tsensor = yFirstTemperature()
psensor = yFirstPressure()

If asensor Is Nothing Or tsensor Is Nothing Or psensor Is Nothing Then
Console.WriteLine("No module connected (check USB cable) ")
End
End If
Else
asensor = yFindAltitude(target + ".altitude")
tsensor = yFindTemperature(target + ".temperature")
psensor = yFindPressure(target + ".pressure")
End If

While (True)
If Not (asensor.isOnline()) Then
Console.WriteLine("Module not connected (check identification and USB cable)")
End
End If
Console.WriteLine("Current altitude: " + Str(asensor.get_currentValue()) _
+ " m " + "(QNH=" + Str(asensor.get_qnh()) + "hPa)")
Console.WriteLine("Current pressure: " + Str(psensor.get_currentValue()) _
+ " hPa")
Console.WriteLine("Current temperature: " + Str(tsensor.get_currentValue()) _
+ " Â°C")
Console.WriteLine(" (press Ctrl-C to exit)")
ySleep(1000, errmsg)
End While
yFreeAPI()
End Sub

End Module

12.4. Contrôle de la partie module

Imports System.IO
Imports System.Environment

Module Module1

Sub usage()
Console.WriteLine("usage: demo <serial or logical name> [ON/OFF]")
End
End Sub

Sub Main()
Dim argv() As String = System.Environment.GetCommandLineArgs()
Dim errmsg As String = ""
Dim m As ymodule

If (yRegisterHub("usb", errmsg) <> YAPI_SUCCESS) Then
Console.WriteLine("RegisterHub error:" + errmsg)
End
End If

If argv.Length < 2 Then usage()

m = yFindModule(argv(1)) REM use serial or logical name
If (m.isOnline()) Then
If argv.Length > 2 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: " + m.get_serialNumber())
Console.WriteLine("logical name: " + m.get_logicalName())
Console.WriteLine("luminosity: " + Str(m.get_luminosity()))
Console.Write("beacon: ")
If (m.get_beacon() = Y_BEACON_ON) Then
Console.WriteLine("ON")
Else
Console.WriteLine("OFF")
End If
Console.WriteLine("upTime: " + Str(m.get_upTime() / 1000) + " sec")
Console.WriteLine("USB current: " + Str(m.get_usbCurrent()) + " mA")
Console.WriteLine("Logs:")
Console.WriteLine(m.get_lastLogs())
Else
Console.WriteLine(argv(1) + " not connected (check identification and USB cable)")
End If
yFreeAPI()
End Sub

End Module

Modifications des réglages du module

Module Module1

Sub usage()

Console.WriteLine("usage: demo <serial or logical name> <new logical name>")
End
End Sub

Sub Main()
Dim argv() As String = System.Environment.GetCommandLineArgs()
Dim errmsg As String = ""
Dim newname As String
Dim m As YModule

If (argv.Length <> 3) Then usage()

REM Setup the API to use local USB devices
If yRegisterHub("usb", errmsg) <> YAPI_SUCCESS Then
Console.WriteLine("RegisterHub error: " + errmsg)
End
End If

m = yFindModule(argv(1)) REM use serial or logical name
If m.isOnline() Then
newname = argv(2)
If (Not yCheckLogicalName(newname)) Then
Console.WriteLine("Invalid name (" + newname + ")")
End
End If
m.set_logicalName(newname)
m.saveToFlash() REM do not forget this
Console.Write("Module: serial= " + m.get_serialNumber)
Console.Write(" / name= " + m.get_logicalName())
Else
Console.Write("not connected (check identification and USB cable")
End If
yFreeAPI()

End Sub

End Module

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

Obtenir la liste des modules connectés se fait à l'aide de la fonction yFirstModule() qui renvoie le premier module trouvé, il suffit ensuite d'appeler la fonction nextModule() de cet objet pour trouver les modules suivants, et ce tant que la réponse n'est pas un Nothing. Ci-dessous un petit exemple listant les module connectés

Module Module1

Sub Main()
Dim M As ymodule
Dim errmsg As String = ""

REM Setup the API to use local USB devices
If yRegisterHub("usb", errmsg) <> YAPI_SUCCESS Then
Console.WriteLine("RegisterHub error: " + errmsg)
End
End If

Console.WriteLine("Device list")
M = yFirstModule()
While M IsNot Nothing
Console.WriteLine(M.get_serialNumber() + " (" + M.get_productName() + ")")
M = M.nextModule()
End While
yFreeAPI()
End Sub

End Module

12.5. Gestion des erreurs

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

13. Utilisation du Yocto-Altimeter en C#

C# (prononcez C-Sharp) est un langage orienté objet promu par Microsoft qui n'est pas sans rappeller Java. Tout comme Visual Basic et Delphi, il permet de créer des applications Windows relativement facilement. Tous les exemples et les modèles de projet sont testés avec Microsoft C# 2010 Express, disponible gratuitement sur le site de Microsoft ³².

Notre librairie est aussi compatible avec Mono, la version open source de C# qui fonctionne sous Linux et MacOS. Vous trouverez sur notre site web différents articles qui décrivent comment indiquer à Mono comment accéder à notre librairie.

13.1. Installation

Téléchargez la librairie Yoctopuce pour Visual C# 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. Vous avez besoin essentiellement du contenu du répertoire Sources. Les autres répertoires contiennent la documentation et quelques programmes d'exemple. Les projets d'exemple sont des projets Visual C# 2010, si vous utilisez une version antérieure, il est possible que vous ayez à reconstruire la structure de ces projets.

13.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 à bas niveau avec les modules³⁴. Les fichiers sources en Visual C# gèrent la partie haut niveau de l'API. Vous avez donc besoin de cette DLL et des fichiers .cs du répertoire Sources pour créer un projet gérant des modules Yoctopuce.

Configuration d'un projet Visual C#

Les indications ci-dessous sont fournies pour Visual Studio express 2010, mais la procédure est semblable pour les autres versions.

Commencez par créer votre projet, puis depuis le panneau Explorateur de solutions effectuez un clic droit sur votre projet, et choisissez Ajouter puis Elément existant.

Une fenêtre de sélection de fichiers apparaît: sélectionnez le fichier yocto_api.cs et les fichiers correspondant aux fonctions des modules Yoctopuce que votre projet va gérer. Dans le doute, vous pouvez aussi sélectionner tous les fichiers.

Ensuite, ajoutez de la même manière la dll yapi.dll, qui se trouve dans le répertoire Sources/dll³⁵. Puis depuis la fenêtre Explorateur de solutions, effectuez un clic droit sur la DLL, choisissez Propriété et dans le panneau Propriétés, mettez l'option Copier dans le répertoire de sortie à toujours copier. Vous êtes maintenant prêt à utiliser vos modules Yoctopuce depuis votre environnement Visual Studio.

13.3. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code C# qui utilise la fonction Altitude.

[...]
string errmsg = "";
YAltitude altitude;

// On récupère l'objet représentant le module (ici connecté en local sur USB)
YAPI.RegisterHub("usb", errmsg);
altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude");

// Pour gérer le hot-plug, on vérifie que le module est là
if (altitude.isOnline())
{ // Utiliser altitude.get_currentValue(): ...
}

Voyons maintenant en détail ce que font ces quelques lignes.

YAPI.RegisterHub

La fonction YAPI.RegisterHub initialise l'API de Yoctopuce en indiquant où les modules doivent être recherchés. Utilisée avec le paramètre "usb", elle permet de travailler avec les modules connectés localement à la machine. Si l'initialisation se passe mal, cette fonction renverra une valeur différente de YAPI.SUCCESS, et retournera via le paramètre errmsg une explication du problème.

YAltitude.FindAltitude

La fonction YAltitude.FindAltitude, permet de retrouver un altimetre en fonction du numéro de série de son module hôte et de son nom de fonction. Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Altimeter avec le numéros de série YALTIMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction altitude "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute ambiguïté):

altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude");
altitude = YAltitude.FindAltitude("YALTIMK1-123456.MaFonction");
altitude = YAltitude.FindAltitude("MonModule.altitude");
altitude = YAltitude.FindAltitude("MonModule.MaFonction");
altitude = YAltitude.FindAltitude("MaFonction");

YAltitude.FindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode YAltitude.isOnline() de l'objet renvoyé par FindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par YAltitude.FindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

YTemperature.FindTemperature et YPressure.FindPressure

Un exemple réel

Lancez Visual C# et ouvrez le projet exemple correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter 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.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace ConsoleApplication1
{
class Program
{
static void usage()
{
string execname = System.AppDomain.CurrentDomain.FriendlyName;
Console.WriteLine(execname + " <serial_number>");
Console.WriteLine(execname + " <logical_name>");
Console.WriteLine(execname + " any ");
System.Threading.Thread.Sleep(2500);
Environment.Exit(0);
}

static void Main(string[] args)
{
string errmsg = "";
string target;

YAltitude asensor;
YTemperature tsensor;
YPressure psensor;

if (args.Length < 1) usage();
target = args[0].ToUpper();

// Setup the API to use local USB devices
if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) {
Console.WriteLine("RegisterHub error: " + errmsg);
Environment.Exit(0);
}

if (target == "ANY") {
asensor = YAltitude.FirstAltitude();
tsensor = YTemperature.FirstTemperature();
psensor = YPressure.FirstPressure();

if ((asensor == null) || (tsensor == null) || (psensor == null)) {
Console.WriteLine("No module connected (check USB cable) ");
Environment.Exit(0);
}
} else {
asensor = YAltitude.FindAltitude(target + ".altitude");
tsensor = YTemperature.FindTemperature(target + ".temperature");
psensor = YPressure.FindPressure(target + ".pressure");
}

if (!asensor.isOnline()) {
Console.WriteLine("Module not connected");
Console.WriteLine("check identification and USB cable");
Environment.Exit(0);
}
while (asensor.isOnline()) {
Console.WriteLine("Current altitude: " + asensor.get_currentValue().ToString()
+ " m "
+ "(QNH=" + asensor.get_qnh().ToString() + " hPa)");
Console.WriteLine("Current temperature: " + tsensor.get_currentValue().ToString()
+ " Â°C");
Console.WriteLine("Current pressure: " + psensor.get_currentValue().ToString()
+ " hPa");
Console.WriteLine(" (press Ctrl-C to exit)");

YAPI.Sleep(1000, ref errmsg);
}
YAPI.FreeAPI();
}
}
}

13.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 balise de localisation.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace ConsoleApplication1
{
class Program
{
static void usage()
{
string execname = System.AppDomain.CurrentDomain.FriendlyName;
Console.WriteLine("Usage:");
Console.WriteLine(execname + " <serial or logical name> [ON/OFF]");
System.Threading.Thread.Sleep(2500);
Environment.Exit(0);
}

static void Main(string[] args)
{
YModule m;
string errmsg = "";

if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) {
Console.WriteLine("RegisterHub error: " + errmsg);
Environment.Exit(0);
}

if (args.Length < 1) usage();

m = YModule.FindModule(args[0]); // use serial or logical name

if (m.isOnline()) {
if (args.Length >= 2) {
if (args[1].ToUpper() == "ON") {
m.set_beacon(YModule.BEACON_ON);
}
if (args[1].ToUpper() == "OFF") {
m.set_beacon(YModule.BEACON_OFF);
}
}

Console.WriteLine("serial: " + m.get_serialNumber());
Console.WriteLine("logical name: " + m.get_logicalName());
Console.WriteLine("luminosity: " + m.get_luminosity().ToString());
Console.Write("beacon: ");
if (m.get_beacon() == YModule.BEACON_ON)
Console.WriteLine("ON");
else
Console.WriteLine("OFF");
Console.WriteLine("upTime: " + (m.get_upTime() / 1000 ).ToString() + " sec");
Console.WriteLine("USB current: " + m.get_usbCurrent().ToString() + " mA");
Console.WriteLine("Logs:\r\n" + m.get_lastLogs());

} else {
Console.WriteLine(args[0] + " not connected (check identification and USB cable)");
}
YAPI.FreeAPI();
}
}
}

Chaque propriété xxx 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 YModule.set_xxx() Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux chapitre API

Modifications des réglages du module

Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction YModule.set_xxx() correspondante, cependant cette modification n'a lieu que dans la mémoire vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration courante dans sa mémoire non volatile. Pour cela il faut utiliser la méthode YModule.saveToFlash(). Inversement il est possible de forcer le module à oublier ses réglages courants en utilisant la méthode YModule.revertFromFlash(). Ce petit exemple ci-dessous vous permet changer le nom logique d'un module.

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction YModule.saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

Obtenir la liste des modules connectés se fait à l'aide de la fonction YModule.yFirstModule() qui renvoie le premier module trouvé, il suffit ensuite d'appeler la méthode nextModule() de cet objet pour trouver les modules suivants, et ce tant que la réponse n'est pas un null. Ci-dessous un petit exemple listant les module connectés

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace ConsoleApplication1
{
class Program
{
static void Main(string[] args)
{
YModule m;
string errmsg = "";

if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) {
Console.WriteLine("RegisterHub error: " + errmsg);
Environment.Exit(0);
}

Console.WriteLine("Device list");
m = YModule.FirstModule();
while (m != null) {
Console.WriteLine(m.get_serialNumber() + " (" + m.get_productName() + ")");
m = m.nextModule();
}
YAPI.FreeAPI();
}
}
}

13.5. Gestion des erreurs

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

14. Utilisation du Yocto-Altimeter avec Universal Windows Platform

Universal Windows Platform, abrégé UWP, est n'est pas un langage à proprememt parler mais une plate-forme logicielle créée par Micorosft. Cette platform permet d'executer un nouveau type d'applications : les application universelle Windows. Ces applicaiton peuvent fonctionner sur toutes les machines qui fonctione sous Windows 10. Cela comprend les PCs, les tablettes, les smartphones, la XBox One, mais aussi Windows IoT Core.

La librairie Yoctopuce UWP permet d'utiliser les modules Yoctopuce dans une application universelle Winodws et est entièrement écrite C#. Elle peut être ajoutée a un projet Visual Studio 2017³⁶.

14.1. Fonctions bloquantes et fonctions asynchrones

La librairie Universal Windows Platform n'utilise pas l'API win32 mais uniquement l'API Windows Runtime qui est disponible sur toutes les versions de Windows 10 et pour n'importe quelle architecture. Grâce à cela la librairie UWP peut être utilisé sur toutes les versions de Windows 10, y compris Windows 10 IoT Core.

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 Task ou Task<> et le résultat peut être obtenu plus tard. Fort heureusement, le langage C# version 6 supporte les mots-clefs async et await qui simplifie beaucoup l'utilisation de ces fonctions. Il est ainsi possible d'utiliser les fonctions asynchrones de la même manière que les fonctions traditionnelles pour autant que les deux règles suivantes soient respectées:

La méthode est déclarée comme asynchrone à l'aide du mot-clef async
le mot-clef await est ajouté lors de l'utilisation d'une fonction asynchrone

Exemple:

async Task<int> MyFunction(int val)
{
// do some long computation
...

return result;
}

int res = await MyFunction(1234);

Notre librairie suit ces deux règles et peut donc d’utiliser la notation await.

Pour ne pas devoir vous poser la question pour chaque méthode de savoir si elle est asynchrone ou pas, la convention est la suivante: toutes les méthodes publiques de la librairie UWP sont asyncrones, c'est-à-dire qui faut les appeler en ajoutant le mot clef await, sauf:

GetTickCount(), parce que mesurer le temps de manière asynchrone n'a pas beaucoup de sens...
FindModule(), FirstModule(), nextModule(), ... parce que la détection et l'énumération des modules est faite en tâche de fond sur des structures internes qui sont gérées de manière transparente, et qu'il n'est donc pas nécessaire de faire des opérations bloquantes durant le simple parcours de ces listes de modules.

14.2. Installation

Téléchargez la librairie Yoctopuce pour $LANG$ 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. Vous avez besoin essentiellement du contenu du répertoire Sources. Les autres répertoires contiennent la documentation et quelques programmes d'exemple. Les projets d'exemple sont des projets Visual Studio 2017 qui est disponible sur le site de Microsoft ³⁸.

14.3. Utilisation l'API Yoctopuce dans un projet Visual Studio

Commencez par créer votre projet , puis depuis le panneau Explorateur de solutions effectuez un clic droit sur votre projet, et choisissez Ajouter puis Élément existant .

Une fenêtre de sélection de fichiers apparaît: sélectionnez tous les fichiers du répertoire Sources de la librairie.

Le fichier Package.appxmanifest

Par défaut, une application Universal Windows n'a pas le droit d’accéder aux ports USB. Si l'on désire accéder à un périphérique USB, il faut impérativement le déclarer dans le fichier Package.appxmanifest.

Malheureusement, la fenêtre d'édition de ce fichier ne permet pas cette opération et il faut modifier le fichier Package.appxmanifest à la main. Dans le panneau "Solutions Explorer", faites un clic droit sur le fichier Package.appxmanifest et sélectionner "View Code".

Dans ce fichier XML, il faut rajouter un nœud DeviceCapability dans le nœud Capabilities. Ce nœud doit avoir un attribut "Name" qui vaut "humaninterfacedevice".

A l’intérieur de ce nœud, il faut déclarer tous les modules qui peuvent être utilisés. Concrètement, pour chaque module, il faut ajouter un nœud "Device" avec un attribut "Id" dont la valeur est une chaîne de caractères "vidpid:USB_VENDORID USB_DEVICE_ID". Le USB_VENDORID de Yoctopuce est 24e0 et le USB_DEVICE_ID de chaque module Yoctopuce peut être trouvé dans la documentation dans la section "Caractéristiques". Pour finir, le nœud "Device" doit contenir un nœud "Function" avec l'attribut "Type" dont la valeur est "usage:ff00 0001".

Pour le Yocto-Altimeter voici ce qu'il faut ajouter dans le nœud "Capabilities":

Malheureusement, il n'est pas possible d'écrire un règle qui autorise tous les modules Yoctopuce, par conséquent il faut impérativement ajouter chaque module que l'on désire utiliser.

14.4. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code c# qui utilise la fonction Altitude.

[...]

await YAPI.RegisterHub("usb");
altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude");

//Pour gérer le hot-plug, on vérifie que le module est là
if (await altitude.isOnline()) {
//Use altitude.get_currentValue()
...
}

[...]

Voyons maintenant en détail ce que font ces quelques lignes.

YAPI.RegisterHub

La fonction YAPI.RegisterHub initialise l'API de Yoctopuce en indiquant où les modules doivent être recherchés. Le paramètre est l'adresse du virtual hub capable de voir les modules. Si l'on passe la chaîne de caractère "usb", l'API va travailler avec les modules connectés localement à la machine. Si l'initialisation se passe mal, une exception sera générée.

YAltitude.FindAltitude

La fonction YAltitude.FindAltitude permet de retrouver un altimetre en fonction du numéro de série de son module hôte et de son nom de fonction. Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Altimeter avec le numéros de série YALTIMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction altitude "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute ambiguïté):

YAltitude.FindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode YAltitude.isOnline() de l'objet renvoyé par FindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par YAltitude.FindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

YTemperature.FindTemperature et YPressure.FindPressure

14.5. Un exemple concret

Lancez Visual Studio et ouvrez le projet correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter de la librairie Yoctopuce.

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 Demo qui se trouve dans le fichier demo.cs. Les propriétés de cette classe correspondent aux différentes champs qui sont affichés à l'écran, et la méthode Run() contient le code qui est exécuté quand le bouton "Start" est pressé.

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.

using System;
using System.Diagnostics;
using System.Threading.Tasks;
using Windows.UI.Xaml.Controls;
using com.yoctopuce.YoctoAPI;

namespace Demo
{
public class Demo : DemoBase
{
public string HubURL { get; set; }
public string Target { get; set; }

public override async Task<int> Run()
{
try {
await YAPI.RegisterHub(HubURL);
YAltitude asensor;
YTemperature tsensor;
YPressure psensor;

if (Target.ToLower() == "any") {
asensor = YAltitude.FirstAltitude();
tsensor = YTemperature.FirstTemperature();
psensor = YPressure.FirstPressure();

if ((asensor == null) || (tsensor == null) || (psensor == null)) {
WriteLine("No module connected (check USB cable) ");
return -1;
}
} else {
asensor = YAltitude.FindAltitude(Target + ".altitude");
tsensor = YTemperature.FindTemperature(Target + ".temperature");
psensor = YPressure.FindPressure(Target + ".pressure");
}
while (await asensor.isOnline()) {
WriteLine("Altitude: " + await asensor.get_currentValue() + " m " +
"(QNH=" +
await asensor.get_qnh() + " hPa)");
WriteLine("Temperature: " + await tsensor.get_currentValue() + " Â°C");
WriteLine("Pressure: " + await psensor.get_currentValue() + " hPa");
await YAPI.Sleep(1000);
}
WriteLine("Module not connected (check identification and USB cable)");
} catch (YAPI_Exception ex) {
WriteLine("error: " + ex.Message);
}

YAPI.FreeAPI();
return 0;
}
}
}

14.6. Contrôle de la partie module

using System;
using System.Diagnostics;
using System.Threading.Tasks;
using Windows.UI.Xaml.Controls;
using com.yoctopuce.YoctoAPI;

namespace Demo
{
public class Demo : DemoBase
{

public string HubURL { get; set; }
public string Target { get; set; }
public bool Beacon { get; set; }

public override async Task<int> Run()
{
YModule m;
string errmsg = "";

if (await YAPI.RegisterHub(HubURL) != YAPI.SUCCESS) {
WriteLine("RegisterHub error: " + errmsg);
return -1;
}
m = YModule.FindModule(Target + ".module"); // use serial or logical name
if (await m.isOnline()) {
if (Beacon) {
await m.set_beacon(YModule.BEACON_ON);
} else {
await m.set_beacon(YModule.BEACON_OFF);
}

WriteLine("serial: " + await m.get_serialNumber());
WriteLine("logical name: " + await m.get_logicalName());
WriteLine("luminosity: " + await m.get_luminosity());
Write("beacon: ");
if (await m.get_beacon() == YModule.BEACON_ON)
WriteLine("ON");
else
WriteLine("OFF");
WriteLine("upTime: " + (await m.get_upTime() / 1000) + " sec");
WriteLine("USB current: " + await m.get_usbCurrent() + " mA");
WriteLine("Logs:\r\n" + await m.get_lastLogs());
} else {
WriteLine(Target + " not connected on" + HubURL +
"(check identification and USB cable)");
}
YAPI.FreeAPI();
return 0;
}
}
}

Modifications des réglages du module

using System;
using System.Diagnostics;
using System.Threading.Tasks;
using Windows.UI.Xaml.Controls;
using com.yoctopuce.YoctoAPI;

namespace Demo
{
public class Demo : DemoBase
{

public string HubURL { get; set; }
public string Target { get; set; }
public string LogicalName { get; set; }

public override async Task<int> Run()
{
try {
YModule m;

await YAPI.RegisterHub(HubURL);

m = YModule.FindModule(Target); // use serial or logical name
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= " + await m.get_logicalName());
} else {
Write("not connected (check identification and USB cable");
}
} catch (YAPI_Exception ex) {
WriteLine("RegisterHub error: " + ex.Message);
}
YAPI.FreeAPI();
return 0;
}
}
}

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction YModule.saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

14.7. Gestion des erreurs

Dans la librairie Universal Windows Platform, le traitement d'erreur est implémenté au moyen d'exceptions. Vous devrez donc intercepter et traiter correctement ces exceptions si vous souhaitez avoir un projet fiable qui ne crashera pas des que vous débrancherez un module.

Les exceptions lancées de la librairie sont toujours de type YAPI_Exception, ce qui permet facilement de les séparer des autres exceptions dans un bloc try{...} catch{...}.

Exemple:

try {
....
} catch (YAPI_Exception ex) {
Debug.WriteLine("Exception from Yoctopuce lib:" + ex.Message);
} catch (Exception ex) {
Debug.WriteLine("Other exceptions :" + ex.Message);
}

15. Utilisation du Yocto-Altimeter en Delphi

Delphi est l'héritier de Turbo-Pascal. A l'origine, Delphi était produit par Borland, mais c'est maintenant Embarcadero qui l'édite. Sa force réside dans sa facilité d'utilisation, il permet à quiconque ayant des notions de Pascal de programmer une application Windows en deux temps trois mouvements. Son seul défaut est d'être payant³⁹.

Les librairies pour Delphi sont fournies non pas sous forme de composants VCL, mais directement sous forme de fichiers source. Ces fichiers sont compatibles avec la plupart des version de Delphi ⁴⁰.

Afin des les garder simples, tous les exemples fournis dans cette documentation sont des applications consoles. Il va de soit que le fonctionnement des librairies est strictement identique avec des applications VCL.

Vous allez rapidement vous rendre compte que l'API Delphi défini beaucoup de fonctions qui retournent des objets. Vous ne devez jamais désallouer ces objets vous-même. Ils seront désalloués automatiquement par l'API à la fin de l'application.

15.1. Préparation

Connectez-vous sur le site de Yoctopuce et téléchargez la la librairie Yoctopuce pour Delphi⁴¹. Décompressez le tout dans le répertoire de votre choix, et ajoutez le sous-répertoire sources de l'archive dans la liste des répertoires des librairies de 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.

15.2. Contrôle de la fonction Altitude

Lancez votre environnement Delphi, copiez la DLL yapi.dll dans un répertoire et créez une nouvelle application console dans ce même répertoire, et copiez-coller le code ci dessous.

program helloworld;
{$APPTYPE CONSOLE}
uses
SysUtils,
Windows,
yocto_api,
yocto_altitude,
yocto_temperature,
yocto_pressure;

Procedure Usage();
var
exe : string;

begin
exe:= ExtractFileName(paramstr(0));
WriteLn(exe+' <serial_number>');
WriteLn(exe+' <logical_name>');
WriteLn(exe+' any');
halt;
End;

var
asensor : TYAltitude;
tsensor : TYTemperature;
psensor : TYPressure;
m : TYModule;
errmsg,serial : string;
done : boolean;

begin
if (paramcount<1) then usage();

// Setup the API to use local USB devices
if yRegisterHub('usb', errmsg)<>YAPI_SUCCESS then
begin
Write('RegisterHub error: '+errmsg);
exit;
end;

if paramstr(1)='any' then
begin
// lets try to find the first available altitude sensor
asensor := yFirstAltitude();
if asensor=nil then
begin
writeln('No module connected (check USB cable)');
halt;
end
end
else
// or the one specified on command line
asensor:= YFindAltitude(paramstr(1)+'.altitude');

// make sure it is online
if not asensor.isOnline() then
begin
writeln('No module connected (check USB cable)');
halt;
end;

// lets find the parent module so we can get the other sensors
m := asensor.get_module();
serial := m.get_serialNumber();

// retreive all sensor present on the yocto-meteo
asensor := yFindAltitude(serial+'.altitude');
tsensor := yFindTemperature(serial+'.temperature');
psensor := yFindPressure(serial+'.pressure');

// let's poll
done := false;
repeat
if (asensor.isOnline()) then
begin
Writeln('Curr altitude: '+FloatToStr(asensor.get_currentValue())+' m ' +
'(QNH='+FloatToStr(asensor.get_qnh())+' hPa)');
Writeln('Curr temperature: '+FloatToStr(tsensor.get_currentValue())+' deg C');
Writeln('Curr pressure: '+FloatToStr(psensor.get_currentValue())+' hPa');
Writeln(' (press Ctrl-C to exit)');
Writeln('');
Sleep(1000);
end
else
begin
Writeln('Module not connected (check identification and USB cable)');
done := true;
end;
until done;
yFreeAPI();
end.

Il n'y a que peu de lignes véritablement importantes dans le code précédent. Nous allons les expliquer en détail.

yocto_api et yocto_altitude

Ces deux unités permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. yocto_api doit toujours être utilisé, yocto_altitude est nécessaire pour gérer les modules contenant un altimetre, comme le Yocto-Altimeter.

yRegisterHub

La fonction yRegisterHub initialise l'API de Yoctopuce en indiquant où les modules doivent être recherchés. Utilisée avec le paramètre 'usb', elle permet de travailler avec les modules connectés localement à la machine. Si l'initialisation se passe mal, cette fonction renverra une valeur différente de YAPI_SUCCESS, et retournera via le paramètre errmsg un explication du problème.

yFindAltitude

altitude := yFindAltitude("YALTIMK1-123456.altitude");
altitude := yFindAltitude("YALTIMK1-123456.MaFonction");
altitude := yFindAltitude("MonModule.altitude");
altitude := yFindAltitude("MonModule.MaFonction");
altitude := yFindAltitude("MaFonction");

yFindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode isOnline() de l'objet renvoyé par yFindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par yFindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

yFindTemperature et yFindPressure

Les fonctions yFindTemperature et yFindPressure permettent de travailler respectivement avec les mesures de température et de pression, et se manipulent exactement comme yFindAltitude.

15.3. Contrôle de la partie module

program modulecontrol;
{$APPTYPE CONSOLE}
uses
SysUtils,
yocto_api;

const
serial = 'YALTIMK1-123456'; // use serial number or logical name

procedure refresh(module:Tymodule) ;
begin
if (module.isOnline()) then
begin
Writeln('');
Writeln('Serial : ' + module.get_serialNumber());
Writeln('Logical name : ' + module.get_logicalName());
Writeln('Luminosity : ' + intToStr(module.get_luminosity()));
Write('Beacon :');
if (module.get_beacon()=Y_BEACON_ON) then Writeln('on')
else Writeln('off');
Writeln('uptime : ' + intToStr(module.get_upTime() div 1000)+'s');
Writeln('USB current : ' + intToStr(module.get_usbCurrent())+'mA');
Writeln('Logs : ');
Writeln(module.get_lastlogs());
Writeln('');
Writeln('r : refresh / b:beacon ON / space : beacon off');
end
else Writeln('Module not connected (check identification and USB cable)');
end;

procedure beacon(module:Tymodule;state:integer);
begin
module.set_beacon(state);
refresh(module);
end;

var
module : TYModule;
c : char;
errmsg : string;

begin
// Setup the API to use local USB devices
if yRegisterHub('usb', errmsg)<>YAPI_SUCCESS then
begin
Write('RegisterHub error: '+errmsg);
exit;
end;

module := yFindModule(serial);
refresh(module);

repeat
read(c);
case c of
'r': refresh(module);
'b': beacon(module,Y_BEACON_ON);
' ': beacon(module,Y_BEACON_OFF);
end;
until c = 'x';
yFreeAPI();
end.

Modifications des réglages du module

program savesettings;
{$APPTYPE CONSOLE}
uses
SysUtils,
yocto_api;

const
serial = 'YALTIMK1-123456'; // use serial number or logical name

var
module : TYModule;
errmsg : string;
newname : string;

begin
// Setup the API to use local USB devices
if yRegisterHub('usb', errmsg)<>YAPI_SUCCESS then
begin
Write('RegisterHub error: '+errmsg);
exit;
end;

module := yFindModule(serial);
if (not(module.isOnline)) then
begin
writeln('Module not connected (check identification and USB cable)');
exit;
end;

Writeln('Current logical name : '+module.get_logicalName());
Write('Enter new name : ');
Readln(newname);
if (not(yCheckLogicalName(newname))) then
begin
Writeln('invalid logical name');
exit;
end;
module.set_logicalName(newname);
module.saveToFlash();
yFreeAPI();
Writeln('logical name is now : '+module.get_logicalName());
end.

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Énumération des modules

Obtenir la liste des modules connectés se fait à l'aide de la fonction yFirstModule() qui renvoie le premier module trouvé, il suffit ensuite d'appeler la fonction nextModule() de cet objet pour trouver les modules suivants, et ce tant que la réponse n'est pas un nil. Ci-dessous un petit exemple listant les module connectés

program inventory;
{$APPTYPE CONSOLE}
uses
SysUtils,
yocto_api;

var
module : TYModule;
errmsg : string;

begin
// Setup the API to use local USB devices
if yRegisterHub('usb', errmsg)<>YAPI_SUCCESS then
begin
Write('RegisterHub error: '+errmsg);
exit;
end;

Writeln('Device list');

module := yFirstModule();
while module<>nil do
begin
Writeln( module.get_serialNumber()+' ('+module.get_productName()+')');
module := module.nextModule();
end;
yFreeAPI();

end.

15.4. Gestion des erreurs

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

16. Utilisation du Yocto-Altimeter en Python

Python est un langage interprété orienté objet développé par Guido van Rossum. Il offre l'avantage d'être gratuit et d'être disponible pour la plupart de plate-formes tant 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. La librairie a été testée avec Python 2.6 et Python 3.2. Les interpréteurs Python sont disponibles sur le site de Python ⁴³.

16.1. Fichiers sources

Les classes de la librairie Yoctopuce⁴⁴ pour Python que vous utiliserez vous sont fournies au format source. Copiez tout le contenu du répertoire Sources dans le répertoire de votre choix et ajoutez ce répertoire à la variable d'environnement PYTHONPATH. Si vous utilisez un IDE pour programmer en Python, référez-vous à sa documentation afin le configurer de manière à ce qu'il retrouve automatiquement les fichiers sources de l'API.

16.2. Librairie dynamique

Une partie de la librairie de bas-niveau est écrite en C, mais vous n'aurez a priori pas besoin d'interagir directement avec elle: cette partie est fournie sous forme de DLL sous Windows, de fichier .so sous Unix et de fichier .dylib sous Mac OS X. Tout a été fait pour que l'interaction avec cette librairie se fasse aussi simplement que possible depuis Python: les différentes versions de la librairie dynamique correspondant aux différents systèmes d'exploitation et architectures sont stockées dans le répertoire cdll. L'API va charger automatiquement le bon fichier lors de son initialisation. Vous n'aurez donc pas à vous en soucier.

Si un jour vous deviez vouloir recompiler la librairie dynamique, vous trouverez tout son code source dans la librairie Yoctopuce pour le C++.

Afin de les garder simples, tous les exemples fournis dans cette documentation sont des applications consoles. 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.

16.3. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code Python qui utilise la fonction Altitude.

[...]

errmsg=YRefParam()
#On récupère l'objet représentant le module (ici connecté en local sur USB)
YAPI.RegisterHub("usb",errmsg)
altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude")

#Pour gérer le hot-plug, on vérifie que le module est là
if altitude.isOnline():
#Use altitude.get_currentValue()
...

[...]

Voyons maintenant en détail ce que font ces quelques lignes.

YAPI.RegisterHub

YAltitude.FindAltitude

YAltitude.FindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode YAltitude.isOnline() de l'objet renvoyé par FindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par YAltitude.FindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

YTemperature.FindTemperature et YPressure.FindPressure

Un exemple réel

Lancez votre interpréteur Python et ouvrez le script correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter 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.

#!/usr/bin/python
# -*- coding: utf-8 -*-
import os, sys

from yocto_api import *
from yocto_altitude import *
from yocto_temperature import *
from yocto_pressure import *

def usage():
scriptname = os.path.basename(sys.argv[0])
print("Usage:")
print(scriptname + ' <serial_number>')
print(scriptname + ' <logical_name>')
print(scriptname + ' any ')
sys.exit()

def die(msg):
sys.exit(msg + ' (check USB cable)')

errmsg = YRefParam()

if len(sys.argv) < 2:
usage()

target = sys.argv[1]

# Setup the API to use local USB devices
if YAPI.RegisterHub("usb", errmsg) != YAPI.SUCCESS:
sys.exit("init error" + errmsg.value)

if target == 'any':
# retreive any altitude sensor
sensor = YAltitude.FirstAltitude()
if sensor is None:
die('No module connected')
m = sensor.get_module()
target = m.get_serialNumber()

else:
m = YModule.FindModule(target)

if not m.isOnline():
die('device not connected')

altSensor = YAltitude.FindAltitude(target + '.altitude')
pressSensor = YPressure.FindPressure(target + '.pressure')
tempSensor = YTemperature.FindTemperature(target + '.temperature')

while altSensor.isOnline():
print("%4.1f" % altSensor.get_currentValue() + "m (QNH=" \
+ "%4.1f" % altSensor.get_qnh() + "hPa) " \
+ "%4.1f" % pressSensor.get_currentValue() + "hPa " \
+ "%2.0f" % tempSensor.get_currentValue() + "deg C " \
+ "(Ctrl-c to stop) ")
YAPI.Sleep(1000)
YAPI.FreeAPI()

16.4. Contrôle de la partie module

#!/usr/bin/python
# -*- coding: utf-8 -*-
import os, sys

from yocto_api import *

def usage():
sys.exit("usage: demo <serial or logical name> [ON/OFF]")

errmsg = YRefParam()
if YAPI.RegisterHub("usb", errmsg) != YAPI.SUCCESS:
sys.exit("RegisterHub error: " + str(errmsg))

if len(sys.argv) < 2:
usage()

m = YModule.FindModule(sys.argv[1]) # # use serial or logical name

if m.isOnline():
if len(sys.argv) > 2:
if sys.argv[2].upper() == "ON":
m.set_beacon(YModule.BEACON_ON)
if sys.argv[2].upper() == "OFF":
m.set_beacon(YModule.BEACON_OFF)

print("serial: " + m.get_serialNumber())
print("logical name: " + m.get_logicalName())
print("luminosity: " + str(m.get_luminosity()))
if m.get_beacon() == YModule.BEACON_ON:
print("beacon: ON")
else:
print("beacon: OFF")
print("upTime: " + str(m.get_upTime() / 1000) + " sec")
print("USB current: " + str(m.get_usbCurrent()) + " mA")
print("logs:\n" + m.get_lastLogs())
else:
print(sys.argv[1] + " not connected (check identification and USB cable)")
YAPI.FreeAPI()

Modifications des réglages du module

#!/usr/bin/python
# -*- coding: utf-8 -*-
import os, sys

from yocto_api import *

def usage():
sys.exit("usage: demo <serial or logical name> <new logical name>")

if len(sys.argv) != 3:
usage()

errmsg = YRefParam()
if YAPI.RegisterHub("usb", errmsg) != YAPI.SUCCESS:
sys.exit("RegisterHub error: " + str(errmsg))

m = YModule.FindModule(sys.argv[1]) # use serial or logical name
if m.isOnline():
newname = sys.argv[2]
if not YAPI.CheckLogicalName(newname):
sys.exit("Invalid name (" + newname + ")")
m.set_logicalName(newname)
m.saveToFlash() # do not forget this
print("Module: serial= " + m.get_serialNumber() + " / name= " + m.get_logicalName())
else:
sys.exit("not connected (check identification and USB cable")
YAPI.FreeAPI()

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction YModule.saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

Obtenir la liste des modules connectés se fait à l'aide de la fonction YModule.yFirstModule() qui renvoie le premier module trouvé, il suffit ensuite d'appeler la mehode nextModule() de cet objet pour trouver les modules suivants, et ce tant que la réponse n'est pas un null. Ci-dessous un petit exemple listant les module connectés

#!/usr/bin/python
# -*- coding: utf-8 -*-
import os, sys

from yocto_api import *

errmsg = YRefParam()

# Setup the API to use local USB devices
if YAPI.RegisterHub("usb", errmsg) != YAPI.SUCCESS:
sys.exit("init error" + str(errmsg))

print('Device list')

module = YModule.FirstModule()
while module is not None:
print(module.get_serialNumber() + ' (' + module.get_productName() + ')')
module = module.nextModule()
YAPI.FreeAPI()

16.5. Gestion des erreurs

Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
Si votre programme tourne dans le debugger, vous pourrez relativement facilement déterminer où le problème s'est produit, et voir le message explicatif lié à l'exception.
Sinon... l'exception va crasher votre programme, boum!

17. Utilisation du Yocto-Altimeter en Java

Java est un langage orienté objet développé par Sun Microsystem. Son principal avantage est la portabilité, mais cette portabilité a un coût. Java fait une telle abstraction des couches matérielles qu'il est très difficile d'interagir directement avec elles. C'est pourquoi l'API java standard de Yoctopuce ne fonctionne pas en natif: elle doit passer par l'intermédiaire d'un VirtualHub pour pouvoir communiquer avec les modules Yoctopuce.

17.1. Préparation

Connectez vous sur le site de Yoctopuce et téléchargez les éléments suivants:

La librairie de programmation pour Java⁴⁵
Le programme VirtualHub⁴⁶ pour Windows, Mac OS X ou Linux selon l'OS que vous utilisez

La librairie est disponible en fichier sources, mais elle aussi disponible sous la forme d'un fichier jar. Branchez vos modules, Décompressez les fichiers de la librairie dans un répertoire de votre choix. Lancez le programme VirtualHub, et vous pouvez commencer vos premiers test. Vous n'avez pas besoin d'installer de driver.

17.2. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code Java qui utilise la fonction Altitude.

[...]

// On récupère l'objet représentant le module (ici connecté en local sur USB)
YAPI.RegisterHub("127.0.0.1");
altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude");

// Pour gérer le hot-plug, on vérifie que le module est là
if (altitude.isOnline())
{
// Utiliser altitude.get_currentValue()
[...]
}

[...]

Voyons maintenant en détail ce que font ces quelques lignes.

YAPI.RegisterHub

YAltitude.FindAltitude

YAltitude.FindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode YAltitude.isOnline() de l'objet renvoyé par FindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par YAltitude.FindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

YTemperature.FindTemperature et YPressure.FindPressure

Un exemple réel

Lancez votre environnement java et ouvrez le projet correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Altimeter 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.

import com.yoctopuce.YoctoAPI.*;

public class Demo {

public static void main(String[] args)
{
try {
// setup the API to use local VirtualHub
YAPI.RegisterHub("127.0.0.1");
} catch (YAPI_Exception ex) {
System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" + ex.getLocalizedMessage() + ")");
System.out.println("Ensure that the VirtualHub application is running");
System.exit(1);
}

YAltitude asensor;
YTemperature tsensor;
YPressure psensor;

if (args.length == 0) {
asensor = YAltitude.FirstAltitude();
tsensor = YTemperature.FirstTemperature();
psensor = YPressure.FirstPressure();
if (asensor == null || tsensor == null || psensor == null) {
System.out.println("No module connected (check USB cable)");
System.exit(1);
}
} else {
asensor = YAltitude.FindAltitude(args[0] + ".altitude");
tsensor = YTemperature.FindTemperature(args[0] + ".temperature");
psensor = YPressure.FindPressure(args[0] + ".pressure");
}

while (true) {
try {
System.out.println("Current altitude: " + asensor.get_currentValue() + " m "
+"(QNH=" + asensor.get_qnh() + " hpa)");
System.out.println("Current temperature: " + tsensor.get_currentValue() + " Â°C");
System.out.println("Current pressure: " + psensor.get_currentValue() + " hPa");
System.out.println(" (press Ctrl-C to exit)");
YAPI.Sleep(1000);
} catch (YAPI_Exception ex) {
System.out.println("Module not connected (check identification and USB cable)");
break;
}
}
YAPI.FreeAPI();
}
}

17.3. Contrôle de la partie module

import com.yoctopuce.YoctoAPI.*;
import java.util.logging.Level;
import java.util.logging.Logger;

public class Demo {

public static void main(String[] args)
{
try {
// setup the API to use local VirtualHub
YAPI.RegisterHub("127.0.0.1");
} catch (YAPI_Exception ex) {
System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" + ex.getLocalizedMessage() + ")");
System.out.println("Ensure that the VirtualHub application is running");
System.exit(1);
}
System.out.println("usage: demo [serial or logical name] [ON/OFF]");

YModule module;
if (args.length == 0) {
module = YModule.FirstModule();
if (module == null) {
System.out.println("No module connected (check USB cable)");
System.exit(1);
}
} else {
module = YModule.FindModule(args[0]); // use serial or logical name
}

try {
if (args.length > 1) {
if (args[1].equalsIgnoreCase("ON")) {
module.setBeacon(YModule.BEACON_ON);
} else {
module.setBeacon(YModule.BEACON_OFF);
}
}
System.out.println("serial: " + module.get_serialNumber());
System.out.println("logical name: " + module.get_logicalName());
System.out.println("luminosity: " + module.get_luminosity());
if (module.get_beacon() == YModule.BEACON_ON) {
System.out.println("beacon: ON");
} else {
System.out.println("beacon: OFF");
}
System.out.println("upTime: " + module.get_upTime() / 1000 + " sec");
System.out.println("USB current: " + module.get_usbCurrent() + " mA");
System.out.println("logs:\n" + module.get_lastLogs());
} catch (YAPI_Exception ex) {
System.out.println(args[1] + " not connected (check identification and USB cable)");
}
YAPI.FreeAPI();
}
}

Modifications des réglages du module

import com.yoctopuce.YoctoAPI.*;

public class Demo {

public static void main(String[] args)
{
try {
// setup the API to use local VirtualHub
YAPI.RegisterHub("127.0.0.1");
} catch (YAPI_Exception ex) {
System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" + ex.getLocalizedMessage() + ")");
System.out.println("Ensure that the VirtualHub application is running");
System.exit(1);
}

if (args.length != 2) {
System.out.println("usage: demo <serial or logical name> <new logical name>");
System.exit(1);
}

YModule m;
String newname;

m = YModule.FindModule(args[0]); // use serial or logical name

try {
newname = args[1];
if (!YAPI.CheckLogicalName(newname))
{
System.out.println("Invalid name (" + newname + ")");
System.exit(1);
}

m.set_logicalName(newname);
m.saveToFlash(); // do not forget this

System.out.println("Module: serial= " + m.get_serialNumber());
System.out.println(" / name= " + m.get_logicalName());
} catch (YAPI_Exception ex) {
System.out.println("Module " + args[0] + "not connected (check identification and USB cable)");
System.out.println(ex.getMessage());
System.exit(1);
}

YAPI.FreeAPI();
}
}

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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction YModule.saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

17.4. Gestion des erreurs

Dans l'API java, le traitement d'erreur est implémenté au moyen d'exceptions. Vous devrez donc intercepter et traiter correctement ces exceptions si vous souhaitez avoir un projet fiable qui ne crashera pas des que vous débrancherez un module.

18. Utilisation du Yocto-Altimeter avec Android

A vrai dire, Android n'est pas un langage de programmation, c'est un système d'exploitation développé par Google pour les appareils portables tels que smart phones et tablettes. Mais il se trouve que sous Android tout est programmé avec le même langage de programmation: Java. En revanche les paradigmes de programmation et les possibilités d'accès au hardware sont légèrement différentes par rapport au Java classique, ce qui justifie un chapitre à part sur la programmation Android.

18.1. Accès Natif et Virtual Hub.

Contrairement à l'API Java classique, l'API Java pour Android accède aux modules USB de manière native. 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.

18.2. Préparation

Connectez-vous sur le site de Yoctopuce et téléchargez la librairie de programmation pour Java pour Android⁴⁷. La librairie est disponible en fichiers sources, mais elle aussi disponible sous la forme d'un fichier jar. Branchez vos modules, décompressez les fichiers de la librairie dans le répertoire de votre choix. Et configurez votre environnement de programmation Android pour qu'il puisse les trouver.

Afin de les garder simples, tous les exemples fournis dans cette documentation sont des fragments d'application Android. Vous devrez les intégrer dans vos propres applications Android pour les faire fonctionner. En revanche vous pourrez trouver des applications complètes dans les exemples fournis avec la librairie Java pour Android.

18.3. Compatibilité

Dans un monde idéal, il suffirait d'avoir un téléphone sous Android pour pouvoir faire fonctionner des modules Yoctopuce. Malheureusement, la réalité est légèrement différente, un appareil tournant sous Android doit répondre à un certain nombre d'exigences pour pouvoir faire fonctionner des modules USB Yoctopuce en natif.

Android 4.x

Android 4.0 (api 14) et suivants sont officiellement supportés. Théoriquement le support USB host fonctionne depuis Android 3.1. Mais sachez que Yoctopuce ne teste régulièrement l'API Java pour Android qu'à partir de Android 4.

Support USB host

Il faut bien sûr que votre machine dispose non seulement d'un port USB, mais il faut aussi que ce port soit capable de tourner en mode host. En mode host, la machine prend littéralement le contrôle des périphériques qui lui sont raccordés. Les ports USB d'un ordinateur bureau, par exemple, fonctionnent mode host. Le pendant du mode host est le mode device. Les clefs USB par exemple fonctionnent en mode device: elles ne peuvent qu'être contrôlées par un host. Certains ports USB sont capables de fonctionner dans les deux modes, ils s'agit de ports OTG (On The Go). Il se trouve que beaucoup d'appareils portables ne fonctionnent qu'en mode "device": ils sont conçus pour être branchés à chargeur ou un ordinateur de bureau, rien de plus. Il est donc fortement recommandé de lire attentivement les spécifications techniques d'un produit fonctionnant sous Android avant d'espérer le voir fonctionner avec des modules Yoctopuce.

Disposer d'une version correcte d'Android et de ports USB fonctionnant en mode host ne suffit malheureusement pas pour garantir un bon fonctionnement avec des modules Yoctopuce sous Android. En effet certains constructeurs configurent leur image Android afin que les périphériques autres que clavier et mass storage soit ignorés, et cette configuration est difficilement détectable. En l'état actuel des choses, le meilleur moyen de savoir avec certitude si un matériel Android spécifique fonctionne avec les modules Yoctopuce consiste à essayer.

Matériel supporté

La librairie est testée et validée sur les machines suivantes:

Samsung Galaxy S3
Samsung Galaxy Note 2
Google Nexus 5
Google Nexus 7
Acer Iconia Tab A200
Asus Tranformer Pad TF300T
Kurio 7

Si votre machine Android n'est pas capable de faire fonctionner nativement des modules Yoctopuce, il vous reste tout de même la possibilité de contrôler à distance des modules pilotés par un VirtualHub sur un autre OS ou un YoctoHub⁴⁸.

18.4. Activer le port USB sous Android

Par défaut Android n’autorise pas une application à accéder aux périphériques connectés au port USB. Pour que votre application puisse interagir avec un module Yoctopuce branché directement sur votre tablette sur un port USB quelques étapes supplémentaires sont nécessaires. Si vous comptez uniquement interagir avec des modules connectés sur une autre machine par IP, vous pouvez ignorer cette section.

Il faut déclarer dans son AndroidManifest.xml l'utilisation de la fonctionnalité "USB Host" en ajoutant le tag <uses-feature android:name="android.hardware.usb.host" /> dans la section 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’accès au périphérique. Si l'utilisateur accepte, l'application pourra accéder au périphérique connecté jusqu'à la prochaine déconnexion du périphérique. Pour que la librairie Yoctopuce puisse gérer correctement ces autorisations, il faut lui fournir un pointeur sur le contexte de l'application en appelant la méthode EnableUSBHost de la classe YAPI avant le premier accès USB. Cette fonction prend en argument un objet de la classe android.content.Context (ou d'une sous-classe). Comme la classe Activity est une sous-classe de Context, le plus simple est de d'appeler YAPI.EnableUSBHost(this); dans la méthode onCreate de votre application. Si l'objet passé en paramètre n'est pas du bon type, une exception YAPI_Exception sera générée.

...
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
try {
// Pass the application Context to the Yoctopuce Library
YAPI.EnableUSBHost(this);
} catch (YAPI_Exception e) {
Log.e("Yocto",e.getLocalizedMessage());
}
}
...

Lancement automatique

Il est possible d'enregistrer son application comme application par défaut pour un module USB, dans ce cas des qu'un module sera connecté au système, l'application sera lancée automatiquement. Il faut ajouter <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"/> dans la section <intent-filter> de l'activité principale. La section <activity> doit contenir un pointeur sur un fichier xml qui contient la liste des modules USB qui peuvent lancer l'application.

Le fichier XML qui contient la liste des modules qui peuvent lancer l'application doit être sauvé dans le répertoire res/xml. Ce fichier contient une liste de vendorId et deviceID USB en décimal. L'exemple suivant lance l'application dès qu'un Yocto-Relay ou un Yocto-PowerRelay est connecté. Vous pouvez trouver le vendorId et deviceId des modules Yoctopuce dans la section caractéristiques de la documentation.

<?xml version="1.0" encoding="utf-8"?>

<resources>
<usb-device vendor-id="9440" product-id="12" />
<usb-device vendor-id="9440" product-id="13" />
</resources>

18.5. Contrôle de la fonction Altitude

Il suffit de quelques lignes de code pour piloter un Yocto-Altimeter. Voici le squelette d'un fragment de code Java qui utilise la fonction Altitude.

[...]

// On récupère l'objet représentant le module (ici connecté en local sur USB)
YAPI.EnableUSBHost(this);
YAPI.RegisterHub("usb");
altitude = YAltitude.FindAltitude("YALTIMK1-123456.altitude");

//Pour gérer le hot-plug, on vérifie que le module est là
if (altitude.isOnline())
{ //Use altitude.get_currentValue()
...
}

[...]

Voyons maintenant en détail ce que font ces quelques lignes.

YAPI.EnableUSBHost

La fonction YAPI.EnableUSBHost initialise l'API avec le Context de l'application courante. Cette fonction prend en argument un objet de la classe android.content.Context (ou d'une sous-classe). Si vous comptez uniquement vous connecter à d'autres machines par IP vous cette fonction est factultative.

YAPI.RegisterHub

La fonction YAPI.RegisterHub initialise l'API de Yoctopuce en indiquant où les modules doivent être recherchés. Le paramètre est l'adresse du virtual hub capable de voir les modules. Si l'on passe la chaine de caractère "usb", l'API va travailler avec les modules connectés localement à la machine. Si l'initialisation se passe mal, une exception sera générée.

YAltitude.FindAltitude

YAltitude.FindAltitude renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler l'altimètre.

isOnline

La méthode YAltitude.isOnline() de l'objet renvoyé par FindAltitude permet de savoir si le module correspondant est présent et en état de marche.

get_currentValue

La méthode get_currentValue() de l'objet renvoyé par YAltitude.FindAltitude permet d'obtenir l'altitude actuelle mesurée par le capteur. La valeur de retour est un nombre flottant en mètres.

YTemperature.FindTemperature et YPressure.FindPressure

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.

package com.yoctopuce.doc_examples;

import android.app.Activity;
import android.os.Bundle;
import android.os.Handler;
import android.view.View;
import android.widget.AdapterView;
import android.widget.AdapterView.OnItemSelectedListener;
import android.widget.ArrayAdapter;
import android.widget.Spinner;
import android.widget.TextView;

import com.yoctopuce.YoctoAPI.YAPI;
import com.yoctopuce.YoctoAPI.YAPI_Exception;
import com.yoctopuce.YoctoAPI.YAltitude;
import com.yoctopuce.YoctoAPI.YModule;
import com.yoctopuce.YoctoAPI.YPressure;
import com.yoctopuce.YoctoAPI.YTemperature;

public class GettingStarted_Yocto_Altimeter extends Activity implements OnItemSelectedListener
{

private ArrayAdapter<String> aa;
private String serial = "";
private Handler handler = null;

@Override
public void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.gettingstarted_yocto_altimeter);
Spinner my_spin = (Spinner) findViewById(R.id.spinner1);
my_spin.setOnItemSelectedListener(this);
aa = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_item);
aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
my_spin.setAdapter(aa);
handler = new Handler();
}

@Override
protected void onStart()
{
super.onStart();
try {
aa.clear();
YAPI.EnableUSBHost(this);
YAPI.RegisterHub("usb");
YModule module = YModule.FirstModule();
while (module != null) {
if (module.get_productName().equals("Yocto-Altimeter")) {
String serial = module.get_serialNumber();
aa.add(serial);
}
module = module.nextModule();
}
} catch (YAPI_Exception e) {
e.printStackTrace();
}
aa.notifyDataSetChanged();
handler.postDelayed(r, 500);
}

@Override
protected void onStop()
{
super.onStop();
handler.removeCallbacks(r);
YAPI.FreeAPI();
}

@Override
public void onItemSelected(AdapterView<?> parent, View view, int pos, long id)
{
serial = parent.getItemAtPosition(pos).toString();
}

@Override
public void onNothingSelected(AdapterView<?> arg0)
{
}

final Runnable r = new Runnable()
{
public void run()
{
if (serial != null) {

YAltitude alt_sensor = YAltitude.FindAltitude(serial);
try {
TextView view = (TextView) findViewById(R.id.altfield);
view.setText(String.format("%.1f %s (QNH=%.1f)", alt_sensor.getCurrentValue(), alt_sensor.getUnit(),alt_sensor.getQnh()));
} catch (YAPI_Exception e) {
e.printStackTrace();

}
YPressure pres_sensor = YPressure.FindPressure(serial);
try {
TextView view = (TextView) findViewById(R.id.presfield);
view.setText(String.format("%.1f %s", pres_sensor.getCurrentValue(), pres_sensor.getUnit()));
} catch (YAPI_Exception e) {
e.printStackTrace();

}
YTemperature temp_sensor = YTemperature.FindTemperature(serial);
try {
TextView view = (TextView) findViewById(R.id.tempfield);
view.setText(String.format("%.1f %s", temp_sensor.getCurrentValue(), temp_sensor.getUnit()));
} catch (YAPI_Exception e) {
e.printStackTrace();

}
}
handler.postDelayed(this, 1000);
}
};

}

18.6. Contrôle de la partie module

package com.yoctopuce.doc_examples;

import android.app.Activity;
import android.os.Bundle;
import android.view.View;
import android.widget.AdapterView;
import android.widget.AdapterView.OnItemSelectedListener;
import android.widget.ArrayAdapter;
import android.widget.Spinner;
import android.widget.Switch;
import android.widget.TextView;

import com.yoctopuce.YoctoAPI.YAPI;
import com.yoctopuce.YoctoAPI.YAPI_Exception;
import com.yoctopuce.YoctoAPI.YModule;

public class ModuleControl extends Activity implements OnItemSelectedListener
{

private ArrayAdapter<String> aa;
private YModule module = null;

@Override
public void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.modulecontrol);
Spinner my_spin = (Spinner) findViewById(R.id.spinner1);
my_spin.setOnItemSelectedListener(this);
aa = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_item);
aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
my_spin.setAdapter(aa);
}

@Override
protected void onStart()
{
super.onStart();

try {
aa.clear();
YAPI.EnableUSBHost(this);
YAPI.RegisterHub("usb");
YModule r = YModule.FirstModule();
while (r != null) {
String hwid = r.get_hardwareId();
aa.add(hwid);
r = r.nextModule();
}
} catch (YAPI_Exception e) {
e.printStackTrace();
}
// refresh Spinner with detected relay
aa.notifyDataSetChanged();
}

@Override
protected void onStop()
{
super.onStop();
YAPI.FreeAPI();
}

private void DisplayModuleInfo()
{
TextView field;
if (module == null)
return;
try {
field = (TextView) findViewById(R.id.serialfield);
field.setText(module.getSerialNumber());
field = (TextView) findViewById(R.id.logicalnamefield);
field.setText(module.getLogicalName());
field = (TextView) findViewById(R.id.luminosityfield);
field.setText(String.format("%d%%", module.getLuminosity()));
field = (TextView) findViewById(R.id.uptimefield);
field.setText(module.getUpTime() / 1000 + " sec");
field = (TextView) findViewById(R.id.usbcurrentfield);
field.setText(module.getUsbCurrent() + " mA");
Switch sw = (Switch) findViewById(R.id.beaconswitch);
sw.setChecked(module.getBeacon() == YModule.BEACON_ON);
field = (TextView) findViewById(R.id.logs);
field.setText(module.get_lastLogs());

} catch (YAPI_Exception e) {
e.printStackTrace();
}
}

@Override
public void onItemSelected(AdapterView<?> parent, View view, int pos, long id)
{
String hwid = parent.getItemAtPosition(pos).toString();
module = YModule.FindModule(hwid);
DisplayModuleInfo();
}

@Override
public void onNothingSelected(AdapterView<?> arg0)
{
}

public void refreshInfo(View view)
{
DisplayModuleInfo();
}

public void toggleBeacon(View view)
{
if (module == null)
return;
boolean on = ((Switch) view).isChecked();

try {
if (on) {
module.setBeacon(YModule.BEACON_ON);
} else {
module.setBeacon(YModule.BEACON_OFF);
}
} catch (YAPI_Exception e) {
e.printStackTrace();
}
}
}

Modifications des réglages du module

package com.yoctopuce.doc_examples;

import android.app.Activity;
import android.os.Bundle;
import android.view.View;
import android.widget.AdapterView;
import android.widget.AdapterView.OnItemSelectedListener;
import android.widget.ArrayAdapter;
import android.widget.EditText;
import android.widget.Spinner;
import android.widget.TextView;
import android.widget.Toast;

import com.yoctopuce.YoctoAPI.YAPI;
import com.yoctopuce.YoctoAPI.YAPI_Exception;
import com.yoctopuce.YoctoAPI.YModule;

public class SaveSettings extends Activity implements OnItemSelectedListener
{

private ArrayAdapter<String> aa;
private YModule module = null;

@Override
public void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.savesettings);
Spinner my_spin = (Spinner) findViewById(R.id.spinner1);
my_spin.setOnItemSelectedListener(this);
aa = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_item);
aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
my_spin.setAdapter(aa);
}

@Override
protected void onStart()
{
super.onStart();

try {
aa.clear();
YAPI.EnableUSBHost(this);
YAPI.RegisterHub("usb");
YModule r = YModule.FirstModule();
while (r != null) {
String hwid = r.get_hardwareId();
aa.add(hwid);
r = r.nextModule();
}
} catch (YAPI_Exception e) {
e.printStackTrace();
}
// refresh Spinner with detected relay
aa.notifyDataSetChanged();
}

@Override
protected void onStop()
{
super.onStop();
YAPI.FreeAPI();
}

private void DisplayModuleInfo()
{
TextView field;
if (module == null)
return;
try {
YAPI.UpdateDeviceList();// fixme
field = (TextView) findViewById(R.id.logicalnamefield);
field.setText(module.getLogicalName());
} catch (YAPI_Exception e) {
e.printStackTrace();
}
}

@Override
public void onItemSelected(AdapterView<?> parent, View view, int pos, long id)
{
String hwid = parent.getItemAtPosition(pos).toString();
module = YModule.FindModule(hwid);
DisplayModuleInfo();
}

@Override
public void onNothingSelected(AdapterView<?> arg0)
{
}

public void saveName(View view)
{
if (module == null)
return;

EditText edit = (EditText) findViewById(R.id.newname);
String newname = edit.getText().toString();
try {
if (!YAPI.CheckLogicalName(newname)) {
Toast.makeText(getApplicationContext(), "Invalid name (" + newname + ")", Toast.LENGTH_LONG).show();
return;
}
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 technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles. Pour résumer vous ne pouvez employer la fonction YModule.saveToFlash() que 100000 fois au cours de la vie du module. Veillez donc à ne pas appeler cette fonction depuis l'intérieur d'une boucle.

Enumeration des modules

package com.yoctopuce.doc_examples;

import android.app.Activity;
import android.os.Bundle;
import android.util.TypedValue;
import android.view.View;
import android.widget.LinearLayout;
import android.widget.TextView;

import com.yoctopuce.YoctoAPI.YAPI;
import com.yoctopuce.YoctoAPI.YAPI_Exception;
import com.yoctopuce.YoctoAPI.YModule;

public class Inventory extends Activity
{

@Override
public void onCreate(Bundle savedInstanceState)
{
super.onCreate(savedInstanceState);
setContentView(R.layout.inventory);
}

public void refreshInventory(View view)
{
LinearLayout layout = (LinearLayout) findViewById(R.id.inventoryList);
layout.removeAllViews();

try {
YAPI.UpdateDeviceList();
YModule module = YModule.FirstModule();
while (module != null) {
String line = module.get_serialNumber() + " (" + module.get_productName() + ")";
TextView tx = new TextView(this);
tx.setText(line);
tx.setTextSize(TypedValue.COMPLEX_UNIT_SP, 20);
layout.addView(tx);
module = module.nextModule();
}
} catch (YAPI_Exception e) {
e.printStackTrace();
}
}

@Override
protected void onStart()
{
super.onStart();
try {
YAPI.EnableUSBHost(this);
YAPI.RegisterHub("usb");
} catch (YAPI_Exception e) {
e.printStackTrace();
}
refreshInventory(null);
}

@Override
protected void onStop()
{
super.onStop();
YAPI.FreeAPI();
}

}

18.7. Gestion des erreurs

Dans l'API java pour Android, le traitement d'erreur est implémenté au moyen d'exceptions. Vous devrez donc intercepter et traiter correctement ces exceptions si vous souhaitez avoir un projet fiable qui ne crashera pas des que vous débrancherez un module.

19. Mise à jour du firmware

Il existe plusieurs moyens de mettre à jour le firmware des modules Yoctopuce.

19.1. Le VirtualHub ou le YoctoHub

Il est possible de mettre à jour un module directement depuis l'interface web du VirutalHub ou du YoctoHub. Il suffit d'accéder à la fenêtre de configuration du module que à mettre à jour et de cliquer sur le bouton "upgrade". Le VirtualHub démarre un assistant qui vous guidera durant la procédure de mise à jour.

Si pour une raison ou une autre, la mise à jour venait à échouer et que le module de fonctionnait plus, débranchez puis rebranchez le module en maintenant sur le Yocto-bouton appuyé. Le module va démarrer en mode "mise à jour" et sera listé en dessous des modules connectés.

19.2. La librairie ligne de commandes

Tous les outils en lignes de commandes ont la possibilité de mettre à jour les modules Yoctopuce grâce à la commande downloadAndUpdate. Le mécanisme de sélection des modules fonctionne comme pour une commande traditionnelle. La [cible] est le nom du module qui va être mis à jour. Vous pouvez aussi utiliser les alias "any" ou "all", ou encore une liste de noms, séparés par des virgules, sans espace.

C:\>Executable [options] [cible] commande [paramètres]

L'exemple suivant met à jour tous les modules Yoctopuce connectés en USB.

C:\>YModule all downloadAndUpdate
ok: Yocto-PowerRelay RELAYHI1-266C8(rev=15430) is up to date.
ok: 0 / 0 hubs in 0.000000s.
ok: 0 / 0 shields in 0.000000s.
ok: 1 / 1 devices in 0.130000s 0.130000s per device.
ok: All devices are now up to date.
C:\>

19.3. L'application Android Yocto-Firmware

Il est possible de mettre à jour le firmware de vos modules depuis votre téléphone ou tablette Android avec l'application Yocto-Firmware. Cette application liste tous les modules Yoctopuce branchés en USB et vérifie si un firmware plus récent est disponible sur www.yoctopuce.com. Si un firmware plus récent est disponible, il est possible de mettre à jour le module. L'application se charge de télécharger et d'installer le nouveau firmware en préservant les paramètres du module.

Attention, pendant la mise à jour du firmware, le module redémarre plusieurs fois. Android interprète le reboot d'un périphérique USB comme une déconnexion et reconnexion du périphérique USB, et demande à nouveau l'autorisation d'utiliser le port USB. L'utilisateur est obligé de cliquer sur OK pour que la procédure de mise à jour se termine correctement.

19.4. La librairie de programmation

Si vous avez besoin d'intégrer la mise à jour de firmware dans votre application, les librairies proposent une API pour mettre à jour vos modules.⁴⁹

Sauvegarder et restaurer les paramètres

La méthode get_allSettings() retourne un buffer binaire qui permet de sauvegarder les paramètres persistants d'un module. Cette fonction est très utile pour sauvegarder la configuration réseau d'un YoctoHub par exemple.

YWireless wireless = YWireless.FindWireless("reference");
YModule m = wireless.get_module();
byte[] default_config = m.get_allSettings();
saveFile("default.bin", default_config);
...

Ces paramètres peuvent être appliqués sur d'autres modules à l'aide de la méthode set_allSettings().

byte[] default_config = loadFile("default.bin");
YModule m = YModule.FirstModule();
while (m != null) {
if (m.get_productName() == "YoctoHub-Wireless") {
m.set_allSettings(default_config);
}
m = m.next();
}

Chercher le bon firmware

La première étape pour mettre à jour un module Yoctopuce est de trouver quel firmware il faut utiliser, c'est le travail de la méthode checkFirmware(path, onlynew) de l'objet YModule. Cette méthode vérifie que le firmware passé en argument (path) est compatible avec le module. Si le paramètre onlynew est vrai, cette méthode vérifie si le firmware est plus récent que la version qui est actuellement utilisée par le module. Quand le fichier n'est pas compatible (ou si le fichier est plus vieux que la version installée), cette méthode retourne une chaîne vide. Si au contraire le fichier est valide, la méthode retourne le chemin d'accès d'un fichier.

Le code suivant vérifie si le fichier c:\tmp\METEOMK1.17328.byn est compatible avec le module stocké dans la variable m.

YModule m = YModule.FirstModule();
...
...
string path = "c:\\tmp\METEOMK1.17328.byn";
string newfirm = m.checkFirmware(path, false);
if (newfirm != "") {
Console.WriteLine("firmware " + newfirm + " is compatible");
}
...

Il est possible de passer un répertoire en argument (au lieu d'un fichier). Dans ce cas la méthode va parcourir récursivement tous les fichiers du répertoire et retourner le firmware compatible le plus récent. Le code suivant vérifie s'il existe un firmware plus récent dans le répertoire c:\tmp\.

YModule m = YModule.FirstModule();
...
...
string path = "c:\\tmp";
string newfirm = m.checkFirmware(path, true);
if (newfirm != "") {
Console.WriteLine("firmware " + newfirm + " is compatible and newer");
}
...

Il est aussi possible de passer la chaîne "www.yoctopuce.com" en argument pour vérifier s'il existe un firmware plus récent publié sur le site web de Yoctopuce. Dans ce cas, la méthode retournera l'URL du firmware. Vous pourrez soit utiliser cette URL pour télécharger le firmware sur votre disque, soit utiliser cette URL lors de la mise à jour du firmware (voir ci-dessous). Bien évidemment, cette possibilité ne fonctionne que si votre machine est reliée à Internet.

YModule m = YModule.FirstModule();
...
...
string url = m.checkFirmware("www.yoctopuce.com", true);
if (url != "") {
Console.WriteLine("new firmware is available at " + url );
}
...

Mettre à jour le firmware

La mise à jour du firmware peut prendre plusieurs minutes, c'est pourquoi le processus de mise à jour est exécuté par la librairie en arrière plan et est contrôlé par le code utilisateur à l'aide de la classe YFirmwareUdpate.

Pour mettre à jour un module Yoctopuce, il faut obtenir une instance de la classe YFirmwareUpdate à l'aide de la méthode updateFirmware d'un objet YModule. Le seul paramètre de cette méthode est le path du firmware à installer. Cette méthode ne démarre pas immédiatement la mise à jour, mais retourne un objet YFirmwareUpdate configuré pour mettre à jour le module.

string newfirm = m.checkFirmware("www.yoctopuce.com", true);
.....
YFirmwareUpdate fw_update = m.updateFirmware(newfirm);

La méthode startUpdate() démarre la mise à jour en arrière plan. Ce processus en arrière plan se charge automatiquement de:

sauvegarder des paramètres du module,
redémarrer le module en mode "mise à jour"
mettre à jour le firmware
démarrer le module avec la nouvelle version du firmware
restaurer les paramètres

Les méthodes get_progress() et get_progressMessage() permettent de suivre la progression de la mise à jour. get_progress()retourne la progression sous forme de pourcentage (100 = mise à jour terminée). get_progressMessage() retourne une chaîne de caractères décrivant l'opération en cours (effacement, écriture, reboot,...). Si la méthode get_progress() retourne une valeur négative, c'est que le processus de mise à jour à échoué. Dans ce cas la méthode get_progressMessage() retourne le message d'erreur.

Le code suivant démarre la mise à jour et affiche la progression sur la sortie standard.

YFirmwareUpdate fw_update = m.updateFirmware(newfirm);
....
int status = fw_update.startUpdate();
while (status < 100 && status >= 0) {
int newstatus = fw_update.get_progress();
if (newstatus != status) {
Console.WriteLine(status + "% "
+ fw_update.get_progressMessage());
}
YAPI.Sleep(500, ref errmsg);
status = newstatus;
}

if (status < 0) {
Console.WriteLine("Firmware Update failed: "
+ fw_update.get_progressMessage());
} else {
Console.WriteLine("Firmware Updated Successfully!");
}

Particularité d'Android

Il est possible de mettre à jour un firmware d'un module en utilisant la librairie Android. Mais pour les modules branchés en USB, Android va demander à l'utilisateur d'autoriser l'application à accéder au port USB.

Pendant la mise à jour du firmware, le module redémarre plusieurs fois. Android interprète le reboot d'un périphérique USB comme une déconnexion et reconnexion du port USB, et interdit tout accès USB tant que l'utilisateur n'a pas fermé le pop-up. L'utilisateur est obligé de cliquer sur OK pour que la procédure de mise à jour puisse continuer correctement. Il n'est pas possible de mettre à jour un module branché en USB à un appareil Android sans que l'utilisateur ne soit obligé d'interagir avec l'appareil.

19.5. Le mode "mise à jour"

Si vous désirez effacer tous les paramètres du module ou que votre module ne démarre plus correctement, il est possible d'installer un firmware depuis le mode "mise à jour".

Pour forcer le module à fonctionner dans le mode "mis à jour", débranchez-le, attendez quelques secondes, et rebranchez-le en maintenant le Yocto-Bouton appuyé. Cela a pour effet de faire démarrer le module en mode "mise à jour". Ce mode de fonctionnement est protégé contre les corruptions et est toujours accessible.

Dans ce mode, le module n'est plus détecté par les objets YModules. Pour obtenir la liste des modules connectés en mode "mise à jour", il faut utiliser la fonction YAPI.GetAllBootLoaders(). Cette fonction retourne un tableau de chaînes de caractères avec le numéro de série des modules en le mode "mise à jour".

List<string> allBootLoader = YAPI.GetAllBootLoaders();

La procédure de mise à jour est identique au cas standard (voir section précédente), mais il faut instancier manuellement l'objet YFirmwareUpdate au lieu d'appeler module.updateFirmware(). Le constructeur prend en argument trois paramètres: le numéro de série du module, le path du firmware à installer, et un tableau de bytes avec les paramètres à restaurer à la fin de la mise à jour (ou null pour restaurer les paramètres d'origine).

YFirmwareUpdateupdate fw_update;
fw_update = new YFirmwareUpdate(allBootLoader[0], newfirm, null);
int status = fw_update.startUpdate();
.....

20. Utilisation avec des langages non supportés

Les modules Yoctopuce peuvent être contrôlés depuis la plupart des langages de programmation courants. De nouveaux langages sont ajoutés régulièrement en fonction de l'intérêt exprimé par les utilisateurs de produits Yoctopuce. Cependant, certains langages ne sont pas et ne seront jamais supportés par Yoctopuce, les raisons peuvent être diverses: compilateurs plus disponibles, environnements inadaptés, etc...

Il existe cependant des méthodes alternatives pour accéder à des modules Yoctopuce depuis un langage de programmation non supporté.

20.1. Ligne de commande

Le moyen le plus simple pour contrôler des modules Yoctopuce depuis un langage non supporté consiste à utiliser l'API en ligne de commande à travers des appels système. L'API en ligne de commande se présente en effet sous la forme d'un ensemble de petits exécutables qu'il est facile d'appeler et dont la sortie est facile à analyser. La plupart des langages de programmation permettant d'effectuer des appels système, cela permet de résoudre le problème en quelques lignes.

Cependant, si l'API en ligne de commande est la solution la plus facile, ce n'est pas la plus rapide ni la plus efficace. A chaque appel, l'exécutable devra initialiser sa propre API et faire l'inventaire des modules USB connectés. Il faut compter environ une seconde par appel.

20.2. Virtual Hub et HTTP GET

Le Virtual Hub est disponible pour presque toutes les plateformes actuelles, il sert généralement de passerelle pour permettre l'accès aux modules Yoctopuce depuis des langages qui interdisent l'accès direct aux couches matérielles d'un ordinateur (Javascript, PHP, Java...).

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é.

Interface REST

A bas niveau, les modules sont pilotés à l'aide d'une API REST. Ainsi pour contrôler un module, il suffit de faire les requêtes HTTP appropriées sur le Virtual Hub. Par défaut le port HTTP du Virtual Hub est 4444.

Un des gros avantages de cette technique est que les tests préliminaires sont très faciles à mettre en œuvre, il suffit d'un Virtual Hub et d'un simple browser Web. Ainsi, si vous copiez l'URL suivante dans votre browser favori, alors que le Virtual Hub est en train de tourner, vous obtiendrez la liste des modules présents.

http://127.0.0.1:4444/api/services/whitePages.txt

Remarquez que le résultat est présenté sous forme texte, mais en demandant whitePages.xml vous auriez obtenu le résultat en XML. De même, whitePages.json aurait permis d'obtenir le résultat en JSON. L'extension html vous permet même d'afficher une interface sommaire vous permettant de changer les valeurs en direct. Toute l'API REST est disponible dans ces différents formats.

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-Altimeter avec le numéro de de série YALTIMK1-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/api/module.txt

Il est bien entendu possible d'utiliser le nom logique des modules plutôt que leur numéro de série.

http://127.0.0.1:4444/byName/monModule/api/module.txt

Vous pouvez retrouver la valeur d'une des propriétés d'un module, il suffit d'ajouter le nom de la propriété en dessous de module. Par exemple, si vous souhaitez connaître la luminosité des LEDs de signalisation, il vous suffit de faire la requête suivante:

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/api/module/luminosity

Pour modifier la valeur d'une propriété, il vous suffit de modifier l'attribut correspondant. Ainsi, pour modifier la luminosité il vous suffit de faire la requête suivante:

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/api/module?luminosity=100

Contrôle des différentes fonctions du module par l'interface REST

Les fonctionnalités des modules se manipulent de la même manière. Pour connaître l'état de la fonction altitude, il suffit de construire l'URL suivante.

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/api/altitude.txt

En revanche, si vous pouvez utiliser le nom logique du module en lieu et place de son numéro de série, vous ne pouvez pas utiliser les noms logiques des fonctions, seuls les noms hardware sont autorisés pour les fonctions.

Vous pouvez retrouver un attribut d'une fonction d'un module d'une manière assez similaire à celle utilisée avec les modules, par exemple:

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/api/altitude/logicalName

Assez logiquement, les attributs peuvent être modifiés de la même manière.

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/api/altitude?logicalName=maFonction

Vous trouverez la liste des attributs disponibles pour votre Yocto-Altimeter au début du chapitre Programmation, concepts généraux.

Accès aux données enregistrées sur le datalogger par l'interface REST

Cette section s'applique uniquement aux modules dotés d'un enregistreur de donnée.

La version résumée des données enregistrées dans le datalogger peut être obtenue au format JSON à l'aide de l'URL suivante:

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/dataLogger.json

Le détail de chaque mesure pour un chaque tranche d'enregistrement peut être obtenu en ajoutant à l'URL l'identifiant de la fonction désirée et l'heure de départ de la tranche:

http://127.0.0.1:4444/bySerial/YALTIMK1-12345/dataLogger.json?id=altitude&utc=1389801080

20.3. 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.

Filename	Plateforme
libyapi.dylib	Max OS X
libyapi-amd64.so	Linux Intel (64 bits)
libyapi-armel.so	Linux ARM EL
libyapi-armhf.so	Linux ARM HL
libyapi-i386.so	Linux Intel (32 bits)
yapi64.dll	Windows (64 bits)
yapi.dll	Windows (32 bits)

Ces librairies dynamiques contiennent toutes les fonctionnalités nécessaires pour reconstruire entièrement toute l'API haut niveau dans n'importe quel langage capable d'intégrer ces librairies. Ce chapitre se limite cependant à décrire une utilisation de base des modules.

Contrôle d'un module

Les trois fonctions essentielles de l'API bas niveau sont les suivantes:

int yapiInitAPI(int connection_type, char *errmsg);
int yapiUpdateDeviceList(int forceupdate, char *errmsg);
int yapiHTTPRequest(char *device, char *request, char* buffer,int buffsize,int *fullsize, char *errmsg);

La fonction yapiInitAPI permet d'initialiser l'API et doit être appelée une fois en début du programme. Pour une connection de type USB, le paramètre connection_type doit prendre la valeur 1. errmsg est un pointeur sur un buffer de 255 caractères destiné à récupérer un éventuel message d'erreur. Ce pointeur peut être aussi mis à NULL. La fonction retourne un entier négatif en cas d'erreur, ou zéro dans le cas contraire.

La fonction yapiUpdateDeviceList gère l'inventaire des modules Yoctopuce connectés, elle doit être appelée au moins une fois. Pour pouvoir gérer le hot plug, et détecter d'éventuels nouveaux modules connectés, cette fonction devra être apellée à intervalles réguliers. Le paramètre forceupdate devra être à la valeur 1 pour forcer un scan matériel. Le paramètre errmsg devra pointer sur un buffer de 255 caractères pour récupérer un éventuel message d'erreur. Ce pointeur peut aussi être à null.Cette fonction retourne un entier négatif en cas d'erreur, ou zéro dans le cas contraire.

Enfin, la fonction yapiHTTPRequest permet d'envoyer des requêtes HTTP à l'API REST du module. Le paramètre device devra contenir le numéro de série ou le nom logique du module que vous cherchez à atteindre. Le paramètre request doit contenir la requête HTTP complète (y compris les sauts de ligne terminaux). buffer doit pointer sur un buffer de caractères suffisamment grand pour contenir la réponse. buffsize doit contenir la taille du buffer. fullsize est un pointeur sur un entier qui sera affecté à la taille effective de la réponse. Le paramètre errmsg devra pointer sur un buffer de 255 caractères pour récupérer un éventuel message d'erreur. Ce pointeur peut aussi être à null. Cette fonction retourne un entier négatif en cas d'erreur, ou zéro dans le cas contraire.

Le format des requêtes est le même que celui décrit dans la section Virtual Hub et HTTP GET. Toutes les chaînes de caractères utilisées par l'API sont des chaînes constituées de caractères 8 bits: l'Unicode et l'UTF8 ne sont pas supportés.

Le résultat retourné dans la variable buffer respecte le protocole HTTP, il inclut donc un header HTTP . Ce header se termine par deux lignes vides, c'est-à-dire une séquence de quatre caractères ASCII 13, 10, 13, 10.

Voici un programme d'exemple écrit en pascal qui utilise la DLL yapi.dll pour lire puis changer la luminosité d'un module.

// Dll functions import
function yapiInitAPI(mode:integer;
errmsg : pansichar):integer;cdecl;
external 'yapi.dll' name 'yapiInitAPI';
function yapiUpdateDeviceList(force:integer;errmsg : pansichar):integer;cdecl;
external 'yapi.dll' name 'yapiUpdateDeviceList';
function yapiHTTPRequest(device:pansichar;url:pansichar; buffer:pansichar;
buffsize:integer;var fullsize:integer;
errmsg : pansichar):integer;cdecl;
external 'yapi.dll' name 'yapiHTTPRequest';

var
errmsgBuffer : array [0..256] of ansichar;
dataBuffer : array [0..1024] of ansichar;
errmsg,data : pansichar;
fullsize,p : integer;

const
serial = 'YALTIMK1-12345';
getValue = 'GET /api/module/luminosity HTTP/1.1'#13#10#13#10;
setValue = 'GET /api/module?luminosity=100 HTTP/1.1'#13#10#13#10;

begin
errmsg := @errmsgBuffer;
data := @dataBuffer;
// API initialization
if(yapiInitAPI(1,errmsg)<0) then
begin
writeln(errmsg);
halt;
end;

// forces a device inventory
if( yapiUpdateDeviceList(1,errmsg)<0) then
begin
writeln(errmsg);
halt;
end;

// requests the module luminosity
if (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;

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. buffer pointe sur un tableau d'entiers 32 bits qui contiendra les handles retournés. Maxsize est la taille en bytes du buffer. neededsize contiendra au retour la taille nécessaire pour stocker tous les handles. Cela permet d'en déduire le nombre de module connectés, ou si le buffer passé en entrée est trop petit. Le paramètre errmsg devra pointer sur un buffer de 255 caractères pour récupérer un éventuel message d'erreur. Ce pointeur peut aussi être à null. Cette fonction retourne un entier négatif en cas d'erreur, ou zéro dans le cas contraire.

La fonction yapiGetDeviceInfo permet de récupérer les informations relatives à un module à partir de son handle. devdesc est un entier 32bit qui représente le module, et qui a été obtenu grâce à yapiGetAllDevices. infos pointe sur une structure de données dans laquelle sera stocké le résultat. Le format de cette structure est le suivant:

Nom	Type	Taille (bytes)	Description
vendorid	int	4	ID USB de Yoctopuce
deviceid	int	4	ID USB du module
devrelease	int	4	Version du module
nbinbterfaces	int	4	Nombre d'interfaces USB utilisée par le module
manufacturer	char[]	20	Yoctopuce (null terminé)
productname	char[]	28	Modèle (null terminé)
serial	char[]	20	Numéro de série (null terminé)
logicalname	char[]	20	Nom logique (null terminé)
firmware	char[]	22	Version du firmware (null terminé)
beacon	byte	1	Etat de la balise de localisation (0/1)

Le paramètre errmsg devra pointer sur un buffer de 255 caractères pour récupérer un éventuel message d'erreur.

Voici un programme d'exemple écrit en pascal qui utilise la DLL yapi.dll pour lister les modules connectés.

// device description structure
type yDeviceSt = packed record
vendorid : word;
deviceid : word;
devrelease : word;
nbinbterfaces : word;
manufacturer : array [0..19] of ansichar;
productname : array [0..27] of ansichar;
serial : array [0..19] of ansichar;
logicalname : array [0..19] of ansichar;
firmware : array [0..21] of ansichar;
beacon : byte;
end;

// Dll function import
function yapiInitAPI(mode:integer;
errmsg : pansichar):integer;cdecl;
external 'yapi.dll' name 'yapiInitAPI';

function yapiUpdateDeviceList(force:integer;errmsg : pansichar):integer;cdecl;
external 'yapi.dll' name 'yapiUpdateDeviceList';

function yapiGetAllDevices( buffer:pointer;
maxsize:integer;
var neededsize:integer;
errmsg : pansichar):integer; cdecl;
external 'yapi.dll' name 'yapiGetAllDevices';

function apiGetDeviceInfo(d:integer; var infos:yDeviceSt;
errmsg : pansichar):integer; cdecl;
external 'yapi.dll' name 'yapiGetDeviceInfo';

var
errmsgBuffer : array [0..256] of ansichar;
dataBuffer : array [0..127] of integer; // max of 128 USB devices
errmsg,data : pansichar;
neededsize,i : integer;
devinfos : yDeviceSt;

begin
errmsg := @errmsgBuffer;

// API initialisation
if(yapiInitAPI(1,errmsg)<0) then
begin
writeln(errmsg);
halt;
end;

// forces a device inventory
if( yapiUpdateDeviceList(1,errmsg)<0) then
begin
writeln(errmsg);
halt;
end;

// loads all device handles into dataBuffer
if yapiGetAllDevices(@dataBuffer,sizeof(dataBuffer),neededsize,errmsg)<0 then
begin
writeln(errmsg);
halt;
end;

// gets device info from each handle
for i:=0 to neededsize div sizeof(integer)-1 do
begin
if (apiGetDeviceInfo(dataBuffer[i], devinfos, errmsg)<0) then
begin
writeln(errmsg);
halt;
end;
writeln(pansichar(@devinfos.serial)+' ('+pansichar(@devinfos.productname)+')');
end;

end.

VB6 et yapi.dll

Chaque point d'entrée de la DLL yapi.dll est disponible en deux versions, une classique C-decl, et un seconde compatible avec Visual Basic 6 préfixée avec vb6_.

20.4. Port de la librairie haut niveau

Toutes les sources de l'API Yoctopuce étant fournies dans leur intégralité, vous pouvez parfaitement entreprendre le port complet de l'API dans le langage de votre choix. Sachez cependant qu'une grande partie du code source de l'API est généré automatiquement.

Ainsi, il n'est pas nécessaire de porter la totalité de l'API, il suffit de porter le fichier yocto_api et un de ceux correspondant à une fonctionnalité, par exemple yocto_relay. Moyennant un peu de travail supplémentaire, 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.

21. Programmation avancée

Les chapitres précédents vous ont présenté dans chaque language disponible les fonctions de programmation de base utilisables avec votre module Yocto-Altimeter. Ce chapitre présente de façon plus générale une utilisation plus avancée de votre module. Les exemples sont donnés dans le language le plus populaire auprès des clients de Yoctopuce, à savoir C#. Néanmoins, vous trouverez dans les librairies de programmation pour chaque language des exemples complets illustrant les concepts présentés ici.

Afin de rester le plus concis possible, les exemples donnés dans ce chapitre ne font aucune gestion d'erreur. Ne les copiez pas tels-quels dans une application de production.

21.1. Programmation par événements

Les méthodes de gestion des modules Yoctopuce qui vous ont été présentées dans les chapitres précédents sont des fonctions de polling, qui consistent à demander en permanence à l'API si quelque chose a changé. Facile à appréhender, cette technique de programmation est n'est pas la plus efficace ni la plus réactive. C'est pourquoi l'API de programmation Yoctopuce propose aussi un modèle de programmation par événements. Cette technique consiste à demander à l'API de signaler elle-même les changements importants dès qu'ils sont détectés. A chaque fois qu'un paramètre clé change, l'API appelle une fonction de callback que vous avez prédéfinie.

Détecter l'arrivée et le départ des modules

La gestion du hot-plug est importante lorsque l'on travaille avec des modules USB, car tôt ou tard vous serez amené à brancher et débrancher un module après le lancement de votre programme. L'API a été conçue pour gérer l'arrivée et le départ inopinés des modules de manière transparente, mais votre application doit en général en tenir compte si elle veut éviter de prétendre utiliser un module qui a été débranché.

La programmation par événements est particulièrement utile pour détecter les branchements/débranchements de modules. Il est en effet plus simple de se faire signaler les branchements, que de devoir lister en permanence les modules branchés pour en déduire ceux qui sont arrivés et ceux qui sont partis. 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 m)
{
Console.WriteLine("Nouveau module : " + m.get_serialNumber());
}

L'initialisation

Vous devez ensuite signaler à l'API qu'il faut appeler votre callback quand un nouveau module est branché.

YAPI.RegisterDeviceArrivalCallback(deviceArrival);

Notez que si des modules sont déjà branchés lorsque le callback est enregistré, le callback sera appelé pour chacun de ces modules déjà branchés.

Déclenchement des callbacks

Un problème classique de la programmation par callbacks est que ces callbacks peuvent être appelés n'importe quand, y compris à 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 UpdateDeviceList(). Il vous suffit d'appeler UpdateDeviceList() à intervalle régulier depuis un timer ou un thread spécifique pour controller précisément quand les appels à ces callbacks auront lieu:

// boucle d'attente gérant les callback
while (true)
{
// callback d'arrivée / départ de modules
YAPI.UpdateDeviceList(ref errmsg);
// attente non active gérant les autres callbacks
YAPI.Sleep(500, ref errmsg);
}

De manière similaire, il est possible d'avoir un callback quand un module est débranché. Vous trouverez un exemple concret démontrant toutes ces techniques dans la librairie de programmation Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-EventBased.

Attention: dans la plupart des langages, les callbacks doivent être des procédures globales, et non pas des méthodes. Si vous souhaitez que le callback appelle une méthode d'un objet, définissez votre callback sous la forme d'une procédure globale qui ensuite appellera votre méthode.

Détecter le changement de valeur d'un senseur

L'API Yoctopuce fournit aussi un système de callback permettant d'être prévenu automatiquement de la valeur d'un senseur, soit lorsqu'il a changé de manière significative, ou soit à intervalle fixe. Le code nécessaire à cet effet est assez similaire au code utilisé pour détecter l'arrivée d'un module.

Cette technique est très utile en particulier si vous voulez détecter des changements de valeur très rapides (de l'ordre de quelques millisecondes), car elle est beaucoup plus efficace (en terme de traffic sur USB) qu'une lecture répétée de la valeur et permet donc des meilleures performances.

L'appel des callbacks

Afin de permettre un meilleur contrôle du contexte d'appel, les callbacks de changement de valeurs et les callback périodiques ne sont appelés que pendant l'exécution des fonctions YAPI.Sleep() et YAPI.HandleEvents(). Vous devez donc appeler une de ces fonctions à intervalle régulier, soit depuis un timer soit depuis un thread parallèle.

while (true)
{
// boucle d'attente permettant de déclencher les callbacks
YAPI.Sleep(500, ref errmsg);
}

Dans les environnements de programmation où seul le thread d'interface a le droit d'interagir avec l'utilisateur, il est souvent approprié d'appeler YAPI.HandleEvents() depuis ce thread.

Le callback de changement de valeur

Ce type de callback est appelé lorsque un altimetre change de manière significative. Il prend en paramètre la fonction concernée et la nouvelle valeur, sous forme d'une chaîne de caractères⁵⁰.

static void valueChangeCallback(YAltitude fct, string value)
{
Console.WriteLine(fct.get_hardwareId() + "=" + value);
}

Dans la plupart des langages, les callbacks doivent être des procédures globales, et non pas des méthodes. Si vous souhaitez que le callback appelle une méthode d'un objet, définissez votre callback sous la forme d'une procédure globale qui ensuite appellera votre méthode. Si vous avez besoin de garder la référence sur votre objet, vous pouvez la stocker directement dans l'objet YAltitude à l'aide de la fonction set_userData. Il vous sera ainsi possible de la récupérer dans la procédure globale de callback en appelant get_userData.

Mise en place du callback de changement de valeur

Le callback est mis en place pour une fonction Altitude donnée à l'aide de la méthode registerValueCallback. L'exemple suivant met en place un callback pour la première fonction Altitude disponible.

YAltitude f = YAltitude.FirstAltitude();
f.registerValueCallback(valueChangeCallback);

Vous remarquerez que chaque fonction d'un module peut ainsi avoir un callback différent. Par ailleurs, si vous prenez goût aux callback de changement de valeur, sachez qu'il ne sont pas limités aux senseurs, et que vous pouvez les utiliser avec tous les modules Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).

Le callback périodique

Ce type de callback est automatiquement appelé à intervalle réguliers. La fréquence d'appel peut être configurée individuellement pour chaque senseur, avec des fréquences pouvant aller de cent fois par seconde à une fois par heure. Le callback prend en paramètre la fonction concernée et la valeur mesurée, sous forme d'un objet YMeasure. Contrairement au callback de changement de valeur qui ne contient que la nouvelle valeur instantanée, l'objet YMeasure peut donner la valeur minimale, moyenne et maximale observée depuis le dernier appel du callback périodique. De plus, il contient aussi l'indication de l'heure exacte qui correspond à la mesure, de sorte à pouvoir l'interpréter correctement même en différé.

static void periodicCallback(YAltitude fct, YMeasure measure)
{
Console.WriteLine(fct.get_hardwareId() + "=" +
measure.get_averageValue());
}

Mise en place du callback périodique

Le callback est mis en place pour une fonction Altitude donnée à l'aide de la méthode registerTimedReportCallback. Pour que le callback périodique soit appelé, il faut aussi spécifier la fréquence d'appel à l'aide de la méthode set_reportFrequency (sinon le callback périodique est désactivé par défaut). La fréquence est spécifié sous forme textuelle (comme pour l'enregistreur de données), en spécifiant le nombre d'occurrences par seconde (/s), par minute (/m) ou par heure (/h). La fréquence maximale est 100 fois par seconde (i.e. "100/s"), et fréquence minimale est 1 fois par heure (i.e. "1/h"). Lorsque la fréquence supérieure ou égale à 1/s, la mesure représente une valeur instantanée. Lorsque la fréquence est inférieure, la mesure comporte des valeurs minimale, moyenne et maximale distinctes sur la base d'un échantillonnage effectué automatiquement par le module.

L'exemple suivant met en place un callback périodique 4 fois par minute pour la première fonction Altitude disponible.

YAltitude f = YAltitude.FirstAltitude();
f.set_reportFrequency("4/m");
f.registerTimedReportCallback(periodicCallback);

Comme pour les callback de changement valeur, chaque fonction d'un module peut avoir un callback périodique différent.

Fonction callback générique

Parfois, il est souhaitable d'utiliser la même fonction de callback pour différents types de senseurs (par exemple pour une application de mesure générique). Ceci est possible en définissant le callback pour un objet de classe YSensor plutôt que YAltitude. Ainsi, la même fonction callback pourra être utilisée avec toutes les sous-classes de YSensor (et en particulier avec YAltitude). A l'intérieur du callback, on peut utiliser la méthode get_unit() pour obtenir l'unité physique du capteur si nécessaire pour l'affichage.

Un exemple concret

Vous trouverez un exemple concret démontrant toutes ces techniques dans la librairie de programmation Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-EventBased.

21.2. L'enregistreur de données

Votre Yocto-Altimeter est équipé d'un enregistreur de données, aussi appelé datalogger, capable d'enregistrer en continu les mesures effectuées par le module. La fréquence d'enregistrement maximale est de cent fois par secondes (i.e. "100/s"), et la fréquence minimale est de une fois par heure (i.e. "1/h"). Lorsque la fréquence supérieure ou égale à 1/s, la mesure représente une valeur instantanée. Lorsque la fréquence est inférieure, l'enregistreur stocke non seulement une valeur moyenne, mais aussi les valeurs minimale et maximale observées durant la période, sur la base d'un échantillonnage effectué par le module.

La mémoire flash de l'enregistreur de données permet d'enregistrer environ 500'000 mesures instantanées, ou 125'000 mesures moyennées. Lorsque la mémoire du datalogger est saturée, les mesures les plus anciennes sont automatiquement effacées.

Prenez garde à ne pas laisser le datalogger fonctionner inutilement à haute vitesse: le nombre d'effacements possibles d'une mémoire flash est limité (typiquement 100'000 cycles d'écriture/effacement). A la vitesse maximale, l'enregistreur peut consommer plus de 100 cycles par jour ! Notez aussi qu'il se sert à rien d'enregistrer des valeurs plus rapidement que la fréquence de mesure du capteur lui-même.

Démarrage/arrêt du datalogger

Le datalogger peut être démarré à l'aide de la méthode set_recording().

YDataLogger l = YDataLogger.FirstDataLogger();
l.set_recording(YDataLogger.RECORDING_ON);

Il est possible de faire démarrer automatiquement l'enregistrement des données dès la mise sous tension du module.

YDataLogger l = YDataLogger.FirstDataLogger();
l.set_autoStart(YDataLogger.AUTOSTART_ON);
l.get_module().saveToFlash(); // il faut sauver le réglage!

Remarque: les modules Yoctopuce n'ont pas besoin d'une connection USB active pour fonctionner: ils commencent à fonctionner dès qu'ils sont alimentés. Le Yocto-Altimeter peut enregistrer des données sans être forcément raccordé à un ordinateur: il suffit d'activer le démarrage automatique du datalogger et d'alimenter le module avec un simple chargeur USB.

Effacement de la mémoire

La mémoire du datalogger peut être effacée à l'aide de la fonction forgetAllDataStreams(). Attention l'effacement est irréversible.

YDataLogger logger = YDataLogger.FirstDataLogger();
logger.forgetAllDataStreams();

Choix de la fréquence d'enregistrement

La fréquence d'enregistrement se configure individuellement pour chaque capteur, à l'aide de la méthode set_logFrequency(). La fréquence est spécifié sous forme textuelle (comme pour les callback périodiques), en spécifiant le nombre d'occurrences par seconde (/s), par minute (/m) ou par heure (/h). La valeur par défaut est "1/s".

L'exemple suivant configure la fréquence d'enregistrement à 15 mesures par minute pour le premier capteur trouvé, quel que soit son type:

YSensor sensor = YSensor.FirstSensor();
sensor.set_logFrequency("15/m");

Pour économiser la mémoire flash, il est possible de désactiver l'enregistrement des mesures pour une fonction donnée. Pour ce faire, il suffit d'utiliser la valeur "OFF":

sensor.set_logFrequency("OFF");

Limitation: Le Yocto-Altimeter ne peut pas utiliser des fréquences différentes pour les notifications périodiques et pour l'enregistrement dans le datalogger. Il est possible de désactiver l'une ou l'autre de ces fonctionnalités indépendamment, mais si les deux sont activées, elles fonctionnent nécessairement à la même fréquence.

Récupération des données

Pour récupérer les données enregistrées dans la mémoire flash du Yocto-Altimeter, il faut appeler la méthode get_recordedData() de la fonction désirée, en spécifiant l'intervalle de temps qui nous intéresse. L'intervalle de temps est donnée à l'aide du timestamp UNIX de début et de fin. Il est aussi possible de spécifier 0 pour ne pas donner de limite de début ou de fin.

La fonction get_recordedData() ne retourne pas directement un tableau de valeurs mesurées, car selon la quantité de données, leur chargement pourrait potentiellement prendre trop de temps et entraver la réactivité de l'application. A la place, cette fonction retourne un objet YDataSet qui permet d'obtenir immédiatement une vue d'ensemble des données (résumé), puis d'en charger progressivement le détail lorsque c'est souhaitable.

Voici les principales méthodes pour accéder aux données enregistrées:

dataset = sensor.get_recordedData(0,0): on choisit l'intervalle de temps désiré
dataset.loadMore(): pour charger les données progressivement
dataset.get_summary(): retourne une mesure unique résumant tout l'intervalle de temps
dataset.get_preview(): retourne un tableau de mesures représentant une version condensée de l'ensemble des mesures sur l'intervalle de temps choisi (réduction d'un facteur 200 environ)
dataset.get_measures(): retourne un tableau contenant toutes les mesures de l'intervalle choisi (grandit au fur et à mesure de leur chargement avec loadMore)

Les mesures sont des objets YMeasure ⁵¹. On peut en y lire la valeur minimale, moyenne et maximale à l'aide des méthodes get_minValue(), get_averageValue() et get_maxValue() respectivement. Voici un petit exemple qui illustre ces fonctions:

// On veut récupérer toutes les données du datalogger
YDataSet dataset = sensor.get_recordedData(0, 0);

// Le 1er appel à loadMore() charge le résumé des données
dataset.loadMore();
YMeasure summary = dataset.get_summary();
string timeFmt = "dd MMM yyyy hh:mm:ss,fff";
string logFmt = "from {0} to {1} : average={2:0.00}{3}";
Console.WriteLine(String.Format(logFmt,
summary.get_startTimeUTC_asDateTime().ToString(timeFmt),
summary.get_endTimeUTC_asDateTime().ToString(timeFmt),
summary.get_averageValue(), sensor.get_unit()));

// Les appels suivants à loadMore() chargent les mesures
Console.WriteLine("loading details");
int progress;
do {
Console.Write(".");
progress = dataset.loadMore();
} while(progress < 100);

// Ca y est, toutes les mesures sont là
List<YMeasure> details = dataset.get_measures();
foreach (YMeasure m in details) {
Console.WriteLine(String.Format(logFmt,
m.get_startTimeUTC_asDateTime().ToString(timeFmt),
m.get_endTimeUTC_asDateTime().ToString(timeFmt),
m.get_averageValue(), sensor.get_unit()));
}

Vous trouverez un exemple complet démontrant cette séquence dans la librairie de programmation Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger.

Horodatage

Le Yocto-Altimeter n'ayant pas de batterie, il n'est pas capable de deviner tout seul l'heure qu'il est au moment de sa mise sous tension. Néanmoins, le Yocto-Altimeter va automatiquement essayer de se mettre à l'heure de l'hôte auquel il est connecté afin de pouvoir correctement dater les mesures du datalogger:

Lorsque le Yocto-Altimeter est branché à un ordinateur exécutant soit le VirtualHub, soit un programme quelconque utilisant la librairie Yoctopuce, il recevra l'heure de cet ordinateur.
Lorsque le Yocto-Altimeter est branché à un YoctoHub-Ethernet, il recevra par ce biais l'heure que le YoctoHub a obtenu par le réseau (depuis un serveur du pool.ntp.org)
Lorsque le Yocto-Altimeter est branché à un YoctoHub-Wireless, il recevra de celui-ci l'heure maintenue par son horloge RTC, précédemment obtenue par le réseau ou par un ordinateur.
Lorsque le Yocto-Altimeter est branché à un appareil mobile Android, il recevra de celui-ci l'heure actuelle pour autant qu'une application utilisant la librairie Yoctopuce soit lancée.

Si aucune de ces conditions n'est remplie (par exemple si le module est simplement connecté à un chargeur USB), le Yocto-Altimeter fera de son mieux pour donner une date vraisemblable aux mesures, en repartant de l'heure des dernières mesures enregistrées. Ainsi, vous pouvez "mettre à l'heure" un Yocto-Altimeter "autonome" en le branchant sur un téléphone Android, lançant un enregistrement de données puis en le re-branchant tout seul sur un chargeur USB. Soyez toutefois conscients que, sans source de temps externe, l'horloge du Yocto-Altimeter peut dériver petit à petit (en principe pas plus de 0.3%).

21.3. Calibration des senseurs

Votre module Yocto-Altimeter est équipé d'un capteur numérique calibré en usine. Les valeurs qu'il renvoie sont censées être raisonnablement justes dans la majorité des cas. Il existe cependant des situations où des conditions extérieures peuvent avoir une influence sur les mesures.

L'API Yoctopuce offre le moyen de re-calibrer les valeurs mesurées par votre Yocto-Altimeter. Il ne n'agit pas de modifier les réglages hardware du module, mais plutôt d'effectuer une transformation a posteriori des mesures effectuées par le capteur. Cette transformation est pilotée par des paramètres qui seront stockés dans la mémoire flash du module, la rendant ainsi spécifique à chaque module. Cette re-calibration est donc entièrement software et reste parfaitement réversible.

Avant de décider de vous lancer dans la re-calibration de votre module Yocto-Altimeter, assurez vous d'avoir bien compris les phénomènes qui influent sur les mesures de votre module, et que la différence en les valeurs vraies et les valeurs lues ne résultent pas d'une mauvaise utilisation ou d'un positionnement inadéquat.

Les modules Yoctopuce supportent deux types de calibration. D'une part une interpolation linéaire basée sur 1 à 5 points de référence, qui peut être effectuée directement à l'intérieur du Yocto-Altimeter. D'autre part l'API supporte une calibration arbitraire externe, implémentée à l'aide de callbacks.

Interpolation linéaire 1 à 5 points

Ces transformations sont effectuées directement dans le Yocto-Altimeter ce qui signifie que vous n'avez qu'à enregistrer les points de calibration dans la mémoire flash du module, et tous les calculs de correction seront effectués de manière totalement transparente: La fonction get_currentValue() renverra la valeur corrigée, alors que la fonction get_currentRawValue() continuera de renvoyer la valeur avant correction.

Les points de calibration sont simplement des couples (Valeur_lue, Valeur_corrigée). Voyons l'influence du nombre de points de corrections sur les corrections.

Correction 1 point

La correction par 1 point ne fait qu'ajouter un décalage aux mesures. Par exemple, si vous fournissez le point de calibration (a,b), toutes les valeurs mesurées seront corrigées en leur ajoutant b-a, de sorte à ce que quand la valeur lue sur le capteur est a, la fonction altitude retournera b.

Correction de mesures avec 1 point de calibration, ici (5,10)

La mise en pratique est des plus simples: il suffit d'appeler la méthode calibrateFromPoints() de la fonction que l'on désire corriger. Le code suivant applique la correction illustrée sur le graphique ci-dessus à la première fonction altitude trouvée. Notez l'appel à la méthode saveToFlash du module hébergeant la fonction, de manière à ce que le module n'oublie pas la calibration dès qu'il sera débranché.

Double[] ValuesBefore = {5};
Double[] ValuesAfter = {10};
YAltitude f = YAltitude.FirstAltitude();
f.calibrateFromPoints(ValuesBefore, ValuesAfter);
f.get_module().saveToFlash();

Correction 2 points

La correction 2 points permet d'effectuer à la fois un décalage et une multiplication par un facteur donné entre deux points. Si vous fournissez les deux points (a,b) et (c,d), le résultat de la fonction sera multiplié par (d-b)/(c-a) dans l'intervalle [a,c] et décalé, de sorte à ce que quand la valeur lue par le senseur est a ou c, la fonction altitude retournera b ou respectivement d. A l'extérieur de l'intervalle [a,c], les valeurs seront simplement décalées de sorte à préserver la continuité des mesures: une augmentation de 1 sur la valeur lue par le senseur induira une augmentation de 1 sur la valeur retournée.

Correction de mesures avec 2 points de calibrations (10,5) et (25,10).

Le code permettant de programmer cette calibration est très similaire au code précédent

Double[] ValuesBefore = {10,25};
Double[] ValuesAfter = {5,10};
YAltitude f = YAltitude.FirstAltitude();
f.calibrateFromPoints(ValuesBefore, ValuesAfter);
f.get_module().saveToFlash();

Notez que les valeurs avant correction doivent être triées dans un ordre strictement croissant, sinon elles seront purement et simplement ignorées.

Correction de 3 à 5 points

Les corrections de 3 à 5 points ne sont qu'une généralisation de la méthode à deux points, permettant de ainsi de créer jusqu' 4 intervalles de correction pour plus de précision. Ces intervalles ne peuvent pas être disjoints.

Exemple de correction avec 3 points de calibrations.

Retour à la normale

Pour annuler les effets d'une calibration sur une fonction, il suffit d'appeler la méthode calibrateFromPoints() avec deux tableaux vides

Double[] ValuesBefore = {};
Double[] ValuesAfter = {};
YAltitude f = YAltitude.FirstAltitude();
f.calibrateFromPoints(ValuesBefore, ValuesAfter);
f.get_module().saveToFlash();

Vous trouverez dans le répertoire Examples\Prog-Calibration des librairies Delphi, VB et C# une application permettant d'expérimenter les effets de la calibration 1 à 5 points.

Limitations

En raison des limitations de stockage et de traitement des valeurs flottantes dans le module Yoctopuce, les valeurs des valeurs lues et des valeur corrigées doivent respecter certaines contraintes numériques:

Seules 3 décimales sont prises en compte (résolution de 0.001)
La valeur minimale permise est -2'100'000
La valeur maximale permise est +2'100'000

Interpolation arbitraire

Il est aussi possible de calculer l'interpolation à la place du module, pour calculer une interpolation par spline par exemple. Il suffit pour cela d'enregistrer un callback dans l'API. Ce callback devra préciser le nombre de points de correction auquel il s'attend.

public static double CustomInterpolation3Points(double rawValue, int calibType,
int[] parameters, double[] beforeValues, double[] afterValues)
{ double result;
// la valeur a corriger est rawValue
// les points de calibrations sont dans beforeValues et afterValues
result = .... // interpolation de votre choix
return result;
}
YAPI.RegisterCalibrationHandler(3, CustomInterpolation3Points);

Notez que ces callbacks d'interpolation sont globaux, et non pas spécifiques à chaque fonction. Ainsi à chaque fois que quelqu'un demandera une valeur à un module qui disposera dans sa mémoire flash du bon nombre de points de calibration, le callback correspondant sera appelé pour corriger la valeur avant de la renvoyer, permettant ainsi de corriger les mesures de manière totalement transparente.

22. 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-Altimeter. 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 définition pour ce langage (yocto_api.* ainsi que les autres fichiers yocto_* définissant les interfaces des fonctions).

Dans les langages qui supportent les exceptions, toutes ces fonctions vont par défaut générer des exceptions en cas d'erreur plutôt que de retourner la valeur d'erreur documentée pour chaque fonction, afin de faciliter le déboguage. Il est toutefois possible de désactiver l'utilisation d'exceptions à l'aide de la fonction yDisableExceptions(), si l'on préfère travailler avec des valeurs de retour d'erreur.

Ce chapitre ne reprend pas en détail les concepts de programmation décrits plus tôt, afin d'offrir une référence plus concise. En cas de doute, n'hésitez pas à retourner au chapitre décrivant en détail de chaque attribut configurable.

22.1. Fonctions générales

Ces quelques fonctions générales permettent l'initialisation et la configuration de la librairie Yoctopuce. Dans la plupart des cas, un appel à yRegisterHub() suffira en tout et pour tout. Ensuite, vous pourrez appeler la fonction globale yFind...() ou yFirst...() correspondant à votre module pour pouvoir interagir avec lui.

Pour utiliser les fonctions décrites ici, vous devez inclure:

js	<script type='text/javascript' src='yocto_api.js'></script>
cpp	#include "yocto_api.h"
m	#import "yocto_api.h"
pas	uses yocto_api;
vb	yocto_api.vb
cs	yocto_api.cs
java	import com.yoctopuce.YoctoAPI.YModule;
uwp	import com.yoctopuce.YoctoAPI.YModule;
py	from yocto_api import *
php	require_once('yocto_api.php');
es	in HTML: <script src="../../lib/yocto_api.js"></script> in node.js: require('yoctolib-es2017/yocto_api.js');

Fonction globales
yCheckLogicalName(name)
Vérifie si un nom donné est valide comme nom logique pour un module ou une fonction.
yClearHTTPCallbackCacheDir(bool_removeFiles)
Désactive le cache de callback HTTP.
yDisableExceptions()
Désactive l'utilisation d'exceptions pour la gestion des erreurs.
yEnableExceptions()
Réactive l'utilisation d'exceptions pour la gestion des erreurs.
yEnableUSBHost(osContext)
Cette fonction est utilisée uniquement sous Android.
yFreeAPI()
Libère la mémoire dynamique utilisée par la librairie Yoctopuce.
yGetAPIVersion()
Retourne la version de la librairie Yoctopuce utilisée.
yGetCacheValidity()
Retourne la durée de validité des données chargée par la libraire.
yGetDeviceListValidity()
Retourne le délais entre chaque énumération forcée des YoctoHub utilisés.
yGetTickCount()
Retourne la valeur du compteur monotone de temps (en millisecondes).
yHandleEvents(errmsg)
Maintient la communication de la librairie avec les modules Yoctopuce.
yInitAPI(mode, errmsg)
Initialise la librairie de programmation de Yoctopuce explicitement.
yPreregisterHub(url, errmsg)
Alternative plus tolerante à `RegisterHub()`.
yRegisterDeviceArrivalCallback(arrivalCallback)
Enregistre une fonction de callback qui sera appelée à chaque fois qu'un module est branché.
yRegisterDeviceRemovalCallback(removalCallback)
Enregistre une fonction de callback qui sera appelée à chaque fois qu'un module est débranché.
yRegisterHub(url, errmsg)
Configure la librairie Yoctopuce pour utiliser les modules connectés sur une machine donnée.
yRegisterHubDiscoveryCallback(hubDiscoveryCallback)
Enregistre une fonction de callback qui est appelée chaque fois qu'un hub réseau s'annonce avec un message SSDP.
yRegisterHubWebsocketCallback(ws, errmsg, authpwd)
Variante de la fonction `RegisterHub()` destinée à initialiser l'API Yoctopuce sur une session Websocket existante, dans le cadre d'un callback websocket entrant.
yRegisterLogFunction(logfun)
Enregistre une fonction de callback qui sera appellée à chaque fois que l'API a quelque chose à dire.
ySelectArchitecture(arch)
Sélectionne manuellement l'architecture de la libraire dynamique à utiliser pour accéder à USB.
ySetCacheValidity(cacheValidityMs)
Change la durée de validité des données chargées par la librairie.
ySetDelegate(object)
(Objective-C uniquement) Enregistre un objet délégué qui doit se conformer au protocole `YDeviceHotPlug`.
ySetDeviceListValidity(deviceListValidity)
Change le délais entre chaque énumération forcée des YoctoHub utilisés.
ySetHTTPCallbackCacheDir(str_directory)
Active le cache du callback HTTP.
ySetTimeout(callback, ms_timeout, args)
Appelle le callback spécifié après un temps d'attente spécifié.
ySetUSBPacketAckMs(pktAckDelay)
Active la quittance des paquets USB reçus par la librairie Yoctopuce.
ySleep(ms_duration, errmsg)
Effectue une pause dans l'exécution du programme pour une durée spécifiée.
yTestHub(url, mstimeout, errmsg)
Test si un hub est joignable.
yTriggerHubDiscovery(errmsg)
Relance une détection des hubs réseau.
yUnregisterHub(url)
Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub.
yUpdateDeviceList(errmsg)
Force une mise-à-jour de la liste des modules Yoctopuce connectés.
yUpdateDeviceList_async(callback, context)
Force une mise-à-jour de la liste des modules Yoctopuce connectés.

YAPI.CheckLogicalName()
yCheckLogicalName()yCheckLogicalName()yCheckLogicalName()[YAPI CheckLogicalName: ]yCheckLogicalName()yCheckLogicalName()YAPI.CheckLogicalName()YAPI.CheckLogicalName()YAPI.CheckLogicalName()YAPI.CheckLogicalName()yCheckLogicalName()YAPI.CheckLogicalName()

Vérifie si un nom donné est valide comme nom logique pour un module ou une fonction.

function yCheckLogicalName(

name)

cpp

bool yCheckLogicalName(

const string& name)

+(BOOL) CheckLogicalName

:(NSString *) name

pas

function yCheckLogicalName(

name: string): boolean

function yCheckLogicalName(

ByVal name As String) As Boolean

bool CheckLogicalName(

string name)

java

boolean CheckLogicalName(

String name)

uwp

bool CheckLogicalName(

string name)

def CheckLogicalName(

name)

php

function yCheckLogicalName(

$name)

function CheckLogicalName(

name)

Un nom logique valide est formé de 19 caractères au maximum, choisis parmi A..Z, a..z, 0..9, _ et -. 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 si le nom est valide, false dans le cas contraire.

YAPI.ClearHTTPCallbackCacheDir()
yClearHTTPCallbackCacheDir()yClearHTTPCallbackCacheDir()

Désactive le cache de callback HTTP.

php

function yClearHTTPCallbackCacheDir(

$bool_removeFiles)

Cette méthode désctive la cache de callback HTTP, et permet également d'en effacer le contenu.

Paramètres :

bool_removeFiles Vrai pour effacer le contenu du répertoire de cache.

Retourne :

nothing.

YAPI.DisableExceptions()
yDisableExceptions()yDisableExceptions()yDisableExceptions()[YAPI DisableExceptions]yDisableExceptions()yDisableExceptions()YAPI.DisableExceptions()YAPI.DisableExceptions()YAPI.DisableExceptions()yDisableExceptions()YAPI.DisableExceptions()

Désactive l'utilisation d'exceptions pour la gestion des erreurs.

function yDisableExceptions(

)

cpp

void yDisableExceptions(

)

+(void) DisableExceptions

pas

procedure yDisableExceptions(

)

procedure yDisableExceptions(

)

void DisableExceptions(

)

uwp

void DisableExceptions(

)

def DisableExceptions(

)

php

function yDisableExceptions(

)

function 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.

YAPI.EnableExceptions()
yEnableExceptions()yEnableExceptions()yEnableExceptions()[YAPI EnableExceptions]yEnableExceptions()yEnableExceptions()YAPI.EnableExceptions()YAPI.EnableExceptions()YAPI.EnableExceptions()yEnableExceptions()YAPI.EnableExceptions()

Réactive l'utilisation d'exceptions pour la gestion des erreurs.

function yEnableExceptions(

)

cpp

void yEnableExceptions(

)

+(void) EnableExceptions

pas

procedure yEnableExceptions(

)

procedure yEnableExceptions(

)

void EnableExceptions(

)

uwp

void EnableExceptions(

)

def EnableExceptions(

)

php

function yEnableExceptions(

)

function EnableExceptions(

)

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).

YAPI.EnableUSBHost()
yEnableUSBHost()YAPI.EnableUSBHost()

Cette fonction est utilisée uniquement sous Android.

java

void EnableUSBHost(

Object osContext)

Avant d'appeler yRegisterHub("usb") il faut activer le port USB host du systeme. Cette fonction prend en argument un objet de la classe android.content.Context (ou d'une sous-classe). Il n'est pas nécessaire d'appeler cette fonction pour accéder au modules à travers le réseau.

Paramètres :

En cas d'erreur, déclenche une exception

osContext un objet de classe android.content.Context (ou une sous-classe)

YAPI.FreeAPI()
yFreeAPI()yFreeAPI()yFreeAPI()[YAPI FreeAPI]yFreeAPI()yFreeAPI()YAPI.FreeAPI()YAPI.FreeAPI()YAPI.FreeAPI()YAPI.FreeAPI()yFreeAPI()YAPI.FreeAPI()

Libère la mémoire dynamique utilisée par la librairie Yoctopuce.

function yFreeAPI(

)

cpp

void yFreeAPI(

)

+(void) FreeAPI

pas

procedure yFreeAPI(

)

procedure yFreeAPI(

)

void FreeAPI(

)

java

void FreeAPI(

)

uwp

void FreeAPI(

)

def FreeAPI(

)

php

function yFreeAPI(

)

function FreeAPI(

)

Il n'est en général pas nécessaire d'appeler cette fonction, sauf si vous désirez libérer tous les blocs de mémoire alloués dynamiquement dans le but d'identifier une source de blocs perdus par exemple. Vous ne devez plus appeler aucune fonction de la librairie après avoir appelé yFreeAPI(), sous peine de crash.

YAPI.GetAPIVersion()
yGetAPIVersion()yGetAPIVersion()yGetAPIVersion()[YAPI GetAPIVersion]yGetAPIVersion()yGetAPIVersion()YAPI.GetAPIVersion()YAPI.GetAPIVersion()YAPI.GetAPIVersion()YAPI.GetAPIVersion()yGetAPIVersion()YAPI.GetAPIVersion()

Retourne la version de la librairie Yoctopuce utilisée.

function yGetAPIVersion(

)

cpp

string yGetAPIVersion(

)

+(NSString*) GetAPIVersion

pas

function yGetAPIVersion(

): string

function yGetAPIVersion(

) As String

String GetAPIVersion(

)

java

String GetAPIVersion(

)

uwp

string GetAPIVersion(

)

def GetAPIVersion(

)

php

function yGetAPIVersion(

)

function GetAPIVersion(

)

La version est retournée sous forme d'une chaîne de caractères au format "Majeure.Mineure.NoBuild", par exemple "1.01.5535". Pour les langages utilisant une DLL externe (par exemple C#, VisualBasic ou Delphi), la chaîne contient en outre la version de la DLL au même format, par exemple "1.01.5535 (1.01.5439)".

Si vous désirez vérifier dans votre code que la version de la librairie est compatible avec celle que vous avez utilisé durant le développement, vérifiez que le numéro majeur soit strictement égal et que le numéro mineur soit égal ou supérieur. Le numéro de build n'est pas significatif par rapport à la compatibilité de la librairie.

Retourne :

une chaîne de caractères décrivant la version de la librairie.

YAPI.GetCacheValidity()
yGetCacheValidity()yGetCacheValidity()[YAPI GetCacheValidity]yGetCacheValidity()yGetCacheValidity()YAPI.GetCacheValidity()YAPI.GetCacheValidity()YAPI.GetCacheValidity()YAPI.GetCacheValidity()yGetCacheValidity()YAPI.GetCacheValidity()

Retourne la durée de validité des données chargée par la libraire.

cpp

static u64 yGetCacheValidity(

)

+(u64) GetCacheValidity

pas

function yGetCacheValidity(

): u64

function yGetCacheValidity(

) As Long

ulong GetCacheValidity(

)

java

long GetCacheValidity(

)

uwp

Task<ulong> GetCacheValidity(

)

def GetCacheValidity(

)

php

function yGetCacheValidity(

)

function GetCacheValidity(

)

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.

YAPI.GetDeviceListValidity()
yGetDeviceListValidity()yGetDeviceListValidity()[YAPI GetDeviceListValidity]yGetDeviceListValidity()yGetDeviceListValidity()YAPI.GetDeviceListValidity()YAPI.GetDeviceListValidity()YAPI.GetDeviceListValidity()YAPI.GetDeviceListValidity()yGetDeviceListValidity()YAPI.GetDeviceListValidity()

Retourne le délais entre chaque énumération forcée des YoctoHub utilisés.

cpp

static int yGetDeviceListValidity(

)

+(int) GetDeviceListValidity

pas

function yGetDeviceListValidity(

): LongInt

function yGetDeviceListValidity(

) As Integer

int GetDeviceListValidity(

)

java

int GetDeviceListValidity(

)

uwp

Task<int> GetDeviceListValidity(

)

def GetDeviceListValidity(

)

php

function yGetDeviceListValidity(

)

function GetDeviceListValidity(

)

Note: Cette fonction doit être appelée après yInitAPI.

Retourne :

le nombre de secondes entre chaque énumération.

YAPI.GetTickCount()
yGetTickCount()yGetTickCount()yGetTickCount()[YAPI GetTickCount]yGetTickCount()yGetTickCount()YAPI.GetTickCount()YAPI.GetTickCount()YAPI.GetTickCount()YAPI.GetTickCount()yGetTickCount()YAPI.GetTickCount()

Retourne la valeur du compteur monotone de temps (en millisecondes).

function yGetTickCount(

)

cpp

u64 yGetTickCount(

)

+(u64) GetTickCount

pas

function yGetTickCount(

): u64

function yGetTickCount(

) As Long

ulong GetTickCount(

)

java

long GetTickCount(

)

uwp

ulong GetTickCount(

)

def GetTickCount(

)

php

function yGetTickCount(

)

function 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.

YAPI.HandleEvents()
yHandleEvents()yHandleEvents()yHandleEvents()[YAPI HandleEvents: ]yHandleEvents()yHandleEvents()YAPI.HandleEvents()YAPI.HandleEvents()YAPI.HandleEvents()YAPI.HandleEvents()yHandleEvents()YAPI.HandleEvents()

Maintient la communication de la librairie avec les modules Yoctopuce.

function yHandleEvents(

errmsg)

cpp

YRETCODE yHandleEvents(

string& errmsg)

+(YRETCODE) HandleEvents

:(NSError**) errmsg

pas

function yHandleEvents(

var errmsg: string): integer

function yHandleEvents(

ByRef errmsg As String) As YRETCODE

YRETCODE HandleEvents(

ref string errmsg)

java

int HandleEvents(

)

uwp

Task<int> HandleEvents(

)

def HandleEvents(

errmsg=None)

php

function yHandleEvents(

&$errmsg)

function HandleEvents(

errmsg)

Si votre programme inclut des longues boucles d'attente, vous pouvez y inclure un appel à cette fonction pour que la librairie prenne en charge les informations mise en attente par les modules sur les canaux de communication. Ce n'est pas strictement indispensable mais cela peut 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.

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.

YAPI.InitAPI()
yInitAPI()yInitAPI()yInitAPI()[YAPI InitAPI: ]yInitAPI()yInitAPI()YAPI.InitAPI()YAPI.InitAPI()YAPI.InitAPI()YAPI.InitAPI()yInitAPI()YAPI.InitAPI()

Initialise la librairie de programmation de Yoctopuce explicitement.

function yInitAPI(

mode, errmsg)

cpp

YRETCODE yInitAPI(

int mode, string& errmsg)

+(YRETCODE) InitAPI

:(int) mode :(NSError**) errmsg

pas

function yInitAPI(

mode: integer, var errmsg: string): integer

function yInitAPI(

ByVal mode As Integer, ByRef errmsg As String) As Integer

int InitAPI(

int mode, ref string errmsg)

java

int InitAPI(

int mode)

uwp

Task<int> InitAPI(

int mode)

def InitAPI(

mode, errmsg=None)

php

function yInitAPI(

$mode, &$errmsg)

function InitAPI(

mode, errmsg)

Il n'est pas indispensable d'appeler yInitAPI(), la librairie sera automatiquement initialisée de toute manière au premier appel à yRegisterHub().

Lorsque cette fonctin est utilisée avec comme mode la valeur Y_DETECT_NONE, il faut explicitement appeler yRegisterHub() pour indiquer à la librairie sur quel VirtualHub les modules sont connectés, avant d'essayer d'y accéder.

Paramètres :

mode	un entier spécifiant le type de détection automatique de modules à utiliser. Les valeurs possibles sont `Y_DETECT_NONE`, `Y_DETECT_USB`, `Y_DETECT_NET` et `Y_DETECT_ALL`.
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.

YAPI.PreregisterHub()
yPreregisterHub()yPreregisterHub()yPreregisterHub()[YAPI PreregisterHub: ]yPreregisterHub()yPreregisterHub()YAPI.PreregisterHub()YAPI.PreregisterHub()YAPI.PreregisterHub()YAPI.PreregisterHub()yPreregisterHub()YAPI.PreregisterHub()

Alternative plus tolerante à RegisterHub().

function yPreregisterHub(

url, errmsg)

cpp

YRETCODE yPreregisterHub(

const string& url, string& errmsg)

+(YRETCODE) PreregisterHub

:(NSString *) url :(NSError**) errmsg

pas

function yPreregisterHub(

url: string, var errmsg: string): integer

vb	function yPreregisterHub(	ByVal url As String,
		ByRef errmsg As String) As Integer

int PreregisterHub(

string url, ref string errmsg)

java

int PreregisterHub(

String url)

uwp

Task<int> PreregisterHub(

string url)

def PreregisterHub(

url, errmsg=None)

php

function yPreregisterHub(

$url, &$errmsg)

function PreregisterHub(

url, errmsg)

Cette fonction a le même but et la même paramètres que la fonction RegisterHub(), mais contrairement à celle-ci PreregisterHub() ne déclanche pas d'erreur si le hub choisi n'est pas joignable au moment de l'appel. Il est ainsi possible d'enregistrer un hub réseau indépendemment de la connectivité, afin de tenter de ne le contacter que lorsqu'on cherche réellement un module.

Paramètres :

url	une chaîne de caractères contenant "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.

YAPI.RegisterDeviceArrivalCallback()
yRegisterDeviceArrivalCallback()yRegisterDeviceArrivalCallback()yRegisterDeviceArrivalCallback()[YAPI RegisterDeviceArrivalCallback: ]yRegisterDeviceArrivalCallback()yRegisterDeviceArrivalCallback()YAPI.RegisterDeviceArrivalCallback()YAPI.RegisterDeviceArrivalCallback()YAPI.RegisterDeviceArrivalCallback()YAPI.RegisterDeviceArrivalCallback()yRegisterDeviceArrivalCallback()YAPI.RegisterDeviceArrivalCallback()

Enregistre une fonction de callback qui sera appelée à chaque fois qu'un module est branché.

function yRegisterDeviceArrivalCallback(

arrivalCallback)

cpp

void yRegisterDeviceArrivalCallback(

yDeviceUpdateCallback arrivalCallback)

+(void) RegisterDeviceArrivalCallback

:(yDeviceUpdateCallback) arrivalCallback

pas

procedure yRegisterDeviceArrivalCallback(

arrivalCallback: yDeviceUpdateFunc)

procedure yRegisterDeviceArrivalCallback(

ByVal arrivalCallback As yDeviceUpdateFunc)

void RegisterDeviceArrivalCallback(

yDeviceUpdateFunc arrivalCallback)

java

void RegisterDeviceArrivalCallback(

DeviceArrivalCallback arrivalCallback)

uwp

void RegisterDeviceArrivalCallback(

DeviceUpdateHandler arrivalCallback)

def RegisterDeviceArrivalCallback(

arrivalCallback)

php

function yRegisterDeviceArrivalCallback(

$arrivalCallback)

function RegisterDeviceArrivalCallback(

arrivalCallback)

Le callback sera appelé pendant l'éxecution de la fonction yUpdateDeviceList, que vous devrez appeler régulièrement.

Paramètres :

pour supprimer un callback déja enregistré.

arrivalCallback une procédure qui prend un YModule en paramètre, ou null

YAPI.RegisterDeviceRemovalCallback()
yRegisterDeviceRemovalCallback()yRegisterDeviceRemovalCallback()yRegisterDeviceRemovalCallback()[YAPI RegisterDeviceRemovalCallback: ]yRegisterDeviceRemovalCallback()yRegisterDeviceRemovalCallback()YAPI.RegisterDeviceRemovalCallback()YAPI.RegisterDeviceRemovalCallback()YAPI.RegisterDeviceRemovalCallback()YAPI.RegisterDeviceRemovalCallback()yRegisterDeviceRemovalCallback()YAPI.RegisterDeviceRemovalCallback()

Enregistre une fonction de callback qui sera appelée à chaque fois qu'un module est débranché.

function yRegisterDeviceRemovalCallback(

removalCallback)

cpp

void yRegisterDeviceRemovalCallback(

yDeviceUpdateCallback removalCallback)

+(void) RegisterDeviceRemovalCallback

:(yDeviceUpdateCallback) removalCallback

pas

procedure yRegisterDeviceRemovalCallback(

removalCallback: yDeviceUpdateFunc)

procedure yRegisterDeviceRemovalCallback(

ByVal removalCallback As yDeviceUpdateFunc)

void RegisterDeviceRemovalCallback(

yDeviceUpdateFunc removalCallback)

java

void RegisterDeviceRemovalCallback(

DeviceRemovalCallback removalCallback)

uwp

void RegisterDeviceRemovalCallback(

DeviceUpdateHandler removalCallback)

def RegisterDeviceRemovalCallback(

removalCallback)

php

function yRegisterDeviceRemovalCallback(

$removalCallback)

function RegisterDeviceRemovalCallback(

removalCallback)

Le callback sera appelé pendant l'éxecution de la fonction yUpdateDeviceList, que vous devrez appeler régulièrement.

Paramètres :

pour supprimer un callback déja enregistré.

removalCallback une procédure qui prend un YModule en paramètre, ou null

YAPI.RegisterHub()
yRegisterHub()yRegisterHub()yRegisterHub()[YAPI RegisterHub: ]yRegisterHub()yRegisterHub()YAPI.RegisterHub()YAPI.RegisterHub()YAPI.RegisterHub()YAPI.RegisterHub()yRegisterHub()YAPI.RegisterHub()

Configure la librairie Yoctopuce pour utiliser les modules connectés sur une machine donnée.

function yRegisterHub(

url, errmsg)

cpp

YRETCODE yRegisterHub(

const string& url, string& errmsg)

+(YRETCODE) RegisterHub

:(NSString *) url :(NSError**) errmsg

pas

function yRegisterHub(

url: string, var errmsg: string): integer

vb	function yRegisterHub(	ByVal url As String,
		ByRef errmsg As String) As Integer

int RegisterHub(

string url, ref string errmsg)

java

int RegisterHub(

String url)

uwp

Task<int> RegisterHub(

string url)

def RegisterHub(

url, errmsg=None)

php

function yRegisterHub(

$url, &$errmsg)

function RegisterHub(

url, errmsg)

Le premier paramètre détermine le fonctionnement de l'API, il peut prendre les valeurs suivantes:

usb: Si vous utilisez le mot-clé usb, l'API utilise les modules Yoctopuce connectés directement par USB. Certains languages comme PHP, Javascript et Java ne permettent pas un accès direct aux couches matérielles, usb ne marchera donc pas avec ces languages. Dans ce cas, utilisez un VirtualHub ou un YoctoHub réseau (voir ci-dessous).

x.x.x.x ou hostname: L'API utilise les modules connectés à la machine dont l'adresse IP est x.x.x.x, ou dont le nom d'hôte DNS est hostname. Cette machine peut être un ordinateur classique faisant tourner un VirtualHub, ou un YoctoHub avec réseau (YoctoHub-Ethernet / YoctoHub-Wireless). Si vous désirez utiliser le VirtualHub tournant sur votre machine locale, utilisez l'adresse IP 127.0.0.1.

callback Le mot-clé callback permet de faire fonctionnner l'API dans un mode appélé "callback HTTP". 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.

Attention, seule une application peut fonctionner à la fois sur une machine donnée en accès direct à USB, sinon il y aurait un conflit d'accès aux modules. Cela signifie en particulier que vous devez stopper le VirtualHub avant de lancer une application utilisant l'accès direct à USB. Cette limitation peut être contournée en passant par un VirtualHub plutôt que d'utiliser directement USB.

Si vous désirez vous connecter à un Hub, virtuel ou non, sur lequel le controle d'accès a été activé, vous devez donner le paramètre url sous la forme:

http://nom:mot_de_passe@adresse:port

Vous pouvez appeller RegisterHub plusieurs fois pour vous connecter à plusieurs machines différentes.

Paramètres :

url	une chaîne de caractères contenant "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.

YAPI.RegisterHubDiscoveryCallback()
yRegisterHubDiscoveryCallback()yRegisterHubDiscoveryCallback()[YAPI RegisterHubDiscoveryCallback: ]yRegisterHubDiscoveryCallback()yRegisterHubDiscoveryCallback()YAPI.RegisterHubDiscoveryCallback()YAPI.RegisterHubDiscoveryCallback()YAPI.RegisterHubDiscoveryCallback()YAPI.RegisterHubDiscoveryCallback()

Enregistre une fonction de callback qui est appelée chaque fois qu'un hub réseau s'annonce avec un message SSDP.

cpp

void yRegisterHubDiscoveryCallback(

YHubDiscoveryCallback hubDiscoveryCallback)

+(void) RegisterHubDiscoveryCallback

: (YHubDiscoveryCallback) hubDiscoveryCallback

pas

procedure yRegisterHubDiscoveryCallback(

hubDiscoveryCallback: YHubDiscoveryCallback)

procedure yRegisterHubDiscoveryCallback(

ByVal hubDiscoveryCallback As YHubDiscoveryCallback)

void RegisterHubDiscoveryCallback(

YHubDiscoveryCallback hubDiscoveryCallback)

java

void RegisterHubDiscoveryCallback(

HubDiscoveryCallback hubDiscoveryCallback)

uwp

Task RegisterHubDiscoveryCallback(

HubDiscoveryHandler hubDiscoveryCallback)

def RegisterHubDiscoveryCallback(

hubDiscoveryCallback)

la fonction de callback reçois deux chaînes de caractères en paramètre La première chaîne contient le numéro de série du hub réseau et la deuxième chaîne contient l'URL du hub. L'URL peut être passée directement en argument à la fonction yRegisterHub. Le callback sera appelé pendant l'exécution de la fonction yUpdateDeviceList, que vous devrez appeler régulièrement.

Paramètres :

utilisez null.

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é,

YAPI.RegisterHubWebsocketCallback()
yRegisterHubWebsocketCallback()

Variante de la fonction RegisterHub() destinée à initialiser l'API Yoctopuce sur une session Websocket existante, dans le cadre d'un callback websocket entrant.

Paramètres :

ws	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.
authpwd	le mot de passe optionnel, nécessaire seulement si une authentification WebSocket est configurée sur le hub appelant.

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.

YAPI.RegisterLogFunction()
yRegisterLogFunction()yRegisterLogFunction()[YAPI RegisterLogFunction: ]yRegisterLogFunction()yRegisterLogFunction()YAPI.RegisterLogFunction()YAPI.RegisterLogFunction()YAPI.RegisterLogFunction()YAPI.RegisterLogFunction()

Enregistre une fonction de callback qui sera appellée à chaque fois que l'API a quelque chose à dire.

cpp

void yRegisterLogFunction(

yLogFunction logfun)

+(void) RegisterLogFunction

:(yLogCallback) logfun

pas

procedure yRegisterLogFunction(

logfun: yLogFunc)

procedure yRegisterLogFunction(

ByVal logfun As yLogFunc)

void RegisterLogFunction(

yLogFunc logfun)

java

void RegisterLogFunction(

LogCallback logfun)

uwp

void RegisterLogFunction(

LogHandler logfun)

def RegisterLogFunction(

logfun)

Utile pour débugger le fonctionnement de l'API.

Paramètres :

ou null pour supprimer un callback déja enregistré.

logfun une procedure qui prend une chaîne de caractère en paramètre,

YAPI.SelectArchitecture()
ySelectArchitecture()YAPI.SelectArchitecture()

Sélectionne manuellement l'architecture de la libraire dynamique à utiliser pour accéder à USB.

def SelectArchitecture(

arch)

Par défaut, la libraire Python détecte automatiquement la version de la libraire dynamique à utiliser pour accéder au port USB. Sous Linux ARM il n'est pas possible de détecter de manière fiable si il s'agit d'une installation Soft float (armel) ou Hard float (armhf). Dans ce cas, il est donc recommendé d'appeler SelectArchitecture() avant tout autre appel à la librairie pour forcer l'utilisation d'une architecture spécifiée.

Paramètres :

arch	une chaîne de caractère spécifiant l'architecture à utiliser. Les valeurs possibles sont `"armhf"`,`"armel"`, `"i386"`,`"x86_64"`,`"32bit"`, `"64bit"`

Retourne :

rien.

En cas d'erreur, déclenche une exception.

YAPI.SetCacheValidity()
ySetCacheValidity()ySetCacheValidity()[YAPI SetCacheValidity: ]ySetCacheValidity()ySetCacheValidity()YAPI.SetCacheValidity()YAPI.SetCacheValidity()YAPI.SetCacheValidity()YAPI.SetCacheValidity()ySetCacheValidity()YAPI.SetCacheValidity()

Change la durée de validité des données chargées par la librairie.

cpp

static void ySetCacheValidity(

u64 cacheValidityMs)

+(void) SetCacheValidity

: (u64) cacheValidityMs

pas

procedure ySetCacheValidity(

cacheValidityMs: u64)

procedure ySetCacheValidity(

)

void SetCacheValidity(

ulong cacheValidityMs)

java

void SetCacheValidity(

long cacheValidityMs)

uwp

Task SetCacheValidity(

ulong cacheValidityMs)

def SetCacheValidity(

cacheValidityMs)

php

function ySetCacheValidity(

$cacheValidityMs)

function SetCacheValidity(

cacheValidityMs)

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour changer cette durée, par exemple dans le but de réduire le trafic réseau ou 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 :

cacheValidityMs un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes.

YAPI.SetDelegate()
ySetDelegate()[YAPI SetDelegate: ]

(Objective-C uniquement) Enregistre un objet délégué qui doit se conformer au protocole YDeviceHotPlug.

+(void) SetDelegate

:(id) object

Les méthodes yDeviceArrival et yDeviceRemoval seront appelées pendant l’exécution de la fonction yUpdateDeviceList, que vous devrez appeler régulièrement.

Paramètres :

pour supprimer un objet déja enregistré.

object un objet qui soit se conformer au protocole YAPIDelegate, ou nil

YAPI.SetDeviceListValidity()
ySetDeviceListValidity()ySetDeviceListValidity()[YAPI SetDeviceListValidity: ]ySetDeviceListValidity()ySetDeviceListValidity()YAPI.SetDeviceListValidity()YAPI.SetDeviceListValidity()YAPI.SetDeviceListValidity()YAPI.SetDeviceListValidity()ySetDeviceListValidity()YAPI.SetDeviceListValidity()

Change le délais entre chaque énumération forcée des YoctoHub utilisés.

cpp

static void ySetDeviceListValidity(

int deviceListValidity)

+(void) SetDeviceListValidity

: (int) deviceListValidity

pas

procedure ySetDeviceListValidity(

deviceListValidity: LongInt)

procedure ySetDeviceListValidity(

)

void SetDeviceListValidity(

int deviceListValidity)

java

void SetDeviceListValidity(

int deviceListValidity)

uwp

Task SetDeviceListValidity(

int deviceListValidity)

def SetDeviceListValidity(

deviceListValidity)

php

function ySetDeviceListValidity(

$deviceListValidity)

function SetDeviceListValidity(

deviceListValidity)

Par défaut la librairie effectue une énumération complète toute les 10 secondes. Pour réduire le trafic réseau il est possible d'augmenter ce délais. C'est particulièrement utile lors un YoctoHub est connecté à 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 :

deviceListValidity nombre de secondes entre chaque énumération.

YAPI.SetHTTPCallbackCacheDir()
ySetHTTPCallbackCacheDir()ySetHTTPCallbackCacheDir()

Active le cache du callback HTTP.

php

function ySetHTTPCallbackCacheDir(

$str_directory)

Le cache du callback HTTP permet de réduire de 50 à 70 % la quantité de données transmise au script PHP. Pour activer le cache, la méthode ySetHTTPCallbackCacheDir() doit être appelée avant premier appel à yRegisterHub(). Cette méthode prend en paramètre le path du répertoire dans lequel seront stockés les données entre chaque callback. Ce répertoire doit exister et le script PHP doit y avoir les droits d'écriture. 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 :

str_directory le path du répertoire utilisé comme cache.

Retourne :

nothing.

On failure, throws an exception.

YAPI.SetTimeout()
ySetTimeout()ySetTimeout()YAPI.SetTimeout()

Appelle le callback spécifié après un temps d'attente spécifié.

function ySetTimeout(

callback, ms_timeout, args)

function SetTimeout(

callback, ms_timeout, args)

Cette fonction se comporte plus ou moins comme la fonction Javascript setTimeout, mais durant le temps d'attente, elle va appeler yHandleEvents et yUpdateDeviceList périodiquement pour maintenir l'API à jour avec les modules connectés.

Paramètres :

callback	la fonction à appeler lorsque le temps d'attente est écoulé. Sous Microsoft Internet Explorer, le callback doit être spécifié sous forme d'une string à évaluer.
ms_timeout	un entier correspondant à la durée de l'attente, en millisecondes
args	des arguments supplémentaires peuvent ê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.

YAPI.SetUSBPacketAckMs()
ySetUSBPacketAckMs()YAPI.SetUSBPacketAckMs()

Active la quittance des paquets USB reçus par la librairie Yoctopuce.

java

void SetUSBPacketAckMs(

int pktAckDelay)

Cette fonction permet à la librairie de fonctionner même sur les téléphones Android qui perdent des paquets USB. Par défaut, la quittance est désactivée, car elle double le nombre de paquets échangés et donc ralentit sensiblement le fonctionnement de L'API. La quittance des paquets USB ne doit donc ê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.

Paramètres :

le dernier paquet USB.

pktAckDelay nombre de ms avant que le module ne renvoie

YAPI.Sleep()
ySleep()ySleep()ySleep()[YAPI Sleep: ]ySleep()ySleep()YAPI.Sleep()YAPI.Sleep()YAPI.Sleep()YAPI.Sleep()ySleep()YAPI.Sleep()

Effectue une pause dans l'exécution du programme pour une durée spécifiée.

function ySleep(

ms_duration, errmsg)

cpp

YRETCODE ySleep(

unsigned ms_duration, string& errmsg)

+(YRETCODE) Sleep

:(unsigned) ms_duration :(NSError **) errmsg

pas

function ySleep(

ms_duration: integer, var errmsg: string): integer

vb	function ySleep(	ByVal ms_duration As Integer,
		ByRef errmsg As String) As Integer

int Sleep(

int ms_duration, ref string errmsg)

java

int Sleep(

long ms_duration)

uwp

Task<int> Sleep(

ulong ms_duration)

def Sleep(

ms_duration, errmsg=None)

php

function ySleep(

$ms_duration, &$errmsg)

function Sleep(

ms_duration, errmsg)

L'attente est passive, c'est-à-dire qu'elle n'occupe pas significativement le processeur, de sorte à le laisser disponible pour les autres processus fonctionnant sur la machine. Durant l'attente, la librairie va néanmoins continuer à 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 à la durée de la pause, en millisecondes
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.

YAPI.TestHub()
yTestHub()yTestHub()[YAPI TestHub: ]yTestHub()yTestHub()YAPI.TestHub()YAPI.TestHub()YAPI.TestHub()YAPI.TestHub()yTestHub()YAPI.TestHub()

Test si un hub est joignable.

cpp

YRETCODE yTestHub(

const string& url, int mstimeout, string& errmsg)

m	+(YRETCODE) TestHub	: (NSString*) url
		: (int) mstimeout
		: (NSError**) errmsg

pas	function yTestHub(	url: string,
		mstimeout: integer,
		var errmsg: string): integer

vb	function yTestHub(	ByVal url As String,
		ByVal mstimeout As Integer,
		ByRef errmsg As String) As Integer

int TestHub(

string url, int mstimeout, ref string errmsg)

java

int TestHub(

String url, int mstimeout)

uwp

Task<int> TestHub(

string url, uint mstimeout)

def TestHub(

url, mstimeout, errmsg=None)

php

function yTestHub(

$url, $mstimeout, &$errmsg)

function TestHub(

url, mstimeout, errmsg)

Cette méthode n'enregistre pas le hub, elle ne fait que de vérifier que le hub est joignable. Le paramètre url suit les mêmes conventions que la méthode RegisterHub. Cette méthode est utile pour vérifier les paramètres d'authentification d'un hub. Il est possible de forcer la méthode à rendre la main après mstimeout millisecondes.

Paramètres :

url	une chaîne de caractères contenant "usb","callback", ou l'URL racine du VirtualHub à utiliser.
mstimeout	le nombre de millisecondes disponible pour tester la connexion.
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 retourne un code d'erreur négatif.

YAPI.TriggerHubDiscovery()
yTriggerHubDiscovery()yTriggerHubDiscovery()[YAPI TriggerHubDiscovery: ]yTriggerHubDiscovery()yTriggerHubDiscovery()YAPI.TriggerHubDiscovery()YAPI.TriggerHubDiscovery()YAPI.TriggerHubDiscovery()YAPI.TriggerHubDiscovery()

Relance une détection des hubs réseau.

cpp

YRETCODE yTriggerHubDiscovery(

string& errmsg)

+(YRETCODE) TriggerHubDiscovery

: (NSError**) errmsg

pas

function yTriggerHubDiscovery(

var errmsg: string): integer

function yTriggerHubDiscovery(

ByRef errmsg As String) As Integer

int TriggerHubDiscovery(

ref string errmsg)

java

int TriggerHubDiscovery(

)

uwp

Task<int> TriggerHubDiscovery(

)

def TriggerHubDiscovery(

errmsg=None)

Si une fonction de callback est enregistrée avec yRegisterHubDiscoveryCallback elle sera appelée à chaque hub réseau qui répondra à la détection SSDP.

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.

YAPI.UnregisterHub()
yUnregisterHub()yUnregisterHub()yUnregisterHub()[YAPI UnregisterHub: ]yUnregisterHub()yUnregisterHub()YAPI.UnregisterHub()YAPI.UnregisterHub()YAPI.UnregisterHub()YAPI.UnregisterHub()yUnregisterHub()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)

cpp

void yUnregisterHub(

const string& url)

+(void) UnregisterHub

:(NSString *) url

pas

procedure yUnregisterHub(

url: string)

procedure yUnregisterHub(

ByVal url As String)

void UnregisterHub(

string url)

java

void UnregisterHub(

String url)

uwp

Task UnregisterHub(

string url)

def UnregisterHub(

url)

php

function yUnregisterHub(

$url)

function UnregisterHub(

url)

Paramètres :

l'URL racine du VirtualHub à ne plus utiliser.

url	une chaîne de caractères contenant "usb" ou

YAPI.UpdateDeviceList()
yUpdateDeviceList()yUpdateDeviceList()yUpdateDeviceList()[YAPI UpdateDeviceList: ]yUpdateDeviceList()yUpdateDeviceList()YAPI.UpdateDeviceList()YAPI.UpdateDeviceList()YAPI.UpdateDeviceList()YAPI.UpdateDeviceList()yUpdateDeviceList()YAPI.UpdateDeviceList()

Force une mise-à-jour de la liste des modules Yoctopuce connectés.

function yUpdateDeviceList(

errmsg)

cpp

YRETCODE yUpdateDeviceList(

string& errmsg)

+(YRETCODE) UpdateDeviceList

:(NSError**) errmsg

pas

function yUpdateDeviceList(

var errmsg: string): integer

function yUpdateDeviceList(

ByRef errmsg As String) As YRETCODE

YRETCODE UpdateDeviceList(

ref string errmsg)

java

int UpdateDeviceList(

)

uwp

Task<int> UpdateDeviceList(

)

def UpdateDeviceList(

errmsg=None)

php

function yUpdateDeviceList(

&$errmsg)

function UpdateDeviceList(

errmsg)

La librairie va vérifier sur les machines ou ports USB précédemment enregistrés en utilisant la fonction yRegisterHub si un module a été connecté ou déconnecté, et le cas échéant appeler les fonctions de callback définies par l'utilisateur.

Cette fonction peut être appelée aussi souvent que désiré, afin de rendre l'application réactive aux événements de hot-plug.

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.

YAPI.UpdateDeviceList_async()
yUpdateDeviceList_async()yUpdateDeviceList_async()

Force une mise-à-jour de la liste des modules Yoctopuce connectés.

function yUpdateDeviceList_async(

callback, context)

Cette fonction peut être appelée aussi souvent que désiré, afin de rendre l'application réactive aux événements de hot-plug.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.

Paramètres :

callback	fonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et le code de retour (`YAPI_SUCCESS` si l'opération se déroule sans erreur).
context	contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

22.2. Interface de contrôle du module

Cette interface est la même pour tous les modules USB de Yoctopuce. Elle permet de contrôler les paramètres généraux du module, et d'énumérer les fonctions fournies par chaque module.

Pour utiliser les fonctions décrites ici, vous devez inclure:

js	<script type='text/javascript' src='yocto_api.js'></script>
cpp	#include "yocto_api.h"
m	#import "yocto_api.h"
pas	uses yocto_api;
vb	yocto_api.vb
cs	yocto_api.cs
java	import com.yoctopuce.YoctoAPI.YModule;
uwp	import com.yoctopuce.YoctoAPI.YModule;
py	from yocto_api import *
php	require_once('yocto_api.php');
es	in HTML: <script src="../../lib/yocto_api.js"></script> in node.js: require('yoctolib-es2017/yocto_api.js');

Fonction globales
yFindModule(func)
Permet de retrouver un module d'après son numéro de série ou son nom logique.
yFindModuleInContext(yctx, func)
Permet de retrouver un module d'après un identifiant donné dans un Context YAPI.
yFirstModule()
Commence l'énumération des modules accessibles par la librairie.
Méthodes des objets `YModule`
module→checkFirmware(path, onlynew)
Teste si le fichier byn est valide pour le module.
module→clearCache()
Invalide le cache.
module→describe()
Retourne un court texte décrivant le module.
module→download(pathname)
Télécharge le fichier choisi du module et retourne son contenu.
module→functionBaseType(functionIndex)
Retourne le type de base de la nième fonction du module.
module→functionCount()
Retourne le nombre de fonctions (sans compter l'interface "module") existant sur le module.
module→functionId(functionIndex)
Retourne l'identifiant matériel de la nième fonction du module.
module→functionName(functionIndex)
Retourne le nom logique de la nième fonction du module.
module→functionType(functionIndex)
Retourne le type de la nième fonction du module.
module→functionValue(functionIndex)
Retourne la valeur publiée par la nième fonction du module.
module→get_allSettings()
Retourne tous les paramètres de configuration du module.
module→get_beacon()
Retourne l'état de la balise de localisation.
module→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.
module→get_errorType()
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()
Retourne l'icône du module.
module→get_lastLogs()
Retourne une chaine de charactère contenant les derniers logs du module.
module→get_logicalName()
Retourne le nom logique du module.
module→get_luminosity()
Retourne la luminosité des leds informatives du module (valeur entre 0 et 100).
module→get_parentHub()
Retourne le numéro de série du YoctoHub sur lequel est connecté le module.
module→get_persistentSettings()
Retourne l'état courant des réglages persistents du module.
module→get_productId()
Retourne l'identifiant USB du module, préprogrammé en usine.
module→get_productName()
Retourne le nom commercial du module, préprogrammé en usine.
module→get_productRelease()
Retourne le numéro de version matériel du module, préprogrammé en usine.
module→get_rebootCountdown()
Retourne le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé.
module→get_serialNumber()
Retourne le numéro de série du module, préprogrammé en usine.
module→get_subDevices()
Retourne la liste des modules branchés au module courant.
module→get_upTime()
Retourne le numbre de millisecondes écoulées depuis la mise sous tension du module
module→get_url()
Retourne l'URL utilisée pour accéder au module.
module→get_usbCurrent()
Retourne le courant consommé par le module sur le bus USB, en milliampères.
module→get_userData()
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode `set_userData`.
module→get_userVar()
Retourne la valeur entière précédemment stockée dans cet attribut.
module→hasFunction(funcId)
Teste la présence d'une fonction pour le module courant.
module→isOnline()
Vérifie si le module est joignable, sans déclencher d'erreur.
module→isOnline_async(callback, context)
Vérifie si le module est joignable, sans déclencher d'erreur.
module→load(msValidity)
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.
module→nextModule()
Continue l'énumération des modules commencée à l'aide de `yFirstModule()`.
module→reboot(secBeforeReboot)
Agende un simple redémarrage du module dans un nombre donné de secondes.
module→registerBeaconCallback(callback)
Enregistre une fonction de callback qui sera appelée à chaque changement d'état de la balise de localisation du module.
module→registerConfigChangeCallback(callback)
Enregistre une fonction de callback qui sera appelée à chaque fois qu'un réglage persistant d'un module est modifié (par exemple changement d'unité de mesure, etc.)
module→registerLogCallback(callback)
Enregistre une fonction de callback qui sera appelée à chaque fois le module émet un message de log.
module→revertFromFlash()
Recharge les réglages stockés dans le mémoire non volatile du module, comme à la mise sous tension du module.
module→saveToFlash()
Sauve les réglages courants dans la mémoire non volatile du module.
module→set_allSettings(settings)
Rétablit tous les paramètres du module.
module→set_allSettingsAndFiles(settings)
Rétablit tous les paramètres de configuration et fichiers sur un module.
module→set_beacon(newval)
Allume ou éteint la balise de localisation du module.
module→set_logicalName(newval)
Change le nom logique du module.
module→set_luminosity(newval)
Modifie la luminosité des leds informatives du module.
module→set_userData(data)
Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode `get_userData`.
module→set_userVar(newval)
Stocke une valeur 32 bits dans la mémoire volatile du module.
module→triggerConfigChangeCallback()
Force le déclanchement d'un callback de changement de configuration, afin de vérifier si ils sont disponibles ou pas.
module→triggerFirmwareUpdate(secBeforeReboot)
Agende un redémarrage du module en mode spécial de reprogrammation du logiciel embarqué.
module→updateFirmware(path)
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.

YModule.FindModule()
yFindModule()yFindModule()yFindModule()[YModule FindModule: ]yFindModule()yFindModule()YModule.FindModule()YModule.FindModule()YModule.FindModule()YModule.FindModule()yFindModule()YModule.FindModule()

Permet de retrouver un module d'après son numéro de série ou son nom logique.

function yFindModule(

func)

cpp

YModule* yFindModule(

string func)

+(YModule*) FindModule

: (NSString*) func

pas

function yFindModule(

func: string): TYModule

function yFindModule(

ByVal func As String) As YModule

YModule FindModule(

string func)

java

YModule FindModule(

String func)

uwp

YModule FindModule(

string func)

def FindModule(

func)

php

function yFindModule(

$func)

function FindModule(

func)

Cette fonction n'exige pas que le module soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YModule.isOnline() pour tester si le module est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Si un appel à la méthode is_online() de cet objet renvoie FAUX alors que vous êtes sûr que le module est bien branché, vérifiez que vous n'avez pas oublié d'appeler registerHub() à l'initialisation de de l'application.

Paramètres :

func	une chaîne de caractères contenant soit le numéro de série, soit le nom logique du module désiré

Retourne :

un objet de classe YModule qui permet ensuite de contrôler le module ou d'obtenir de plus amples informations sur le module.

YModule.FindModuleInContext()
yFindModuleInContext()YModule.FindModuleInContext()YModule.FindModuleInContext()YModule.FindModuleInContext()

Permet de retrouver un module d'après un identifiant donné dans un Context YAPI.

java

YModule FindModuleInContext(

YAPIContext yctx, String func)

uwp

YModule FindModuleInContext(

YAPIContext yctx, string func)

function FindModuleInContext(

yctx, func)

L'identifiant peut être spécifié sous plusieurs formes:

NomLogiqueFonction
NoSerieModule.IdentifiantFonction
NoSerieModule.NomLogiqueFonction
NomLogiqueModule.IdentifiantMatériel
NomLogiqueModule.NomLogiqueFonction

Paramètres :

yctx	un contexte YAPI
func	une chaîne de caractères qui référence le module sans ambiguïté

Retourne :

un objet de classe YModule qui permet ensuite de contrôler le module.

YModule.FirstModule()
yFirstModule()yFirstModule()yFirstModule()[YModule FirstModule]yFirstModule()yFirstModule()YModule.FirstModule()YModule.FirstModule()YModule.FirstModule()YModule.FirstModule()yFirstModule()YModule.FirstModule()

Commence l'énumération des modules accessibles par la librairie.

function yFirstModule(

)

cpp

YModule* yFirstModule(

)

+(YModule*) FirstModule

pas

function yFirstModule(

): TYModule

function yFirstModule(

) As YModule

YModule FirstModule(

)

java

YModule FirstModule(

)

uwp

YModule FirstModule(

)

def FirstModule(

)

php

function yFirstModule(

)

function FirstModule(

)

Utiliser la fonction YModule.nextModule() pour itérer sur les autres modules.

Retourne :

un pointeur sur un objet YModule, correspondant au premier module accessible en ligne, ou null si aucun module n'a été trouvé.

module→checkFirmware()module.checkFirmware()module→checkFirmware()[module checkFirmware: ]module.checkFirmware()module.checkFirmware()module.checkFirmware()module.checkFirmware()module.checkFirmware()module.checkFirmware()module→checkFirmware()module.checkFirmware()YModule checkFirmware

Teste si le fichier byn est valide pour le module.

function checkFirmware(

path, onlynew)

cpp

string checkFirmware(

string path, bool onlynew)

m	-(NSString*) checkFirmware	: (NSString*) path
		: (bool) onlynew

pas

function checkFirmware(

path: string, onlynew: boolean): string

function checkFirmware(

) As String

string checkFirmware(

string path, bool onlynew)

java

String checkFirmware(

String path, boolean onlynew)

uwp

Task<string> checkFirmware(

string path, bool onlynew)

def checkFirmware(

path, onlynew)

php

function checkFirmware(

$path, $onlynew)

function checkFirmware(

path, onlynew)

cmd

YModule target checkFirmware

path onlynew

Cette méthode est utile pour vérifier si il est nécessaire de mettre à jour le module avec un nouveau firmware. Il est possible de passer un répertoire qui contiens plusieurs fichier .byn. Dans ce cas cette methode retourne le path du fichier .byn compatible le plus récent. Si le parametre onlynew est vrais, les firmwares équivalents ou plus anciens que le firmware actuellement installé sont ignorés.

Paramètres :

path	le path d'un fichier `.byn` ou d'un répertoire contenant plusieurs fichier `.byn`
onlynew	retourne uniquement les fichiers strictement plus récents

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:".

module→clearCache()module.clearCache()module→clearCache()[module clearCache]module.clearCache()module.clearCache()module.clearCache()module.clearCache()module.clearCache()module→clearCache()module.clearCache()

Invalide le cache.

function clearCache(

)

cpp

void clearCache(

)

-(void) clearCache

pas

procedure clearCache(

)

procedure clearCache(

)

void clearCache(

)

java

void clearCache(

)

def clearCache(

)

php

function clearCache(

)

function 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.

module→describe()module.describe()module→describe()[module describe]module.describe()module.describe()module.describe()module.describe()module.describe()module→describe()module.describe()

Retourne un court texte décrivant le module.

function describe(

)

cpp

string describe(

)

-(NSString*) describe

pas

function describe(

): string

function describe(

) As String

string describe(

)

java

String describe(

)

def describe(

)

php

function describe(

)

function 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

module→download()module.download()module→download()[module download: ]module.download()module.download()module.download()module.download()module.download()module.download()module→download()module.download()YModule download

Télécharge le fichier choisi du module et retourne son contenu.

function download(

pathname)

cpp

string download(

string pathname)

-(NSMutableData*) download

: (NSString*) pathname

pas

function download(

pathname: string): TByteArray

function download(

) As Byte

byte[] download(

string pathname)

java

byte[] download(

String pathname)

uwp

Task<byte[]> download(

string pathname)

def download(

pathname)

php

function download(

$pathname)

function download(

pathname)

cmd

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.

module→functionBaseType()module.functionBaseType()module→functionBaseType()module.functionBaseType()module.functionBaseType()module.functionBaseType()module.functionBaseType()module.functionBaseType()module→functionBaseType()module.functionBaseType()

Retourne le type de base de la nième fonction du module.

function functionBaseType(

functionIndex)

cpp

string functionBaseType(

int functionIndex)

pas

function functionBaseType(

functionIndex: integer): string

function functionBaseType(

ByVal functionIndex As Integer) As String

string functionBaseType(

int functionIndex)

java

String functionBaseType(

int functionIndex)

def functionBaseType(

functionIndex)

php

function functionBaseType(

$functionIndex)

function functionBaseType(

functionIndex)

Par exemple, le type de base de toutes les fonctions de mesure est "Sensor".

Paramètres :

functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 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.

module→functionCount()module.functionCount()module→functionCount()[module functionCount]module.functionCount()module.functionCount()module.functionCount()module.functionCount()module.functionCount()module→functionCount()module.functionCount()

Retourne le nombre de fonctions (sans compter l'interface "module") existant sur le module.

function functionCount(

)

cpp

int functionCount(

)

-(int) functionCount

pas

function functionCount(

): integer

function functionCount(

) As Integer

int functionCount(

)

java

int functionCount(

)

def functionCount(

)

php

function functionCount(

)

function 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.

module→functionId()module.functionId()module→functionId()[module functionId: ]module.functionId()module.functionId()module.functionId()module.functionId()module.functionId()module→functionId()module.functionId()

Retourne l'identifiant matériel de la nième fonction du module.

function functionId(

functionIndex)

cpp

string functionId(

int functionIndex)

-(NSString*) functionId

: (int) functionIndex

pas

function functionId(

functionIndex: integer): string

function functionId(

ByVal functionIndex As Integer) As String

string functionId(

int functionIndex)

java

String functionId(

int functionIndex)

def functionId(

functionIndex)

php

function functionId(

$functionIndex)

function functionId(

functionIndex)

Paramètres :

functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 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.

module→functionName()module.functionName()module→functionName()[module functionName: ]module.functionName()module.functionName()module.functionName()module.functionName()module.functionName()module→functionName()module.functionName()

Retourne le nom logique de la nième fonction du module.

function functionName(

functionIndex)

cpp

string functionName(

int functionIndex)

-(NSString*) functionName

: (int) functionIndex

pas

function functionName(

functionIndex: integer): string

function functionName(

ByVal functionIndex As Integer) As String

string functionName(

int functionIndex)

java

String functionName(

int functionIndex)

def functionName(

functionIndex)

php

function functionName(

$functionIndex)

function functionName(

functionIndex)

Paramètres :

functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 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.

module→functionType()module.functionType()module→functionType()module.functionType()module.functionType()module.functionType()module.functionType()module.functionType()module→functionType()module.functionType()

Retourne le type de la nième fonction du module.

function functionType(

functionIndex)

cpp

string functionType(

int functionIndex)

pas

function functionType(

functionIndex: integer): string

function functionType(

ByVal functionIndex As Integer) As String

string functionType(

int functionIndex)

java

String functionType(

int functionIndex)

def functionType(

functionIndex)

php

function functionType(

$functionIndex)

function functionType(

functionIndex)

Paramètres :

functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 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.

module→functionValue()module.functionValue()module→functionValue()[module functionValue: ]module.functionValue()module.functionValue()module.functionValue()module.functionValue()module.functionValue()module→functionValue()module.functionValue()

Retourne la valeur publiée par la nième fonction du module.

function functionValue(

functionIndex)

cpp

string functionValue(

int functionIndex)

-(NSString*) functionValue

: (int) functionIndex

pas

function functionValue(

functionIndex: integer): string

function functionValue(

ByVal functionIndex As Integer) As String

string functionValue(

int functionIndex)

java

String functionValue(

int functionIndex)

def functionValue(

functionIndex)

php

function functionValue(

$functionIndex)

function functionValue(

functionIndex)

Paramètres :

functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 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.

module→get_allSettings()
module→allSettings()module.get_allSettings()module→get_allSettings()[module allSettings]module.get_allSettings()module.get_allSettings()module.get_allSettings()module.get_allSettings()module.get_allSettings()module.get_allSettings()module→get_allSettings()module.get_allSettings()YModule get_allSettings

Retourne tous les paramètres de configuration du module.

function get_allSettings(

)

cpp

string get_allSettings(

)

-(NSMutableData*) allSettings

pas

function get_allSettings(

): TByteArray

function get_allSettings(

) As Byte

byte[] get_allSettings(

)

java

byte[] get_allSettings(

)

uwp

Task<byte[]> get_allSettings(

)

def get_allSettings(

)

php

function get_allSettings(

)

function get_allSettings(

)

cmd

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.

module→get_beacon()
module→beacon()module.get_beacon()module→get_beacon()[module beacon]module.get_beacon()module.get_beacon()module.get_beacon()module.get_beacon()module.get_beacon()module.get_beacon()module→get_beacon()module.get_beacon()YModule get_beacon

Retourne l'état de la balise de localisation.

function get_beacon(

)

cpp

Y_BEACON_enum get_beacon(

)

-(Y_BEACON_enum) beacon

pas

function get_beacon(

): Integer

function get_beacon(

) As Integer

int get_beacon(

)

java

int get_beacon(

)

uwp

Task<int> get_beacon(

)

def get_beacon(

)

php

function get_beacon(

)

function get_beacon(

)

cmd

YModule target get_beacon

Retourne :

soit Y_BEACON_OFF, soit Y_BEACON_ON, selon l'état de la balise de localisation

En cas d'erreur, déclenche une exception ou retourne Y_BEACON_INVALID.

module→get_errorMessage()
module→errorMessage()module.get_errorMessage()module→get_errorMessage()[module errorMessage]module.get_errorMessage()module.get_errorMessage()module.get_errorMessage()module.get_errorMessage()module.get_errorMessage()module→get_errorMessage()module.get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.

function get_errorMessage(

)

cpp

string get_errorMessage(

)

-(NSString*) errorMessage

pas

function get_errorMessage(

): string

function get_errorMessage(

) As String

string get_errorMessage(

)

java

String get_errorMessage(

)

def get_errorMessage(

)

php

function get_errorMessage(

)

function 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

module→get_errorType()
module→errorType()module.get_errorType()module→get_errorType()module.get_errorType()module.get_errorType()module.get_errorType()module.get_errorType()module.get_errorType()module→get_errorType()module.get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.

function get_errorType(

)

cpp

YRETCODE get_errorType(

)

pas

function get_errorType(

): YRETCODE

function get_errorType(

) As YRETCODE

YRETCODE get_errorType(

)

java

int get_errorType(

)

def get_errorType(

)

php

function get_errorType(

)

function 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

module→get_firmwareRelease()
module→firmwareRelease()module.get_firmwareRelease()module→get_firmwareRelease()[module firmwareRelease]module.get_firmwareRelease()module.get_firmwareRelease()module.get_firmwareRelease()module.get_firmwareRelease()module.get_firmwareRelease()module.get_firmwareRelease()module→get_firmwareRelease()module.get_firmwareRelease()YModule get_firmwareRelease

Retourne la version du logiciel embarqué du module.

function get_firmwareRelease(

)

cpp

string get_firmwareRelease(

)

-(NSString*) firmwareRelease

pas

function get_firmwareRelease(

): string

function get_firmwareRelease(

) As String

string get_firmwareRelease(

)

java

String get_firmwareRelease(

)

uwp

Task<string> get_firmwareRelease(

)

def get_firmwareRelease(

)

php

function get_firmwareRelease(

)

function get_firmwareRelease(

)

cmd

YModule target get_firmwareRelease

Retourne :

une chaîne de caractères représentant la version du logiciel embarqué du module

En cas d'erreur, déclenche une exception ou retourne Y_FIRMWARERELEASE_INVALID.

module→get_functionIds()
module→functionIds()module.get_functionIds()module→get_functionIds()[module functionIds: ]module.get_functionIds()module.get_functionIds()module.get_functionIds()module.get_functionIds()module.get_functionIds()module.get_functionIds()module→get_functionIds()module.get_functionIds()YModule get_functionIds

Retourne les identifiants matériels des fonctions correspondant au type passé en argument.

function get_functionIds(

funType)

cpp

vector<string> get_functionIds(

string funType)

-(NSMutableArray*) functionIds

: (NSString*) funType

pas

function get_functionIds(

funType: string): TStringArray

function get_functionIds(

) As List

List<string> get_functionIds(

string funType)

java

ArrayList<String> get_functionIds(

String funType)

uwp

Task<List<string>> get_functionIds(

string funType)

def get_functionIds(

funType)

php

function get_functionIds(

$funType)

function get_functionIds(

funType)

cmd

YModule target get_functionIds

funType

Paramètres :

funType Le type de fonction (Relay, LightSensor, Voltage,...)

Retourne :

un tableau de chaînes de caractère.

module→get_hardwareId()
module→hardwareId()module.get_hardwareId()module→get_hardwareId()[module hardwareId]module.get_hardwareId()module.get_hardwareId()module.get_hardwareId()module.get_hardwareId()module→get_hardwareId()module.get_hardwareId()

Retourne l'identifiant unique du module.

function get_hardwareId(

)

cpp

string get_hardwareId(

)

-(NSString*) hardwareId

function get_hardwareId(

) As String

string get_hardwareId(

)

java

String get_hardwareId(

)

def get_hardwareId(

)

php

function get_hardwareId(

)

function 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

module→get_icon2d()
module→icon2d()module.get_icon2d()module→get_icon2d()[module icon2d]module.get_icon2d()module.get_icon2d()module.get_icon2d()module.get_icon2d()module.get_icon2d()module.get_icon2d()module→get_icon2d()module.get_icon2d()YModule get_icon2d

Retourne l'icône du module.

function get_icon2d(

)

cpp

string get_icon2d(

)

-(NSMutableData*) icon2d

pas

function get_icon2d(

): TByteArray

function get_icon2d(

) As Byte

byte[] get_icon2d(

)

java

byte[] get_icon2d(

)

uwp

Task<byte[]> get_icon2d(

)

def get_icon2d(

)

php

function get_icon2d(

)

function get_icon2d(

)

cmd

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.

module→get_lastLogs()
module→lastLogs()module.get_lastLogs()module→get_lastLogs()[module lastLogs]module.get_lastLogs()module.get_lastLogs()module.get_lastLogs()module.get_lastLogs()module.get_lastLogs()module.get_lastLogs()module→get_lastLogs()module.get_lastLogs()YModule get_lastLogs

Retourne une chaine de charactère contenant les derniers logs du module.

function get_lastLogs(

)

cpp

string get_lastLogs(

)

-(NSString*) lastLogs

pas

function get_lastLogs(

): string

function get_lastLogs(

) As String

string get_lastLogs(

)

java

String get_lastLogs(

)

uwp

Task<string> get_lastLogs(

)

def get_lastLogs(

)

php

function get_lastLogs(

)

function get_lastLogs(

)

cmd

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.

module→get_logicalName()
module→logicalName()module.get_logicalName()module→get_logicalName()[module logicalName]module.get_logicalName()module.get_logicalName()module.get_logicalName()module.get_logicalName()module.get_logicalName()module.get_logicalName()module→get_logicalName()module.get_logicalName()YModule get_logicalName

Retourne le nom logique du module.

function get_logicalName(

)

cpp

string get_logicalName(

)

-(NSString*) logicalName

pas

function get_logicalName(

): string

function get_logicalName(

) As String

string get_logicalName(

)

java

String get_logicalName(

)

uwp

Task<string> get_logicalName(

)

def get_logicalName(

)

php

function get_logicalName(

)

function get_logicalName(

)

cmd

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 Y_LOGICALNAME_INVALID.

module→get_luminosity()
module→luminosity()module.get_luminosity()module→get_luminosity()[module luminosity]module.get_luminosity()module.get_luminosity()module.get_luminosity()module.get_luminosity()module.get_luminosity()module.get_luminosity()module→get_luminosity()module.get_luminosity()YModule get_luminosity

Retourne la luminosité des leds informatives du module (valeur entre 0 et 100).

function get_luminosity(

)

cpp

int get_luminosity(

)

-(int) luminosity

pas

function get_luminosity(

): LongInt

function get_luminosity(

) As Integer

int get_luminosity(

)

java

int get_luminosity(

)

uwp

Task<int> get_luminosity(

)

def get_luminosity(

)

php

function get_luminosity(

)

function get_luminosity(

)

cmd

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 Y_LUMINOSITY_INVALID.

module→get_parentHub()
module→parentHub()module.get_parentHub()module→get_parentHub()[module parentHub]module.get_parentHub()module.get_parentHub()module.get_parentHub()module.get_parentHub()module.get_parentHub()module.get_parentHub()module→get_parentHub()module.get_parentHub()YModule get_parentHub

Retourne le numéro de série du YoctoHub sur lequel est connecté le module.

function get_parentHub(

)

cpp

string get_parentHub(

)

-(NSString*) parentHub

pas

function get_parentHub(

): string

function get_parentHub(

) As String

string get_parentHub(

)

java

String get_parentHub(

)

uwp

Task<string> get_parentHub(

)

def get_parentHub(

)

php

function get_parentHub(

)

function get_parentHub(

)

cmd

YModule target get_parentHub

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.

module→get_persistentSettings()
module→persistentSettings()module.get_persistentSettings()module→get_persistentSettings()[module persistentSettings]module.get_persistentSettings()module.get_persistentSettings()module.get_persistentSettings()module.get_persistentSettings()module.get_persistentSettings()module.get_persistentSettings()module→get_persistentSettings()module.get_persistentSettings()YModule get_persistentSettings

Retourne l'état courant des réglages persistents du module.

function get_persistentSettings(

)

cpp

Y_PERSISTENTSETTINGS_enum get_persistentSettings(

)

-(Y_PERSISTENTSETTINGS_enum) persistentSettings

pas

function get_persistentSettings(

): Integer

function get_persistentSettings(

) As Integer

int get_persistentSettings(

)

java

int get_persistentSettings(

)

uwp

Task<int> get_persistentSettings(

)

def get_persistentSettings(

)

php

function get_persistentSettings(

)

function get_persistentSettings(

)

cmd

YModule target get_persistentSettings

Retourne :

une valeur parmi Y_PERSISTENTSETTINGS_LOADED, Y_PERSISTENTSETTINGS_SAVED et Y_PERSISTENTSETTINGS_MODIFIED représentant l'état courant des réglages persistents du module

En cas d'erreur, déclenche une exception ou retourne Y_PERSISTENTSETTINGS_INVALID.

module→get_productId()
module→productId()module.get_productId()module→get_productId()[module productId]module.get_productId()module.get_productId()module.get_productId()module.get_productId()module.get_productId()module.get_productId()module→get_productId()module.get_productId()YModule get_productId

Retourne l'identifiant USB du module, préprogrammé en usine.

function get_productId(

)

cpp

int get_productId(

)

-(int) productId

pas

function get_productId(

): LongInt

function get_productId(

) As Integer

int get_productId(

)

java

int get_productId(

)

uwp

Task<int> get_productId(

)

def get_productId(

)

php

function get_productId(

)

function get_productId(

)

cmd

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 Y_PRODUCTID_INVALID.

module→get_productName()
module→productName()module.get_productName()module→get_productName()[module productName]module.get_productName()module.get_productName()module.get_productName()module.get_productName()module.get_productName()module.get_productName()module→get_productName()module.get_productName()YModule get_productName

Retourne le nom commercial du module, préprogrammé en usine.

function get_productName(

)

cpp

string get_productName(

)

-(NSString*) productName

pas

function get_productName(

): string

function get_productName(

) As String

string get_productName(

)

java

String get_productName(

)

uwp

Task<string> get_productName(

)

def get_productName(

)

php

function get_productName(

)

function get_productName(

)

cmd

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 Y_PRODUCTNAME_INVALID.

module→get_productRelease()
module→productRelease()module.get_productRelease()module→get_productRelease()[module productRelease]module.get_productRelease()module.get_productRelease()module.get_productRelease()module.get_productRelease()module.get_productRelease()module.get_productRelease()module→get_productRelease()module.get_productRelease()YModule get_productRelease

Retourne le numéro de version matériel du module, préprogrammé en usine.

function get_productRelease(

)

cpp

int get_productRelease(

)

-(int) productRelease

pas

function get_productRelease(

): LongInt

function get_productRelease(

) As Integer

int get_productRelease(

)

java

int get_productRelease(

)

uwp

Task<int> get_productRelease(

)

def get_productRelease(

)

php

function get_productRelease(

)

function get_productRelease(

)

cmd

YModule target get_productRelease

Retourne :

un entier représentant le numéro de version matériel du module, préprogrammé en usine

En cas d'erreur, déclenche une exception ou retourne Y_PRODUCTRELEASE_INVALID.

module→get_rebootCountdown()
module→rebootCountdown()module.get_rebootCountdown()module→get_rebootCountdown()[module rebootCountdown]module.get_rebootCountdown()module.get_rebootCountdown()module.get_rebootCountdown()module.get_rebootCountdown()module.get_rebootCountdown()module.get_rebootCountdown()module→get_rebootCountdown()module.get_rebootCountdown()YModule get_rebootCountdown

Retourne le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé.

function get_rebootCountdown(

)

cpp	int get_rebootCountdow