1. Manuels
  2. Marques
  3. Yoctopuce Manuels
  4. Instruments de mesure
  5. Yocto-VOC-V3
  6. Mode d'emploi

Yoctopuce Yocto-VOC-V3 Mode D'emploi

Masquer les pouces
1
2
Table Des Matières
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
Table des Matières

Publicité

Liens rapides

Télécharger ce manuel
Yocto-VOC-V3
Mode d'emploi

Publicité

Table des Matières
loading

Manuels Connexes pour Yoctopuce Yocto-VOC-V3

Sommaire des Matières pour Yoctopuce Yocto-VOC-V3

  • Page 1 Yocto-VOC-V3 Mode d'emploi...

  • Page 3: Table Des Matières

    4.1. Fixation ..........................4.2. Déporter le capteur ......................4.3. Contraintes d'alimentation par USB ................5. Programmation, concepts généraux ................ 5.1. Paradigme de programmation ..................5.2. Le module Yocto-VOC-V3 ....................5.3. Module ..........................5.4. Voc ............................5.5. Tvoc ............................ 5.6. Humidity ..........................
  • Page 4 6. Utilisation du Yocto-VOC-V3 en ligne de commande ........6.1. Installation .......................... 6.2. Utilisation: description générale ..................6.3. Contrôle de la fonction Voc ....................6.4. Contrôle de la partie module .................... 6.5. Limitations .......................... 7. Utilisation du Yocto-VOC-V3 en Python ..............
  • Page 5 14. Utilisation du Yocto-VOC-V3 en JavaScript / EcmaScript ....... 14.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ....... 14.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ......14.3. Contrôle de la fonction Voc ..................14.4. Contrôle de la partie module ..................
  • Page 6 24.5. Module alimenté mais invisible pour l'OS ..............24.6. Another process named xxx is already using yAPI ............ 24.7. Déconnexions, comportement erratique ..............24.8. RegisterHub d'un VirtualHub déconnecte le précédent ..........24.9. Commandes ignorées ....................24.10. Module endommagé ....................25. Caractéristiques ......................www.yoctopuce.com...

  • Page 7: Introduction

    Les ingénieurs Yoctopuce se sont donné beaucoup de mal pour que votre Yocto-VOC-V3 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 8: Informations De Sécurité

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

  • Page 9: Conditions Environnementales

    été déterminée en fonction des recommandations officielles des fabricants des composants utilisés dans le Yocto-VOC-V3, 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-VOC-V3 dans des conditions de température extrêmes pour une période prolongée, il est recommandé...
  • Page 10 www.yoctopuce.com...

  • Page 11: Présentation

    Tous les Yocto-modules ont un certain nombre de fonctionnalités en commun. Le connecteur USB Les modules de Yoctopuce sont tous équipés d'une connectique USB 2.0 au format micro-B. Attention, le connecteur USB est simplement soudé en surface et peut être arraché si la prise USB venait à...

  • Page 12: Le Yocto-Bouton

    COV à oxyde métallique. Le SGP30 inclut aussi une correction de le mesure par rapport à l'humidité absolue dans l'air, qui est implémentée dans le Yocto-VOC-V3 grâce au capteur d'humidité SHT35 présent sur le module.

  • Page 13: Le Capteur D'humidité Et De Température

    2. Présentation Le capteur COV du Yocto-VOC-V3 a besoin d'un petit temps de préchauffage de 15 secondes avant de fournir les première mesures. Il est prévu pour fonctioner sur toute la plage de température étendue, mais le taux d'humidité doit être entre 10% et 95%, sans condensation.

  • Page 14: Limitations

    Yoctopuce. Vis et entretoises Pour fixer le module Yocto-VOC-V3 à un support, vous pouvez placer des petites vis de 2.5mm avec une tête de 4.5mm au maximum dans les trous prévus ad-hoc. Il est conseillé de les visser dans des entretoises filetées, que vous pourrez fixer sur le support.
  • Page 15 émissions électromagnétiques indésirables. Boîtier Votre Yocto-VOC-V3 a été conçu pour pouvoir être installé tel quel dans votre projet. Néanmoins Yoctopuce commercialise des boîtiers spécialement conçus pour les modules Yoctopuce. Ces boîtiers sont munis de pattes de fixation amovibles et d'aimants de fixation. Vous trouverez plus d'informations à...
  • Page 16 www.yoctopuce.com...

  • Page 17: Premiers Pas

    Linux est fait via l'API standard de la libusb, disponible aussi pour FreeBSD par exemple. Yoctopuce teste régulièrement le bon fonctionnement des modules sur un kernel Linux 4.15 (Ubuntu 18.04 LTS).

  • Page 18: Test De La Connectivité Usb

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

  • Page 19: Localisation

    3.4. Test du module La première chose à vérifier est le bon fonctionnement de votre module: cliquez sur le numéro de série correspondant à votre module, et une fenêtre résumant les propriétés de votre Yocto-VOC-V3. Propriétés du module Yocto-VOC-V3. Cette fenêtre vous permet entre autres de jouer avec votre module pour en vérifier son fonctionnement, les valeurs de VOC y sont en effet affichées en temps réel après un temps de...

  • Page 20: Luminosité

    Nom logique des fonctions Chaque module Yoctopuce a un numéro de série, et un nom logique. De manière analogue, chaque fonction présente sur chaque module Yoctopuce a un nom matériel et un nom logique, ce dernier pouvant être librement choisi par l'utilisateur. Utiliser des noms logiques pour les fonctions permet une plus grande flexibilité...

  • Page 21: Montage Et Connectique

    Exemples de montage sur un support. Le module Yocto-VOC-V3 dispose de trous de montage 2.5mm. Vous pouvez utiliser ces trous pour y passer des vis. Le diamètre de la tête de ces vis ne devra pas dépasser 4.5mm, sous peine d'endommager les circuits du module.

  • Page 22: Déporter Le Capteur

    Cependant les sous-modules ne sont pas du tout compatibles entre modèles différents. Si vous raccordez un sous module de votre Yocto-VOC-V3 à un autre type de module, par exemple un Yocto-Meteo, cela ne marchera pas, et vous risquez fort d'endommager votre matériel.

  • Page 23: Compatibilité Électromagnétique (Emi)

    2000mA, ça ne marche pas trop mal, et cela fait rarement des dégâts. Ce que vous devez en retenir: si vous branchez des modules Yoctopuce via un ou des hubs non alimentés, vous n'aurez aucun garde-fou et dépendrez entièrement du soin qu'aura mis le fabricant de votre ordinateur pour fournir un maximum de courant sur les ports USB et signaler les excès...
  • Page 24 www.yoctopuce.com...

  • Page 25: Programmation, Concepts Généraux

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

  • Page 26: Programmation

    Programmation Dans l'API Yoctopuce, la priorité a été mise sur la facilité d'accès aux fonctionnalités des modules en offrant la possibilité de faire abstraction des modules qui les implémentent. Ainsi, il est parfaitement possible de travailler avec un ensemble de fonctionnalités sans jamais savoir exactement quel module les héberge au niveau matériel.

  • Page 27: Le Module Yocto-Voc-V3

    5.2. Le module Yocto-VOC-V3 Le module Yocto-VOC-V3 offre une instance des fonctions voc, tvoc, humidity, temperature et Datalogger correspondant respectivement au capteur de Composés Organique Volatil, au capteur de Composés Organique Volatil Total au capteur d'humidity, au capteur de température et à...
  • Page 28 Type énuméré modifiable sensorType Nombre (virgule fixe) lecture seule signalValue Texte lecture seule signalUnit Texte modifiable command dataLogger : DataLogger attribut type modifiable ? Texte modifiable logicalName Texte modifiable advertisedValue Nombre entier lecture seule currentRunIndex Heure UTC modifiable timeUTC www.yoctopuce.com...

  • Page 29: Module

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

  • Page 30: Voc

    La classe permet de lire et de configurer les capteurs de Composés Organiques Volatils YVoc Yoctopuce. Elle hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: YSensor lecture de mesures, callbacks, enregistreur de données. logicalName Chaîne de caractères contenant le nom logique du capteur de Composés Organiques Volatils, initialement vide.

  • Page 31: Tvoc

    (total) Yoctopuce. Elle hérite de la classe toutes les fonctions de base des capteurs YSensor Yoctopuce: lecture de mesures, callbacks, enregistreur de données. logicalName Chaîne de caractères contenant le nom logique du capteur de Composés Organiques Volatils (total), initialement vide. Cet attribut peut être changé au bon vouloir de l'utilisateur. Un fois initialisé à une valeur non vide, il peut servir de point de départ pour accéder à...

  • Page 32: Humidity

    Interface pour intéragir avec les capteurs d'humidité, disponibles par exemple dans le Yocto-CO2- V2, le Yocto-Meteo-V2 et le Yocto-VOC-V3 La classe permet de lire et de configurer les capteurs d'humidité Yoctopuce. Elle hérite YHumidity de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.

  • Page 33: Temperature

    Interface pour intéragir avec les capteurs de température, disponibles par exemple dans le Yocto- Meteo-V2, le Yocto-PT100, le Yocto-Temperature et le Yocto-Thermocouple La classe permet de lire et de configurer les capteurs de température Yoctopuce. YTemperature Elle hérite de la classe...
  • Page 34 Type de senseur utilisé pour réaliser la mesure de température. Le senseur peut être digital, un type de thermocouple, un type de PT100, un thermistor ou encore un capteur infrarouge signalValue Valeur actuelle du signal électrique mesuré par le capteur (sauf pour les senseurs digitaux) sous forme de nombre à virgule. www.yoctopuce.com...

  • Page 35: Datalogger

    Attribut magique permettant de configurer les paramètres physiques du capteur de température. 5.8. 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...

  • Page 36: Clearhistory

    Attribut qui peut être mis à vrai pour effacer l'historique des mesures. 5.9. Quelle interface: Native, DLL ou Service? Il y existe plusieurs méthodes pour contrôler un module USB Yoctopuce depuis un programme. Contrôle natif Dans ce cas de figure le programme pilotant votre projet est directement compilé avec une librairie qui offre le contrôle des modules.

  • Page 37: 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 38: Limitation Des Librairies Yoctopuce

    Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto- VOC-V3. Il est temps de passer à la pratique. Il vous faut télécharger la librairie Yoctopuce pour votre language de programmation favori depuis le site web de Yoctopuce .

  • Page 39: Utilisation Du Yocto-Voc-V3 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-VOC-V3, ouvrir un shell et commencer à travailler en tapant par exemple: C:\>YVoc...

  • Page 40: Contrôle De La Fonction Voc

    C:\>executable commande /help Pour obtenir une description détaillée des paramètres d'une commande. 6.3. Contrôle de la fonction Voc Pour contrôler la fonction Voc de votre Yocto-VOC-V3, vous avez besoin de l'exécutable YVoc. Vous pouvez par exemple lancer: C:\>YVoc get_currentValue Cet exemple utilise la cible "any" pour signifier que l'on désire travailler sur la première fonction Voc trouvée parmi toutes celles disponibles sur les modules Yoctopuce accessibles au moment de...

  • Page 41: Contrôle De La Partie Module

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

  • Page 43: Utilisation Du Yocto-Voc-V3 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 44: Un Exemple Réel

    7. Utilisation du Yocto-VOC-V3 en Python Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code Python qui utilise la fonction Voc. [...] # On active la détection des modules sur USB errmsg=YRefParam() YAPI.RegisterHub("usb",errmsg)

  • Page 45: Contrôle De La Partie Module

    7. Utilisation du Yocto-VOC-V3 en Python #!/usr/bin/python # -*- coding: utf-8 -*- import os, from yocto_api import from yocto_voc import usage(): scriptname = os.path.basename(sys.argv[0]) print("Usage:") print(scriptname + <serial_number>') print(scriptname + <logical_name>') print(scriptname + ' any sys.exit() die(msg): sys.exit(msg + ' (check USB...
  • Page 46 7. Utilisation du Yocto-VOC-V3 en Python = YModule.FindModule(sys.argv[1]) # # use serial or logical name m.isOnline(): if len(sys.argv) > if sys.argv[2].upper() == "ON": m.set_beacon(YModule.BEACON_ON) if sys.argv[2].upper() == "OFF": m.set_beacon(YModule.BEACON_OFF) print("serial: " m.get_serialNumber()) print("logical name: " m.get_logicalName()) print("luminosity: " str(m.get_luminosity())) if m.get_beacon() == YModule.BEACON_ON:...

  • Page 47: Enumeration Des Modules

    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 48 7. Utilisation du Yocto-VOC-V3 en Python peuvent être testées par l'appelant lorsque c'est pertinent. Le nom de la valeur de retour en cas d'erreur pour chaque fonction est systématiquement documenté dans la référence de la librairie. Il suit toujours même logique: méthode...

  • Page 49: Utilisation Du Yocto-Voc-V3 En C

    à la création d'un projet à neuf linké avec les librairies Yoctopuce. 8.1. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code C++ qui utilise la fonction Voc. #include "yocto_api.h"...
  • Page 50 Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-VOC-V3 avec le numéros de série YVOCMK03-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction voc "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter...

  • Page 51: Contrôle De La Partie Module

    8. Utilisation du Yocto-VOC-V3 en C++ Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret. #include "yocto_api.h" #include "yocto_voc.h" #include <iostream> #include <stdlib.h> using namespace std;...
  • Page 52 8. Utilisation du Yocto-VOC-V3 en C++ using namespace std; static void usage(const char *exe) cout << "usage: " << << " <serial or logical name> [ON/OFF]" << endl; exit(1); int main(int argc, const char * argv[]) string errmsg; // Setup the API to use local USB devices if(YAPI::RegisterHub("usb",...
  • Page 53 8. Utilisation du Yocto-VOC-V3 en C++ static void usage(const char *exe) cerr << "usage: " << << " <serial> <newLogicalName>" << endl; exit(1); int main(int argc, const char * argv[]) string errmsg; // Setup the API to use local USB devices if(YAPI::RegisterHub("usb",...

  • Page 54: 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 55: Intégration Au Format Source (Recommandé)

    ASCII, etc.); • Elle facilite le déboggage si vous cherchez la cause d'un problème lié à la librairie Yoctopuce • Elle réduit les dépendances sur des composants tiers, par exemple pour parer au cas où vous pourriez être mené...
  • Page 56 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 correspondant. Ensuite, pour intégrer la librairie dynamique 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 57: Utilisation Du Yocto-Voc-V3 En C

    9.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 58: Contrôle De La Fonction Voc

    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. 9.3. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code C# qui utilise la fonction Voc. [...] // On active la détection des modules sur USB...
  • Page 59 9. Utilisation du Yocto-VOC-V3 en C# = YVoc.FindVoc("YVOCMK03-123456.MaFonction"); = YVoc.FindVoc("MonModule.voc"); = YVoc.FindVoc("MonModule.MaFonction"); = YVoc.FindVoc("MaFonction"); renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler le capteur YVoc.FindVoc de Composés Organiques Volatils. isOnline La méthode de l'objet renvoyé par...

  • Page 60: Contrôle De La Partie Module

    9. Utilisation du Yocto-VOC-V3 en C# if (!vocsensor.isOnline()) { Console.WriteLine("Module not connected"); Console.WriteLine("check identification and USB cable"); Environment.Exit(0); while (vocsensor.isOnline()) { Console.WriteLine("VOC: " + vocsensor.get_currentValue().ToString() + " ppm"); Console.WriteLine(" (press Ctrl-C to exit)"); YAPI.Sleep(1000, ref errmsg); YAPI.FreeAPI(); 9.4. Contrôle de la partie module Chaque module peut-être contrôlé...
  • Page 61 9. Utilisation du Yocto-VOC-V3 en C# Console.WriteLine("OFF"); Console.WriteLine("upTime: " + (m.get_upTime() / 1000 ).ToString() + " sec"); Console.WriteLine("USB current: " + m.get_usbCurrent().ToString() + " mA"); Console.WriteLine("Logs:\r\n" + m.get_lastLogs()); } else { Console.WriteLine(args[0] + " not connected (check identification and USB cable)");...

  • Page 62: 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 63 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 64 www.yoctopuce.com...

  • Page 65: Utilisation Du Yocto-Voc-V3 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 66: 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 67 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 68: 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 69: 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 70 \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 71: Présentation Des Vis Yoctopuce

    Yoctopuce et avec tous les VIs de l'API 10.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 72: 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 73: 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 74: 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 75 10. Utilisation du Yocto-VOC-V3 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 76: 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 77: 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 78: Gestion Du Datalogger

    Connexion asynchrone 10.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 79: Énumération De Fonctions

    10. Utilisation du Yocto-VOC-V3 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 80: Un Mot Sur Les Performances

    Récupération de la liste de tous les modules connectés 10.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 81: Différences Avec Les Autres Api Yoctopuce

    Yoctopuce pour LabVIEW 10.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 82 www.yoctopuce.com...

  • Page 83: Utilisation Du Yocto-Voc-V3 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. 11.2. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code Java qui utilise la fonction Voc. [...] // On active l'accès aux modules locaux à...

  • Page 84: 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-VOC-V3 avec le numéros de série YVOCMK03-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction voc "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter...

  • Page 85: Contrôle De La Partie Module

    11. Utilisation du Yocto-VOC-V3 en Java (args.length > 0) { vocsensor = YVoc.FindVoc(args[0] + ".voc"); } else { vocsensor = YVoc.FirstVoc(); (vocsensor == null) { System.out.println("No module connected (check USB cable)"); System.exit(1); while (true) { try { System.out.println("VOC: "+vocsensor.getCurrentValue() + "...
  • Page 86 11. Utilisation du Yocto-VOC-V3 en Java System.out.println("beacon: ON"); } else { System.out.println("beacon: OFF"); System.out.println("upTime: " + module.get_upTime() / 1000 " sec"); System.out.println("USB current: " + module.get_usbCurrent() + " mA"); System.out.println("logs:\n" + module.get_lastLogs()); } catch (YAPI_Exception ex) { System.out.println(args[1] + " not connected (check identification and USB cable)");...

  • Page 87: 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 88 11. Utilisation du Yocto-VOC-V3 en Java suffire dans certains cas. Il faut toutefois être conscient qu'on ne peut pas totalement exclure une erreur se produisant après le , qui pourrait faire planter le programme. isOnline() Dans l'API java, le traitement d'erreur est implémenté au moyen d'exceptions. Vous devrez donc intercepter et traiter correctement ces exceptions si vous souhaitez avoir un projet fiable qui ne crashera pas des que vous débrancherez un module.

  • Page 89: Utilisation Du Yocto-Voc-V3 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 90: 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 91: Lancement Automatique

    12. Utilisation du Yocto-VOC-V3 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 92: Contrôle De La Fonction Voc

    12. Utilisation du Yocto-VOC-V3 avec Android 12.5. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code Java qui utilise la fonction Voc. [...] // On active la détection des modules sur USB YAPI.EnableUSBHost(this);...
  • Page 93 12. Utilisation du Yocto-VOC-V3 avec Android Un exemple réel Lancez votre environnement java et ouvrez le projet correspondant, fourni dans le répertoire Examples/Doc-Examples de la librairie Yoctopuce. Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret.

  • Page 94: Contrôle De La Partie Module

    12. Utilisation du Yocto-VOC-V3 avec Android @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long serial = parent.getItemAtPosition(pos).toString(); @Override public void onNothingSelected(AdapterView<?> arg0) final Runnable = new Runnable() public void run() (serial != null) { YVoc voc_sensor YVoc.FindVoc(serial + ".voc");...
  • Page 95 12. Utilisation du Yocto-VOC-V3 avec Android super.onStart(); try { aa.clear(); YAPI.EnableUSBHost(this); YAPI.RegisterHub("usb"); YModule = YModule.FirstModule(); while != null) { String hwid = r.get_hardwareId(); aa.add(hwid); = r.nextModule(); } catch (YAPI_Exception e) { e.printStackTrace(); // refresh Spinner with detected relay aa.notifyDataSetChanged(); @Override...
  • Page 96 12. Utilisation du Yocto-VOC-V3 avec Android if (on) { module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF); } catch (YAPI_Exception e) { e.printStackTrace(); 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 97 12. Utilisation du Yocto-VOC-V3 avec Android String hwid = r.get_hardwareId(); aa.add(hwid); = r.nextModule(); } catch (YAPI_Exception e) { e.printStackTrace(); // refresh Spinner with detected relay aa.notifyDataSetChanged(); @Override protected void onStop() super.onStop(); YAPI.FreeAPI(); private void DisplayModuleInfo() TextView field; (module == null) return;...
  • Page 98 12. Utilisation du Yocto-VOC-V3 avec Android Enumeration des modules Obtenir la liste des modules connectés se fait à l'aide de la fonction YModule.yFirstModule() qui renvoie le premier module trouvé, il suffit ensuite d'appeler la mehode de cet nextModule() objet pour trouver les modules suivants, et ce tant que la réponse n'est pas un .

  • Page 99: 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 100 www.yoctopuce.com...

  • Page 101: Utilisation Du Yocto-Voc-V3 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 102: 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 103: Contrôle De La Fonction Voc

    13.3. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code TypeScript qui utilise la fonction Voc. // 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 104: Un Exemple Concret, En Node.js

    à en faire un petit programme d'exemple concret. Si le Yocto-VOC-V3 n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où est branché le 127.0.0.1...
  • Page 105 13. Utilisation du Yocto-VOC-V3 en TypeScript let voc: YVoc; async function startDemo(): Promise<void> await YAPI.LogUnhandledPromiseRejections(); // Setup the API to use the VirtualHub on local machine let errmsg: YErrorMsg = new YErrorMsg(); if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) { console.log('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg);...

  • Page 106: 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-VOC-V3. Vous y trouverez un fichier html , et un fichier TypeScript similaire au code ci-dessus, mais avec app.html...
  • Page 107 13. Utilisation du Yocto-VOC-V3 en TypeScript console.log('USB current: '+await module.get_usbCurrent()+' mA'); console.log('logs:'); console.log(await module.get_lastLogs()); } else { console.log("Module not connected (check identification and USB cable)\n"); await YAPI.FreeAPI(); if(process.argv.length < 3) { console.log("usage: npm run demo <serial or logicalname> [ ON | OFF ]");...

  • Page 108: 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 109 13. Utilisation du Yocto-VOC-V3 en TypeScript Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: • Si votre code attrape l'exception au vol et la gère, et tout se passe bien.
  • Page 110 www.yoctopuce.com...

  • Page 111: Utilisation Du Yocto-Voc-V3 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 112: Fonctions Bloquantes Et Fonctions Asynchrones En Javascript

    14. Utilisation du Yocto-VOC-V3 en JavaScript / EcmaScript 14.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 113: 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 114: Compatibilité Avec L'ancienne Librairie Javascript

    14. Utilisation du Yocto-VOC-V3 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 115: Contrôle De La Fonction Voc

    Ce dernier appel asynchrone peut aussi être formulé comme: myModule.get_syncProxy().then(logInfoProxy); 14.3. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction Voc. // En Node.js, on utilise la fonction require() // En HTML, on utiliserait &lt;script src="..."&gt;...
  • Page 116 à en faire un petit programme d'exemple concret. Si le Yocto-VOC-V3 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 117 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-VOC-V3. 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 118: Contrôle De La Partie Module

    14. Utilisation du Yocto-VOC-V3 en JavaScript / EcmaScript document.getElementById("voc").value = (await voc.get_currentValue()) + ' ppm'; } else { document.getElementById('msg').value = 'Module not connected'; setTimeout(refresh, 500); startDemo(); </script> </head> <body> Module to use: <input id='serial'> <input id='msg' style='color:red;border:none;' readonly><br> VOC : <input...
  • Page 119 14. Utilisation du Yocto-VOC-V3 en JavaScript / EcmaScript 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 120: 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 121 à l'exception. • Sinon... l'exception va crasher votre programme, boum! Comme cette dernière situation n'est pas la plus souhaitable, la librairie Yoctopuce offre une autre alternative pour la gestion des erreurs, permettant de faire un programme robuste sans devoir...
  • Page 122 www.yoctopuce.com...

  • Page 123: Utilisation Du Yocto-Voc-V3 En Php

    Vous n'avez pas besoin d'installer de driver. 15.2. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code PHP qui utilise la fonction Voc. include('yocto_api.php');...
  • Page 124 Yoctopuce. doit toujours être inclus, est nécessaire pour gérer yocto_api.php yocto_voc.php les modules contenant un capteur de Composés Organiques Volatils, comme le Yocto-VOC-V3. 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...

  • Page 125: Un Exemple Réel

    15. Utilisation du Yocto-VOC-V3 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 126 15. Utilisation du Yocto-VOC-V3 en PHP <FORM method='get'> <?php include('yocto_api.php'); // Use explicit error handling rather than exceptions YAPI::DisableExceptions(); // Setup the API to use the VirtualHub on local machine if(YAPI::RegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI::SUCCESS) { die("Cannot contact VirtualHub on 127.0.0.1 : ".$errmsg);...
  • Page 127 15. Utilisation du Yocto-VOC-V3 en PHP méthode . Ce petit exemple ci-dessous vous permet changer le nom logique revertFromFlash() d'un module. <HTML> <HEAD> <TITLE>save settings</TITLE> <BODY> <FORM method='get'> <?php include('yocto_api.php'); // Use explicit error handling rather than exceptions YAPI::DisableExceptions(); // Setup the API to use the VirtualHub on local machine if(YAPI::RegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI::SUCCESS) {...

  • Page 128: 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 129 15. Utilisation du Yocto-VOC-V3 en PHP Les réponses aux requêtes venant des machines du LAN sont routées. Mais les requêtes venant de l'extérieur sont bloquées. Voir Internet sans être vu représente un avantage de sécurité énorme. Cependant, cela signifie qu'a priori, on ne peut pas simplement monter son propre serveur Web publique chez soi pour une installation domotique et offrir un accès depuis l'extérieur.
  • Page 130 15. Utilisation du Yocto-VOC-V3 en PHP Configuration L'API callback se sert donc du Virtual Hub comme passerelle. Toutes les communications sont initiées par le Virtual Hub, ce sont donc des communication sortantes, et par conséquent parfaitement autorisée par le routeur DSL.

  • Page 131: Gestion Des Erreurs

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

  • Page 133: Utilisation Du Yocto-Voc-V3 En Visualbasic .Net

    16.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 134: Contrôle De La Fonction Voc

    16.3. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction Voc. [...] ' On active la détection des modules sur USB...
  • Page 135 16. Utilisation du Yocto-VOC-V3 en VisualBasic .NET = YVoc.FindVoc("MaFonction") renvoie un objet que vous pouvez ensuite utiliser à loisir pour contrôler le capteur YVoc.FindVoc de Composés Organiques Volatils. isOnline La méthode de l'objet renvoyé par permet de savoir si le module isOnline() YVoc.FindVoc...

  • Page 136: Contrôle De La Partie Module

    16. Utilisation du Yocto-VOC-V3 en VisualBasic .NET YAPI.FreeAPI() End Sub End Module 16.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.
  • Page 137 16. Utilisation du Yocto-VOC-V3 en VisualBasic .NET de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration courante dans sa mémoire non volatile. Pour cela il faut utiliser la méthode saveToFlash() Inversement il est possible de forcer le module à oublier ses réglages courants en utilisant la méthode...

  • Page 138: 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 139: Utilisation Du Yocto-Voc-V3 En Delphi

    17.2. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code Delphi qui utilise la fonction Voc.
  • Page 140 [...] Voyons maintenant en détail ce que font ces quelques lignes. yocto_api et yocto_voc 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 contenant yocto_api yocto_voc un capteur de Composés Organiques Volatils, comme le Yocto-VOC-V3.

  • Page 141: Contrôle De La Partie Module

    17. Utilisation du Yocto-VOC-V3 en Delphi 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. program helloworld; {$APPTYPE CONSOLE} uses SysUtils, Windows, yocto_api, yocto_voc;...
  • Page 142 17. Utilisation du Yocto-VOC-V3 en Delphi program modulecontrol; {$APPTYPE CONSOLE} uses SysUtils, yocto_api; const serial = 'YVOCMK03-123456'; // use serial number or logical name procedure refresh(module:Tymodule) begin if (module.isOnline()) then begin Writeln(''); Writeln('Serial + module.get_serialNumber()); Writeln('Logical name : ' + module.get_logicalName());...
  • Page 143 17. Utilisation du Yocto-VOC-V3 en Delphi Inversement il est possible de forcer le module à oublier ses réglages courants en utilisant la méthode . Ce petit exemple ci-dessous vous permet changer le nom logique revertFromFlash() d'un module. program savesettings; {$APPTYPE CONSOLE}...

  • Page 144: 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 145 17. Utilisation du Yocto-VOC-V3 en Delphi méthodes . Ce sont les même informations qui auraient été errType() errMessage() associées à l'exception si elles avaient été actives. www.yoctopuce.com...
  • Page 146 www.yoctopuce.com...

  • Page 147: Utilisation Du Yocto-Voc-V3 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 148: Installation

    18.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 149: Contrôle De La Fonction Voc

    18.4. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code c# qui utilise la fonction Voc.

  • Page 150: 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 151: Contrôle De La Partie Module

    18. Utilisation du Yocto-VOC-V3 avec Universal Windows Platform 18.6. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci-dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
  • Page 152 18. Utilisation du Yocto-VOC-V3 avec Universal Windows Platform mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration courante dans sa mémoire non volatile. Pour cela il faut utiliser la méthode . Inversement il est possible de forcer le module à oublier ses réglages YModule.saveToFlash()

  • Page 153: 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 154 www.yoctopuce.com...

  • Page 155: Utilisation Du Yocto-Voc-V3 En Objective-C

    à vos projets. 19.1. Contrôle de la fonction Voc Il suffit de quelques lignes de code pour piloter un Yocto-VOC-V3. Voici le squelette d'un fragment de code Objective-C qui utilise la fonction Voc. #import "yocto_api.h"...
  • Page 156 Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-VOC-V3 avec le numéros de série YVOCMK03-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction voc "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour éviter...

  • Page 157: Contrôle De La Partie Module

    19. Utilisation du Yocto-VOC-V3 en Objective-C NSLog(@"usage: demo <serial_number> "); NSLog(@" demo <logical_name>"); NSLog(@" demo any (use any discovered device)"); exit(1); int main(int argc, const char * argv[]) NSError *error; (argc < 2) { usage(); @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) {...
  • Page 158 19. Utilisation du Yocto-VOC-V3 en Objective-C if(argc < usage(argv[0]); NSString *serial_or_name [NSString stringWithUTF8String:argv[1]]; // use serial or logical name YModule *module [YModule FindModule:serial_or_name]; ([module isOnline]) { (argc > 2) { (strcmp(argv[2], "ON") == 0) [module setBeacon:Y_BEACON_ON]; else [module setBeacon:Y_BEACON_OFF]; NSLog(@"serial: %@\n", [module serialNumber]);...

  • Page 159: Gestion Des Erreurs

    Il y aura forcément une occasion où un utilisateur aura débranché le périphérique, soit avant de lancer le programme, soit même en pleine opération. La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais www.yoctopuce.com...
  • Page 160 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 161: 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 162: Exemple D'utilisation Avec Matlab

    20. 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 163: 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 164: 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-VOC-V3 avec le numéro de de série YVOCMK03-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.

  • Page 165: Accès Aux Données Enregistrées Sur Le Datalogger Par L'interface Rest

    20.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 166 (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 167: Inventaire Des Modules

    20. 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 168: 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 169: 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 170: 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 171 Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).

  • Page 172: L'enregistreur De Données

    Prog-EventBased. 21.2. L'enregistreur de données Votre Yocto-VOC-V3 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 173: 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-VOC-V3, 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 174 Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-VOC-V3 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-VOC-V3 va automatiquement essayer de se mettre à...

  • Page 175: Calibration Des Senseurs

    L'API Yoctopuce offre le moyen de re-calibrer les valeurs mesurées par votre Yocto-VOC-V3. Il ne n'agit pas de modifier les réglages hardware du module, mais plutôt d'effectuer une transformation a posteriori des mesures effectuées par le capteur.
  • Page 176 Correction de 3 à 5 points Les corrections de 3 à 5 points ne sont qu'une généralisation de la méthode à deux points, permettant de ainsi de créer jusqu' 4 intervalles de correction pour plus de précision. Ces intervalles ne peuvent pas être disjoints. www.yoctopuce.com...

  • Page 177: Interpolation Arbitraire

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

  • Page 179: 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 180: 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 181: 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 182: 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 183: Référence De L'api De Haut Niveau

    23. 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-VOC-V3. 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 184: 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 185 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 186 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 187 . 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 188 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 189 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 190 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 191 (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 192 23. 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 193 23. 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 194 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 195 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 196 . 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 197 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 198 23. 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 199 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 200 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 201 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 202 23. 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 203 "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 204 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 205 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 206 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 207 "usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 208 , 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 209 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 210 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 211 à 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 212 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 213 (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 214 à 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 215 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 216 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 217 ê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 218 ê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 219 à 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 220 é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 221 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 222 23. 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 223 23. 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 224 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 225: La Classe Ymodule

    23.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 226 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 227 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 228 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 229 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 230 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 231 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 232 23. 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 233 23. Référence de l'API de haut niveau YModule module→FirmwareRelease Version du logiciel embarqué du module. string FirmwareRelease www.yoctopuce.com...
  • Page 234 23. 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 235 23. 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 236 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 237 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 238 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 239 23. 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 240 23. 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 241 23. 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 242 23. 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 243 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 244 ) 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 245 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 246 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 247 à 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 248 ) 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 249 à 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 250 à 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 251 à 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 252 à 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 253 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 254 ): 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 255 ) 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 256 ) 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 257 ' 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 258 $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 259 ) 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 260 ) 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 261 ) 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 262 ) 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 263 ): 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 264 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 265 ' 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 266 ) 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 267 ): 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 268 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 269 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...
  • Page 270 ): 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 271 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 272: 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 273 ): 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 274 ): 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 275 ) 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 276 ) 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 277 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 278 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 279 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 280 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 281 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 282 ê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 283 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 284 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 285 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 286: 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 287 $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 288 ) 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 289 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 290 ê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 291 ê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 292 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 293 ê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 294 ê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 295 $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 296 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 297 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 298 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 299 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 300 à 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 301 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 302: La Classe Yvoc

    Composés Organiques Volatils YVoc Yoctopuce. Elle hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: YSensor lecture de mesures, callbacks, enregistreur de données. Pour utiliser les fonctions décrites ici, vous devez inclure: in HTML: <script src="../../lib/yocto_voc.js"></script>...
  • Page 303 Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du capteur de Composés Organiques Volatils. voc→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du capteur de Composés Organiques Volatils. voc→get_friendlyName() Retourne un identifiant global du capteur de Composés Organiques Volatils au format NOM_MODULE.NOM_FONCTION voc→get_functionDescriptor() www.yoctopuce.com...
  • Page 304 Retourne la valeur minimale observée pour le taux de VOC estimé depuis le démarrage du module. voc→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. voc→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
  • Page 305 Arrête l'enregistreur de données du module. voc→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. voc→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 306 Paramètres : func une chaîne de caractères qui référence le capteur de Composés Organiques Volatils sans ambiguïté, par exemple YVOCMK03.voc Retourne : YVoc un objet de classe qui permet ensuite de contrôler le capteur de Composés Organiques Volatils. www.yoctopuce.com...
  • Page 307 YAPI func une chaîne de caractères qui référence le capteur de Composés Organiques Volatils sans ambiguïté, par exemple YVOCMK03.voc Retourne : YVoc un objet de classe qui permet ensuite de contrôler le capteur de Composés Organiques Volatils. www.yoctopuce.com...
  • Page 308 Composés Organiques YVoc.nextVoc() Volatils. Retourne : un pointeur sur un objet YVoc , correspondant au premier capteur de Composés Organiques Volatils null accessible en ligne, ou si il n'y a pas de capteurs de Composés Organiques Volatils disponibles. www.yoctopuce.com...
  • Page 309 Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YVoc , correspondant au premier capteur de Composés Organiques Volatils null accessible en ligne, ou si il n'y a pas de capteurs de Composés Organiques Volatils disponibles. www.yoctopuce.com...
  • Page 310 Chaque chaîne retournée peut être passée en argument à la méthode pour obtenir YVoc.FindVoc 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 311 23. Référence de l'API de haut niveau YVoc voc→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 312 23. Référence de l'API de haut niveau YVoc voc→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 313 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 314 23. Référence de l'API de haut niveau YVoc voc→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 315 23. Référence de l'API de haut niveau YVoc voc→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 316 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 317 "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 318 23. Référence de l'API de haut niveau YVoc voc→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 319 "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 320 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 321 23. Référence de l'API de haut niveau YVoc voc→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 322 ê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 323 ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du capteur de Composés Organiques Volatils. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 324 Cette Relay(BadCustomeName.relay1)=unresolved methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur. Retourne : une chaîne de caractères décrivant le capteur de Composés Organiques Volatils (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 325 ) int get_advMode( ) YVoc target get_advMode Retourne : YVoc.ADVMODE_IMMEDIATE YVoc.ADVMODE_PERIOD_AVG valeur parmi YVoc.ADVMODE_PERIOD_MIN YVoc.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 YVoc.ADVMODE_INVALID www.yoctopuce.com...
  • Page 326 ) string get_advertisedValue( ) YVoc target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur de Composés Organiques Volatils (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YVoc.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 327 ) YVoc target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en ppm (vol), sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YVoc.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 328 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 329 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 330 ) 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 capteur de Composés Organiques Volatils.
  • Page 331 ) 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 capteur de Composés Organiques Volatils.
  • Page 332 Volatils si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel du capteur de Composés Organiques Volatils (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur de Composés Organiques Volatils en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YVoc.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 333 é 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 334 ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le capteur de Composés Organiques Volatils (ex: En cas d'erreur, déclenche une exception ou retourne YVoc.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 335 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de Composés Organiques Volatils (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le capteur de Composés Organiques Volatils (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YVoc.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 336 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 taux de VOC estimé depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YVoc.HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 337 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 YVoc.LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 338 ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YVoc target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur de Composés Organiques Volatils. En cas d'erreur, déclenche une exception ou retourne YVoc.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 339 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 taux de VOC estimé depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YVoc.LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 340 23. Référence de l'API de haut niveau YVoc voc→get_module() voc→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 341 23. Référence de l'API de haut niveau YVoc voc→get_module_async() voc→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 342 à 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 343 ) YVoc 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 YVoc.REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 344 à 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 YVoc.RESOLUTION_INVALID www.yoctopuce.com...
  • Page 345 En cas d'erreur, déclenche une exception ou retourne YVoc.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 346 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YVoc 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 347 ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YVoc target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle le taux de VOC estimé est exprimée En cas d'erreur, déclenche une exception ou retourne YVoc.UNIT_INVALID www.yoctopuce.com...
  • Page 348 ) 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 349 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 de Composés Organiques Volatils est joignable, sinon www.yoctopuce.com...
  • Page 350 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 351 ) YVoc 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 352 Retourne faux si le module n'est pas joignable, ou que le capteur n'a pas de mesure actuelle à communiquer. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur dispose d'une mesure actuelle, sinon www.yoctopuce.com...
  • Page 353 Paramètres : 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 354 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 355 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 356 YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 357 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 358 ) Si vous souhaitez retrouver un capteur de Composés Organiques Volatils spécifique, utilisez Voc.findVoc() avec un hardwareID ou un nom logique. Retourne : YVoc null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 359 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux YMeasure arguments: l'object fonction dont la valeur a changé, et un objet décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 360 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 361 YVoc.ADVMODE_PERIOD_MIN YVoc.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 362 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur maximale observée Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 363 ê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 364 Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de Composés Organiques Volatils. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 365 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : newval une valeur numérique représentant la mémoire de valeur minimale observée Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 366 ê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 367 ê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 368 $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 369 ) int startDataLogger( ) int startDataLogger( ) YVoc target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 370 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YVoc target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 371 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 372 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 373: La Classe Ytvoc

    Composés Organiques Volatils (total) YTvoc Yoctopuce. Elle hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: YSensor lecture de mesures, callbacks, enregistreur de données. Pour utiliser les fonctions décrites ici, vous devez inclure: in HTML: <script src="../../lib/yocto_tvoc.js"></script>...
  • Page 374 Composés Organiques Volatils (total). tvoc→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du capteur de Composés Organiques Volatils (total). tvoc→get_friendlyName() Retourne un identifiant global du capteur de Composés Organiques Volatils (total) au format NOM_MODULE.NOM_FONCTION tvoc→get_functionDescriptor() www.yoctopuce.com...
  • Page 375 Retourne la valeur minimale observée pour le taux de TVOC estimé depuis le démarrage du module. tvoc→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. tvoc→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
  • Page 376 Arrête l'enregistreur de données du module. tvoc→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. tvoc→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 377 Paramètres : func une chaîne de caractères qui référence le capteur de Composés Organiques Volatils (total) sans ambiguïté, par exemple YVOCMK03.tvoc Retourne : YTvoc un objet de classe qui permet ensuite de contrôler le capteur de Composés Organiques Volatils (total). www.yoctopuce.com...
  • Page 378 YAPI func une chaîne de caractères qui référence le capteur de Composés Organiques Volatils (total) sans ambiguïté, par exemple YVOCMK03.tvoc Retourne : YTvoc un objet de classe qui permet ensuite de contrôler le capteur de Composés Organiques Volatils (total). www.yoctopuce.com...
  • Page 379 YTvoc.nextTvoc() Volatils (total). Retourne : un pointeur sur un objet YTvoc , correspondant au premier capteur de Composés Organiques Volatils null (total) accessible en ligne, ou si il n'y a pas de capteurs de Composés Organiques Volatils (total) disponibles. www.yoctopuce.com...
  • Page 380 YAPI. Retourne : un pointeur sur un objet YTvoc , correspondant au premier capteur de Composés Organiques Volatils null (total) accessible en ligne, ou si il n'y a pas de capteurs de Composés Organiques Volatils (total) disponibles. www.yoctopuce.com...
  • Page 381 Chaque chaîne retournée peut être passée en argument à la méthode pour YTvoc.FindTvoc 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 382 23. Référence de l'API de haut niveau YTvoc tvoc→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 383 23. Référence de l'API de haut niveau YTvoc tvoc→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 384 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 385 23. Référence de l'API de haut niveau YTvoc tvoc→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 386 23. Référence de l'API de haut niveau YTvoc tvoc→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 387 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 388 "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 389 23. Référence de l'API de haut niveau YTvoc tvoc→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 390 "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 391 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 392 23. Référence de l'API de haut niveau YTvoc tvoc→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 393 ê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 394 ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du capteur de Composés Organiques Volatils (total). Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 395 Cette Relay(BadCustomeName.relay1)=unresolved methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur. Retourne : une chaîne de caractères décrivant le capteur de Composés Organiques Volatils (total) (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 396 ) int get_advMode( ) YTvoc target get_advMode Retourne : YTvoc.ADVMODE_IMMEDIATE YTvoc.ADVMODE_PERIOD_AVG une valeur parmi YTvoc.ADVMODE_PERIOD_MIN YTvoc.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 YTvoc.ADVMODE_INVALID www.yoctopuce.com...
  • Page 397 ) string get_advertisedValue( ) YTvoc target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur de Composés Organiques Volatils (total) (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YTvoc.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 398 ) YTvoc target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en ppb, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne YTvoc.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 399 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 400 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 401 ) 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 capteur de Composés Organiques Volatils (total).
  • Page 402 ) 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 capteur de Composés Organiques Volatils (total).
  • Page 403 : MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur de Composés Organiques Volatils (total) en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YTvoc.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 404 é 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 405 ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le capteur de Composés Organiques Volatils (total) (ex: En cas d'erreur, déclenche une exception ou retourne YTvoc.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 406 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de Composés Organiques Volatils (total) (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le capteur de Composés Organiques Volatils (total) (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YTvoc.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 407 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 taux de TVOC estimé depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YTvoc.HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 408 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 YTvoc.LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 409 ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YTvoc target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur de Composés Organiques Volatils (total). En cas d'erreur, déclenche une exception ou retourne YTvoc.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 410 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 taux de TVOC estimé depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YTvoc.LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 411 23. Référence de l'API de haut niveau YTvoc tvoc→get_module() tvoc→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 412 23. Référence de l'API de haut niveau YTvoc tvoc→get_module_async() tvoc→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 413 à 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 414 ) YTvoc 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 YTvoc.REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 415 à 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 YTvoc.RESOLUTION_INVALID www.yoctopuce.com...
  • Page 416 En cas d'erreur, déclenche une exception ou retourne YTvoc.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 417 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YTvoc 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 418 ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YTvoc target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle le taux de TVOC estimé est exprimée En cas d'erreur, déclenche une exception ou retourne YTvoc.UNIT_INVALID www.yoctopuce.com...
  • Page 419 ) 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 420 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 de Composés Organiques Volatils (total) est joignable, sinon www.yoctopuce.com...
  • Page 421 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 422 ) YTvoc 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 423 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 424 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 425 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 426 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 427 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 428 é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 429 ) Si vous souhaitez retrouver un capteur de Composés Organiques Volatils (total) spécifique, utilisez Tvoc.findTvoc() avec un hardwareID ou un nom logique. Retourne : YTvoc null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 430 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 431 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 432 YTvoc.ADVMODE_PERIOD_MIN YTvoc.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 433 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 434 ê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 435 Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de Composés Organiques Volatils (total). 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 436 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 437 ê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 438 ê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 439 $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 440 ) int startDataLogger( ) int startDataLogger( ) YTvoc 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 441 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YTvoc target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 442 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 443 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 444: La Classe Yhumidity

    Interface pour intéragir avec les capteurs d'humidité, disponibles par exemple dans le Yocto-CO2-V2, le Yocto-Meteo-V2 et le Yocto-VOC-V3 La classe permet de lire et de configurer les capteurs d'humidité Yoctopuce. Elle hérite de YHumidity la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.
  • Page 445 Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du capteur d'humidité. humidity→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du capteur d'humidité. humidity→get_friendlyName() NOM_MODULE.NOM_FONCTION Retourne un identifiant global du capteur d'humidité au format www.yoctopuce.com...
  • Page 446 Retourne la valeur minimale observée pour l'humidité depuis le démarrage du module. humidity→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. humidity→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. humidity→get_recordedData(startTime, endTime)
  • Page 447 Arrête l'enregistreur de données du module. humidity→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. humidity→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 448 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur d'humidité sans ambiguïté, par exemple YCO2MK02.humidity Retourne : YHumidity un objet de classe qui permet ensuite de contrôler le capteur d'humidité. www.yoctopuce.com...
  • Page 449 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le capteur d'humidité sans ambiguïté, par exemple YCO2MK02.humidity Retourne : YHumidity un objet de classe qui permet ensuite de contrôler le capteur d'humidité. www.yoctopuce.com...
  • Page 450 Utiliser la fonction pour itérer sur les autres capteurs d'humidité. YHumidity.nextHumidity() Retourne : un pointeur sur un objet YHumidity , correspondant au premier capteur d'humidité accessible en ligne, ou null si il n'y a pas de capteurs d'humidité disponibles. www.yoctopuce.com...
  • Page 451 YHumidity.nextHumidity() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YHumidity , correspondant au premier capteur d'humidité accessible en ligne, ou null si il n'y a pas de capteurs d'humidité disponibles. www.yoctopuce.com...
  • Page 452 Chaque chaîne retournée peut être passée en argument à la méthode YHumidity.FindHumidity 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 453 23. Référence de l'API de haut niveau YHumidity humidity→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 454 23. Référence de l'API de haut niveau YHumidity humidity→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 455 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 456 23. Référence de l'API de haut niveau YHumidity humidity→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 457 23. Référence de l'API de haut niveau YHumidity humidity→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 458 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 459 "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 460 23. Référence de l'API de haut niveau YHumidity humidity→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 461 "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 462 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 463 23. Référence de l'API de haut niveau YHumidity humidity→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 464 ê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 465 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du capteur d'humidité. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 466 è r e s d é c r i v a n t c a p t e u r d ' h u m i d i t é ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 467 ) double get_absHum( ) double get_absHum( ) YHumidity target get_absHum Retourne : une valeur numérique représentant la valeur actuelle de l'humidité absolue, en gramme par mètre cube d'air En cas d'erreur, déclenche une exception ou retourne YHumidity.ABSHUM_INVALID www.yoctopuce.com...
  • Page 468 ) int get_advMode( ) YHumidity target get_advMode Retourne : YHumidity.ADVMODE_IMMEDIATE YHumidity.ADVMODE_PERIOD_AVG une valeur parmi YHumidity.ADVMODE_PERIOD_MIN YHumidity.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 YHumidity.ADVMODE_INVALID www.yoctopuce.com...
  • Page 469 ' 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 YHumidity.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 470 ' 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 YHumidity.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 471 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 472 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 473 ) 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 capteur d'humidité.
  • Page 474 ) 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 capteur d'humidité.
  • Page 475 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur d'humidité en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YHumidity.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 476 é 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 477 ) 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 capteur d'humidité (ex: En cas d'erreur, déclenche une exception ou retourne YHumidity.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 478 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur d'humidité (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le capteur d'humidité (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YHumidity.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 479 YHumidity target get_highestValue Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour l'humidité depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YHumidity.HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 480 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 YHumidity.LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 481 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YHumidity target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur d'humidité. En cas d'erreur, déclenche une exception ou retourne YHumidity.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 482 YHumidity target get_lowestValue Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour l'humidité depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne YHumidity.LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 483 23. Référence de l'API de haut niveau YHumidity humidity→get_module() humidity→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 484 23. Référence de l'API de haut niveau YHumidity humidity→get_module_async() humidity→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 485 à 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 486 ): Promise<number> async get_relHum( ) double get_relHum( ) double get_relHum( ) YHumidity target get_relHum Retourne : une valeur numérique représentant la valeur actuelle de l'humidité relative, en pour cent En cas d'erreur, déclenche une exception ou retourne YHumidity.RELHUM_INVALID www.yoctopuce.com...
  • Page 487 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YHumidity.REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 488 à 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 YHumidity.RESOLUTION_INVALID www.yoctopuce.com...
  • Page 489 En cas d'erreur, déclenche une exception ou retourne YHumidity.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 490 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YHumidity 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 491 ) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YHumidity target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle l'humidité est exprimée En cas d'erreur, déclenche une exception ou retourne YHumidity.UNIT_INVALID www.yoctopuce.com...
  • Page 492 ) 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 493 Si les valeurs des attributs en cache du capteur d'humidité sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur d'humidité est joignable, sinon www.yoctopuce.com...
  • Page 494 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 495 ) YHumidity 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 496 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 497 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 498 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 499 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 500 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 501 é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 502 ): YHumidity | null nextHumidity( ) Si vous souhaitez retrouver un capteur d'humidité spécifique, utilisez Humidity.findHumidity() avec un hardwareID ou un nom logique. Retourne : YHumidity null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 503 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 504 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 505 YHumidity.ADVMODE_PERIOD_AVG YHumidity.ADVMODE_PERIOD_MIN YHumidity.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 506 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 507 ê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 508 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur d'humidité. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 509 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 510 ê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 511 ê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 512 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant l'unité principale dans laquelle l'humidité est exprimé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 513 $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 514 ) int startDataLogger( ) int startDataLogger( ) YHumidity target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 515 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YHumidity target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 516 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 517 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 518: La Classe Ytemperature

    Interface pour intéragir avec les capteurs de température, disponibles par exemple dans le Yocto- Meteo-V2, le Yocto-PT100, le Yocto-Temperature et le Yocto-Thermocouple La classe permet de lire et de configurer les capteurs de température Yoctopuce. Elle YTemperature hérite de la classe...
  • Page 519 Retourne la valeur actuelle de la température, en degrés Celsius, sous forme de nombre à virgule. temperature→get_dataLogger() YDatalogger Retourne l'objet du module qui héberge le senseur. temperature→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du capteur de température. temperature→get_errorType() www.yoctopuce.com...
  • Page 520 Retourne la valeur minimale observée pour la température depuis le démarrage du module. temperature→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. temperature→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. temperature→get_recordedData(startTime, endTime)
  • Page 521 Modifie la mémoire de valeur minimale observée. temperature→set_ntcParameters(res25, beta) Configure les paramètres d'un thermistor NTC pour calculer correctement la température sur la base de la résistance mesurée. temperature→set_reportFrequency(newval) Modifie la fréquence de notification périodique des valeurs mesurées. temperature→set_resolution(newval) www.yoctopuce.com...
  • Page 522 Arrête l'enregistreur de données du module. temperature→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. temperature→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 523 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur de température sans ambiguïté, par exemple METEOMK2.temperature Retourne : YTemperature un objet de classe qui permet ensuite de contrôler le capteur de température. www.yoctopuce.com...
  • Page 524 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le capteur de température sans ambiguïté, par exemple METEOMK2.temperature Retourne : YTemperature un objet de classe qui permet ensuite de contrôler le capteur de température. www.yoctopuce.com...
  • Page 525 YTemperature.nextTemperature() température. Retourne : un pointeur sur un objet YTemperature , correspondant au premier capteur de température accessible null en ligne, ou si il n'y a pas de capteurs de température disponibles. www.yoctopuce.com...
  • Page 526 YTemperature.nextTemperature() température. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YTemperature , correspondant au premier capteur de température accessible null en ligne, ou si il n'y a pas de capteurs de température disponibles. www.yoctopuce.com...
  • Page 527 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YTemperature.FindTemperature 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 528 23. Référence de l'API de haut niveau YTemperature temperature→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 529 23. Référence de l'API de haut niveau YTemperature temperature→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 530 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 531 23. Référence de l'API de haut niveau YTemperature temperature→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 532 23. Référence de l'API de haut niveau YTemperature temperature→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 533 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 534 "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 535 23. Référence de l'API de haut niveau YTemperature temperature→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 536 "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 537 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 538 Modifie le type de senseur utilisé par le module. Cette function sert à spécifier le type de thermocouple (K,E, etc..) raccordé au module. Cette fonction n'aura pas d'effet si le module utilise un capteur digital ou un thermistor. N'oubliez pas d'appeler la méthode du module si le réglage doit saveToFlash() être préservé. www.yoctopuce.com...
  • Page 539 23. Référence de l'API de haut niveau YTemperature temperature→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 540 23. Référence de l'API de haut niveau YTemperature temperature→SignalUnit Unité du signal électrique utilisé par le capteur. string SignalUnit www.yoctopuce.com...
  • Page 541 ê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 542 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du capteur de température. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 543 è r e s d é c r i v a n t c a p t e u r t e m p é r a t u r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 544 YTemperature.ADVMODE_PERIOD_AVG YTemperature.ADVMODE_PERIOD_MIN YTemperature.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 YTemperature.ADVMODE_INVALID www.yoctopuce.com...
  • Page 545 ' 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 YTemperature.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 546 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YTemperature.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 547 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 548 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 549 ) 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 capteur de température.
  • Page 550 ) 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 capteur de température.
  • Page 551 ' 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 YTemperature.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 552 é 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 553 ' 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 YTemperature.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 554 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YTemperature.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 555 ' 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 YTemperature.HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 556 ' 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 YTemperature.LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 557 ' 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 YTemperature.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 558 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YTemperature.LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 559 23. Référence de l'API de haut niveau YTemperature temperature→get_module() temperature→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 560 23. Référence de l'API de haut niveau YTemperature temperature→get_module_async() temperature→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 561 à 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 562 ' 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 YTemperature.REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 563 ' 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 YTemperature.RESOLUTION_INVALID www.yoctopuce.com...
  • Page 564 ' 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 YTemperature.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 565 ' 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 YTemperature.SENSORTYPE_INVALID www.yoctopuce.com...
  • Page 566 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YTemperature 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 567 ' 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 YTemperature.SIGNALUNIT_INVALID www.yoctopuce.com...
  • Page 568 ' 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 YTemperature.SIGNALVALUE_INVALID www.yoctopuce.com...
  • Page 569 ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YTemperature target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la température est exprimée En cas d'erreur, déclenche une exception ou retourne YTemperature.UNIT_INVALID www.yoctopuce.com...
  • Page 570 ) 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 571 Si les valeurs des attributs en cache du capteur de température sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur de température est joignable, sinon www.yoctopuce.com...
  • Page 572 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 573 ) YTemperature 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 574 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 575 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 576 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 577 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 578 (en Ohms) pour chacun des points de température, index par index. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 579 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 580 é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 581 é c i f i q u e , u t i l i s e z Temperature.findTemperature() avec un hardwareID ou un nom logique. Retourne : YTemperature null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 582 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 583 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 584 Y T e m p e r a t u r e . A D V M O D E _ P E R I O D _ M I N YTemperature.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 585 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 586 ê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 587 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de température. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 588 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 589 Cette fonction ne peut être utilisée qu'avec les capteurs de température basés sur un thermistor. Paramètres : res25 résistance à 25 degrés Celsius beta coefficient Beta Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 590 ê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 591 ê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 592 Y T e m p e r a t u r e . S E N S O R T Y P E _ R E S _ I N T E R N A L YTemperature.SENSORTYPE_IR YTemperature.SENSORTYPE_RES_PT1000 YTemperature.SENSORTYPE_CHANNEL_OFF représentant le type de senseur utilisé par le module Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 593 (en Ohms) pour chacun des resValues points de température, index par index. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 594 Paramètres : une chaîne de caractères représentant l'unité dans laquelle la température mesurée est exprimée 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 595 $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 596 ) int startDataLogger( ) int startDataLogger( ) YTemperature target startDataLogger Attention, l'enregistreur ne sauvera les mesures de ce capteur que si la fréquence d'enregistrement (logFrequency) n'est pas sur "OFF". Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 597 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YTemperature target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 598 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 599 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 600: La Classe Ydatalogger

    23. Référence de l'API de haut niveau 23.7. 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 601 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 602 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 603 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 604 à 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 605 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 606 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 607 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 608 à 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 609 23. 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 610 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 611 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 612 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 613 23. 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 614 23. 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 615 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 616 23. 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 617 23. 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 618 23. 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 619 ) 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 620 è 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 621 ) 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 622 ' 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 623 ) 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 624 ' 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 625 ' 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 626 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 627 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 628 ) 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 629 ) 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 630 ' 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 631 é 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 632 ) 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 633 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 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 YDataLogger.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 635 23. 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 636 23. 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 637 ): 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 638 ): 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 639 ): 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 640 ) 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 641 ) 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 642 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 643 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 644 ) 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 645 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 646 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 647 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 648 é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 649 é 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 650 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 651 , 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 652 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 653 ê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 654 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 655 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 656 $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 657 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 658 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 659: 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 660 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 661 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 662 à 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 663 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 664 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 665 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 666 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 667 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 668 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 669 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 670 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 671 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 672 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 673 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 674 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 675 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 676 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 677 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 678 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 679 23. 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 680 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 681 , 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 682 à 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 683 - 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 684 23. 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 685 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 686 23. 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 687 23. 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 688 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 689 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 690 ) 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 691 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 692: 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 693 ): 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 694 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 695 ): 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 696 ): 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 697 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 698 www.yoctopuce.com...

  • Page 699: Problèmes Courants

    24.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 24.2.

  • Page 700: Plateformes Arm: Hf Et El

    24.5. Module alimenté mais invisible pour l'OS Si votre Yocto-VOC-V3 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 701: Déconnexions, Comportement Erratique

    24. Problèmes courants 24.7. Déconnexions, comportement erratique Si votre Yocto-VOC-V3 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 702 www.yoctopuce.com...

  • Page 703: Caractéristiques

    25. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module Yocto-VOC-V3 Identifiant produit YVOCMK03 † Rev. B Révision matérielle Connecteur USB micro-B Largeur 20 mm Longueur 60 mm Poids Senseur SGP30, SHT35 (Sensirion) Fréquence de rafraîchissement 1 Hz Plage de mesure (CO2eq) 0...60000 ppm...
  • Page 704 25. Caractéristiques www.yoctopuce.com...

Table des Matières