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

Yoctopuce Yocto-Serial Mode D'emploi

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

Publicité

Liens rapides

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

Publicité

Table des Matières
loading

Manuels Connexes pour Yoctopuce Yocto-Serial

Sommaire des Matières pour Yoctopuce Yocto-Serial

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

  • Page 3: Table Des Matières

    5.5. Protocole MODBUS ......................5.6. Protocole Wiegand ......................5.7. Flux de données ASCII ...................... 5.8. Flux de données binaires ....................5.9. Analyseur de communication série ................. 6. Mesures automatiques ..................... 6.1. Les jobs de communication ....................6.2. Les tâches .......................... www.yoctopuce.com...
  • Page 4 9. Utilisation du Yocto-Serial en JavaScript / EcmaScript ......... 9.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ........9.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ....... 9.3. Contrôle de la fonction SerialPort ..................9.4. Contrôle de la partie module ....................
  • Page 5 13.5. Gestion des erreurs ......................14. Utilisation du Yocto-Serial en C# ................14.1. Installation ........................14.2. Utilisation l'API yoctopuce dans un projet Visual C# ........... 14.3. Contrôle de la fonction SerialPort .................. 14.4. Contrôle de la partie module ..................14.5. Gestion des erreurs .......................
  • Page 6 20.8. Énumération de fonctions ..................... 20.9. Un mot sur les performances ..................20.10. Un exemple complet de programme LabVIEW ............20.11. Différences avec les autres API Yoctopuce .............. 21. Utilisation avec des langages non supportés ..........21.1. Utilisation en ligne de commande ................

  • Page 7: Introduction

    équipé d'une sortie série en l'équivalent software d'un capteur Yoctopuce, datalogger compris. Attention, le Yocto-Serial n'est pas un adaptateur série vers USB classique: il ne crée pas de port COM virtuel, il ne peut donc pas être utilisé avec une application conçue pour utilisé un port COM.

  • Page 8: Informations De Sécurité

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

  • Page 9: Environnement

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

    COM virtuel dont l'identité varie au gré du temps. A la place de cela, le Yocto-Serial gère de manière autonome le port série: il est doté de tampons de 16KB en court-court-court long-long-long court-court-court support@yoctopuce.com...

  • Page 13: Les Leds D'activité

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

  • Page 15: 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 16: Test De La Connectivité Usb

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

  • Page 17: Localisation

    3.4. Test du module La première chose à vérifier est le bon fonctionnement de votre module: cliquez sur le numéro de série correspondant à votre module, et une fenêtre résumant les propriétés de votre Yocto-Serial. Propriétés du module Yocto-Serial. Cette fenêtre vous permet, entre autres, de jouer avec votre module pour en vérifier son fonctionnement: vous y trouverez un émulateur de terminal simplifié...

  • Page 18: Configuration

    HTML si nécessaire, à l'aide du bouton Save, pour être ensuite réouverte telle quelle à l'aide de n'importe quel navigateur. 3.5. Configuration Si, dans la liste de modules, vous cliquez sur le bouton configure correspondant à votre module, la fenêtre de configuration apparaît. Configuration du module Yocto-Serial. www.yoctopuce.com...

  • Page 19: 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 20: Configuration De L'alimentation

    3. Premiers pas Configuration de l'alimentation Le Yocto-Serial dispose d'une sortie capable d'alimenter le circuit connecté au port série en 3.3V ou 5V. Vous pouvez compter sur 200mA en 3.3V et 450mA en 5V. Ce réglage est sauvé dans la mémoire flash, vérifiez soigneusement le voltage de l'alimentation avant de connecter un nouveau circuit.

  • Page 21: Montage Et Connectique

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

  • Page 22: 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 23 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 24 www.yoctopuce.com...

  • Page 25: Le Port Série

    5. Le port série Contrairement aux adaptateurs de port série classiques, le port série du Yocto-Serial n'est pas une simple passerelle vers un port COM virtuel. Il est basé sur une gestion active de la communication par le module, et offre une interface de programmation complète semblable à tous les modules Yoctopuce.

  • Page 26: Paramètres Configurables

    Attention, si le contrôle de flux matériel est activé dans le Yocto-Serial mais que la ligne CTS n'est pas câblée ou pas gérée par l'appareil en face, la transmission sera bloquée. C'est pourquoi le contrôle de flux n'est pas activé dans la configuration par défaut.

  • Page 27: Protocole Basé Sur Des Trames Binaires

    être ici utilisée. Le Yocto-Serial est capable de séparer les différents messages reçus grâce à la mesure du délai entre la réception des octets successifs. Lorsque vous choisissez un protocole basé sur des trames binaires, vous pouvez spécifier l'espacement délimitant la séparation entre deux trames.

  • Page 28: Protocole Wiegand

    (appelés bits, ou "coils") et de mots de 16 bits. Il s'agit systématiquement d'un échange initié par l'hôte, et auquel l'appareil "esclave" répond. Le Yocto-Serial gère de manière transparente le mode ASCII ou RTU, et calcule lui-même les octets de validations (LRC et CRC) spécifiés dans le protocole MODBUS.

  • Page 29: Flux De Données Binaires

    5.9. Analyseur de communication série Le Yocto-Serial peut être utilisé comme un analyseur de protocole série en le branchant sur le câble qui relie directement deux appareils communiquant par protocole série. Dans ce mode spécial, les signaux en émission du Yocto-Serial ne sont pas câblés (garantissant un fonctionnement sans perturbation), et les lignes TD et RD à...
  • Page 30 www.yoctopuce.com...

  • Page 31: Mesures Automatiques

    Serial permet de choisir quel job exécuter, tandis que la fenêtre de configuration permet de définir quel job doit être exécuté au démarrage du module. Le Yocto-Serial n'exécute qu'un seul job à la fois, mais un job peut faire plusieurs choses en parallèle.
  • Page 32 Yocto-Serial. Pour configurer Yocto-Serial par software, il suffi donc d'uploader le bon fichier sur le Yocto-Serial à l'aide de la classe YFiles et de programmer son exécution à l'aide des fonctions selectJob() ou set_startupJob() de la classe YSerialPort.

  • Page 33: Les Tâches

    : les tâches réactives et les tâches périodiques. Les tâches réactives Une tâche réactives est déclenchée à l'initiative de l'appareil connecté au Yocto-Serial: la tâche est lancée automatiquement dès que des données correspondant à un pattern prédéfini apparaissent sur le port. Le plus souvent, la tâche consiste simplement à interpréter ces données et à les affecter à...

  • Page 34: Les Tâches Périodiques

    Il est possible de mixer tâches périodiques et tâches réactives dans un même job, mais il conviendra d'être particulièrement attentif à leurs conditions de déclenchement afin d'éviter qu'elles ne se perturbent les unes les autres. Le Yocto-Serial attend toujours qu'une tâche périodique se termine www.yoctopuce.com...

  • Page 35: Les Commandes

    6.3. Les commandes Les commandes qui peuvent être utilisées dans une tâche (périodique ou réactive) des modules Yoctopuce gérant une transmission série sont les suivantes: EXPECT La commande expect attend que des données correspondant à un certain pattern apparaissent sur la ligne série.
  • Page 36 La représentation des nombres flottants étant limitée à 3 décimales dans les modules Yoctopuce, il est possible de convertir l'ordre de grandeur des nombres flottants lus par les expressions FLOAT, FLOAT16 et FLOAT32 en les préfixant d'un M pour retourner des millièmes, un U pour les...
  • Page 37 La commande wait permet d'attendre un certain nombre de millisecondes avant de passer à la commande suivante. La commande log permet d'afficher une chaîne de caractères dans les log du Yocto-Serial. WRITE La commande write permet d'envoyer une chaîne de caractères telle-quelle sur la ligne série. La chaîne est envoyée sans retour de chariot additionnel.

  • Page 38: Les Fonctions Genericsensor

    6. Mesures automatiques SETPOWER La commande setPower, disponible uniquement sur le Yocto-Serial et le Yocto-SPI, permet de commander automatiquement l'état de la sortie d'alimentation du module via une tâche, par exemple pour mettre en/hors tension un capteur externe. Si, pour une raison ou une autre, une commande génère une erreur, vous trouverez une trace de cette erreur dans les logs du Yocto-Serial.

  • Page 39: Exemple De Configuration

    Le code suivant la lettre e est un code d'erreur éventuel. Étape 1 Configurer le Yocto-Serial pour fournir une alimentation 5V au capteur, et pour une communication en "Line-based ASCII protocol", 9600, 8N1, avec des signaux en TTL 3.3V.
  • Page 40 Étape 3 Lancer le job et vérifier qu'il fonctionne en faisant apparaître les fonctions de chaque module dans la page principale du VirtualHub. Si le résultat ne correspond pas à ce qui était prévu, consulter les logs du module. www.yoctopuce.com...

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

    7.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 42: 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 43: Le Module Yocto-Serial

    Inversement, la classe YModule dispose d'un certain nombre de méthodes permettant d'énumérer les fonctionnalités disponibles sur un module. 7.2. Le module Yocto-Serial Le module Yocto-Serial est une interface série TTL autonome, avec datalogger intégré. module : Module attribut type...

  • Page 44: Module

    : Files attribut type modifiable ? Texte lecture seule logicalName Texte lecture seule advertisedValue Nombre entier lecture seule filesCount Nombre entier lecture seule freeSpace 7.3. Module Interface de contrôle des paramètres généraux des modules Yoctopuce www.yoctopuce.com...
  • Page 45 Chaine de caractères contenant le numéro de série, unique et préprogrammé en usine. Pour un module Yocto-Serial, ce numéro de série commence toujours par YSERIAL1. Il peut servir comme point de départ pour accéder par programmation à un module particulier.

  • Page 46: Serialport

    (vitesse, nombre de bits, parité, contrôle de flux et protocole). Notez que les interfaces série Yoctopuce ne sont pas visibles comme des ports COM virtuels. Ils sont faits pour être utilisés comme tous les autres modules Yoctopuce.

  • Page 47: Poweroutput

    Taux de transfert, nombre de bits, parité et bits d'arrêt. 7.5. PowerOutput Interface pour intéragir avec les sources d'alimentation, disponibles par exemple dans le Yocto-I2C, le Yocto-MaxiMicroVolt-Rx, le Yocto-SPI et le Yocto-Serial La classe permet de contrôler l'alimentation mise a disposition sur certain module YPowerOutput Yoctopuce.
  • Page 48 Etat du capteur (zero lorsque qu'une mesure actuelle est disponible). signalValue Valeur actuelle du signal électrique mesuré par le capteur, sous forme de nombre à virgule. signalUnit Courte chaîne de catactères représentant l'unité du signal électrique utilisé par le capteur. www.yoctopuce.com...

  • Page 49: Datalogger

    Activation/désactivation de la mesure. 7.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 ordinateur.

  • Page 50: Files

    Interface pour intéragir avec les systèmes de fichier, disponibles par exemple dans le Yocto-Buzzer, le Yocto-Color-V2, le Yocto-RS485-V2 et le YoctoHub-Ethernet La class YFiles permet d'accéder au système de fichier embarqué sur certains modules Yoctopuce. Le stockage de fichiers permet par exemple de personnaliser un service web (dans le cas d'un module connecté...

  • Page 51: Contrôle Natif

    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 52 ✔ VisualBasic .Net ✔ ✔ C# .Net ✔ ✔ C# UWP ✔ EcmaScript / JavaScript ✔ ✔ ✔ Java ✔ ✔ Java pour Android ✔ ✔ Ligne de commande ✔ ✔ LabVIEW Méthode de support pour les différents langages. www.yoctopuce.com...

  • Page 53: Limitation Des Librairies Yoctopuce

    Arrivé à ce point du manuel, vous devriez connaître l'essentiel de la théorie à propos de votre Yocto- Serial. 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 54 www.yoctopuce.com...

  • Page 55: Utilisation Du Yocto-Serial En Ligne De Commande

    à votre plateforme/OS dans le répertoire de votre choix. Ajoutez éventuellement ce répertoire à votre variable environnement PATH pour avoir accès aux exécutables depuis n'importe où. C'est tout, il ne vous reste plus qu'à brancher votre Yocto-Serial, ouvrir un shell et commencer à travailler en tapant par exemple: C:\>YSerialPort...

  • Page 56: Contrôle De La Fonction Serialport

    C:\>executable commande /help Pour obtenir une description détaillée des paramètres d'une commande. 8.3. Contrôle de la fonction SerialPort Pour contrôler la fonction SerialPort de votre Yocto-Serial, vous avez besoin de l'exécutable YSerialPort. Vous pouvez par exemple lancer: C:\>YSerialPort set_serialMode "9600,8N1"...

  • Page 57: Contrôle De La Partie Module

    8. Utilisation du Yocto-Serial en ligne de commande C:\>YSerialPort describe Pour plus de détails sur les possibilités de l'exécutable , utilisez: YSerialPort C:\>YSerialPort /help 8.4. Contrôle de la partie module Chaque module peut être contrôlé d'une manière similaire à l'aide de l'exécutable .
  • Page 58 8. Utilisation du Yocto-Serial en ligne de commande Cette limitation peut aisément être contournée en utilisant un Virtual Hub: il suffit de faire tourner le VirtualHub sur la machine concernée et d'utiliser les executables de l'API en ligne de commande...

  • Page 59: Utilisation Du Yocto-Serial 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 60: Fonctions Bloquantes Et Fonctions Asynchrones En Javascript

    9. Utilisation du Yocto-Serial en JavaScript / EcmaScript 9.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 61: 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 62: Compatibilité Avec L'ancienne Librairie Javascript

    9. Utilisation du Yocto-Serial 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 63: Contrôle De La Fonction Serialport

    Ce dernier appel asynchrone peut aussi être formulé comme: myModule.get_syncProxy().then(logInfoProxy); 9.3. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code JavaScript qui utilise la fonction SerialPort. // En Node.js, on utilise la fonction require() // En HTML, on utiliserait <script src="...">...

  • Page 64: Un Exemple Concret, En Node.js

    à en faire un petit programme d'exemple concret. Si le Yocto-Serial 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 65: 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-Serial. Vous y trouverez un fichier html, avec une section JavaScript similaire au code précédent, mais avec quelques variantes pour permettre une interaction à...
  • Page 66 9. Utilisation du Yocto-Serial en JavaScript / EcmaScript <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Hello World</title> <script src="../../lib/yocto_api.js"></script> <script src="../../lib/yocto_serialport.js"></script> <script> let serialPort; async function startDemo() { await YAPI.LogUnhandledPromiseRejections(); await YAPI.DisableExceptions(); // Setup the API to use the VirtualHub on local machine let errmsg = new YErrorMsg();...

  • Page 67: Contrôle De La Partie Module

    9. Utilisation du Yocto-Serial en JavaScript / EcmaScript 9.4. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.

  • Page 68: Énumération Des Modules

    9. Utilisation du Yocto-Serial en JavaScript / EcmaScript async function startDemo(args) await YAPI.LogUnhandledPromiseRejections(); // Setup the API to use the VirtualHub on local machine errmsg = new YErrorMsg(); if(await YAPI.RegisterHub('127.0.0.1', errmsg) != YAPI.SUCCESS) { console.log('Cannot contact VirtualHub on 127.0.0.1: '+errmsg.msg);...

  • Page 69: 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 70 9. Utilisation du Yocto-Serial en JavaScript / EcmaScript 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 71: Utilisation Du Yocto-Serial En Php

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

  • Page 73: Un Exemple Réel

    10. Utilisation du Yocto-Serial en PHP writeLine La méthode transmet la chaîne spécifiée sur le port série, suivie par un saut de ligne writeLine() (CR/LF). Un exemple réel Ouvrez votre éditeur de texte préféré , recopiez le code ci dessous, sauvez-le dans un répertoire accessible par votre serveur web/PHP avec les fichiers de la librairie, et ouvrez-la page avec votre browser favori.

  • Page 74: Contrôle De La Partie Module

    10. Utilisation du Yocto-Serial en PHP 10.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 75 10. Utilisation du Yocto-Serial en PHP Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire vive du set_xxx() module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration...

  • Page 76: 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 77 10. Utilisation du Yocto-Serial en PHP seule adresse IP officielle, attribuée au routeur DSL exclusivement. Les différents appareils réseau ne sont pas directement atteignables depuis l'extérieur. C'est assez contraignant, mais c'est une protection relativement efficace contre les intrusions. Les réponses aux requêtes venant des machines du LAN sont routées.
  • Page 78 10. Utilisation du Yocto-Serial 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 79: Utilisation

    VirtualHub pour fonctionner. Pour coder un site Web qui contrôle des modules Yoctopuce de manière interactive, il faudra créer une interface utilisateur qui stockera dans un fichier ou une base de données les actions à effectuer sur les modules Yoctopuce. Ces actions seront ensuite lues puis exécutés par le script de contrôle.
  • Page 80 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 81: Utilisation Du Yocto-Serial En C

    à la création d'un projet à neuf linké avec les librairies Yoctopuce. 11.1. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code C++ qui utilise la fonction SerialPort. #include "yocto_api.h"...
  • Page 82 Yoctopuce. doit toujours être utilisé, est nécessaire pour yocto_api.h yocto_serialport.h gérer les modules contenant un port série, comme le Yocto-Serial. YAPI::RegisterHub La fonction initialise l'API de Yoctopuce en indiquant où les modules YAPI::RegisterHub doivent être recherchés. Utilisée avec le paramètre , elle permet de travailler avec les "usb"...
  • Page 83 11. Utilisation du Yocto-Serial en C++ Un exemple réel Lancez votre environnement C++ et ouvrez le projet exemple correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Serial de la librairie Yoctopuce. Si vous préférez travailler avec votre éditeur de texte préféré, ouvrez le fichier , vous taperez simplement main.cpp...

  • Page 84: Contrôle De La Partie Module

    11. Utilisation du Yocto-Serial en C++ 11.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 85 11. Utilisation du Yocto-Serial 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 86: 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 87: 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 88: Intégration En Librairie Dynamique

    11. Utilisation du Yocto-Serial 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 89: Utilisation Du Yocto-Serial En Objective-C

    à vos projets. 12.1. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code Objective-C qui utilise la fonction SerialPort. #import "yocto_api.h"...
  • Page 90 Yoctopuce. doit toujours être utilisé, est nécessaire pour yocto_api.h yocto_serialport.h gérer les modules contenant un port série, comme le Yocto-Serial. [YAPI RegisterHub] La fonction initialise l'API de Yoctopuce en indiquant où les modules [YAPI RegisterHub] doivent être recherchés. Utilisée avec le paramètre , elle permet de travailler avec les @"usb"...

  • Page 91: Contrôle De La Partie Module

    12. Utilisation du Yocto-Serial en Objective-C Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret. #import <Foundation/Foundation.h> #import "yocto_api.h" #import "yocto_serialport.h" int main(int argc,...
  • Page 92 12. Utilisation du Yocto-Serial en Objective-C NSLog(@"usage: %s <serial or logical name> [ON/OFF]\n", exe); 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:...
  • Page 93 12. Utilisation du Yocto-Serial 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 94: 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 95: Utilisation Du Yocto-Serial En Visualbasic .Net

    13.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 96: Contrôle De La Fonction Serialport

    13.3. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction SerialPort. [...] ' On active la détection des modules sur USB...
  • Page 97 13. Utilisation du Yocto-Serial en VisualBasic .NET renvoie un objet que vous pouvez ensuite utiliser à loisir pour YSerialPort.FindSerialPort contrôler le port série. isOnline La méthode de l'objet renvoyé par permet de isOnline() YSerialPort.FindSerialPort savoir si le module correspondant est présent et en état de marche.

  • Page 98: Contrôle De La Partie Module

    13. Utilisation du Yocto-Serial en VisualBasic .NET serialPort.set_protocol("Line") serialPort.reset() Console.WriteLine("****************************") Console.WriteLine("* make sure voltage levels *") Console.WriteLine("* are properly configured *") Console.WriteLine("****************************") YAPI.Sleep(500, errmsg) line = serialPort.readLine() (line <> "") Then Console.WriteLine("Received: " + line) End If Loop While (line <>...
  • Page 99 13. Utilisation du Yocto-Serial en VisualBasic .NET End If YAPI.FreeAPI() End Sub End Module Chaque propriété du module peut être lue grâce à une méthode du type , et les get_xxxx() propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode set_xxx Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux chapitre API...

  • Page 100: 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 101 13. Utilisation du Yocto-Serial en VisualBasic .NET d'erreur pour chaque fonction est systématiquement documenté dans la référence de la librairie. Il suit toujours même logique: méthode retournera valeur get_state() méthode retournera valeur Y_STATE_INVALID get_currentValue , etc. Dans tous les cas, la valeur retournée sera du type attendu, et Y_CURRENTVALUE_INVALID ne sera pas un pointeur nul qui risquerait de faire crasher votre programme.
  • Page 102 www.yoctopuce.com...

  • Page 103: Utilisation Du Yocto-Serial En C

    14.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 104: Contrôle De La Fonction Serialport

    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. 14.3. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code C# qui utilise la fonction SerialPort. [...] // On active la détection des modules sur USB...
  • Page 105 14. Utilisation du Yocto-Serial en C# serialport = YSerialPort.FindSerialPort("MonModule.MaFonction"); serialport = YSerialPort.FindSerialPort("MaFonction"); renvoie un objet que vous pouvez ensuite utiliser à loisir pour YSerialPort.FindSerialPort contrôler le port série. isOnline La méthode de l'objet renvoyé par permet de isOnline() YSerialPort.FindSerialPort savoir si le module correspondant est présent et en état de marche.

  • Page 106: Contrôle De La Partie Module

    14. Utilisation du Yocto-Serial en C# Console.WriteLine("* are properly configured *"); Console.WriteLine("****************************"); serialPort.set_serialMode("9600,8N1"); serialPort.set_protocol("Line"); serialPort.reset(); string line; do { YAPI.Sleep(500, ref errmsg); do { line = serialPort.readLine(); (line != "") { Console.WriteLine("Received: " + line); } while (line != "");...
  • Page 107 14. Utilisation du Yocto-Serial en C# Console.WriteLine("serial: " + m.get_serialNumber()); Console.WriteLine("logical name: " + m.get_logicalName()); Console.WriteLine("luminosity: " + m.get_luminosity().ToString()); Console.Write("beacon: "); if (m.get_beacon() == YModule.BEACON_ON) Console.WriteLine("ON"); else Console.WriteLine("OFF"); Console.WriteLine("upTime: " + (m.get_upTime() / 1000 ).ToString() + " sec"); Console.WriteLine("USB current: "...

  • Page 108: Gestion Des Erreurs

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

  • Page 111: Utilisation Du Yocto-Serial 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 112: Installation

    15.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 113: Contrôle De La Fonction Serialport

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

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

    15. Utilisation du Yocto-Serial avec Universal Windows Platform await serialPort.reset(); string line; do { (ToSend != "") { await serialPort.writeLine(ToSend); ToSend = ""; await YAPI.Sleep(500); do { line = await serialPort.readLine(); (line != "") { WriteLine("Received: " + line); } while (line != "");...
  • Page 116 15. Utilisation du Yocto-Serial avec Universal Windows Platform WriteLine("Logs:\r\n" + await m.get_lastLogs()); } else { WriteLine(Target " not connected on" HubURL "(check identification and USB cable)"); YAPI.FreeAPI(); return 0; Chaque propriété du module peut être lue grâce à une méthode du type YModule.get_xxxx...

  • Page 117: 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 118 15. Utilisation du Yocto-Serial avec Universal Windows Platform Les exceptions lancées de la librairie sont toujours de type YAPI_Exception, ce qui permet facilement de les séparer des autres exceptions dans un bloc try{...} catch{...} Exemple: try { ..} catch...

  • Page 119: Utilisation Du Yocto-Serial En Delphi

    16.2. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code Delphi qui utilise la fonction SerialPort.
  • Page 120 [...] Voyons maintenant en détail ce que font ces quelques lignes. yocto_api et yocto_serialport Ces deux unités permettent d'avoir accès aux fonctions permettant de gérer les modules Yoctopuce. doit toujours être utilisé, est nécessaire pour gérer les modules yocto_api yocto_serialport contenant un port série, comme le Yocto-Serial.

  • Page 121: Un Exemple Réel

    16. Utilisation du Yocto-Serial en Delphi writeLine La méthode transmet la chaîne spécifiée sur le port série, suivie par un saut de ligne writeLine() (CR/LF). Un exemple réel Lancez votre environnement Delphi, copiez la DLL yapi.dll dans un répertoire et créez une nouvelle application console dans ce même répertoire, et copiez-coller le code ci dessous.

  • Page 122: Contrôle De La Partie Module

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

  • Page 124: 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 125 16. Utilisation du Yocto-Serial en Delphi ne sera pas un pointeur nul qui risquerait de faire crasher votre programme. Au pire, si vous affichez la valeur sans la tester, elle sera hors du cadre attendu pour la valeur retournée. Dans le cas de fonctions qui ne retournent à...
  • Page 126 www.yoctopuce.com...

  • Page 127: Utilisation Du Yocto-Serial 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 128 17. Utilisation du Yocto-Serial en Python Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code Python qui utilise la fonction SerialPort. [...] # On active la détection des modules sur USB errmsg=YRefParam() YAPI.RegisterHub("usb",errmsg)

  • Page 129: Contrôle De La Partie Module

    17. Utilisation du Yocto-Serial en Python Un exemple réel Lancez votre interpréteur Python et ouvrez le script correspondant, fourni dans le répertoire Examples/Doc-GettingStarted-Yocto-Serial 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 17. Utilisation du Yocto-Serial en Python sys.exit("RegisterHub error: " str(errmsg)) if len(sys.argv) < usage() = 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: "...

  • Page 131: Gestion Des Erreurs

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 132 17. Utilisation du Yocto-Serial en Python 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 133: Utilisation Du Yocto-Serial 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. 18.2. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code Java qui utilise la fonction SerialPort. [...] // On active l'accès aux modules locaux à...
  • Page 134 Voyons maintenant en détail ce que font ces quelques lignes. YAPI.RegisterHub La fonction initialise l'API de Yoctopuce en indiquant où les modules doivent YAPI.RegisterHub être recherchés. Le paramètre est l'adresse du virtual hub capable de voir les modules. Si l'initialisation se passe mal, une exception sera générée.

  • Page 135: Contrôle De La Partie Module

    18. Utilisation du Yocto-Serial en Java import java.io.InputStreamReader; public class Demo public static void main(String[] args) try { // setup the API to use local VirtualHub YAPI.RegisterHub("127.0.0.1"); } catch (YAPI_Exception ex) { System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" ex.getLocalizedMessage() + ")");...
  • Page 136 18. Utilisation du Yocto-Serial en Java try { // setup the API to use local VirtualHub YAPI.RegisterHub("127.0.0.1"); } catch (YAPI_Exception ex) { System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" ex.getLocalizedMessage() + ")"); System.out.println("Ensure that the VirtualHub application is running"); System.exit(1); System.out.println("usage: demo [serial or logical name] [ON/OFF]");...
  • Page 137 18. Utilisation du Yocto-Serial en Java // setup the API to use local VirtualHub YAPI.RegisterHub("127.0.0.1"); } catch (YAPI_Exception ex) { System.out.println("Cannot contact VirtualHub on 127.0.0.1 (" ex.getLocalizedMessage() + ")"); System.out.println("Ensure that the VirtualHub application is running"); System.exit(1); (args.length != 2) { System.out.println("usage: demo <serial or logical name>...

  • Page 138: 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 139: Utilisation Du Yocto-Serial 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 140: 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 141: Lancement Automatique

    19. Utilisation du Yocto-Serial 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 142: Contrôle De La Fonction Serialport

    19. Utilisation du Yocto-Serial avec Android 19.5. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-Serial. Voici le squelette d'un fragment de code Java qui utilise la fonction SerialPort. [...] // On active la détection des modules sur USB YAPI.EnableUSBHost(this);...
  • Page 143 19. Utilisation du Yocto-Serial avec Android readLine La méthode retourne la prochaine ligne de texte reçue sur le port série, jusqu'au readLine() prochain saut de ligne. La fonction est non-bloquante: si aucune ligne n'est disponible, elle retourne une chaîne vide.

  • Page 144: Contrôle De La Partie Module

    19. Utilisation du Yocto-Serial avec Android @Override protected void onStop() super.onStop(); YAPI.FreeAPI(); @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long String hwid = (String) parent.getItemAtPosition(pos); serialPort = YSerialPort.FindSerialPort(hwid); try { serialPort.set_serialMode("9600,8N1"); serialPort.set_protocol("Line"); serialPort.reset(); }catch (YAPI_Exception e) { e.printStackTrace(); @Override...
  • Page 145 19. Utilisation du Yocto-Serial avec Android import com.yoctopuce.YoctoAPI.YModule; public class ModuleControl extends Activity implements OnItemSelectedListener private ArrayAdapter<String> aa; private YModule module = null; @Override public void onCreate(Bundle savedInstanceState) super.onCreate(savedInstanceState); setContentView(R.layout.modulecontrol); Spinner my_spin = (Spinner) findViewById(R.id.spinner1); my_spin.setOnItemSelectedListener(this); = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_item);...
  • Page 146 19. Utilisation du Yocto-Serial avec Android String hwid = parent.getItemAtPosition(pos).toString(); module = YModule.FindModule(hwid); DisplayModuleInfo(); @Override public void onNothingSelected(AdapterView<?> arg0) public void refreshInfo(View view) DisplayModuleInfo(); public void toggleBeacon(View view) (module == null) return; boolean = ((Switch) view).isChecked(); try { if (on) { module.setBeacon(YModule.BEACON_ON);...
  • Page 147 19. Utilisation du Yocto-Serial avec Android public void onCreate(Bundle savedInstanceState) super.onCreate(savedInstanceState); setContentView(R.layout.savesettings); Spinner my_spin = (Spinner) findViewById(R.id.spinner1); my_spin.setOnItemSelectedListener(this); = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_item); aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item); my_spin.setAdapter(aa); @Override protected void onStart() super.onStart(); try { aa.clear(); YAPI.EnableUSBHost(this); YAPI.RegisterHub("usb"); YModule = YModule.FirstModule(); while != null) {...
  • Page 148 19. Utilisation du Yocto-Serial avec Android return; module.set_logicalName(newname); module.saveToFlash(); // do not forget this edit.setText(""); } catch (YAPI_Exception ex) { ex.printStackTrace(); DisplayModuleInfo(); Attention, le nombre de cycles d'écriture de la mémoire non volatile du module est limité. Passé cette limite plus rien ne garantit que la sauvegarde des réglages se passera correctement. Cette limite, liée à...

  • Page 149: 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 150 www.yoctopuce.com...

  • Page 151: Utilisation Du Yocto-Serial 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 152: 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 153 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 154: 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 155: 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 156 \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 157: Présentation Des Vis Yoctopuce

    Yoctopuce et avec tous les VIs de l'API 20.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 158: 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 159: 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 160: 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 161 20. Utilisation du Yocto-Serial 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 162: Utilisation Des Objets

    VI pour chacune d'entre elles. C'est pourquoi il y a un VI par classe qui expose les deux propriétés que Yoctopuce a jugé les plus utiles, mais cela ne veut pas dire que les autres ne sont pas accessibles.

  • Page 163: 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 164: Gestion Du Datalogger

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

    20. Utilisation du Yocto-Serial 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 166: Un Mot Sur Les Performances

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

    Yoctopuce pour LabVIEW 20.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 168 www.yoctopuce.com...

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

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

  • Page 180: L'enregistreur De Données

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

    à la même fréquence. Récupération des données Pour récupérer les données enregistrées dans la mémoire flash du Yocto-Serial, il faut appeler la méthode de la fonction désirée, en spécifiant l'intervalle de temps qui get_recordedData() nous intéresse.
  • Page 182 Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-Serial 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-Serial va automatiquement essayer de se mettre à...

  • Page 183: Calibration Des Senseurs

    Les modules Yoctopuce supportent deux types de calibration. D'une part une interpolation linéaire basée sur 1 à 5 points de référence, qui peut être effectuée directement à l'intérieur du Yocto-Serial. D'autre part l'API supporte une calibration arbitraire externe, implémentée à l'aide de callbacks.
  • Page 184 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 185: 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 186 22. Programmation avancée valeur avant de la renvoyer, permettant ainsi de corriger les mesures de manière totalement transparente. www.yoctopuce.com...

  • Page 187: 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 188: 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 189: 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 190: 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 191: 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-Serial. La syntaxe et les types précis peuvent varier d'un langage à l'autre mais, sauf avis contraire toutes sont disponibles dans chaque language. Pour une information plus précise sur les types des arguments et des valeurs de retour dans un langage donné, veuillez vous référer au fichier de définition pour ce...

  • Page 192: 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 193 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 194 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 195 . Lorsqu'on configure un nom logique avec une chaîne incorrecte, les caractères invalides sont ignorés. Paramètres : name une chaîne de caractères contenant le nom vérifier. Retourne : true si le nom est valide, false dans le cas contraire. www.yoctopuce.com...
  • Page 196 Désactive le cache de callback HTTP. function yClearHTTPCallbackCacheDir( $bool_removeFiles) Cette méthode désctive la cache de callback HTTP, et permet également d'en effacer le contenu. Paramètres : Vrai pour effacer le contenu du répertoire de cache. bool_removeFiles Retourne : nothing. www.yoctopuce.com...
  • Page 197 ) static void DisableExceptions( ) void DisableExceptions( ) DisableExceptions( ) function yDisableExceptions( ) 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 198 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 199 (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 200 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 yFreeAPI( ) +(void) FreeAPI...
  • Page 201 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 yGetAPIVersion( ) +(NSString*) GetAPIVersion string yGetAPIVersion( ): string function yGetAPIVersion( ) As String static String GetAPIVersion( ) static String GetAPIVersion( )
  • Page 202 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 203 ) As Integer int GetDeviceListValidity( ) int GetDeviceListValidity( ) java async Task<int> GetDeviceListValidity( ) GetDeviceListValidity( ) function yGetDeviceListValidity( ) 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 204 . 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 205 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 206 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) 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 207 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 208 GetTickCount( ) function yGetTickCount( ) 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 209 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 210 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 yInitAPI( int mode, string errmsg) +(YRETCODE) InitAPI :(int) mode :(NSError**) errmsg integer yInitAPI( mode: integer, var errmsg: string): integer...
  • Page 211 "usb","callback", ou l'URL racine du VirtualHub à utiliser. une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message errmsg d'erreur. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 212 RegisterDeviceArrivalCallback( DeviceUpdateHandler arrivalCallback) RegisterDeviceArrivalCallback( arrivalCallback) function yRegisterDeviceArrivalCallback( $arrivalCallback) async RegisterDeviceArrivalCallback( arrivalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : arrivalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
  • Page 213 RegisterDeviceRemovalCallback( DeviceUpdateHandler removalCallback) RegisterDeviceRemovalCallback( removalCallback) function yRegisterDeviceRemovalCallback( $removalCallback) 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 214 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 215 24. Référence de l'API de haut niveau 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 216 , 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 217 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 218 RegisterLogFunction( yLogFunc logfun) void RegisterLogFunction( LogCallback logfun) java void RegisterLogFunction( LogHandler logfun) RegisterLogFunction( logfun) async RegisterLogFunction( logfun) Utile pour débugger le fonctionnement de l'API. Paramètres : une procedure qui prend une chaîne de caractère en paramètre, logfun www.yoctopuce.com...
  • Page 219 à 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 220 USB. Ce paramètre n'affecte pas les callbacks de changement de valeur Note: Cette fonction doit être appelée après yInitAPI Paramètres : cacheValidityMs un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes. www.yoctopuce.com...
  • Page 221 (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 222 à un réseau GSM où le trafic est facturé. Ce paramètre n'affecte pas les modules connectés par USB, ni le fonctionnement des callback de connexion/déconnexion de module. Note: Cette fonction doit être appelée après yInitAPI Paramètres : deviceListValidity nombre de secondes entre chaque énumération. www.yoctopuce.com...
  • Page 223 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 224 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 225 à la durée de l'attente, en millisecondes des arguments supplémentaires peuvent être fournis, pour être passés à la fonction de args callback si nécessaire. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 226 ê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 227 à jour. yHandleEvents() Cette fonction peut signaler une erreur au cas à la communication avec un module Yoctopuce ne se passerait pas comme attendu. Paramètres : un entier correspondant à la durée de la pause, en millisecondes...
  • Page 228 é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 229 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 230 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 yUnregisterHub( string url) +(void) UnregisterHub :(NSString *) yUnregisterHub( url: string)
  • Page 231 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 yUpdateDeviceList( string errmsg) +(YRETCODE) UpdateDeviceList :(NSError**) errmsg integer yUpdateDeviceList( var errmsg: string): integer function yUpdateDeviceList( ByRef...
  • Page 232 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 233: 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 234 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module. module→get_firmwareRelease() Retourne la version du logiciel embarqué du module. module→get_functionIds(funType) Retourne les identifiants matériels des fonctions correspondant au type passé en argument. module→get_hardwareId() Retourne l'identifiant unique du module. module→get_icon2d() Retourne l'icône du module. module→get_lastLogs() www.yoctopuce.com...
  • Page 235 Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→load_async(msValidity, callback, context) Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→log(text) Ajoute un message arbitraire dans les logs du module. module→nextModule() www.yoctopuce.com...
  • Page 236 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 237 Retourne : un objet de classe YModule qui permet ensuite de contrôler le module ou d'obtenir de plus amples informations sur le module. www.yoctopuce.com...
  • Page 238 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le module sans ambiguïté, par exemple func MyDevice.module Retourne : un objet de classe YModule qui permet ensuite de contrôler le module. www.yoctopuce.com...
  • Page 239 ) static FirstModule( ) Utiliser la fonction pour itérer sur les autres modules. YModule.nextModule() Retourne : YModule null un pointeur sur un objet , correspondant au premier module accessible en ligne, ou aucun module n'a été trouvé. www.yoctopuce.com...
  • Page 240 24. Référence de l'API de haut niveau YModule module→Beacon état de la balise de localisation. int Beacon Valeurs possibles: Y_BEACON_INVALID Y_BEACON_OFF Y_BEACON_ON Modifiable. Allume ou éteint la balise de localisation du module. www.yoctopuce.com...
  • Page 241 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 242 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 243 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 244 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 245 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 246 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 247 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 248 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 249 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 250 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 251 Retourne : .byn le path du fichier à utiliser, ou une chaîne vide si aucun firmware plus récent n'est disponible En cas d'erreur, déclenche une exception ou retourne une chaine de caractère qui comment par "error:". www.yoctopuce.com...
  • Page 252 ) void clearCache( ) java clearCache( ) function clearCache( ) 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 253 ) String describe( ) java describe( ) function describe( ) 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 254 $pathname) async download( pathname) byte[] download( string pathname) string download( string pathname) YModule target download pathname Paramètres : nom complet du fichier pathname Retourne : le contenu du fichier chargé En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
  • Page 255 à 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 256 ) As Integer int functionCount( ) int functionCount( ) java functionCount( ) function functionCount( ) 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 257 à 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 258 à 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 259 à 0 pour la functionIndex première fonction. Retourne : une chaîne de caractères correspondant au type de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 260 à 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 261 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 262 ) async get_beacon( ) int get_beacon( ) int get_beacon( ) YModule target get_beacon Retourne : soit Y_BEACON_OFF , soit Y_BEACON_ON , selon l'état de la balise de localisation En cas d'erreur, déclenche une exception ou retourne Y_BEACON_INVALID www.yoctopuce.com...
  • Page 263 ) function get_errorMessage( ) 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 264 ) function get_errorType( ) 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 265 ) function get_firmwareRelease( ) async get_firmwareRelease( ) string get_firmwareRelease( ) string get_firmwareRelease( ) YModule target get_firmwareRelease Retourne : une chaîne de caractères représentant la version du logiciel embarqué du module En cas d'erreur, déclenche une exception ou retourne Y_FIRMWARERELEASE_INVALID www.yoctopuce.com...
  • Page 266 Task<List<string>> get_functionIds( string funType) get_functionIds( funType) function get_functionIds( $funType) 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 267 ) 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 268 ) 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 269 ) YModule target get_lastLogs Cette méthode retourne les derniers logs qui sont encore stocké dans le module. Retourne : une chaîne de caractère contenant les derniers logs du module. En cas d'erreur, déclenche une exception YAPI_INVALID_STRING ou retourne www.yoctopuce.com...
  • Page 270 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) 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 Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 271 ) 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 Y_LUMINOSITY_INVALID www.yoctopuce.com...
  • Page 272 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 273 ) async get_persistentSettings( ) int get_persistentSettings( ) int get_persistentSettings( ) YModule target get_persistentSettings Retourne : une valeur parmi Y_PERSISTENTSETTINGS_LOADED Y_PERSISTENTSETTINGS_SAVED Y_PERSISTENTSETTINGS_MODIFIED représentant l'état courant des réglages persistents du module En cas d'erreur, déclenche une exception ou retourne Y_PERSISTENTSETTINGS_INVALID www.yoctopuce.com...
  • Page 274 Task<int> get_productId( ) get_productId( ) function get_productId( ) 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 Y_PRODUCTID_INVALID www.yoctopuce.com...
  • Page 275 ) 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 Y_PRODUCTNAME_INVALID www.yoctopuce.com...
  • Page 276 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 Y_PRODUCTRELEASE_INVALID www.yoctopuce.com...
  • Page 277 ) int get_rebootCountdown( ) YModule target get_rebootCountdown Retourne : un entier représentant le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé En cas d'erreur, déclenche une exception ou retourne Y_REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...
  • Page 278 ) 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 Y_SERIALNUMBER_INVALID www.yoctopuce.com...
  • Page 279 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 280: Retourne Le Numbre De Millisecondes Écoulées Depuis La Mise Sous Tension Du Module

    ) 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 Y_UPTIME_INVALID www.yoctopuce.com...
  • Page 281 ) 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 282 ) 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 Y_USBCURRENT_INVALID www.yoctopuce.com...
  • Page 283 ) Object get_userData( ) java get_userData( ) function get_userData( ) 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 284 ) YModule target get_userVar Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Retourne : un entier représentant la valeur entière précédemment stockée dans cet attribut En cas d'erreur, déclenche une exception ou retourne Y_USERVAR_INVALID www.yoctopuce.com...
  • Page 285 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 : identifiant matériel de la fonction funcId Retourne : vrai si le module inclut la fonction demandée www.yoctopuce.com...
  • Page 286 Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le module est joignable, false sinon www.yoctopuce.com...
  • Page 287 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 288 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 289 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 290 être inclus dans la chaîne de caractère. Paramètres : le message à ajouter aux logs du module. text Retourne : YAPI_SUCCESS si l'opération se 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 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 avec un Module.findModule() hardwareID ou un nom logique. Retourne : un pointeur sur un objet YModule accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 292 YModule target reboot secBeforeReboot Paramètres : nombre de secondes avant de redémarrer secBeforeReboot Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 293 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 294 As YModuleConfigChangeCallback) As Integer int registerConfigChangeCallback( ConfigChangeCallback callback) int registerConfigChangeCallback( ConfigChangeCallback callback) java async Task<int> registerConfigChangeCallback( ConfigChangeCallback callback) registerConfigChangeCallback( callback) function registerConfigChangeCallback( $callback) async registerConfigChangeCallback( callback) Paramètres : callback une procédure qui prend un YModule en paramètre, ou null www.yoctopuce.com...
  • Page 295 Task<int> registerLogCallback( LogCallback callback) registerLogCallback( callback) function registerLogCallback( $callback) async registerLogCallback( callback) Utile pour débugger le fonctionnement d'un module Yoctopuce. Paramètres : la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux callback arguments: l'objet module qui a produit un log, un chaîne de caractère qui contiens le log...
  • Page 296 Task<int> revertFromFlash( ) revertFromFlash( ) function revertFromFlash( ) 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 297 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 298 être préservés. saveToFlash() Paramètres : settings un objet binaire avec touts les paramètres Retourne : YAPI_SUCCESS si l'opération se 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és. Paramètres : settings un buffer binaire avec touts les paramètres Retourne : YAPI_SUCCESS si l'opération se 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 YModule target set_beacon newval Paramètres : newval Y_BEACON_OFF Y_BEACON_ON soit , soit Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 301 être préservé. Paramètres : une chaîne de caractères newval Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 302 être préservé. Paramètres : newval un entier représentant la luminosité des leds informatives 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 303 Object data) java set_userData( data) function set_userData( $data) 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 304 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 305 -(int) triggerConfigChangeCallback LongInt triggerConfigChangeCallback( ): LongInt function triggerConfigChangeCallback( ) As Integer int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) java async Task<int> triggerConfigChangeCallback( ) triggerConfigChangeCallback( ) function triggerConfigChangeCallback( ) async triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) YModule target triggerConfigChangeCallback www.yoctopuce.com...
  • Page 306 YModule target triggerFirmwareUpdate secBeforeReboot Paramètres : nombre de secondes avant de redémarrer secBeforeReboot Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 307 Cette méthode retourne un object qui est utilisé pour mettre à jour le firmware du YFirmwareUpdate module. Paramètres : path .byn le path du fichier à utiliser Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 308 à jour le firmware du YFirmwareUpdate module. Paramètres : path le path du fichier .byn à utiliser force vrai pour forceer la mise à jour même si un prérequis ne semble pas satisfait Retourne : un object YFirmwareUpdate ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 309 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 310: La Classe Yserialport

    (vitesse, nombre de bits, parité, contrôle de flux et protocole). Notez que les interfaces série Yoctopuce ne sont pas visibles comme des ports COM virtuels. Ils sont faits pour être utilisés comme tous les autres modules Yoctopuce.
  • Page 311 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du port série. serialport→get_friendlyName() Retourne un identifiant global du port série au format NOM_MODULE.NOM_FONCTION serialport→get_functionDescriptor() YFUN_DESCR Retourne un identifiant unique de type correspondant à la fonction. serialport→get_functionId() Retourne l'identifiant matériel du port série, sans référence au module. serialport→get_hardwareId() www.yoctopuce.com...
  • Page 312 Retourne le dernier message reçu (pour les protocoles de type Line, Frame et Modbus). serialport→get_logicalName() Retourne le nom logique du port série. serialport→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. serialport→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. serialport→get_protocol() Retourne le type de protocole utilisé...
  • Page 313 Lit la prochaine ligne (ou le prochain message) du tampon de réception, à partir de la position courante dans le flux de donnée. serialport→readMessages(pattern, maxWait) Cherche les messages entrants dans le tampon de réception correspondant à un format donné, à partir de la position courante. www.yoctopuce.com...
  • Page 314 Sauvegarde une définition de tâche (au format JSON) dans un fichier. serialport→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. serialport→writeArray(byteList) Envoie une séquence d'octets (fournie sous forme d'une liste) sur le port série. serialport→writeBin(buff) www.yoctopuce.com...
  • Page 315 Envoie une chaîne de caractères sur le port série, suivie d'un saut de ligne (CR LF). serialport→writeMODBUS(hexString) Envoie une commande MODBUS (fournie sous forme de chaîne hexadécimale) sur le port série. serialport→writeStr(text) Envoie une chaîne de caractères telle quelle sur le port série. www.yoctopuce.com...
  • Page 316 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le port série sans ambiguïté, par exemple RS232MK1.serialPort Retourne : un objet de classe YSerialPort qui permet ensuite de contrôler le port série. www.yoctopuce.com...
  • Page 317 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le port série sans ambiguïté, par exemple RS232MK1.serialPort Retourne : un objet de classe YSerialPort qui permet ensuite de contrôler le port série. www.yoctopuce.com...
  • Page 318 Utiliser la fonction pour itérer sur les autres ports série. YSerialPort.nextSerialPort() Retourne : YSerialPort un pointeur sur un objet , correspondant au premier port série accessible en ligne, ou null si il n'y a pas de ports série disponibles. www.yoctopuce.com...
  • Page 319 YSerialPort.nextSerialPort() Paramètres : un contexte YAPI. yctx Retourne : YSerialPort un pointeur sur un objet , correspondant au premier port série accessible en ligne, ou null si il n'y a pas de ports série disponibles. www.yoctopuce.com...
  • Page 320 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YSerialPort.FindSerialPort 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 321 24. Référence de l'API de haut niveau YSerialPort serialport→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 322 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 323 24. Référence de l'API de haut niveau YSerialPort serialport→FunctionId Identifiant matériel du port série, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 324 24. Référence de l'API de haut niveau YSerialPort serialport→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 325 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 326 24. Référence de l'API de haut niveau YSerialPort serialport→JobMaxSize Taille maximale d'un fichier job. int JobMaxSize www.yoctopuce.com...
  • Page 327 24. Référence de l'API de haut niveau YSerialPort serialport→JobMaxTask Nombre maximal de tâches dans un job supporté par le module. int JobMaxTask www.yoctopuce.com...
  • Page 328 24. Référence de l'API de haut niveau YSerialPort serialport→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 329 "/[wait]ms" peut être ajouté pour réduire la cadence d'émission de sorte à ce qu'il y ait au minimum le nombre spécifié de millisecondes d'intervalle entre l'envoi de chaque byte. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 330 "CtsRts" pour le contrôle de flux matériel, "XOnXOff" pour le contrôle de flux logique et "Simplex" pour l'utilisation du signal RTS pour l'acquisition d'un bus partagé (tel qu'utilisé pour certains adaptateurs RS485 par exemple). N'oubliez pas d'appeler la méthode du module si saveToFlash() le réglage doit être préservé. www.yoctopuce.com...
  • Page 331 24. Référence de l'API de haut niveau YSerialPort serialport→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 332 Nom du fichier de tâches à exécuter au démarrage du module. string StartupJob Modifiable. Modifie le nom du job à exécuter au démarrage du module. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 333 Y_VOLTAGELEVEL_RS485 Y_VOLTAGELEVEL_TTL1V8 Modifiable. Les valeurs valides dépendent du modèle de module Yoctopuce hébergeant le port série. Consultez la documentation de votre module pour savoir quelles valeurs sont supportées. Affecter une valeur invalide n'aura aucun effet. N'oubliez pas d'appeler la méthode...
  • Page 334 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du port série. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 335 î n e c a r a c t è r e s d é c r i v a n t p o r t s é r i e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 336 La ligne CTS est habituellement pilotée par le signal RTS du périphérique série connecté. Retourne : 1 si le CTS est signalé (niveau haut), 0 si le CTS n'est pas actif (niveau bas). En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 337 ) string get_advertisedValue( ) string get_advertisedValue( ) YSerialPort target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du port série (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 338 ) async get_currentJob( ) string get_currentJob( ) string get_currentJob( ) YSerialPort target get_currentJob Retourne : une chaîne de caractères représentant le nom du fichier de tâches actif en ce moment En cas d'erreur, déclenche une exception ou retourne Y_CURRENTJOB_INVALID www.yoctopuce.com...
  • Page 339 ) async get_errCount( ) int get_errCount( ) int get_errCount( ) YSerialPort target get_errCount Retourne : un entier représentant le nombre d'erreurs de communication détectées depuis la dernière mise à zéro En cas d'erreur, déclenche une exception ou retourne Y_ERRCOUNT_INVALID www.yoctopuce.com...
  • Page 340 ) function get_errorMessage( ) 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 port série.
  • Page 341 ) function get_errorType( ) 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 port série.
  • Page 342 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le port série en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 343 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 344 ) function get_functionId( ) async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant le port série (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 345 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du port série (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le port série (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 346 Task<int> get_jobMaxSize( ) get_jobMaxSize( ) function get_jobMaxSize( ) async get_jobMaxSize( ) int get_jobMaxSize( ) int get_jobMaxSize( ) YSerialPort target get_jobMaxSize Retourne : un entier représentant la taille maximale d'un fichier job En cas d'erreur, déclenche une exception ou retourne Y_JOBMAXSIZE_INVALID www.yoctopuce.com...
  • Page 347 ) async get_jobMaxTask( ) int get_jobMaxTask( ) int get_jobMaxTask( ) YSerialPort target get_jobMaxTask Retourne : un entier représentant le nombre maximal de tâches dans un job supporté par le module En cas d'erreur, déclenche une exception ou retourne Y_JOBMAXTASK_INVALID www.yoctopuce.com...
  • Page 348 ) string get_lastMsg( ) string get_lastMsg( ) YSerialPort target get_lastMsg Retourne : une chaîne de caractères représentant le dernier message reçu (pour les protocoles de type Line, Frame et Modbus) En cas d'erreur, déclenche une exception ou retourne Y_LASTMSG_INVALID www.yoctopuce.com...
  • Page 349 ) function get_logicalName( ) async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YSerialPort target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du port série. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 350 24. Référence de l'API de haut niveau YSerialPort serialport→get_module() serialport→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 351 24. Référence de l'API de haut niveau YSerialPort serialport→get_module_async() serialport→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 352 Wiegand en mode octet, "Char" pour un flux ASCII continu ou "Byte" pour un flux binaire continue. Retourne : une chaîne de caractères représentant le type de protocole utilisé sur la communication série, sous forme d'une chaîne de caractères En cas d'erreur, déclenche une exception ou retourne Y_PROTOCOL_INVALID www.yoctopuce.com...
  • Page 353 ) async get_rxCount( ) int get_rxCount( ) int get_rxCount( ) YSerialPort target get_rxCount Retourne : un entier représentant le nombre d'octets reçus depuis la dernière mise à zéro En cas d'erreur, déclenche une exception ou retourne Y_RXCOUNT_INVALID www.yoctopuce.com...
  • Page 354 ) async get_rxMsgCount( ) int get_rxMsgCount( ) int get_rxMsgCount( ) YSerialPort target get_rxMsgCount Retourne : un entier représentant le nombre de messages reçus depuis la dernière mise à zéro En cas d'erreur, déclenche une exception ou retourne Y_RXMSGCOUNT_INVALID www.yoctopuce.com...
  • Page 355 RTS pour l'acquisition d'un bus partagé (tel qu'utilisé pour certains adaptateurs RS485 par exemple). Retourne : une chaîne de caractères représentant les paramètres de communication du port, sous forme d'une chaîne de caractères du type "9600,8N1" En cas d'erreur, déclenche une exception ou retourne Y_SERIALMODE_INVALID www.yoctopuce.com...
  • Page 356 ) async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YSerialPort 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 357 ) string get_startupJob( ) string get_startupJob( ) YSerialPort target get_startupJob Retourne : une chaîne de caractères représentant le nom du fichier de tâches à exécuter au démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_STARTUPJOB_INVALID www.yoctopuce.com...
  • Page 358 ) async get_txCount( ) int get_txCount( ) int get_txCount( ) YSerialPort target get_txCount Retourne : un entier représentant le nombre d'octets transmis depuis la dernière mise à zéro En cas d'erreur, déclenche une exception ou retourne Y_TXCOUNT_INVALID www.yoctopuce.com...
  • Page 359 ) async get_txMsgCount( ) int get_txMsgCount( ) int get_txMsgCount( ) YSerialPort target get_txMsgCount Retourne : un entier représentant le nombre de messages envoyés depuis la dernière mise à zéro En cas d'erreur, déclenche une exception ou retourne Y_TXMSGCOUNT_INVALID www.yoctopuce.com...
  • Page 360 ) Object get_userData( ) java get_userData( ) function get_userData( ) 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 361 Y _ V O L T A G E L E V E L _ T T L 3 V Y_VOLTAGELEVEL_TTL3VR Y_VOLTAGELEVEL_TTL5V Y_VOLTAGELEVEL_TTL5VR Y_VOLTAGELEVEL_RS232 Y_VOLTAGELEVEL_RS485 Y_VOLTAGELEVEL_TTL1V8 représentant le niveau de tension utilisé par le module sur le port série En cas d'erreur, déclenche une exception ou retourne Y_VOLTAGELEVEL_INVALID www.yoctopuce.com...
  • Page 362 Si les valeurs des attributs en cache du port série sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le port série est joignable, false sinon www.yoctopuce.com...
  • Page 363 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 364 ) YSerialPort 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 365 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 366 Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 367 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 368 à lire (indexé à partir de zéro). pduAddr nBits nombre de bits à lire Retourne : un vecteur d'entiers, correspondant chacun à un bit. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 369 à lire (indexé à partir de zéro). nBits nombre de bits à lire Retourne : un vecteur d'entiers, correspondant chacun à un bit. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 370 à lire (indexé à partir de zéro). nWords nombre de registres d'entrée à lire Retourne : un vecteur d'entiers, correspondant chacun à une valeur d'entrée (16 bits). En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 371 à lire (indexé à partir de zéro). nWords nombre de registres internes à lire Retourne : un vecteur d'entiers, correspondant chacun à une valeur de registre (16 bits). En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 372 $slaveNo, $pduWriteAddr, $values, $pduReadAddr, $nReadWords) async modbusWriteAndReadRegisters( slaveNo, pduWriteAddr, values, pduReadAddr, nReadWords) int[] modbusWriteAndReadRegisters( int slaveNo, int pduWriteAddr, int[] values, int pduReadAddr, int nReadWords) vector<int> modbusWriteAndReadRegisters( int slaveNo, int pduWriteAddr, www.yoctopuce.com...
  • Page 373 à lire (indexé à partir de zéro). pduReadAddr nReadWords nombre de registres internes à lire Retourne : un vecteur d'entiers, correspondant chacun à une valeur de registre (16 bits) lue. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 374 à modifier (indexé à partir de zéro). value la valeur à appliquer (0 pour l'état OFF, non-zéro pour l'état ON) Retourne : le nombre de bits affectés sur le périphérique (1) En cas d'erreur, déclenche une exception ou retourne zéro. www.yoctopuce.com...
  • Page 375 à modifier (indexé à partir de zéro). pduAddr bits vecteur de bits à appliquer (un entier par bit) Retourne : le nombre de bits affectés sur le périphérique En cas d'erreur, déclenche une exception ou retourne zéro. www.yoctopuce.com...
  • Page 376 à modifier (indexé à partir de zéro). value la valeur 16 bits à appliquer Retourne : le nombre de registres affectés sur le périphérique (1) En cas d'erreur, déclenche une exception ou retourne zéro. www.yoctopuce.com...
  • Page 377 à modifier (indexé à partir de zéro). values vecteur de valeurs 16 bits à appliquer Retourne : le nombre de registres affectés sur le périphérique En cas d'erreur, déclenche une exception ou retourne zéro. www.yoctopuce.com...
  • Page 378 é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 379 ) nextSerialPort( ) Si vous souhaitez retrouver un port série spécifique, utilisez SerialPort.findSerialPort() avec un hardwareID ou un nom logique. Retourne : un pointeur sur un objet YSerialPort accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 380 (en millisecondes). maxWait Retourne : la première trame reçu après l'envoi du message, en hexadécimal. Les trames suivantes peuvent être obtenues avec des appels à readHex ou readMessages. En cas d'erreur, déclenche une exception ou retourne une chaîne vide. www.yoctopuce.com...
  • Page 381 (en millisecondes). Retourne : la première ligne de texte reçue après l'envoi du message. Les lignes suivantes peuvent être obtenues avec des appels à readLine ou readMessages. En cas d'erreur, déclenche une exception ou retourne une chaîne vide. www.yoctopuce.com...
  • Page 382 à envoyer (PDU), sous forme de vecteur d'octets. Le premier octet du PDU est le code de fonction MODBUS. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un tableau vide (ou une réponse d'erreur). www.yoctopuce.com...
  • Page 383 Si le contenu à la position n'est plus disponible dans le tampon de réception, la fonction ne retournera que les données disponibles. Paramètres : le nombre maximum de bytes à lire nChars Retourne : une liste de bytes avec le contenu du tampon de réception. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 384 Si le contenu à la position n'est plus disponible dans le tampon de réception, la fonction ne retournera que les données disponibles. Paramètres : le nombre maximum de bytes à lire nChars Retourne : un objet binaire avec le contenu du tampon de réception. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 385 Si le contenu à la position n'est plus disponible dans le tampon de réception, ou si aucun octet n'est disponible pour l'instant, la fonction retourne YAPI_NO_MORE_DATA. Retourne : le prochain byte En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 386 Paramètres : le nombre maximal d'octets à lire nBytes Retourne : une chaîne de caractère avec le contenu du tampon de réception, encodé en hexadécimal En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 387 Si aucune nouvelle ligne entière n'est disponible, la fonction retourne un chaîne vide. Retourne : une chaîne de caractère avec une ligne de texte En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 388 (en millisecondes). Retourne : un tableau de chaînes de caractères contenant les messages trouvés. Les messages binaires sont convertis automatiquement en représentation hexadécimale. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 389 Paramètres : le nombre maximum de caractères à lire nChars Retourne : une chaîne de caractère avec le contenu du tampon de réception. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 390 ) As Integer int read_avail( ) int read_avail( ) java async Task<int> read_avail( ) read_avail( ) function read_avail( ) async read_avail( ) int read_avail( ) int read_avail( ) YSerialPort target read_avail Retourne : le nombre d'octets prêts à être lus www.yoctopuce.com...
  • Page 391 Cette fonction n'a pas d'effet sur le module, elle ne fait que changer la valeur stockée dans l'objet d'API qui sera utilisée pour les prochaines operations de lecture. Paramètres : index de position absolue pour les opérations de lecture suivantes. absPos Retourne : rien du tout. www.yoctopuce.com...
  • Page 392 ) int read_tell( ) java async Task<int> read_tell( ) read_tell( ) function read_tell( ) async read_tell( ) int read_tell( ) int read_tell( ) YSerialPort target read_tell Retourne : l'index de position absolue pour les prochaines opérations de lecture. www.yoctopuce.com...
  • Page 393 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 394 Task<int> reset( ) reset( ) function reset( ) async reset( ) int reset( ) int reset( ) YSerialPort target reset Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 395 à l'aide de la fonction uploadJob() Paramètres : jobfile nom du fichier de tâche (fichier sur 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 396 Cette fonction n'a pas d'effet lorsque le contrôle du flux par CTS/RTS est actif, car la ligne RTS est alors pilotée automatiquement. Paramètres : 1 pour activer la ligne RTS, 0 pour la désactiver Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 397 Si une chaîne vide est passée en argument, stoppe immédiatement l'exécution du fichier de tâches actuel. 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 398 être préservé. Paramètres : une chaîne de caractères représentant le nom logique du port série. newval 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 399 Paramètres : newval une chaîne de caractères représentant le type de protocol utilisé sur la communication série Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 400 "9600,8N1" Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 401 Paramètres : newval une chaîne de caractères représentant le nom du job à exécuter au démarrage 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 402 Object data) java set_userData( data) function set_userData( $data) 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 403 Les valeurs valides dépendent du modèle de module Yoctopuce hébergeant le port série. Consultez la documentation de votre module pour savoir quelles valeurs sont supportées. Affecter une valeur invalide n'aura aucun effet. N'oubliez pas d'appeler la méthode...
  • Page 404 (en millisecondes). Retourne : YSnoopingRecord un tableau de contenant les messages trouvés. Les messages binaires sont convertis automatiquement en représentation hexadécimale. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 405 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() 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 406 JSON Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 407 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 408 YSerialPort target writeArray byteList Paramètres : la liste d'octets à envoyer byteList Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 409 YSerialPort target writeBin buff Paramètres : l'objet binaire à envoyer buff Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 410 YSerialPort target writeByte code Paramètres : le byte à envoyer code Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 411 YSerialPort target writeHex hexString Paramètres : la chaîne hexadécimale à envoyer hexString Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 412 YSerialPort target writeLine text Paramètres : la chaîne de caractères à envoyer text Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 413 Cette fonction n'attend pas de réponse. Paramètres : le message à envoyer, en hexadécimal, sans le CRC/LRC hexString Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 414 YSerialPort target writeStr text Paramètres : la chaîne de caractères à envoyer text Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 415: La Classe Ypoweroutput

    24. Référence de l'API de haut niveau 24.4. La classe YPowerOutput Interface pour intéragir avec les sources d'alimentation, disponibles par exemple dans le Yocto-I2C, le Yocto-MaxiMicroVolt-Rx, le Yocto-SPI et le Yocto-Serial La classe permet de contrôler l'alimentation mise a disposition sur certain module YPowerOutput Yoctopuce.
  • Page 416 SERIAL.FUNCTIONID poweroutput→get_logicalName() Retourne le nom logique de la source d'alimentation. poweroutput→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. poweroutput→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. poweroutput→get_serialNumber() Retourne le numéro de série du module, préprogrammé en usine.
  • Page 417 Modifie le voltage de l'alimentation mise à disposition par le module. poweroutput→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. poweroutput→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 418 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence la source d'alimentation sans ambiguïté, par exemple YI2CMK01.powerOutput Retourne : un objet de classe YPowerOutput qui permet ensuite de contrôler la source d'alimentation. www.yoctopuce.com...
  • Page 419 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 la source d'alimentation sans ambiguïté, par exemple YI2CMK01.powerOutput Retourne : un objet de classe YPowerOutput qui permet ensuite de contrôler la source d'alimentation. www.yoctopuce.com...
  • Page 420 Utiliser la fonction pour itérer sur les autres sources YPowerOutput.nextPowerOutput() d'alimentation. Retourne : YPowerOutput un pointeur sur un objet , correspondant à la premiere source d'alimentation accessible en ligne, ou null si il n'y a pas de sources d'alimentation disponibles. www.yoctopuce.com...
  • Page 421 YPowerOutput.nextPowerOutput() d'alimentation. Paramètres : un contexte YAPI. yctx Retourne : YPowerOutput un pointeur sur un objet , correspondant à la premiere source d'alimentation accessible en ligne, ou null si il n'y a pas de sources d'alimentation disponibles. www.yoctopuce.com...
  • Page 422 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YPowerOutput.FindPowerOutput 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 423 24. Référence de l'API de haut niveau YPowerOutput poweroutput→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 424 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 425 24. Référence de l'API de haut niveau YPowerOutput poweroutput→FunctionId Identifiant matériel de la source d'alimentation, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 426 24. Référence de l'API de haut niveau YPowerOutput poweroutput→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 427 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 428 24. Référence de l'API de haut niveau YPowerOutput poweroutput→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 429 24. Référence de l'API de haut niveau YPowerOutput poweroutput→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 430 Voltage envoyé sur l'alimentation mise à disposition sur le module. int Voltage Valeurs possibles: Y_VOLTAGE_INVALID Y_VOLTAGE_OFF Y_VOLTAGE_OUT3V3 Y_VOLTAGE_OUT5V Y_VOLTAGE_OUT4V7 Y_VOLTAGE_OUT1V8 Modifiable. Modifie le voltage de l'alimentation mise à disposition par le module. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 431 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes de la source d'alimentation. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 432 è r e s d é c r i v a n t s o u r c e d ' a l i m e n t a t i o n ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 433 ) string get_advertisedValue( ) string get_advertisedValue( ) YPowerOutput target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de la source d'alimentation (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 434 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de la source d'alimentation.
  • Page 435 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de la source d'alimentation.
  • Page 436 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant la source d'alimentation en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 437 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 438 ) function get_functionId( ) async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant la source d'alimentation (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 439 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la source d'alimentation (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant la source d'alimentation (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 440 ) function get_logicalName( ) async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YPowerOutput target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de la source d'alimentation. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 441 24. Référence de l'API de haut niveau YPowerOutput poweroutput→get_module() poweroutput→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 442 24. Référence de l'API de haut niveau YPowerOutput poweroutput→get_module_async() poweroutput→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 443 ) async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YPowerOutput 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 444 ) Object get_userData( ) java get_userData( ) function get_userData( ) 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 445 ) int get_voltage( ) YPowerOutput target get_voltage Retourne : une valeur parmi Y_VOLTAGE_OFF Y_VOLTAGE_OUT3V3 Y_VOLTAGE_OUT5V Y_VOLTAGE_OUT4V7 Y_VOLTAGE_OUT1V8 représentant le voltage envoyé sur l'alimentation mise à disposition sur le module En cas d'erreur, déclenche une exception ou retourne Y_VOLTAGE_INVALID www.yoctopuce.com...
  • Page 446 Si les valeurs des attributs en cache de la source d'alimentation sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si la source d'alimentation est joignable, false sinon www.yoctopuce.com...
  • Page 447 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 448 ) YPowerOutput 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 449 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 450 Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 451 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 452 é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 453 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. PowerOutput.findPowerOutput() Retourne : un pointeur sur un objet YPowerOutput accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 454 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 455 être préservé. Paramètres : une chaîne de caractères représentant le nom logique de la source d'alimentation. newval 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 456 Object data) java set_userData( data) function set_userData( $data) 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 457 Y_VOLTAGE_OFF Y_VOLTAGE_OUT3V3 Y_VOLTAGE_OUT5V Y_VOLTAGE_OUT4V7 Y_VOLTAGE_OUT1V8 représentant le voltage de l'alimentation mise à disposition 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 458 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() 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 459 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 460: La Classe Yfiles

    Interface pour intéragir avec les systèmes de fichier, disponibles par exemple dans le Yocto-Buzzer, le Yocto-Color-V2, le Yocto-RS485-V2 et le YoctoHub-Ethernet La class YFiles permet d'accéder au système de fichier embarqué sur certains modules Yoctopuce. Le stockage de fichiers permet par exemple de personnaliser un service web (dans le cas d'un module connecté...
  • Page 461 Retourne l'identifiant matériel du système de fichier, sans référence au module. files→get_hardwareId() Retourne l'identifiant matériel unique du système de fichier au format SERIAL.FUNCTIONID files→get_list(pattern) Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier. files→get_logicalName() Retourne le nom logique du système de fichier. www.yoctopuce.com...
  • Page 462 24. Référence de l'API de haut niveau files→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. files→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. files→get_serialNumber() Retourne le numéro de série du module, préprogrammé en usine.
  • Page 463 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YBUZZER2.files Retourne : un objet de classe YFiles qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 464 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple func YBUZZER2.files Retourne : un objet de classe YFiles qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 465 YFiles.nextFiles() Retourne : YFiles un pointeur sur un objet , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
  • Page 466 YFiles.nextFiles() Paramètres : un contexte YAPI. yctx Retourne : YFiles un pointeur sur un objet , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
  • Page 467 Chaque chaîne retournée peut être passée en argument à la méthode pour YFiles.FindFiles obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
  • Page 468 24. Référence de l'API de haut niveau YFiles files→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 469 24. Référence de l'API de haut niveau YFiles files→FilesCount Nombre de fichiers présents dans le système de fichier. int FilesCount www.yoctopuce.com...
  • Page 470 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 471 24. Référence de l'API de haut niveau YFiles files→FunctionId Identifiant matériel du système de fichier, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 472 24. Référence de l'API de haut niveau YFiles files→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 473 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 474 24. Référence de l'API de haut niveau YFiles files→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 475 24. Référence de l'API de haut niveau YFiles files→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 476 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du système de fichier. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 477 î n e c a r a c t è r e s d é c r i v a n t s y s t è m e f i c h i e r ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 478 Paramètres : nom complet du fichier à charger, y compris le chemin d'accès. pathname Retourne : le contenu du fichier chargé sous forme d'objet binaire En cas d'erreur, déclenche une exception ou retourne un contenu vide. www.yoctopuce.com...
  • Page 479 La fonction callback doit prendre trois arguments: - la variable de contexte à disposition de l'utilisateur - l'objet YFiles dont la méthode download_async a été appelée - le contenu du fichier chargé sous forme d'objet binaire variable de contexte à disposition de l'utilisateur context Retourne : rien. www.yoctopuce.com...
  • Page 480 YFiles target fileExist filename Paramètres : le nom de fichier. filename Retourne : vrais si le fichier existe, et faux is le fichier n'existe pas. En cas d'erreur, déclenche une exception. www.yoctopuce.com...
  • Page 481 ) int format_fs( ) YFiles target format_fs entièrement vide. Tous les fichiers précédemment chargés sont irrémédiablement effacés. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 482 ) string get_advertisedValue( ) string get_advertisedValue( ) YFiles target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du système de fichier (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 483 ) function get_errorMessage( ) 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 système de fichier.
  • Page 484 ) function get_errorType( ) 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 système de fichier.
  • Page 485 ) async get_filesCount( ) int get_filesCount( ) int get_filesCount( ) YFiles target get_filesCount Retourne : un entier représentant le nombre de fichiers présents dans le système de fichier En cas d'erreur, déclenche une exception ou retourne Y_FILESCOUNT_INVALID www.yoctopuce.com...
  • Page 486 ) int get_freeSpace( ) int get_freeSpace( ) YFiles target get_freeSpace Retourne : un entier représentant l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets En cas d'erreur, déclenche une exception ou retourne Y_FREESPACE_INVALID www.yoctopuce.com...
  • Page 487 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le système de fichier en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 488 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 489 ) function get_functionId( ) async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant le système de fichier (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 490 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du système de fichier (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le système de fichier (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...

  • Page 491: Paramètres

    Retourne : YFileRecord une liste d'objets , contenant le nom complet (y compris le chemin d'accès), la taille en octets et le CRC 32-bit du contenu du fichier. En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 492 ) function get_logicalName( ) async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YFiles target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du système de fichier. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 493 24. Référence de l'API de haut niveau YFiles files→get_module() files→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 494 24. Référence de l'API de haut niveau YFiles files→get_module_async() files→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 495 ) async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YFiles 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 496 ) Object get_userData( ) java get_userData( ) function get_userData( ) 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 497 Si les valeurs des attributs en cache du système de fichier sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le système de fichier est joignable, false sinon www.yoctopuce.com...
  • Page 498 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 499 ) YFiles 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 500 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 501 Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 502 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 503 é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 504 ) nextFiles( ) Si vous souhaitez retrouver un système de fichier spécifique, utilisez avec un Files.findFiles() hardwareID ou un nom logique. Retourne : un pointeur sur un objet YFiles accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 505 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 506 éventuellement pas été libéré. Pour s'assurer de libérer la totalité de l'espace du système de fichier, utilisez la fonction format_fs Paramètres : pathname nom complet du fichier, y compris le chemin d'accès. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 507 être préservé. Paramètres : une chaîne de caractères représentant le nom logique du système de fichier. newval 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 508 Object data) java set_userData( data) function set_userData( $data) 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 509 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() 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 510 Paramètres : pathname nom complet du fichier, y compris le chemin d'accès. contenu du fichier à télécharger content Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 511 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 512: La Classe Ygenericsensor

    Interface pour intéragir avec les capteurs de type GenericSensor, disponibles par exemple dans le Yocto-0-10V-Rx, le Yocto-4-20mA-Rx, le Yocto-RS485-V2 et le Yocto-milliVolt-Rx La classe permet de lire et de configurer les transducteurs de signaux Yoctopuce. YGenericSensor Elle hérite de la classe...
  • Page 513 Retourne le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). genericsensor→get_advertisedValue() Retourne la valeur courante du capteur générique (pas plus de 6 caractères). genericsensor→get_currentRawValue() Retourne la valeur brute retournée par le capteur (sans arrondi ni calibration). genericsensor→get_currentValue() Retourne la valeur mesurée actuelle. www.yoctopuce.com...
  • Page 514 Retourne la valeur minimale observée pour la measure depuis le démarrage du module. genericsensor→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. genericsensor→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. genericsensor→get_recordedData(startTime, endTime)
  • Page 515 Enregistre la fonction de callback qui est appelée à chaque notification périodique. genericsensor→registerValueCallback(callback) Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée. genericsensor→set_advMode(newval) Modifie le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). genericsensor→set_enabled(newval) Modifie l'état d'activation de cette mesure. genericsensor→set_highestValue(newval) www.yoctopuce.com...
  • Page 516 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. genericsensor→zeroAdjust() Ajuste le biais du signal de sorte à ce que la valeur actuelle du signal soit interprétée comme zéro (tare). www.yoctopuce.com...
  • Page 517 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur générique sans ambiguïté, par exemple RX010V01.genericSensor1 Retourne : un objet de classe YGenericSensor qui permet ensuite de contrôler le capteur générique. www.yoctopuce.com...
  • Page 518 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le capteur générique sans ambiguïté, par exemple RX010V01.genericSensor1 Retourne : un objet de classe YGenericSensor qui permet ensuite de contrôler le capteur générique. www.yoctopuce.com...
  • Page 519 Utiliser la fonction pour itérer sur les autres capteurs YGenericSensor.nextGenericSensor() génériques. Retourne : YGenericSensor un pointeur sur un objet , correspondant au premier capteur générique accessible en ligne, ou null si il n'y a pas de capteurs génériques disponibles. www.yoctopuce.com...
  • Page 520 YGenericSensor.nextGenericSensor() génériques. Paramètres : un contexte YAPI. yctx Retourne : YGenericSensor un pointeur sur un objet , correspondant au premier capteur générique accessible en ligne, ou null si il n'y a pas de capteurs génériques disponibles. www.yoctopuce.com...
  • Page 521 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le YGenericSensor.FindGenericSensor module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
  • Page 522 24. Référence de l'API de haut niveau YGenericSensor genericsensor→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Valeurs possibles: Y_ADVMODE_INVALID Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 523 24. Référence de l'API de haut niveau YGenericSensor genericsensor→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 524 Y_ENABLED_TRUE Modifiable. Lorsqu'une mesure est désactivée, sa valeur n'est plus transmise, et pour certains modules, cela permet d'augmenter la fréquence de rafraîchissement des mesures actives. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 525 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 526 24. Référence de l'API de haut niveau YGenericSensor genericsensor→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 527 24. Référence de l'API de haut niveau YGenericSensor genericsensor→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 528 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 529 "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 530 24. Référence de l'API de haut niveau YGenericSensor genericsensor→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 531 "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 532 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 533 24. Référence de l'API de haut niveau YGenericSensor genericsensor→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 534 à la correction d'un signal trop négatif. Modifiable. Si votre signal électrique est positif lorsqu'il devrait être nul, configurez un biais positif de la même valeur afin de corriger l'erreur. N'oubliez pas d'appeler la méthode du module saveToFlash() si le réglage doit être préservé. www.yoctopuce.com...
  • Page 535 Pour un capteur 4-20mA, la plage d'entrée par défaut est "4...20". Pour un capteur 0-10V, la plage d'entrée par défaut est "0.1...10". Pour les interfaces de communication numériques, la plage par défaut est "-999999.999...999999.999". N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 536 La méthode LOW_NOISE combine la fréquence réduite avec un filtre médian, pour obtenir des LOW_NOISE_FILTERED mesures aussi stables que possible même sur un signal bruité. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 537 24. Référence de l'API de haut niveau YGenericSensor genericsensor→SignalUnit Unité du signal électrique utilisé par le capteur. string SignalUnit www.yoctopuce.com...
  • Page 538 Notez que le changement de plage peut avoir pour effet de bord un changement automatique de la résolution affichée. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 539 être préservé. Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.
  • Page 540 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du capteur générique. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 541 è r e s d é c r i v a n t c a p t e u r g é n é r i q u e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 542 Y _ A D V M O D E _ P E R I O D _ A V G Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...
  • Page 543 ) string get_advertisedValue( ) string get_advertisedValue( ) YGenericSensor target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur générique (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 544 ) async get_currentRawValue( ) double get_currentRawValue( ) double get_currentRawValue( ) YGenericSensor target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration) En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 545 Task<double> get_currentValue( ) get_currentValue( ) function get_currentValue( ) async get_currentValue( ) double get_currentValue( ) double get_currentValue( ) YGenericSensor target get_currentValue Retourne : une valeur numérique représentant la valeur mesurée actuelle En cas d'erreur, déclenche une exception ou retourne Y_CURRENTVALUE_INVALID www.yoctopuce.com...
  • Page 546 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 : un objet YDatalogger , ou null en cas d'erreur. www.yoctopuce.com...
  • Page 547 ) function get_enabled( ) async get_enabled( ) int get_enabled( ) int get_enabled( ) YGenericSensor target get_enabled Retourne : soit Y_ENABLED_FALSE , soit Y_ENABLED_TRUE , selon l'état d'activation de cette mesure En cas d'erreur, déclenche une exception ou retourne Y_ENABLED_INVALID www.yoctopuce.com...
  • Page 548 ) function get_errorMessage( ) 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 générique.
  • Page 549 ) function get_errorType( ) 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 générique.
  • Page 550 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur générique en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 551 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 552 ) function get_functionId( ) async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant le capteur générique (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 553 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur générique (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le capteur générique (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 554 Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour la measure depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 555 Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 556 ) function get_logicalName( ) async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YGenericSensor target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur générique. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 557 Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour la measure depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 558 24. Référence de l'API de haut niveau YGenericSensor genericsensor→get_module() genericsensor→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 559 24. Référence de l'API de haut niveau YGenericSensor genericsensor→get_module_async() genericsensor→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 560 à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : une instance de YDataSet , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
  • Page 561 ) YGenericSensor target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 562 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 563 En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 564 ) async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YGenericSensor 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 565 Un biais positif correspond à la correction d'un signal trop positif, tandis qu'un biais négatif correspond à la correction d'un signal trop négatif. Retourne : une valeur numérique représentant le biais du signal électrique pour la correction du point zéro En cas d'erreur, déclenche une exception ou retourne Y_SIGNALBIAS_INVALID www.yoctopuce.com...
  • Page 566 ) async get_signalRange( ) string get_signalRange( ) string get_signalRange( ) YGenericSensor target get_signalRange Retourne : une chaîne de caractères représentant la plage de signal d'entrée utilisé par le capteur En cas d'erreur, déclenche une exception ou retourne Y_SIGNALRANGE_INVALID www.yoctopuce.com...
  • Page 567 Y _ S I G N A L S A M P L I N G _ H I G H _ R A T E Y_SIGNALSAMPLING_HIGH_RATE_FILTERED Y_SIGNALSAMPLING_LOW_NOISE Y_SIGNALSAMPLING_LOW_NOISE_FILTERED Y_SIGNALSAMPLING_HIGHEST_RATE représentant la méthode d'échantillonnage du signal utilisée En cas d'erreur, déclenche une exception ou retourne Y_SIGNALSAMPLING_INVALID www.yoctopuce.com...
  • Page 568 ) async get_signalUnit( ) string get_signalUnit( ) string get_signalUnit( ) YGenericSensor target get_signalUnit Retourne : une chaîne de caractères représentant l'unité du signal électrique utilisé par le capteur En cas d'erreur, déclenche une exception ou retourne Y_SIGNALUNIT_INVALID www.yoctopuce.com...
  • Page 569 ) async get_signalValue( ) double get_signalValue( ) double get_signalValue( ) YGenericSensor target get_signalValue Retourne : une valeur numérique représentant la valeur actuelle du signal électrique mesuré par le capteur En cas d'erreur, déclenche une exception ou retourne Y_SIGNALVALUE_INVALID www.yoctopuce.com...
  • Page 570 ) function get_unit( ) async get_unit( ) string get_unit( ) string get_unit( ) YGenericSensor target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la measure est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 571 ) Object get_userData( ) java get_userData( ) function get_userData( ) 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 572 ) async get_valueRange( ) string get_valueRange( ) string get_valueRange( ) YGenericSensor target get_valueRange Retourne : une chaîne de caractères représentant la plage de valeurs physiques mesurés par le capteur En cas d'erreur, déclenche une exception ou retourne Y_VALUERANGE_INVALID www.yoctopuce.com...
  • Page 573 Si les valeurs des attributs en cache du capteur générique sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le capteur générique est joignable, false sinon www.yoctopuce.com...
  • Page 574 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 575 ) YGenericSensor 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 576 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 577 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 578 Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 579 Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 580 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 581 é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 582 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. GenericSensor.findGenericSensor() Retourne : un pointeur sur un objet YGenericSensor accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 583 Paramètres : la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux callback YMeasure arguments: l'object fonction dont la valeur a changé, et un objet décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 584 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 585 Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 586 être préservé. saveToFlash() Paramètres : newval soit Y_ENABLED_FALSE , soit Y_ENABLED_TRUE , selon l'état d'activation de cette mesure Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 587 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 588 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 589 être préservé. Paramètres : une chaîne de caractères représentant le nom logique du capteur générique. newval 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 590 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 591 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 592 En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.newvalune valeur numérique @return YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 593 Paramètres : newval une valeur numérique représentant le biais du signal électrique pour la correction du point zéro Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 594 être préservé. Paramètres : newval une chaîne de caractères représentant la plage du signal d'entrée utilisé 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 595 Y _ S I G N A L S A M P L I N G _ L O W _ N O I S E _ F I L T E R E D Y_SIGNALSAMPLING_HIGHEST_RATE représentant la méthode d'échantillonnage du signal à utiliser Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 596 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant l'unité dans laquelle la valeur 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 597 Object data) java set_userData( data) function set_userData( $data) 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 598 à la grandeur physique mesuré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 599 ) int startDataLogger( ) int startDataLogger( ) YGenericSensor 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 600 ) As Integer int stopDataLogger( ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) YGenericSensor target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 601 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() 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 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 603 ) YGenericSensor target zeroAdjust 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 604: La Classe Ydatalogger

    24. Référence de l'API de haut niveau 24.7. La classe YDataLogger Interface de contrôle de l'enregistreur de données, présent sur la plupart des capteurs Yoctopuce. La plupart des capteurs Yoctopuce sont équipés d'une mémoire non-volatile. Elle permet de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un ordinateur. La classe contrôle les paramètres globaux de cet enregistreur de données.
  • Page 605 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données. datalogger→get_friendlyName() Retourne un identifiant global de l'enregistreur de données au format NOM_MODULE.NOM_FONCTION datalogger→get_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction. datalogger→get_functionId() www.yoctopuce.com...
  • Page 606 Retourne l'identifiant matériel unique de l'enregistreur de données au format datalogger→get_logicalName() Retourne le nom logique de l'enregistreur de données. datalogger→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_recording() Retourne l'état d'activation de l'enregistreur de données.
  • Page 607 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 608 à 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 Y3DMK002.dataLogger Retourne : un objet de classe YDataLogger qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 609 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 Y3DMK002.dataLogger Retourne : un objet de classe YDataLogger qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 610 YDataLogger.nextDataLogger() données. Retourne : YDataLogger un pointeur sur un objet , correspondant au premier enregistreur de données accessible en ligne, ou null si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 611 YDataLogger.nextDataLogger() données. Paramètres : un contexte YAPI. yctx Retourne : YDataLogger un pointeur sur un objet , correspondant au premier enregistreur de données accessible en ligne, ou null si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 612 à 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 613 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 614 Modifiable. N'oubliez pas d'appeler la méthode pour sauver la modification de saveToFlash() 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 615 Vrai si l'enregistreur de données est synchronisé avec la balise de localisation. int BeaconDriven Valeurs possibles: Y_BEACONDRIVEN_INVALID Y_BEACONDRIVEN_OFF Y_BEACONDRIVEN_ON 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 616 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 617 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 618 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 619 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 620 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 621 24. Référence de l'API de haut niveau YDataLogger datalogger→Recording état d'activation de l'enregistreur de données. int Recording Valeurs possibles: Y_RECORDING_INVALID Y_RECORDING_OFF Y_RECORDING_ON Y_RECORDING_PENDING Modifiable. www.yoctopuce.com...
  • Page 622 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 623 ) java clearCache( ) function clearCache( ) 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 624 è 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 625 ) 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 626 ) string get_advertisedValue( ) string get_advertisedValue( ) YDataLogger target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'enregistreur de données (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 627 ) int get_autoStart( ) YDataLogger target get_autoStart Retourne : soit Y_AUTOSTART_OFF , soit Y_AUTOSTART_ON , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension En cas d'erreur, déclenche une exception ou retourne Y_AUTOSTART_INVALID www.yoctopuce.com...
  • Page 628 ) int get_beaconDriven( ) YDataLogger target get_beaconDriven Retourne : soit Y_BEACONDRIVEN_OFF , soit Y_BEACONDRIVEN_ON , selon vrai si l'enregistreur de données est synchronisé avec la balise de localisation En cas d'erreur, déclenche une exception ou retourne Y_BEACONDRIVEN_INVALID www.yoctopuce.com...
  • Page 629 Retourne : un entier représentant le numéro du Run actuel, correspondant au nombre de fois que le module a été mis sous tension avec la fonction d'enregistreur de données active En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRUNINDEX_INVALID www.yoctopuce.com...
  • Page 630 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 : une liste d'objets YDataSet En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 631 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 632 ) function get_errorMessage( ) 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 633 ) function get_errorType( ) 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 634 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 635 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 636 ) function get_functionId( ) async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 637 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'enregistreur de données (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant l'enregistreur de données (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 638 ) function get_logicalName( ) async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YDataLogger target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'enregistreur de données. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 639 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 640 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 641 ) async get_recording( ) int get_recording( ) int get_recording( ) YDataLogger target get_recording Retourne : une valeur parmi Y_RECORDING_OFF Y_RECORDING_ON Y_RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_RECORDING_INVALID www.yoctopuce.com...
  • Page 642 ) 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 YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 643 ) 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 Y_TIMEUTC_INVALID www.yoctopuce.com...
  • Page 644 Task<int> get_usage( ) get_usage( ) function get_usage( ) 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 Y_USAGE_INVALID www.yoctopuce.com...
  • Page 645 ) Object get_userData( ) java get_userData( ) function get_userData( ) 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 646 Si les valeurs des attributs en cache de l'enregistreur de données sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si l'enregistreur de données est joignable, false sinon www.yoctopuce.com...
  • Page 647 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 648 ) 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 649 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 650 Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 651 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 652 é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 653 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. DataLogger.findDataLogger() Retourne : un pointeur sur un objet YDataLogger accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 654 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 655 , soit Y_AUTOSTART_ON , 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 656 Paramètres : newval soit Y_BEACONDRIVEN_OFF , soit Y_BEACONDRIVEN_ON , 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 657 être préservé. Paramètres : une chaîne de caractères représentant le nom logique de l'enregistreur de données. newval 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 658 Y_RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 659 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 660 Object data) java set_userData( data) function set_userData( $data) 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 661 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() 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 662 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 663: La Classe Ydataset

    à la révision 13000. 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: <script src="../../lib/yocto_module.js"></script> in node.js: require('yoctolib-es2017/yocto_module.js'); import YoctoProxyAPI.YDataSetProxy #include "yocto_module_proxy.h"...
  • Page 664 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() Retourne un objet YMeasure résumant tout le YDataSet www.yoctopuce.com...
  • Page 665 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 666 à 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 667 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 dernière mesure. www.yoctopuce.com...
  • Page 668 ) String get_functionId( ) java async Task<string> get_functionId( ) get_functionId( ) function get_functionId( ) async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example temperature1 Retourne : une chaîne de caractères identifiant la fonction (ex: temperature1 www.yoctopuce.com...
  • Page 669 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 : une chaîne de caractères identifiant la fonction (ex: THRMCPL1-123456.temperature1 En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 670 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 671 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 672 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 673 Paramètres : index MeasuresRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
  • Page 674 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 675 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 676 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 677 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 678 Le résumé des mesures est disponible dès que a été appelé pour la première fois. loadMore() Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 679 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 680 Paramètres : index PreviewRecordCount un entier dans la plage [ -1]. Retourne : un nombre réel positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 UTC et la fin de la mesure. www.yoctopuce.com...
  • Page 681 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 682 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 683 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 684 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 685 , l'avancement est nul. Au fur et à mesure get_dataSet() des appels à , l'avancement progresse pour atteindre la valeur 100 lorsque toutes les loadMore() 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 686 à 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 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 première mesure enregistrée. www.yoctopuce.com...
  • Page 687 - 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 : YMeasure un objet www.yoctopuce.com...
  • Page 688 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 689 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 690 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 691 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 692 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 693 String get_unit( ) java async Task<string> get_unit( ) get_unit( ) function get_unit( ) 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 Y_UNIT_INVALID www.yoctopuce.com...
  • Page 694 ) 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 695 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 696: 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 697 -(double) averageValue double get_averageValue( ): double function get_averageValue( ) As Double double get_averageValue( ) double get_averageValue( ) java double get_averageValue( ) get_averageValue( ) function get_averageValue( ) get_averageValue( ) Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 698 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 699 -(double) maxValue double get_maxValue( ): double function get_maxValue( ) As Double double get_maxValue( ) double get_maxValue( ) java double get_maxValue( ) get_maxValue( ) function get_maxValue( ) get_maxValue( ) Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 700 -(double) minValue double get_minValue( ): double function get_minValue( ) As Double double get_minValue( ) double get_minValue( ) java double get_minValue( ) get_minValue( ) function get_minValue( ) get_minValue( ) Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 701 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 702 www.yoctopuce.com...

  • Page 703: 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 704: Plateformes Arm: Hf Et El

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

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

  • Page 707: Caractéristiques

    26. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module Yocto-Serial Identifiant produit YSERIAL1 † Révision matérielle Connecteur USB micro-B Largeur 20 mm Longueur 51 mm Poids Fréquence max 115200 bps Mémoire tampon 16 KB Classe de protection selon IEC 61140 classe III Temp.
  • Page 708 26. Caractéristiques www.yoctopuce.com...

Table des Matières