Table des Matières

Publicité

Liens rapides

Yocto-Meteo
Mode d'emploi

Publicité

Table des Matières
loading

Sommaire des Matières pour Yoctopuce Yocto-Meteo

  • Page 1 Yocto-Meteo Mode d'emploi...
  • Page 3: Table Des Matières

    5.6. Interface de la fonction Temperature ................5.7. Interface de la fonction DataLogger ................. 5.8. Quelle interface: Native, DLL ou Service? ............... 5.9. Programmation, par où commencer? ................6. Utilisation du Yocto-Meteo en ligne de commande .......... 6.1. Installation .......................... www.yoctopuce.com...
  • Page 4 7. Utilisation du Yocto-Meteo en JavaScript / EcmaScript ........ 7.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ........7.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ....... 7.3. Contrôle de la fonction Humidity ..................7.4. Contrôle de la partie module ....................
  • Page 5 14. Utilisation du Yocto-Meteo en Delphi ..............14.1. Préparation ........................14.2. Contrôle de la fonction Humidity ................... 14.3. Contrôle de la partie module ..................14.4. Gestion des erreurs ....................... 15. Utilisation du Yocto-Meteo en Python ..............15.1. Fichiers sources ......................
  • Page 6 22.4. Les exemples de programmation n'ont pas l'air de marcher ........22.5. Module alimenté mais invisible pour l'OS ..............22.6. Another process named xxx is already using yAPI ............ 22.7. Déconnexions, comportement erratique ..............22.8. Module endommagé ...................... 23. Caractéristiques ......................www.yoctopuce.com...
  • Page 7: Introduction

    1. Introduction Le Yocto-Meteo est un module électronique de 60x20mm qui permet de mesurer par USB à la fois la température, le taux d'humidité relative et pression atmosphérique. Sa précision typique est de 0.2°C pour la température, d'environ 1.8% pour le taux d'humidité et de 1mbar pour la pression .
  • Page 8: Informations De Sécurité

    1. Introduction 1.1. Informations de sécurité Le Yocto-Meteo 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.
  • Page 9 1. Introduction extrêmes, en environnement controllé. Si vous envisagez d'utiliser le Yocto-Meteo 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. www.yoctopuce.com...
  • Page 10 www.yoctopuce.com...
  • Page 11: Présentation

    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 à...
  • Page 12: Le Yocto-Bouton

    à l'intérieur, et n'utilisez jamais de solvant pour le nettoyer. Pour les applications extérieures ou en environnent poussiéreux, l'utilisation d'un filtre SF2 est court-court-court long-long-long court-court-court support@yoctopuce.com Une version antérieure du Yocto-Meteo (numéros de série < 133C0) était équipée avec des capteurs SHT21, légèrement moins précis. www.yoctopuce.com...
  • Page 13 Si le capteur n'est pas déporté, dans le cas d'une installation verticale il faut dans tous les cas éviter de positionner la prise USB vers le bas, car cela aurait pour conséquence de conduire l'air échauffé par l'électronique du module directement vers le capteur de température. https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/2_Humidity_Sensors/ Sensirion_Humidity_Sensors_Handling_Instructions.pdf www.yoctopuce.com...
  • Page 14: Accessoires Optionnels

    Yoctopuce. Vis et entretoises Pour fixer le module Yocto-Meteo à 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.
  • Page 15: Connecteurs Picoflex Et Cable Nappe Souple

    Le capteur d'humidité peut être protégé par un filtre. Connecteurs Picoflex et cable nappe souple Si vous désirez déporter la partie capteur du module Yocto-Meteo à l'aide d'un cable à connecteur enfichable, vous aurez besoin de cable nappe souple à 4 fils espacés de 1.27mm et de connecteurs http://www.yoctopuce.com/EN/products/category/enclosures...
  • Page 16 Vous trouverez plus de détail à ce sujet dans le chapitre concernant le montage et la connectique. Embases Molex ref 90325-3004 ou 90325-0004, disponibles chez la plupart des fournisseurs de composants électroniques (www.mouser.com, www.digikey.com, www.farnell.com, www.distrelec.ch...). S'utilise avec les connecteurs ref 90327-3304 ou 90327-0304 www.yoctopuce.com...
  • Page 17: Premiers Pas

    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).
  • Page 18: Test De La Connectivité Usb

    Yoctopuce. Vous devez raccorder votre module Yocto-Meteo à 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-Meteo, prenez garde à ne pas dépasser les limites de courant imposées par USB, sous peine de faire face des comportements...
  • Page 19: Localisation

    3.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-Meteo. Propriétés du module Yocto-Meteo. Cette fenêtre vous permet entre autres de jouer avec votre module pour en vérifier son fonctionnement, les valeurs de température, d'humidité...
  • Page 20: Luminosité

    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é...
  • Page 21: Montage Et Connectique

    Exemples de montage sur un support. Le module Yocto-Meteo 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.
  • Page 22: Déporter Le Capteur

    4. Montage et connectique 4.2. Déporter le capteur Le module Yocto-Meteo 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.
  • Page 23: Contraintes D'alimentation Par Usb

    Cependant les sous-modules ne sont pas du tout compatibles entre modèles différents. Si vous raccordez un sous module de votre Yocto-Meteo à un autre type de module, par exemple un Yocto-Temperature, cela ne marchera pas, et vous risquez fort d'endommager votre matériel.
  • Page 24 Toujours par rapport aux normes de compatibilité électromagnétique, la longueur maximale supportée du câble USB est de 3m. En plus de pouvoir causer des problèmes de chute de tension, l'utilisation de câbles plus long aurait des incidences sur les test d'immunité électromagnétiques à effectuer pour respecter les normes. www.yoctopuce.com...
  • Page 25: Programmation, Concepts Généraux

    5.1. Paradigme de programmation L'API Yoctopuce est une API orientée objet. Mais dans un souci de simplicité, seules les bases de la programmation objet ont été utilisées. Même si la programmation objet ne vous est pas familière, il est peu probable que cela vous soit un obstacle à...
  • Page 26: Programmation

    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.
  • Page 27: Le Module Yocto-Meteo

    5.2. Le module Yocto-Meteo Le module Yocto-Meteo offre une instance de la fonction Temperature, correspondant au capteur de température, une instance de la fonction Humidity, correspondant à la sonde d'humidité relative et une instance de de fonction Pressure, correspondant à la sonde de pression atmosphérique. La précision du capteur de température est de 0.25 degrés Celsius, celle de la sonde d'humidité...
  • Page 28: Interface De Contrôle Du Module

    5.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.
  • Page 29: Interface De La Fonction Humidity

    Attribut de type entier 32 bits à disposition de l'utilisateur. 5.4. Interface de la fonction Humidity La classe YHumidity permet de lire et de configurer les capteurs d'humidité Yoctopuce. Elle hérite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de données.
  • Page 30 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). relHum Valeur actuelle de l'humidité relative, en pour cent. www.yoctopuce.com...
  • Page 31: Interface De La Fonction Pressure

    Valeur actuelle de l'humidité absolue, en gramme par mètre cube d'air. 5.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.
  • Page 32: 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).
  • Page 33: Interface De La Fonction Datalogger

    Attribut magique permettant de configurer les paramètres physiques du capteur de température. 5.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.
  • Page 34: Quelle Interface: Native, Dll Ou Service

    Attribut qui peut être mis à vrai pour effacer l'historique des mesures. 5.8. Quelle interface: Native, DLL ou Service? Il y existe plusieurs méthodes pour contrôler un module USB Yoctopuce depuis un programme. Contrôle natif Dans ce cas de figure le programme pilotant votre projet est directement compilé avec une librairie qui offre le contrôle des modules.
  • Page 35: 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'à...
  • Page 36: Limitation Des Librairies Yoctopuce

    Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto- Meteo. Il est temps de passer à la pratique. Il vous faut télécharger la librairie Yoctopuce pour votre language de programmation favori depuis le site web de Yoctopuce .
  • Page 37 5. Programmation, concepts généraux Une fois que vous maîtriserez la programmation de base de votre module, vous pourrez vous intéresser au chapitre concernant la programmation avancée qui décrit certaines techniques qui vous permettront d'exploiter au mieux votre Yocto-Meteo. www.yoctopuce.com...
  • Page 38 www.yoctopuce.com...
  • Page 39: Utilisation Du Yocto-Meteo En Ligne De Commande

    à 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-Meteo, ouvrir un shell et commencer à travailler en tapant par exemple: C:\>YTemperature...
  • Page 40: Contrôle De La Fonction Humidity

    C:\>executable commande /help Pour obtenir une description détaillée des paramètres d'une commande. 6.3. Contrôle de la fonction Humidity Pour contrôler la fonction Humidity de votre Yocto-Meteo, vous avez besoin de l'exécutable YHumidity. Vous pouvez par exemple lancer: C:\>YTemperature get_currentValue Cet exemple utilise la cible "any"...
  • Page 41: Contrôle De La Partie Module

    6. Utilisation du Yocto-Meteo en ligne de commande 6.4. Contrôle de la partie module Chaque module peut être contrôlé d'une manière similaire à l'aide de l'exécutable . Par YModule exemple, pour obtenir la liste de tous les modules connectés, utilisez: C:\>YModule inventory...
  • Page 42 6. Utilisation du Yocto-Meteo en ligne de commande Vous obtenez un inventaire des modules connectés par USB, en utilisant un accès natif. Si il y a déjà une autre commande en cours qui accède aux modules en natif, cela ne fonctionnera pas. Mais si vous lancez un virtual hub et que vous lancez votre commande sous la forme: C:\>YModule -r 127.0.0.1 inventory...
  • Page 43: Utilisation Du Yocto-Meteo En Javascript / Ecmascript

    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.
  • Page 44: Fonctions Bloquantes Et Fonctions Asynchrones En Javascript

    7. Utilisation du Yocto-Meteo en JavaScript / EcmaScript 7.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...
  • Page 45: 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.
  • Page 46: Compatibilité Avec L'ancienne Librairie Javascript

    7. Utilisation du Yocto-Meteo en JavaScript / EcmaScript npm instal -g babel-cli npm instal babel-preset-env Normalement vous demanderez à Babel de poser les fichiers transpilés dans un autre répertoire, nommé par exemple. Pour ce faire, utilisez par exemple les commandes suivantes: comopat babel --presets env demo.js --out-dir compat/...
  • Page 47: Contrôle De La Fonction Humidity

    Ce dernier appel asynchrone peut aussi être formulé comme: myModule.get_syncProxy().then(logInfoProxy); 7.3. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction Humidity. // En Node.js, on utilise la fonction require() // En HTML, on utiliserait &lt;script src="..."&gt;...
  • Page 48: Un Exemple Concret, En Node.js

    à en faire un petit programme d'exemple concret. Si le Yocto-Meteo n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où...
  • Page 49: 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-Meteo. Vous y trouverez un fichier html, avec une section JavaScript similaire au code précédent, mais avec quelques variantes pour permettre une interaction à...
  • Page 50: Contrôle De La Partie Module

    7. Utilisation du Yocto-Meteo en JavaScript / EcmaScript async function refresh() let serial = document.getElementById('serial').value; if(serial == '') { // by default use any connected module suitable for the demo let anysensor = YHumidity.FirstHumidity(); if(anysensor) { let module = await anysensor.module();...
  • Page 51 7. Utilisation du Yocto-Meteo en JavaScript / EcmaScript 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");...
  • Page 52: Énumération Des Modules

    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 www.yoctopuce.com...
  • Page 53 La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 54 www.yoctopuce.com...
  • Page 55: Utilisation Du Yocto-Meteo En Php

    Vous n'avez pas besoin d'installer de driver. 8.2. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code PHP qui utilise la fonction Humidity. include('yocto_api.php');...
  • Page 56 Yocto-Meteo. yRegisterHub La fonction permet d'indiquer sur quelle machine se trouve les modules yRegisterHub Yoctopuce, ou plus exactemenent sur quelle machine tourne le programme VirtualHub. Dans notre cas l'adresse indique la machine locale, en utilisant le port (le port 127.0.0.1:4444 4444 standard utilisé...
  • Page 57: Un Exemple Réel

    8. Utilisation du Yocto-Meteo en PHP 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.
  • Page 58: Contrôle De La Partie Module

    8. Utilisation du Yocto-Meteo en PHP 8.3. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
  • Page 59 8. Utilisation du Yocto-Meteo en PHP Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire vive du set_xxx() module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration...
  • Page 60: 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é...
  • Page 61 8. Utilisation du Yocto-Meteo en PHP 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.
  • Page 62 8. Utilisation du Yocto-Meteo en PHP Configuration L'API callback se sert donc du Virtual Hub comme passerelle. Toutes les communications sont initiées par le Virtual Hub, ce sont donc des communication sortantes, et par conséquent parfaitement autorisée par le routeur DSL.
  • Page 63: Utilisation

    VirtualHub pour fonctionner. Pour coder un site Web qui contrôle des modules Yoctopuce de manière interactive, il faudra créer une interface utilisateur qui stockera dans un fichier ou une base de données les actions à effectuer sur les modules Yoctopuce. Ces actions seront ensuite lues puis exécutés par le script de contrôle.
  • Page 64 La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 65: Utilisation Du Yocto-Meteo En C

    à la création d'un projet à neuf linké avec les librairies Yoctopuce. 9.1. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code C++ qui utilise la fonction Humidity. #include "yocto_api.h"...
  • Page 66 Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Meteo avec le numéros de série METEOMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
  • Page 67 9. Utilisation du Yocto-Meteo en C++ travailler avec votre éditeur de texte préféré, ouvrez le fichier , vous taperez simplement main.cpp dans le répertoire de l'exemple pour le compiler. make Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à...
  • Page 68: Contrôle De La Partie Module

    9. Utilisation du Yocto-Meteo en C++ 9.2. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
  • Page 69 9. Utilisation du Yocto-Meteo en C++ Inversement il est possible de forcer le module à oublier ses réglages courants en utilisant la méthode . Ce petit exemple ci-dessous vous permet changer le nom logique revertFromFlash() d'un module. #include <iostream> #include <stdlib.h>...
  • Page 70: Gestion Des Erreurs

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 71: Intégration De La Librairie Yoctopuce En C

    ASCII, etc.); • Elle facilite le déboggage si vous cherchez la cause d'un problème lié à la librairie Yoctopuce • Elle réduit les dépendances sur des composants tiers, par exemple pour parer au cas où vous pourriez être mené...
  • Page 72: Intégration En Librairie Dynamique

    9. Utilisation du Yocto-Meteo en C++ 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...
  • Page 73: Utilisation Du Yocto-Meteo En Objective-C

    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.
  • Page 74 Yoctopuce. doit toujours être utilisé, est nécessaire pour yocto_api.h yocto_humidity.h gérer les modules contenant un capteur d'humidité, comme le Yocto-Meteo. [YAPI RegisterHub] La fonction initialise l'API de Yoctopuce en indiquant où les modules [YAPI RegisterHub] doivent être recherchés. Utilisée avec le paramètre , elle permet de travailler avec les @"usb"...
  • Page 75: Contrôle De La Partie Module

    Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Meteo avec le numéros de série METEOMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction humidity "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute...
  • Page 76 10. Utilisation du Yocto-Meteo en Objective-C (argc > 2) { (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: "); ([module beacon] == Y_BEACON_ON) NSLog(@"ON\n"); else NSLog(@"OFF\n");...
  • Page 77: Gestion Des Erreurs

    La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
  • Page 78 La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 79: Utilisation Du Yocto-Meteo En Visualbasic .Net

    11.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 à...
  • Page 80: Contrôle De La Fonction Humidity

    11.3. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction Humidity. [...]...
  • Page 81: Un Exemple Réel

    11. Utilisation du Yocto-Meteo en VisualBasic .NET isOnline La méthode de l'objet renvoyé par permet de savoir si le module isOnline() yFindHumidity correspondant est présent et en état de marche. get_currentValue La méthode de l'objet renvoyé par permet d'obtenir get_currentValue() yFindHumidity l'humidité...
  • Page 82: Contrôle De La Partie Module

    11. Utilisation du Yocto-Meteo en VisualBasic .NET Console.WriteLine("Module not connected (check identification and USB cable)") End If Console.WriteLine("Current humidity: " + Str(hsensor.get_currentValue()) " %RH") Console.WriteLine("Current temperature: " + Str(tsensor.get_currentValue()) " °C") Console.WriteLine("Current pressure: " + Str(psensor.get_currentValue()) " hPa") Console.WriteLine(" (press Ctrl-C to exit)")
  • Page 83 11. Utilisation du Yocto-Meteo en VisualBasic .NET End Module Chaque propriété du module peut être lue grâce à une méthode du type , et les get_xxxx() propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode set_xxx Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux chapitre API...
  • Page 84: Gestion Des Erreurs

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 85 11. Utilisation du Yocto-Meteo en VisualBasic .NET d'erreur pour chaque fonction est systématiquement documenté dans la référence de la librairie. Il suit toujours même logique: méthode retournera valeur get_state() méthode retournera valeur Y_STATE_INVALID get_currentValue , etc. Dans tous les cas, la valeur retournée sera du type attendu, et Y_CURRENTVALUE_INVALID ne sera pas un pointeur nul qui risquerait de faire crasher votre programme.
  • Page 86 www.yoctopuce.com...
  • Page 87: Utilisation Du Yocto-Meteo En C

    12.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 à...
  • Page 88: Contrôle De La Fonction Humidity

    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 Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code C# qui utilise la fonction Humidity. [...]...
  • Page 89 12. Utilisation du Yocto-Meteo en C# humidity = YHumidity.FindHumidity("MaFonction"); renvoie un objet que vous pouvez ensuite utiliser à loisir pour YHumidity.FindHumidity contrôler le capteur d'humidité. isOnline La méthode de l'objet renvoyé par permet de savoir YHumidity.isOnline() FindHumidity si le module correspondant est présent et en état de marche.
  • Page 90: Contrôle De La Partie Module

    12. Utilisation du Yocto-Meteo en C# ((hsensor == null) || (tsensor == null) || (psensor == null)) { Console.WriteLine("No module connected (check USB cable) "); Environment.Exit(0); } else { hsensor YHumidity.FindHumidity(target + ".humidity"); tsensor YTemperature.FindTemperature(target + ".temperature"); psensor YPressure.FindPressure(target + ".pressure");...
  • Page 91 12. Utilisation du Yocto-Meteo en C# 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() +...
  • Page 92 12. Utilisation du Yocto-Meteo en C# = YModule.FindModule(args[0]); // use serial or logical name if (m.isOnline()) { newname = args[1]; if (!YAPI.CheckLogicalName(newname)) { Console.WriteLine("Invalid name (" newname + ")"); Environment.Exit(0); m.set_logicalName(newname); m.saveToFlash(); // do not forget this Console.Write("Module: serial= "...
  • Page 93: Gestion Des Erreurs

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 94 www.yoctopuce.com...
  • Page 95: Utilisation Du Yocto-Meteo Avec Universal Windows Platform

    Cependant, l'utilisation des nouvelles API UWP n'est pas sans conséquence: l'API Windows Runtime pour accéder aux ports USB est asynchrone, et par conséquent la librairie Yoctopuce doit aussi être asynchrone. Concrètement les méthodes asynchrones ne retournent pas directement le résultat mais un objet et le résultat peut être obtenu plus tard.
  • Page 96: Installation

    13.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.
  • Page 97: Contrôle De La Fonction Humidity

    13.4. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code c# qui utilise la fonction Humidity.
  • Page 98: Un Exemple Concret

    Le projets Visual Studio contient de nombreux fichiers dont la plupart ne sont pas liés à l'utilisation de la librairie Yoctopuce. Pour simplifier la lecture du code nous avons regroupé tout le code qui utilise la librairie dans la classe qui se trouve dans le fichier .
  • Page 99: Contrôle De La Partie Module

    13. Utilisation du Yocto-Meteo avec Universal Windows Platform } catch (YAPI_Exception ex) { WriteLine("error: " + ex.Message); YAPI.FreeAPI(); return 0; 13.6. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci-dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
  • Page 100 13. Utilisation du Yocto-Meteo avec Universal Windows Platform Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire YModule.set_xxx() vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa...
  • Page 101: Gestion Des Erreurs

    La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
  • Page 102 www.yoctopuce.com...
  • Page 103: Utilisation Du Yocto-Meteo En Delphi

    Delphi Par défaut la librairie Yoctopuce pour Delphi utilise une DLL yapi.dll, toutes les applications que vous créerez avec Delphi devront avoir accès à cette DLL. Le plus simple est de faire en sorte qu'elle soit présente dans le même répertoire que l'exécutable de votre application.
  • Page 104 // lets find the parent module so we can get the other sensors m := hsensor.get_module(); serial := m.get_serialNumber(); // retreive all sensor present on the yocto-meteo hsensor := yFindHumidity(serial+'.humidity'); tsensor := yFindTemperature(serial+'.temperature'); psensor := yFindPressure(serial+'.pressure'); // let's poll done := false;...
  • Page 105 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_humidity Ces deux unités permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. doit toujours être utilisé, est nécessaire pour gérer les modules...
  • Page 106: Contrôle De La Partie Module

    14. Utilisation du Yocto-Meteo en Delphi 14.3. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
  • Page 107 14. Utilisation du Yocto-Meteo en Delphi Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire vive du set_xxx() module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration...
  • Page 108: Gestion Des Erreurs

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 109 14. Utilisation du Yocto-Meteo en Delphi 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 à...
  • Page 110 www.yoctopuce.com...
  • Page 111: Utilisation Du Yocto-Meteo En Python

    Windows qu'Unix. C'est un language idéal pour écrire des petits scripts sur un coin de table. La librairie Yoctopuce est compatible avec Python 2.6+ et 3+. Elle fonctionne sous Windows, Max OS X et Linux tant Intel qu'ARM.
  • Page 112: Contrôle De La Fonction Humidity

    15. Utilisation du Yocto-Meteo en Python 15.3. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code Python qui utilise la fonction Humidity. [...] errmsg=YRefParam() #On récupère l'objet représentant le module (ici connecté en local sur USB) YAPI.RegisterHub("usb",errmsg)
  • Page 113: Un Exemple Réel

    15. Utilisation du Yocto-Meteo en Python Un exemple réel Lancez votre interpréteur Python et ouvrez le script correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Meteo de la librairie Yoctopuce. Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret.
  • Page 114 15. Utilisation du Yocto-Meteo en Python #!/usr/bin/python # -*- coding: utf-8 -*- import os, from yocto_api import usage(): sys.exit("usage: demo <serial or logical name> [ON/OFF]") errmsg = YRefParam() if YAPI.RegisterHub("usb", errmsg) != YAPI.SUCCESS: sys.exit("RegisterHub error: " str(errmsg)) if len(sys.argv) <...
  • Page 115: Gestion Des Erreurs

    La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
  • Page 116 La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 117: Utilisation Du Yocto-Meteo En Java

    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.2. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code Java qui utilise la fonction Humidity. [...] // On récupère l'objet représentant le module (ici connecté...
  • Page 118 Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-Meteo avec le numéros de série METEOMK1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction humidity "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter toute...
  • Page 119: Contrôle De La Partie Module

    16. Utilisation du Yocto-Meteo en Java 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); YHumidity hsensor; YTemperature tsensor; YPressure psensor; (args.length == 0) { hsensor = YHumidity.FirstHumidity(); tsensor = YTemperature.FirstTemperature(); psensor = YPressure.FirstPressure();...
  • Page 120 16. Utilisation du Yocto-Meteo en Java (module == null) { System.out.println("No module connected (check USB cable)"); System.exit(1); } else { module = YModule.FindModule(args[0]); // use serial or logical name try { (args.length > 1) { if (args[1].equalsIgnoreCase("ON")) { module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF);...
  • Page 121 16. Utilisation du Yocto-Meteo en Java String newname; = YModule.FindModule(args[0]); // use serial or logical name try { newname = args[1]; if (!YAPI.CheckLogicalName(newname)) System.out.println("Invalid name (" newname + ")"); System.exit(1); m.set_logicalName(newname); m.saveToFlash(); // do not forget this System.out.println("Module: serial= "...
  • Page 122: Gestion Des Erreurs

    La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
  • Page 123: Utilisation Du Yocto-Meteo Avec Android

    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.
  • Page 124: Matériel Supporté

    "USB Host" en AndroidManifest.xml ajoutant le tag <uses-feature android:name="android.hardware.usb.host" /> dans la section manifest <manifest ...> <uses-feature android:name="android.hardware.usb.host" />; Les YoctoHub sont un moyen simple et efficace d'ajouter une connectivité réseau à vos modules Yoctopuce. http:// www.yoctopuce.com/FR/products/category/extensions-et-reseau www.yoctopuce.com...
  • Page 125: Lancement Automatique

    17. Utilisation du Yocto-Meteo avec Android </manifest> Lors du premier accès à un module Yoctopuce, Android va ouvrir une fenêtre pour informer l'utilisateur que l'application va accéder module connecté. L'utilisateur peut refuser ou autoriser l a c c è s au périphérique. Si l'utilisateur accepte, l'application pourra accéder au périphérique connecté...
  • Page 126: Contrôle De La Fonction Humidity

    17. Utilisation du Yocto-Meteo avec Android 17.5. Contrôle de la fonction Humidity Il suffit de quelques lignes de code pour piloter un Yocto-Meteo. Voici le squelette d'un fragment de code Java qui utilise la fonction Humidity. [...] // On récupère l'objet représentant le module (ici connecté en local sur USB) YAPI.EnableUSBHost(this);...
  • Page 127 17. Utilisation du Yocto-Meteo avec Android YTemperature.FindTemperature et YPressure.FindPressure fonctions YTemperature.FindTemperature YPressure.FindPressure permettent de travailler respectivement avec les mesures de temperature et de pression, et se manipulent exactement comme YHumidity.FindHumidity 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.
  • Page 128: Contrôle De La Partie Module

    17. Utilisation du Yocto-Meteo avec Android @Override protected void onStop() super.onStop(); handler.removeCallbacks(r); YAPI.FreeAPI(); @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long serial = parent.getItemAtPosition(pos).toString(); @Override public void onNothingSelected(AdapterView<?> arg0) final Runnable = new Runnable() public void run() (serial != null) {...
  • Page 129 17. Utilisation du Yocto-Meteo avec Android 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);...
  • Page 130 17. Utilisation du Yocto-Meteo avec Android @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long 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) (module == null) return;...
  • Page 131 17. Utilisation du Yocto-Meteo avec Android 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); = 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();...
  • Page 132 17. Utilisation du Yocto-Meteo avec Android 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();...
  • Page 133: Gestion Des Erreurs

    La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
  • Page 134 www.yoctopuce.com...
  • Page 135: Mise À Jour Du Firmware

    "mise à jour" et sera listé en dessous des modules connectés. 18.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 .
  • Page 136: La Librairie De Programmation

    (m.get_productName() == "YoctoHub-Wireless") { m.set_allSettings(default_config); = m.next(); Chercher le bon firmware La première étape pour mettre à jour un module Yoctopuce est de trouver quel firmware il faut utiliser, c'est le travail de la méthode de l'objet YModule. checkFirmware(path, onlynew) Cette méthode vérifie que le firmware passé...
  • Page 137: Mettre À Jour Le Firmware

    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 à...
  • Page 138: Particularité D'android

    à installer, et un tableau de bytes avec les paramètres à restaurer à la fin de la mise à jour (ou pour restaurer les paramètres d'origine). null YFirmwareUpdateupdate fw_update; fw_update = new YFirmwareUpdate(allBootLoader[0], newfirm, null); status = fw_update.startUpdate(); ..www.yoctopuce.com...
  • Page 139: Utilisation Avec Des Langages Non Supportés

    Il se trouve que le Virtual Hub est en fait un petit serveur Web qui est capable de router des requêtes HTTP vers les modules Yoctopuce. Ce qui signifie que si vous pouvez faire une requête HTTP depuis votre langage de programmation, vous pouvez contrôler des modules Yoctopuce, même si ce langage n'est pas officiellement supporté.
  • Page 140: Contrôle D'un Module Par L'interface Rest

    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-Meteo avec le numéro de de série METEOMK1-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.
  • Page 141: Accès Aux Données Enregistrées Sur Le Datalogger Par L'interface Rest

    19.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.
  • Page 142 (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. www.yoctopuce.com...
  • Page 143: Inventaire Des Modules

    19. Utilisation avec des langages non supportés 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.
  • Page 144: Port De La Librairie Haut Niveau

    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.
  • Page 145: Programmation Avancée

    Pour pouvoir être prévenu dès qu'un module arrive, vous avez besoin de trois morceaux de code. Le callback Le callback est la fonction qui sera appelée à chaque fois qu'un nouveau module Yoctopuce sera branché. Elle prend en paramètre le module concerné. static void deviceArrival(YModule www.yoctopuce.com...
  • Page 146: Détecter Le Changement De Valeur D'un Senseur

    à des moments où le programme principal n'est pas prêt à les recevoir, ce qui peut avoir des effets de bords indésirables comme des dead-locks et autres conditions de course. C'est pourquoi dans l'API Yoctopuce, les callbacks d'arrivée/départs de modules ne sont appelés que pendant l'exécution de la fonction .
  • Page 147 Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).
  • Page 148: L'enregistreur De Données

    YDataLogger = 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-Meteo peut enregistrer des www.yoctopuce.com...
  • Page 149: Effacement De La Mémoire

    à 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-Meteo, il faut appeler la méthode de la fonction désirée, en spécifiant l'intervalle de temps qui get_recordedData() nous intéresse.
  • Page 150 Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-Meteo 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-Meteo va automatiquement essayer de se mettre à...
  • Page 151: Calibration Des Senseurs

    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-Meteo. D'autre part l'API supporte une calibration arbitraire externe, implémentée à l'aide de callbacks.
  • Page 152 Correction de 3 à 5 points Les corrections de 3 à 5 points ne sont qu'une généralisation de la méthode à deux points, permettant de ainsi de créer jusqu' 4 intervalles de correction pour plus de précision. Ces intervalles ne peuvent pas être disjoints. www.yoctopuce.com...
  • Page 153: Interpolation Arbitraire

    Limitations En raison des limitations de stockage et de traitement des valeurs flottantes dans le module Yoctopuce, les valeurs des valeurs lues et des valeur corrigées doivent respecter certaines contraintes numériques: • Seules 3 décimales sont prises en compte (résolution de 0.001) •...
  • Page 154 20. Programmation avancée valeur avant de la renvoyer, permettant ainsi de corriger les mesures de manière totalement transparente. www.yoctopuce.com...
  • Page 155: Référence De L'api De Haut Niveau

    21. 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-Meteo. 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...
  • Page 156: Fonctions Générales

    21. Référence de l'API de haut niveau 21.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 à suffira en tout et pour tout. Ensuite, vous yRegisterHub() pourrez appeler la fonction globale correspondant à...
  • Page 157 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.
  • Page 158: Paramètres

    . 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. www.yoctopuce.com...
  • Page 159 Désactive le cache de callback HTTP. function yClearHTTPCallbackCacheDir( $bool_removeFiles) Cette méthode désctive la cache de callback HTTP, et permet également d'en effacer le contenu. Paramètres : Vrai pour effacer le contenu du répertoire de cache. bool_removeFiles Retourne : nothing. www.yoctopuce.com...
  • Page 160 ) void DisableExceptions( ) void DisableExceptions( ) def DisableExceptions( ) 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. www.yoctopuce.com...
  • Page 161 Attention, lorsque les exceptions sont activées, tout appel à une fonction de la librairie qui échoue déclenche une exception. Dans le cas où celle-ci n'est pas interceptée correctement par le code appelant, soit le debugger se lance, soit le programme de l'utilisateur est immédiatement stoppé (crash). www.yoctopuce.com...
  • Page 162 (ou d'une sous-classe). Il n'est pas nécessaire d'appeler cette fonction pour accéder au modules à travers le réseau. Paramètres : osContext un objet de classe android.content.Context (ou une sous-classe) www.yoctopuce.com...
  • Page 163 21. Référence de l'API de haut niveau YAPI.FreeAPI() YAPI yFreeAPI() Libère la mémoire dynamique utilisée par la librairie Yoctopuce. function yFreeAPI( ) void yFreeAPI( ) +(void) FreeAPI procedure yFreeAPI( ) procedure yFreeAPI( ) void FreeAPI( ) void FreeAPI( ) java...
  • Page 164 21. Référence de l'API de haut niveau YAPI.GetAPIVersion() YAPI yGetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée. function yGetAPIVersion( ) string yGetAPIVersion( ) +(NSString*) GetAPIVersion function yGetAPIVersion( ): string function yGetAPIVersion( ) As String String GetAPIVersion( ) String GetAPIVersion( )
  • Page 165 Cette méthode retourne la durée de mise en cache de tous les attributs des fonctions du module. Note: Cette fonction doit être appelée après yInitAPI Retourne : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes. www.yoctopuce.com...
  • Page 166 ) As Integer int GetDeviceListValidity( ) int GetDeviceListValidity( ) java Task<int> GetDeviceListValidity( ) def GetDeviceListValidity( ) function yGetDeviceListValidity( ) function GetDeviceListValidity( ) Note: Cette fonction doit être appelée après yInitAPI Retourne : le nombre de secondes entre chaque énumération. www.yoctopuce.com...
  • Page 167 GetTickCount( ) 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.
  • Page 168 Ce n'est pas strictement indispensable mais cela peut améliorer la réactivité des la librairie pour les commandes suivantes. Cette fonction peut signaler une erreur au cas à la communication avec un module Yoctopuce ne se passerait pas comme attendu.
  • Page 169 21. Référence de l'API de haut niveau YAPI.InitAPI() YAPI yInitAPI() Initialise la librairie de programmation de Yoctopuce explicitement. function yInitAPI( mode, errmsg) YRETCODE yInitAPI( int mode, string& errmsg) +(YRETCODE) InitAPI :(int) mode :(NSError**) errmsg function yInitAPI( mode: integer, var errmsg: string): integer...
  • Page 170 "usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 171 RegisterDeviceArrivalCallback( DeviceUpdateHandler arrivalCallback) def RegisterDeviceArrivalCallback( arrivalCallback) function yRegisterDeviceArrivalCallback( $arrivalCallback) function RegisterDeviceArrivalCallback( arrivalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : arrivalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
  • Page 172 RegisterDeviceRemovalCallback( DeviceUpdateHandler removalCallback) def RegisterDeviceRemovalCallback( removalCallback) function yRegisterDeviceRemovalCallback( $removalCallback) function RegisterDeviceRemovalCallback( removalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : removalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
  • Page 173 C'est un mode spécial permettant, entre autres, de prendre le contrôle de modules Yoctopuce à travers un filtre NAT par l'intermédiaire d'un VirtualHub ou d'un Hub Yoctopuce. Il vous suffit de configuer le hub pour qu'il appelle votre script à intervalle régulier. Ce mode de fonctionnement n'est disponible actuellement qu'en PHP et en Node.JS.
  • Page 174 21. Référence de l'API de haut niveau Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 175 , que vous devrez appeler régulièrement. yUpdateDeviceList Paramètres : une procédure qui prend deux chaîne de caractères en paramètre, le numéro de hubDiscoveryCallback série et l'URL du hub découvert. Pour supprimer un callback déjà enregistré, www.yoctopuce.com...
  • Page 176 YAPI.RegisterHubWebsocketCallback() YAPI 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 : l'objet WebSocket lié à au callback websocket entrant. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur.
  • Page 177 As yLogFunc) void RegisterLogFunction( yLogFunc logfun) void RegisterLogFunction( LogCallback logfun) java void RegisterLogFunction( LogHandler logfun) def RegisterLogFunction( logfun) Utile pour débugger le fonctionnement de l'API. Paramètres : logfun une procedure qui prend une chaîne de caractère en paramètre, www.yoctopuce.com...
  • Page 178 à la librairie pour forcer l'utilisation d'une SelectArchitecture() architecture spécifiée. Paramètres : arch une chaîne de caractère spécifiant l'architecture à utiliser. Les valeurs possibles sont "armhf" "armel" "i386" "x86_64" "32bit" "64bit" Retourne : rien. En cas d'erreur, déclenche une exception. www.yoctopuce.com...
  • Page 179 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. www.yoctopuce.com...
  • Page 180 (Objective-C uniquement) Enregistre un objet délégué qui doit se conformer au protocole YDeviceHotPlug +(void) SetDelegate :(id) object Les méthodes seront appelées pendant l’exécution de la yDeviceArrival yDeviceRemoval fonction , que vous devrez appeler régulièrement. yUpdateDeviceList Paramètres : object un objet qui soit se conformer au protocole YAPIDelegate , ou www.yoctopuce.com...
  • Page 181 à 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. www.yoctopuce.com...
  • Page 182 Il est recommandé d'utiliser un répertoire qui n'est pas accessible depuis le serveur Web, car la librairie va y stocker des données provenant des modules Yoctopuce. Note : Cette fonctionnalité est supportée par les YoctoHub et VirtualHub depuis la version 27750 Paramètres :...
  • Page 183 à la durée de l'attente, en millisecondes des arguments supplémentaires peuvent être fournis, pour être passés à la fonction de args callback si nécessaire. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 184 être activée que sur des tablette ou des téléphones qui posent problème. Un délais de 50 millisecondes est en général suffisant. En cas de doute contacter le support Yoctopuce. Pour désactiver la quittance des paquets USB, appeler cette fonction avec la valeur 0. Note : Cette fonctionnalité est disponible uniquement sous Android.
  • Page 185 à jour. yHandleEvents() Cette fonction peut signaler une erreur au cas à la communication avec un module Yoctopuce ne se passerait pas comme attendu. Paramètres : un entier correspondant à la durée de la pause, en millisecondes...
  • Page 186 éventuel errmsg message d'erreur. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 187 Paramètres : une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message errmsg d'erreur. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 188 21. Référence de l'API de haut niveau YAPI.UnregisterHub() YAPI yUnregisterHub() Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. function yUnregisterHub( url) void yUnregisterHub( const string& url) +(void) UnregisterHub :(NSString *)
  • Page 189 21. Référence de l'API de haut niveau YAPI.UpdateDeviceList() YAPI yUpdateDeviceList() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList( errmsg) YRETCODE yUpdateDeviceList( string& errmsg) +(YRETCODE) UpdateDeviceList :(NSError**) errmsg function yUpdateDeviceList( var errmsg: string): integer function yUpdateDeviceList( ByRef...
  • Page 190 YAPI.UpdateDeviceList_async() YAPI yUpdateDeviceList_async() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList_async( callback, context) La librairie va vérifier sur les machines ou ports USB précédemment enregistrés en utilisant la fonction si un module a été connecté ou déconnecté, et le cas échéant appeler les fonctions yRegisterHub de callback définies par l'utilisateur.
  • Page 191: Interface De Contrôle Du Module

    21. Référence de l'API de haut niveau 21.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.
  • Page 192 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() www.yoctopuce.com...
  • Page 193 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 get_userData méthode module→set_userVar(newval) www.yoctopuce.com...
  • Page 194 Prepare une mise à jour de firmware du module. module→updateFirmwareEx(path, force) Prepare une mise à jour de firmware du module. module→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 195 Retourne : YModule un objet de classe qui permet ensuite de contrôler le module ou d'obtenir de plus amples informations sur le module. www.yoctopuce.com...
  • Page 196 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le module sans ambiguïté func Retourne : YModule un objet de classe qui permet ensuite de contrôler le module. www.yoctopuce.com...
  • Page 197 ) function FirstModule( ) Utiliser la fonction pour itérer sur les autres modules. YModule.nextModule() Retourne : YModule null un pointeur sur un objet , correspondant au premier module accessible en ligne, ou aucun module n'a été trouvé. www.yoctopuce.com...
  • Page 198 Retourne : .byn le path du fichier à utiliser, ou une chaîne vide si aucun firmware plus récent n'est disponible En cas d'erreur, déclenche une exception ou retourne une chaine de caractère qui comment par "error:". www.yoctopuce.com...
  • Page 199 ) java def clearCache( ) 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. www.yoctopuce.com...
  • Page 200 ) String describe( ) java def describe( ) 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 www.yoctopuce.com...
  • Page 201 Task<byte[]> download( string pathname) def download( pathname) function download( $pathname) function download( pathname) YModule target download pathname Paramètres : pathname nom complet du fichier Retourne : le contenu du fichier chargé En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
  • Page 202 à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant au type de base de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 203 ) As Integer int functionCount( ) int functionCount( ) java def functionCount( ) 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. www.yoctopuce.com...
  • Page 204 à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant à l'identifiant matériel unique de la fonction désirée En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 205 à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant au nom logique de la fonction désirée En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 206 à 0 pour la functionIndex première fonction. Retourne : une chaîne de caractères correspondant au type de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 207 à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant à la valeur publiée par la fonction désirée En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 208 YModule target get_allSettings Utile pour sauvgarder les noms logiques, les calibrations et fichies uploadés d'un module. Retourne : un objet binaire avec tous les paramètres En cas d'erreur, déclenche une exception ou retourne un objet binaire de taille 0. www.yoctopuce.com...
  • Page 209 Task<int> get_beacon( ) def get_beacon( ) function get_beacon( ) function get_beacon( ) 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 www.yoctopuce.com...
  • Page 210 ) 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 www.yoctopuce.com...
  • Page 211 ) 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...
  • Page 212 Task<string> get_firmwareRelease( ) def get_firmwareRelease( ) function get_firmwareRelease( ) function get_firmwareRelease( ) 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 www.yoctopuce.com...
  • Page 213 ArrayList<String> get_functionIds( String funType) java Task<List<string>> get_functionIds( string funType) def get_functionIds( funType) function get_functionIds( $funType) function get_functionIds( funType) YModule target get_functionIds funType Paramètres : funType Le type de fonction (Relay, LightSensor, Voltage,...) Retourne : un tableau de chaînes de caractère. www.yoctopuce.com...
  • Page 214 ) String get_hardwareId( ) java def get_hardwareId( ) 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 www.yoctopuce.com...
  • Page 215 ) function get_icon2d( ) YModule target get_icon2d L'icone est au format PNG et a une taille maximale de 1536 octets. Retourne : un buffer binaire contenant l'icone, au format png. En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
  • Page 216 ) 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 YAPI_INVALID_STRING ou retourne www.yoctopuce.com...
  • Page 217 String get_logicalName( ) java Task<string> get_logicalName( ) def get_logicalName( ) function get_logicalName( ) function get_logicalName( ) YModule target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du module En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 218 Task<int> get_luminosity( ) def get_luminosity( ) function get_luminosity( ) function get_luminosity( ) YModule target get_luminosity Retourne : un entier représentant la luminosité des leds informatives du module (valeur entre 0 et 100) En cas d'erreur, déclenche une exception ou retourne Y_LUMINOSITY_INVALID www.yoctopuce.com...
  • Page 219 Si le module est connecté par USB, ou si le module est le YoctoHub racine, une chaîne vide est retournée. Retourne : une chaîne de caractères contenant le numéro de série du YoctoHub, ou une chaîne vide. www.yoctopuce.com...
  • Page 220 Task<int> get_persistentSettings( ) def get_persistentSettings( ) function get_persistentSettings( ) function get_persistentSettings( ) YModule target get_persistentSettings Retourne : une valeur parmi Y_PERSISTENTSETTINGS_LOADED Y_PERSISTENTSETTINGS_SAVED 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 www.yoctopuce.com...
  • Page 221 ) java Task<int> get_productId( ) def get_productId( ) function get_productId( ) function get_productId( ) YModule target get_productId Retourne : un entier représentant l'identifiant USB du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne Y_PRODUCTID_INVALID www.yoctopuce.com...
  • Page 222 Task<string> get_productName( ) def get_productName( ) function get_productName( ) function get_productName( ) YModule target get_productName Retourne : une chaîne de caractères représentant le nom commercial du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne Y_PRODUCTNAME_INVALID www.yoctopuce.com...
  • Page 223 Task<int> get_productRelease( ) def get_productRelease( ) function get_productRelease( ) function get_productRelease( ) 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 www.yoctopuce.com...
  • Page 224 ) function get_rebootCountdown( ) YModule target get_rebootCountdown Retourne : un entier représentant le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé En cas d'erreur, déclenche une exception ou retourne Y_REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...
  • Page 225 Task<string> get_serialNumber( ) def get_serialNumber( ) function get_serialNumber( ) function get_serialNumber( ) YModule target get_serialNumber Retourne : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne Y_SERIALNUMBER_INVALID www.yoctopuce.com...
  • Page 226 Cette fonction n'est pertinente que lorsqu'elle appelée pour un YoctoHub ou pour le VirtualHub. Dans le cas contraire, un tableau vide est retourné. Retourne : un tableau de chaînes de caractères contenant les numéros de série des sous-modules connectés au module www.yoctopuce.com...
  • Page 227 Task<long> get_upTime( ) def get_upTime( ) function get_upTime( ) function get_upTime( ) YModule target get_upTime Retourne : un entier représentant le numbre de millisecondes écoulées depuis la mise sous tension du module En cas d'erreur, déclenche une exception ou retourne Y_UPTIME_INVALID www.yoctopuce.com...
  • Page 228 Task<string> get_url( ) def get_url( ) function get_url( ) function get_url( ) YModule target get_url Si le module est connecté par USB la chaîne de caractère 'usb' est retournée. Retourne : une chaîne de caractère contenant l'URL du module. www.yoctopuce.com...
  • Page 229 Task<int> get_usbCurrent( ) def get_usbCurrent( ) function get_usbCurrent( ) function get_usbCurrent( ) YModule target get_usbCurrent Retourne : un entier représentant le courant consommé par le module sur le bus USB, en milliampères En cas d'erreur, déclenche une exception ou retourne Y_USBCURRENT_INVALID www.yoctopuce.com...
  • Page 230 Object get_userData( ) java def get_userData( ) function get_userData( ) function get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 231 ) YModule target get_userVar Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Retourne : un entier représentant la valeur entière précédemment stockée dans cet attribut En cas d'erreur, déclenche une exception ou retourne Y_USERVAR_INVALID www.yoctopuce.com...
  • Page 232 YModule target hasFunction funcId La méthode prend en paramètre l'identifiant de la fonction (relay1, voltage2,...) et retourne un booléen. Paramètres : funcId identifiant matériel de la fonction Retourne : vrai si le module inclut la fonction demandée www.yoctopuce.com...
  • Page 233 Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le module est joignable, false sinon www.yoctopuce.com...
  • Page 234 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 235 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 236 YAPI_SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 237 être inclus dans la chaîne de caractère. Paramètres : text le message à ajouter aux logs du module. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 238 ) As YModule YModule nextModule( ) YModule nextModule( ) java YModule nextModule( ) def nextModule( ) function nextModule( ) function nextModule( ) Retourne : YModule null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 239 $secBeforeReboot) function reboot( secBeforeReboot) YModule target reboot secBeforeReboot Paramètres : secBeforeReboot nombre de secondes avant de redémarrer Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 240 La fonction de callback doit accepter deux arguments: l’objet YModule dont la balise a changé, et un entier représentant l'état de la balise de localisation. Paramètres : callback null la fonction de callback à rappeler, ou www.yoctopuce.com...
  • Page 241 ) As Integer int registerConfigChangeCallback( ConfigChangeCallback callback) int registerConfigChangeCallback( ConfigChangeCallback callback) java Task<int> registerConfigChangeCallback( ConfigChangeCallback callback) def registerConfigChangeCallback( callback) function registerConfigChangeCallback( $callback) function registerConfigChangeCallback( callback) Paramètres : callback une procédure qui prend un YModule en paramètre, ou null www.yoctopuce.com...
  • Page 242 LogCallback callback) void registerLogCallback( LogCallback callback) java def registerLogCallback( callback) Utile pour débugger le fonctionnement d'un module Yoctopuce. Paramètres : la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux callback arguments: l'objet module qui a produit un log, un chaîne de caractère qui contiens le log...
  • Page 243 ) java Task<int> revertFromFlash( ) def revertFromFlash( ) function revertFromFlash( ) function revertFromFlash( ) YModule target revertFromFlash Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 244 Attention le nombre total de sauvegardes possibles durant la vie du module est limité (environ 100000 cycles). N'appelez pas cette fonction dans une boucle. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 245 être préservés. Paramètres : un objet binaire avec touts les paramètres settings Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 246 être préservés. Paramètres : un buffer binaire avec touts les paramètres settings Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 247 $newval) function set_beacon( newval) YModule target set_beacon newval Paramètres : newval soit Y_BEACON_OFF , soit Y_BEACON_ON Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 248 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 249 être préservé. Paramètres : un entier représentant la luminosité des leds informatives du module newval Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 250 Object data) java def set_userData( data) function set_userData( $data) function set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 251 Cet attribut est à la disposition du programmeur pour y stocker par exemple une variable d'état. Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Paramètres : newval un entier Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 252 ) int triggerConfigChangeCallback( ) -(int) triggerConfigChangeCallback function triggerConfigChangeCallback( ): LongInt function triggerConfigChangeCallback( ) As Integer int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) java Task<int> triggerConfigChangeCallback( ) def triggerConfigChangeCallback( ) function triggerConfigChangeCallback( ) function triggerConfigChangeCallback( ) YModule target triggerConfigChangeCallback www.yoctopuce.com...
  • Page 253 $secBeforeReboot) function triggerFirmwareUpdate( secBeforeReboot) YModule target triggerFirmwareUpdate secBeforeReboot Paramètres : secBeforeReboot nombre de secondes avant de redémarrer Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 254 Cette méthode retourne un object qui est utilisé pour mettre à jour le firmware du YFirmwareUpdate module. Paramètres : path le path du fichier .byn à utiliser Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 255 à jour le firmware du YFirmwareUpdate module. Paramètres : path .byn le path du fichier à utiliser force vrai pour forceer la mise à jour même si un prérequis ne semble pas satisfait Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 256 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 257: Interface De La Fonction Humidity

    21. Référence de l'API de haut niveau 21.3. Interface de la fonction Humidity La classe YHumidity permet de lire et de configurer les capteurs d'humidité Yoctopuce. Elle hérite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de données.
  • Page 258 Retourne la valeur minimale observée pour l'humidité depuis le démarrage du module. humidity→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. humidity→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. humidity→get_recordedData(startTime, endTime) Retourne un objet DataSet représentant des mesures de ce capteur précédemment enregistrées à...
  • Page 259 Change l'unité principale dans laquelle l'humidité est exprimée. humidity→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 humidity→startDataLogger() Démarre l'enregistreur de données du module. humidity→stopDataLogger() www.yoctopuce.com...
  • Page 260 Arrête l'enregistreur de données du module. humidity→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. humidity→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 261 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence le capteur d'humidité sans ambiguïté func Retourne : un objet de classe YHumidity qui permet ensuite de contrôler le capteur d'humidité. www.yoctopuce.com...
  • Page 262 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le capteur d'humidité sans ambiguïté func Retourne : YHumidity un objet de classe qui permet ensuite de contrôler le capteur d'humidité. www.yoctopuce.com...
  • Page 263 Utiliser la fonction pour itérer sur les autres capteurs d'humidité. YHumidity.nextHumidity() Retourne : YHumidity un pointeur sur un objet , correspondant au premier capteur d'humidité accessible en ligne, ou null si il n'y a pas de capteurs d'humidité disponibles. www.yoctopuce.com...
  • Page 264 YHumidity.nextHumidity() Paramètres : un contexte YAPI. yctx Retourne : YHumidity un pointeur sur un objet , correspondant au premier capteur d'humidité accessible en ligne, ou null si il n'y a pas de capteurs d'humidité disponibles. www.yoctopuce.com...
  • Page 265 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.
  • Page 266 ) java def clearCache( ) function clearCache( ) function clearCache( ) Invalide le cache des valeurs courantes du capteur d'humidité. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 267 è r e s d é c r i v a n t c a p t e u r d ' h u m i d i t é ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 268 ) function get_absHum( ) function get_absHum( ) YHumidity target get_absHum Retourne : une valeur numérique représentant la valeur actuelle de l'humidité absolue, en gramme par mètre cube d'air En cas d'erreur, déclenche une exception ou retourne Y_ABSHUM_INVALID www.yoctopuce.com...
  • Page 269 Y _ A D V M O D E _ P E R I O D _ A V G Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...
  • Page 270 ) function get_advertisedValue( ) function get_advertisedValue( ) YHumidity target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur d'humidité (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 271 ) YHumidity target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en %RH, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 272: Retourne La Valeur Actuelle De L'humidité, En %Rh, Sous Forme De Nombre À Virgule

    ) function get_currentValue( ) function get_currentValue( ) YHumidity target get_currentValue Retourne : une valeur numérique représentant la valeur actuelle de l'humidité, en %RH, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTVALUE_INVALID www.yoctopuce.com...
  • Page 273: Humidity→Get_Datalogger()

    Cette méthode retourne un objet de la classe YDataLogger qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : un objet de classe YDataLogger ou null en cas d'erreur. www.yoctopuce.com...
  • Page 274: Humidity→Get_Errormessage()

    ) 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 capteur d'humidité.
  • Page 275: Humidity→Get_Errortype()

    ) 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 capteur d'humidité.
  • Page 276: Humidity→Get_Friendlyname()

    (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur d'humidité en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 277: Humidity→Get_Functiondescriptor()

    é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 278: Humidity→Get_Functionid()

    ) String get_functionId( ) java def get_functionId( ) function get_functionId( ) function get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le capteur d'humidité (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 279: Humidity→Get_Hardwareid()

    L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur d'humidité (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le capteur d'humidité (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 280: Humidity→Get_Highestvalue()

    YHumidity target get_highestValue Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour l'humidité depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 281: Humidity→Get_Logfrequency()

    Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 282: Humidity→Get_Logicalname()

    String get_logicalName( ) java Task<string> get_logicalName( ) def get_logicalName( ) function get_logicalName( ) function get_logicalName( ) YHumidity target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur d'humidité. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 283: Humidity→Get_Lowestvalue()

    YHumidity target get_lowestValue Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour l'humidité depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 284: Retourne L'objet Ymodule Correspondant Au Module Yoctopuce Qui Héberge La Fonction

    21. Référence de l'API de haut niveau YHumidity humidity→get_module() humidity→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 285: Retourne L'objet Ymodule Correspondant Au Module Yoctopuce Qui Héberge La Fonction

    21. Référence de l'API de haut niveau YHumidity humidity→get_module_async() humidity→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 286: Retourne Un Objet Dataset Représentant Des Mesures De Ce Capteur Précédemment Enregistrées À L'aide Du

    à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : une instance de YDataSet, dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
  • Page 287: Retourne La Valeur Actuelle De L'humidité Relative, En Pour Cent

    Task<double> get_relHum( ) def get_relHum( ) function get_relHum( ) function get_relHum( ) YHumidity target get_relHum Retourne : une valeur numérique représentant la valeur actuelle de l'humidité relative, en pour cent En cas d'erreur, déclenche une exception ou retourne Y_RELHUM_INVALID www.yoctopuce.com...
  • Page 288: Humidity→Get_Reportfrequency()

    ) YHumidity target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 289: Humidity→Get_Resolution()

    La résolution correspond à la précision numérique de la représentation des mesures. Elle n'est pas forcément identique à la précision réelle du capteur. Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 290: Humidity→Get_Sensorstate()

    En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 291 String get_unit( ) java Task<string> get_unit( ) def get_unit( ) function get_unit( ) function get_unit( ) YHumidity target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle l'humidité est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 292 Object get_userData( ) java def get_userData( ) function get_userData( ) function get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 293 Si les valeurs des attributs en cache du capteur d'humidité sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le capteur d'humidité est joignable, false sinon www.yoctopuce.com...
  • Page 294 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 295 Retourne faux si le module n'est pas joignable, ou que le capteur n'a pas de mesure actuelle à communiquer. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur dispose d'une mesure actuelle, sinon www.yoctopuce.com...
  • Page 296 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 297: Paramètres

    $attrName) function loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 298 Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 299 YAPI_SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 300 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 301 ) As YHumidity YHumidity nextHumidity( ) YHumidity nextHumidity( ) java YHumidity nextHumidity( ) def nextHumidity( ) function nextHumidity( ) function nextHumidity( ) Retourne : YHumidity null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 302 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et un objet YMeasure décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 303 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 304 Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 305 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur maximale observée Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 306 "OFF". Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 307 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur d'humidité. Retourne : YAPI_SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 308 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur minimale observée Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 309 "OFF". Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 310 La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. Paramètres : newval une valeur numérique représentant la résolution des valeurs physique mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 311 N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Paramètres : newval une chaîne de caractères Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 312 Object data) java def set_userData( data) function set_userData( $data) function set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 313 ) function startDataLogger( ) function startDataLogger( ) YHumidity target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 314 ): LongInt function stopDataLogger( ) As Integer int stopDataLogger( ) int stopDataLogger( ) java Task<int> stopDataLogger( ) def stopDataLogger( ) function stopDataLogger( ) function stopDataLogger( ) YHumidity target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 315 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 316 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 317: Interface De La Fonction Pressure

    21. Référence de l'API de haut niveau 21.4. 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.
  • Page 318 Retourne la valeur minimale observée pour la pression depuis le démarrage du module. pressure→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. pressure→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. pressure→get_recordedData(startTime, endTime) Retourne un objet DataSet représentant des mesures de ce capteur précédemment enregistrées à...
  • Page 319 Arrête l'enregistreur de données du module. pressure→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. pressure→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 320 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence le capteur de pression sans ambiguïté func Retourne : un objet de classe YPressure qui permet ensuite de contrôler le capteur de pression. www.yoctopuce.com...
  • Page 321 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le capteur de pression sans ambiguïté func Retourne : YPressure un objet de classe qui permet ensuite de contrôler le capteur de pression. www.yoctopuce.com...
  • Page 322 Utiliser la fonction pour itérer sur les autres capteurs de pression. YPressure.nextPressure() Retourne : YPressure un pointeur sur un objet , correspondant au premier capteur de pression accessible en ligne, null si il n'y a pas de capteurs de pression disponibles. www.yoctopuce.com...
  • Page 323 YPressure.nextPressure() Paramètres : un contexte YAPI. yctx Retourne : YPressure un pointeur sur un objet , correspondant au premier capteur de pression accessible en ligne, null si il n'y a pas de capteurs de pression disponibles. www.yoctopuce.com...
  • Page 324 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.
  • Page 325 ) java def clearCache( ) function clearCache( ) function clearCache( ) Invalide le cache des valeurs courantes du capteur de pression. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 326 è r e s d é c r i v a n t c a p t e u r p r e s s i o n ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 327 Y _ A D V M O D E _ P E R I O D _ A V G Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...
  • Page 328 ) function get_advertisedValue( ) function get_advertisedValue( ) YPressure target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur de pression (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 329 ) YPressure target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en millibar (hPa), sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 330 ) function get_currentValue( ) YPressure target get_currentValue Retourne : une valeur numérique représentant la valeur actuelle de la pression, en millibar (hPa), sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTVALUE_INVALID www.yoctopuce.com...
  • Page 331: Retourne L'objet Ydatalogger Du Module Qui Héberge Le Senseur

    Cette méthode retourne un objet de la classe YDataLogger qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : un objet de classe YDataLogger ou null en cas d'erreur. www.yoctopuce.com...
  • Page 332: Pressure→Get_Errormessage()

    ) 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 capteur de pression.
  • Page 333 ) 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 capteur de pression.
  • Page 334: Pressure→Get_Friendlyname()

    (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur de pression en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 335: Pressure→Get_Functiondescriptor()

    é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 336: Pressure→Get_Functionid()

    ) String get_functionId( ) java def get_functionId( ) function get_functionId( ) function get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le capteur de pression (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 337: Pressure→Get_Hardwareid()

    L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de pression (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le capteur de pression (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 338: Pressure→Get_Highestvalue()

    Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour la pression depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 339: Pressure→Get_Logfrequency()

    Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 340: Pressure→Get_Logicalname()

    Task<string> get_logicalName( ) def get_logicalName( ) function get_logicalName( ) function get_logicalName( ) YPressure target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur de pression. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 341: Pressure→Get_Lowestvalue()

    Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour la pression depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 342 21. Référence de l'API de haut niveau YPressure pressure→get_module() pressure→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 343: Pressure→Get_Module()

    21. Référence de l'API de haut niveau YPressure pressure→get_module_async() pressure→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 344: Retourne Un Objet Dataset Représentant Des Mesures De Ce Capteur Précédemment Enregistrées À L'aide Du

    à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : une instance de YDataSet, dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
  • Page 345: Pressure→Get_Reportfrequency()

    ) YPressure target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 346: Pressure→Get_Resolution()

    La résolution correspond à la précision numérique de la représentation des mesures. Elle n'est pas forcément identique à la précision réelle du capteur. Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 347: Pressure→Get_Sensorstate()

    En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 348 Task<string> get_unit( ) def get_unit( ) function get_unit( ) function get_unit( ) YPressure target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la pression est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 349 Object get_userData( ) java def get_userData( ) function get_userData( ) function get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 350: Pressure→Isonline()

    Si les valeurs des attributs en cache du capteur de pression sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le capteur de pression est joignable, false sinon www.yoctopuce.com...
  • Page 351: Pressure→Isonline_Async(Callback, Context)

    à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 352 Retourne faux si le module n'est pas joignable, ou que le capteur n'a pas de mesure actuelle à communiquer. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur dispose d'une mesure actuelle, sinon www.yoctopuce.com...
  • Page 353 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 354: Paramètres

    $attrName) function loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 355 Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 356 YAPI_SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 357 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 358 ) As YPressure YPressure nextPressure( ) YPressure nextPressure( ) java YPressure nextPressure( ) def nextPressure( ) function nextPressure( ) function nextPressure( ) Retourne : YPressure null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 359 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et un objet YMeasure décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 360 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 361 Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 362 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur maximale observée Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 363 "OFF". Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 364 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de pression. Retourne : YAPI_SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 365 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur minimale observée Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 366 "OFF". Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 367 La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. Paramètres : newval une valeur numérique représentant la résolution des valeurs physique mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 368 Object data) java def set_userData( data) function set_userData( $data) function set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 369 ) function startDataLogger( ) function startDataLogger( ) YPressure target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 370 ): LongInt function stopDataLogger( ) As Integer int stopDataLogger( ) int stopDataLogger( ) java Task<int> stopDataLogger( ) def stopDataLogger( ) function stopDataLogger( ) function stopDataLogger( ) YPressure target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 371 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 372 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 373: 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).
  • Page 374 Retourne la valeur minimale observée pour la température depuis le démarrage du module. temperature→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. temperature→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. temperature→get_recordedData(startTime, endTime) Retourne un objet DataSet représentant des mesures de ce capteur précédemment enregistrées à...
  • Page 375 Modifie la mémoire de valeur minimale observée. temperature→set_ntcParameters(res25, beta) Configure les paramètres d'un thermistor NTC pour calculer correctement la température sur la base de la résistance mesurée. temperature→set_reportFrequency(newval) Modifie la fréquence de notification périodique des valeurs mesurées. temperature→set_resolution(newval) www.yoctopuce.com...
  • Page 376 Arrête l'enregistreur de données du module. temperature→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. temperature→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 377 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence le capteur de température sans ambiguïté func Retourne : un objet de classe YTemperature qui permet ensuite de contrôler le capteur de température. www.yoctopuce.com...
  • Page 378 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le capteur de température sans ambiguïté Retourne : YTemperature un objet de classe qui permet ensuite de contrôler le capteur de température. www.yoctopuce.com...
  • Page 379 YTemperature.nextTemperature() température. Retourne : YTemperature un pointeur sur un objet , correspondant au premier capteur de température accessible en ligne, ou null si il n'y a pas de capteurs de température disponibles. www.yoctopuce.com...
  • Page 380 YTemperature.nextTemperature() température. Paramètres : un contexte YAPI. yctx Retourne : YTemperature un pointeur sur un objet , correspondant au premier capteur de température accessible en ligne, ou null si il n'y a pas de capteurs de température disponibles. www.yoctopuce.com...
  • Page 381: Paramètres

    être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.
  • Page 382 ) java def clearCache( ) function clearCache( ) function clearCache( ) Invalide le cache des valeurs courantes du capteur de température. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 383 è r e s d é c r i v a n t c a p t e u r t e m p é r a t u r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 384 Y _ A D V M O D E _ P E R I O D _ A V G Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...
  • Page 385 ) function get_advertisedValue( ) function get_advertisedValue( ) YTemperature target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur de température (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 386 ) YTemperature target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en degrés Celsius, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 387 ) function get_currentValue( ) YTemperature target get_currentValue Retourne : une valeur numérique représentant la valeur actuelle de la température, en degrés Celsius, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTVALUE_INVALID www.yoctopuce.com...
  • Page 388: Temperature→Get_Datalogger()

    Cette méthode retourne un objet de la classe YDataLogger qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : un objet de classe YDataLogger ou null en cas d'erreur. www.yoctopuce.com...
  • Page 389: Temperature→Get_Errormessage()

    ) 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 capteur de température.
  • Page 390 ) 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 capteur de température.
  • Page 391: Temperature→Get_Friendlyname()

    (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur de température en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 392 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 393: Temperature→Get_Functionid()

    ) String get_functionId( ) java def get_functionId( ) function get_functionId( ) function get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le capteur de température (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 394: Temperature→Get_Hardwareid()

    L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de température (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le capteur de température (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 395: Temperature→Get_Highestvalue()

    Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour la température depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 396: Temperature→Get_Logfrequency()

    Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 397 Task<string> get_logicalName( ) def get_logicalName( ) function get_logicalName( ) function get_logicalName( ) YTemperature target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur de température. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 398 Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour la température depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 399 21. Référence de l'API de haut niveau YTemperature temperature→get_module() temperature→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 400 21. Référence de l'API de haut niveau YTemperature temperature→get_module_async() temperature→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 401 à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : une instance de YDataSet, dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
  • Page 402 ) YTemperature target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 403 La résolution correspond à la précision numérique de la représentation des mesures. Elle n'est pas forcément identique à la précision réelle du capteur. Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 404 En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 405 Y _ S E N S O R T Y P E _ P T 1 0 0 _ 3 W I R E S Y_SENSORTYPE_PT100_2WIRES Y_SENSORTYPE_RES_OHM Y_SENSORTYPE_RES_NTC Y_SENSORTYPE_RES_LINEAR Y_SENSORTYPE_RES_INTERNAL représentant le type de capteur de température utilisé par le module En cas d'erreur, déclenche une exception ou retourne Y_SENSORTYPE_INVALID www.yoctopuce.com...
  • Page 406 Task<string> get_signalUnit( ) def get_signalUnit( ) function get_signalUnit( ) function get_signalUnit( ) YTemperature target get_signalUnit Retourne : une chaîne de caractères représentant l'unité du signal électrique utilisé par le capteur En cas d'erreur, déclenche une exception ou retourne Y_SIGNALUNIT_INVALID www.yoctopuce.com...
  • Page 407 Task<double> get_signalValue( ) def get_signalValue( ) function get_signalValue( ) function get_signalValue( ) YTemperature target get_signalValue Retourne : une valeur numérique représentant la valeur actuelle du signal électrique mesuré par le capteur En cas d'erreur, déclenche une exception ou retourne Y_SIGNALVALUE_INVALID www.yoctopuce.com...
  • Page 408 Task<string> get_unit( ) def get_unit( ) function get_unit( ) function get_unit( ) YTemperature target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la température est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 409 Object get_userData( ) java def get_userData( ) function get_userData( ) function get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 410 Si les valeurs des attributs en cache du capteur de température sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le capteur de température est joignable, false sinon www.yoctopuce.com...
  • Page 411 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 412 Retourne faux si le module n'est pas joignable, ou que le capteur n'a pas de mesure actuelle à communiquer. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur dispose d'une mesure actuelle, sinon www.yoctopuce.com...
  • Page 413 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 414: Paramètres

    $attrName) function loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 415 Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 416 (en Ohms) resValues pour chacun des points de température, index par index. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 417 YAPI_SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 418 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 419 ) As YTemperature YTemperature nextTemperature( ) YTemperature nextTemperature( ) java YTemperature nextTemperature( ) def nextTemperature( ) function nextTemperature( ) function nextTemperature( ) Retourne : YTemperature null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 420 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et un objet YMeasure décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 421 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 422 Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 423 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur maximale observée Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 424 "OFF". Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 425 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de température. Retourne : YAPI_SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 426 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur minimale observée Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 427 Cette fonction ne peut être utilisée qu'avec les capteurs de température basés sur un thermistor. Paramètres : res25 résistance à 25 degrés Celsius beta coefficient Beta Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 428 "OFF". Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 429 La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. Paramètres : newval une valeur numérique représentant la résolution des valeurs physique mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 430 Y _ S E N S O R T Y P E _ R E S _ L I N E A R Y_SENSORTYPE_RES_INTERNAL représentant le type de senseur utilisé par le module Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 431 (en Ohms) pour chacun des points de température, index par index. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 432 Attention: si une calibration spécifique est définie pour la fonction temperature, un changement d'unité a toutes les chances de la fausser. Paramètres : une chaîne de caractères newval Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 433 Object data) java def set_userData( data) function set_userData( $data) function set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 434 ) function startDataLogger( ) function startDataLogger( ) YTemperature target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 435 ): LongInt function stopDataLogger( ) As Integer int stopDataLogger( ) int stopDataLogger( ) java Task<int> stopDataLogger( ) def stopDataLogger( ) function stopDataLogger( ) function stopDataLogger( ) YTemperature target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 436 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 437 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 438: Interface De La Fonction Datalogger

    21. Référence de l'API de haut niveau 21.6. 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.
  • Page 439 Retourne l'identifiant matériel unique de l'enregistreur de données au format datalogger→get_logicalName() Retourne le nom logique de l'enregistreur de données. datalogger→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_recording() Retourne l'état d'activation de l'enregistreur de données.
  • Page 440 Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la get_userData méthode datalogger→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. datalogger→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 441 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté func Retourne : un objet de classe YDataLogger qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 442 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 443 YDataLogger.nextDataLogger() données. Retourne : YDataLogger un pointeur sur un objet , correspondant au premier enregistreur de données accessible en ligne, ou null si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 444 YDataLogger.nextDataLogger() données. Paramètres : un contexte YAPI. yctx Retourne : YDataLogger un pointeur sur un objet , correspondant au premier enregistreur de données accessible en ligne, ou null si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 445 ) java def clearCache( ) function clearCache( ) function clearCache( ) Invalide le cache des valeurs courantes de l'enregistreur de données. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 446 è r e s d é c r i v a n t l ' e n r e g i s t r e u r d o n n é e s ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 447 ) function forgetAllDataStreams( ) YDataLogger target forgetAllDataStreams Cette méthode remet aussi à zéro le compteur de Runs. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 448 ) function get_advertisedValue( ) function get_advertisedValue( ) YDataLogger target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'enregistreur de données (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 449 ) function get_autoStart( ) YDataLogger target get_autoStart Retourne : soit Y_AUTOSTART_OFF , soit Y_AUTOSTART_ON , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension En cas d'erreur, déclenche une exception ou retourne Y_AUTOSTART_INVALID www.yoctopuce.com...
  • Page 450 ) function get_beaconDriven( ) YDataLogger target get_beaconDriven Retourne : soit Y_BEACONDRIVEN_OFF , soit Y_BEACONDRIVEN_ON , selon vrais si l'enregistreur de données est synchronisé avec la balise de localisation En cas d'erreur, déclenche une exception ou retourne Y_BEACONDRIVEN_INVALID www.yoctopuce.com...
  • Page 451 Retourne : un entier représentant le 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 En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRUNINDEX_INVALID www.yoctopuce.com...
  • Page 452 Cette méthode ne fonctionne que si le module utilise un firmware récent, car les objets YDataSet ne sont pas supportés par les firmwares antérieurs à la révision 13000. Retourne : une liste d'objets YDataSet En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 453 Paramètres : un tableau de YDataStreams qui sera rempli avec les séquences trouvées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 454 ) 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 de l'enregistreur de données.
  • Page 455 ) 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 de l'enregistreur de données.
  • Page 456 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 457 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 458 ) String get_functionId( ) java def get_functionId( ) function get_functionId( ) function get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'enregistreur de données (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 459 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'enregistreur de données (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant l'enregistreur de données (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 460 Task<string> get_logicalName( ) def get_logicalName( ) function get_logicalName( ) function get_logicalName( ) YDataLogger target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'enregistreur de données. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 461 21. Référence de l'API de haut niveau YDataLogger datalogger→get_module() datalogger→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 462 21. Référence de l'API de haut niveau YDataLogger datalogger→get_module_async() datalogger→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 463 Task<int> get_recording( ) def get_recording( ) function get_recording( ) function get_recording( ) YDataLogger target get_recording Retourne : une valeur parmi Y_RECORDING_OFF Y_RECORDING_ON Y_RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_RECORDING_INVALID www.yoctopuce.com...
  • Page 464 Task<long> get_timeUTC( ) def get_timeUTC( ) function get_timeUTC( ) function get_timeUTC( ) YDataLogger target get_timeUTC Retourne : un entier représentant le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue En cas d'erreur, déclenche une exception ou retourne Y_TIMEUTC_INVALID www.yoctopuce.com...
  • Page 465 Object get_userData( ) java def get_userData( ) function get_userData( ) function get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 466 Si les valeurs des attributs en cache de l'enregistreur de données sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si l'enregistreur de données est joignable, false sinon www.yoctopuce.com...
  • Page 467 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 468 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 469: Paramètres

    $attrName) function loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 470 YAPI_SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 471 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 472 ) As YDataLogger YDataLogger nextDataLogger( ) YDataLogger nextDataLogger( ) java YDataLogger nextDataLogger( ) def nextDataLogger( ) function nextDataLogger( ) function nextDataLogger( ) Retourne : YDataLogger null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 473 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 474 , soit , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 475 Paramètres : newval Y_BEACONDRIVEN_OFF Y_BEACONDRIVEN_ON soit , soit , selon le mode de synchronisation de l'enregistreur de données Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 476 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'enregistreur de données. Retourne : YAPI_SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 477 Y _ R E C O R D I N G _ O N Y_RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 478 Paramètres : newval un entier représentant la référence de temps UTC, afin de l'attacher aux données enregistrées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 479 Object data) java def set_userData( data) function set_userData( $data) function set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 480 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 481 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 482: Séquence De Données Enregistrées

    Pour utiliser les fonctions décrites ici, vous devez inclure: <script type='text/javascript' src='yocto_api.js'></script> #include "yocto_api.h" #import "yocto_api.h" uses yocto_api; yocto_api.vb yocto_api.cs import com.yoctopuce.YoctoAPI.YModule; java import com.yoctopuce.YoctoAPI.YModule; from yocto_api import * require_once('yocto_api.php'); in HTML: <script src="../../lib/yocto_api.js"></script> in node.js: require('yoctolib-es2017/yocto_api.js'); Méthodes des objets YDataSet dataset→get_endTimeUTC()
  • Page 483 Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, et met à jour l'indicateur d'avancement. dataset→loadMore_async(callback, context) Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, de manière asynchrone. www.yoctopuce.com...
  • Page 484 , l'heure de fin est mise à jour à la get_dataSet loadMore() dernière mesure effectivement disponible dans l'enregistreur de données pour la plage spécifiée. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la dernière mesure. www.yoctopuce.com...
  • Page 485 ): string function get_functionId( ) As String string get_functionId( ) String get_functionId( ) java Task<string> get_functionId( ) def get_functionId( ) function get_functionId( ) function get_functionId( ) Par example temperature1 Retourne : une chaîne de caractères identifiant la fonction (ex: temperature1 www.yoctopuce.com...
  • Page 486 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example THRMCPL1-123456.temperature1 Retourne : THRMCPL1-123456.temperature1 une chaîne de caractères identifiant la fonction (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 487 UTC de l'enregistreur de données pendant l'enregistrement. Retourne : un tableau d'enregistrements, chaque enregistrement représentant une mesure effectuée à un moment précis. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 488 Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 489 Le résumé des mesures est disponible dès que a été appelé pour la première fois. loadMore() Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 490 , l'avancement est nul. Au fur et à mesure get_dataSet() des appels à loadMore() , l'avancement progresse pour atteindre la valeur 100 lorsque toutes les mesures ont été chargées. Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées. www.yoctopuce.com...
  • Page 491 à jour à la première mesure effectivement disponible dans l'enregistreur de données pour la plage spécifiée. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la première mesure enregistrée. www.yoctopuce.com...
  • Page 492 - la valeur minimale observée dans l'intervalle de temps - la valeur moyenne observée dans l'intervalle de temps - la valeur maximale observée dans l'intervalle de temps Ce résumé des mesures est disponible dès que a été appelé pour la première fois. loadMore() Retourne : un objet YMeasure www.yoctopuce.com...
  • Page 493 ) As String string get_unit( ) String get_unit( ) java Task<string> get_unit( ) def get_unit( ) function get_unit( ) function get_unit( ) Retourne : une chaîne de caractères représentant une unité physique. En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 494 ) Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées, ou un code d'erreur négatif en cas de problème. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 495 - l'objet YDataSet dont la méthode loadMore_async a été appelée - le résultat de l'appel: soit l'état d'avancement du chargement (0...100), ou un code d'erreur négatif en cas de problème. context variable de contexte à disposition de l'utilisateur Retourne : rien. www.yoctopuce.com...
  • Page 496: Valeur Mesurée

    21. Référence de l'API de haut niveau 21.8. Valeur mesurée Les objets YMeasure sont utilisés dans l'interface de programmation Yoctopuce pour représenter une valeur observée un moment donnée. Ces objets sont utilisés en particulier en conjonction avec la classe YDataSet.
  • Page 497 ): double function get_averageValue( ) As Double double get_averageValue( ) double get_averageValue( ) java double get_averageValue( ) def get_averageValue( ) function get_averageValue( ) function get_averageValue( ) Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 498 Lors que l'enregistrement de données se fait à une fréquence supérieure à une mesure par seconde, le timestamp peuvent inclurent une fraction décimale. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
  • Page 499 ): double function get_maxValue( ) As Double double get_maxValue( ) double get_maxValue( ) java double get_maxValue( ) def get_maxValue( ) function get_maxValue( ) function get_maxValue( ) Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 500 ): double function get_minValue( ) As Double double get_minValue( ) double get_minValue( ) java double get_minValue( ) def get_minValue( ) function get_minValue( ) function get_minValue( ) Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 501 Lors que l'enregistrement de données se fait à une fréquence supérieure à une mesure par seconde, le timestamp peuvent inclurent une fraction décimale. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la début de la mesure. www.yoctopuce.com...
  • Page 502 www.yoctopuce.com...
  • Page 503: Problèmes Courants

    22.1. Par où commencer ? Si c'est la première fois que vous utilisez un module Yoctopuce et ne savez pas trop par où commencer, allez donc jeter un coup d'il sur le blog de Yoctopuce. Il y a une section dédiée aux débutants 22.2.
  • Page 504: Plateformes Arm: Hf Et El

    22.5. Module alimenté mais invisible pour l'OS Si votre Yocto-Meteo est branché par USB et que sa LED bleue s'allume, mais que le module n'est pas vu par le système d'exploitation, vérifiez que vous utilisez bien un vrai câble USB avec les fils pour les données, et non pas un câble de charge.
  • Page 505: Déconnexions, Comportement Erratique

    22. Problèmes courants 22.7. Déconnexions, comportement erratique Si votre Yocto-Meteo se comporte de manière erratique et/ou se déconnecte du bus USB sans raison apparente, vérifiez qu'il est alimenté correctement. Evitez les câbles d'une longueur supérieure à 2 mètres. Au besoin, intercalez un hub USB alimenté...
  • Page 506 www.yoctopuce.com...
  • Page 507: Caractéristiques

    23. Caractéristiques Vous trouverez résumées ci dessous les principales caractéristiques techniques de votre module Yocto-Meteo Connecteur USB micro-B Largeur 20 mm Longueur 60 mm Poids Senseur SHT25 (Sensirion), MPL3115A2 (Freescale) Fréquence de rafraîchissement 1 Hz Plage de mesure (H) 0..100 % Plage de mesure (P) 200..1100 mbar...
  • Page 508 23. Caractéristiques www.yoctopuce.com...

Table des Matières