1. Manuels
  2. Marques
  3. Yoctopuce Manuels
  4. Unités de contrôle
  5. Yocto-RangeFinder
  6. Mode d'emploi

Yoctopuce Yocto-RangeFinder 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
Table des Matières

Publicité

Liens rapides

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

Publicité

Table des Matières
loading

Manuels Connexes pour Yoctopuce Yocto-RangeFinder

Sommaire des Matières pour Yoctopuce Yocto-RangeFinder

  • Page 1 Yocto-RangeFinder Mode d'emploi...

  • Page 3: Table Des Matières

    5. Montage et connectique ....................5.1. Fixation ..........................5.2. Déporter le capteur ......................5.3. Contraintes d'alimentation par USB ................6. Programmation, concepts généraux ................ 6.1. Paradigme de programmation ..................6.2. Le module Yocto-RangeFinder ..................6.3. Module ..........................6.4. RangeFinder ........................www.yoctopuce.com...
  • Page 4 6.7. DataLogger ......................... 6.8. Quelle interface: Native, DLL ou Service? ............... 6.9. Programmation, par où commencer? ................7. Utilisation du Yocto-RangeFinder en ligne de commande ......7.1. Installation .......................... 7.2. Utilisation: description générale ..................7.3. Contrôle de la fonction RangeFinder ................
  • Page 5 15. Utilisation du Yocto-RangeFinder en JavaScript / EcmaScript .... 15.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ....... 15.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ......15.3. Contrôle de la fonction RangeFinder ................15.4. Contrôle de la partie module ..................
  • Page 6 19.7. Gestion des erreurs ....................... 20. Utilisation du Yocto-RangeFinder en Objective-C ........20.1. Contrôle de la fonction RangeFinder ................20.2. Contrôle de la partie module ..................20.3. Gestion des erreurs ....................... 21. Utilisation avec des langages non supportés ..........21.1. Utilisation en ligne de commande ................

  • Page 7: Introduction

    Les ingénieurs Yoctopuce se sont donné beaucoup de mal pour que votre Yocto-RangeFinder 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é

    Boîtier de protection Le Yocto-RangeFinder ne doit pas être utilisé sans boîtier de protection, en raison des composants électriques à nu. Pour une sécurité optimale, il devrait être mis dans un boîtier non métallique, non- inflammable, résistant à...

  • Page 9: Environnement

    été déterminée en fonction des recommandations officielles des fabricants des composants utilisés dans le Yocto-RangeFinder, 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-RangeFinder 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

    . Si cela arrivait débranchez puis rebranchez le module. Si le problème venait à se reproduire vérifiez que le module contient bien la dernière version du firmware, et dans l'affirmative contactez le support Yoctopuce La sonde de courant Chaque Yocto-module est capable de mesurer sa propre consommation de courant sur le bus USB.

  • Page 13: Accessoires Optionnels

    à ce que capteur reste propre. La LED de détection La LED de détection signale lorsque le Yocto-RangeFinder a détecté un objet à moins d'un mètre. 2.3. Accessoires optionnels Les accessoires ci-dessous ne sont pas nécessaires à l'utilisation du module Yocto-RangeFinder, mais pourraient vous être utiles selon l'utilisation que vous en faites.

  • Page 14: Connecteurs Picoflex Et Cable Nappe Souple

    Vous pouvez installer votre Yocto-RangeFinder dans un boîtier optionnel. Connecteurs Picoflex et cable nappe souple Si vous désirez déporter la partie capteur du module Yocto-RangeFinder à l'aide d'un câble à connecteur enfichable, vous aurez besoin de câble nappe souple à 4 fils espacés de 1.27mm et de connecteurs Picoflex.

  • Page 15: Principe De Fonctionnement Et Limitations

    3. Principe de fonctionnement et limitations Le Yocto-RangeFinder émet des impulsions laser et mesure le temps qu'elles mettent pour retourner vers le capteur après s'être réfléchies contre un obstacle. Les intervalles de temps d'une telle mesure sont tellement courts que le capteur utilise des principes physiques indirects pour les évaluer.

  • Page 16: Modes De Fonctionnement

    Pour ne pas affecter la linéarité des mesures, cette calibration n'est pas déclenchée automatiquement par le Yocto-RangeFinder, mais il est doté d'un capteur de température qui vous permet de décider quand la déclencher lorsque la différence de température depuis la dernière calibration atteint 8 degrés Celsius.

  • Page 17: Procédures De Calibration Matérielles

    Pour garantir le bon fonctionnement du capteur, il faut lancer une procédure de calibration automatique lorsque la température varie de plus de 8°C. Le Yocto-RangeFinder inclut un capteur de température situé juste à côté du capteur de distance, permettant de détecter les variations de température et de lancer cette calibration si nécessaire.
  • Page 18 (sans calibration) en fonction de la distance réelle d'une cible. Pour que le résultat de la calibration soit préservé après le redémarrage du module, il faut sauvegarder les paramètres calculés dans la mémoire flash du Yocto-RangeFinder. Pour cela, il faut appeler la méthode du module.
  • Page 19 3. Principe de fonctionnement et limitations www.yoctopuce.com dans la rubrique Support. Les commandes correspondantes sont les suivantes, en plaçant bien entendu les cibles correspondantes et en remplaçant les distances en fonction de leurs positions: YRangeFinder any triggerSpadCalibration YRangeFinder any triggerTemperatureCalibration...
  • Page 20 www.yoctopuce.com...

  • Page 21: Premiers Pas

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

  • Page 22: Test De La Connectivité Usb

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

  • Page 23: Localisation

    . Lancez le Virtual Hub en ligne de commande, ouvrez votre browser préféré et tapez l'adresse http://127.0.0.1:4444. Vous devriez voir apparaître la liste des modules Yoctopuce raccordés à votre ordinateur. Liste des modules telle qu'elle apparaît dans votre browser. 4.3. Localisation Il est alors possible de localiser physiquement chacun des modules affichés en cliquant sur le bouton...

  • Page 24: 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 25: Montage Et Connectique

    Exemples de montage sur un support. Le module Yocto-RangeFinder 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 26: Déporter Le Capteur

    5. Montage et connectique 5.2. Déporter le capteur Le module Yocto-RangeFinder est conçu pour pouvoir être séparé en deux morceaux afin de vous permettre de déporter le capteur. Vous pouvez les séparer en cassant simplement le circuit, mais vous obtiendrez un meilleur résultat en utilisant une bonne paire de tenailles, ou une grosse pince coupante.

  • Page 27: Contraintes D'alimentation Par Usb

    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 28 Toujours par rapport aux normes de compatibilité électromagnétique, la longueur maximale supportée du câble USB est de 3m. En plus de pouvoir causer des problèmes de chute de tension, l'utilisation de câbles plus long aurait des incidences sur les test d'immunité électromagnétiques à effectuer pour respecter les normes. www.yoctopuce.com...

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

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

  • Page 30: 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 31: Le Module Yocto-Rangefinder

    6.2. Le module Yocto-RangeFinder Le module Yocto-RangeFinder offre une instance de la fonction RangeFinder correspondant au capteur de distance, une instance de la fonction LightSensor qui mesure le niveau ambiant de lumière infrarouge et une instance de la fonction Temperature, correspondant au capteur de température intégré...

  • Page 32: Module

    Nombre entier lecture seule currentRunIndex Heure UTC modifiable timeUTC Type énuméré modifiable recording On/Off modifiable autoStart On/Off modifiable beaconDriven 0..100% lecture seule usage Booléen modifiable clearHistory 6.3. Module Interface de contrôle des paramètres généraux des modules Yoctopuce www.yoctopuce.com...
  • Page 33 Chaine de caractères contenant le numéro de série, unique et préprogrammé en usine. Pour un module Yocto-RangeFinder, ce numéro de série commence toujours par YRNGFND1. Il peut servir comme point de départ pour accéder par programmation à un module particulier.

  • Page 34: Rangefinder

    Interface pour intéragir avec les capteurs de distance, disponibles par exemple dans le Yocto- RangeFinder La classe permet de lire et de configurer les capteurs de distance Yoctopuce. Elle YRangeFinder hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de YSensor mesures, callbacks, enregistreur de données.

  • Page 35: Lightsensor

    Interface pour intéragir avec les capteurs de lumière, disponibles par exemple dans le Yocto-Light- V3, le Yocto-Proximity et le Yocto-RangeFinder La classe permet de lire et de configurer les capteurs de lumière Yoctopuce. Elle YLightSensor hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de YSensor mesures, callbacks, enregistreur de données.

  • Page 36: Temperature

    6.6. 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 www.yoctopuce.com...
  • Page 37 6. Programmation, concepts généraux La classe permet de lire et de configurer les capteurs de température Yoctopuce. YTemperature Elle hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de YSensor mesures, callbacks, enregistreur de données. De plus, elle permet de configurer les paramètres spécifiques de certains types de capteur (type de connection, table d'étalonnage).

  • Page 38: Datalogger

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

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

  • Page 40: 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 41: Limitation Des Librairies Yoctopuce

    Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto- RangeFinder. 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 42 6. Programmation, concepts généraux Une fois que vous maîtriserez la programmation de base de votre module, vous pourrez vous intéresser au chapitre concernant la programmation avancée qui décrit certaines techniques qui vous permettront d'exploiter au mieux votre Yocto-RangeFinder. www.yoctopuce.com...

  • Page 43: Utilisation Du Yocto-Rangefinder En Ligne De Commande

    7. Utilisation du Yocto-RangeFinder en ligne de commande Lorsque vous désirez effectuer une opération ponctuelle sur votre Yocto-RangeFinder, comme la lecture d'une valeur, le changement d'un nom logique, etc.. vous pouvez bien sur utiliser le Virtual Hub, mais il existe une méthode encore plus simple, rapide et efficace: l'API en ligne de commande.

  • Page 44: Contrôle De La Fonction Rangefinder

    C:\>executable commande /help Pour obtenir une description détaillée des paramètres d'une commande. 7.3. Contrôle de la fonction RangeFinder Pour contrôler la fonction RangeFinder de votre Yocto-RangeFinder, vous avez besoin de l'exécutable YRangeFinder. Vous pouvez par exemple lancer: C:\>YRangeFinder get_currentValue Cet exemple utilise la cible "any"...

  • Page 45: Contrôle De La Partie Module

    7. Utilisation du Yocto-RangeFinder en ligne de commande 7.4. Contrôle de la partie module Chaque module peut être contrôlé d'une manière similaire à l'aide de l'exécutable . Par YModule exemple, pour obtenir la liste de tous les modules connectés, utilisez: C:\>YModule inventory...
  • Page 46 7. Utilisation du Yocto-RangeFinder 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 47: Utilisation Du Yocto-Rangefinder 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 48: Un Exemple Réel

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

  • Page 49: Contrôle De La Partie Module

    8. Utilisation du Yocto-RangeFinder en Python import os, from yocto_api import from yocto_rangefinder import from yocto_lightsensor import from yocto_temperature 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 50 8. Utilisation du Yocto-RangeFinder 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 51: 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 52 8. Utilisation du Yocto-RangeFinder en Python chaque fonction sont systématiquement remplacées par des valeurs de retour particulières, qui peuvent être testées par l'appelant lorsque c'est pertinent. Le nom de la valeur de retour en cas d'erreur pour chaque fonction est systématiquement documenté dans la référence de la librairie. Il...

  • Page 53: Utilisation Du Yocto-Rangefinder En C

    à la création d'un projet à neuf linké avec les librairies Yoctopuce. 9.1. Contrôle de la fonction RangeFinder Il suffit de quelques lignes de code pour piloter un Yocto-RangeFinder. Voici le squelette d'un fragment de code C++ qui utilise la fonction RangeFinder. #include "yocto_api.h"...
  • Page 54 Mais vous pouvez tout aussi bien utiliser des noms logiques que vous auriez préalablement configurés. Imaginons un module Yocto-RangeFinder avec le numéros de série YRNGFND1-123456 que vous auriez appelé "MonModule" et dont vous auriez nommé la fonction rangeFinder "MaFonction", les cinq appels suivants seront strictement équivalents (pour autant que MaFonction ne soit définie qu'une fois, pour...
  • Page 55 9. Utilisation du Yocto-RangeFinder en C++ #include "yocto_api.h" #include "yocto_rangefinder.h" #include "yocto_lightsensor.h" #include "yocto_temperature.h" #include <iostream> #include <stdlib.h> using namespace std; static void usage(void) cout << "usage: demo <serial_number> " << endl; cout << " demo <logical_name>" << endl; cout <<...

  • Page 56: Contrôle De La Partie Module

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

  • Page 58: 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 59: Intégration De La Librairie Yoctopuce En C

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

  • Page 60: Intégration En Librairie Dynamique

    9. Utilisation du Yocto-RangeFinder en C++ Intégration en librairie dynamique L'intégration de la librairie Yoctopuce sous forme de librairie dynamique permet de produire un exécutable plus petit que les deux méthodes précédentes, et de mettre éventuellement à jour cette librairie si un correctif s'avérait nécessaire sans devoir recompiler le code source de l'application. Par contre, c'est un mode d'intégration qui exigera systématiquement de copier la librairie dynamique sur...

  • Page 61: Utilisation Du Yocto-Rangefinder En C

    10.2. Utilisation l'API yoctopuce dans un projet Visual C# La librairie Yoctopuce pour Visual C# .NET se présente sous la forme d'une DLL et de fichiers sources en Visual C#. La DLL n'est pas une DLL .NET mais une DLL classique, écrite en C, qui gère les communications à...

  • Page 62: Contrôle De La Fonction Rangefinder

    Il va de soit que que les fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique. 10.3. Contrôle de la fonction RangeFinder Il suffit de quelques lignes de code pour piloter un Yocto-RangeFinder. Voici le squelette d'un fragment de code C# qui utilise la fonction RangeFinder. [...] // On active la détection des modules sur USB...
  • Page 63 10. Utilisation du Yocto-RangeFinder en C# rangefinder = YRangeFinder.FindRangeFinder("YRNGFND1-123456.MaFonction"); rangefinder = YRangeFinder.FindRangeFinder("MonModule.rangeFinder"); rangefinder = YRangeFinder.FindRangeFinder("MonModule.MaFonction"); rangefinder = YRangeFinder.FindRangeFinder("MaFonction"); renvoie un objet que vous pouvez ensuite utiliser à loisir YRangeFinder.FindRangeFinder pour contrôler le capteur de distance. isOnline La méthode de l'objet renvoyé par...

  • Page 64: Contrôle De La Partie Module

    10. Utilisation du Yocto-RangeFinder en C# YLightSensor.FindLightSensor(target + ".lightSensor1"); YTemperature.FindTemperature(target + ".temperature1"); while (rf.isOnline()) { Console.WriteLine("Distance : " + rf.get_currentValue().ToString()); Console.WriteLine("Ambiant IR : " + ir.get_currentValue().ToString()); Console.WriteLine("Temperature : " + tmp.get_currentValue().ToString()); Console.WriteLine(" (press Ctrl-C to exit)"); YAPI.Sleep(1000, ref errmsg); YAPI.FreeAPI();...
  • Page 65 10. Utilisation du Yocto-RangeFinder en C# 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 66: 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 67 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 68 www.yoctopuce.com...

  • Page 69: Utilisation Du Yocto-Rangefinder 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 70: 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 71 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 72: 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 73: 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 74 \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 75: Présentation Des Vis Yoctopuce

    Yoctopuce et avec tous les VIs de l'API 11.4. Présentation des VIs Yoctopuce La librairie Yoctopuce pour LabVIEW comprend un VI par classe de l'API Yoctopuce, plus quelques VI spéciaux. Tous les VIs disposent des connecteurs traditionnels Error IN et Error Out.

  • Page 76: 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 77: 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 78: 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 79 11. Utilisation du Yocto-RangeFinder 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 80: Gestion Des Erreurs

    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 81: 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 82: Gestion Du Datalogger

    Connexion asynchrone 11.7. Gestion du datalogger Quasiment tous les senseurs Yoctopuce disposent d'un enregistreur de données qui permet de stocker les mesures des senseurs dans la mémoire non volatile du module. La configuration de l'enregistreur de données peut être réalisée avec le VirtualHub, mais aussi à l'aide d'un peu de code...

  • Page 83: Énumération De Fonctions

    11. Utilisation du Yocto-RangeFinder 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 84: Un Mot Sur Les Performances

    Récupération de la liste de tous les modules connectés 11.9. Un mot sur les performances L'API Yoctopuce pour LabVIEW été optimisée de manière à ce que les tous les VIs et les propriétés de objets Proxy génèrent un minimum de communication avec les modules Yoctopuce. Ainsi vous pouvez les utiliser dans des boucles sans prendre de précaution particulière: vous n'êtes pas obligés...

  • Page 85: Différences Avec Les Autres Api Yoctopuce

    Yoctopuce pour LabVIEW 11.11. Différences avec les autres API Yoctopuce Yoctopuce fait tout son possible pour maintenir une forte cohérence entre les différentes librairies de programmation. Cependant, LabVIEW étant un environnement clairement à part, il en résulte des différences importantes avec les autres librairies.
  • Page 86 www.yoctopuce.com...

  • Page 87: Utilisation Du Yocto-Rangefinder En Java

    Il va de soit que que le fonctionnement des librairies est strictement identiques si vous les intégrez dans une application dotée d'une interface graphique. 12.2. Contrôle de la fonction RangeFinder Il suffit de quelques lignes de code pour piloter un Yocto-RangeFinder. Voici le squelette d'un fragment de code Java qui utilise la fonction RangeFinder. [...] // On active l'accès aux modules locaux à...

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

  • Page 89: Contrôle De La Partie Module

    12. Utilisation du Yocto-RangeFinder en Java System.out.println("Ensure that the VirtualHub application is running"); System.exit(1); YRangeFinder (args.length > 0) { = YRangeFinder.FindRangeFinder(args[0] + ".rangeFinder1"); } else { = YRangeFinder.FirstRangeFinder(); == null) { System.out.println("No module connected (check USB cable)"); System.exit(1); if (!rf.isOnline()) { System.out.println("Module not connected (check identification and USB cable)"...
  • Page 90 12. Utilisation du Yocto-RangeFinder en Java System.out.println("No module connected (check USB cable)"); System.exit(1); } else { module = YModule.FindModule(args[0]); // use serial or logical name try { (args.length > 1) { if (args[1].equalsIgnoreCase("ON")) { module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF); System.out.println("serial: "...

  • Page 91: Enumeration Des Modules

    12. Utilisation du Yocto-RangeFinder en Java = YModule.FindModule(args[0]); // use serial or logical name try { newname = args[1]; if (!YAPI.CheckLogicalName(newname)) System.out.println("Invalid name (" newname + ")"); System.exit(1); m.set_logicalName(newname); m.saveToFlash(); // do not forget this System.out.println("Module: serial= " + m.get_serialNumber());...

  • Page 92: 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 93: Utilisation Du Yocto-Rangefinder 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 94: 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 95: Lancement Automatique

    13. Utilisation du Yocto-RangeFinder 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 96: Contrôle De La Fonction Rangefinder

    13. Utilisation du Yocto-RangeFinder avec Android 13.5. Contrôle de la fonction RangeFinder Il suffit de quelques lignes de code pour piloter un Yocto-RangeFinder. Voici le squelette d'un fragment de code Java qui utilise la fonction RangeFinder. [...] // On active la détection des modules sur USB YAPI.EnableUSBHost(this);...
  • Page 97 13. Utilisation du Yocto-RangeFinder 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 98: Contrôle De La Partie Module

    13. Utilisation du Yocto-RangeFinder avec Android handler.postDelayed(r, 500); @Override protected void onStop() super.onStop(); handler.removeCallbacks(r); YAPI.FreeAPI(); @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long serial = parent.getItemAtPosition(pos).toString(); @Override public void onNothingSelected(AdapterView<?> arg0) final Runnable = new Runnable() public void run()
  • Page 99 13. Utilisation du Yocto-RangeFinder avec Android @Override public void onCreate(Bundle savedInstanceState) super.onCreate(savedInstanceState); setContentView(R.layout.modulecontrol); Spinner my_spin = (Spinner) findViewById(R.id.spinner1); my_spin.setOnItemSelectedListener(this); = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_item); aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item); my_spin.setAdapter(aa); @Override protected void onStart() super.onStart(); try { aa.clear(); YAPI.EnableUSBHost(this); YAPI.RegisterHub("usb"); YModule = YModule.FirstModule(); while != null) {...
  • Page 100 13. Utilisation du Yocto-RangeFinder avec Android public void refreshInfo(View view) DisplayModuleInfo(); public void toggleBeacon(View view) (module == null) return; boolean = ((Switch) view).isChecked(); try { if (on) { module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF); } catch (YAPI_Exception e) { e.printStackTrace(); Chaque propriété...
  • Page 101 13. Utilisation du Yocto-RangeFinder avec Android aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item); my_spin.setAdapter(aa); @Override protected void onStart() super.onStart(); try { aa.clear(); YAPI.EnableUSBHost(this); YAPI.RegisterHub("usb"); YModule = 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();...
  • Page 102 13. Utilisation du Yocto-RangeFinder avec Android DisplayModuleInfo(); Attention, le nombre de cycles d'écriture de la mémoire non volatile du module est limité. Passé cette limite plus rien ne garantit que la sauvegarde des réglages se passera correctement. Cette limite, liée à la technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles.

  • Page 103: 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 104 www.yoctopuce.com...

  • Page 105: Utilisation Du Yocto-Rangefinder 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 106: 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 107: Contrôle De La Fonction Rangefinder

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

    à en faire un petit programme d'exemple concret. Si le Yocto-RangeFinder 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 109 14. Utilisation du Yocto-RangeFinder en TypeScript import { YLightSensor } from 'yoctolib-cjs/yocto_lightsensor.js' import { YTemperature } from 'yoctolib-cjs/yocto_temperature.js' let rf: YRangeFinder; let ir: YLightSensor; let tmp: YTemperature; async function startDemo(): Promise<void> await YAPI.LogUnhandledPromiseRejections(); // Setup the API to use the VirtualHub on local machine...

  • Page 110: 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-RangeFinder. Vous y trouverez un fichier html , et un fichier TypeScript similaire au code ci-dessus, app.html...
  • Page 111 14. Utilisation du Yocto-RangeFinder en TypeScript await module.set_beacon(YModule.BEACON_OFF); console.log('serial: '+await module.get_serialNumber()); console.log('logical name: '+await module.get_logicalName()); console.log('luminosity: '+await module.get_luminosity()+'%'); console.log('beacon: (await module.get_beacon() == YModule.BEACON_ON 'ON' : 'OFF')); console.log('upTime: ((await module.get_upTime()/1000)>>0) sec'); console.log('USB current: '+await module.get_usbCurrent()+' mA'); console.log('logs:'); console.log(await module.get_lastLogs()); } else { console.log("Module not connected (check identification and USB...

  • Page 112: 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 113 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 114 www.yoctopuce.com...

  • Page 115: Utilisation Du Yocto-Rangefinder 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 116: Fonctions Bloquantes Et Fonctions Asynchrones En Javascript

    15. Utilisation du Yocto-RangeFinder en JavaScript / EcmaScript 15.1. Fonctions bloquantes et fonctions asynchrones en JavaScript JavaScript a été conçu pour éviter toute situation de concurrence durant l'exécution. Il n'y a jamais qu'un seul thread en JavaScript. Cela signifie que si un programme effectue une attente active durant une communication réseau, par exemple pour lire un capteur, le programme entier se trouve...

  • Page 117: 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 118: Compatibilité Avec L'ancienne Librairie Javascript

    15. Utilisation du Yocto-RangeFinder 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 119: Contrôle De La Fonction Rangefinder

    Ce dernier appel asynchrone peut aussi être formulé comme: myModule.get_syncProxy().then(logInfoProxy); 15.3. Contrôle de la fonction RangeFinder Il suffit de quelques lignes de code pour piloter un Yocto-RangeFinder. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction RangeFinder. // En Node.js, on utilise la fonction require() // En HTML, on utiliserait &lt;script src="..."&gt;...
  • Page 120 à en faire un petit programme d'exemple concret. Si le Yocto-RangeFinder 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 121 15. Utilisation du Yocto-RangeFinder en JavaScript / EcmaScript YRangeFinder.FindRangeFinder(serial + ".rangeFinder1"); YLightSensor.FindLightSensor(serial + ".lightSensor1"); YTemperature.FindTemperature(serial + ".temperature1"); refresh(); async function refresh() { if (await rf.isOnline()) { console.log(" Distance : " + (await rf.get_currentValue()) + " Ambient IR : " + (await ir.get_currentValue()) + "...

  • Page 122: Contrôle De La Partie Module

    15. Utilisation du Yocto-RangeFinder en JavaScript / EcmaScript let rf = YRangeFinder.FindRangeFinder(serial + ".rangeFinder1"); let ir = YLightSensor.FindLightSensor(serial + ".lightSensor1"); let tmp = YTemperature.FindTemperature(serial + ".temperature1"); if (await rf.isOnline()) { document.getElementById('msg').value = ''; document.getElementById("rf").value = await rf.get_currentValue(); document.getElementById("ir").value = await ir.get_currentValue();...
  • Page 123 15. Utilisation du Yocto-RangeFinder en JavaScript / EcmaScript console.log("Module not connected (check identification and USB cable)\n"); await YAPI.FreeAPI(); if(process.argv.length < 2) { console.log("usage: node demo.js <serial or logicalname> [ ON | OFF ]"); } else { startDemo(process.argv.slice(2)); Chaque propriété du module peut être lue grâce à une méthode du type...

  • Page 124: 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 125 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 126 www.yoctopuce.com...

  • Page 127: Utilisation Du Yocto-Rangefinder En Php

    Vous n'avez pas besoin d'installer de driver. 16.2. Contrôle de la fonction RangeFinder Il suffit de quelques lignes de code pour piloter un Yocto-RangeFinder. Voici le squelette d'un fragment de code PHP qui utilise la fonction RangeFinder. include('yocto_api.php');...

  • Page 128: Un Exemple Réel

    Ces deux includes PHP permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. doit toujours être inclus, yocto_api.php yocto_rangefinder.php nécessaire pour gérer les modules contenant un capteur de distance, comme le Yocto-RangeFinder. 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.

  • Page 129: Contrôle De La Partie Module

    16. Utilisation du Yocto-RangeFinder en PHP browser favori. Vous trouverez aussi ce code dans le répertoire Examples/Doc-GettingStarted- Yocto-RangeFinder 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 130 16. Utilisation du Yocto-RangeFinder en 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); @$serial = $_GET['serial'];...
  • Page 131 16. Utilisation du Yocto-RangeFinder en PHP <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) { die("Cannot contact VirtualHub on 127.0.0.1");...

  • Page 132: 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 133 16. Utilisation du Yocto-RangeFinder 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 134 16. Utilisation du Yocto-RangeFinder 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 135: 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 136 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 137: Utilisation Du Yocto-Rangefinder En Visualbasic .Net

    17.2. Utilisation l'API yoctopuce dans un projet Visual Basic La librairie Yoctopuce pour Visual Basic .NET se présente sous la forme d'une DLL et de fichiers sources en Visual Basic. La DLL n'est pas une DLL .NET mais une DLL classique, écrite en C, qui gère les communications à...

  • Page 138: Contrôle De La Fonction Rangefinder

    17.3. Contrôle de la fonction RangeFinder Il suffit de quelques lignes de code pour piloter un Yocto-RangeFinder. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction RangeFinder. [...] ' On active la détection des modules sur USB...
  • Page 139 17. Utilisation du Yocto-RangeFinder en VisualBasic .NET rangefinder = YRangeFinder.FindRangeFinder("MaFonction") renvoie un objet que vous pouvez ensuite utiliser à loisir YRangeFinder.FindRangeFinder pour contrôler le capteur de distance. isOnline La méthode de l'objet renvoyé par permet isOnline() YRangeFinder.FindRangeFinder de savoir si le module correspondant est présent et en état de marche.

  • Page 140: Contrôle De La Partie Module

    17. Utilisation du Yocto-RangeFinder en VisualBasic .NET Console.WriteLine("Temperature : " + Str(tmp.get_currentValue())) Console.WriteLine(" (press Ctrl-C to exit)") YAPI.Sleep(1000, errmsg) End While YAPI.FreeAPI() End Sub End Module 17.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...
  • Page 141 17. Utilisation du Yocto-RangeFinder en VisualBasic .NET Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire vive du set_xxx() module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration...

  • Page 142: Gestion Des Erreurs

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 143 17. Utilisation du Yocto-RangeFinder en VisualBasic .NET Quand vous travaillez sans les exceptions, il est possible d'obtenir un code d'erreur et un message expliquant l'origine de l'erreur en le demandant à l'objet qui a retourné une erreur à l'aide des méthodes...
  • Page 144 www.yoctopuce.com...

  • Page 145: Utilisation Du Yocto-Rangefinder En Delphi

    Delphi Par défaut la librairie Yoctopuce pour Delphi utilise une DLL yapi.dll, toutes les applications que vous créerez avec Delphi devront avoir accès à cette DLL. Le plus simple est de faire en sorte qu'elle soit présente dans le même répertoire que l'exécutable de votre application.
  • Page 146 [...] Voyons maintenant en détail ce que font ces quelques lignes. yocto_api et yocto_rangefinder 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 yocto_api yocto_rangefinder modules contenant un capteur de distance, comme le Yocto-RangeFinder.
  • Page 147 18. Utilisation du Yocto-RangeFinder 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_rangeFinder, yocto_lightSensor, yocto_temperature;...

  • Page 148: Contrôle De La Partie Module

    18. Utilisation du Yocto-RangeFinder en Delphi done := true; end; until done; yFreeAPI(); end. 18.3. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
  • Page 149 18. Utilisation du Yocto-RangeFinder en Delphi until c = 'x'; yFreeAPI(); end. 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 150: 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 151 18. Utilisation du Yocto-RangeFinder en Delphi attraper exceptions à chaque ligne code. suffit d'appeler fonction pour commuter la librairie dans un mode où les exceptions de YAPI.DisableExceptions() chaque fonction sont systématiquement remplacées par des valeurs de retour particulières, qui peuvent être testées par l'appelant lorsque c'est pertinent. Le nom de la valeur de retour en cas d'erreur pour chaque fonction est systématiquement documenté...
  • Page 152 www.yoctopuce.com...

  • Page 153: Utilisation Du Yocto-Rangefinder 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 154: Installation

    19.2. Installation Téléchargez la librairie Yoctopuce pour Universal Windows Platform depuis le site web de Yoctopuce . Il n'y a pas de programme d'installation, copiez simplement de contenu du fichier zip dans le répertoire de votre choix.

  • Page 155: Contrôle De La Fonction Rangefinder

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

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

    19. Utilisation du Yocto-RangeFinder avec Universal Windows Platform YAPI.FreeAPI(); return 0; 19.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 158 19. Utilisation du Yocto-RangeFinder avec Universal Windows Platform Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire YModule.set_xxx() vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa...

  • Page 159: 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 160 www.yoctopuce.com...

  • Page 161: Utilisation Du Yocto-Rangefinder En Objective-C

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

  • Page 163: Contrôle De La Partie Module

    20. Utilisation du Yocto-RangeFinder 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 164 20. Utilisation du Yocto-RangeFinder en Objective-C exit(1); main (int argc, const char * argv[]) NSError *error; @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) { NSLog(@"RegisterHub error: %@", [error localizedDescription]); return if(argc <...
  • Page 165 20. Utilisation du Yocto-RangeFinder en Objective-C NSError *error; @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb" :&error] != YAPI_SUCCESS) { NSLog(@"RegisterHub error: %@", [error localizedDescription]); return if(argc < usage(argv[0]); NSString *serial_or_name [NSString stringWithUTF8String:argv[1]]; // use serial or logical name...

  • Page 166: 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 167: 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 168: Exemple D'utilisation Avec Matlab

    21. Utilisation avec des langages non supportés mécanismes de callbacks. A la place, cette librairie offre des objets miroirs, appelés Proxys, qui publient par le biais de Propriétés les principaux attributs des fonctions Yoctopuce tels que la mesure courante, les paramètres de configuration, l'état, etc.

  • Page 169: 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 170: 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-RangeFinder avec le numéro de de série YRNGFND1-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.

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

    21.4. Utilisation des librairies dynamiques L'API Yoctopuce bas niveau est disponible sous différents formats de librairie dynamiques écrites en C, dont les sources sont disponibles avec l'API C++. Utiliser une de ces librairies bas niveau vous permettra de vous passer du Virtual Hub.
  • Page 172 (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 173: Inventaire Des Modules

    21. Utilisation avec des langages non supportés end. Inventaire des modules Pour procéder à l'inventaire des modules Yoctopuce, deux fonctions de la librairie dynamique sont nécessaires int yapiGetAllDevices(int *buffer,int maxsize,int *neededsize,char *errmsg); int yapiGetDeviceInfo(int devdesc,yDeviceSt *infos, char *errmsg); La fonction yapiGetAllDevices permet d'obtenir la liste des modules connectés sous la forme d'une liste de handles.

  • Page 174: 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 175: 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 176: 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 177 Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).

  • Page 178: L'enregistreur De Données

    Prog-EventBased. 22.2. L'enregistreur de données Votre Yocto-RangeFinder 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 179: Effacement De La Mémoire

    Remarque: les modules Yoctopuce n'ont pas besoin d'une connection USB active pour fonctionner: ils commencent à fonctionner dès qu'ils sont alimentés. Le Yocto-RangeFinder peut enregistrer des données sans être forcément raccordé à un ordinateur: il suffit d'activer le démarrage automatique du datalogger et d'alimenter le module avec un simple chargeur USB.
  • Page 180 Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-RangeFinder 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-RangeFinder va automatiquement essayer de se mettre à...

  • Page 181: Calibration Des Senseurs

    L'API Yoctopuce offre le moyen de re-calibrer les valeurs mesurées par votre Yocto-RangeFinder. 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 182 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 183: 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 184 22. Programmation avancée valeur avant de la renvoyer, permettant ainsi de corriger les mesures de manière totalement transparente. www.yoctopuce.com...

  • Page 185: Mise À Jour Du Firmware

    "mise à jour" et sera listé en dessous des modules connectés. 23.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 186: 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 187: 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 188: 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 189: Référence De L'api De Haut Niveau

    24. Référence de l'API de haut niveau Ce chapitre résume les fonctions de l'API de haut niveau pour commander votre Yocto-RangeFinder. 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...

  • Page 190: 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 191 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 192 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 193 . 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 194 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 195 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 196 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 197 (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 198 24. Référence de l'API de haut niveau YAPI.FreeAPI() YAPI YAPI.FreeAPI() Attends que toutes les communications en cours avec les modules Yoctopuce soient terminées puis libère les ressources utilisées par la librairie Yoctopuce. function yFreeAPI( ) void FreeAPI( ) +(void) FreeAPI...
  • Page 199 24. Référence de l'API de haut niveau YAPI.GetAPIVersion() YAPI YAPI.GetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée. function yGetAPIVersion( ) string GetAPIVersion( ) +(NSString*) GetAPIVersion string yGetAPIVersion( ): string function GetAPIVersion( ) As String static String GetAPIVersion( ) static String GetAPIVersion( )
  • Page 200 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 201 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 202 . 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 203 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 204 24. Référence de l'API de haut niveau YAPI.GetLog() YAPI YAPI.GetLog() Récupère les messages de logs de la librairie de communication Yoctopuce. static string GetLog( string lastLogLine) static string GetLog( string lastLogLine) Cette méthode permet de récupérer progressivement les messages de logs, ligne par ligne. La méthode doit être appelée en boucle, jusqu'à...
  • Page 205 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 206 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 207 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 208 24. Référence de l'API de haut niveau YAPI.InitAPI() YAPI YAPI.InitAPI() Initialise la librairie de programmation de Yoctopuce explicitement. function yInitAPI( mode, errmsg) YRETCODE InitAPI( int mode, string errmsg) +(YRETCODE) InitAPI :(int) mode :(NSError**) errmsg integer yInitAPI( mode: integer, var errmsg: string): integer...
  • Page 209 "usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 210 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 211 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 212 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 213 "usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 214 , 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 215 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 216 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 217 à 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 218 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 219 (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 220 à 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 221 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 222 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 223 ê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 224 ê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 225 à 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 226 é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 227 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 228 24. Référence de l'API de haut niveau YAPI.UnregisterHub() YAPI YAPI.UnregisterHub() Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. function yUnregisterHub( url) void UnregisterHub( string url) +(void) UnregisterHub :(NSString *) yUnregisterHub( url: string)
  • Page 229 24. Référence de l'API de haut niveau YAPI.UpdateDeviceList() YAPI YAPI.UpdateDeviceList() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList( errmsg) YRETCODE UpdateDeviceList( string errmsg) +(YRETCODE) UpdateDeviceList :(NSError**) errmsg integer yUpdateDeviceList( var errmsg: string): integer function UpdateDeviceList( ByRef...
  • Page 230 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 231: La Classe Ymodule

    24.2. La classe YModule Interface de contrôle des paramètres généraux des modules Yoctopuce La classe est utilisable avec tous les modules USB de Yoctopuce. Elle permet de contrôler YModule les paramètres généraux du module, et d'énumérer les fonctions fournies par chaque module.
  • Page 232 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 233 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 234 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 235 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 236 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 237 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 238 24. Référence de l'API de haut niveau YModule module→Beacon état de la balise de localisation. int Beacon Modifiable. Allume ou éteint la balise de localisation du module. www.yoctopuce.com...
  • Page 239 24. Référence de l'API de haut niveau YModule module→FirmwareRelease Version du logiciel embarqué du module. string FirmwareRelease www.yoctopuce.com...
  • Page 240 24. Référence de l'API de haut niveau YModule module→FunctionId Identifiant matériel de la nième fonction du module. string FunctionId @param functionIndex : l'index de la fonction pour laquelle l'information est désirée, en commençant à 0 pour la première fonction. www.yoctopuce.com...
  • Page 241 24. Référence de l'API de haut niveau YModule module→HardwareId Identifiant unique du module. string HardwareId L'identifiant unique est composé du numéro de série du module suivi de la chaîne ".module". www.yoctopuce.com...
  • Page 242 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 243 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 244 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 245 24. Référence de l'API de haut niveau YModule module→ProductId Identifiant USB du module, préprogrammé en usine. int ProductId www.yoctopuce.com...
  • Page 246 24. Référence de l'API de haut niveau YModule module→ProductName Nom commercial du module, préprogrammé en usine. string ProductName www.yoctopuce.com...
  • Page 247 24. Référence de l'API de haut niveau YModule module→ProductRelease Numéro uméro de révision du module hardware, préprogrammé en usine. int ProductRelease La révision originale du retourne la valeur 1, la révision B retourne la valeur 2, etc. www.yoctopuce.com...
  • Page 248 24. Référence de l'API de haut niveau YModule module→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 249 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 250 ) 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 251 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 252 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 253 à 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 254 ) 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 255 à 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 256 à 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 257 à 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 258 à 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 259 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 260 ): 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 261 ) 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 262 ) 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 263 ' 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 264 $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 265 ) 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 266 ) 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 267 ) 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 268 ) 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 269 ): 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 270 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 271 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.PERSISTENTSETTINGS_INVALID www.yoctopuce.com...
  • Page 272 ) 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 273 ): 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 274 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 275 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...
  • Page 276 ): 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 277 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 278: 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 279 ): 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 280 ): 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 281 ) 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 282 ) 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 283 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 284 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 285 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 286 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 287 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 288 ê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 289 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 290 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 291 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 292: 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 293 $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 294 ) 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 295 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 296 ê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 297 ê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 298 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 299 ê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 300 ê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 301 $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 302 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 303 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 304 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 305 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 306 à 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 307 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 308: La Classe Yrangefinder

    Interface pour intéragir avec les capteurs de distance, disponibles par exemple dans le Yocto- RangeFinder La classe permet de lire et de configurer les capteurs de distance Yoctopuce. Elle YRangeFinder hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.
  • Page 309 Retourne la valeur brute retournée par le capteur (sans arrondi ni calibration), en mm, sous forme de nombre à virgule. rangefinder→get_currentTemperature() Retourne la température actuelle du capteur, sous forme de nombre à virgule. rangefinder→get_currentValue() Retourne la valeur actuelle de la distance, en mm, sous forme de nombre à virgule. www.yoctopuce.com...
  • Page 310 Retourne la valeur minimale observée pour la distance depuis le démarrage du module. rangefinder→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. rangefinder→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. rangefinder→get_quality() Retourne une estimation de la quality de la mesure, sur la base de la dispersion mesurée.
  • Page 311 Modifie le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). rangefinder→set_highestValue(newval) Modifie la mémoire de valeur maximale observée. rangefinder→set_logFrequency(newval) Modifie la fréquence d'enregistrement des mesures dans le datalogger. rangefinder→set_logicalName(newval) Modifie le nom logique du capteur de distance. rangefinder→set_lowestValue(newval) Modifie la mémoire de valeur minimale observée. rangefinder→set_rangeFinderMode(newval) www.yoctopuce.com...
  • Page 312 Lance la calibration matérielle d'interférence de réflexion du capteur de distance. rangefinder→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. rangefinder→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 313 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur de distance sans ambiguïté, par exemple YRNGFND1.rangeFinder1 Retourne : YRangeFinder un objet de classe qui permet ensuite de contrôler le capteur de distance. www.yoctopuce.com...
  • Page 314 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 distance sans ambiguïté, par exemple YRNGFND1.rangeFinder1 Retourne : YRangeFinder un objet de classe qui permet ensuite de contrôler le capteur de distance. www.yoctopuce.com...
  • Page 315 YRangeFinder.nextRangeFinder() distance. Retourne : un pointeur sur un objet YRangeFinder , correspondant au premier capteur de distance accessible en null ligne, ou si il n'y a pas de capteurs de distance disponibles. www.yoctopuce.com...
  • Page 316 YRangeFinder.nextRangeFinder() distance. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YRangeFinder , correspondant au premier capteur de distance accessible en null ligne, ou si il n'y a pas de capteurs de distance disponibles. www.yoctopuce.com...
  • Page 317 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YRangeFinder.FindRangeFinder 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 318 24. Référence de l'API de haut niveau YRangeFinder rangefinder→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 319 24. Référence de l'API de haut niveau YRangeFinder rangefinder→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 320 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 321 24. Référence de l'API de haut niveau YRangeFinder rangefinder→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 322 24. Référence de l'API de haut niveau YRangeFinder rangefinder→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 323 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 324 "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 325 24. Référence de l'API de haut niveau YRangeFinder rangefinder→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 326 Le choix du mode permet de favoriser la précision, la vitesse, ou la distance maximale détectable. Modifiable. permettant ainsi de mettre la priorité sur la précision, la vitesse ou la distance maximale détectable. N'oubliez pas d'appeler la méthode du module si le réglage doit être saveToFlash() préservé. www.yoctopuce.com...
  • Page 327 "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 328 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 329 24. Référence de l'API de haut niveau YRangeFinder rangefinder→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 330 Modifiable. Une fenêtre temporelle plus grande donne des estimations plus fiables, mais rajoute de la latence et ne permet pas la détection d'événements de durée inférieure à la taille de la fenêtre. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 331 ê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 332 ) YRangeFinder target cancelCoverGlassCalibrations 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 333 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du capteur de distance. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 334 è r e s d é c r i v a n t c a p t e u r d i s t a n c e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 335 YRangeFinder.ADVMODE_PERIOD_AVG YRangeFinder.ADVMODE_PERIOD_MIN YRangeFinder.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 YRangeFinder.ADVMODE_INVALID www.yoctopuce.com...
  • Page 336 ' 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 YRangeFinder.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 337 ' 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 YRangeFinder.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 338 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRangeFinder.CURRENTTEMPERATURE_INVALID www.yoctopuce.com...
  • Page 339 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 340 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 341 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du capteur de distance.
  • Page 342 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du capteur de distance.
  • Page 343 ' 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 YRangeFinder.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 344 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 345 ' 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 YRangeFinder.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 346 YRangeFinder target get_hardwareCalibrationTemperature Cette fonction permet de déterminer si une nouvelle calibration par rapport à la température ambiante est nécessaire. Retourne : une température, sous forme de nombre à virgule. En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_DOUBLE. www.yoctopuce.com...
  • Page 347 ' 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 YRangeFinder.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 348 ' 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 YRangeFinder.HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 349 ' 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 YRangeFinder.LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 350 ' 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 YRangeFinder.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 351 ' 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 YRangeFinder.LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 352 24. Référence de l'API de haut niveau YRangeFinder rangefinder→get_module() rangefinder→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 353 24. Référence de l'API de haut niveau YRangeFinder rangefinder→get_module_async() rangefinder→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 354 ) int get_quality( ) int get_quality( ) YRangeFinder target get_quality Retourne : un entier représentant une estimation de la quality de la mesure, sur la base de la dispersion mesurée En cas d'erreur, déclenche une exception ou retourne YRangeFinder.QUALITY_INVALID www.yoctopuce.com...
  • Page 355 ' 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 YRangeFinder.RANGEFINDERMODE_INVALID www.yoctopuce.com...
  • Page 356 à 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 357 ' 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 YRangeFinder.REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 358 ' 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 YRangeFinder.RESOLUTION_INVALID www.yoctopuce.com...
  • Page 359 ' 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 YRangeFinder.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 360 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YRangeFinder 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 361 ) YRangeFinder target get_timeFrame Retourne : un entier représentant la fenêtre temporelle, en millisecondes, utilisée pour la mesure de distance et l'évaluation de la fiabilité de la mesure En cas d'erreur, déclenche une exception ou retourne YRangeFinder.TIMEFRAME_INVALID www.yoctopuce.com...
  • Page 362 ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YRangeFinder target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la distance est exprimée En cas d'erreur, déclenche une exception ou retourne YRangeFinder.UNIT_INVALID www.yoctopuce.com...
  • Page 363 ) 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 364 Si les valeurs des attributs en cache du capteur de distance 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 distance est joignable, sinon www.yoctopuce.com...
  • Page 365 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 366 ) YRangeFinder 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 367 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 368 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 369 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 370 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 371 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 372 é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 373 é c i f i q u e , u t i l i s e z RangeFinder.findRangeFinder() avec un hardwareID ou un nom logique. Retourne : YRangeFinder null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 374 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 375 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 376 Y R a n g e F i n d e r . A D V M O D E _ P E R I O D _ M I N YRangeFinder.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 377 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 378 ê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 379 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de distance. 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 380 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 381 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 382 ê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 383 ê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 384 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 385 Paramètres : newval une chaîne de caractères représentant l'unité dans laquelle la distance mesurée 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 386 $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 387 ) int startDataLogger( ) int startDataLogger( ) YRangeFinder 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 388 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YRangeFinder target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 389 à suivre exacte. Paramètres : targetDist distance réelle de la cible, en mm ou en pouce selon l'unité configuré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 390 Référez-vous au chapitre de la documentation concernant la calibration pour compenser l'effet d'une vitre pour les détails sur la marche à suivre exacte. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 391 8°C. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 392 à suivre exacte. Paramètres : targetDist distance réelle de la cible, en mm ou en pouce selon l'unité configuré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 393 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 394 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 395: 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 396 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 397 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 398 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 399 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 400 à 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 401 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 402 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 403 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 404 à 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 405 24. 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 406 24. 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 407 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 408 24. 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 409 24. 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 410 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 411 "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 412 24. 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 413 "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 414 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 415 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 416 24. 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 417 24. 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 418 ê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 419 ) 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 420 è 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 421 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 422 ' 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 423 ' 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 424 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 425 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 426 ) 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 427 ) 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 428 ' 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 429 é 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 430 ' 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 431 ' 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 432 ' 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 433 ' 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 434 ' 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 435 ' 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 436 24. 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 437 24. 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 438 à 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 439 ' 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 440 ' 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 441 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YTemperature.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 442 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YTemperature.SENSORTYPE_INVALID www.yoctopuce.com...
  • Page 443 ): 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 444 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YTemperature.SIGNALUNIT_INVALID www.yoctopuce.com...
  • Page 445 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YTemperature.SIGNALVALUE_INVALID www.yoctopuce.com...
  • Page 446 ): 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 447 ) 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 448 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 449 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 450 ) 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 451 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 452 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 453 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 454 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 455 (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 456 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 457 é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 458 é 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 459 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 460 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 461 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 462 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 463 ê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 464 ê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 465 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 466 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 467 ê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 468 ê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 469 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 470 (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 471 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 472 $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 473 ) 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 474 ) 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 475 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 476 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 477: La Classe Ylightsensor

    Interface pour intéragir avec les capteurs de lumière, disponibles par exemple dans le Yocto-Light-V3, le Yocto-Proximity et le Yocto-RangeFinder La classe permet de lire et de configurer les capteurs de lumière Yoctopuce. Elle YLightSensor hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.
  • Page 478 Retourne la valeur actuelle de la lumière ambiante, en l'unité spécifiée, sous forme de nombre à virgule. lightsensor→get_dataLogger() YDatalogger Retourne l'objet du module qui héberge le senseur. lightsensor→get_errorMessage() Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du capteur de lumière. www.yoctopuce.com...
  • Page 479 Retourne la valeur minimale observée pour la lumière ambiante depuis le démarrage du module. lightsensor→get_measureType() Retourne le type de mesure de lumière utilisé par le module. lightsensor→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. lightsensor→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. lightsensor→get_recordedData(startTime, endTime)
  • Page 480 Modifie la résolution des valeurs physique mesurées. lightsensor→set_userData(data) Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData lightsensor→startDataLogger() Démarre l'enregistreur de données du module. lightsensor→stopDataLogger() www.yoctopuce.com...
  • Page 481 Arrête l'enregistreur de données du module. lightsensor→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. lightsensor→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 482 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur de lumière sans ambiguïté, par exemple LIGHTMK3.lightSensor Retourne : YLightSensor un objet de classe qui permet ensuite de contrôler le capteur de lumière. www.yoctopuce.com...
  • Page 483 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le capteur de lumière sans ambiguïté, par exemple LIGHTMK3.lightSensor Retourne : YLightSensor un objet de classe qui permet ensuite de contrôler le capteur de lumière. www.yoctopuce.com...
  • Page 484 YLightSensor.nextLightSensor() lumière. Retourne : un pointeur sur un objet YLightSensor , correspondant au premier capteur de lumière accessible en null ligne, ou si il n'y a pas de capteurs de lumière disponibles. www.yoctopuce.com...
  • Page 485 YLightSensor.nextLightSensor() lumière. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YLightSensor , correspondant au premier capteur de lumière accessible en null ligne, ou si il n'y a pas de capteurs de lumière disponibles. www.yoctopuce.com...
  • Page 486 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YLightSensor.FindLightSensor 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 487 24. Référence de l'API de haut niveau YLightSensor lightsensor→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 488 24. Référence de l'API de haut niveau YLightSensor lightsensor→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 489 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 490 24. Référence de l'API de haut niveau YLightSensor lightsensor→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 491 24. Référence de l'API de haut niveau YLightSensor lightsensor→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 492 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 493 "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 494 24. Référence de l'API de haut niveau YLightSensor lightsensor→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 495 Modifiable. Modifie le type dde mesure de lumière effectuée par le capteur. La mesure peut soit approximer la réponse de l'oeil humain, soit donner une valeur ciblant un spectre particulier, en fonction des possibilités offertes par le récepteur de lumière. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 496 "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 497 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 498 24. Référence de l'API de haut niveau YLightSensor lightsensor→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 499 YLightSensor target calibrate calibratedVal Paramètres : calibratedVal la consigne de valeur désiré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 500 ê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 501 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du capteur de lumière. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 502 î n e c a r a c t è r e s d é c r i v a n t c a p t e u r l u m i è r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 503 YLightSensor.ADVMODE_PERIOD_AVG YLightSensor.ADVMODE_PERIOD_MIN YLightSensor.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 YLightSensor.ADVMODE_INVALID www.yoctopuce.com...
  • Page 504 ' 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 YLightSensor.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 505 ' 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 YLightSensor.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 506 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 507 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 508 ) 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 lumière.
  • Page 509 ) 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 lumière.
  • Page 510 ' 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 YLightSensor.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 511 é 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 512 ' 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 YLightSensor.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 513 ' 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 YLightSensor.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 514 ' 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 YLightSensor.HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 515 ' 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 YLightSensor.LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 516 ' 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 YLightSensor.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 517 ' 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 YLightSensor.LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 518 ' 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 YLightSensor.MEASURETYPE_INVALID www.yoctopuce.com...
  • Page 519 24. Référence de l'API de haut niveau YLightSensor lightsensor→get_module() lightsensor→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 520 24. Référence de l'API de haut niveau YLightSensor lightsensor→get_module_async() lightsensor→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 521 à 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 522 ' 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 YLightSensor.REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 523 ' 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 YLightSensor.RESOLUTION_INVALID www.yoctopuce.com...
  • Page 524 ' 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 YLightSensor.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 525 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YLightSensor 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 526 ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) YLightSensor target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la lumière ambiante est exprimée En cas d'erreur, déclenche une exception ou retourne YLightSensor.UNIT_INVALID www.yoctopuce.com...
  • Page 527 ) 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 528 Si les valeurs des attributs en cache du capteur de lumière 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 lumière est joignable, sinon www.yoctopuce.com...
  • Page 529 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 530 ) YLightSensor 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 531 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 532 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 533 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 534 Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 535 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 536 é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 537 é c i f i q u e , u t i l i s e z LightSensor.findLightSensor() avec un hardwareID ou un nom logique. Retourne : YLightSensor null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 538 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 539 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 540 Y L i g h t S e n s o r . A D V M O D E _ P E R I O D _ M I N YLightSensor.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 541 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 542 ê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 543 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de lumière. 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 544 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 545 Y L i g h t S e n s o r . M E A S U R E T Y P E _ H I G H _ E N E R G Y YLightSensor.MEASURETYPE_HIGH_RESOLUTION représentant le type dde mesure de lumière effectuée par le capteur Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 546 ê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 547 ê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 548 $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 549 ) int startDataLogger( ) int startDataLogger( ) YLightSensor 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 550 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YLightSensor target stopDataLogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 551 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 552 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 553: La Classe Ydatalogger

    24. Référence de l'API de haut niveau 24.6. 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 554 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 555 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 556 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 557 à 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 558 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 559 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 560 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 561 à 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 562 24. Référence de l'API de haut niveau YDataLogger datalogger→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 563 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 564 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 565 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 566 24. Référence de l'API de haut niveau YDataLogger datalogger→FunctionId Identifiant matériel de l'enregistreur de données, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 567 24. Référence de l'API de haut niveau YDataLogger datalogger→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 568 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 569 24. Référence de l'API de haut niveau YDataLogger datalogger→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 570 24. Référence de l'API de haut niveau YDataLogger datalogger→Recording état d'activation de l'enregistreur de données. int Recording Modifiable. www.yoctopuce.com...
  • Page 571 24. Référence de l'API de haut niveau YDataLogger datalogger→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 572 ) 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 573 è 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 574 ) 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 575 ' 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 576 ) 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 577 ' 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 578 ' 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 579 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 580 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 581 ) 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 582 ) 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 583 ' 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 584 é 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 585 ) 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 586 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 587 ' 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 588 24. Référence de l'API de haut niveau YDataLogger datalogger→get_module() datalogger→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 589 24. Référence de l'API de haut niveau YDataLogger datalogger→get_module_async() datalogger→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 590 ): 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 591 ): 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 592 ): 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 593 ) 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 594 ) 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 595 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 596 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 597 ) 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 598 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 599 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 600 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 601 é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 602 é 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 603 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 604 , 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 605 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 606 ê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 607 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 608 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 609 $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 610 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 611 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 612: 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 613 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 614 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 615 à 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 616 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 617 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 618 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 619 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 620 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 621 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 622 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 623 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 624 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 625 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 626 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 627 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 628 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 629 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 630 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 631 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 632 24. Référence de l'API de haut niveau YDataSet dataset→get_previewRecordCount() dataset→previewRecordCount() Retourne le nombre d'entrées dans la version résumée des mesures qui pourront être obtenues dans ce YDataSet Retourne : un nombre entier correspondant au nombre d'entrées dans le résumé. www.yoctopuce.com...
  • Page 633 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 634 , 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 635 à 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 636 - 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 637 24. Référence de l'API de haut niveau YDataSet dataset→get_summaryAvg() dataset→summaryAvg() Retourne la valeur moyenne observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 638 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 639 24. Référence de l'API de haut niveau YDataSet dataset→get_summaryMax() dataset→summaryMax() Retourne la plus grande valeur observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 640 24. Référence de l'API de haut niveau YDataSet dataset→get_summaryMin() dataset→summaryMin() Retourne la plus petite valeur observée durant l'intervalle de temps couvert par ce DataSet Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 641 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 642 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 643 ) 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 644 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 645: 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 646 ): 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 647 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 648 ): 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 649 ): 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 650 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 651: Problèmes Courants

    25.1. Par où commencer ? Si c'est la première fois que vous utilisez un module Yoctopuce et ne savez pas trop par où commencer, allez donc jeter un coup d'œil sur le blog de Yoctopuce. Il y a une section dédiée aux débutants 25.2.

  • Page 652: Plateformes Arm: Hf Et El

    25.5. Module alimenté mais invisible pour l'OS Si votre Yocto-RangeFinder 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 653: Déconnexions, Comportement Erratique

    Yocto-RangeFinder ne fonctionne plus, commencez par contacter le support Yoctopuce par e- mail pour poser un diagnostic. Même si c'est suite à une mauvaise manipulation que le module a été endommagé, il se peut que Yoctopuce puisse le réparer, et ainsi éviter de créer un déchet électronique.
  • Page 654 www.yoctopuce.com...

  • Page 655: Caractéristiques

    26. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module Yocto-RangeFinder Identifiant produit YRNGFND1 † Révision matérielle Connecteur USB micro-B Largeur 20 mm Longueur 58 mm Poids Chipset VL53L0X Précision max Distance max 2 m (~6%) Angle de vue 25 °...
  • Page 656 26. Caractéristiques www.yoctopuce.com...

Table des Matières