1. Manuels
  2. Marques
  3. Yoctopuce Manuels
  4. Adaptateurs
  5. Yocto-RS485-V2
  6. Mode d'emploi

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

Publicité

Liens rapides

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

Publicité

Table des Matières
loading

Sommaire des Matières pour Yoctopuce Yocto-RS485-V2

  • Page 1 Yocto-RS485-V2 Mode d'emploi...

  • Page 3: Table Des Matières

    ..............5.4. Protocole basé sur des trames binaires ................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 ..................... www.yoctopuce.com...
  • Page 4 7.7. Files ............................. 7.8. Quelle interface: Native, DLL ou Service? ............... 7.9. Programmation, par où commencer? ................8. Utilisation du Yocto-RS485-V2 en ligne de commande ........8.1. Installation .......................... 8.2. Utilisation: description générale ..................8.3. Contrôle de la fonction SerialPort ..................
  • Page 5 16. Utilisation du Yocto-RS485-V2 en JavaScript / EcmaScript ....16.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ....... 16.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ......16.3. Contrôle de la fonction SerialPort ................16.4. Contrôle de la partie module ..................
  • Page 6 19.4. Gestion des erreurs ....................... 20. Utilisation du Yocto-RS485-V2 avec Universal Windows Platform ..20.1. Fonctions bloquantes et fonctions asynchrones ............20.2. Installation ........................20.3. Utilisation l'API Yoctopuce dans un projet Visual Studio .......... 20.4. Contrôle de la fonction SerialPort ................
  • Page 7 26.7. Déconnexions, comportement erratique ..............26.8. RegisterHub d'un VirtualHub déconnecte le précédent ..........26.9. Commandes ignorées ....................26.10. Module endommagé ....................27. Caractéristiques ......................www.yoctopuce.com...
  • Page 8 www.yoctopuce.com...

  • Page 9: Introduction

    1. Introduction Le module Yocto-RS485-V2 est un module USB de 60x20mm qui offre un port série au standard RS485 (transmission en mode différentiel, permettant une communication à plus de 1000m). Il supporte nativement divers protocoles série, y compris MODBUS. Il dispose d'une mémoire tampon permettant au besoin de communiquer de manière asynchrone.

  • Page 10: Informations De Sécurité

    Les ingénieurs Yoctopuce se sont donné beaucoup de mal pour que votre Yocto-RS485-V2 soit facile à installer n'importe où et soit facile à piloter depuis un maximum de langages de programmation. Néanmoins, si ce module venait à vous décevoir, ou si vous avez besoin d'informations supplémentaires, n'hésitez pas à...

  • Page 11: Applications

    Le module Yocto-RS485-V2 a été conçu pour travailler uniquement avec des très basses tension de sécurité. Ne dépassez pas les tensions indiquées dans ce manuel, et ne raccordez en aucun cas sur le bornier du Yocto-RS485-V2 un fil susceptible d'être connecté au réseau secteur.
  • Page 12 www.yoctopuce.com...

  • Page 13: Présentation

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

  • Page 14: Le Yocto-Bouton

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

  • Page 15: Les Leds D'activité

    à des circuits électriques différents sont fréquents, il est doté d'une isolation renforcée (voir ci-dessous). Les LEDs d'activité Le Yocto-RS485-V2 dispose de deux LEDs vertes reflétant l'activité du port RS485, une pour la réception et la deuxième pour l'émission. L'interrupteur d'activation de terminaison Pour optimiser la qualité...

  • Page 16: Vis Et Entretoises

    2. Présentation Vis et entretoises Pour fixer le module Yocto-RS485-V2 à un support, vous pouvez placer des petites vis de 2.5mm avec une tête de 4.5mm au maximum dans les trous prévus ad-hoc. Il est conseillé de les visser dans des entretoises filetées, que vous pourrez fixer sur le support. Vous trouverez plus de détail à...

  • Page 17: Premiers Pas

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

  • Page 18: Test De La Connectivité Usb

    Yoctopuce. Vous devez raccorder votre module Yocto-RS485-V2 à l'aide d'un cable USB 2.0 de type A - micro B Si vous branchez un hub USB entre l'ordinateur et le module Yocto-RS485-V2, prenez garde à ne pas dépasser les limites de courant imposées par USB, sous peine de faire face des comportements...

  • Page 19: Localisation

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

  • Page 20: Configuration

    Firmware Le firmware du module peut être facilement mis à jour à l'aide de l'interface. Les firmwares destinés aux modules Yoctopuce se présentent sous la forme de fichiers .byn et peuvent être téléchargés depuis le site web de Yoctopuce. www.yoctopuce.com...

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

  • Page 23: Montage Et Connectique

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

  • Page 24: Connexions

    Le standard EIA/ TIA-485 exige un fil de masse. Le Yocto-RS485-V2 est un module isolé: ne raccordez pas artificiellement la masse du bus RS485 à la masse du bus USB, vous perdriez le bénéfice de l'isolation qui protège votre ordinateur.

  • Page 25: 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 26 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 27: Le Port Série

    ±15 kV. 5.1. Paramètres configurables Le port série du Yocto-RS485-V2 est capable de gérer les vitesses de communication de 110 bits/s à 250'000 Kbits/s. Il peut être configuré pour utiliser 7 ou 8 bits de données, avec ou sans parité...

  • Page 28: Protocole Basé Sur Des Lignes De Textes

    être ici utilisée. Le Yocto-RS485-V2 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 29: Protocole Modbus

    (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-RS485-V2 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 30: Protocole Wiegand

    RFID). Il existe de nombreuses variantes, mais toutes reviennent à envoyer un séquence de quelques dizaines de bits identifiant un badge. Le Yocto-RS485-V2 peut décoder les messages Wiegand de deux manières: soit envoyer la séquence de bits telle quelle, en ASCII (suite de zéro et de uns), soit rassembler les bits en octets afin de pouvoir être plus facilement interprétés.

  • Page 31: Analyseur De Communication Série

    Câblage pour utiliser le Yocto-RS485-V2 en mode analyseur. Si vous le désirez vous pouvez acheter sur le site de Yoctopuce un adaptateur prêt à l'emploi avec une fiche DB9 mâle et une prise DB9 femelle, sous la dénomination RS232-Snooping-Adapter http://www.yoctopuce.com/FR/products/accessoires-et-connectique/rs232-snooping-adapter...
  • Page 32 www.yoctopuce.com...

  • Page 33: Mesures Automatiques

    6. Mesures automatiques En plus d'offrir un moyen d'effectuer des communications série à bas niveau, le Yocto-RS485-V2 est capable de travailler à un niveau d'abstraction supérieur. Il peut interroger de manière autonome un appareil par le port série, et présenter les valeurs lues comme des mesures, à la manière de tous les capteurs Yoctopuce.
  • Page 34 Yocto-RS485-V2. Pour configurer Yocto- RS485-V2 par software, il suffi donc d'uploader le bon fichier sur le Yocto-RS485-V2 à 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 35: 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-RS485-V2: 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 à...

  • Page 36: Les Tâches Périodiques

    Les données lues lors d'une tâche périodique peuvent aussi être affectées aux fonctions genericSensor du Yocto-RS485-V2. Attention, le protocole série défini dans la configuration du Yocto-RS485-V2 doit correspondre aux besoins du job: par exemple, vous ne pourrez pas détecter une transaction MODBUS si le Yocto-RS485-V2 est configuré en mode line-based ASCII.

  • Page 37: Les Commandes

    6. Mesures automatiques perturbent les unes les autres. Le Yocto-RS485-V2 attend toujours qu'une tâche périodique se termine avant de lancer la suivante, mais par contre les tâches réactives peuvent être déclenchées à tout moment, même parallèlement à une tâche périodique.
  • Page 38 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 39 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-RS485-V2. 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 40: Les Fonctions Genericsensor

    Yocto-RS485-V2. 6.4. Les fonctions genericSensor Le Yocto-RS485-V2 dispose de 9 fonctions genericSensor, dont les valeurs peuvent être librement attribuées par les jobs qui s'exécutent sur le module. Ces fonctions genericSensor peuvent être directement accédées depuis l'API Yoctopuce à l'aide de la classe YGenericSensor. Elles peuvent aussi être configurées afin d'ajuster leur comportement à...

  • Page 41: Exemple De Configuration

    (chapitre "Data Address Map"). Dans le cas particulier, il s'agit du registre 41001. Étape 1 Configurer le Yocto-RS485-V2 en "MODBUS-RTU", avec la vitesse et la parité correspondant à la configuration de votre contrôleur REG48. Étape 2 Créer un job contenant une seule tâche périodique, qui effectue une lecture du registre MODBUS d'entrée 41001.
  • Page 42 Configuration de la fonction genericSensor pour afficher la température mesurée par le REG48. Étape 4 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 résultat ne correspond pas à ce qui était prévu, consulter les log du module. www.yoctopuce.com...

  • Page 43: 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 44: 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 45: Le Module Yocto-Rs485-V2

    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-RS485-V2 Le module Yocto-RS485-V2 est une interface RS485 isolée, avec datalogger intégré. module : Module attribut type...

  • Page 46: Module

    7.3. Module 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 YModule contrôler les paramètres généraux du module, et d'énumérer les fonctions fournies par chaque module.
  • Page 47 Chaine de caractères contenant le numéro de série, unique et préprogrammé en usine. Pour un module Yocto-RS485-V2, ce numéro de série commence toujours par RS485MK2. Il peut servir comme point de départ pour accéder par programmation à un module particulier.

  • Page 48: 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 49: Genericsensor

    YGenericSensor Yoctopuce. Elle hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: YSensor lecture de mesures, callbacks, enregistreur de données. De plus, elle permet de configurer une conversion automatique entre le signal mesuré...

  • Page 50: Datalogger

    Activation/désactivation de la mesure. 7.6. 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 51: Files

    Interface pour intéragir avec les systèmes de fichier, disponibles par exemple dans le Yocto-Color- V2, le Yocto-Serial, le YoctoHub-Ethernet et le YoctoHub-Wireless-n 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 52: Quelle Interface: Native, Dll Ou Service

    Espace disponible dans le système de fichiers pour charger des nouveaux fichiers, en octets. 7.8. Quelle interface: Native, DLL ou Service? Il y existe plusieurs méthodes pour contrôler un module USB Yoctopuce depuis un programme. Contrôle natif Dans ce cas de figure le programme pilotant votre projet est directement compilé avec une librairie qui offre le contrôle des modules.

  • Page 53: Contrôle Par Un Service

    Certain langages ne permettent tout simplement pas d'accéder facilement au niveau matériel de la machine. C'est le cas de Javascript par exemple. Pour gérer ce cas Yoctopuce offre la solution sous la forme d'un petit service, appelé VirtualHub qui lui est capable d'accéder aux modules, et votre application n'a plus qu'à...

  • Page 54: Limitation Des Librairies Yoctopuce

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

  • Page 57: Utilisation Du Yocto-Rs485-V2 En Ligne De Commande

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

  • Page 58: 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-RS485-V2, vous avez besoin de l'exécutable YSerialPort. Vous pouvez par exemple lancer: C:\>YSerialPort modbusReadInputRegisters 2 1000 1 C:\>YSerialPort...

  • Page 59: Contrôle De La Partie Module

    8. Utilisation du Yocto-RS485-V2 en ligne de commande 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 . Par YModule exemple, pour obtenir la liste de tous les modules connectés, utilisez: C:\>YModule inventory...
  • Page 60 8. Utilisation du Yocto-RS485-V2 en ligne de commande C:\>YModule inventory Vous obtenez un inventaire des modules connectés par USB, en utilisant un accès natif. Si il y a déjà une autre commande en cours qui accède aux modules en natif, cela ne fonctionnera pas. Mais si vous lancez un virtual hub et que vous lancez votre commande sous la forme: C:\>YModule -r 127.0.0.1 inventory...

  • Page 61: Utilisation Du Yocto-Rs485-V2 En Python

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

  • Page 62: Un Exemple Réel

    9. Utilisation du Yocto-RS485-V2 en Python Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. 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 63: Contrôle De La Partie Module

    9. Utilisation du Yocto-RS485-V2 en Python #!/usr/bin/python # -*- coding: utf-8 -*- import os, from yocto_api import from yocto_serialport import # Setup the API to use local USB devices. You can # use an IP address instead of 'usb' if the device # is connected to a network.
  • Page 64 9. Utilisation du Yocto-RS485-V2 en Python sys.exit("usage: demo <serial or logical name> [ON/OFF]") errmsg = YRefParam() if YAPI.RegisterHub("usb", errmsg) != YAPI.SUCCESS: sys.exit("RegisterHub error: " str(errmsg)) if len(sys.argv) < usage() = YModule.FindModule(sys.argv[1]) # # use serial or logical name m.isOnline(): if len(sys.argv) >...

  • Page 65: Enumeration Des Modules

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 66 à l'exception. • Sinon... l'exception va crasher votre programme, boum! Comme cette dernière situation n'est pas la plus souhaitable, la librairie Yoctopuce offre une autre alternative pour la gestion des erreurs, permettant de faire un programme robuste sans devoir...

  • Page 67: Utilisation Du Yocto-Rs485-V2 En C

    à la création d'un projet à neuf linké avec les librairies Yoctopuce. 10.1. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. Voici le squelette d'un fragment de code C++ qui utilise la fonction SerialPort. #include "yocto_api.h"...
  • Page 68 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-RS485-V2. 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 69 10. Utilisation du Yocto-RS485-V2 en C++ #include "yocto_api.h" #include "yocto_serialport.h" #include <iostream> #include <stdlib.h> using namespace std; int main(int argc, const char * argv[]) string errmsg; (YAPI::RegisterHub("usb", errmsg) != YAPI::SUCCESS) { cerr << "RegisterHub error : " << errmsg << endl;...

  • Page 70: Contrôle De La Partie Module

    10. Utilisation du Yocto-RS485-V2 en C++ 10.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 71 10. Utilisation du Yocto-RS485-V2 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 72: 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 73: 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 74: Intégration En Librairie Dynamique

    10. Utilisation du Yocto-RS485-V2 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 75: Utilisation Du Yocto-Rs485-V2 En C

    11.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 76: 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. 11.3. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. Voici le squelette d'un fragment de code C# qui utilise la fonction SerialPort. [...] // On active la détection des modules sur USB...
  • Page 77 11. Utilisation du Yocto-RS485-V2 en C# serialport = YSerialPort.FindSerialPort("RS485MK2-123456.MaFonction"); serialport = YSerialPort.FindSerialPort("MonModule.serialPort"); 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...

  • Page 78: Contrôle De La Partie Module

    11. Utilisation du Yocto-RS485-V2 en C# serialPort.modbusReadInputRegisters(slave, reg 30001, 1)[0]; } else if (reg >= 10001) { serialPort.modbusReadInputBits(slave, reg 10001, 1)[0]; } else { serialPort.modbusReadBits(slave, reg 1)[0]; Console.WriteLine("Current value: " + val.ToString()); Console.Write("Press ENTER to read again, Q to quit");...
  • Page 79 11. Utilisation du Yocto-RS485-V2 en C# if (args[1].ToUpper() == "OFF") { m.set_beacon(YModule.BEACON_OFF); Console.WriteLine("serial: " + m.get_serialNumber()); Console.WriteLine("logical name: " + m.get_logicalName()); Console.WriteLine("luminosity: " + m.get_luminosity().ToString()); Console.Write("beacon: "); if (m.get_beacon() == YModule.BEACON_ON) Console.WriteLine("ON"); else Console.WriteLine("OFF"); Console.WriteLine("upTime: " + (m.get_upTime() / 1000 ).ToString() +...

  • Page 80: Gestion Des Erreurs

    11. Utilisation du Yocto-RS485-V2 en C# if (m.isOnline()) { newname = args[1]; if (!YAPI.CheckLogicalName(newname)) { Console.WriteLine("Invalid name (" newname + ")"); Environment.Exit(0); m.set_logicalName(newname); m.saveToFlash(); // do not forget this Console.Write("Module: serial= " + m.get_serialNumber()); Console.WriteLine(" / name= " + m.get_logicalName());...
  • Page 81 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 82 www.yoctopuce.com...

  • Page 83: Utilisation Du Yocto-Rs485-V2 Avec Labview

    Virtual Instruments (VI) des programmes LabVIEW. Avec la programmation visuelle, dessiner des algorithmes complexes devient très vite fastidieux, c'est pourquoi la librairie Yoctopuce pour LabVIEW a été pensée pour être aussi simple de possible à utiliser. Autrement dit, LabVIEW étant un environnement extrêmement différent des autres langages supportés par l'API Yoctopuce, vous rencontrerez des différences majeures entre l'API LabVIEW et...

  • Page 84: 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 85 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 86: 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 87: 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 88 \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 89: Présentation Des Vis Yoctopuce

    Yoctopuce et avec tous les VIs de l'API 12.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 90: 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 91: 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 92: 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 93 12. Utilisation du Yocto-RS485-V2 avec LabVIEW Utilisation des sorties hardware name et isOnline Les VIs de l'API Yoctopuce ne sont qu'une porte d'entrée sur la mécanique interne de la librairie Yoctopuce. Cette mécanique fonctionne indépendamment des VIs Yoctopuce. En effet, la plupart des communications avec les modules électroniques sont gérées automatiquement en arrière plan.

  • Page 94: 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 95: 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 96: Gestion Du Datalogger

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

    12. Utilisation du Yocto-RS485-V2 avec LabVIEW Le VI YDataLoggerContents Extraire les données de l'enregistreur d'un module Yoctopuce est un processus lent qui peut prendre plusieurs dizaines de secondes. C'est pourquoi le VI qui permet cette opération a été conçu pour fonctionner de manière itérative.

  • Page 98: Un Mot Sur Les Performances

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

    Yoctopuce pour LabVIEW 12.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 100 www.yoctopuce.com...

  • Page 101: Utilisation Du Yocto-Rs485-V2 En Java

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

  • Page 102: Un Exemple Réel

    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 103: Contrôle De La Partie Module

    13. Utilisation du Yocto-RS485-V2 en Java YSerialPort serialPort; (args.length > 0) { serialPort = YSerialPort.FindSerialPort(args[0]); } else { serialPort = YSerialPort.FirstSerialPort(); (serialPort == null) { System.out.println("No module connected (check USB cable)"); System.exit(1); slave, reg, val; String cmd; InputStreamReader inputStreamReader = new InputStreamReader(System.in);...
  • Page 104 13. Utilisation du Yocto-RS485-V2 en Java import com.yoctopuce.YoctoAPI.*; import java.util.logging.Level; import java.util.logging.Logger; 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 ("...

  • Page 105: Enumeration Des Modules

    13. Utilisation du Yocto-RS485-V2 en Java import com.yoctopuce.YoctoAPI.*; 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 106: 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 107: Utilisation Du Yocto-Rs485-V2 Avec Android

    En revanche, comme il n'existe pas de VirtualHub tournant sous Android, il n'est pas possible de prendre le contrôle à distance de modules Yoctopuce pilotés par une machine sous Android. Bien sûr, l'API Java pour Android reste parfaitement capable de se connecter à un VirtualHub tournant sur un autre OS.

  • Page 108: 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 109: Lancement Automatique

    14. Utilisation du Yocto-RS485-V2 avec Android </manifest> Lors du premier accès à un module Yoctopuce, Android va ouvrir une fenêtre pour informer l'utilisateur que l'application va accéder module connecté. L'utilisateur peut refuser ou autoriser l a c c è s au périphérique. Si l'utilisateur accepte, l'application pourra accéder au périphérique connecté...

  • Page 110: Contrôle De La Fonction Serialport

    14. Utilisation du Yocto-RS485-V2 avec Android 14.5. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. 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 111 14. Utilisation du Yocto-RS485-V2 avec Android Un exemple réel Lancez votre environnement java et ouvrez le projet correspondant, fourni dans le répertoire Examples/Doc-Examples de la librairie Yoctopuce. Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret.
  • Page 112 14. Utilisation du Yocto-RS485-V2 avec Android @Override protected void onStop() super.onStop(); YAPI.FreeAPI(); private _doModbus(String hwid, String slavefield, String registerfield, String cmdfield) slave; reg; try { slave = Integer.parseInt(slavefield); = Integer.parseInt(registerfield); } catch (NumberFormatException ex) { Toast.makeText(this,ex.toString(),Toast.LENGTH_LONG).show(); return 0; try {...

  • Page 113: Contrôle De La Partie Module

    14. Utilisation du Yocto-RS485-V2 avec Android 14.6. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci-dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation. package com.yoctopuce.doc_examples;...
  • Page 114 14. Utilisation du Yocto-RS485-V2 avec Android field.setText(module.getSerialNumber()); field = (TextView) findViewById(R.id.logicalnamefield); field.setText(module.getLogicalName()); field = (TextView) findViewById(R.id.luminosityfield); field.setText(String.format("%d%%", module.getLuminosity())); field = (TextView) findViewById(R.id.uptimefield); field.setText(module.getUpTime() / 1000 " sec"); field = (TextView) findViewById(R.id.usbcurrentfield); field.setText(module.getUsbCurrent() + " mA"); Switch = (Switch) findViewById(R.id.beaconswitch); sw.setChecked(module.getBeacon() == YModule.BEACON_ON);...
  • Page 115 14. Utilisation du Yocto-RS485-V2 avec Android import android.app.Activity; import android.os.Bundle; import android.view.View; import android.widget.AdapterView; import android.widget.AdapterView.OnItemSelectedListener; import android.widget.ArrayAdapter; import android.widget.EditText; import android.widget.Spinner; import android.widget.TextView; import android.widget.Toast; import com.yoctopuce.YoctoAPI.YAPI; import com.yoctopuce.YoctoAPI.YAPI_Exception; import com.yoctopuce.YoctoAPI.YModule; public class SaveSettings extends Activity implements OnItemSelectedListener private ArrayAdapter<String> aa;...
  • Page 116 14. Utilisation du Yocto-RS485-V2 avec Android String hwid = parent.getItemAtPosition(pos).toString(); module = YModule.FindModule(hwid); DisplayModuleInfo(); @Override public void onNothingSelected(AdapterView<?> arg0) public void saveName(View view) (module == null) return; EditText edit = (EditText) findViewById(R.id.newname); String newname = edit.getText().toString(); try { if (!YAPI.CheckLogicalName(newname)) { Toast.makeText(getApplicationContext(),...

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

  • Page 119: Utilisation Du Yocto-Rs485-V2 En Typescript

    JavaScript avant l'exécution, pour être ensuite interprêté par n'importe quel navigateur Web ou par Node.js. Cette librairie de programmation Yoctopuce permet donc de coder des applications JavaScript tout en bénéficiant d'un typage fort. Comme notre librairie EcmaScript, elle utilise les fonctionnalités asynchrones introduites dans la version ECMAScript 2017 et qui sont maintenant disponibles nativement dans tous les environnements JavaScript modernes.

  • Page 120: Utiliser La Librairie Yoctopuce Pour Typescript

    • Installez ensuite TypeScript sur votre machine à l'aide de la commande: npm install -g typescript 2. Connectez-vous ensuite sur le site Web de Yoctopuce et téléchargez les éléments suivants: • La librairie de programmation pour TypeScript • Le programme VirtualHub pour Windows, Mac OS X ou Linux selon l'OS que vous utilisez.

  • Page 121: Contrôle De La Fonction Serialport

    15.3. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. Voici le squelette d'un fragment de code TypeScript qui utilise la fonction SerialPort. // En Node.js, on référence la librairie via son package NPM // En HTML, on utiliserait plutôt un path relatif (selon l'environnement)

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

    à en faire un petit programme d'exemple concret. Si le Yocto-RS485-V2 n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où est branché le 127.0.0.1...
  • Page 123 15. Utilisation du Yocto-RS485-V2 en TypeScript import * as readline from 'readline'; let serialPort: YSerialPort; let target: { slave: number, reg: number } = { slave: 0, reg: let g_step: number = 1; let rl: readline.Interface; async function startDemo(): Promise<void>...
  • Page 124 15. Utilisation du Yocto-RS485-V2 en TypeScript if (chunk.charAt(0) != && chunk.charAt(0) != && (target.reg % 30000) < 10000) { (target.reg >= 30001) { await serialPort.modbusWriteRegister(target.slave, target.reg - 30001, val); } else { await serialPort.modbusWriteBit(target.slave, target.reg - 1, val); await printModbusValue(target.slave, target.reg);...

  • Page 125: Le Même Exemple, Mais Dans Un Navigateur

    Le même exemple, mais dans un navigateur Si vous voulez voir comment utiliser la librairie dans un navigateur plutôt que dans Node.js, changez de répertoire et allez dans example_html/Doc-GettingStarted-Yocto-RS485-V2. Vous y trouverez un fichier html , et un fichier TypeScript similaire au code ci-dessus, mais avec app.html...
  • Page 126 15. Utilisation du Yocto-RS485-V2 en TypeScript if(process.argv.length < 3) { console.log("usage: npm run demo <serial or logicalname> [ ON | OFF ]"); } else { startDemo(process.argv.slice(2)); Chaque propriété du module peut être lue grâce à une méthode du type , et les get_xxxx() propriétés qui se sont pas en lecture seule peuvent être modifiées à...

  • Page 127: 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 128 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 129: Utilisation Du Yocto-Rs485-V2 En Javascript / Ecmascript

    JavaScript / EcmaScript 2017, afin de la différentier de la précédente Librairie pour JavaScript qu'elle remplace. Cette librairie permet d'accéder aux modules Yoctopuce depuis tous les environnements JavaScript modernes. Elle fonctionne aussi bien depuis un navigateur internet que dans un environnement Node.js.

  • Page 130: Fonctions Bloquantes Et Fonctions Asynchrones En Javascript

    16. Utilisation du Yocto-RS485-V2 en JavaScript / EcmaScript 16.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 131: 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 132: Compatibilité Avec L'ancienne Librairie Javascript

    16. Utilisation du Yocto-RS485-V2 en JavaScript / EcmaScript npm instal -g babel-cli npm instal babel-preset-env Normalement vous demanderez à Babel de poser les fichiers transpilés dans un autre répertoire, nommé par exemple. Pour ce faire, utilisez par exemple les commandes suivantes: comopat babel --presets env demo.js --out-dir compat/...

  • Page 133: Contrôle De La Fonction Serialport

    Ce dernier appel asynchrone peut aussi être formulé comme: myModule.get_syncProxy().then(logInfoProxy); 16.3. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. 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 &lt;script src="..."&gt;...
  • Page 134 à en faire un petit programme d'exemple concret. Si le Yocto-RS485-V2 n'est pas branché sur la machine où fonctionne le navigateur internet, remplacez dans l'exemple l'adresse par l'adresse IP de la machine où...
  • Page 135 16. Utilisation du Yocto-RS485-V2 en JavaScript / EcmaScript console.log('Using device ' + serial); serialPort = YSerialPort.FirstSerialPort(); = readline.createInterface({ input: process.stdin, output: process.stdout console.log('Please enter the MODBUS slave address (1...255)'); console.log('Slave:'); rl.on('line', handleInput); async function handleInput(chunk) { = parseInt(chunk); switch (g_step) {...
  • Page 136 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-RS485-V2. Vous y trouverez un fichier html, avec une section JavaScript similaire au code précédent, mais avec quelques variantes pour permettre une interaction à...

  • Page 137: Contrôle De La Partie Module

    16. Utilisation du Yocto-RS485-V2 en JavaScript / EcmaScript function slavechanged() { slave = parseInt(document.getElementById('slaveinput').value); if (slave > 0) { document.getElementById('slaveinput').style.display = 'none'; document.getElementById('slavevalue').innerHTML = slave; document.getElementById('regspan').style.display = ''; async function regchanged() { reg = parseInt(document.getElementById('reginput').value); let res; if (reg > 0) { let value = await modbus_readvalue(slave, reg);...
  • Page 138 16. Utilisation du Yocto-RS485-V2 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 139 16. Utilisation du Yocto-RS485-V2 en JavaScript / EcmaScript module = YModule.FindModule(args[0]); if(await module.isOnline()) { if(args.length > 1) { newname = args[1]; if (!await YAPI.CheckLogicalName(newname)) { console.log("Invalid name (" newname + ")"); process.exit(1); await module.set_logicalName(newname); await module.saveToFlash(); console.log('Current name: '+await module.get_logicalName());...

  • Page 140: 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 141: Utilisation Du Yocto-Rs485-V2 En Php

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

  • Page 142: Un Exemple Réel

    Yocto-RS485-V2. YAPI::RegisterHub La fonction permet d'indiquer sur quelle machine se trouve les modules YAPI::RegisterHub Yoctopuce, ou plus exactemenent sur quelle machine tourne le programme VirtualHub. Dans notre cas l'adresse indique la machine locale, en utilisant le port (le port 127.0.0.1:4444 4444 standard utilisé...
  • Page 143 17. Utilisation du Yocto-RS485-V2 en PHP browser favori. Vous trouverez aussi ce code dans le répertoire Examples/Doc-GettingStarted- Yocto-RS485-V2 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 144: Contrôle De La Partie Module

    17. Utilisation du Yocto-RS485-V2 en PHP YAPI::FreeAPI(); ?> <input type='submit'> </FORM> </BODY> </HTML> 17.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 145 17. Utilisation du Yocto-RS485-V2 en PHP YAPI::FreeAPI(); ?> <input type='submit' value='refresh'> </FORM> </BODY> </HTML> Chaque propriété du module peut être lue grâce à une méthode du type , et les get_xxxx() propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode set_xxx Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux chapitre API...

  • Page 146: 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 147 17. Utilisation du Yocto-RS485-V2 en PHP Configuration DSL typique, les machines du LAN sont isolées de l'extérieur par le router DSL Ce qui, transposé en terme de réseau, donne : les appareils connectés sur un réseau domestique peuvent communiquer entre eux en utilisant une adresse IP locale (du genre 192.168.xxx.yyy), et contacter des serveurs sur Internet par leur adresse publique, mais vu de l'extérieur, il n'y a qu'une...
  • Page 148 17. Utilisation du Yocto-RS485-V2 en PHP NAT du routeur DSL. Le problème de cette solution est qu'il expose le serveur de domotique aux attaques externes. L'API par callback HTTP résoud ce problème sans qu'il soit nécessaire de modifier la configuration du routeur DSL.

  • Page 149: 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 150: Gestion Des Erreurs

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

  • Page 151: Utilisation Du Yocto-Rs485-V2 En Visualbasic .Net

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

    18.3. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. 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 153: Lancez Microsoft Visualbasic Et Ouvrez Le Projet Exemple Correspondant, Fourni Dans Le Répertoire

    18. Utilisation du Yocto-RS485-V2 en VisualBasic .NET 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 154: Contrôle De La Partie Module

    18. Utilisation du Yocto-RS485-V2 en VisualBasic .NET Console.WriteLine("Press ENTER to read again, Q to quit") ((reg Mod 30000) < 10000) Then Console.WriteLine(" or enter a new value") = Console.ReadLine() "q" "Q" Then End (cmd <> "" (reg Mod 30000) < 10000) Then = Convert.ToInt32(cmd)
  • Page 155 18. Utilisation du Yocto-RS485-V2 en VisualBasic .NET End Module Chaque propriété du module peut être lue grâce à une méthode du type , et les get_xxxx() propriétés qui se sont pas en lecture seule peuvent être modifiées à l'aide de la méthode set_xxx Pour plus de détails concernant ces fonctions utilisées, reportez-vous aux chapitre API...

  • Page 156: 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 157 18. Utilisation du Yocto-RS485-V2 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() , une méthode retournera une valeur NomDeClasse.STATE_INVALID get_currentValue , etc. Dans tous les cas, la valeur retournée sera du NomDeClasse.CURRENTVALUE_INVALID...
  • Page 158 www.yoctopuce.com...

  • Page 159: Utilisation Du Yocto-Rs485-V2 En Delphi

    19.2. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. Voici le squelette d'un fragment de code Delphi qui utilise la fonction SerialPort.
  • Page 160 [...] 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-RS485-V2.
  • Page 161 19. Utilisation du Yocto-RS485-V2 en Delphi program helloworld; {$APPTYPE CONSOLE} uses SysUtils, Windows, yocto_api, yocto_serialport; errmsg,line : string; serialPort : TYserialport; slave,reg: integer; res : TLongIntArray; cmd :string; : integer; begin // Setup the API to use local USB devices. You can // use an IP address instead of 'usb' if the device // is connected to a network.

  • Page 162: Contrôle De La Partie Module

    19. Utilisation du Yocto-RS485-V2 en Delphi 19.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 163 19. Utilisation du Yocto-RS485-V2 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 164: 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 165 19. Utilisation du Yocto-RS485-V2 en Delphi type attendu, et 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.
  • Page 166 www.yoctopuce.com...

  • Page 167: Utilisation Du Yocto-Rs485-V2 Avec Universal Windows Platform

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

  • Page 168: Installation

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

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

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

    20. Utilisation du Yocto-RS485-V2 avec Universal Windows Platform val; (reg >= 40001) { = (await serialPort.modbusReadRegisters(slave, reg 40001, 1))[0]; } else if (reg >= 30001) { = (await serialPort.modbusReadInputRegisters(slave, reg 30001, 1))[0]; } else if (reg >= 10001) { = (await serialPort.modbusReadInputBits(slave, reg...
  • Page 172 20. Utilisation du Yocto-RS485-V2 avec Universal Windows Platform WriteLine("ON"); else WriteLine("OFF"); WriteLine("upTime: " + (await m.get_upTime() / 1000) + " sec"); WriteLine("USB current: " + await m.get_usbCurrent() + " mA"); WriteLine("Logs:\r\n" + await m.get_lastLogs()); } else { WriteLine(Target " not connected on"...

  • Page 173: 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 174 20. Utilisation du Yocto-RS485-V2 avec Universal Windows Platform Dans la librairie Universal Windows Platform, le traitement d'erreur est implémenté au moyen d'exceptions. Vous devrez donc intercepter et traiter correctement ces exceptions si vous souhaitez avoir un projet fiable qui ne crashera pas des que vous débrancherez un module.

  • Page 175: Utilisation Du Yocto-Rs485-V2 En Objective-C

    à vos projets. 21.1. Contrôle de la fonction SerialPort Il suffit de quelques lignes de code pour piloter un Yocto-RS485-V2. Voici le squelette d'un fragment de code Objective-C qui utilise la fonction SerialPort. #import "yocto_api.h"...
  • Page 176 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-RS485-V2. [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 177 21. Utilisation du Yocto-RS485-V2 en Objective-C NSError *error; char cmd[50] = {0}; @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) { NSLog(@"RegisterHub error: %@", [error localizedDescription]); return YSerialPort *serialPort; (argc > 1) {...

  • Page 178: Contrôle De La Partie Module

    21. Utilisation du Yocto-RS485-V2 en Objective-C 21.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 179: Ce Petit Exemple Ci-Dessous Vous Permet Changer Le Nom Logique

    21. Utilisation du Yocto-RS485-V2 en Objective-C méthode . Ce petit exemple ci-dessous vous permet changer le nom logique revertFromFlash d'un module. #import <Foundation/Foundation.h> #import "yocto_api.h" static void usage(const char *exe) NSLog(@"usage: %s <serial> <newLogicalName>\n", exe); exit(1); main (int argc, const char...

  • Page 180: 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 181 21. Utilisation du Yocto-RS485-V2 en Objective-C méthodes . Ce sont les même informations qui auraient été errType() errMessage() associées à l'exception si elles avaient été actives. www.yoctopuce.com...
  • Page 182 www.yoctopuce.com...

  • Page 183: 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 184: Exemple D'utilisation Avec Matlab

    22. 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 185: 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 186: 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-RS485-V2 avec le numéro de de série RS485MK2-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.

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

    22.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 188 (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 189: Inventaire Des Modules

    22. 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 190: 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 191: 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 192: L'initialisation

    à 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 193 Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).

  • Page 194: Fonction Callback Générique

    Prog-EventBased. 23.2. L'enregistreur de données Votre Yocto-RS485-V2 est équipé d'un enregistreur de données, aussi appelé datalogger, capable d'enregistrer en continu les mesures effectuées par le module. La fréquence d'enregistrement maximale est de cent fois par secondes (i.e. "100/s"), et la fréquence minimale est de une fois par heure (i.e.

  • Page 195: 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-RS485-V2, il faut appeler la méthode de la fonction désirée, en spécifiant l'intervalle de temps qui get_recordedData() nous intéresse.
  • Page 196 Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-RS485-V2 n'ayant pas de batterie, il n'est pas capable de deviner tout seul l'heure qu'il est au moment de sa mise sous tension. Néanmoins, le Yocto-RS485-V2 va automatiquement essayer de se mettre à...

  • Page 197: Calibration Des Senseurs

    L'API Yoctopuce offre le moyen de re-calibrer les valeurs mesurées par votre Yocto-RS485-V2. Il ne n'agit pas de modifier les réglages hardware du module, mais plutôt d'effectuer une transformation a posteriori des mesures effectuées par le capteur.
  • Page 198 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 199: 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 200 23. Programmation avancée valeur avant de la renvoyer, permettant ainsi de corriger les mesures de manière totalement transparente. www.yoctopuce.com...

  • Page 201: Mise À Jour Du Firmware

    "mise à jour" et sera listé en dessous des modules connectés. 24.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 202: 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 203: 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 204: 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 205: Référence De L'api De Haut Niveau

    25. 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-RS485-V2. La syntaxe et les types précis peuvent varier d'un langage à l'autre mais, sauf avis contraire toutes sont disponibles dans chaque language. Pour une information plus précise sur les types des arguments et des valeurs de retour dans un langage donné, veuillez vous référer au fichier de...

  • Page 206: 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 207 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 208 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 209: Paramètres

    . Lorsqu'on configure un nom logique avec une chaîne incorrecte, les caractères invalides sont ignorés. Paramètres : name une chaîne de caractères contenant le nom vérifier. Retourne : true false si le nom est valide, dans le cas contraire. www.yoctopuce.com...
  • Page 210 Désactive le cache de callback HTTP. function ClearHTTPCallbackCacheDir( $bool_removeFiles) Cette méthode désctive la cache de callback HTTP, et permet également d'en effacer le contenu. Paramètres : Vrai pour effacer le contenu du répertoire de cache. bool_removeFiles Retourne : nothing. www.yoctopuce.com...
  • Page 211 DisableExceptions( ) void DisableExceptions( ) DisableExceptions( ) function DisableExceptions( ) async DisableExceptions( ): Promise<void> async DisableExceptions( ) Lorsque les exceptions sont désactivées, chaque fonction retourne une valeur d'erreur spécifique selon son type, documentée dans ce manuel de référence. www.yoctopuce.com...
  • Page 212 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 213 (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 214 25. Référence de l'API de haut niveau YAPI.FreeAPI() YAPI YAPI.FreeAPI() Attends que toutes les communications en cours avec les modules Yoctopuce soient terminées puis libère les ressources utilisées par la librairie Yoctopuce. function yFreeAPI( ) void FreeAPI( ) +(void) FreeAPI...
  • Page 215 25. Référence de l'API de haut niveau YAPI.GetAPIVersion() YAPI YAPI.GetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée. function yGetAPIVersion( ) string GetAPIVersion( ) +(NSString*) GetAPIVersion string yGetAPIVersion( ): string function GetAPIVersion( ) As String static String GetAPIVersion( ) static String GetAPIVersion( )
  • Page 216 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 217 GetDeviceListValidity( ) int GetDeviceListValidity( ) java async Task<int> GetDeviceListValidity( ) GetDeviceListValidity( ) function GetDeviceListValidity( ) async GetDeviceListValidity( ): Promise<number> async GetDeviceListValidity( ) Note: Cette fonction doit être appelée après yInitAPI Retourne : le nombre de secondes entre chaque énumération. www.yoctopuce.com...
  • Page 218 . 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 219 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 220 25. Référence de l'API de haut niveau YAPI.GetLog() YAPI YAPI.GetLog() Récupère les messages de logs de la librairie de communication Yoctopuce. static string GetLog( string lastLogLine) static string GetLog( string lastLogLine) Cette méthode permet de récupérer progressivement les messages de logs, ligne par ligne. La méthode doit être appelée en boucle, jusqu'à...
  • Page 221 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 222 GetTickCount( ) GetTickCount( ): number GetTickCount( ) Ce compteur peut être utilisé pour calculer des délais en rapport avec les modules Yoctopuce, dont la base de temps est aussi la milliseconde. Retourne : un long entier contenant la valeur du compteur de millisecondes.

  • Page 223: Paramètres

    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 224 25. Référence de l'API de haut niveau YAPI.InitAPI() YAPI YAPI.InitAPI() Initialise la librairie de programmation de Yoctopuce explicitement. function yInitAPI( mode, errmsg) YRETCODE InitAPI( int mode, string errmsg) +(YRETCODE) InitAPI :(int) mode :(NSError**) errmsg integer yInitAPI( mode: integer, var errmsg: string): integer...

  • Page 225: Alternative Plus Tolerante À Yregisterhub

    "usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 226 RegisterDeviceArrivalCallback( $arrivalCallback) async RegisterDeviceArrivalCallback( arrivalCallback: YDeviceUpdateCallback| null): Promise<void> async RegisterDeviceArrivalCallback( arrivalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : arrivalCallback une procédure qui prend un YModule en paramètre, ou null www.yoctopuce.com...
  • Page 227 RegisterDeviceRemovalCallback( $removalCallback) async RegisterDeviceRemovalCallback( removalCallback: YDeviceUpdateCallback| null): Promise<void> async RegisterDeviceRemovalCallback( removalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : removalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
  • Page 228 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 229 "usb","callback", ou l'URL racine du VirtualHub à utiliser. errmsg une chaîne de caractères passée par référence, dans laquelle sera stocké un éventuel message d'erreur. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 230 , 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 231 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 232 RegisterLogFunction( LogCallback logfun) java void RegisterLogFunction( LogHandler logfun) RegisterLogFunction( logfun) async RegisterLogFunction( logfun: YLogCallback): Promise<number> async RegisterLogFunction( logfun) Utile pour débugger le fonctionnement de l'API. Paramètres : logfun une procedure qui prend une chaîne de caractère en paramètre, www.yoctopuce.com...
  • Page 233 à 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 234 USB. Ce paramètre n'affecte pas les callbacks de changement de valeur Note: Cette fonction doit être appelée après yInitAPI Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en cacheValidityMs millisecondes. www.yoctopuce.com...
  • Page 235 (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 236 à un réseau GSM où le trafic est facturé. Ce paramètre n'affecte pas les modules connectés par USB, ni le fonctionnement des callback de connexion/déconnexion de module. Note: Cette fonction doit être appelée après yInitAPI Paramètres : nombre de secondes entre chaque énumération. deviceListValidity www.yoctopuce.com...
  • Page 237 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 238 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 239 être fournis, pour être passés à la fonction de callback si nécessaire. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 240 ê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 241 à lire périodiquement les informations en provenance des modules Yoctopuce en appelant la fonction yHandleEvents() afin de se maintenir à jour. Cette fonction peut signaler une erreur au cas à la communication avec un module Yoctopuce ne se passerait pas comme attendu. Paramètres : ms_duration un entier correspondant à...
  • Page 242 é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 243 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 244 25. Référence de l'API de haut niveau YAPI.UnregisterHub() YAPI YAPI.UnregisterHub() Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. function yUnregisterHub( url) void UnregisterHub( string url) +(void) UnregisterHub :(NSString *) yUnregisterHub( url: string)
  • Page 245 25. Référence de l'API de haut niveau YAPI.UpdateDeviceList() YAPI YAPI.UpdateDeviceList() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList( errmsg) YRETCODE UpdateDeviceList( string errmsg) +(YRETCODE) UpdateDeviceList :(NSError**) errmsg integer yUpdateDeviceList( var errmsg: string): integer function UpdateDeviceList( ByRef...
  • Page 246 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 247: La Classe Ymodule

    25.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 248 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module. module→get_firmwareRelease() Retourne la version du logiciel embarqué du module. module→get_functionIds(funType) Retourne les identifiants matériels des fonctions correspondant au type passé en argument. module→get_hardwareId() Retourne l'identifiant unique du module. module→get_icon2d() www.yoctopuce.com...
  • Page 249 Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→load_async(msValidity, callback, context) Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→log(text) Ajoute un message arbitraire dans les logs du module. www.yoctopuce.com...
  • Page 250 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 251 Retourne : YModule un objet de classe qui permet ensuite de contrôler le module ou d'obtenir de plus amples informations sur le module. www.yoctopuce.com...
  • Page 252 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le module sans ambiguïté, par exemple MyDevice.module Retourne : YModule un objet de classe qui permet ensuite de contrôler le module. www.yoctopuce.com...
  • Page 253 FirstModule( ): YModule | null static FirstModule( ) Utiliser la fonction pour itérer sur les autres modules. YModule.nextModule() Retourne : un pointeur sur un objet YModule , correspondant au premier module accessible en ligne, ou null aucun module n'a été trouvé. www.yoctopuce.com...
  • Page 254 25. Référence de l'API de haut niveau YModule module→Beacon état de la balise de localisation. int Beacon Modifiable. Allume ou éteint la balise de localisation du module. www.yoctopuce.com...
  • Page 255 25. Référence de l'API de haut niveau YModule module→FirmwareRelease Version du logiciel embarqué du module. string FirmwareRelease www.yoctopuce.com...
  • Page 256 25. 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 257 25. 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 258 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 259 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 260 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 261 25. 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 262 25. 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 263 25. 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 264 25. 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 265 Retourne : le path du fichier .byn à utiliser, ou une chaîne vide si aucun firmware plus récent n'est disponible En cas d'erreur, déclenche une exception ou retourne une chaine de caractère qui comment par "error:". www.yoctopuce.com...
  • Page 266 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du module. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 267 String describe( ) java describe( ) function describe( ) async describe( ): Promise<string> async describe( ) Ce texte peut contenir soit le nom logique du module, soit son numéro de série. Retourne : une chaîne de caractères décrivant le module www.yoctopuce.com...

  • Page 268: En Cas D'erreur, Déclenche Une Exception Ou Retourne

    Promise<Uint8Array> async download( pathname) byte[] download( string pathname) string download( string pathname) YModule target download pathname Paramètres : pathname nom complet du fichier Retourne : le contenu du fichier chargé En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
  • Page 269 à 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 270 ) int functionCount( ) java functionCount( ) function functionCount( ) async functionCount( ): Promise<number> async functionCount( ) Retourne : le nombre de fonctions sur le module En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 271 à 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 272 à 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 273 à 0 pour la première fonction. Retourne : une chaîne de caractères correspondant au type de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 274 à 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 275 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 276 ): Promise<YModule_Beacon> async get_beacon( ) int get_beacon( ) int get_beacon( ) YModule target get_beacon Retourne : YModule.BEACON_OFF YModule.BEACON_ON soit , soit , selon l'état de la balise de localisation En cas d'erreur, déclenche une exception ou retourne YModule.BEACON_INVALID www.yoctopuce.com...
  • Page 277 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du module www.yoctopuce.com...
  • Page 278 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du module...
  • Page 279 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.FIRMWARERELEASE_INVALID www.yoctopuce.com...
  • Page 280 $funType) async get_functionIds( funType: string): Promise<string[] async get_functionIds( funType) string[] get_functionIds( string funType) vector<string> get_functionIds( string funType) YModule target get_functionIds funType Paramètres : funType Le type de fonction (Relay, LightSensor, Voltage,...) Retourne : un tableau de chaînes de caractère. www.yoctopuce.com...
  • Page 281 ) 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 282 ) 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 283 ) YModule target get_lastLogs Cette méthode retourne les derniers logs qui sont encore stocké dans le module. Retourne : une chaîne de caractère contenant les derniers logs du module. En cas d'erreur, déclenche une exception ou retourne YAPI_INVALID_STRING www.yoctopuce.com...
  • Page 284 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YModule target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du module En cas d'erreur, déclenche une exception ou retourne YModule.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 285 ): Promise<number> async get_luminosity( ) int get_luminosity( ) int get_luminosity( ) YModule target get_luminosity Retourne : un entier représentant la luminosité des leds informatives du module (valeur entre 0 et 100) En cas d'erreur, déclenche une exception ou retourne YModule.LUMINOSITY_INVALID www.yoctopuce.com...
  • Page 286 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 287 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.PERSISTENTSETTINGS_INVALID www.yoctopuce.com...
  • Page 288 ) async get_productId( ): Promise<number> async get_productId( ) int get_productId( ) int get_productId( ) YModule target get_productId Retourne : un entier représentant l'identifiant USB du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTID_INVALID www.yoctopuce.com...
  • Page 289 ): Promise<string> async get_productName( ) string get_productName( ) string get_productName( ) YModule target get_productName Retourne : une chaîne de caractères représentant le nom commercial du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTNAME_INVALID www.yoctopuce.com...
  • Page 290 La révision originale du retourne la valeur 1, la révision B retourne la valeur 2, etc. Retourne : un entier représentant le numéro uméro de révision du module hardware, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.PRODUCTRELEASE_INVALID www.yoctopuce.com...
  • Page 291 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YModule.REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...
  • Page 292 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YModule target get_serialNumber Retourne : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne YModule.SERIALNUMBER_INVALID www.yoctopuce.com...
  • Page 293 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 294: Retourne Le Numbre De Millisecondes Écoulées Depuis La Mise Sous Tension Du Module

    ): Promise<number> async get_upTime( ) long get_upTime( ) s64 get_upTime( ) YModule target get_upTime Retourne : un entier représentant le numbre de millisecondes écoulées depuis la mise sous tension du module En cas d'erreur, déclenche une exception ou retourne YModule.UPTIME_INVALID www.yoctopuce.com...
  • Page 295 ): Promise<string> async get_url( ) string get_url( ) string get_url( ) YModule target get_url Si le module est connecté par USB la chaîne de caractère 'usb' est retournée. Retourne : une chaîne de caractère contenant l'URL du module. www.yoctopuce.com...
  • Page 296 ): Promise<number> async get_usbCurrent( ) int get_usbCurrent( ) int get_usbCurrent( ) YModule target get_usbCurrent Retourne : un entier représentant le courant consommé par le module sur le bus USB, en milliampères En cas d'erreur, déclenche une exception ou retourne YModule.USBCURRENT_INVALID www.yoctopuce.com...
  • Page 297 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 298 ) YModule target get_userVar Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Retourne : un entier représentant la valeur entière précédemment stockée dans cet attribut En cas d'erreur, déclenche une exception ou retourne YModule.USERVAR_INVALID www.yoctopuce.com...
  • Page 299 YModule target hasFunction funcId La méthode prend en paramètre l'identifiant de la fonction (relay1, voltage2,...) et retourne un booléen. Paramètres : funcId identifiant matériel de la fonction Retourne : vrai si le module inclut la fonction demandée www.yoctopuce.com...
  • Page 300 Si les valeurs des attributs du module en cache sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le module est joignable, sinon www.yoctopuce.com...
  • Page 301 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 302 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 303 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 304 être inclus dans la chaîne de caractère. Paramètres : text le message à ajouter aux logs du module. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 305 Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les modules sont retournés. Si vous souhaitez retrouver un module spécifique, utilisez Module.findModule() avec un hardwareID ou un nom logique. Retourne : YModule null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 306 YModule target reboot secBeforeReboot Paramètres : secBeforeReboot nombre de secondes avant de redémarrer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 307 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 308 ConfigChangeCallback callback) int registerConfigChangeCallback( ConfigChangeCallback callback) java async Task<int> registerConfigChangeCallback( ConfigChangeCallback callback) registerConfigChangeCallback( callback) function registerConfigChangeCallback( $callback) async registerConfigChangeCallback( callback: YModuleConfigChangeCallback | null): Promise<number> async registerConfigChangeCallback( callback) Paramètres : callback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
  • Page 309 $callback) async registerLogCallback( callback: YModuleLogCallback | null): Promise<number> async registerLogCallback( callback) Utile pour débugger le fonctionnement d'un module Yoctopuce. Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'objet module qui a produit un log, un chaîne de caractère qui contiens le log...
  • Page 310 ) async revertFromFlash( ): Promise<number> async revertFromFlash( ) int revertFromFlash( ) int revertFromFlash( ) YModule target revertFromFlash Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 311 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 312 être préservés. saveToFlash() Paramètres : un objet binaire avec touts les paramètres settings Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 313 être préservés. Paramètres : un buffer binaire avec touts les paramètres settings Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 314 YModule target set_beacon newval Paramètres : newval soit YModule.BEACON_OFF , soit YModule.BEACON_ON Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 315 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 316 être préservé. Paramètres : un entier représentant la luminosité des leds informatives du module newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 317 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 318 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 319 LongInt triggerConfigChangeCallback( ): LongInt function triggerConfigChangeCallback( ) As Integer int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) java async Task<int> triggerConfigChangeCallback( ) triggerConfigChangeCallback( ) function triggerConfigChangeCallback( ) async triggerConfigChangeCallback( ): Promise<number> async triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) YModule target triggerConfigChangeCallback www.yoctopuce.com...
  • Page 320 YModule target triggerFirmwareUpdate secBeforeReboot Paramètres : secBeforeReboot nombre de secondes avant de redémarrer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 321 Cette méthode retourne un object qui est utilisé pour mettre à jour le firmware du YFirmwareUpdate module. Paramètres : path le path du fichier .byn à utiliser Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 322 à jour le firmware du YFirmwareUpdate module. Paramètres : path .byn le path du fichier à utiliser force vrai pour forceer la mise à jour même si un prérequis ne semble pas satisfait Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 323 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 324: 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 325 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. www.yoctopuce.com...
  • Page 326 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() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. serialport→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. serialport→get_protocol() Retourne le type de protocole utilisé...
  • Page 327 Lit le contenu du tampon de réception sous forme hexadécimale, à partir de la position courante dans le flux de donnée. serialport→readLine() 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) www.yoctopuce.com...
  • Page 328 Réactive l'envoi de chaque changement de la valeur publiée au hub parent. serialport→uploadJob(jobfile, jsonDef) 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) www.yoctopuce.com...
  • Page 329 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. serialport→writeStxEtx(text) Envoie une chaîne de caractères sur le port série, précédée d'un code STX et suivie d'un code ETX. www.yoctopuce.com...
  • Page 330 à 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 : YSerialPort un objet de classe qui permet ensuite de contrôler le port série. www.yoctopuce.com...
  • Page 331 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 : YSerialPort un objet de classe qui permet ensuite de contrôler le port série. www.yoctopuce.com...
  • Page 332 Utiliser la fonction pour itérer sur les autres ports série. YSerialPort.nextSerialPort() Retourne : un pointeur sur un objet YSerialPort , 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 333 YSerialPort.nextSerialPort() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YSerialPort , 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 334 à 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 335 25. 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 336 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 337 25. 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 338 25. 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 339 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 340 25. Référence de l'API de haut niveau YSerialPort serialport→JobMaxSize Taille maximale d'un fichier job. int JobMaxSize www.yoctopuce.com...
  • Page 341 25. 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 342 25. 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 343 ASCII continu ou "Byte" pour un flux binaire continue. Le suffixe "/[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 saveToFlash() module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 344 "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 345 25. 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 346 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 347 Niveau de tension utilisé par le module sur le port série. int VoltageLevel 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.
  • Page 348 ) function clearCache( ) async clearCache( ): Promise<void> 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 349 î 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 350 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 351 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YSerialPort.ADVERTISEDVALUE_INVALID www.yoctopuce.com...

  • Page 352: En Cas D'erreur, Déclenche Une Exception Ou Retourne

    ): Promise<string> 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 YSerialPort.CURRENTJOB_INVALID www.yoctopuce.com...
  • Page 353 ): Promise<number> 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 YSerialPort.ERRCOUNT_INVALID www.yoctopuce.com...
  • Page 354 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du port série.
  • Page 355 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du port série.
  • Page 356 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YSerialPort.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 357 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 358 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le port série (ex: En cas d'erreur, déclenche une exception ou retourne YSerialPort.FUNCTIONID_INVALID www.yoctopuce.com...

  • Page 359: Retourne L'identifiant Matériel Unique Du Port Série Au Format

    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 : une chaîne de caractères identifiant le port série (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YSerialPort.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 360 ) async get_jobMaxSize( ): Promise<number> 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 YSerialPort.JOBMAXSIZE_INVALID www.yoctopuce.com...
  • Page 361 ): Promise<number> 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 YSerialPort.JOBMAXTASK_INVALID www.yoctopuce.com...
  • Page 362 ) 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 YSerialPort.LASTMSG_INVALID www.yoctopuce.com...
  • Page 363 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YSerialPort.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 364 25. 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 365 25. 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 366 "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 YSerialPort.PROTOCOL_INVALID www.yoctopuce.com...
  • Page 367 ): Promise<number> 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 YSerialPort.RXCOUNT_INVALID www.yoctopuce.com...
  • Page 368 ): Promise<number> 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 YSerialPort.RXMSGCOUNT_INVALID www.yoctopuce.com...
  • Page 369 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 YSerialPort.SERIALMODE_INVALID www.yoctopuce.com...
  • Page 370 ): Promise<string> 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 YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 371 ) 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 YSerialPort.STARTUPJOB_INVALID www.yoctopuce.com...
  • Page 372 ): Promise<number> 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 YSerialPort.TXCOUNT_INVALID www.yoctopuce.com...
  • Page 373 ): Promise<number> 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 YSerialPort.TXMSGCOUNT_INVALID www.yoctopuce.com...
  • Page 374 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 375 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YSerialPort.VOLTAGELEVEL_INVALID www.yoctopuce.com...
  • Page 376 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 false si le port série est joignable, sinon www.yoctopuce.com...
  • Page 377 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 378 ) 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 379 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 380: Paramètres

    Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 381 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 382 à 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 383 à 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 384 à lire (indexé à partir de zéro). pduAddr 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 385 à lire (indexé à partir de zéro). pduAddr 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 386 $slaveNo, $pduWriteAddr, $values, $pduReadAddr, $nReadWords) async modbusWriteAndReadRegisters( slaveNo: number, pduWriteAddr: number, values: number[], pduReadAddr: number, nReadWords: number): Promise<number[] async modbusWriteAndReadRegisters( slaveNo, pduWriteAddr, values, pduReadAddr, nReadWords) int[] modbusWriteAndReadRegisters( int slaveNo, int pduWriteAddr, int[] values, int pduReadAddr, www.yoctopuce.com...
  • Page 387 à lire (indexé à partir de zéro). 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 388 à modifier (indexé à partir de zéro). la valeur à appliquer (0 pour l'état OFF, non-zéro pour l'état ON) value 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 389 à modifier (indexé à partir de zéro). 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 390 à modifier (indexé à partir de zéro). la valeur 16 bits à appliquer value 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 391 à modifier (indexé à partir de zéro). pduAddr 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 392 é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 393 ): YSerialPort | null nextSerialPort( ) Si vous souhaitez retrouver un port série spécifique, utilisez SerialPort.findSerialPort() avec un hardwareID ou un nom logique. Retourne : YSerialPort null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 394 (en millisecondes). 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 395 (en millisecondes). maxWait 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 396 à 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 397 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 : nChars le nombre maximum de bytes à lire 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 398 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 : nChars le nombre maximum de bytes à lire 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 399 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 400 Paramètres : nBytes le nombre maximal d'octets à lire 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 401 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 402 (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 403 Paramètres : nChars le nombre maximum de caractères à lire 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 404 ) int read_avail( ) java async Task<int> read_avail( ) read_avail( ) function read_avail( ) async read_avail( ): Promise<number> 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 405 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 : absPos index de position absolue pour les opérations de lecture suivantes. Retourne : rien du tout. www.yoctopuce.com...
  • Page 406 ) java async Task<int> read_tell( ) read_tell( ) function read_tell( ) async read_tell( ): Promise<number> 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 407 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 408 ) async reset( ): Promise<number> 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 409 à 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 410 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 411 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 412 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du port série. 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 413 Paramètres : une chaîne de caractères représentant le type de protocol utilisé sur la communication série 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 414 "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 415 Paramètres : une chaîne de caractères représentant le nom du job à exécuter au démarrage du module newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 416 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 417 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 418 (en millisecondes). Retourne : un tableau de YSnoopingRecord 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 419 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 420: Le Fichier Peut Ensuite Être Activé À L'aide De La Méthode

    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 421 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
  • Page 422 YSerialPort target writeArray byteList Paramètres : byteList la liste d'octets à envoyer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 423 YSerialPort target writeBin buff Paramètres : buff l'objet binaire à envoyer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 424 YSerialPort target writeByte code Paramètres : code le byte à envoyer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 425 YSerialPort target writeHex hexString Paramètres : hexString la chaîne hexadécimale à envoyer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 426 YSerialPort target writeLine text Paramètres : text la chaîne de caractères à envoyer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 427 Cette fonction n'attend pas de réponse. Paramètres : hexString le message à envoyer, en hexadécimal, sans le CRC/LRC Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 428 YSerialPort target writeStr text Paramètres : text la chaîne de caractères à envoyer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 429 YSerialPort target writeStxEtx text Paramètres : text la chaîne de caractères à envoyer Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 430: La Classe Yfiles

    Interface pour intéragir avec les systèmes de fichier, disponibles par exemple dans le Yocto-Color-V2, le Yocto-Serial, le YoctoHub-Ethernet et le YoctoHub-Wireless-n 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 431 Retourne l'identifiant matériel du système de fichier, sans référence au module. files→get_hardwareId() SERIAL.FUNCTIONID Retourne l'identifiant matériel unique du système de fichier au format files→get_list(pattern) Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier. www.yoctopuce.com...
  • Page 432 25. Référence de l'API de haut niveau files→get_logicalName() Retourne le nom logique du système de fichier. files→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_serialNumber() Retourne le numéro de série du module, préprogrammé...
  • Page 433 à 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 YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 434 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 435 YFiles.nextFiles() Retourne : un pointeur sur un objet YFiles , 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 436 YFiles.nextFiles() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YFiles , 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 437 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 438 25. 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 439 25. 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 440 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 441 25. 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 442 25. 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 443 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 444 25. 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 445 25. 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 446 ) function clearCache( ) async clearCache( ): Promise<void> 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 447 î 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 448: Paramètres

    Paramètres : pathname nom complet du fichier à charger, y compris le chemin d'accès. 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 449 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 450 YFiles target fileExist filename Paramètres : filename le nom de fichier. 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 451 ) 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 452: En Cas D'erreur, Déclenche Une Exception Ou Retourne

    ) 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 YFiles.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 453 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 454 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 455 ): Promise<number> 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 YFiles.FILESCOUNT_INVALID www.yoctopuce.com...
  • Page 456 ) 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 YFiles.FREESPACE_INVALID www.yoctopuce.com...
  • Page 457 (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 YFiles.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 458 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 459 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le système de fichier (ex: En cas d'erreur, déclenche une exception ou retourne YFiles.FUNCTIONID_INVALID www.yoctopuce.com...

  • Page 460: Retourne L'identifiant Matériel Unique Du Système De Fichier Au Format

    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 : une chaîne de caractères identifiant le système de fichier (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YFiles.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 461 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 462 ): Promise<string> 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 YFiles.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 463 25. 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 464 25. 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 465 ): Promise<string> 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 YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 466 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 467 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 false si le système de fichier est joignable, sinon www.yoctopuce.com...
  • Page 468 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 469 ) 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 470 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 471 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 472 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 473 é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 474 ): YFiles | null nextFiles( ) Si vous souhaitez retrouver un système de fichier spécifique, utilisez Files.findFiles() avec un hardwareID ou un nom logique. Retourne : YFiles null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 475 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 476 é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 477 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du système de fichier. 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 478 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 479 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 480 Paramètres : nom complet du fichier, y compris le chemin d'accès. pathname content contenu du fichier à télécharger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 481 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 482: 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-Serial 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 483 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). www.yoctopuce.com...
  • Page 484 Retourne la valeur minimale observée pour la mesure depuis le démarrage du module. genericsensor→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. genericsensor→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. genericsensor→get_recordedData(startTime, endTime)
  • Page 485 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) www.yoctopuce.com...
  • Page 486 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 487 à 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 : YGenericSensor un objet de classe qui permet ensuite de contrôler le capteur générique. www.yoctopuce.com...
  • Page 488 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 : YGenericSensor un objet de classe qui permet ensuite de contrôler le capteur générique. www.yoctopuce.com...
  • Page 489 Utiliser la fonction pour itérer sur les autres capteurs YGenericSensor.nextGenericSensor() génériques. Retourne : un pointeur sur un objet YGenericSensor , correspondant au premier capteur générique accessible en null ligne, ou si il n'y a pas de capteurs génériques disponibles. www.yoctopuce.com...
  • Page 490 YGenericSensor.nextGenericSensor() génériques. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YGenericSensor , correspondant au premier capteur générique accessible en null ligne, ou si il n'y a pas de capteurs génériques disponibles. www.yoctopuce.com...
  • Page 491 à 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 492 25. 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 Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 493 25. 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 494 Enabled 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 495 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 496 25. 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 497 25. 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 498 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 499 "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 500 25. 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 501 "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 502 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 503 25. 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 504 à 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 505 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 506 La méthode 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 507 25. 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 508 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 509: Paramètres

    être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les rawValues points de correction.
  • Page 510 ) function clearCache( ) async clearCache( ): Promise<void> 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 511 è 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 512 YGenericSensor.ADVMODE_PERIOD_AVG YGenericSensor.ADVMODE_PERIOD_MIN YGenericSensor.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 YGenericSensor.ADVMODE_INVALID www.yoctopuce.com...
  • Page 513 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 514 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 515 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.CURRENTVALUE_INVALID www.yoctopuce.com...
  • Page 516 YDataLoggerProxy get_dataLogger( ) YDataLoggerProxy* get_dataLogger( ) Cette méthode retourne un objet qui permet de contrôler les paramètres globaux de l'enregistreur de données. L'objet retourné ne doit pas être libéré. Retourne : YDatalogger un objet , ou null en cas d'erreur. www.yoctopuce.com...
  • Page 517 ): Promise<YGenericSensor_Enabled> async get_enabled( ) int get_enabled( ) int get_enabled( ) YGenericSensor target get_enabled Retourne : YGenericSensor.ENABLED_FALSE YGenericSensor.ENABLED_TRUE soit , soit , selon l'état d'activation de cette mesure En cas d'erreur, déclenche une exception ou retourne YGenericSensor.ENABLED_INVALID www.yoctopuce.com...
  • Page 518 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du capteur générique.
  • Page 519 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du capteur générique.
  • Page 520 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 521 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 522 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.FUNCTIONID_INVALID www.yoctopuce.com...

  • Page 523: Retourne L'identifiant Matériel Unique Du Capteur Générique Au Format

    ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 524 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 525 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 526 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 527 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 528 25. 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 529 25. 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 530: Paramètres

    à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin. Retourne : YDataSet une instance de , dont les méthodes permettent de d'accéder aux données historiques souhaitées. www.yoctopuce.com...
  • Page 531 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 532 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.RESOLUTION_INVALID www.yoctopuce.com...
  • Page 533 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 534 ): Promise<string> 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 YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 535 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.SIGNALBIAS_INVALID www.yoctopuce.com...
  • Page 536 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.SIGNALRANGE_INVALID www.yoctopuce.com...
  • Page 537 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.SIGNALSAMPLING_INVALID www.yoctopuce.com...
  • Page 538 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.SIGNALUNIT_INVALID www.yoctopuce.com...
  • Page 539 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.SIGNALVALUE_INVALID www.yoctopuce.com...

  • Page 540: En Cas D'erreur, Déclenche Une Exception Ou Retourne

    ): Promise<string> 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 mesure est exprimée En cas d'erreur, déclenche une exception ou retourne YGenericSensor.UNIT_INVALID www.yoctopuce.com...
  • Page 541 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 542 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YGenericSensor.VALUERANGE_INVALID www.yoctopuce.com...
  • Page 543 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 false si le capteur générique est joignable, sinon www.yoctopuce.com...
  • Page 544 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 545 ) 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 546 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 547 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 548: Paramètres

    Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...

  • Page 549: Récupère Les Points De Correction De Mesure Précédemment Enregistrés À L'aide De La Méthode Calibratefrompoints

    Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 550 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 551 é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 552 é c i f i q u e , u t i l i s e z GenericSensor.findGenericSensor() avec un hardwareID ou un nom logique. Retourne : YGenericSensor null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 553 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et un objet YMeasure décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 554 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 555 Y G e n e r i c S e n s o r . A D V M O D E _ P E R I O D _ M I N YGenericSensor.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 556 être préservé. saveToFlash() Paramètres : newval YGenericSensor.ENABLED_FALSE YGenericSensor.ENABLED_TRUE soit , soit 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 557 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 558 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le newval datalogger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 559: Vous Pouvez Utiliser Pas D'appeler La Méthode

    être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur générique. 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 560 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 561 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la fréquence de notification périodique des valeurs newval mesurées Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 562 1.0, 0.1, 0.01, 0.02, 0.05 etc. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Paramètres : une valeur numérique 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 563 Paramètres : une valeur numérique représentant le biais du signal électrique pour la correction du point zéro 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 564: N'oubliez Pas D'appeler La Méthode

    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 565 Y G e n e r i c S e n s o r . S I G N A L S A M P L I N G _ L O W _ N O I S E YGenericSensor.SIGNALSAMPLING_LOW_NOISE_FILTERED YGenericSensor.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 566 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant l'unité dans laquelle la valeur mesurée est exprimée newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 567 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 568 à 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 569 ) 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 570 ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ): Promise<number> 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 571 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 572 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
  • Page 573 ) 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 574: La Classe Ydatalogger

    25. Référence de l'API de haut niveau 25.6. La classe YDataLogger Interface de contrôle de l'enregistreur de données, présent sur la plupart des capteurs Yoctopuce. La plupart des capteurs Yoctopuce sont équipés d'une mémoire non-volatile. Elle permet de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un ordinateur. La classe contrôle les paramètres globaux de cet enregistreur de données.
  • Page 575 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données. datalogger→get_friendlyName() NOM_MODULE.NOM_FONCTION Retourne un identifiant global de l'enregistreur de données au format datalogger→get_functionDescriptor() YFUN_DESCR Retourne un identifiant unique de type correspondant à la fonction. www.yoctopuce.com...
  • Page 576 SERIAL.FUNCTIONID datalogger→get_logicalName() Retourne le nom logique de l'enregistreur de données. datalogger→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. datalogger→get_recording() Retourne l'état d'activation de l'enregistreur de données.
  • Page 577 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 578 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple RX420MA1.dataLogger Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 579 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple RX420MA1.dataLogger Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 580 YDataLogger.nextDataLogger() données. Retourne : un pointeur sur un objet YDataLogger , correspondant au premier enregistreur de données accessible null en ligne, ou si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 581 YDataLogger.nextDataLogger() données. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YDataLogger , correspondant au premier enregistreur de données accessible null en ligne, ou si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 582 à 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 583 25. 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 584 Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() pour sauver la modification de configuration. Attention si le module n'a pas de source de temps à sa disposition au démarrage, il va attendre environ 8 sec avant de démarrer automatiquement l'enregistrement avec un horodatage arbitraire. www.yoctopuce.com...
  • Page 585 Vrai si l'enregistreur de données est synchronisé avec la balise de localisation. int BeaconDriven Modifiable. Modifie le mode de synchronisation de l'enregistreur de données . N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 586 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 587 25. 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 588 25. 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 589 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 590 25. 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 591 25. Référence de l'API de haut niveau YDataLogger datalogger→Recording état d'activation de l'enregistreur de données. int Recording Modifiable. www.yoctopuce.com...
  • Page 592 25. 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 593 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'enregistreur de données. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 594 è 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 595 ) 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 596 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 597 ) int get_autoStart( ) YDataLogger target get_autoStart Retourne : YDataLogger.AUTOSTART_OFF YDataLogger.AUTOSTART_ON soit , soit , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension En cas d'erreur, déclenche une exception ou retourne YDataLogger.AUTOSTART_INVALID www.yoctopuce.com...
  • Page 598 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.BEACONDRIVEN_INVALID www.yoctopuce.com...
  • Page 599 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.CURRENTRUNINDEX_INVALID www.yoctopuce.com...
  • Page 600 Cette méthode ne fonctionne que si le module utilise un firmware récent, car les objets YDataSet sont pas supportés par les firmwares antérieurs à la révision 13000. Retourne : YDataSet une liste d'objets En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 601 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 602 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
  • Page 603 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
  • Page 604 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 605 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 606 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'enregistreur de données (ex: En cas d'erreur, déclenche une exception ou retourne YDataLogger.FUNCTIONID_INVALID www.yoctopuce.com...

  • Page 607: Retourne L'identifiant Matériel Unique De L'enregistreur De Données Au Format

    L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'enregistreur de données (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YDataLogger.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 608 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YDataLogger.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 609 25. 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 610 25. 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 611 ): Promise<YDataLogger_Recording> async get_recording( ) int get_recording( ) int get_recording( ) YDataLogger target get_recording Retourne : YDataLogger.RECORDING_OFF YDataLogger.RECORDING_ON une valeur parmi YDataLogger.RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne YDataLogger.RECORDING_INVALID www.yoctopuce.com...
  • Page 612 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YDataLogger target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 613 ): Promise<number> async get_timeUTC( ) long get_timeUTC( ) s64 get_timeUTC( ) YDataLogger target get_timeUTC Retourne : un entier représentant le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue En cas d'erreur, déclenche une exception ou retourne YDataLogger.TIMEUTC_INVALID www.yoctopuce.com...
  • Page 614 ) async get_usage( ): Promise<number> async get_usage( ) int get_usage( ) int get_usage( ) YDataLogger target get_usage Retourne : un entier représentant le pourcentage d'utilisation de la mémoire d'enregistrement En cas d'erreur, déclenche une exception ou retourne YDataLogger.USAGE_INVALID www.yoctopuce.com...
  • Page 615 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 616 Si les valeurs des attributs en cache de l'enregistreur de données sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'enregistreur de données est joignable, sinon www.yoctopuce.com...
  • Page 617 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 618 ) 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 619 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 620: Paramètres

    Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 621 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 622 é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 623: Continue L'énumération Des Enregistreurs De Données Commencée À L'aide De Yfirstdatalogger

    é c i f i q u e , u t i l i s e z DataLogger.findDataLogger() avec un hardwareID ou un nom logique. Retourne : YDataLogger null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 624 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 625 , soit , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 626 Paramètres : newval YDataLogger.BEACONDRIVEN_OFF YDataLogger.BEACONDRIVEN_ON soit , soit selon le mode de synchronisation de l'enregistreur de données Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 627 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'enregistreur de données. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 628 Paramètres : newval une valeur parmi YDataLogger.RECORDING_OFF YDataLogger.RECORDING_ON YDataLogger.RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 629 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 630 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 631 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 632 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 633: La Classe Ydataset

    Pour utiliser les fonctions décrites ici, vous devez inclure: <script type='text/javascript' src='yocto_module.js'></script> #include "yocto_module.h" #import "yocto_module.h" uses yocto_module; yocto_module.vb yocto_module.cs import com.yoctopuce.YoctoAPI.YDataSet; java import com.yoctopuce.YoctoAPI.YDataSet; from yocto_module import * require_once('yocto_module.php'); in HTML: import { YDataSet } from '../../dist/esm/yocto_module.js'; in Node.js: import { YDataSet } from 'yoctolib-cjs/yocto_module.js';...
  • Page 634 Retourne l'état d'avancement du chargement des données, sur une échelle de 0 à 100. dataset→get_startTimeUTC() Retourne l'heure absolue du début des mesures disponibels, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix). dataset→get_summary() www.yoctopuce.com...
  • Page 635 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 636 à 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 637 OBSOLÈTE: cette methode a été remplacé par get_summary() qui retoure des informations plus précises. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la dernière mesure. www.yoctopuce.com...

  • Page 638: Par Example Temperature1

    String get_functionId( ) java async Task<string> get_functionId( ) get_functionId( ) function get_functionId( ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example temperature1 Retourne : temperature1 une chaîne de caractères identifiant la fonction (ex: www.yoctopuce.com...

  • Page 639: Retourne L'identifiant Matériel Unique De La Fonction Qui A Effectué Les Mesures, Au Format

    L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example THRMCPL1-123456.temperature1 Retourne : THRMCPL1-123456.temperature1 une chaîne de caractères identifiant la fonction (ex: En cas d'erreur, déclenche une exception ou retourne YDataSet.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 640 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 641: Le Résultat Est Fourni Sous Forme D'une Liste D'objets

    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 642 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 643 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 644 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 645 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 646 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 647 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 648 Le résumé des mesures est disponible dès que loadMore() a été appelé pour la première fois. Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 649 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 650 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 651 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 652 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 653 25. 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 654 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 655 , l'avancement est nul. Au fur et à mesure get_dataSet() des appels à loadMore() , l'avancement progresse pour atteindre la valeur 100 lorsque toutes les mesures ont été chargées. Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées. www.yoctopuce.com...
  • Page 656 à jour à la première mesure effectivement disponible dans l'enregistreur de données pour la plage spécifiée. OBSOLÈTE: cette methode a été remplacé par qui retoure des informations plus get_summary() précises. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la première mesure enregistrée. www.yoctopuce.com...
  • Page 657 - la valeur minimale observée dans l'intervalle de temps - la valeur moyenne observée dans l'intervalle de temps - la valeur maximale observée dans l'intervalle de temps Ce résumé des mesures est disponible dès que a été appelé pour la première fois. loadMore() Retourne : un objet YMeasure www.yoctopuce.com...
  • Page 658 25. 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 659 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 660 25. 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 661 25. 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 662 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 663 Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ): Promise<string> async get_unit( ) string get_unit( ) string get_unit( ) Retourne : une chaîne de caractères représentant une unité physique. En cas d'erreur, déclenche une exception ou retourne YDataSet.UNIT_INVALID www.yoctopuce.com...
  • Page 664 ) 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 665 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 666: 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 667 ): double function get_averageValue( ) As Double double get_averageValue( ) double get_averageValue( ) java double get_averageValue( ) get_averageValue( ) function get_averageValue( ) get_averageValue( ): number get_averageValue( ) Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 668 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 669 ): double function get_maxValue( ) As Double double get_maxValue( ) double get_maxValue( ) java double get_maxValue( ) get_maxValue( ) function get_maxValue( ) get_maxValue( ): number get_maxValue( ) Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 670 ): double function get_minValue( ) As Double double get_minValue( ) double get_minValue( ) java double get_minValue( ) get_minValue( ) function get_minValue( ) get_minValue( ): number get_minValue( ) Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 671 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 672 www.yoctopuce.com...

  • Page 673: Problèmes Courants

    26.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 26.2.

  • Page 674: Plateformes Arm: Hf Et El

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

  • Page 675: Déconnexions, Comportement Erratique

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

  • Page 677: Caractéristiques

    27. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module Yocto-RS485-V2 Identifiant produit RS485MK2 † Révision matérielle Connecteur USB micro-B Largeur 20 mm Longueur 60 mm Poids 11 g Chipset ISO1410 Fréquence max 115200 bps Classe de protection selon IEC 61140 classe III Isolation USB, dist.
  • Page 678 27. Caractéristiques www.yoctopuce.com...

Ce manuel est également adapté pour:

Yocto-rs232

Table des Matières