Yoctopuce Yocto-3D-V2 Mode D'emploi

Module électronique de 51x20mm qui dispose d'un accéléromètre, d'un gyroscope et d'un magnétomètre

page de 875

/ 875
Matières
Table des Matières
Signets

Table des Matières

Liens rapides

Télécharger ce manuel

Yocto-3D-V2

Mode d'emploi

Table des Matières

Chapitres

Table des Matières

Sommaire des Matières pour Yoctopuce Yocto-3D-V2

Page 1 Yocto-3D-V2 Mode d'emploi...
Page 3: Table Des Matières
1.2. Conditions environnementales ..................2. Présentation ..........................2.1. Les éléments communs ...................... 2.2. Les éléments spécifiques ....................3. Les fonctions du Yocto-3D-V2 ..................3.1. L'accéléromètre 3D ......................3.2. Le magnétomètre 3D ......................3.3. Le gyroscope 3D ........................3.4. Le référentiel ........................
Page 4 6.10. DataLogger ........................6.11. Quelle interface: Native, DLL ou Service? ..............6.12. Programmation, par où commencer? ................7. Utilisation du Yocto-3D-V2 en ligne de commande .......... 7.1. Installation .......................... 7.2. Utilisation: description générale ..................7.3. Contrôle de la fonction Tilt ....................
Page 5 15. Utilisation du Yocto-3D-V2 en JavaScript / EcmaScript ......15.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ....... 15.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ......15.3. Contrôle de la fonction Tilt ................... 15.4. Contrôle de la partie module ..................
Page 6 19.5. Un exemple concret ....................... 19.6. Contrôle de la partie module ..................19.7. Gestion des erreurs ....................... 20. Utilisation du Yocto-3D-V2 en Objective-C ............20.1. Contrôle de la fonction Tilt ................... 20.2. Contrôle de la partie module ..................20.3. Gestion des erreurs .......................
Page 7 26. Caractéristiques ......................www.yoctopuce.com...
Page 8 www.yoctopuce.com...
Page 9: Introduction
Le module Yocto-3D-V2 Le Yocto-3D-V2 n'est pas en lui-même un produit complet. C'est un composant destiné à être intégré dans une solution d'automatisation en laboratoire, ou pour le contrôle de procédés industriels, ou pour des applications similaires en milieu résidentiel ou commercial.
Page 10: Informations De Sécurité
Les ingénieurs Yoctopuce se sont donné beaucoup de mal pour que votre Yocto-3D-V2 soit facile à installer n'importe où et soit facile à piloter depuis un maximum de langages de programmation. Néanmoins, si ce module venait à vous décevoir, ou si vous avez besoin d'informations supplémentaires, n'hésitez pas à...
Page 11: Environnement
été déterminée en fonction des recommandations officielles des fabricants des composants utilisés dans le Yocto-3D-V2, et par des tests de durée limitée (1h) dans les conditions extrêmes, en environnement controllé. Si vous envisagez d'utiliser le Yocto-3D-V2 dans des conditions de température extrêmes pour une période prolongée, il est recommandé...
Page 12 www.yoctopuce.com...
Page 13: 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 14: Les Éléments Spécifiques
2.2. Les éléments spécifiques Les capteurs Le Yocto-3D-V2 utilise un capteur BNO055 de Bosch qui combine un gyroscope, un accéléromètre et un magnétomètre, tous tridimensionnels. De plus, il gère lui-même la fusion des capteurs en temps réel, et s'auto-calibre en continu. Attention, il s'agit d'un composant relativement fragile: il peut être définitivement abîmé...
Page 15: Les Fonctions Du Yocto-3D-V2
être obtenues individuellement. La valeur maximale mesurée est environ 16g. Attention, l'accéléromètre du Yocto-3D-V2 est susceptible de détecter une perte de calibration si il subit une accélération supérieure à 16g, et de dégrader son comportement en conséquence. Ceci peut avoir une incidence sur toutes les fonctions du Yocto-3D-V2 qui dépendent même indirectement de...
Page 16: Le Gyroscope 3D
Z du module. Si on imagine que le Yocto-3D-V2 est monté dans un avion, il peut être fixé sur la paroi de gauche (LEFT), sur la paroi de droite (RIGHT), sur le plancher (BOTTOM), au plafond (TOP), à l'avant (FRONT) ou encore a l'arrière (REAR).
Page 17: L'inclinomètre 2D
à la sélection des axes choisis. 3.5. L'inclinomètre 2D Le Yocto-3D-V2 peut mesurer l'inclinaison du module par rapport au plan horizontal, à l'aide d'une mesure de gravité. Le choix du plan horizontal de référence est configurable dans la fonction décrite ci-dessus, mais par défaut il s'agit du plan X/Y du module.
Page 18: Le Compas Magnétique
Le Yocto-3D-V2 permet de configurer la fréquence de mesure de l'inclinaison entre 1Hz et 20Hz. En interne, la mesure est calculée à 20Hz, mais si une fréquence inférieure est choisie, les mesures seront moyennées sur la période choisie.
Page 19: Vis Et Entretoises
3. Les fonctions du Yocto-3D-V2 Vis et entretoises Pour fixer le module Yocto-3D-V2 à 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 20: Connecteurs Picoflex Et Cable Nappe Souple
3. Les fonctions du Yocto-3D-V2 Connecteurs Picoflex et cable nappe souple Si vous désirez déporter la partie capteur du module Yocto-3D-V2 à l'aide d'un cable à connecteur enfichable, vous aurez besoin de câble nappe souple à 4 fils espacés de 1.27mm et de connecteurs Picoflex.
Page 21: 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 22: Test De La Connectivité Usb
Yoctopuce. Vous devez raccorder votre module Yocto-3D-V2 à 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-3D-V2, prenez garde à ne pas dépasser les limites de courant imposées par USB, sous peine de faire face des comportements...
Page 23: Localisation
Propriétés du module Yocto-3D-V2. Cette fenêtre vous permet entre autres de jouer avec votre module pour en vérifier son fonctionnement. Les valeurs de mesurées par le Yocto-3D-V2 y sont en effet affichées en temps réel, sous forme numérique et sous forme graphique.
Page 24: Configuration
Firmware Le firmware du module peut être facilement mis à jour à l'aide de l'interface. Les firmwares destinés aux modules Yoctopuce se présentent sous la forme de fichiers .byn et peuvent être téléchargés depuis le site web de Yoctopuce. Pour mettre à jour un firmware, cliquez simplement sur le bouton upgrade de la fenêtre de configuration et suivez les instructions.
Page 25: Nom Logique Des Fonctions
4. Premiers pas 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 26 www.yoctopuce.com...
Page 27: Montage Et Connectique
Exemples de montage sur un support. Le module Yocto-3D-V2 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 28: Déporter Le Capteur
Yocto-3D-V2 après son installation, et au besoin effectuez une calibration. 5.2. Déporter le capteur Le module Yocto-3D-V2 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...
Page 29: 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-3D-V2 à un autre type de module, par exemple un Yocto-Temperature, cela ne marchera pas, et vous risquez fort d'endommager votre matériel.
Page 30: Compatibilité Électromagnétique (Emi)
5.4. Compatibilité électromagnétique (EMI) Les choix de connectique pour intégrer le Yocto-3D-V2 ont naturellement une incidence sur les émissions électromagnétiques du système, et donc sur la conformité avec les normes concernées. Les mesures de référence que nous effectuons pour valider la conformité avec la norme IEC CISPR 11 sont faites sans aucun boîtier, mais en raccordant les modules par un câble USB blindé,...
Page 31: Programmation, Concepts Généraux
6.1. Paradigme de programmation L'API Yoctopuce est une API orientée objet. Mais dans un souci de simplicité, seules les bases de la programmation objet ont été utilisées. Même si la programmation objet ne vous est pas familière, il est peu probable que cela vous soit un obstacle à...
Page 32: 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 33: Le Module Yocto-3D-V2
6.2. Le module Yocto-3D-V2 Le module Yocto-3D-V2 fournit de nombreuses fonctions, permettant aussi bien de lire les mesures brutes d'accélération, de champ magnétique et de vitesse angulaire, que d'obtenir l'inclinaison mesurée (tilt), l'orientation par rapport au champ magnétique horizontal (compass) et l'estimation de l'orientation 3D du module sur la base de l'intégration de tous les capteurs.
Page 34 Texte modifiable advertisedValue Nombre entier modifiable mountPos Nombre (virgule fixe) modifiable bearing Paramètrs de calibration modifiable calibrationParam Algorithme de fusion modifiable fusionMode tilt1 : Tilt tilt2 : Tilt attribut type modifiable ? Texte modifiable logicalName Texte modifiable advertisedValue www.yoctopuce.com...
Page 35 Paramètrs de calibration modifiable calibrationParam Nombre (virgule fixe) modifiable resolution Nombre entier lecture seule sensorState dataLogger : DataLogger attribut type modifiable ? Texte modifiable logicalName Texte modifiable advertisedValue Nombre entier lecture seule currentRunIndex Heure UTC modifiable timeUTC Type énuméré modifiable recording www.yoctopuce.com...
Page 36: Module
Chaine de caractères contenant le numéro de série, unique et préprogrammé en usine. Pour un module Yocto-3D-V2, ce numéro de série commence toujours par Y3DMK002. Il peut servir comme point de départ pour accéder par programmation à un module particulier.
Page 37: Accelerometer
Attribut de type entier 32 bits à disposition de l'utilisateur. 6.4. Accelerometer Interface pour intéragir avec les accéléromètres, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La classe permet de lire et de configurer les accéléromètres Yoctopuce. Elle YAccelerometer hérite de la classe...
Page 38: Magnetometer
Interface pour intéragir avec les magnétomètres, disponibles par exemple dans le Yocto-3D-V2 La classe est la classe parente de tous les types de capteurs Yoctopuce. Elle permet de YSensor lire la valeur courante et l'unité de n'importe quel capteur, de lire les valeurs min/max, de configurer la fréquence d'enregistrement autonome des données et de récupérer les mesures enregistrées.
Page 39: Gyro
Composante X du champ magnétique, sous forme de nombre à virgule. yValue Composante Y du champ magnétique, sous forme de nombre à virgule. zValue Composante Z du champ magnétique, sous forme de nombre à virgule. 6.6. Gyro Interface pour intéragir avec les gyroscopes, disponibles par exemple dans le Yocto-3D-V2 www.yoctopuce.com...
Page 40 6. Programmation, concepts généraux La classe permet de lire et de configurer les gyroscopes Yoctopuce. Elle hérite de la classe YGyro toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, YSensor enregistreur de données. Elle ajoute la possibilité de lire individuellement les 3 composantes x, y et z du vecteur de rotation, ainsi que la possibilité...
Page 41: Refframe
Vitesse angulaire autour de l'axe Z du module, sous forme de nombre à virgule. 6.7. RefFrame Interface de configuration du référentiel 3D, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La class permet de configurer l'orientation des capteurs inertiels Yoctopuce. Cela YRefFrame permet aux fonctions d'orientation relatives au plan de la surface terrestre d'utiliser le référentiel...
Page 42 6. Programmation, concepts généraux La classe est la classe parente de tous les types de capteurs Yoctopuce. Elle permet de YSensor lire la valeur courante et l'unité de n'importe quel capteur, de lire les valeurs min/max, de configurer la fréquence d'enregistrement autonome des données et de récupérer les mesures enregistrées. Elle permet aussi d'enregistrer un callback appelé...
Page 43: Compass
Fréquence de rafraîchissement de la mesure. axis Axe de fonctionnement de l'inclinomètre. 6.9. Compass Interface pour intéragir avec les fonctions boussole, disponibles par exemple dans le Yocto-3D-V2 La classe permet de lire et de configurer les fonctions boussole Yoctopuce. Elle hérite YCompass...
Page 44: Datalogger
Direction du nord magnétique (indépent du cap configuré). 6.10. DataLogger Interface de contrôle de l'enregistreur de données, présent sur la plupart des capteurs Yoctopuce. La plupart des capteurs Yoctopuce sont équipés d'une mémoire non-volatile. Elle permet de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un ordinateur.
Page 45: Quelle Interface: Native, Dll Ou Service
Attribut qui peut être mis à vrai pour effacer l'historique des mesures. 6.11. 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 46: 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 47: Limitation Des Librairies Yoctopuce
Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto-3D-V2. 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 48 6. Programmation, concepts généraux Une fois que vous maîtriserez la programmation de base de votre module, vous pourrez vous intéresser au chapitre concernant la programmation avancée qui décrit certaines techniques qui vous permettront d'exploiter au mieux votre Yocto-3D-V2. www.yoctopuce.com...
Page 49: Utilisation Du Yocto-3D-V2 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-3D-V2, ouvrir un shell et commencer à travailler en tapant par exemple: C:\>YTilt...
Page 50: Contrôle De La Fonction Tilt
C:\>executable commande /help Pour obtenir une description détaillée des paramètres d'une commande. 7.3. Contrôle de la fonction Tilt Pour contrôler la fonction Tilt de votre Yocto-3D-V2, vous avez besoin de l'exécutable YTilt. Vous pouvez par exemple lancer: C:\>YTilt get_currentValue Cet exemple utilise la cible "any" pour signifier que l'on désire travailler sur la première fonction Tilt trouvée parmi toutes celles disponibles sur les modules Yoctopuce accessibles au moment de...
Page 51: Limitations
7. Utilisation du Yocto-3D-V2 en ligne de commande C:\>YModule inventory Vous pouvez aussi utiliser la commande suivante pour obtenir une liste encore plus détaillée des modules connectés: C:\>YModule describe Chaque propriété du module peut être obtenue grâce à une commande du type get_xxxx() et les propriétés qui ne sont pas en lecture seule peuvent être modifiées à...
Page 52 7. Utilisation du Yocto-3D-V2 en ligne de commande cela marchera parce que la commande ne sera plus exécutée nativement, mais à travers le Virtual Hub. Notez que le Virtual Hub compte comme une application native. www.yoctopuce.com...
Page 53: Utilisation Du Yocto-3D-V2 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 54: Un Exemple Réel
8. Utilisation du Yocto-3D-V2 en Python Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code Python qui utilise la fonction Tilt. [...] # On active la détection des modules sur USB errmsg=YRefParam() YAPI.RegisterHub("usb",errmsg)
Page 55 8. Utilisation du Yocto-3D-V2 en Python Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret. #!/usr/bin/python # -*- coding: utf-8 -*- import os, from...
Page 56: Contrôle De La Partie Module
8. Utilisation du Yocto-3D-V2 en Python 8.4. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci-dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation. #!/usr/bin/python...
Page 57: Enumeration Des Modules
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 58 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 59: Utilisation Du Yocto-3D-V2 En C
à la création d'un projet à neuf linké avec les librairies Yoctopuce. 9.1. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code C++ qui utilise la fonction Tilt. #include "yocto_api.h"...
Page 60 Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-3D-V2 avec le numéros de série Y3DMK002-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
Page 61 9. Utilisation du Yocto-3D-V2 en C++ Un exemple réel Lancez votre environnement C++ et ouvrez le projet exemple correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-3D-V2 de la librairie Yoctopuce. Si vous préférez travailler avec votre éditeur de texte préféré, ouvrez le fichier , vous taperez simplement main.cpp...
Page 62: Contrôle De La Partie Module
9. Utilisation du Yocto-3D-V2 en C++ while(1) { if(!tilt1->isOnline()) { cout << "device disconnected"; break; ((count % 10) == 0) { cout << "tilt1\ntilt2\ncompass\tacc\tgyro" << endl; cout << std::setprecision(2) << std::setw(8) << tilt1->get_currentValue() << "\t" << tilt2->get_currentValue() << "\t" << compass->get_currentValue() <<...
Page 63 9. Utilisation du Yocto-3D-V2 en C++ cout << "USB current: " << module->get_usbCurrent() << " mA" << endl; cout << "Logs:" << endl << module->get_lastLogs() << endl; } else { cout << argv[1] << " not connected (check identification and USB cable)"...
Page 64: 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 65: Intégration De La Librairie Yoctopuce En C
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 66: Intégration En Librairie Statique
Windows. Ce script qui se situe à la racine de la librairie, détecte l'OS et build.bat recompile toutes les librairies ainsi que les exemples correspondants. Ensuite, pour intégrer la librairie statique Yoctopuce à votre projet, vous devez inclure le répertoire de la librairie Yoctopuce à votre IncludePath, et ajouter le sous-répertoire de Sources correspondant à...
Page 67: Utilisation Du Yocto-3D-V2 En C
10.2. Utilisation l'API yoctopuce dans un projet Visual C# La librairie Yoctopuce pour Visual C# .NET se présente sous la forme d'une DLL et de fichiers sources en Visual C#. La DLL n'est pas une DLL .NET mais une DLL classique, écrite en C, qui gère les communications à...
Page 68: Contrôle De La Fonction Tilt
Il va de soit que que les fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique. 10.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code C# qui utilise la fonction Tilt. [...] // On active la détection des modules sur USB...
Page 69 10. Utilisation du Yocto-3D-V2 en C# tilt = YTilt.FindTilt("MonModule.MaFonction"); tilt = YTilt.FindTilt("MaFonction"); renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler YTilt.FindTilt l'inclinomètre. isOnline La méthode de l'objet renvoyé par permet de savoir si le module isOnline() YTilt.FindTilt...
Page 70: Contrôle De La Partie Module
10. Utilisation du Yocto-3D-V2 en C# (anytilt == null) { Console.WriteLine("No module connected (check USB cable)"); Environment.Exit(0); } else { anytilt YTilt.FindTilt(target + ".tilt1"); if (!anytilt.isOnline()) { Console.WriteLine("Module not connected"); Console.WriteLine("check identification and USB cable"); Environment.Exit(0); string serial = anytilt.get_module().get_serialNumber();...
Page 71 10. Utilisation du Yocto-3D-V2 en C# Console.WriteLine("RegisterHub error: " + errmsg); Environment.Exit(0); (args.Length < 1) usage(); = YModule.FindModule(args[0]); // use serial or logical name if (m.isOnline()) { (args.Length >= 2) { if (args[1].ToUpper() == "ON") { m.set_beacon(YModule.BEACON_ON); if (args[1].ToUpper() == "OFF") { m.set_beacon(YModule.BEACON_OFF);...
Page 72 10. Utilisation du Yocto-3D-V2 en C# static void Main(string[] args) YModule string errmsg = ""; string newname; (args.Length != 2) usage(); (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS) { Console.WriteLine("RegisterHub error: " + errmsg); Environment.Exit(0); = YModule.FindModule(args[0]); // use serial or logical name if (m.isOnline()) {...
Page 73: 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 74 www.yoctopuce.com...
Page 75: Utilisation Du Yocto-3D-V2 Avec Labview
Virtual Instruments (VI) des programmes LabVIEW. Avec la programmation visuelle, dessiner des algorithmes complexes devient très vite fastidieux, c'est pourquoi la librairie Yoctopuce pour LabVIEW a été pensée pour être aussi simple de possible à utiliser. Autrement dit, LabVIEW étant un environnement extrêmement différent des autres langages supportés par l'API Yoctopuce, vous rencontrerez des différences majeures entre l'API LabVIEW et...
Page 76: Compatibilité
Yoctopuce, ces derniers doivent avoir au moins le firmware 37120 LabVIEW pour Linux et MacOS Au moment de l'écriture de ce manuel, l'API Yoctopuce pour LabVIEW n'a été testée que sous Windows. Il y a donc de fortes chances pour qu'elle ne fonctionne tout simplement pas avec les versions Linux et MacOS de LabVIEW.
Page 77 Pour pouvoir utiliser les exemples fournis avec l'API, vous aurez avantage à ajouter le répertoire des VIs Yoctopuce dans la liste des répertoires où LabVIEW doit chercher les VIs qu'il n'a pas trouvé. Cette liste est accessible via le menu Tools > Options > Paths > VI Search Path.
Page 78: Méthode 2 : Installeur Fourni Avec La Librairie
à faire en sorte qu'ils ne soit pas effacés tant que vous en aurez besoin. Voici ce que fait exactement l'installeur quand cette option est choisie: • Toute référence à des répertoires contenant une version quelconque de la librairie Yoctopuce sont supprimés de l'option viSearchPath dans le fichier labview.ini.
Page 79: Méthode 3 Installation Manuelle Dans La Palette Labview
Notez cependant que les exemples de programmation ne sont pas copiés. Voici ce que fait l'installeur exactement: • Toute référence à des répertoires contenant une version quelconque de la librairie Yoctopuce sont supprimés de l'option viSearchPath dans le fichier labview.ini.
Page 80 \Yoctopuce\API que vous avez créé au point 1 et cliquez sur Current Folder Tous les VIs Yoctopuce vont apparaitre dans la fenêtre Yoctopuce. Par défaut, ils sont triés dans l'ordre alphabétique, mais vous pouvez les arranger comme bon vous semble en les glissant avec la souris.
Page 81: Présentation Des Vis Yoctopuce
Yoctopuce et avec tous les VIs de l'API 11.4. Présentation des VIs Yoctopuce La librairie Yoctopuce pour LabVIEW comprend un VI par classe de l'API Yoctopuce, plus quelques VI spéciaux. Tous les VIs disposent des connecteurs traditionnels Error IN et Error Out.
Page 82: Structure Des Vi Correspondant À Une Classe
à moins que le paramètre async ne soit mis à TRUE. Si async est mis à TRUE, aucune erreur ne sera générée, et les modules Yoctopuce correspondant à cette adresse IP seront automatiquement mis à disposition dès que la machine concernée sera joignable.
Page 83: Les Vi Senseurs
Utilisation du VI YModule pour retrouver les fonctions hébergés sur le même module Les VI senseurs Tous les VI correspondant à des senseurs Yoctopuce ont exactement la même géométrie. Les deux sorties permettent de récupérer la valeur mesurée par le capteur correspondant ainsi que l'unité...
Page 84: Fonctionnement Et Utilisation Des Vis
élevés utiliser la syntaxe (x/s). La fréquence de mise à jour du VI est un paramètre géré par le module Yoctopuce physique. Si plusieurs VI essayent de changer la fréquence d'un même capteur, la configuration retenue sera celle du dernier appel.
Page 85 11. Utilisation du Yocto-3D-V2 avec LabVIEW Utilisation des sorties hardware name et isOnline Les VIs de l'API Yoctopuce ne sont qu'une porte d'entrée sur la mécanique interne de la librairie Yoctopuce. Cette mécanique fonctionne indépendamment des VIs Yoctopuce. En effet, la plupart des communications avec les modules électroniques sont gérées automatiquement en arrière plan.
Page 86: Utilisation Des Objets
VI pour chacune d'entre elles. C'est pourquoi il y a un VI par classe qui expose les deux propriétés que Yoctopuce a jugé les plus utiles, mais cela ne veut pas dire que les autres ne sont pas accessibles.
Page 87: Utilisation En Réseau
Vous trouverez la description de toutes les propriétés, fonctions et méthodes disponibles dans la documentation de l'API .NET Proxy. Utilisation en réseau Sur une même machine, il ne peut y avoir qu'un seul processus qui accède aux modules Yoctopuce locaux directement par USB (url mis à ). Par contre, plusieurs processus peuvent se "usb"...
Page 88: Gestion Du Datalogger
Connexion asynchrone 11.7. Gestion du datalogger Quasiment tous les senseurs Yoctopuce disposent d'un enregistreur de données qui permet de stocker les mesures des senseurs dans la mémoire non volatile du module. La configuration de l'enregistreur de données peut être réalisée avec le VirtualHub, mais aussi à l'aide d'un peu de code...
Page 89: Énumération De Fonctions
11. Utilisation du Yocto-3D-V2 avec LabVIEW Le VI YDataLoggerContents Extraire les données de l'enregistreur d'un module Yoctopuce est un processus lent qui peut prendre plusieurs dizaines de secondes. C'est pourquoi le VI qui permet cette opération a été conçu pour fonctionner de manière itérative.
Page 90: Un Mot Sur Les Performances
Récupération de la liste de tous les modules connectés 11.9. Un mot sur les performances L'API Yoctopuce pour LabVIEW été optimisée de manière à ce que les tous les VIs et les propriétés de objets Proxy génèrent un minimum de communication avec les modules Yoctopuce. Ainsi vous pouvez les utiliser dans des boucles sans prendre de précaution particulière: vous n'êtes pas obligés...
Page 91: Différences Avec Les Autres Api Yoctopuce
Yoctopuce pour LabVIEW 11.11. Différences avec les autres API Yoctopuce Yoctopuce fait tout son possible pour maintenir une forte cohérence entre les différentes librairies de programmation. Cependant, LabVIEW étant un environnement clairement à part, il en résulte des différences importantes avec les autres librairies.
Page 92 www.yoctopuce.com...
Page 93: Utilisation Du Yocto-3D-V2 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. 12.2. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code Java qui utilise la fonction Tilt. [...] // On active l'accès aux modules locaux à...
Page 94: Un Exemple Réel
Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-3D-V2 avec le numéros de série Y3DMK002-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
Page 95: Contrôle De La Partie Module
12. Utilisation du Yocto-3D-V2 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); YTilt anytilt,tilt1, tilt2; YCompass compass; YAccelerometer accelerometer; YGyro gyro; (args.length == 0) { anytilt = YTilt.FirstTilt(); (anytilt == null) { System.out.println("No module connected (check USB...
Page 96 12. Utilisation du Yocto-3D-V2 en Java try { // setup the API to use local VirtualHub YAPI.RegisterHub("127.0.0.1"); } catch (YAPI_Exception ex) { System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" ex.getLocalizedMessage() + ")"); System.out.println("Ensure that the VirtualHub application is running"); System.exit(1); System.out.println("usage: demo [serial or logical name] [ON/OFF]");...
Page 97: Enumeration Des Modules
12. Utilisation du Yocto-3D-V2 en Java YAPI.RegisterHub("127.0.0.1"); } catch (YAPI_Exception ex) { System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" ex.getLocalizedMessage() + ")"); System.out.println("Ensure that the VirtualHub application is running"); System.exit(1); (args.length != 2) { System.out.println("usage: demo <serial or logical name> <new logical name>");...
Page 98: 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 99: Utilisation Du Yocto-3D-V2 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 100: 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 101: Lancement Automatique
13. Utilisation du Yocto-3D-V2 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 102: Contrôle De La Fonction Tilt
13. Utilisation du Yocto-3D-V2 avec Android 13.5. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code Java qui utilise la fonction Tilt. [...] // On active la détection des modules sur USB YAPI.EnableUSBHost(this);...
Page 103: Lancez Votre Environnement Java Et Ouvrez Le Projet Correspondant, Fourni Dans Le Répertoire
13. Utilisation du Yocto-3D-V2 avec Android YCompass.FindCompass, YGyro.FindGyro... fonctions YCompass.FindCompass YMagnetometer.FindMagnetometer permettent de travailler YGyro.FindGyro YAccelerometer.FindAccelerometer respectivement avec les mesures de renvoyées par le compas, le magnétomètre, le gyroscope et l'accéléromètre, exactement de la même manière qu'avec YTilt.FindTilt Un exemple réel Lancez votre environnement java et ouvrez le projet correspondant, fourni dans le répertoire...
Page 104 13. Utilisation du Yocto-3D-V2 avec Android aa.notifyDataSetChanged(); handler.postDelayed(r, 500); @Override protected void onStop() super.onStop(); handler.removeCallbacks(r); YAPI.FreeAPI(); @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long serial = parent.getItemAtPosition(pos).toString(); @Override public void onNothingSelected(AdapterView<?> arg0) final Runnable = new Runnable() public void...
Page 105: Contrôle De La Partie Module
13. Utilisation du Yocto-3D-V2 avec Android 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. package com.yoctopuce.doc_examples;...
Page 106 13. Utilisation du Yocto-3D-V2 avec Android field.setText(module.getSerialNumber()); field = (TextView) findViewById(R.id.logicalnamefield); field.setText(module.getLogicalName()); field = (TextView) findViewById(R.id.luminosityfield); field.setText(String.format("%d%%", module.getLuminosity())); field = (TextView) findViewById(R.id.uptimefield); field.setText(module.getUpTime() / 1000 " sec"); field = (TextView) findViewById(R.id.usbcurrentfield); field.setText(module.getUsbCurrent() + " mA"); Switch = (Switch) findViewById(R.id.beaconswitch); sw.setChecked(module.getBeacon() == YModule.BEACON_ON);...
Page 107 13. Utilisation du Yocto-3D-V2 avec Android import android.app.Activity; import android.os.Bundle; import android.view.View; import android.widget.AdapterView; import android.widget.AdapterView.OnItemSelectedListener; import android.widget.ArrayAdapter; import android.widget.EditText; import android.widget.Spinner; import android.widget.TextView; import android.widget.Toast; import com.yoctopuce.YoctoAPI.YAPI; import com.yoctopuce.YoctoAPI.YAPI_Exception; import com.yoctopuce.YoctoAPI.YModule; public class SaveSettings extends Activity implements OnItemSelectedListener private ArrayAdapter<String> aa;...
Page 108 13. Utilisation du Yocto-3D-V2 avec Android String hwid = parent.getItemAtPosition(pos).toString(); module = YModule.FindModule(hwid); DisplayModuleInfo(); @Override public void onNothingSelected(AdapterView<?> arg0) public void saveName(View view) (module == null) return; EditText edit = (EditText) findViewById(R.id.newname); String newname = edit.getText().toString(); try { if (!YAPI.CheckLogicalName(newname)) { Toast.makeText(getApplicationContext(),...
Page 109: 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 110 www.yoctopuce.com...
Page 111: Utilisation Du Yocto-3D-V2 En Typescript
JavaScript avant l'exécution, pour être ensuite interprêté par n'importe quel navigateur Web ou par Node.js. Cette librairie de programmation Yoctopuce permet donc de coder des applications JavaScript tout en bénéficiant d'un typage fort. Comme notre librairie EcmaScript, elle utilise les fonctionnalités asynchrones introduites dans la version ECMAScript 2017 et qui sont maintenant disponibles nativement dans tous les environnements JavaScript modernes.
Page 112: Utiliser La Librairie Yoctopuce Pour Typescript
• Installez ensuite TypeScript sur votre machine à l'aide de la commande: npm install -g typescript 2. Connectez-vous ensuite sur le site Web de Yoctopuce et téléchargez les éléments suivants: • La librairie de programmation pour TypeScript • Le programme VirtualHub pour Windows, Mac OS X ou Linux selon l'OS que vous utilisez.
Page 113: Contrôle De La Fonction Tilt
14.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code TypeScript qui utilise la fonction Tilt. // En Node.js, on référence la librairie via son package NPM // En HTML, on utiliserait plutôt un path relatif (selon l'environnement)
Page 114: Un Exemple Concret, En Node.js
YAPI.RegisterHub La méthode permet d'indiquer sur quelle machine se trouvent les modules RegisterHub Yoctopuce, ou plus exactement la machine sur laquelle 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 115 14. Utilisation du Yocto-3D-V2 en TypeScript Si le Yocto-3D-V2 n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où est branché le Yocto-3D-V2 127.0.0.1 et où vous avez lancé le VirtualHub.
Page 116: Le Même Exemple, Mais Dans Un Navigateur
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-3D-V2. Vous y trouverez un fichier html , et un fichier TypeScript similaire au code ci-dessus, mais avec app.html...
Page 117 14. Utilisation du Yocto-3D-V2 en TypeScript import { YAPI, YErrorMsg, YModule } from 'yoctolib-cjs/yocto_api_nodejs.js'; async function startDemo(args: string[]): Promise<void> await YAPI.LogUnhandledPromiseRejections(); // Setup the API to use the VirtualHub on local machine let errmsg: YErrorMsg = new YErrorMsg(); if (await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) { console.log('Cannot contact VirtualHub on 127.0.0.1:...
Page 118 14. Utilisation du Yocto-3D-V2 en TypeScript // Select the device to use let module: YModule = YModule.FindModule(args[0]); if(await module.isOnline()) { if(args.length > 1) { let newname: string = args[1]; if (!await YAPI.CheckLogicalName(newname)) { console.log("Invalid name (" newname + ")"); process.exit(1);...
Page 119: 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 120 www.yoctopuce.com...
Page 121: Utilisation Du Yocto-3D-V2 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 122: Fonctions Bloquantes Et Fonctions Asynchrones En Javascript
15. Utilisation du Yocto-3D-V2 en JavaScript / EcmaScript 15.1. Fonctions bloquantes et fonctions asynchrones en JavaScript JavaScript a été conçu pour éviter toute situation de concurrence durant l'exécution. Il n'y a jamais qu'un seul thread en JavaScript. Cela signifie que si un programme effectue une attente active durant une communication réseau, par exemple pour lire un capteur, le programme entier se trouve...
Page 123: 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 124: Compatibilité Avec L'ancienne Librairie Javascript
15. Utilisation du Yocto-3D-V2 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 125: Contrôle De La Fonction Tilt
Ce dernier appel asynchrone peut aussi être formulé comme: myModule.get_syncProxy().then(logInfoProxy); 15.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction Tilt. // En Node.js, on utilise la fonction require() // En HTML, on utiliserait <script src="...">...
Page 126 à en faire un petit programme d'exemple concret. Si le Yocto-3D-V2 n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où...
Page 127 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-3D-V2. 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 128: Contrôle De La Partie Module
15. Utilisation du Yocto-3D-V2 en JavaScript / EcmaScript async function startDemo() await YAPI.LogUnhandledPromiseRejections(); await YAPI.DisableExceptions(); // Setup the API to use the VirtualHub on local machine let errmsg = new YErrorMsg(); if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) { alert('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg);...
Page 129 15. Utilisation du Yocto-3D-V2 en JavaScript / EcmaScript // Setup the API to use the VirtualHub on local machine errmsg = new YErrorMsg(); if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) { console.log('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg); return; // Select the relay to use module = YModule.FindModule(args[0]);...
Page 130 15. Utilisation du Yocto-3D-V2 en JavaScript / EcmaScript newname = args[1]; if (!await YAPI.CheckLogicalName(newname)) { console.log("Invalid name (" newname + ")"); process.exit(1); await module.set_logicalName(newname); await module.saveToFlash(); console.log('Current name: '+await module.get_logicalName()); } else { console.log("Module not connected (check identification and USB cable)\n");...
Page 131: 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 132 www.yoctopuce.com...
Page 133: Utilisation Du Yocto-3D-V2 En Php
Vous n'avez pas besoin d'installer de driver. 16.2. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code PHP qui utilise la fonction Tilt. include('yocto_api.php');...
Page 134 Yocto-3D-V2. YAPI::RegisterHub La fonction permet d'indiquer sur quelle machine se trouve les modules YAPI::RegisterHub Yoctopuce, ou plus exactemenent sur quelle machine tourne le programme VirtualHub. Dans notre cas l'adresse indique la machine locale, en utilisant le port (le port 127.0.0.1:4444 4444 standard utilisé...
Page 135: Un Exemple Réel
16. Utilisation du Yocto-3D-V2 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 136: Contrôle De La Partie Module
16. Utilisation du Yocto-3D-V2 en PHP </BODY> </HTML> 16.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 137 16. Utilisation du Yocto-3D-V2 en PHP </HTML> 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 138: 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 139 16. Utilisation du Yocto-3D-V2 en PHP Ce qui, transposé en terme de réseau, donne : les appareils connectés sur un réseau domestique peuvent communiquer entre eux en utilisant une adresse IP locale (du genre 192.168.xxx.yyy), et contacter des serveurs sur Internet par leur adresse publique, mais vu de l'extérieur, il n'y a qu'une seule adresse IP officielle, attribuée au routeur DSL exclusivement.
Page 140 16. Utilisation du Yocto-3D-V2 en PHP L'API par callback HTTP utilise le VirtualHub, et c'est lui qui initie les requêtes. Configuration L'API callback se sert donc du Virtual Hub comme passerelle. Toutes les communications sont initiées par le Virtual Hub, ce sont donc des communication sortantes, et par conséquent parfaitement autorisée par le routeur DSL.
Page 141: 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 142: 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 143: Utilisation Du Yocto-3D-V2 En Visualbasic .Net
17.2. Utilisation l'API yoctopuce dans un projet Visual Basic La librairie Yoctopuce pour Visual Basic .NET se présente sous la forme d'une DLL et de fichiers sources en Visual Basic. La DLL n'est pas une DLL .NET mais une DLL classique, écrite en C, qui gère les communications à...
Page 144: Contrôle De La Fonction Tilt
17.3. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction Tilt. [...] ' On active la détection des modules sur USB...
Page 145 17. Utilisation du Yocto-3D-V2 en VisualBasic .NET renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler YTilt.FindTilt l'inclinomètre. isOnline La méthode de l'objet renvoyé par permet de savoir si le module isOnline() YTilt.FindTilt correspondant est présent et en état de marche.
Page 146: Contrôle De La Partie Module
17. Utilisation du Yocto-3D-V2 en VisualBasic .NET End If End If serial = anytilt.get_module().get_serialNumber() tilt1 YTilt.FindTilt(serial + ".tilt1") tilt2 YTilt.FindTilt(serial + ".tilt2") compass YCompass.FindCompass(serial + ".compass") accelerometer YAccelerometer.FindAccelerometer(serial + ".accelerometer") gyro YGyro.FindGyro(serial + ".gyro") count While (True) If (Not tilt1.isOnline()) Then Console.WriteLine("Module...
Page 147 17. Utilisation du Yocto-3D-V2 en VisualBasic .NET Console.Write("beacon: ") If (m.get_beacon() = Y_BEACON_ON) Then Console.WriteLine("ON") Else Console.WriteLine("OFF") End If Console.WriteLine("upTime: " + Str(m.get_upTime() / 1000) + " sec") Console.WriteLine("USB current: " + Str(m.get_usbCurrent()) + " mA") Console.WriteLine("Logs:") Console.WriteLine(m.get_lastLogs()) Else Console.WriteLine(argv(1) + "...
Page 148: 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 149 La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
Page 150 www.yoctopuce.com...
Page 151: Utilisation Du Yocto-3D-V2 En Delphi
18.2. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code Delphi qui utilise la fonction Tilt.
Page 152 [...] Voyons maintenant en détail ce que font ces quelques lignes. yocto_api et yocto_tilt Ces deux unités permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. doit toujours être utilisé, est nécessaire pour gérer les modules yocto_api yocto_tilt contenant un inclinomètre, comme le Yocto-3D-V2.
Page 153 18. Utilisation du Yocto-3D-V2 en Delphi Un exemple réel Lancez votre environnement Delphi, copiez la DLL yapi.dll dans un répertoire et créez une nouvelle application console dans ce même répertoire, et copiez-coller le code ci dessous. 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 154: Contrôle De La Partie Module
18. Utilisation du Yocto-3D-V2 en Delphi // retreive some sensors present on the yocto-3D tilt1 := yFindTilt(serial+'.tilt1'); tilt2 := yFindTilt(serial+'.tilt2'); compass := yFindCompass(serial+'.compass'); accelerometer := yFindaccelerometer(serial+'.accelerometer'); gyro :=yFindGyro(serial+'.gyro'); // let's poll done := false; count :=0; repeat if (tilt1.isOnline()) then...
Page 155 18. Utilisation du Yocto-3D-V2 en Delphi module : TYModule; : char; errmsg : string; begin // Setup the API to use local USB devices yRegisterHub('usb', errmsg)<>YAPI_SUCCESS then begin Write('RegisterHub error: '+errmsg); exit; end; module := yFindModule(serial); refresh(module); repeat read(c); case 'r': refresh(module);...
Page 156: 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 157 La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
Page 158 www.yoctopuce.com...
Page 159: Utilisation Du Yocto-3D-V2 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 160: Installation
19.2. Installation Téléchargez la librairie Yoctopuce pour Universal Windows Platform depuis le site web de Yoctopuce . Il n'y a pas de programme d'installation, copiez simplement de contenu du fichier zip dans le répertoire de votre choix.
Page 161: Contrôle De La Fonction Tilt
19.4. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code c# qui utilise la fonction Tilt.
Page 162: 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 163: Contrôle De La Partie Module
19. Utilisation du Yocto-3D-V2 avec Universal Windows Platform count = 0; while (await tilt1.isOnline()) { if (count++ % == 0) { WriteLine("tilt1 tilt2 compass gyro"); Write(await tilt1.get_currentValue() + "\t"); Write(await tilt2.get_currentValue() + "\t"); Write(await compass.get_currentValue() + "\t"); Write(await accel.get_currentValue() + "\t");...
Page 164 19. Utilisation du Yocto-3D-V2 avec Universal Windows Platform } else { WriteLine(Target " not connected on" HubURL "(check identification and USB cable)"); YAPI.FreeAPI(); return 0; Chaque propriété du module peut être lue grâce à une méthode du type YModule.get_xxxx , et les propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux...
Page 165: 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 166 19. Utilisation du Yocto-3D-V2 avec Universal Windows Platform Exemple: try { ..} catch (YAPI_Exception ex) { Debug.WriteLine("Exception from Yoctopuce lib:" + ex.Message); } catch (Exception ex) { Debug.WriteLine("Other exceptions :" + ex.Message); www.yoctopuce.com...
Page 167: Utilisation Du Yocto-3D-V2 En Objective-C
à vos projets. 20.1. Contrôle de la fonction Tilt Il suffit de quelques lignes de code pour piloter un Yocto-3D-V2. Voici le squelette d'un fragment de code Objective-C qui utilise la fonction Tilt. #import "yocto_api.h"...
Page 168 Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-3D-V2 avec le numéros de série Y3DMK002-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé...
Page 169 20. Utilisation du Yocto-3D-V2 en Objective-C #import <Foundation/Foundation.h> #import "yocto_api.h" #import "yocto_tilt.h" #import "yocto_compass.h" #import "yocto_gyro.h" #import "yocto_accelerometer.h" static void usage(void) NSLog(@"usage: demo <serial_number> "); NSLog(@" demo <logical_name>"); NSLog(@" demo any (use any discovered device)"); exit(1); int main(int argc, const char...
Page 170: Contrôle De La Partie Module
20. Utilisation du Yocto-3D-V2 en Objective-C return 20.2. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
Page 171 20. Utilisation du Yocto-3D-V2 en Objective-C module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration courante dans sa mémoire non volatile. Pour cela il faut utiliser la méthode saveToFlash Inversement il est possible de forcer le module à...
Page 172: 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 173 20. Utilisation du Yocto-3D-V2 en Objective-C Dans le cas de fonctions qui ne retournent à priori pas d'information, la valeur de retour sera si tout va bien, et un code d'erreur différent en cas d'échec. YAPI.SUCCESS Quand vous travaillez sans les exceptions, il est possible d'obtenir un code d'erreur et un message expliquant l'origine de l'erreur en le demandant à...
Page 174 www.yoctopuce.com...
Page 175: Utilisation Avec Des Langages Non Supportés
être utilisés par des applications tierces. Dans notre cas, c'est toute la librairie Yoctopuce qui est disponible dans l'Assembly .NET, de sorte à pouvoir être utilisée dans n'importe quel environnement qui supporte le chargement dynamique d'Assembly .NET.
Page 176: Exemple D'utilisation Avec Matlab
21. Utilisation avec des langages non supportés mécanismes de callbacks. A la place, cette librairie offre des objets miroirs, appelés Proxys, qui publient par le biais de Propriétés les principaux attributs des fonctions Yoctopuce tels que la mesure courante, les paramètres de configuration, l'état, etc.
Page 177: Virtual Hub Et Http Get
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 178: 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-3D-V2 avec le numéro de de série Y3DMK002-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.
Page 179: Accès Aux Données Enregistrées Sur Le Datalogger Par L'interface Rest
21.4. Utilisation des librairies dynamiques L'API Yoctopuce bas niveau est disponible sous différents formats de librairie dynamiques écrites en C, dont les sources sont disponibles avec l'API C++. Utiliser une de ces librairies bas niveau vous permettra de vous passer du Virtual Hub.
Page 180 (yapiHTTPRequest(serial,getValue,data,sizeof(dataBuffer),fullsize,errmsg)<0) then begin writeln(errmsg); halt; end; // searches for the HTTP header end p := pos(#13#10#13#10,data); // displays the response minus the HTTP header writeln(copy(data,p+4,length(data)-p-3)); // change the luminosity if (yapiHTTPRequest(serial,setValue,data,sizeof(dataBuffer),fullsize,errmsg)<0) then begin writeln(errmsg); halt; end; www.yoctopuce.com...
Page 181: Inventaire Des Modules
21. Utilisation avec des langages non supportés end. Inventaire des modules Pour procéder à l'inventaire des modules Yoctopuce, deux fonctions de la librairie dynamique sont nécessaires int yapiGetAllDevices(int *buffer,int maxsize,int *neededsize,char *errmsg); int yapiGetDeviceInfo(int devdesc,yDeviceSt *infos, char *errmsg); La fonction yapiGetAllDevices permet d'obtenir la liste des modules connectés sous la forme d'une liste de handles.
Page 182: 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 183: Mise À Jour Du Firmware
"mise à jour" et sera listé en dessous des modules connectés. 22.2. La librairie ligne de commandes Tous les outils en lignes de commandes ont la possibilité de mettre à jour les modules Yoctopuce grâce à la commande .
Page 184: 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 185: 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 186: 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 187: 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 188: 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 189 Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).
Page 190: L'enregistreur De Données
Prog-EventBased. 23.2. L'enregistreur de données Votre Yocto-3D-V2 est équipé d'un enregistreur de données, aussi appelé datalogger, capable d'enregistrer en continu les mesures effectuées par le module. La fréquence d'enregistrement maximale est de cent fois par secondes (i.e. "100/s"), et la fréquence minimale est de une fois par heure (i.e.
Page 191: 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-3D-V2, 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 192 Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-3D-V2 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-3D-V2 va automatiquement essayer de se mettre à...
Page 193: Référence De L'api De Haut Niveau
24. Référence de l'API de haut niveau Ce chapitre résume les fonctions de l'API de haut niveau pour commander votre Yocto-3D-V2. 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 194: La Classe Yapi
YAPI.EnableUSBHost(osContext) Cette fonction est utilisée uniquement sous Android. YAPI.FreeAPI() Attends que toutes les communications en cours avec les modules Yoctopuce soient terminées puis libère les ressources utilisées par la librairie Yoctopuce. YAPI.GetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée.
Page 195 Enregistre une fonction de callback qui sera appelée à chaque fois qu'un module est débranché. YAPI.RegisterHub(url, errmsg) Configure la librairie Yoctopuce pour utiliser les modules connectés sur une machine donnée. YAPI.RegisterHubDiscoveryCallback(hubDiscoveryCallback) Enregistre une fonction de callback qui est appelée chaque fois qu'un hub réseau s'annonce avec un message SSDP.
Page 196 Test si un hub est joignable. YAPI.TriggerHubDiscovery(errmsg) Relance une détection des hubs réseau. YAPI.UnregisterHub(url) Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. YAPI.UpdateDeviceList(errmsg) Force une mise-à-jour de la liste des modules Yoctopuce connectés.
Page 197 . Lorsqu'on configure un nom logique avec une chaîne incorrecte, les caractères invalides sont ignorés. Paramètres : name une chaîne de caractères contenant le nom vérifier. Retourne : true false si le nom est valide, dans le cas contraire. www.yoctopuce.com...
Page 198 Désactive le cache de callback HTTP. function ClearHTTPCallbackCacheDir( $bool_removeFiles) Cette méthode désctive la cache de callback HTTP, et permet également d'en effacer le contenu. Paramètres : Vrai pour effacer le contenu du répertoire de cache. bool_removeFiles Retourne : nothing. www.yoctopuce.com...
Page 199 DisableExceptions( ) void DisableExceptions( ) DisableExceptions( ) function DisableExceptions( ) async DisableExceptions( ): Promise<void> async DisableExceptions( ) Lorsque les exceptions sont désactivées, chaque fonction retourne une valeur d'erreur spécifique selon son type, documentée dans ce manuel de référence. www.yoctopuce.com...
Page 200 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 201 (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 202 24. Référence de l'API de haut niveau YAPI.FreeAPI() YAPI YAPI.FreeAPI() Attends que toutes les communications en cours avec les modules Yoctopuce soient terminées puis libère les ressources utilisées par la librairie Yoctopuce. function yFreeAPI( ) void FreeAPI( ) +(void) FreeAPI...
Page 203 24. Référence de l'API de haut niveau YAPI.GetAPIVersion() YAPI YAPI.GetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée. function yGetAPIVersion( ) string GetAPIVersion( ) +(NSString*) GetAPIVersion string yGetAPIVersion( ): string function GetAPIVersion( ) As String static String GetAPIVersion( ) static String GetAPIVersion( )
Page 204 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 205 GetDeviceListValidity( ) int GetDeviceListValidity( ) java async Task<int> GetDeviceListValidity( ) GetDeviceListValidity( ) function GetDeviceListValidity( ) async GetDeviceListValidity( ): Promise<number> async GetDeviceListValidity( ) Note: Cette fonction doit être appelée après yInitAPI Retourne : le nombre de secondes entre chaque énumération. www.yoctopuce.com...
Page 206 . Pour les machines ARM, l'architecture "Win32" "Win64" . Pour les autres machines Linux, l'architecture est "Armhf32" "Aarch64" "Linux32" . Pour MacOS, l'architecture est "Linux64" "MacOs32" "MacOs64" Retourne : une chaîne de caractères décrivant l'architecture du binaire de la librairie de communication Yoctopuce utilisée. www.yoctopuce.com...
Page 207 YAPI.GetDllPath() YAPI YAPI.GetDllPath() Retourne l'emplacement sur le disque des librairies Yoctopuce utilisées. static string GetDllPath( ) Pour les architectures qui demandent l'utilisation de plusieurs DLLs, et en particulier dans le cadre de l'utilisation de la librairie sous forme de .NET Assembly, la chaîne retournée est au format suivant: , où...
Page 208 24. Référence de l'API de haut niveau YAPI.GetLog() YAPI YAPI.GetLog() Récupère les messages de logs de la librairie de communication Yoctopuce. static string GetLog( string lastLogLine) static string GetLog( string lastLogLine) Cette méthode permet de récupérer progressivement les messages de logs, ligne par ligne. La méthode doit être appelée en boucle, jusqu'à...
Page 209 Ce délai n'affecte que les YoctoHubs et VirtualHub qui sont accessibles par réseau. Par défaut, ce délai est de 20000 millisecondes, mais en fonction de votre réseau il peut être souhaitable de changer ce délai, par exemple, si votre infrastructure réseau utilise une connexion GSM. Retourne : le délai de connexion réseau en millisecondes. www.yoctopuce.com...
Page 210 GetTickCount( ) GetTickCount( ): number GetTickCount( ) Ce compteur peut être utilisé pour calculer des délais en rapport avec les modules Yoctopuce, dont la base de temps est aussi la milliseconde. Retourne : un long entier contenant la valeur du compteur de millisecondes.
Page 211 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 212 24. Référence de l'API de haut niveau YAPI.InitAPI() YAPI YAPI.InitAPI() Initialise la librairie de programmation de Yoctopuce explicitement. function yInitAPI( mode, errmsg) YRETCODE InitAPI( int mode, string errmsg) +(YRETCODE) InitAPI :(int) mode :(NSError**) errmsg integer yInitAPI( mode: integer, var errmsg: string): integer...
Page 213 "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 214 RegisterDeviceArrivalCallback( $arrivalCallback) async RegisterDeviceArrivalCallback( arrivalCallback: YDeviceUpdateCallback| null): Promise<void> async RegisterDeviceArrivalCallback( arrivalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : arrivalCallback une procédure qui prend un YModule en paramètre, ou null www.yoctopuce.com...
Page 215 RegisterDeviceRemovalCallback( $removalCallback) async RegisterDeviceRemovalCallback( removalCallback: YDeviceUpdateCallback| null): Promise<void> async RegisterDeviceRemovalCallback( removalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : removalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
Page 216 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 217 "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 218 , que vous devrez appeler régulièrement. yUpdateDeviceList Paramètres : hubDiscoveryCallback une procédure qui prend deux chaîne de caractères en paramètre, le numéro de série et l'URL du hub découvert. Pour supprimer un callback déjà enregistré, www.yoctopuce.com...
Page 219 YAPI.RegisterHubWebsocketCallback() YAPI YAPI.RegisterHubWebsocketCallback() Variante de la fonction yRegisterHub() destinée à initialiser l'API Yoctopuce sur une session Websocket existante, dans le cadre d'un callback WebSocket entrant. Paramètres : l'objet WebSocket lié à au callback WebSocket entrant. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur.
Page 220 RegisterLogFunction( LogCallback logfun) java void RegisterLogFunction( LogHandler logfun) RegisterLogFunction( logfun) async RegisterLogFunction( logfun: YLogCallback): Promise<number> async RegisterLogFunction( logfun) Utile pour débugger le fonctionnement de l'API. Paramètres : logfun une procedure qui prend une chaîne de caractère en paramètre, www.yoctopuce.com...
Page 221 à la librairie pour forcer l'utilisation d'une SelectArchitecture() architecture spécifiée. Paramètres : arch une chaîne de caractère spécifiant l'architecture à utiliser. Les valeurs possibles sont "armhf" "armel" "aarch64" "i386" "x86_64" "32bit" "64bit" Retourne : rien. En cas d'erreur, déclenche une exception. www.yoctopuce.com...
Page 222 USB. Ce paramètre n'affecte pas les callbacks de changement de valeur Note: Cette fonction doit être appelée après yInitAPI Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en cacheValidityMs millisecondes. www.yoctopuce.com...
Page 223 (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 224 à un réseau GSM où le trafic est facturé. Ce paramètre n'affecte pas les modules connectés par USB, ni le fonctionnement des callback de connexion/déconnexion de module. Note: Cette fonction doit être appelée après yInitAPI Paramètres : nombre de secondes entre chaque énumération. deviceListValidity www.yoctopuce.com...
Page 225 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 226 Ce délai n'affecte que les YoctoHubs et VirtualHub qui sont accessibles par réseau. Par défaut ce délai est de 20000 millisecondes, mais en fonction de votre réseau il peut être souhaitable de changer ce délai, par exemple si votre infrastructure réseau utilise une connexion GSM. Paramètres : networkMsTimeout le délais de connexion réseau en millisecondes. www.yoctopuce.com...
Page 227 être fournis, pour être passés à la fonction de callback si nécessaire. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 228 ê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 229 à lire périodiquement les informations en provenance des modules Yoctopuce en appelant la fonction yHandleEvents() afin de se maintenir à jour. Cette fonction peut signaler une erreur au cas à la communication avec un module Yoctopuce ne se passerait pas comme attendu. Paramètres : ms_duration un entier correspondant à...
Page 230 éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur retourne un code d'erreur négatif. www.yoctopuce.com...
Page 231 Paramètres : errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 232 24. Référence de l'API de haut niveau YAPI.UnregisterHub() YAPI YAPI.UnregisterHub() Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. function yUnregisterHub( url) void UnregisterHub( string url) +(void) UnregisterHub :(NSString *) yUnregisterHub( url: string)
Page 233 24. Référence de l'API de haut niveau YAPI.UpdateDeviceList() YAPI YAPI.UpdateDeviceList() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList( errmsg) YRETCODE UpdateDeviceList( string errmsg) +(YRETCODE) UpdateDeviceList :(NSError**) errmsg integer yUpdateDeviceList( var errmsg: string): integer function UpdateDeviceList( ByRef...
Page 234 YAPI.UpdateDeviceList_async() YAPI YAPI.UpdateDeviceList_async() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList_async( callback, context) La librairie va vérifier sur les machines ou ports USB précédemment enregistrés en utilisant la fonction si un module a été connecté ou déconnecté, et le cas échéant appeler les fonctions yRegisterHub de callback définies par l'utilisateur.
Page 235: La Classe Ymodule
24.2. La classe YModule Interface de contrôle des paramètres généraux des modules Yoctopuce La classe est utilisable avec tous les modules USB de Yoctopuce. Elle permet de contrôler YModule les paramètres généraux du module, et d'énumérer les fonctions fournies par chaque module.
Page 236 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module. module→get_firmwareRelease() Retourne la version du logiciel embarqué du module. module→get_functionIds(funType) Retourne les identifiants matériels des fonctions correspondant au type passé en argument. module→get_hardwareId() Retourne l'identifiant unique du module. module→get_icon2d() www.yoctopuce.com...
Page 237 Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→load_async(msValidity, callback, context) Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→log(text) Ajoute un message arbitraire dans les logs du module. www.yoctopuce.com...
Page 238 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 239 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 240 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le module sans ambiguïté, par exemple MyDevice.module Retourne : YModule un objet de classe qui permet ensuite de contrôler le module. www.yoctopuce.com...
Page 241 FirstModule( ): YModule | null static FirstModule( ) Utiliser la fonction pour itérer sur les autres modules. YModule.nextModule() Retourne : un pointeur sur un objet YModule , correspondant au premier module accessible en ligne, ou null aucun module n'a été trouvé. www.yoctopuce.com...
Page 242 24. Référence de l'API de haut niveau YModule module→Beacon état de la balise de localisation. int Beacon Modifiable. Allume ou éteint la balise de localisation du module. www.yoctopuce.com...
Page 243 24. Référence de l'API de haut niveau YModule module→FirmwareRelease Version du logiciel embarqué du module. string FirmwareRelease www.yoctopuce.com...
Page 244 24. Référence de l'API de haut niveau YModule module→FunctionId Identifiant matériel de la nième fonction du module. string FunctionId @param functionIndex : l'index de la fonction pour laquelle l'information est désirée, en commençant à 0 pour la première fonction. www.yoctopuce.com...
Page 245 24. Référence de l'API de haut niveau YModule module→HardwareId Identifiant unique du module. string HardwareId L'identifiant unique est composé du numéro de série du module suivi de la chaîne ".module". www.yoctopuce.com...
Page 246 Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 247 Nom logique du module. string LogicalName Modifiable. Change le nom logique du module. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module saveToFlash() si le réglage doit être préservé. www.yoctopuce.com...
Page 248 Luminosité des leds informatives du module (valeur entre 0 et 100). int Luminosity Modifiable. Modifie la luminosité des leds informatives du module. Le paramêtre est une valeur entre 0 et 100. N'oubliez pas d'appeler la méthode du module si le réglage doit être saveToFlash() préservé. www.yoctopuce.com...
Page 249 24. Référence de l'API de haut niveau YModule module→ProductId Identifiant USB du module, préprogrammé en usine. int ProductId www.yoctopuce.com...
Page 250 24. Référence de l'API de haut niveau YModule module→ProductName Nom commercial du module, préprogrammé en usine. string ProductName www.yoctopuce.com...
Page 251 24. Référence de l'API de haut niveau YModule module→ProductRelease Numéro uméro de révision du module hardware, préprogrammé en usine. int ProductRelease La révision originale du retourne la valeur 1, la révision B retourne la valeur 2, etc. www.yoctopuce.com...
Page 252 24. Référence de l'API de haut niveau YModule module→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 253 Retourne : le path du fichier .byn à utiliser, ou une chaîne vide si aucun firmware plus récent n'est disponible En cas d'erreur, déclenche une exception ou retourne une chaine de caractère qui comment par "error:". www.yoctopuce.com...
Page 254 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du module. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 255 String describe( ) java describe( ) function describe( ) async describe( ): Promise<string> async describe( ) Ce texte peut contenir soit le nom logique du module, soit son numéro de série. Retourne : une chaîne de caractères décrivant le module www.yoctopuce.com...
Page 256 Promise<Uint8Array> async download( pathname) byte[] download( string pathname) string download( string pathname) YModule target download pathname Paramètres : pathname nom complet du fichier Retourne : le contenu du fichier chargé En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
Page 257 à 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 258 ) int functionCount( ) java functionCount( ) function functionCount( ) async functionCount( ): Promise<number> async functionCount( ) Retourne : le nombre de fonctions sur le module En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 259 à 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 260 à 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 261 à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant au type de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 262 à 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 263 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 264 ): Promise<YModule_Beacon> async get_beacon( ) int get_beacon( ) int get_beacon( ) YModule target get_beacon Retourne : YModule.BEACON_OFF YModule.BEACON_ON soit , soit , selon l'état de la balise de localisation En cas d'erreur, déclenche une exception ou retourne YModule.BEACON_INVALID www.yoctopuce.com...
Page 265 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du module www.yoctopuce.com...
Page 266 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du module...
Page 267 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.FIRMWARERELEASE_INVALID www.yoctopuce.com...
Page 268 $funType) async get_functionIds( funType: string): Promise<string[] async get_functionIds( funType) string[] get_functionIds( string funType) vector<string> get_functionIds( string funType) YModule target get_functionIds funType Paramètres : funType Le type de fonction (Relay, LightSensor, Voltage,...) Retourne : un tableau de chaînes de caractère. www.yoctopuce.com...
Page 269 ) string get_hardwareId( ) string get_hardwareId( ): string async Task<string> get_hardwareId( ) YModule target get_hardwareId L'identifiant unique est composé du numéro de série du module suivi de la chaîne ".module". Retourne : une chaîne de caractères identifiant la fonction www.yoctopuce.com...
Page 270 ) string get_icon2d( ) YModule target get_icon2d L'icone est au format PNG et a une taille maximale de 1536 octets. Retourne : un buffer binaire contenant l'icone, au format png. En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
Page 271 ) YModule target get_lastLogs Cette méthode retourne les derniers logs qui sont encore stocké dans le module. Retourne : une chaîne de caractère contenant les derniers logs du module. En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
Page 272 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YModule target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du module En cas d'erreur, déclenche une exception ou retourne YModule.LOGICALNAME_INVALID www.yoctopuce.com...
Page 273 ): Promise<number> async get_luminosity( ) int get_luminosity( ) int get_luminosity( ) YModule target get_luminosity Retourne : un entier représentant la luminosité des leds informatives du module (valeur entre 0 et 100) En cas d'erreur, déclenche une exception ou retourne YModule.LUMINOSITY_INVALID www.yoctopuce.com...
Page 274 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 275 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.PERSISTENTSETTINGS_INVALID www.yoctopuce.com...
Page 276 ) async get_productId( ): Promise<number> async get_productId( ) int get_productId( ) int get_productId( ) YModule target get_productId Retourne : un entier représentant l'identifiant USB du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTID_INVALID www.yoctopuce.com...
Page 277 ): Promise<string> async get_productName( ) string get_productName( ) string get_productName( ) YModule target get_productName Retourne : une chaîne de caractères représentant le nom commercial du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTNAME_INVALID www.yoctopuce.com...
Page 278 La révision originale du retourne la valeur 1, la révision B retourne la valeur 2, etc. Retourne : un entier représentant le numéro uméro de révision du module hardware, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTRELEASE_INVALID www.yoctopuce.com...
Page 279 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...
Page 280 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YModule target get_serialNumber Retourne : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.SERIALNUMBER_INVALID www.yoctopuce.com...
Page 281 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 282: Retourne Le Numbre De Millisecondes Écoulées Depuis La Mise Sous Tension Du Module
): Promise<number> async get_upTime( ) long get_upTime( ) s64 get_upTime( ) YModule target get_upTime Retourne : un entier représentant le numbre de millisecondes écoulées depuis la mise sous tension du module En cas d'erreur, déclenche une exception ou retourne YModule.UPTIME_INVALID www.yoctopuce.com...
Page 283 ): Promise<string> async get_url( ) string get_url( ) string get_url( ) YModule target get_url Si le module est connecté par USB la chaîne de caractère 'usb' est retournée. Retourne : une chaîne de caractère contenant l'URL du module. www.yoctopuce.com...
Page 284 ): Promise<number> async get_usbCurrent( ) int get_usbCurrent( ) int get_usbCurrent( ) YModule target get_usbCurrent Retourne : un entier représentant le courant consommé par le module sur le bus USB, en milliampères En cas d'erreur, déclenche une exception ou retourne YModule.USBCURRENT_INVALID www.yoctopuce.com...
Page 285 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 286 ) YModule target get_userVar Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Retourne : un entier représentant la valeur entière précédemment stockée dans cet attribut En cas d'erreur, déclenche une exception ou retourne YModule.USERVAR_INVALID www.yoctopuce.com...
Page 287 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 288 Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le module est joignable, sinon www.yoctopuce.com...
Page 289 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 290 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 291 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 292 ê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 293 Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les modules sont retournés. Si vous souhaitez retrouver un module spécifique, utilisez Module.findModule() avec un hardwareID ou un nom logique. Retourne : YModule null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 294 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 295 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 296: Paramètres
ConfigChangeCallback callback) int registerConfigChangeCallback( ConfigChangeCallback callback) java async Task<int> registerConfigChangeCallback( ConfigChangeCallback callback) registerConfigChangeCallback( callback) function registerConfigChangeCallback( $callback) async registerConfigChangeCallback( callback: YModuleConfigChangeCallback | null): Promise<number> async registerConfigChangeCallback( callback) Paramètres : callback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
Page 297 $callback) async registerLogCallback( callback: YModuleLogCallback | null): Promise<number> async registerLogCallback( callback) Utile pour débugger le fonctionnement d'un module Yoctopuce. Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'objet module qui a produit un log, un chaîne de caractère qui contiens le log...
Page 298 ) async revertFromFlash( ): Promise<number> async revertFromFlash( ) int revertFromFlash( ) int revertFromFlash( ) YModule target revertFromFlash Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 299 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 300 être préservés. saveToFlash() Paramètres : un objet binaire avec touts les paramètres settings Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 301 ê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 302 YModule target set_beacon newval Paramètres : newval soit YModule.BEACON_OFF , soit YModule.BEACON_ON Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 303 ê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 304 ê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 305 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 306 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 307 LongInt triggerConfigChangeCallback( ): LongInt function triggerConfigChangeCallback( ) As Integer int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) java async Task<int> triggerConfigChangeCallback( ) triggerConfigChangeCallback( ) function triggerConfigChangeCallback( ) async triggerConfigChangeCallback( ): Promise<number> async triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) YModule target triggerConfigChangeCallback www.yoctopuce.com...
Page 308 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 309 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 310 à 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 311 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 312: La Classe Yaccelerometer
24. Référence de l'API de haut niveau 24.3. La classe YAccelerometer Interface pour intéragir avec les accéléromètres, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La classe permet de lire et de configurer les accéléromètres Yoctopuce. Elle hérite YAccelerometer...
Page 313 Retourne la valeur actuelle de l'accélération, en g, sous forme de nombre à virgule. accelerometer→get_dataLogger() Retourne l'objet YDatalogger du module qui héberge le senseur. accelerometer→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'accéléromètre. accelerometer→get_errorType() www.yoctopuce.com...
Page 314 Retourne la valeur minimale observée pour l'accélération depuis le démarrage du module. accelerometer→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. accelerometer→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. accelerometer→get_recordedData(startTime, endTime)
Page 315 Modifie la fréquence de notification périodique des valeurs mesurées. accelerometer→set_resolution(newval) Modifie la résolution des valeurs physique mesurées. accelerometer→set_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la get_userData méthode accelerometer→startDataLogger() www.yoctopuce.com...
Page 316 Arrête l'enregistreur de données du module. accelerometer→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. accelerometer→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 317 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'accéléromètre sans ambiguïté, par exemple Y3DMK002.accelerometer Retourne : YAccelerometer un objet de classe qui permet ensuite de contrôler l'accéléromètre. www.yoctopuce.com...
Page 318 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'accéléromètre sans ambiguïté, par exemple Y3DMK002.accelerometer Retourne : YAccelerometer un objet de classe qui permet ensuite de contrôler l'accéléromètre. www.yoctopuce.com...
Page 319 FirstAccelerometer( ) Utiliser la fonction pour itérer sur les autres YAccelerometer.nextAccelerometer() accéléromètres. Retourne : un pointeur sur un objet YAccelerometer , correspondant au premier accéléromètre accessible en null ligne, ou si il n'y a pas de accéléromètres disponibles. www.yoctopuce.com...
Page 320 YAccelerometer.nextAccelerometer() accéléromètres. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YAccelerometer , correspondant au premier accéléromètre accessible en null ligne, ou si il n'y a pas de accéléromètres disponibles. www.yoctopuce.com...
Page 321 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le YAccelerometer.FindAccelerometer module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 322 24. Référence de l'API de haut niveau YAccelerometer accelerometer→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 323 24. Référence de l'API de haut niveau YAccelerometer accelerometer→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 324 24. Référence de l'API de haut niveau YAccelerometer accelerometer→Bandwidth Fréquence de rafraîchissement de la mesure, en Hz. int Bandwidth Modifiable. Lorsque la fréquence est plus basse, un moyennage est effectué. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 325 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 326 24. Référence de l'API de haut niveau YAccelerometer accelerometer→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 327 24. Référence de l'API de haut niveau YAccelerometer accelerometer→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 328 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 329 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence d'enregistrement à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 330 24. Référence de l'API de haut niveau YAccelerometer accelerometer→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 331 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence de notification périodique à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 332 Modifiable. Modifie la résolution des valeurs physique mesurées. La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 333 24. Référence de l'API de haut niveau YAccelerometer accelerometer→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 334 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
Page 335 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'accéléromètre. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 336 è r e s d é c r i v a n t l ' a c c é l é r o m è t r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 337 YAccelerometer.ADVMODE_PERIOD_AVG YAccelerometer.ADVMODE_PERIOD_MIN YAccelerometer.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne YAccelerometer.ADVMODE_INVALID www.yoctopuce.com...
Page 338 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 339 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.BANDWIDTH_INVALID www.yoctopuce.com...
Page 340 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
Page 341 En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
Page 342 YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
Page 343 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'accéléromètre.
Page 344 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'accéléromètre.
Page 345: Accelerometer→Get_Friendlyname()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 346: Accelerometer→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$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 347: Retourne L'identifiant Matériel De L'accéléromètre, Sans Référence Au Module
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.FUNCTIONID_INVALID www.yoctopuce.com...
Page 348: Accelerometer→Get_Hardwareid()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.HARDWAREID_INVALID www.yoctopuce.com...
Page 349: Accelerometer→Get_Highestvalue()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.HIGHESTVALUE_INVALID www.yoctopuce.com...
Page 350: Accelerometer→Get_Logfrequency()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.LOGFREQUENCY_INVALID www.yoctopuce.com...
Page 351: Accelerometer→Get_Logicalname()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.LOGICALNAME_INVALID www.yoctopuce.com...
Page 352: Accelerometer→Get_Lowestvalue()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.LOWESTVALUE_INVALID www.yoctopuce.com...
Page 353: Accelerometer→Get_Module()
24. Référence de l'API de haut niveau YAccelerometer accelerometer→get_module() accelerometer→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 354: Retourne L'objet Ymodule Correspondant Au Module Yoctopuce Qui Héberge La Fonction
24. Référence de l'API de haut niveau YAccelerometer accelerometer→get_module_async() accelerometer→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
Page 355 à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 356: Accelerometer→Get_Reportfrequency()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.REPORTFREQUENCY_INVALID www.yoctopuce.com...
Page 357: Accelerometer→Get_Resolution()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.RESOLUTION_INVALID www.yoctopuce.com...
Page 358: Accelerometer→Get_Sensorstate()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YAccelerometer.SENSORSTATE_INVALID www.yoctopuce.com...
Page 359: Accelerometer→Get_Serialnumber()
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YAccelerometer target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 360: Accelerometer→Get_Unit()
) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YAccelerometer target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle l'accélération est exprimée En cas d'erreur, déclenche une exception ou retourne YAccelerometer.UNIT_INVALID www.yoctopuce.com...
Page 361 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 362 ): Promise<number> async get_xValue( ) double get_xValue( ) double get_xValue( ) YAccelerometer target get_xValue Retourne : une valeur numérique représentant la composante X de l'accélération, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YAccelerometer.XVALUE_INVALID www.yoctopuce.com...
Page 363 ): Promise<number> async get_yValue( ) double get_yValue( ) double get_yValue( ) YAccelerometer target get_yValue Retourne : une valeur numérique représentant la composante Y de l'accélération, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YAccelerometer.YVALUE_INVALID www.yoctopuce.com...
Page 364 ): Promise<number> async get_zValue( ) double get_zValue( ) double get_zValue( ) YAccelerometer target get_zValue Retourne : une valeur numérique représentant la composante Z de l'accélération, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YAccelerometer.ZVALUE_INVALID www.yoctopuce.com...
Page 365 Si les valeurs des attributs en cache de l'accéléromètre sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'accéléromètre est joignable, sinon www.yoctopuce.com...
Page 366 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 367 ) YAccelerometer target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 368 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 369 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 370 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 371 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 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 373 é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 374 é c i f i q u e , u t i l i s e z Accelerometer.findAccelerometer() avec un hardwareID ou un nom logique. Retourne : YAccelerometer null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 375 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 376 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 377: Paramètres
Y A c c e l e r o m e t e r . A D V M O D E _ P E R I O D _ M I N YAccelerometer.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 378 être préservé. saveToFlash() Paramètres : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 379 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 380 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 381 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'accéléromètre. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 382 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 383 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 384 être préservé. Paramètres : une valeur numérique représentant la résolution des valeurs physique mesurées newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 385 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 386 ) int startDataLogger( ) int startDataLogger( ) YAccelerometer target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 387 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YAccelerometer target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 388 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 389 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 390: La Classe Ymagnetometer
Interface pour intéragir avec les magnétomètres, disponibles par exemple dans le Yocto-3D-V2 La classe est la classe parente de tous les types de capteurs Yoctopuce. Elle permet de lire YSensor la valeur courante et l'unité de n'importe quel capteur, de lire les valeurs min/max, de configurer la fréquence d'enregistrement autonome des données et de récupérer les mesures enregistrées.
Page 391 Retourne la valeur actuelle du champ magnétique, en mT, sous forme de nombre à virgule. magnetometer→get_dataLogger() YDatalogger Retourne l'objet du module qui héberge le senseur. magnetometer→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du magnétomètre. magnetometer→get_errorType() www.yoctopuce.com...
Page 392 Retourne la valeur minimale observée pour le champ magnétique depuis le démarrage du module. magnetometer→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. magnetometer→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction.
Page 393 Modifie la fréquence de notification périodique des valeurs mesurées. magnetometer→set_resolution(newval) Modifie la résolution des valeurs physique mesurées. magnetometer→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 magnetometer→startDataLogger() www.yoctopuce.com...
Page 394 Arrête l'enregistreur de données du module. magnetometer→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. magnetometer→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 395 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le magnétomètre sans ambiguïté, par exemple Y3DMK002.magnetometer Retourne : YMagnetometer un objet de classe qui permet ensuite de contrôler le magnétomètre. www.yoctopuce.com...
Page 396 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le magnétomètre sans ambiguïté, par exemple Y3DMK002.magnetometer Retourne : YMagnetometer un objet de classe qui permet ensuite de contrôler le magnétomètre. www.yoctopuce.com...
Page 397 FirstMagnetometer( ): YMagnetometer | null static FirstMagnetometer( ) Utiliser la fonction pour itérer sur les autres YMagnetometer.nextMagnetometer() magnétomètres. Retourne : un pointeur sur un objet YMagnetometer , correspondant au premier magnétomètre accessible en ligne, null si il n'y a pas de magnétomètres disponibles. www.yoctopuce.com...
Page 398 Utiliser la fonction pour itérer sur les autres YMagnetometer.nextMagnetometer() magnétomètres. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YMagnetometer , correspondant au premier magnétomètre accessible en ligne, null si il n'y a pas de magnétomètres disponibles. www.yoctopuce.com...
Page 399 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le YMagnetometer.FindMagnetometer module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 400 24. Référence de l'API de haut niveau YMagnetometer magnetometer→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 401 24. Référence de l'API de haut niveau YMagnetometer magnetometer→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 402: Magnetometer→Bandwidth [Modifiable]
24. Référence de l'API de haut niveau YMagnetometer magnetometer→Bandwidth Fréquence de rafraîchissement de la mesure, en Hz. int Bandwidth Modifiable. Lorsque la fréquence est plus basse, un moyennage est effectué. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 403: Magnetometer→Friendlyname [Lecture Seule]
Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 404: Magnetometer→Functionid [Lecture Seule]
24. Référence de l'API de haut niveau YMagnetometer magnetometer→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 405: Magnetometer→Hardwareid [Lecture Seule]
24. Référence de l'API de haut niveau YMagnetometer magnetometer→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 406: Magnetometer→Isonline [Lecture Seule]
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 407: Magnetometer→Logfrequency [Modifiable]
"OFF". Attention il est inutile, voir contre productif, de régler la fréquence d'enregistrement à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 408: Magnetometer→Logicalname [Modifiable]
24. Référence de l'API de haut niveau YMagnetometer magnetometer→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 409: Magnetometer→Reportfrequency [Modifiable]
"OFF". Attention il est inutile, voir contre productif, de régler la fréquence de notification périodique à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 410: Magnetometer→Resolution [Modifiable]
Modifiable. Modifie la résolution des valeurs physique mesurées. La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 411: Magnetometer→Serialnumber [Lecture Seule]
24. Référence de l'API de haut niveau YMagnetometer magnetometer→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 412 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
Page 413: Magnetometer→Clearcache()
) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du magnétomètre. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 414: Magnetometer→Describe()
î n e c a r a c t è r e s d é c r i v a n t m a g n é t o m è t r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 415: Retourne Le Mode De Calcul De La Valeur Publiée Jusqu'au Hub Parent (Advertisedvalue)
YMagnetometer.ADVMODE_PERIOD_AVG YMagnetometer.ADVMODE_PERIOD_MIN YMagnetometer.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 YMagnetometer.ADVMODE_INVALID www.yoctopuce.com...
Page 416: Magnetometer→Get_Advertisedvalue()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 417: Retourne La Fréquence De Rafraîchissement De La Mesure, En Hz
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.BANDWIDTH_INVALID www.yoctopuce.com...
Page 418: Magnetometer→Get_Currentrawvalue()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
Page 419: Magnetometer→Get_Currentvalue()
En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
Page 420: Magnetometer→Get_Datalogger()
YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
Page 421: Magnetometer→Get_Errormessage()
) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du magnétomètre.
Page 422: Retourne Le Code D'erreur Correspondant À La Dernière Erreur Survenue Lors De L'utilisation Du Magnétomètre
) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du magnétomètre.
Page 423: Magnetometer→Get_Friendlyname()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 424: Magnetometer→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$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 425: Magnetometer→Get_Functionid()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.FUNCTIONID_INVALID www.yoctopuce.com...
Page 426: Magnetometer→Get_Hardwareid()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.HARDWAREID_INVALID www.yoctopuce.com...
Page 427: Magnetometer→Get_Highestvalue()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.HIGHESTVALUE_INVALID www.yoctopuce.com...
Page 428: Magnetometer→Get_Logfrequency()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.LOGFREQUENCY_INVALID www.yoctopuce.com...
Page 429: Magnetometer→Get_Logicalname()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.LOGICALNAME_INVALID www.yoctopuce.com...
Page 430: Magnetometer→Get_Lowestvalue()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.LOWESTVALUE_INVALID www.yoctopuce.com...
Page 431: Retourne L'objet Ymodule Correspondant Au Module Yoctopuce Qui Héberge La Fonction
24. Référence de l'API de haut niveau YMagnetometer magnetometer→get_module() magnetometer→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 432: Retourne L'objet Ymodule Correspondant Au Module Yoctopuce Qui Héberge La Fonction
24. Référence de l'API de haut niveau YMagnetometer magnetometer→get_module_async() magnetometer→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 433 à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 434: Magnetometer→Get_Reportfrequency()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.REPORTFREQUENCY_INVALID www.yoctopuce.com...
Page 435: Magnetometer→Get_Resolution()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.RESOLUTION_INVALID www.yoctopuce.com...
Page 436: Magnetometer→Get_Sensorstate()
' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YMagnetometer.SENSORSTATE_INVALID www.yoctopuce.com...
Page 437: Magnetometer→Get_Serialnumber()
): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YMagnetometer target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 438: Retourne L'unité Dans Laquelle Le Champ Magnétique Est Exprimée
): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YMagnetometer target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle le champ magnétique est exprimée En cas d'erreur, déclenche une exception ou retourne YMagnetometer.UNIT_INVALID www.yoctopuce.com...
Page 439: Retourne Le Contenu De L'attribut Userdata, Précédemment Stocké À L'aide De La Méthode
) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 440: Retourne La Composante X Du Champ Magnétique, Sous Forme De Nombre À Virgule
) double get_xValue( ) double get_xValue( ) YMagnetometer target get_xValue Retourne : une valeur numérique représentant la composante X du champ magnétique, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YMagnetometer.XVALUE_INVALID www.yoctopuce.com...
Page 441: Retourne La Composante Y Du Champ Magnétique, Sous Forme De Nombre À Virgule
) double get_yValue( ) double get_yValue( ) YMagnetometer target get_yValue Retourne : une valeur numérique représentant la composante Y du champ magnétique, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YMagnetometer.YVALUE_INVALID www.yoctopuce.com...
Page 442: Retourne La Composante Z Du Champ Magnétique, Sous Forme De Nombre À Virgule
) double get_zValue( ) double get_zValue( ) YMagnetometer target get_zValue Retourne : une valeur numérique représentant la composante Z du champ magnétique, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YMagnetometer.ZVALUE_INVALID www.yoctopuce.com...
Page 443: Magnetometer→Isonline()
Si les valeurs des attributs en cache du magnétomètre sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le magnétomètre est joignable, sinon www.yoctopuce.com...
Page 444 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 445 ) YMagnetometer target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 446 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 447 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 448 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 449 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 450 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 451 é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 452 é c i f i q u e , u t i l i s e z Magnetometer.findMagnetometer() avec un hardwareID ou un nom logique. Retourne : YMagnetometer null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 453 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 454 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 455: Paramètres
Y M a g n e t o m e t e r . A D V M O D E _ P E R I O D _ M I N YMagnetometer.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 456 être préservé. saveToFlash() Paramètres : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 457 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 458 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 459 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du magnétomètre. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 460 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 461 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 462 être préservé. Paramètres : une valeur numérique représentant la résolution des valeurs physique mesurées newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 463 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 464 ) int startDataLogger( ) int startDataLogger( ) YMagnetometer 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 465 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YMagnetometer target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 466 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 467 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 468: La Classe Yrefframe
24. Référence de l'API de haut niveau 24.5. La classe YRefFrame Interface de configuration du référentiel 3D, disponibles par exemple dans le Yocto-3D-V2 et le Yocto- Inclinometer La class permet de configurer l'orientation des capteurs inertiels Yoctopuce. Cela permet YRefFrame aux fonctions d'orientation relatives au plan de la surface terrestre d'utiliser le référentiel approprié.
Page 469 Retourne la valeur courante du référentiel (pas plus de 6 caractères). refframe→get_bearing() Retourne le cap de référence utilisé par le compas. refframe→get_calibrationState() Retourne l'état de calibration des capteurs 3D (Yocto-3D-V2 seulement). refframe→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du référentiel. refframe→get_errorType() Retourne le code d'erreur correspondant à...
Page 470 Retourne l'identifiant matériel unique du référentiel au format SERIAL.FUNCTIONID refframe→get_logicalName() Retourne le nom logique du référentiel. refframe→get_measureQuality() Retourne l'estimation de qualité de la mesure d'orientation (Yocto-3D-V2 seulement). refframe→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. refframe→get_module_async(callback, context)
Page 471 Initie le processus de calibration tridimensionnelle des capteurs. refframe→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. refframe→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 472 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le référentiel sans ambiguïté, par exemple Y3DMK002.refFrame Retourne : YRefFrame un objet de classe qui permet ensuite de contrôler le référentiel. www.yoctopuce.com...
Page 473 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le référentiel sans ambiguïté, par exemple Y3DMK002.refFrame Retourne : YRefFrame un objet de classe qui permet ensuite de contrôler le référentiel. www.yoctopuce.com...
Page 474 FirstRefFrame( ) Utiliser la fonction pour itérer sur les autres référentiels. YRefFrame.nextRefFrame() Retourne : un pointeur sur un objet YRefFrame , correspondant au premier référentiel accessible en ligne, ou null si il n'y a pas de référentiels disponibles. www.yoctopuce.com...
Page 475 YRefFrame.nextRefFrame() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YRefFrame , correspondant au premier référentiel accessible en ligne, ou null si il n'y a pas de référentiels disponibles. www.yoctopuce.com...
Page 476 Chaque chaîne retournée peut être passée en argument à la méthode YRefFrame.FindRefFrame pour obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 477 24. Référence de l'API de haut niveau YRefFrame refframe→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 478 De même, si le capteur n'est pas positionné dans une des directions standard à cause d'un angle de lacet supplémentaire, vous pouvez le configurer comme cap de référence afin que le compas donne la direction naturelle attendue. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 479 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 480 24. Référence de l'API de haut niveau YRefFrame refframe→FunctionId Identifiant matériel du référentiel, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 481 Notez que les modes de fonctionnements disponibles dépendent du type de capteur. Modifiable. Notez que les modes de fonctionnements disponibles dépendent du type de capteur. N'oubliez pas d'appeler la méthode du module si vous désirez que le réglage soit saveToFlash() préservé au prochain redémarrage. www.yoctopuce.com...
Page 482 24. Référence de l'API de haut niveau YRefFrame refframe→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 483 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 484 24. Référence de l'API de haut niveau YRefFrame refframe→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 485 24. Référence de l'API de haut niveau YRefFrame refframe→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 486 ) java async Task<int> cancel3DCalibration( ) cancel3DCalibration( ) function cancel3DCalibration( ) async cancel3DCalibration( ): Promise<number> async cancel3DCalibration( ) int cancel3DCalibration( ) int cancel3DCalibration( ) YRefFrame target cancel3DCalibration En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 487 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du référentiel. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 488 î n e c a r a c t è r e s d é c r i v a n t r é f é r e n t i e l ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 489 ) As String string get_3DCalibrationHint( ) String get_3DCalibrationHint( ) java async Task<string> get_3DCalibrationHint( ) get_3DCalibrationHint( ) function get_3DCalibrationHint( ) async get_3DCalibrationHint( ): Promise<string> async get_3DCalibrationHint( ) string get_3DCalibrationHint( ) string get_3DCalibrationHint( ) YRefFrame target get_3DCalibrationHint Retourne : une chaîne de caractères. www.yoctopuce.com...
Page 490 Task<string> get_3DCalibrationLogMsg( ) get_3DCalibrationLogMsg( ) function get_3DCalibrationLogMsg( ) async get_3DCalibrationLogMsg( ): Promise<string> async get_3DCalibrationLogMsg( ) string get_3DCalibrationLogMsg( ) string get_3DCalibrationLogMsg( ) YRefFrame target get_3DCalibrationLogMsg Si aucun nouveau message n'est disponible, retourne une chaîne vide. Retourne : une chaîne de caractères. www.yoctopuce.com...
Page 491 ) java async Task<int> get_3DCalibrationProgress( ) get_3DCalibrationProgress( ) function get_3DCalibrationProgress( ) async get_3DCalibrationProgress( ): Promise<number> async get_3DCalibrationProgress( ) int get_3DCalibrationProgress( ) int get_3DCalibrationProgress( ) YRefFrame target get_3DCalibrationProgress Retourne : une nombre entier entre 0 (pas commencé) et 100 (terminé). www.yoctopuce.com...
Page 492 Task<int> get_3DCalibrationStage( ) get_3DCalibrationStage( ) function get_3DCalibrationStage( ) async get_3DCalibrationStage( ): Promise<number> async get_3DCalibrationStage( ) int get_3DCalibrationStage( ) int get_3DCalibrationStage( ) YRefFrame target get_3DCalibrationStage Retourne : une nombre entier, croissant au fur et à mesure de la complétion des étapes. www.yoctopuce.com...
Page 493 ) java async Task<int> get_3DCalibrationStageProgress( ) get_3DCalibrationStageProgress( ) function get_3DCalibrationStageProgress( ) async get_3DCalibrationStageProgress( ): Promise<number> async get_3DCalibrationStageProgress( ) int get_3DCalibrationStageProgress( ) int get_3DCalibrationStageProgress( ) YRefFrame target get_3DCalibrationStageProgress Retourne : une nombre entier entre 0 (pas commencé) et 100 (terminé). www.yoctopuce.com...
Page 494 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRefFrame.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 495 Le cap relatif indiqué par le compas est la différence entre le Nord magnétique mesuré et le cap de référence spécifié ici. Retourne : une valeur numérique représentant le cap de référence utilisé par le compas En cas d'erreur, déclenche une exception ou retourne YRefFrame.BEARING_INVALID www.yoctopuce.com...
Page 496 Retourne : un entier représentant l'état de calibration du Yocto-3D-V2: 333 quand il est entièrement calibré, 0 lorsqu'il n'est pas calibré du tout. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. Pour le Yocto-3D (V1), la valeur retournée est toujours -3 (fonction non supportée).
Page 497 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du référentiel.
Page 498 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du référentiel.
Page 499 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le référentiel en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YRefFrame.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 500 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 501 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le référentiel (ex: En cas d'erreur, déclenche une exception ou retourne YRefFrame.FUNCTIONID_INVALID www.yoctopuce.com...
Page 502 Y R e f F r a m e . F U S I O N M O D E _ I N C L I N _ 9 0 D E G _ 3 G 6 YRefFrame.FUSIONMODE_INCLIN_10DEG représentant le mode de fonctionnement du capteur En cas d'erreur, déclenche une exception ou retourne YRefFrame.FUSIONMODE_INVALID www.yoctopuce.com...
Page 503 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du référentiel (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le référentiel (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YRefFrame.HARDWAREID_INVALID www.yoctopuce.com...
Page 504 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YRefFrame target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du référentiel. En cas d'erreur, déclenche une exception ou retourne YRefFrame.LOGICALNAME_INVALID www.yoctopuce.com...
Page 505 24. Référence de l'API de haut niveau YRefFrame refframe→get_measureQuality() refframe→measureQuality() Retourne l'estimation de qualité de la mesure d'orientation (Yocto-3D-V2 seulement). function get_measureQuality( ) int get_measureQuality( ) -(int) measureQuality LongInt get_measureQuality( ): LongInt function get_measureQuality( ) As Integer int get_measureQuality( )
Page 506 24. Référence de l'API de haut niveau YRefFrame refframe→get_module() refframe→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 507 24. Référence de l'API de haut niveau YRefFrame refframe→get_module_async() refframe→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
Page 508 à la l'orientation de la flèche "X" sur le module par rapport à un cadran d'horloge vu par un observateur au centre de la boîte. Sur la face BOTTOM le 12h pointe vers l'avant, tandis que sur la face TOP le 12h pointe vers l'arrière. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 509 ' é n u m é r a t i o n YRefFrame.MOUNTPOSITION_BOTTOM YRefFrame.MOUNTPOSITION_TOP YRefFrame.MOUNTPOSITION_FRONT YRefFrame.MOUNTPOSITION_RIGHT YRefFrame.MOUNTPOSITION_REAR YRefFrame.MOUNTPOSITION_LEFT ), correspondant à l'installation dans une boîte, sur l'une des six faces En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 510 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YRefFrame target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 511 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 512 Si les valeurs des attributs en cache du référentiel sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le référentiel est joignable, sinon www.yoctopuce.com...
Page 513 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 514 ) YRefFrame target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 515 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 516 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 517 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 518 Cette méthode doit être appelée environ 5 fois par secondes après avoir positionné le module selon les instructions fournies par la méthode get_3DCalibrationHint (les instructions changent pendant la procédure de calibration). En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 519 é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 520 ): YRefFrame | null nextRefFrame( ) Si vous souhaitez retrouver un référentiel spécifique, utilisez RefFrame.findRefFrame() avec un hardwareID ou un nom logique. Retourne : YRefFrame null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 521 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 522 ) int save3DCalibration( ) YRefFrame target save3DCalibration N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé après saveToFlash() le redémarrage du module. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 523 être préservé. Paramètres : newval une valeur numérique représentant le cap de référence utilisé par le compas Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 524 Y R e f F r a m e . F U S I O N M O D E _ I N C L I N _ 9 0 D E G _ 3 G 6 YRefFrame.FUSIONMODE_INCLIN_10DEG représentant le mode de fonctionnement du capteur Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 525 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du référentiel. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 526 "X" sur le module par rapport à un cadran d'horloge vu par un observateur au centre de la boîte. Sur la face BOTTOM le 12h pointe vers l'avant, tandis que sur la face TOP le 12h pointe vers l'arrière. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 527 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 528 100. Il est alors possible d'appliquer les paramètres get_3DCalibrationProgress calculés, à l'aide de la méthode save3DCalibration . A tout moment, la calibration peut être abandonnée à l'aide de cancel3DCalibration En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 529 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 530 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 531: La Classe Ytilt
24. Référence de l'API de haut niveau 24.6. La classe YTilt Interface pour intéragir avec les inclinomètres, disponibles par exemple dans le Yocto-3D-V2 et le Yocto-Inclinometer La classe est la classe parente de tous les types de capteurs Yoctopuce. Elle permet de lire YSensor la valeur courante et l'unité...
Page 532 Retourne la fréquence de rafraîchissement de la mesure, en Hz. tilt→get_currentRawValue() Retourne la valeur brute retournée par le capteur (sans arrondi ni calibration), en degrés, sous forme de nombre à virgule. tilt→get_currentValue() Retourne la valeur actuelle de l'inclinaison, en degrés, sous forme de nombre à virgule. tilt→get_dataLogger() www.yoctopuce.com...
Page 533 Retourne la valeur minimale observée pour l'inclinaison depuis le démarrage du module. tilt→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. tilt→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. tilt→get_recordedData(startTime, endTime)
Page 534 Modifie la fréquence de notification périodique des valeurs mesurées. tilt→set_resolution(newval) Modifie la résolution des valeurs physique mesurées. tilt→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 tilt→startDataLogger() www.yoctopuce.com...
Page 535 Arrête l'enregistreur de données du module. tilt→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. tilt→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 536 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'inclinomètre sans ambiguïté, par exemple Y3DMK002.tilt1 Retourne : YTilt un objet de classe qui permet ensuite de contrôler l'inclinomètre. www.yoctopuce.com...
Page 537 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'inclinomètre sans ambiguïté, par exemple Y3DMK002.tilt1 Retourne : YTilt un objet de classe qui permet ensuite de contrôler l'inclinomètre. www.yoctopuce.com...
Page 538 FirstTilt( ) Utiliser la fonction pour itérer sur les autres inclinomètres. YTilt.nextTilt() Retourne : un pointeur sur un objet YTilt , correspondant au premier inclinomètre accessible en ligne, ou null si il n'y a pas de inclinomètres disponibles. www.yoctopuce.com...
Page 539 YTilt.nextTilt() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YTilt , correspondant au premier inclinomètre accessible en ligne, ou null si il n'y a pas de inclinomètres disponibles. www.yoctopuce.com...
Page 540 Chaque chaîne retournée peut être passée en argument à la méthode pour YTilt.FindTilt obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 541 24. Référence de l'API de haut niveau YTilt tilt→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 542 24. Référence de l'API de haut niveau YTilt tilt→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 543 24. Référence de l'API de haut niveau YTilt tilt→Bandwidth Fréquence de rafraîchissement de la mesure, en Hz. int Bandwidth Modifiable. Lorsque la fréquence est plus basse, un moyennage est effectué. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 544 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 545 24. Référence de l'API de haut niveau YTilt tilt→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 546 24. Référence de l'API de haut niveau YTilt tilt→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 547 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 548 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence d'enregistrement à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 549 24. Référence de l'API de haut niveau YTilt tilt→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 550 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence de notification périodique à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 551 Modifiable. Modifie la résolution des valeurs physique mesurées. La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 552 24. Référence de l'API de haut niveau YTilt tilt→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 553 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
Page 554 Attention, le décalage se répercute aussi sur les bornes de la mesure. 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 555 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'inclinomètre. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 556 î n e c a r a c t è r e s d é c r i v a n t l ' i n c l i n o m è t r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 557 ) int get_advMode( ) YTilt target get_advMode Retourne : YTilt.ADVMODE_IMMEDIATE YTilt.ADVMODE_PERIOD_AVG une valeur parmi YTilt.ADVMODE_PERIOD_MIN YTilt.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne YTilt.ADVMODE_INVALID www.yoctopuce.com...
Page 558 ): Promise<string> async get_advertisedValue( ) string get_advertisedValue( ) string get_advertisedValue( ) YTilt target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'inclinomètre (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YTilt.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 559 ): Promise<number> async get_bandwidth( ) int get_bandwidth( ) int get_bandwidth( ) YTilt target get_bandwidth Retourne : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz En cas d'erreur, déclenche une exception ou retourne YTilt.BANDWIDTH_INVALID www.yoctopuce.com...
Page 560 ) YTilt target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en degrés, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YTilt.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
Page 561 En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
Page 562 YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
Page 563 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'inclinomètre.
Page 564 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'inclinomètre.
Page 565 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'inclinomètre en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YTilt.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 566 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 567 ) function get_functionId( ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'inclinomètre (ex: En cas d'erreur, déclenche une exception ou retourne YTilt.FUNCTIONID_INVALID www.yoctopuce.com...
Page 568 ) L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'inclinomètre (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'inclinomètre (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YTilt.HARDWAREID_INVALID www.yoctopuce.com...
Page 569 YTilt target get_highestValue Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour l'inclinaison depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YTilt.HIGHESTVALUE_INVALID www.yoctopuce.com...
Page 570 Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne YTilt.LOGFREQUENCY_INVALID www.yoctopuce.com...
Page 571 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YTilt target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'inclinomètre. En cas d'erreur, déclenche une exception ou retourne YTilt.LOGICALNAME_INVALID www.yoctopuce.com...
Page 572 YTilt target get_lowestValue Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour l'inclinaison depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YTilt.LOWESTVALUE_INVALID www.yoctopuce.com...
Page 573 24. Référence de l'API de haut niveau YTilt tilt→get_module() tilt→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 574 24. Référence de l'API de haut niveau YTilt tilt→get_module_async() tilt→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
Page 575 à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 576 ) YTilt target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne YTilt.REPORTFREQUENCY_INVALID www.yoctopuce.com...
Page 577 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne YTilt.RESOLUTION_INVALID www.yoctopuce.com...
Page 578 En cas d'erreur, déclenche une exception ou retourne YTilt.SENSORSTATE_INVALID www.yoctopuce.com...
Page 579 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YTilt target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 580 ) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YTilt target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle l'inclinaison est exprimée En cas d'erreur, déclenche une exception ou retourne YTilt.UNIT_INVALID www.yoctopuce.com...
Page 581 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 582 Si les valeurs des attributs en cache de l'inclinomètre sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'inclinomètre est joignable, sinon www.yoctopuce.com...
Page 583 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 584 ) YTilt target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 585 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 586 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 587 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 588 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 589 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 590 é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 591 ): YTilt | null nextTilt( ) Si vous souhaitez retrouver un inclinomètre spécifique, utilisez Tilt.findTilt() avec un hardwareID ou un nom logique. Retourne : YTilt null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 592 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux YMeasure arguments: l'object fonction dont la valeur a changé, et un objet décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 593 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 594 ) int restoreZeroCalibration( ) int restoreZeroCalibration( ) YTilt target restoreZeroCalibration Cette fonction restaure les réglages de zéro d'usine. 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 595 YTilt.ADVMODE_PERIOD_MIN YTilt.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 596 être préservé. saveToFlash() Paramètres : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 597 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 598 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 599 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'inclinomètre. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 600 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 601 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 602 être préservé. Paramètres : une valeur numérique représentant la résolution des valeurs physique mesurées newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 603 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 604 ) int startDataLogger( ) int startDataLogger( ) YTilt target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 605 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YTilt target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 606 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 607 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 608: La Classe Ycompass
24. Référence de l'API de haut niveau 24.7. La classe YCompass Interface pour intéragir avec les fonctions boussole, disponibles par exemple dans le Yocto-3D-V2 La classe permet de lire et de configurer les fonctions boussole Yoctopuce. Elle hérite de la...
Page 609 Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de la fonction boussole. compass→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de la fonction boussole. compass→get_friendlyName() www.yoctopuce.com...
Page 610 Retourne la valeur minimale observée pour le cap relatif depuis le démarrage du module. compass→get_magneticHeading() Retourne la direction du nord magnétique, indépendemment du cap configuré. compass→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. compass→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. compass→get_recordedData(startTime, endTime)
Page 611 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 compass→startDataLogger() Démarre l'enregistreur de données du module. compass→stopDataLogger() Arrête l'enregistreur de données du module. compass→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. compass→wait_async(callback, context) www.yoctopuce.com...
Page 612 24. Référence de l'API de haut niveau 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 613 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence la fonction boussole sans ambiguïté, par exemple Y3DMK002.compass Retourne : YCompass un objet de classe qui permet ensuite de contrôler la fonction boussole. www.yoctopuce.com...
Page 614 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence la fonction boussole sans ambiguïté, par exemple Y3DMK002.compass Retourne : YCompass un objet de classe qui permet ensuite de contrôler la fonction boussole. www.yoctopuce.com...
Page 615 Utiliser la fonction pour itérer sur les autres fonctions boussole. YCompass.nextCompass() Retourne : un pointeur sur un objet YCompass , correspondant à la première fonction boussole accessible en ligne, ou null si il n'y a pas de fonctions boussole disponibles. www.yoctopuce.com...
Page 616 YCompass.nextCompass() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YCompass , correspondant à la première fonction boussole accessible en ligne, ou null si il n'y a pas de fonctions boussole disponibles. www.yoctopuce.com...
Page 617 Chaque chaîne retournée peut être passée en argument à la méthode YCompass.FindCompass pour obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 618 24. Référence de l'API de haut niveau YCompass compass→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 619 24. Référence de l'API de haut niveau YCompass compass→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 620 24. Référence de l'API de haut niveau YCompass compass→Bandwidth Fréquence de rafraîchissement de la mesure, en Hz. int Bandwidth Modifiable. Lorsque la fréquence est plus basse, un moyennage est effectué. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 621 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 622 24. Référence de l'API de haut niveau YCompass compass→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 623 24. Référence de l'API de haut niveau YCompass compass→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 624 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 625 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence d'enregistrement à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 626 24. Référence de l'API de haut niveau YCompass compass→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 627 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence de notification périodique à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 628 Modifiable. Modifie la résolution des valeurs physique mesurées. La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 629 24. Référence de l'API de haut niveau YCompass compass→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 630 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
Page 631 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de la fonction boussole. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 632 è r e s d é c r i v a n t f o n c t i o n b o u s s o l e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 633 ) int get_advMode( ) YCompass target get_advMode Retourne : YCompass.ADVMODE_IMMEDIATE YCompass.ADVMODE_PERIOD_AVG une valeur parmi YCompass.ADVMODE_PERIOD_MIN YCompass.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 YCompass.ADVMODE_INVALID www.yoctopuce.com...
Page 634 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YCompass.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 635 ): Promise<number> async get_bandwidth( ) int get_bandwidth( ) int get_bandwidth( ) YCompass target get_bandwidth Retourne : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz En cas d'erreur, déclenche une exception ou retourne YCompass.BANDWIDTH_INVALID www.yoctopuce.com...
Page 636 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YCompass.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
Page 637 En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
Page 638 YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
Page 639 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de la fonction boussole.
Page 640 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de la fonction boussole.
Page 641 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant la fonction boussole en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YCompass.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 642 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 643 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant la fonction boussole (ex: En cas d'erreur, déclenche une exception ou retourne YCompass.FUNCTIONID_INVALID www.yoctopuce.com...
Page 644 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction boussole (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant la fonction boussole (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YCompass.HARDWAREID_INVALID www.yoctopuce.com...
Page 645 Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour le cap relatif depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YCompass.HIGHESTVALUE_INVALID www.yoctopuce.com...
Page 646 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 YCompass.LOGFREQUENCY_INVALID www.yoctopuce.com...
Page 647 ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YCompass target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de la fonction boussole. En cas d'erreur, déclenche une exception ou retourne YCompass.LOGICALNAME_INVALID www.yoctopuce.com...
Page 648 Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour le cap relatif depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YCompass.LOWESTVALUE_INVALID www.yoctopuce.com...
Page 649 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YCompass.MAGNETICHEADING_INVALID www.yoctopuce.com...
Page 650 24. Référence de l'API de haut niveau YCompass compass→get_module() compass→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 651 24. Référence de l'API de haut niveau YCompass compass→get_module_async() compass→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 652 à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 653 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YCompass.REPORTFREQUENCY_INVALID www.yoctopuce.com...
Page 654 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne YCompass.RESOLUTION_INVALID www.yoctopuce.com...
Page 655 En cas d'erreur, déclenche une exception ou retourne YCompass.SENSORSTATE_INVALID www.yoctopuce.com...
Page 656 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YCompass target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 657 ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YCompass target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle le cap relatif est exprimée En cas d'erreur, déclenche une exception ou retourne YCompass.UNIT_INVALID www.yoctopuce.com...
Page 658 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 659 Si les valeurs des attributs en cache de la fonction boussole sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si la fonction boussole est joignable, sinon www.yoctopuce.com...
Page 660 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 661 ) YCompass target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 662 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 663 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 664 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 665 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 666 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 667 é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 668 ): YCompass | null nextCompass( ) Si vous souhaitez retrouver une fonction boussole spécifique, utilisez Compass.findCompass() avec un hardwareID ou un nom logique. Retourne : YCompass null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 669 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 670 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 671 YCompass.ADVMODE_PERIOD_AVG YCompass.ADVMODE_PERIOD_MIN YCompass.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 672 être préservé. saveToFlash() Paramètres : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 673 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 674 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 675 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de la fonction boussole. 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 676 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 677 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 678 être préservé. Paramètres : une valeur numérique représentant la résolution des valeurs physique mesurées newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 679 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 680 ) int startDataLogger( ) int startDataLogger( ) YCompass 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 681 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YCompass target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 682 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 683 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 684: La Classe Ygyro
Interface pour intéragir avec les gyroscopes, disponibles par exemple dans le Yocto-3D-V2 La classe permet de lire et de configurer les gyroscopes Yoctopuce. Elle hérite de la classe YGyro toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, YSensor enregistreur de données.
Page 685 Retourne la valeur actuelle de la vitesse angulaire, en degrés par seconde, sous forme de nombre à virgule. gyro→get_dataLogger() Retourne l'objet YDatalogger du module qui héberge le senseur. gyro→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du gyroscope. gyro→get_errorType() www.yoctopuce.com...
Page 686 Retourne la valeur minimale observée pour la vitesse angulaire depuis le démarrage du module. gyro→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. gyro→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction.
Page 687 Continue l'énumération des gyroscopes commencée à l'aide de yFirstGyro() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les gyroscopes sont retournés. gyro→registerAnglesCallback(callback) Enregistre une fonction de callback qui sera appelée à chaque changement de l'estimation de l'orientation du module. gyro→registerQuaternionCallback(callback) www.yoctopuce.com...
Page 688 Arrête l'enregistreur de données du module. gyro→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. gyro→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 689 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le gyroscope sans ambiguïté, par exemple Y3DMK002.gyro Retourne : YGyro un objet de classe qui permet ensuite de contrôler le gyroscope. www.yoctopuce.com...
Page 690 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le gyroscope sans ambiguïté, par exemple Y3DMK002.gyro Retourne : YGyro un objet de classe qui permet ensuite de contrôler le gyroscope. www.yoctopuce.com...
Page 691 FirstGyro( ) Utiliser la fonction pour itérer sur les autres gyroscopes. YGyro.nextGyro() Retourne : un pointeur sur un objet YGyro , correspondant au premier gyroscope accessible en ligne, ou null si il n'y a pas de gyroscopes disponibles. www.yoctopuce.com...
Page 692 YGyro.nextGyro() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YGyro , correspondant au premier gyroscope accessible en ligne, ou null si il n'y a pas de gyroscopes disponibles. www.yoctopuce.com...
Page 693 Chaque chaîne retournée peut être passée en argument à la méthode pour YGyro.FindGyro obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 694 24. Référence de l'API de haut niveau YGyro gyro→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 695 24. Référence de l'API de haut niveau YGyro gyro→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 696 24. Référence de l'API de haut niveau YGyro gyro→Bandwidth Fréquence de rafraîchissement de la mesure, en Hz. int Bandwidth Modifiable. Lorsque la fréquence est plus basse, un moyennage est effectué. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 697 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 698 24. Référence de l'API de haut niveau YGyro gyro→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 699 24. Référence de l'API de haut niveau YGyro gyro→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 700 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 701 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence d'enregistrement à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
Page 702 24. Référence de l'API de haut niveau YGyro gyro→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 703 "OFF". Attention il est inutile, voir contre productif, de régler la fréquence de notification périodique à une valeur supérieure à la fréquence d'échantillonnage native du capteur: ces deux fréquences sont complètement indépendantes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
Page 704 Modifiable. Modifie la résolution des valeurs physique mesurées. La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 705 24. Référence de l'API de haut niveau YGyro gyro→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 706 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
Page 707 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du gyroscope. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 708 î n e c a r a c t è r e s d é c r i v a n t g y r o s c o p e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 709 ) int get_advMode( ) YGyro target get_advMode Retourne : YGyro.ADVMODE_IMMEDIATE YGyro.ADVMODE_PERIOD_AVG une valeur parmi YGyro.ADVMODE_PERIOD_MIN YGyro.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 YGyro.ADVMODE_INVALID www.yoctopuce.com...
Page 710 ): Promise<string> async get_advertisedValue( ) string get_advertisedValue( ) string get_advertisedValue( ) YGyro target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du gyroscope (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YGyro.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 711 ): Promise<number> async get_bandwidth( ) int get_bandwidth( ) int get_bandwidth( ) YGyro target get_bandwidth Retourne : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz En cas d'erreur, déclenche une exception ou retourne YGyro.BANDWIDTH_INVALID www.yoctopuce.com...
Page 712 YGyro 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 par seconde, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YGyro.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
Page 713 En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
Page 714 YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
Page 715 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du gyroscope.
Page 716 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du gyroscope.
Page 717 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le gyroscope en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YGyro.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 718 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 719 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le gyroscope (ex: En cas d'erreur, déclenche une exception ou retourne YGyro.FUNCTIONID_INVALID www.yoctopuce.com...
Page 720 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du gyroscope (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le gyroscope (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YGyro.HARDWAREID_INVALID www.yoctopuce.com...
Page 721 L'axe de lacet peut être attribué à n'importe laquelle des direction physiques X, Y ou Z du module à l'aide des méthodes de la classe YRefFrame Retourne : un nombre à virgule correspondant au cap, exprimé en degrés (entre 0 et 360). www.yoctopuce.com...
Page 722 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 vitesse angulaire depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YGyro.HIGHESTVALUE_INVALID www.yoctopuce.com...
Page 723 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 YGyro.LOGFREQUENCY_INVALID www.yoctopuce.com...
Page 724 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YGyro target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du gyroscope. En cas d'erreur, déclenche une exception ou retourne YGyro.LOGICALNAME_INVALID www.yoctopuce.com...
Page 725 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 vitesse angulaire depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YGyro.LOWESTVALUE_INVALID www.yoctopuce.com...
Page 726 24. Référence de l'API de haut niveau YGyro gyro→get_module() gyro→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 727 24. Référence de l'API de haut niveau YGyro gyro→get_module_async() gyro→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 728 L'axe de tangage peut être attribué à n'importe laquelle des direction physiques X, Y ou Z du module à l'aide des méthodes de la classe YRefFrame Retourne : un nombre à virgule correspondant à l'assiette, exprimée en degrés (entre -90 et +90). www.yoctopuce.com...
Page 729 ) java async Task<double> get_quaternionW( ) get_quaternionW( ) function get_quaternionW( ) async get_quaternionW( ): Promise<number> async get_quaternionW( ) double get_quaternionW( ) double get_quaternionW( ) YGyro target get_quaternionW Retourne : un nombre à virgule correspondant à la composante du quaternion. www.yoctopuce.com...
Page 730 ): Promise<number> async get_quaternionX( ) double get_quaternionX( ) double get_quaternionX( ) YGyro target get_quaternionX La composante est essentiellement corrélée aux rotations sur l'axe de roulis. Retourne : un nombre à virgule correspondant à la composante du quaternion. www.yoctopuce.com...
Page 731 ): Promise<number> async get_quaternionY( ) double get_quaternionY( ) double get_quaternionY( ) YGyro target get_quaternionY La composante est essentiellement corrélée aux rotations sur l'axe de tangage. Retourne : un nombre à virgule correspondant à la composante du quaternion. www.yoctopuce.com...
Page 732 ): Promise<number> async get_quaternionZ( ) double get_quaternionZ( ) double get_quaternionZ( ) YGyro target get_quaternionZ La composante est essentiellement corrélée aux rotations sur l'axe de lacet. Retourne : un nombre à virgule correspondant à la composante du quaternion. www.yoctopuce.com...
Page 733 à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 734 ) YGyro 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 YGyro.REPORTFREQUENCY_INVALID www.yoctopuce.com...
Page 735 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne YGyro.RESOLUTION_INVALID www.yoctopuce.com...
Page 736 L'axe de roulis peut être attribué à n'importe laquelle des direction physiques X, Y ou Z du module à l'aide des méthodes de la classe YRefFrame Retourne : un nombre à virgule correspondant à l'inclinaison, exprimée en degrés (entre -180 et +180). www.yoctopuce.com...
Page 737 En cas d'erreur, déclenche une exception ou retourne YGyro.SENSORSTATE_INVALID www.yoctopuce.com...
Page 738 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YGyro target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 739 ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YGyro target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la vitesse angulaire est exprimée En cas d'erreur, déclenche une exception ou retourne YGyro.UNIT_INVALID www.yoctopuce.com...
Page 740 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 741 ) double get_xValue( ) YGyro target get_xValue Retourne : une valeur numérique représentant la vitesse angulaire autour de l'axe X du module, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YGyro.XVALUE_INVALID www.yoctopuce.com...
Page 742 ) double get_yValue( ) YGyro target get_yValue Retourne : une valeur numérique représentant la vitesse angulaire autour de l'axe Y du module, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YGyro.YVALUE_INVALID www.yoctopuce.com...
Page 743 ) double get_zValue( ) YGyro target get_zValue Retourne : une valeur numérique représentant la vitesse angulaire autour de l'axe Z du module, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YGyro.ZVALUE_INVALID www.yoctopuce.com...
Page 744 Si les valeurs des attributs en cache du gyroscope sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le gyroscope est joignable, sinon www.yoctopuce.com...
Page 745 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 746 ) YGyro target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 747 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 748 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 749 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 750 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 751 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 752 é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 753 ): YGyro | null nextGyro( ) Si vous souhaitez retrouver un gyroscope spécifique, utilisez Gyro.findGyro() avec un hardwareID ou un nom logique. Retourne : YGyro null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 754 à rappeler, ou un pointeur nul. La fonction de callback doit accepter quatre arguments: l'objet YGyro du module qui a tourné, et les valeurs des trois angles roll, pitch et heading en degrés (nombres à virgules). www.yoctopuce.com...
Page 755 à rappeler, ou un pointeur nul. La fonction de callback doit accepter cinq arguments: l'objet YGyro du module qui a tourné, et les valeurs des quatre composantes w, x, y et z du quaternion (nombres à virgules). www.yoctopuce.com...
Page 756 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux YMeasure arguments: l'object fonction dont la valeur a changé, et un objet décrivant la nouvelle valeur publiée. www.yoctopuce.com...
Page 757 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 758 YGyro.ADVMODE_PERIOD_MIN YGyro.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 759 être préservé. saveToFlash() Paramètres : un entier représentant la fréquence de rafraîchissement de la mesure, en Hz newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 760 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 761 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 762 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du gyroscope. 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 763 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 764 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 765 être préservé. Paramètres : une valeur numérique représentant la résolution des valeurs physique mesurées newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 766 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 767 ) int startDataLogger( ) int startDataLogger( ) YGyro 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 768 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YGyro target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
Page 769 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 770 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 771: La Classe Ydatalogger
24. Référence de l'API de haut niveau 24.9. La classe YDataLogger Interface de contrôle de l'enregistreur de données, présent sur la plupart des capteurs Yoctopuce. La plupart des capteurs Yoctopuce sont équipés d'une mémoire non-volatile. Elle permet de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un ordinateur. La classe contrôle les paramètres globaux de cet enregistreur de données.
Page 772 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données. datalogger→get_friendlyName() NOM_MODULE.NOM_FONCTION Retourne un identifiant global de l'enregistreur de données au format datalogger→get_functionDescriptor() YFUN_DESCR Retourne un identifiant unique de type correspondant à la fonction. www.yoctopuce.com...
Page 773 SERIAL.FUNCTIONID datalogger→get_logicalName() Retourne le nom logique de l'enregistreur de données. datalogger→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_recording() Retourne l'état d'activation de l'enregistreur de données.
Page 774 Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData datalogger→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. datalogger→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
Page 775 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple RX420MA1.dataLogger Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
Page 776 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple RX420MA1.dataLogger Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
Page 777 YDataLogger.nextDataLogger() données. Retourne : un pointeur sur un objet YDataLogger , correspondant au premier enregistreur de données accessible null en ligne, ou si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
Page 778 YDataLogger.nextDataLogger() données. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YDataLogger , correspondant au premier enregistreur de données accessible null en ligne, ou si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
Page 779 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YDataLogger.FindDataLogger correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
Page 780 24. Référence de l'API de haut niveau YDataLogger datalogger→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
Page 781 Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() pour sauver la modification de configuration. Attention si le module n'a pas de source de temps à sa disposition au démarrage, il va attendre environ 8 sec avant de démarrer automatiquement l'enregistrement avec un horodatage arbitraire. www.yoctopuce.com...
Page 782 Vrai si l'enregistreur de données est synchronisé avec la balise de localisation. int BeaconDriven Modifiable. Modifie le mode de synchronisation de l'enregistreur de données . N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 783 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
Page 784 24. Référence de l'API de haut niveau YDataLogger datalogger→FunctionId Identifiant matériel de l'enregistreur de données, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
Page 785 24. Référence de l'API de haut niveau YDataLogger datalogger→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
Page 786 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
Page 787 24. Référence de l'API de haut niveau YDataLogger datalogger→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
Page 788 24. Référence de l'API de haut niveau YDataLogger datalogger→Recording état d'activation de l'enregistreur de données. int Recording Modifiable. www.yoctopuce.com...
Page 789 24. Référence de l'API de haut niveau YDataLogger datalogger→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
Page 790 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'enregistreur de données. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
Page 791 è 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 792 ) int forgetAllDataStreams( ) YDataLogger target forgetAllDataStreams Cette méthode remet aussi à zéro le compteur de Runs. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 793 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
Page 794 ) int get_autoStart( ) YDataLogger target get_autoStart Retourne : YDataLogger.AUTOSTART_OFF YDataLogger.AUTOSTART_ON soit , soit , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension En cas d'erreur, déclenche une exception ou retourne YDataLogger.AUTOSTART_INVALID www.yoctopuce.com...
Page 795 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.BEACONDRIVEN_INVALID www.yoctopuce.com...
Page 796 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.CURRENTRUNINDEX_INVALID www.yoctopuce.com...
Page 797 Cette méthode ne fonctionne que si le module utilise un firmware récent, car les objets YDataSet sont pas supportés par les firmwares antérieurs à la révision 13000. Retourne : YDataSet une liste d'objets En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
Page 798 Paramètres : un tableau de DataStream qui sera rempli avec les séquences trouvées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 799 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
Page 800 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
Page 801 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.FRIENDLYNAME_INVALID www.yoctopuce.com...
Page 802 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
Page 803 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'enregistreur de données (ex: En cas d'erreur, déclenche une exception ou retourne YDataLogger.FUNCTIONID_INVALID www.yoctopuce.com...
Page 804 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'enregistreur de données (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YDataLogger.HARDWAREID_INVALID www.yoctopuce.com...
Page 805 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.LOGICALNAME_INVALID www.yoctopuce.com...
Page 806 24. Référence de l'API de haut niveau YDataLogger datalogger→get_module() datalogger→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
Page 807 24. Référence de l'API de haut niveau YDataLogger datalogger→get_module_async() datalogger→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
Page 808 ): Promise<YDataLogger_Recording> async get_recording( ) int get_recording( ) int get_recording( ) YDataLogger target get_recording Retourne : YDataLogger.RECORDING_OFF YDataLogger.RECORDING_ON une valeur parmi YDataLogger.RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne YDataLogger.RECORDING_INVALID www.yoctopuce.com...
Page 809 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YDataLogger target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
Page 810 ): Promise<number> async get_timeUTC( ) long get_timeUTC( ) s64 get_timeUTC( ) YDataLogger target get_timeUTC Retourne : un entier représentant le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue En cas d'erreur, déclenche une exception ou retourne YDataLogger.TIMEUTC_INVALID www.yoctopuce.com...
Page 811 ) async get_usage( ): Promise<number> async get_usage( ) int get_usage( ) int get_usage( ) YDataLogger target get_usage Retourne : un entier représentant le pourcentage d'utilisation de la mémoire d'enregistrement En cas d'erreur, déclenche une exception ou retourne YDataLogger.USAGE_INVALID www.yoctopuce.com...
Page 812 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
Page 813 Si les valeurs des attributs en cache de l'enregistreur de données sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'enregistreur de données est joignable, sinon www.yoctopuce.com...
Page 814 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
Page 815 ) YDataLogger target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
Page 816 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 817 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
Page 818 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 819 é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 820 é c i f i q u e , u t i l i s e z DataLogger.findDataLogger() avec un hardwareID ou un nom logique. Retourne : YDataLogger null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
Page 821 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 822 , 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 823 Paramètres : newval YDataLogger.BEACONDRIVEN_OFF YDataLogger.BEACONDRIVEN_ON soit , soit selon le mode de synchronisation de l'enregistreur de données Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 824 ê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 825 Paramètres : newval une valeur parmi YDataLogger.RECORDING_OFF YDataLogger.RECORDING_ON YDataLogger.RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
Page 826 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 827 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
Page 828 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 829 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
Page 830: La Classe Ydataset
Pour utiliser les fonctions décrites ici, vous devez inclure: <script type='text/javascript' src='yocto_module.js'></script> #include "yocto_module.h" #import "yocto_module.h" uses yocto_module; yocto_module.vb yocto_module.cs import com.yoctopuce.YoctoAPI.YDataSet; java import com.yoctopuce.YoctoAPI.YDataSet; from yocto_module import * require_once('yocto_module.php'); in HTML: import { YDataSet } from '../../dist/esm/yocto_module.js'; in Node.js: import { YDataSet } from 'yoctolib-cjs/yocto_module.js';...
Page 831 Retourne l'état d'avancement du chargement des données, sur une échelle de 0 à 100. dataset→get_startTimeUTC() Retourne l'heure absolue du début des mesures disponibels, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix). dataset→get_summary() www.yoctopuce.com...
Page 832 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 833 à dire en nombre de secondes depuis le 1er endTime janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : une instance de YDataSet , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
Page 834 OBSOLÈTE: cette methode a été remplacé par get_summary() qui retoure des informations plus précises. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la dernière mesure. www.yoctopuce.com...
Page 835 String get_functionId( ) java async Task<string> get_functionId( ) get_functionId( ) function get_functionId( ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example temperature1 Retourne : temperature1 une chaîne de caractères identifiant la fonction (ex: www.yoctopuce.com...
Page 836 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example THRMCPL1-123456.temperature1 Retourne : THRMCPL1-123456.temperature1 une chaîne de caractères identifiant la fonction (ex: En cas d'erreur, déclenche une exception ou retourne YDataSet.HARDWAREID_INVALID www.yoctopuce.com...
Page 837 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 838 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 839 Retourne la valeur moyenne observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 840 Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
Page 841 Retourne la plus grande valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 842 Retourne la plus petite valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 843 Le nombre total de mesures disponible n'est connu que lorsque toutes les mesures sont chargées, c'est-à-dire quand a été appelé en boucle jusqu'à ce que l'indicateur d'avancement loadMore() retourne 100. Retourne : un nombre entier correspondant au nombre d'entrées déjà chargées. www.yoctopuce.com...
Page 844 Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la début de la mesure. www.yoctopuce.com...
Page 845 Le résumé des mesures est disponible dès que loadMore() a été appelé pour la première fois. Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
Page 846 Retourne la valeur moyenne observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 847 Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
Page 848 Retourne la plus grande valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 849 Retourne la plus petite valeur observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 850 24. Référence de l'API de haut niveau YDataSet dataset→get_previewRecordCount() dataset→previewRecordCount() Retourne le nombre d'entrées dans la version résumée des mesures qui pourront être obtenues dans ce YDataSet Retourne : un nombre entier correspondant au nombre d'entrées dans le résumé. www.yoctopuce.com...
Page 851 Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la début de la mesure. www.yoctopuce.com...
Page 852 , 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 853 à jour à la première mesure effectivement disponible dans l'enregistreur de données pour la plage spécifiée. OBSOLÈTE: cette methode a été remplacé par qui retoure des informations plus get_summary() précises. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la première mesure enregistrée. www.yoctopuce.com...
Page 854 - 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 855 24. Référence de l'API de haut niveau YDataSet dataset→get_summaryAvg() dataset→summaryAvg() Retourne la valeur moyenne observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 856 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 857 24. Référence de l'API de haut niveau YDataSet dataset→get_summaryMax() dataset→summaryMax() Retourne la plus grande valeur observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 858 24. Référence de l'API de haut niveau YDataSet dataset→get_summaryMin() dataset→summaryMin() Retourne la plus petite valeur observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 859 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 860 Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) Retourne : une chaîne de caractères représentant une unité physique. En cas d'erreur, déclenche une exception ou retourne YDataSet.UNIT_INVALID www.yoctopuce.com...
Page 861 ) 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 862 YDataSet dont la méthode loadMore_async a été appelée - le résultat de l'appel: soit l'état d'avancement du chargement (0...100), ou un code d'erreur négatif en cas de problème. variable de contexte à disposition de l'utilisateur context Retourne : rien. www.yoctopuce.com...
Page 863: La Classe Ymeasure
Valeur mesurée, retournée en particulier par les méthodes de la classe YDataSet Les objets sont utilisés dans l'interface de programmation Yoctopuce pour représenter une YMeasure valeur observée à un moment donnée. Ces objets sont utilisés en particulier en conjonction avec la classe , mais aussi par les notification périodique des capteurs configurées (voir...
Page 864 ): double function get_averageValue( ) As Double double get_averageValue( ) double get_averageValue( ) java double get_averageValue( ) get_averageValue( ) function get_averageValue( ) get_averageValue( ): number get_averageValue( ) Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
Page 865 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 866 ): double function get_maxValue( ) As Double double get_maxValue( ) double get_maxValue( ) java double get_maxValue( ) get_maxValue( ) function get_maxValue( ) get_maxValue( ): number get_maxValue( ) Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
Page 867 ): double function get_minValue( ) As Double double get_minValue( ) double get_minValue( ) java double get_minValue( ) get_minValue( ) function get_minValue( ) get_minValue( ): number get_minValue( ) Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
Page 868 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 869: Problèmes Courants
25.1. Par où commencer ? Si c'est la première fois que vous utilisez un module Yoctopuce et ne savez pas trop par où commencer, allez donc jeter un coup d'œil sur le blog de Yoctopuce. Il y a une section dédiée aux débutants 25.2.
Page 870: Plateformes Arm: Hf Et El
25.5. Module alimenté mais invisible pour l'OS Si votre Yocto-3D-V2 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 871: Déconnexions, Comportement Erratique
25. Problèmes courants 25.7. Déconnexions, comportement erratique Si votre Yocto-3D-V2 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 872 www.yoctopuce.com...
Page 873: Caractéristiques
26. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module Yocto-3D-V2 Identifiant produit Y3DMK002 † Révision matérielle Connecteur USB micro-B Largeur 20 mm Longueur 51 mm Poids Senseur BNO055 Estimation gyroscopique 100 Hz Plage de mesure (Accel.)
Page 874 La plage de température étendue est définie d'après les spécifications des composants et testée sur une durée limitée (1h). En cas d'utilisation prolongée hors de la plage de température standard, il est recommandé procéder à des tests extensifs avant la mise en production. www.yoctopuce.com...
Page 875 26. Caractéristiques www.yoctopuce.com...

Ce manuel est également adapté pour:

Yocto-3d

Yoctopuce Yocto-3D-V2 Mode D'emploi

Table des Matières

1 Introduction

2 Présentation

3 Les Fonctions du Yocto-3D-V2

4 Premiers Pas

5 Montage et Connectique

6 Programmation, Concepts Généraux

7 Utilisation du Yocto-3D-V2 en Ligne de Commande

8 Utilisation du Yocto-3D-V2 en Python

9 Utilisation du Yocto-3D-V2 en C

10 Utilisation du Yocto-3D-V2 en C

11 Utilisation du Yocto-3D-V2 Avec Labview

12 Utilisation du Yocto-3D-V2 en Java

13 Utilisation du Yocto-3D-V2 Avec Android

14 Utilisation du Yocto-3D-V2 en Typescript

15 Utilisation du Yocto-3D-V2 en Javascript / Ecmascript

16 Utilisation du Yocto-3D-V2 en PHP

17 Utilisation du Yocto-3D-V2 en Visualbasic .NET

18 Utilisation du Yocto-3D-V2 en Delphi

19 Utilisation du Yocto-3D-V2 Avec Universal Windows Platform

20 Utilisation du Yocto-3D-V2 en Objective-C

21 Utilisation Avec des Langages Non Supportés

22 Mise à Jour du Firmware

23 Programmation Avancée

24 Référence de L'api de Haut Niveau

Table des Matières

Accelerometer→Get_Friendlyname()

Accelerometer→Get_Functiondescriptor()

Accelerometer→Get_Hardwareid()

Accelerometer→Get_Highestvalue()

Accelerometer→Get_Logfrequency()

Accelerometer→Get_Logicalname()

Accelerometer→Get_Lowestvalue()

Accelerometer→Get_Module()

Accelerometer→Get_Reportfrequency()

Accelerometer→Get_Resolution()

Accelerometer→Get_Sensorstate()

Accelerometer→Get_Serialnumber()

Accelerometer→Get_Unit()

Table des Matières

Magnetometer→Bandwidth [Modifiable]

Magnetometer→Friendlyname [Lecture Seule]

Magnetometer→Functionid [Lecture Seule]

Magnetometer→Hardwareid [Lecture Seule]

Magnetometer→Isonline [Lecture Seule]

Magnetometer→Logfrequency [Modifiable]

Magnetometer→Logicalname [Modifiable]

Magnetometer→Reportfrequency [Modifiable]

Magnetometer→Resolution [Modifiable]

Magnetometer→Serialnumber [Lecture Seule]

Magnetometer→Clearcache()

Magnetometer→Describe()

Magnetometer→Get_Advertisedvalue()

Magnetometer→Get_Currentrawvalue()

Magnetometer→Get_Currentvalue()

Magnetometer→Get_Datalogger()

Magnetometer→Get_Errormessage()

Magnetometer→Get_Friendlyname()

Magnetometer→Get_Functiondescriptor()

Magnetometer→Get_Functionid()

Magnetometer→Get_Hardwareid()

Magnetometer→Get_Highestvalue()

Magnetometer→Get_Logfrequency()

Magnetometer→Get_Logicalname()

Magnetometer→Get_Lowestvalue()

Magnetometer→Get_Reportfrequency()

Magnetometer→Get_Resolution()

Magnetometer→Get_Sensorstate()

Magnetometer→Get_Serialnumber()

Magnetometer→Isonline()

25 Problèmes Courants

Liens rapides

Chapitres

Manuels Connexes pour Yoctopuce Yocto-3D-V2

Sommaire des Matières pour Yoctopuce Yocto-3D-V2