1. Manuels
  2. Marques
  3. Yoctopuce Manuels
  4. Récepteurs
  5. Yocto-GPS-V2
  6. Mode d'emploi

Yoctopuce Yocto-GPS-V2 Mode D'emploi

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

Publicité

Liens rapides

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

Publicité

Table des Matières
loading

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

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

  • Page 3: Table Des Matières

    4. Montage et connectique ....................4.1. Fixation ..........................4.2. L'antenne ..........................4.3............................... 5. Programmation, concepts généraux ................ 5.1. Paradigme de programmation ..................5.2. Le module Yocto-GPS-V2 ....................5.3. Module ..........................5.4. Gps ............................5.5. Latitude ..........................5.6. Longitude ........................... 5.7. Altitude ..........................
  • Page 4 7. Utilisation du Yocto-GPS-V2 en JavaScript / EcmaScript ......7.1. Fonctions bloquantes et fonctions asynchrones en JavaScript ........7.2. Utiliser la librairie Yoctopuce pour JavaScript / EcmaScript 2017 ....... 7.3. Contrôle de la fonction Latitude ..................7.4. Contrôle de la partie module ....................
  • Page 5 13.5. Un exemple concret ......................13.6. Contrôle de la partie module ..................13.7. Gestion des erreurs ......................14. Utilisation du Yocto-GPS-V2 en Delphi .............. 14.1. Préparation ........................14.2. Contrôle de la fonction Latitude ................... 14.3. Contrôle de la partie module ..................
  • Page 6 23.4. Les exemples de programmation n'ont pas l'air de marcher ........23.5. Module alimenté mais invisible pour l'OS ..............23.6. Another process named xxx is already using yAPI ............ 23.7. Déconnexions, comportement erratique ..............23.8. Module endommagé ...................... 24. Caractéristiques ......................www.yoctopuce.com...

  • Page 7: Introduction

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

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

  • Page 9: Conditions Environnementales

    été déterminée en fonction des recommandations officielles des fabricants des composants utilisés dans le Yocto-GPS-V2, et par des tests de durée limitée (1h) dans les conditions extrêmes, en environnement controllé. Si vous envisagez d'utiliser le Yocto-GPS-V2 dans des conditions de température extrêmes pour une période prolongée, il est recommandé...
  • Page 10 www.yoctopuce.com...

  • Page 11: Présentation

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

  • Page 12: Les Éléments Spécifiques

    La LED verte (Fix Sat.) présente sur le module témoigne de l'état de la réception satellite. Elle reste fixe lorsque la réception est satisfaisante et clignote rapidement lorsque le module cherche des satellites. Avec une réception correcte, le Yocto-GPS-V2 peut obtenir une position en moins de 35 court-court-court long-long-long court-court-court support@yoctopuce.com...

  • Page 13: Le Connecteur D'antenne

    Yoctopuce. Vis et entretoises Pour fixer le module Yocto-GPS-V2 à un support, vous pouvez placer des petites vis de 2.5mm avec une tête de 4.5mm au maximum dans les trous prévus ad-hoc. Il est conseillé de les visser dans des entretoises filetées, que vous pourrez fixer sur le support.
  • Page 14 à l'aide de connecteurs board-to-board au pas 1.27mm. Pour éviter les court-circuits, soudez de préférence le connecteur femelle sur le hub et le connecteur mâle sur le Yocto-GPS-V2. Vous pouvez aussi utiliser un petit câble à 4 fils doté de connecteurs au pas 1.27mm (ou 1.25mm, la différence est négligeable pour 4 pins), ce qui vous permet de déporter le module d'une dizaine de...

  • Page 15: Premiers Pas

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

  • Page 16: Test De La Connectivité Usb

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

  • Page 17: Localisation

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

  • Page 18: 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 19: La Fonction Gps

    Le Yocto-GPS-V2 est capable de calculer la vitesse-sol, c'est-à-dire la vitesse horizontale par rapport au sol. Limitations Le Yocto-GPS-V2 est sujet aux limitations usuelles des GPS commerciaux: il cesse de donner des informations lorsque l'une des limites suivantes est dépassée: • altitude: 50,000 m •...
  • Page 20 www.yoctopuce.com...

  • Page 21: Montage Et Connectique

    Exemples de montage sur un support. Le module Yocto-GPS-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 22: L'antenne

    à essayer, placez l'antenne près d'une fenêtre. Câble d'antenne Le Yocto-GPS-V2 est livré avec un antenne active céramique au bout d'un câble coaxial d'une dizaine de centimètres terminé par un connecteur U.FL. Ce genre de câble est assez fragile: évitez de le plier à...

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

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

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

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

  • Page 26: Programmation

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

  • Page 27: Le Module Yocto-Gps-V2

    Inversement, la classe YModule dispose d'un certain nombre de méthodes permettant d'énumérer les fonctionnalités disponibles sur un module. 5.2. Le module Yocto-GPS-V2 Le module Yocto-GPS-V2 est une interface GNSS. module : Module attribut type...
  • Page 28 Nombre (virgule fixe) lecture seule Texte lecture seule technology groundSpeed : GroundSpeed attribut type modifiable ? Texte lecture seule logicalName Texte lecture seule advertisedValue Texte lecture seule unit Nombre (virgule fixe) lecture seule currentValue Nombre (virgule fixe) lecture seule lowestValue www.yoctopuce.com...

  • Page 29: Module

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

  • Page 30: Gps

    GPS/GNSS YGps Yoctopuce. Cette classe permet d'obtenir toutes les informations nécessaires. Cependant, si vous souhaitez définir des callbacks sur des changement de position ou enregistrer la position dans le datalogger, utilisez plutôt les classes...

  • Page 31: Latitude

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

  • Page 32: Longitude

    Résolution de la mesure (précision de la représentation, mais pas forcément de la mesure elle- même). sensorState Etat du capteur (zero lorsque qu'une mesure actuelle est disponible). 5.6. Longitude Interface pour intéragir avec les capteurs de longitude, disponibles par exemple dans le Yocto-GPS www.yoctopuce.com...
  • Page 33 5. Programmation, concepts généraux La classe permet de lire et de configurer les capteurs de longitude Yoctopuce. Elle YLongitude hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de YSensor mesures, callbacks, enregistreur de données. logicalName Chaîne de caractères contenant le nom logique du capteur de longitude, initialement vide.

  • Page 34: Altitude

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

  • Page 35: Groundspeed

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

  • Page 36: Gps

    GPS/GNSS YGps Yoctopuce. Cette classe permet d'obtenir toutes les informations nécessaires. Cependant, si vous souhaitez définir des callbacks sur des changement de position ou enregistrer la position dans le datalogger, utilisez plutôt les classes...

  • Page 37: Datalogger

    5.10. DataLogger Interface de contrôle de l'enregistreur de données, présent sur la plupart des capteurs Yoctopuce. La plupart des capteurs Yoctopuce sont équipés d'une mémoire non-volatile. Elle permet de mémoriser les données mesurées d'une manière autonome, sans nécessiter le suivi permanent d'un ordinateur.

  • Page 38: Quelle Interface: Native, Dll Ou Service

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

  • Page 39: Contrôle Natif Par Dll

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

  • Page 41: Limitation Des Librairies Yoctopuce

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

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

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

  • Page 44: Contrôle De La Fonction Latitude

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

  • Page 45: Contrôle De La Partie Module

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

  • Page 47: Utilisation Du Yocto-Gps-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 48: Fonctions Bloquantes Et Fonctions Asynchrones En Javascript

    7. Utilisation du Yocto-GPS-V2 en JavaScript / EcmaScript 7.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 49: 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 50: Compatibilité Avec L'ancienne Librairie Javascript

    7. Utilisation du Yocto-GPS-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 51: Contrôle De La Fonction Latitude

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

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

    YGps.FindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 53: 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-GPS-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 54: Contrôle De La Partie Module

    7. Utilisation du Yocto-GPS-V2 en JavaScript / EcmaScript let gps = YGps.FindGps(serial+".gps"); if (await gps.isOnline()) { document.getElementById('msg').value = ''; if (await gps.get_isFixed() != YGps.ISFIXED_TRUE) { document.getElementById("gps").value = 'fixing...'; } else { document.getElementById("gps").value = (await gps.get_latitude()) + ' ' + (await gps.get_longitude());...
  • Page 55 7. Utilisation du Yocto-GPS-V2 en JavaScript / EcmaScript if(process.argv.length < 2) { console.log("usage: node demo.js <serial or logicalname> [ ON | OFF ]"); } else { startDemo(process.argv.slice(2)); Chaque propriété du module peut être lue grâce à une méthode du type...

  • Page 56: Énumération Des Modules

    La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie.
  • Page 57 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 58 www.yoctopuce.com...

  • Page 59: Utilisation Du Yocto-Gps-V2 En Php

    Vous n'avez pas besoin d'installer de driver. 8.2. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code PHP qui utilise la fonction Latitude. include('yocto_api.php');...
  • Page 60 YFindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 61: Un Exemple Réel

    8. Utilisation du Yocto-GPS-V2 en PHP Un exemple réel Ouvrez votre éditeur de texte préféré , recopiez le code ci dessous, sauvez-le dans un répertoire accessible par votre serveur web/PHP avec les fichiers de la librairie, et ouvrez-la page avec votre browser favori.
  • Page 62 8. Utilisation du Yocto-GPS-V2 en PHP </HEAD> <BODY> <FORM method='get'> <?php include('yocto_api.php'); // Use explicit error handling rather than exceptions YAPI::DisableExceptions(); // Setup the API to use the VirtualHub on local machine if(YAPI::RegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI::SUCCESS) { die("Cannot contact VirtualHub on 127.0.0.1 : ".$errmsg);...
  • Page 63 8. Utilisation du Yocto-GPS-V2 en PHP méthode . Ce petit exemple ci-dessous vous permet changer le nom logique revertFromFlash() d'un module. <HTML> <HEAD> <TITLE>save settings</TITLE> <BODY> <FORM method='get'> <?php include('yocto_api.php'); // Use explicit error handling rather than exceptions YAPI::DisableExceptions(); // Setup the API to use the VirtualHub on local machine if(YAPI::RegisterHub('http://127.0.0.1:4444/',$errmsg) != YAPI::SUCCESS) {...

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

  • Page 67: 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 68 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 69: Utilisation Du Yocto-Gps-V2 En C

    à la création d'un projet à neuf linké avec les librairies Yoctopuce. 9.1. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code C++ qui utilise la fonction Latitude. #include "yocto_api.h"...
  • Page 70 YFindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 71: Contrôle De La Partie Module

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

  • Page 74: 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 75: 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 76 Windows. Ce script qui se situe à la racine de la librairie, détecte l'OS et build.bat recompile toutes les librairies ainsi que les exemples correspondant. Ensuite, pour intégrer la librairie dynamique Yoctopuce à votre projet, vous devez inclure le répertoire de la librairie Yoctopuce à votre IncludePath, et ajouter le sous-répertoire de Sources correspondant à...

  • Page 77: Utilisation Du Yocto-Gps-V2 En Objective-C

    à vos projets. 10.1. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code Objective-C qui utilise la fonction Latitude. #import "yocto_api.h"...
  • Page 78 YGps.FindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 79: Contrôle De La Partie Module

    10. Utilisation du Yocto-GPS-V2 en Objective-C static void usage(void) NSLog(@"usage: demo <serial_number> "); NSLog(@" demo <logical_name>"); NSLog(@" demo any (use any discovered device)"); exit(1); int main(int argc, const char * argv[]) NSError *error; (argc < 2) { usage(); @autoreleasepool {...
  • Page 80 10. Utilisation du Yocto-GPS-V2 en Objective-C @autoreleasepool { // Setup the API to use local USB devices if([YAPI RegisterHub:@"usb": &error] != YAPI_SUCCESS) { NSLog(@"RegisterHub error: %@", [error localizedDescription]); return if(argc < usage(argv[0]); NSString *serial_or_name [NSString stringWithUTF8String:argv[1]]; // use serial or logical name...
  • Page 81 10. Utilisation du Yocto-GPS-V2 en Objective-C if(argc < usage(argv[0]); NSString *serial_or_name [NSString stringWithUTF8String:argv[1]]; // use serial or logical name YModule *module [YModule FindModule:serial_or_name]; if (module.isOnline) { (argc >= 3) { NSString *newname [NSString stringWithUTF8String:argv[2]]; (![YAPI CheckLogicalName:newname]) { NSLog(@"Invalid name (%@)\n", newname);...

  • Page 82: 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 83: Utilisation Du Yocto-Gps-V2 En Visualbasic .Net

    11.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 84: Contrôle De La Fonction Latitude

    11.3. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code VisualBasic .NET qui utilise la fonction Latitude. [...] ' On active la détection des modules sur USB...
  • Page 85 YFindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 86: Contrôle De La Partie Module

    11. Utilisation du Yocto-GPS-V2 en VisualBasic .NET End If Console.WriteLine(" (press Ctrl-C to exit)") YAPI.Sleep(1000, errmsg) End While YAPI.FreeAPI() End Sub End Module 11.4. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la...
  • Page 87 11. Utilisation du Yocto-GPS-V2 en VisualBasic .NET Modifications des réglages du module Lorsque que vous souhaitez modifier les réglages d'un module, il suffit d'appeler la fonction correspondante, cependant cette modification n'a lieu que dans la mémoire vive du set_xxx() module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration...

  • Page 88: 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 89 11. Utilisation du Yocto-GPS-V2 en VisualBasic .NET Quand vous travaillez sans les exceptions, il est possible d'obtenir un code d'erreur et un message expliquant l'origine de l'erreur en le demandant à l'objet qui a retourné une erreur à l'aide des méthodes...
  • Page 90 www.yoctopuce.com...

  • Page 91: Utilisation Du Yocto-Gps-V2 En C

    12.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 92: Contrôle De La Fonction Latitude

    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. 12.3. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code C# qui utilise la fonction Latitude. [...] // On active la détection des modules sur USB...
  • Page 93 YGps.FindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 94: Contrôle De La Partie Module

    12. Utilisation du Yocto-GPS-V2 en C# if (!gps.isOnline()) { Console.WriteLine("Module not connected"); Console.WriteLine("check identification and USB cable"); Environment.Exit(0); while (gps.isOnline()) { if (gps.get_isFixed() != YGps.ISFIXED_TRUE) Console.WriteLine("fixing... "); else Console.WriteLine(gps.get_latitude() + " " + gps.get_longitude()); Console.WriteLine(" (press Ctrl-C to exit)"); YAPI.Sleep(1000, ref errmsg);...
  • Page 95 12. Utilisation du Yocto-GPS-V2 en C# Console.Write("beacon: "); if (m.get_beacon() == YModule.BEACON_ON) Console.WriteLine("ON"); else Console.WriteLine("OFF"); Console.WriteLine("upTime: " + (m.get_upTime() / 1000 ).ToString() + " sec"); Console.WriteLine("USB current: " + m.get_usbCurrent().ToString() + " mA"); Console.WriteLine("Logs:\r\n" + m.get_lastLogs()); } else { Console.WriteLine(args[0] + "...

  • Page 96: 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 97 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 98 www.yoctopuce.com...

  • Page 99: Utilisation Du Yocto-Gps-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 100: Installation

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

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

  • Page 102: Un Exemple Concret

    YGps.FindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 103: Contrôle De La Partie Module

    13. Utilisation du Yocto-GPS-V2 avec Universal Windows Platform 13.6. Contrôle de la partie module Chaque module peut-être contrôlé d'une manière similaire, vous trouverez ci-dessous un simple programme d'exemple affichant les principaux paramètres d'un module et permettant d'activer la balise de localisation.
  • Page 104 13. Utilisation du Yocto-GPS-V2 avec Universal Windows Platform vive du module: si le module redémarre, les modifications seront perdues. Pour qu'elle soient mémorisées de manière persistante, il est nécessaire de demander au module de sauvegarder sa configuration courante dans sa mémoire non volatile. Pour cela il faut utiliser la méthode .

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

  • Page 107: Utilisation Du Yocto-Gps-V2 En Delphi

    14.2. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code Delphi qui utilise la fonction Latitude.

  • Page 108: Un Exemple Réel

    YFindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.
  • Page 109 14. Utilisation du Yocto-GPS-V2 en Delphi Vous reconnaîtrez dans cet exemple l'utilisation des fonctions expliquées ci-dessus, cette fois utilisées avec le décorum nécessaire à en faire un petit programme d'exemple concret. program helloworld; {$APPTYPE CONSOLE} uses SysUtils, Windows, yocto_api, yocto_gps;...

  • Page 110: Contrôle De La Partie Module

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

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

  • Page 117: Contrôle De La Partie Module

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

  • Page 119: Gestion Des Erreurs

    La méthode recommandée par la plupart des langages de programmation pour la gestion des erreurs imprévisibles est l'utilisation d'exceptions. C'est le comportement par défaut de la librairie Yoctopuce. Si une erreur se produit alors qu'on essaie d'accéder à un module, la librairie va lancer une exception. Dans ce cas, de trois choses l'une: •...
  • Page 120 15. Utilisation du Yocto-GPS-V2 en Python peuvent être testées par l'appelant lorsque c'est pertinent. Le nom de la valeur de retour en cas d'erreur pour chaque fonction est systématiquement documenté dans la référence de la librairie. Il suit toujours même logique: méthode...

  • Page 121: Utilisation Du Yocto-Gps-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. 16.2. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code Java qui utilise la fonction Latitude. [...] // On active l'accès aux modules locaux à...
  • Page 122 YGps.FindGps actuelle mesurée par le Yocto-GPS-V2, sous forme de chaîne de caractères. Le format dépend de la configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude.

  • Page 123: Contrôle De La Partie Module

    16. Utilisation du Yocto-GPS-V2 en Java YGps gps; (args.length == 0) { = YGps.FirstGps(); (gps == null) { System.out.println("No module connected (check USB cable)"); System.exit(1); } else { = YGps.FindGps(args[0] + ".gps"); while (true) { try { if (gps.get_isFixed() != YGps.ISFIXED_TRUE) { System.out.println("fixing...");...
  • Page 124 16. Utilisation du Yocto-GPS-V2 en Java module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF); System.out.println("serial: " + module.get_serialNumber()); System.out.println("logical name: " + module.get_logicalName()); System.out.println("luminosity: " + module.get_luminosity()); if (module.get_beacon() == YModule.BEACON_ON) { System.out.println("beacon: ON"); } else { System.out.println("beacon: OFF"); System.out.println("upTime: " + module.get_upTime() / 1000 "...

  • Page 125: Gestion Des Erreurs

    Il y aura forcément une occasion où un utilisateur aura débranché le périphérique, soit avant de lancer le programme, soit même en pleine opération. La librairie Yoctopuce est prévue pour vous aider à supporter ce genre de comportements, mais www.yoctopuce.com...
  • Page 126 16. Utilisation du Yocto-GPS-V2 en Java votre code doit néanmoins être fait pour se comporter au mieux pour interpréter les erreurs signalées par la librairie. La manière la plus simple de contourner le problème est celle que nous avons employé pour les petits exemples précédents de ce chapitre: avant d'accéder à...

  • Page 127: Utilisation Du Yocto-Gps-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 128: 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 129: Lancement Automatique

    17. Utilisation du Yocto-GPS-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 130: Contrôle De La Fonction Latitude

    17. Utilisation du Yocto-GPS-V2 avec Android 17.5. Contrôle de la fonction Latitude Il suffit de quelques lignes de code pour piloter un Yocto-GPS-V2. Voici le squelette d'un fragment de code Java qui utilise la fonction Latitude. [...] // On active la détection des modules sur USB YAPI.EnableUSBHost(this);...
  • Page 131 17. Utilisation du Yocto-GPS-V2 avec Android configuration du Yocto-GPS-V2. Pour obtenir une valeur en virgule flottante, quelle que soit la configuration du Yocto-GPS-V2, utilisez plutôt la classe YLatitude. 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.

  • Page 132: Contrôle De La Partie Module

    17. Utilisation du Yocto-GPS-V2 avec Android @Override public void onItemSelected(AdapterView<?> parent, View view, pos, long id) { serial = parent.getItemAtPosition(pos).toString(); @Override public void onNothingSelected(AdapterView<?> arg0) { final Runnable = new Runnable() { public void run() { (serial != null) { YGps = YGps.FindGps(serial);...
  • Page 133 17. Utilisation du Yocto-GPS-V2 avec Android aa.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item); my_spin.setAdapter(aa); @Override protected void onStart() super.onStart(); try { aa.clear(); YAPI.EnableUSBHost(this); YAPI.RegisterHub("usb"); YModule = YModule.FirstModule(); while != null) { String hwid = r.get_hardwareId(); aa.add(hwid); = r.nextModule(); } catch (YAPI_Exception e) { e.printStackTrace(); // refresh Spinner with detected relay aa.notifyDataSetChanged();...
  • Page 134 17. Utilisation du Yocto-GPS-V2 avec Android (module == null) return; boolean = ((Switch) view).isChecked(); try { if (on) { module.setBeacon(YModule.BEACON_ON); } else { module.setBeacon(YModule.BEACON_OFF); } catch (YAPI_Exception e) { e.printStackTrace(); Chaque propriété du module peut être lue grâce à une méthode du type YModule.get_xxxx...
  • Page 135 17. Utilisation du Yocto-GPS-V2 avec Android try { aa.clear(); YAPI.EnableUSBHost(this); YAPI.RegisterHub("usb"); YModule = YModule.FirstModule(); while != null) { String hwid = r.get_hardwareId(); aa.add(hwid); = r.nextModule(); } catch (YAPI_Exception e) { e.printStackTrace(); // refresh Spinner with detected relay aa.notifyDataSetChanged(); @Override protected...
  • Page 136 17. Utilisation du Yocto-GPS-V2 avec Android Attention, le nombre de cycles d'écriture de la mémoire non volatile du module est limité. Passé cette limite plus rien ne garantit que la sauvegarde des réglages se passera correctement. Cette limite, liée à la technologie employée par le micro-processeur du module se situe aux alentour de 100000 cycles.

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

  • Page 139: Utilisation Du Yocto-Gps-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 140: 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 141 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 142: 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 143: 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 144 \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 145: Présentation Des Vis Yoctopuce

    Yoctopuce et avec tous les VIs de l'API 18.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 146: 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 147: 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 148: 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 149 18. Utilisation du Yocto-GPS-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 150: 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 151: 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 152: Gestion Du Datalogger

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

    18. Utilisation du Yocto-GPS-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 154: Un Mot Sur Les Performances

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

    Yoctopuce pour LabVIEW 18.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 156 www.yoctopuce.com...

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

    19. 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 159: 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 160: 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-GPS-V2 avec le numéro de de série YGNSSMK2-12345 et le nom logique monModule. l'URL suivante permettra de connaître l'état du module.

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

    19.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 162 (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 163: Inventaire Des Modules

    19. 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 164: 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 165: 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 166: Détecter Le Changement De Valeur D'un Senseur

    à des moments où le programme principal n'est pas prêt à les recevoir, ce qui peut avoir des effets de bords indésirables comme des dead-locks et autres conditions de course. C'est pourquoi dans l'API Yoctopuce, les callbacks d'arrivée/départs de modules ne sont appelés que pendant l'exécution de la fonction .
  • Page 167 Yoctopuce (par exemple pour être notifié en cas de commutation d'un relais).

  • Page 168: L'enregistreur De Données

    Prog-EventBased. 20.2. L'enregistreur de données Votre Yocto-GPS-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 169: 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-GPS-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 170 Yoctopuce de chaque langage. L'exemple se trouve dans le répertoire Examples/Prog-DataLogger. Horodatage Le Yocto-GPS-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-GPS-V2 va automatiquement essayer de se mettre à...

  • Page 171: Calibration Des Senseurs

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

  • Page 175: Mise À Jour Du Firmware

    "mise à jour" et sera listé en dessous des modules connectés. 21.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 176: 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 177: 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 178: 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 179: Référence De L'api De Haut Niveau

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

  • Page 180: La Classe Yapi

    22. Référence de l'API de haut niveau 22.1. La classe YAPI Fonctions générales Ces quelques fonctions générales permettent l'initialisation et la configuration de la librairie Yoctopuce. Dans la plupart des cas, un appel à suffira en tout et pour tout. Ensuite, vous...
  • Page 181 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 182 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 183 . Lorsqu'on configure un nom logique avec une chaîne incorrecte, les caractères invalides sont ignorés. Paramètres : name une chaîne de caractères contenant le nom vérifier. Retourne : true si le nom est valide, false dans le cas contraire. www.yoctopuce.com...
  • Page 184 Désactive le cache de callback HTTP. function yClearHTTPCallbackCacheDir( $bool_removeFiles) Cette méthode désctive la cache de callback HTTP, et permet également d'en effacer le contenu. Paramètres : Vrai pour effacer le contenu du répertoire de cache. bool_removeFiles Retourne : nothing. www.yoctopuce.com...
  • Page 185 ) static void DisableExceptions( ) void DisableExceptions( ) DisableExceptions( ) function yDisableExceptions( ) async DisableExceptions( ) Lorsque les exceptions sont désactivées, chaque fonction retourne une valeur d'erreur spécifique selon son type, documentée dans ce manuel de référence. www.yoctopuce.com...
  • Page 186 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 187 (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 188 22. Référence de l'API de haut niveau YAPI.FreeAPI() YAPI YAPI.FreeAPI() Libère la mémoire dynamique utilisée par la librairie Yoctopuce. function yFreeAPI( ) void yFreeAPI( ) +(void) FreeAPI yFreeAPI( ) procedure yFreeAPI( ) static void FreeAPI( ) static void FreeAPI( )
  • Page 189 22. Référence de l'API de haut niveau YAPI.GetAPIVersion() YAPI YAPI.GetAPIVersion() Retourne la version de la librairie Yoctopuce utilisée. function yGetAPIVersion( ) string yGetAPIVersion( ) +(NSString*) GetAPIVersion string yGetAPIVersion( ): string function yGetAPIVersion( ) As String static String GetAPIVersion( ) static string GetAPIVersion( )
  • Page 190 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 191 ) As Integer int GetDeviceListValidity( ) int GetDeviceListValidity( ) java async Task<int> GetDeviceListValidity( ) GetDeviceListValidity( ) function yGetDeviceListValidity( ) async GetDeviceListValidity( ) Note: Cette fonction doit être appelée après yInitAPI Retourne : le nombre de secondes entre chaque énumération. www.yoctopuce.com...
  • Page 192 . 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 193 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 194 YAPI.GetLog() YAPI YAPI.GetLog() Récupère les messages de logs de la librairie de communication Yoctopuce. 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'à ce qu'elle retourne une chaîne vide. Prenez garde à sortir de votre boucle dès qu'une chaîne vide est retournée, car si vous repassez une chaîne vide dans le...
  • Page 195 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 196 GetTickCount( ) function yGetTickCount( ) GetTickCount( ) Ce compteur peut être utilisé pour calculer des délais en rapport avec les modules Yoctopuce, dont la base de temps est aussi la milliseconde. Retourne : un long entier contenant la valeur du compteur de millisecondes.
  • Page 197 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 198 22. Référence de l'API de haut niveau YAPI.InitAPI() YAPI YAPI.InitAPI() Initialise la librairie de programmation de Yoctopuce explicitement. function yInitAPI( mode, errmsg) YRETCODE yInitAPI( int mode, string errmsg) +(YRETCODE) InitAPI :(int) mode :(NSError**) errmsg integer yInitAPI( mode: integer, var errmsg: string): integer...
  • Page 199 "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 200 RegisterDeviceArrivalCallback( DeviceUpdateHandler arrivalCallback) RegisterDeviceArrivalCallback( arrivalCallback) function yRegisterDeviceArrivalCallback( $arrivalCallback) async RegisterDeviceArrivalCallback( arrivalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : arrivalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
  • Page 201 RegisterDeviceRemovalCallback( DeviceUpdateHandler removalCallback) RegisterDeviceRemovalCallback( removalCallback) function yRegisterDeviceRemovalCallback( $removalCallback) async RegisterDeviceRemovalCallback( removalCallback) Le callback sera appelé pendant l'éxecution de la fonction , que vous devrez yUpdateDeviceList appeler régulièrement. Paramètres : removalCallback YModule null une procédure qui prend un en paramètre, ou www.yoctopuce.com...
  • Page 202 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 203 22. Référence de l'API de haut niveau Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 204 , 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 205 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 206 RegisterLogFunction( yLogFunc logfun) void RegisterLogFunction( LogCallback logfun) java void RegisterLogFunction( LogHandler logfun) RegisterLogFunction( logfun) async RegisterLogFunction( logfun) Utile pour débugger le fonctionnement de l'API. Paramètres : une procedure qui prend une chaîne de caractère en paramètre, logfun www.yoctopuce.com...
  • Page 207 à 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 208 USB. Ce paramètre n'affecte pas les callbacks de changement de valeur Note: Cette fonction doit être appelée après yInitAPI Paramètres : cacheValidityMs un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes. www.yoctopuce.com...
  • Page 209 (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 210 à un réseau GSM où le trafic est facturé. Ce paramètre n'affecte pas les modules connectés par USB, ni le fonctionnement des callback de connexion/déconnexion de module. Note: Cette fonction doit être appelée après yInitAPI Paramètres : deviceListValidity nombre de secondes entre chaque énumération. www.yoctopuce.com...
  • Page 211 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 212 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 : le délais de connexion réseau en millisecondes. networkMsTimeout www.yoctopuce.com...
  • Page 213 à la durée de l'attente, en millisecondes des arguments supplémentaires peuvent être fournis, pour être passés à la fonction de args callback si nécessaire. Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 214 ê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 215 à jour. yHandleEvents() Cette fonction peut signaler une erreur au cas à la communication avec un module Yoctopuce ne se passerait pas comme attendu. Paramètres : un entier correspondant à la durée de la pause, en millisecondes...
  • Page 216 é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 217 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 218 22. Référence de l'API de haut niveau YAPI.UnregisterHub() YAPI YAPI.UnregisterHub() Configure la librairie Yoctopuce pour ne plus utiliser les modules connectés sur une machine préalablement enregistrer avec RegisterHub. function yUnregisterHub( url) void yUnregisterHub( string url) +(void) UnregisterHub :(NSString *) yUnregisterHub( url: string)
  • Page 219 22. Référence de l'API de haut niveau YAPI.UpdateDeviceList() YAPI YAPI.UpdateDeviceList() Force une mise-à-jour de la liste des modules Yoctopuce connectés. function yUpdateDeviceList( errmsg) YRETCODE yUpdateDeviceList( string errmsg) +(YRETCODE) UpdateDeviceList :(NSError**) errmsg integer yUpdateDeviceList( var errmsg: string): integer function yUpdateDeviceList( ByVal...
  • Page 220 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 221: La Classe Ymodule

    22.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 222 Retourne les identifiants matériels des fonctions correspondant au type passé en argument. module→get_hardwareId() Retourne l'identifiant unique du module. module→get_icon2d() Retourne l'icône du module. module→get_lastLogs() Retourne une chaine de charactère contenant les derniers logs du module. module→get_logicalName() Retourne le nom logique du module. module→get_luminosity() www.yoctopuce.com...
  • Page 223 Met en cache les valeurs courantes du module, avec une durée de validité spécifiée. module→log(text) Ajoute un message arbitraire dans les logs du module. module→nextModule() Continue l'énumération des modules commencée à l'aide de yFirstModule() module→reboot(secBeforeReboot) Agende un simple redémarrage du module dans un nombre donné de secondes. module→registerBeaconCallback(callback) www.yoctopuce.com...
  • Page 224 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 225 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 226 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le module sans ambiguïté, par exemple func MyDevice.module Retourne : un objet de classe YModule qui permet ensuite de contrôler le module. www.yoctopuce.com...
  • Page 227 ) static FirstModule( ) Utiliser la fonction pour itérer sur les autres modules. YModule.nextModule() Retourne : YModule null un pointeur sur un objet , correspondant au premier module accessible en ligne, ou aucun module n'a été trouvé. www.yoctopuce.com...
  • Page 228 22. Référence de l'API de haut niveau YModule module→Beacon état de la balise de localisation. int Beacon Valeurs possibles: Y_BEACON_INVALID Y_BEACON_OFF Y_BEACON_ON Modifiable. Allume ou éteint la balise de localisation du module. www.yoctopuce.com...
  • Page 229 22. 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 230 22. 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 231 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 232 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 233 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 234 22. 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 235 22. 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 236 22. 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 237 22. 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 238 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 239 ) void clearCache( ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du module. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 240 ) String describe( ) java describe( ) function describe( ) async describe( ) Ce texte peut contenir soit le nom logique du module, soit son numéro de série. Retourne : une chaîne de caractères décrivant le module www.yoctopuce.com...
  • Page 241 Task<byte[]> download( string pathname) download( pathname) function download( $pathname) async download( 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 242 à 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 243 ) As Integer int functionCount( ) int functionCount( ) java functionCount( ) function functionCount( ) async functionCount( ) Retourne : le nombre de fonctions sur le module En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 244 à 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 245 à 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 246 à 0 pour la functionIndex première fonction. Retourne : une chaîne de caractères correspondant au type de la fonction En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 247 à 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 248 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 249 Task<int> get_beacon( ) get_beacon( ) function get_beacon( ) async get_beacon( ) YModule target get_beacon Retourne : Y_BEACON_OFF Y_BEACON_ON soit , soit , selon l'état de la balise de localisation En cas d'erreur, déclenche une exception ou retourne Y_BEACON_INVALID www.yoctopuce.com...
  • Page 250 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du module www.yoctopuce.com...
  • Page 251 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du module...
  • Page 252 Task<string> get_firmwareRelease( ) get_firmwareRelease( ) function get_firmwareRelease( ) async get_firmwareRelease( ) YModule target get_firmwareRelease Retourne : une chaîne de caractères représentant la version du logiciel embarqué du module En cas d'erreur, déclenche une exception ou retourne Y_FIRMWARERELEASE_INVALID www.yoctopuce.com...
  • Page 253 ArrayList<String> get_functionIds( String funType) java async Task<List<string>> get_functionIds( string funType) get_functionIds( funType) function get_functionIds( $funType) async get_functionIds( funType) YModule target get_functionIds funType Paramètres : Le type de fonction (Relay, LightSensor, Voltage,...) funType Retourne : un tableau de chaînes de caractère. www.yoctopuce.com...
  • Page 254 ) async 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 255 ) async 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 256 ) 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 257 String get_logicalName( ) java async Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YModule target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du module En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...

  • Page 258: Retourne La Luminosité Des Leds Informatives Du Module (Valeur Entre 0 Et 100)

    Task<int> get_luminosity( ) get_luminosity( ) function get_luminosity( ) async get_luminosity( ) YModule target get_luminosity Retourne : un entier représentant la luminosité des leds informatives du module (valeur entre 0 et 100) En cas d'erreur, déclenche une exception ou retourne Y_LUMINOSITY_INVALID www.yoctopuce.com...

  • Page 259: Module→Get_Parenthub()

    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 260: Module→Get_Persistentsettings()

    Task<int> get_persistentSettings( ) get_persistentSettings( ) function get_persistentSettings( ) async get_persistentSettings( ) YModule target get_persistentSettings Retourne : Y_PERSISTENTSETTINGS_LOADED Y_PERSISTENTSETTINGS_SAVED une valeur parmi Y_PERSISTENTSETTINGS_MODIFIED représentant l'état courant des réglages persistents du module En cas d'erreur, déclenche une exception ou retourne Y_PERSISTENTSETTINGS_INVALID www.yoctopuce.com...

  • Page 261: Retourne L'identifiant Usb Du Module, Préprogrammé En Usine

    ) java async Task<int> get_productId( ) get_productId( ) function get_productId( ) async get_productId( ) YModule target get_productId Retourne : un entier représentant l'identifiant USB du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne Y_PRODUCTID_INVALID www.yoctopuce.com...

  • Page 262: Module→Get_Productname()

    Task<string> get_productName( ) get_productName( ) function get_productName( ) async get_productName( ) YModule target get_productName Retourne : une chaîne de caractères représentant le nom commercial du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne Y_PRODUCTNAME_INVALID www.yoctopuce.com...

  • Page 263: Module→Get_Productrelease()

    La révision originale du retourne la valeur 1, la révision B retourne la valeur 2, etc. Retourne : un entier représentant le numéro uméro de révision du module hardware, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne Y_PRODUCTRELEASE_INVALID www.yoctopuce.com...

  • Page 264: Module→Get_Rebootcountdown()

    ) async get_rebootCountdown( ) YModule target get_rebootCountdown Retourne : un entier représentant le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé En cas d'erreur, déclenche une exception ou retourne Y_REBOOTCOUNTDOWN_INVALID www.yoctopuce.com...

  • Page 265: Module→Get_Serialnumber()

    Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YModule target get_serialNumber Retourne : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine En cas d'erreur, déclenche une exception ou retourne Y_SERIALNUMBER_INVALID www.yoctopuce.com...

  • Page 266: Module→Get_Subdevices()

    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 267: Module→Get_Uptime()

    Task<long> get_upTime( ) get_upTime( ) function get_upTime( ) async get_upTime( ) YModule target get_upTime Retourne : un entier représentant le numbre de millisecondes écoulées depuis la mise sous tension du module En cas d'erreur, déclenche une exception ou retourne Y_UPTIME_INVALID www.yoctopuce.com...

  • Page 268: Retourne L'url Utilisée Pour Accéder Au Module

    Task<string> get_url( ) get_url( ) function get_url( ) async 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 269: Module→Get_Usbcurrent()

    Task<int> get_usbCurrent( ) get_usbCurrent( ) function get_usbCurrent( ) async get_usbCurrent( ) YModule target get_usbCurrent Retourne : un entier représentant le courant consommé par le module sur le bus USB, en milliampères En cas d'erreur, déclenche une exception ou retourne Y_USBCURRENT_INVALID www.yoctopuce.com...

  • Page 270: Module→Get_Userdata()

    ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 271 ) YModule target get_userVar Au démarrage du module (ou après un redémarrage), la valeur est toujours zéro. Retourne : un entier représentant la valeur entière précédemment stockée dans cet attribut En cas d'erreur, déclenche une exception ou retourne Y_USERVAR_INVALID www.yoctopuce.com...
  • Page 272 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 273 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 274 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 275 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 276 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 277 ê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 278 Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les modules sont retournés. Si vous souhaitez retrouver un module spécifique, utilisez avec un Module.findModule() hardwareID ou un nom logique. Retourne : un pointeur sur un objet YModule accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 279 $secBeforeReboot) async reboot( secBeforeReboot) 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 280 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 281 As YModuleConfigChangeCallback) As Integer int registerConfigChangeCallback( ConfigChangeCallback callback) int registerConfigChangeCallback( ConfigChangeCallback callback) java async Task<int> registerConfigChangeCallback( ConfigChangeCallback callback) registerConfigChangeCallback( callback) function registerConfigChangeCallback( $callback) async registerConfigChangeCallback( callback) Paramètres : callback une procédure qui prend un YModule en paramètre, ou null www.yoctopuce.com...
  • Page 282 Task<int> registerLogCallback( LogCallback callback) registerLogCallback( callback) function registerLogCallback( $callback) async registerLogCallback( callback) Utile pour débugger le fonctionnement d'un module Yoctopuce. Paramètres : la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux callback arguments: l'objet module qui a produit un log, un chaîne de caractère qui contiens le log...
  • Page 283 ) java async Task<int> revertFromFlash( ) revertFromFlash( ) function revertFromFlash( ) async 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 284 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 285 être préservés. saveToFlash() Paramètres : settings un objet binaire avec touts les paramètres Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 286 être préservés. Paramètres : settings un buffer binaire avec touts les paramètres Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 287 $newval) async set_beacon( newval) YModule target set_beacon newval Paramètres : newval Y_BEACON_OFF Y_BEACON_ON soit , soit Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 288 ê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 289 être préservé. Paramètres : newval un entier représentant la luminosité des leds informatives du module Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 290 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 291 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 : un entier 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 292 ) -(int) triggerConfigChangeCallback LongInt triggerConfigChangeCallback( ): LongInt function triggerConfigChangeCallback( ) As Integer int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) int triggerConfigChangeCallback( ) java async Task<int> triggerConfigChangeCallback( ) triggerConfigChangeCallback( ) function triggerConfigChangeCallback( ) async triggerConfigChangeCallback( ) YModule target triggerConfigChangeCallback www.yoctopuce.com...
  • Page 293 $secBeforeReboot) async triggerFirmwareUpdate( secBeforeReboot) 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 294 Cette méthode retourne un object YFirmwareUpdate qui est utilisé pour mettre à jour le firmware du module. Paramètres : path .byn le path du fichier à utiliser Retourne : un object YFirmwareUpdate ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 295 à jour le firmware du module. Paramètres : path le path du fichier .byn à utiliser force vrai pour forceer la mise à jour même si un prérequis ne semble pas satisfait Retourne : YFirmwareUpdate un object ou NULL en cas d'erreur www.yoctopuce.com...
  • Page 296 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 297: La Classe Ygps

    GPS/GNSS YGps Yoctopuce. Cette classe permet d'obtenir toutes les informations nécessaires. Cependant, si vous souhaitez définir des callbacks sur des changement de position ou enregistrer la position dans le datalogger, utilisez plutôt les classes...
  • Page 298 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du module de géolocalisation. gps→get_friendlyName() NOM_MODULE.NOM_FONCTION Retourne un identifiant global du module de géolocalisation au format gps→get_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction. gps→get_functionId() Retourne l'identifiant matériel du module de géolocalisation, sans référence au module. www.yoctopuce.com...
  • Page 299 Retourne le nom logique du module de géolocalisation. gps→get_longitude() Retourne la longitude courante. gps→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. gps→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. gps→get_satCount() Retourne le nombre total de satellites utilisés pour calculer la position GPS.
  • Page 300 Modifie le nombre de secondes de décalage entre l'heure courante et l'heure UTC (time zone). gps→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. gps→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 301 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le module de géolocalisation sans ambiguïté, par exemple YGNSSMK1.gps Retourne : YGps un objet de classe qui permet ensuite de contrôler le module de géolocalisation. www.yoctopuce.com...
  • Page 302 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le module de géolocalisation sans ambiguïté, par exemple func YGNSSMK1.gps Retourne : un objet de classe YGps qui permet ensuite de contrôler le module de géolocalisation. www.yoctopuce.com...
  • Page 303 YGps.nextGps() Retourne : YGps un pointeur sur un objet , correspondant au premier module de géolocalisation accessible en ligne, ou null si il n'y a pas de modules de géolocalisation disponibles. www.yoctopuce.com...
  • Page 304 YGps.nextGps() Paramètres : un contexte YAPI. yctx Retourne : YGps un pointeur sur un objet , correspondant au premier module de géolocalisation accessible en ligne, ou null si il n'y a pas de modules de géolocalisation disponibles. www.yoctopuce.com...
  • Page 305 Chaque chaîne retournée peut être passée en argument à la méthode pour obtenir YGps.FindGps 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 306 22. Référence de l'API de haut niveau YGps gps→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 307 CoordSystem Valeurs possibles: Y_COORDSYSTEM_INVALID Y_COORDSYSTEM_GPS_DMS Y_COORDSYSTEM_GPS_DM Y_COORDSYSTEM_GPS_D Modifiable. Change le système de représentation utilisé pour les données de positionnement. N'oubliez pas d'appeler la méthode du module si vous désirez que le réglage soit saveToFlash() préservé au prochain redémarrage. www.yoctopuce.com...
  • Page 308 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 309 22. Référence de l'API de haut niveau YGps gps→FunctionId Identifiant matériel du module de géolocalisation, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 310 22. Référence de l'API de haut niveau YGps gps→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 311 22. Référence de l'API de haut niveau YGps gps→IsFixed TRUE si le récepteur a trouvé suffisamment de satellites pour fonctionner. int IsFixed Valeurs possibles: Y_ISFIXED_INVALID Y_ISFIXED_FALSE Y_ISFIXED_TRUE www.yoctopuce.com...
  • Page 312 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 313 22. Référence de l'API de haut niveau YGps gps→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 314 22. Référence de l'API de haut niveau YGps gps→SatCount Nombre total de satellites utilisés pour calculer la position GPS. long SatCount www.yoctopuce.com...
  • Page 315 22. Référence de l'API de haut niveau YGps gps→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 316 Le décallage est automatiquement arrondi au quart d'heure le plus proche. Si l'heure UTC est connue, l'heure courante sera automatiquement adaptée en fonction du décalage choisi. N'oubliez pas d'appeler la méthode du module si vous désirez que le réglage soit préservé au saveToFlash() prochain redémarrage. www.yoctopuce.com...
  • Page 317 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du module de géolocalisation. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 318 è r e s d é c r i v a n t m o d u l e g é o l o c a l i s a t i o n ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 319 ) function get_advertisedValue( ) async get_advertisedValue( ) YGps target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du module de géolocalisation (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 320 YGps target get_altitude Retourne : une valeur numérique représentant l'altitude courante, Attention: la technologie GPS ne permet d'obtenir une altitude précise, des erreurs de plusieurs dizaine des mètres sont courantes En cas d'erreur, déclenche une exception ou retourne Y_ALTITUDE_INVALID www.yoctopuce.com...
  • Page 321 Y _ C O N S T E L L A T I O N _ G A L I L E O Y_CONSTELLATION_GPS_GLONASS Y_CONSTELLATION_GPS_GALILEO Y_CONSTELLATION_GLONASS_GALILEO représentant la constellation de satellites utilisée pour les données de positionnement En cas d'erreur, déclenche une exception ou retourne Y_CONSTELLATION_INVALID www.yoctopuce.com...
  • Page 322 Task<int> get_coordSystem( ) get_coordSystem( ) function get_coordSystem( ) async get_coordSystem( ) YGps target get_coordSystem Retourne : Y_COORDSYSTEM_GPS_DMS Y_COORDSYSTEM_GPS_DM valeur parmi Y_COORDSYSTEM_GPS_D représentant le système de représentation utilisé pour les données de positionnement En cas d'erreur, déclenche une exception ou retourne Y_COORDSYSTEM_INVALID www.yoctopuce.com...
  • Page 323 String get_dateTime( ) java async Task<string> get_dateTime( ) get_dateTime( ) function get_dateTime( ) async get_dateTime( ) YGps target get_dateTime Retourne : une chaîne de caractères représentant l'heure courante au format "AAAA/MM/JJ hh:mm:ss" En cas d'erreur, déclenche une exception ou retourne Y_DATETIME_INVALID www.yoctopuce.com...
  • Page 324 ) async get_dilution( ) YGps target get_dilution Plus ce chiffre est petit, plus la précision est grande. Retourne : une valeur numérique représentant la dilution de précision horizontale En cas d'erreur, déclenche une exception ou retourne Y_DILUTION_INVALID www.yoctopuce.com...
  • Page 325 Task<double> get_direction( ) get_direction( ) function get_direction( ) async get_direction( ) YGps target get_direction Retourne : une valeur numérique représentant la direction du déplacement en degrés par rapport au nord vrai (géographique) En cas d'erreur, déclenche une exception ou retourne Y_DIRECTION_INVALID www.yoctopuce.com...
  • Page 326 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du module de géolocalisation.
  • Page 327 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du module de géolocalisation.
  • Page 328 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le module de géolocalisation en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 329 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 330 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant le module de géolocalisation (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 331 ) YGps target get_gpsRefreshRate Cette valeur n'est mise à jour qu'une fois toutes les 5 secondes. Retourne : une valeur numérique représentant la fréquence de rafraichissement effective des données GPS En cas d'erreur, déclenche une exception ou retourne Y_GPSREFRESHRATE_INVALID www.yoctopuce.com...
  • Page 332 ) java async Task<double> get_groundSpeed( ) get_groundSpeed( ) function get_groundSpeed( ) async get_groundSpeed( ) YGps target get_groundSpeed Retourne : une valeur numérique représentant la vitesse au sol actuelle en Km/h En cas d'erreur, déclenche une exception ou retourne Y_GROUNDSPEED_INVALID www.yoctopuce.com...
  • Page 333 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du module de géolocalisation (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le module de géolocalisation (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 334 ) function get_isFixed( ) async get_isFixed( ) YGps target get_isFixed Retourne : Y_ISFIXED_FALSE Y_ISFIXED_TRUE soit , soit , selon TRUE si le récepteur a trouvé suffisamment de satellites pour fonctionner En cas d'erreur, déclenche une exception ou retourne Y_ISFIXED_INVALID www.yoctopuce.com...
  • Page 335 ) String get_latitude( ) java async Task<string> get_latitude( ) get_latitude( ) function get_latitude( ) async get_latitude( ) YGps target get_latitude Retourne : une chaîne de caractères représentant la latitude courante En cas d'erreur, déclenche une exception ou retourne Y_LATITUDE_INVALID www.yoctopuce.com...
  • Page 336 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YGps target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du module de géolocalisation. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 337 ) String get_longitude( ) java async Task<string> get_longitude( ) get_longitude( ) function get_longitude( ) async get_longitude( ) YGps target get_longitude Retourne : une chaîne de caractères représentant la longitude courante En cas d'erreur, déclenche une exception ou retourne Y_LONGITUDE_INVALID www.yoctopuce.com...
  • Page 338 22. Référence de l'API de haut niveau YGps gps→get_module() gps→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 339 22. Référence de l'API de haut niveau YGps gps→get_module_async() gps→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 340 Task<long> get_satCount( ) get_satCount( ) function get_satCount( ) async get_satCount( ) YGps target get_satCount Retourne : un entier représentant le nombre total de satellites utilisés pour calculer la position GPS En cas d'erreur, déclenche une exception ou retourne Y_SATCOUNT_INVALID www.yoctopuce.com...
  • Page 341 5: nombre de satellites GPS, bits 6..11 : Glonass, bits 12..17 : Galileo. Cette valeur n'est mise à jour qu'une fois toutes les 5 secondes. . Retourne : un entier représentant le nombre de satellites visibles et par constellation, encodé sur un entier 32 bits: bits En cas d'erreur, déclenche une exception ou retourne Y_SATPERCONST_INVALID www.yoctopuce.com...
  • Page 342 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YGps 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 343 ) function get_unixTime( ) async get_unixTime( ) YGps target get_unixTime Retourne : un entier représentant l'heure courante au format Unix (nombre de secondes écoulées depuis le 1er janvier 1970) En cas d'erreur, déclenche une exception ou retourne Y_UNIXTIME_INVALID www.yoctopuce.com...
  • Page 344 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 345 ) function get_utcOffset( ) async get_utcOffset( ) YGps target get_utcOffset Retourne : un entier représentant le nombre de secondes de décallage entre l'heure courante et l'heure UTC (time zone) En cas d'erreur, déclenche une exception ou retourne Y_UTCOFFSET_INVALID www.yoctopuce.com...
  • Page 346 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 de géolocalisation est joignable, sinon www.yoctopuce.com...
  • Page 347 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 348 ) YGps 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 349 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 350 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 351 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 352 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la 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 353 ) nextGps( ) Si vous souhaitez retrouver un module de géolocalisation spécifique, utilisez avec Gps.findGps() un hardwareID ou un nom logique. Retourne : un pointeur sur un objet YGps accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 354 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 355 Y _ C O N S T E L L A T I O N _ G A L I L E O Y_CONSTELLATION_GPS_GLONASS Y_CONSTELLATION_GPS_GALILEO Y_CONSTELLATION_GLONASS_GALILEO Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 356 Paramètres : newval Y_COORDSYSTEM_GPS_DMS Y_COORDSYSTEM_GPS_DM une valeur parmi Y_COORDSYSTEM_GPS_D Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 357 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du module de géolocalisation. 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 358 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 359 UTC (time zone) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 360 Cette fonction annule un précédent appel à muteValueCallbacks() . 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 361 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 362: La Classe Ylatitude

    22.4. La classe YLatitude Interface pour intéragir avec les capteurs de latitude, disponibles par exemple dans le Yocto-GPS La classe permet de lire et de configurer les capteurs de latitude Yoctopuce. Elle hérite de YLatitude la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.
  • Page 363 Retourne un identifiant global du capteur de latitude au format latitude→get_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction. latitude→get_functionId() Retourne l'identifiant matériel du capteur de latitude, sans référence au module. latitude→get_hardwareId() SERIAL.FUNCTIONID Retourne l'identifiant matériel unique du capteur de latitude au format www.yoctopuce.com...
  • Page 364 Retourne la valeur minimale observée pour la latitude depuis le démarrage du module. latitude→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. latitude→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. latitude→get_recordedData(startTime, endTime)
  • Page 365 Arrête l'enregistreur de données du module. latitude→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. latitude→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 366 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur de latitude sans ambiguïté, par exemple YGNSSMK1.latitude Retourne : YLatitude un objet de classe qui permet ensuite de contrôler le capteur de latitude. www.yoctopuce.com...
  • Page 367 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le capteur de latitude sans ambiguïté, par exemple func YGNSSMK1.latitude Retourne : un objet de classe YLatitude qui permet ensuite de contrôler le capteur de latitude. www.yoctopuce.com...
  • Page 368 Utiliser la fonction pour itérer sur les autres capteurs de latitude. YLatitude.nextLatitude() Retourne : YLatitude un pointeur sur un objet , correspondant au premier capteur delatitude accessible en ligne, ou null si il n'y a pas de capteurs de latitude disponibles. www.yoctopuce.com...
  • Page 369 YLatitude.nextLatitude() Paramètres : un contexte YAPI. yctx Retourne : YLatitude un pointeur sur un objet , correspondant au premier capteur delatitude accessible en ligne, ou null si il n'y a pas de capteurs de latitude disponibles. www.yoctopuce.com...
  • Page 370 Chaque chaîne retournée peut être passée en argument à la méthode YLatitude.FindLatitude pour obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
  • Page 371 22. Référence de l'API de haut niveau YLatitude latitude→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Valeurs possibles: Y_ADVMODE_INVALID Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 372 22. Référence de l'API de haut niveau YLatitude latitude→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 373 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 374 22. Référence de l'API de haut niveau YLatitude latitude→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 375 22. Référence de l'API de haut niveau YLatitude latitude→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 376 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 377 "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 378 22. Référence de l'API de haut niveau YLatitude latitude→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 379 "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 380 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 381 22. Référence de l'API de haut niveau YLatitude latitude→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 382 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.
  • Page 383 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du capteur de latitude. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 384 è r e s d é c r i v a n t c a p t e u r l a t i t u d e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 385 Y _ A D V M O D E _ P E R I O D _ A V G u n e v a l e u r p a r m i Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...
  • Page 386 ) function get_advertisedValue( ) async get_advertisedValue( ) YLatitude target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur de latitude (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 387 ) YLatitude target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en deg/1000, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 388 En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
  • Page 389 ) async 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 390 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du capteur de latitude.
  • Page 391 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du capteur de latitude.
  • Page 392 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur de latitude en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 393 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 394 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant le capteur de latitude (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 395 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de latitude (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le capteur de latitude (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 396 Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour la latitude depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 397 Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 398 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YLatitude target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur de latitude. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 399 Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour la latitude depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 400 22. Référence de l'API de haut niveau YLatitude latitude→get_module() latitude→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 401 22. Référence de l'API de haut niveau YLatitude latitude→get_module_async() latitude→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 402 à 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 403 ) YLatitude target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 404 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 405 En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 406 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YLatitude 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 407 Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ) YLatitude target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la latitude est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 408 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 409 Si les valeurs des attributs en cache du capteur de latitude sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur de latitude est joignable, sinon www.yoctopuce.com...
  • Page 410 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 411 ) YLatitude 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 412 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 413 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 414 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 415 Retourne : YAPI_SUCCESS si l'opération se 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 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 417 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la 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 418 ) nextLatitude( ) Si vous souhaitez retrouver un capteur de latitude spécifique, utilisez Latitude.findLatitude() avec un hardwareID ou un nom logique. Retourne : un pointeur sur un objet YLatitude accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 419 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 420 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 421 Y_ADVMODE_PERIOD_AVG valeur parmi Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 422 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur maximale observé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 423 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 424 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de latitude. 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 425 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur minimale observé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 426 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 427 être préservé. Paramètres : newval une valeur numérique représentant la résolution des valeurs physique 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 428 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 429 ) function startDataLogger( ) async startDataLogger( ) YLatitude 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 430 ) As Integer int stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ) YLatitude target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 431 Cette fonction annule un précédent appel à muteValueCallbacks() . 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 432 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 433: La Classe Ylongitude

    22.5. La classe YLongitude Interface pour intéragir avec les capteurs de longitude, disponibles par exemple dans le Yocto-GPS La classe permet de lire et de configurer les capteurs de longitude Yoctopuce. Elle YLongitude hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.
  • Page 434 Retourne un identifiant global du capteur de longitude au format longitude→get_functionDescriptor() Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction. longitude→get_functionId() Retourne l'identifiant matériel du capteur de longitude, sans référence au module. longitude→get_hardwareId() SERIAL.FUNCTIONID Retourne l'identifiant matériel unique du capteur de longitude au format www.yoctopuce.com...
  • Page 435 Retourne la valeur minimale observée pour la longitude depuis le démarrage du module. longitude→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. longitude→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. longitude→get_recordedData(startTime, endTime)
  • Page 436 Arrête l'enregistreur de données du module. longitude→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. longitude→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 437 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur de longitude sans ambiguïté, par exemple YGNSSMK1.longitude Retourne : YLongitude un objet de classe qui permet ensuite de contrôler le capteur de longitude. www.yoctopuce.com...
  • Page 438 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : un contexte YAPI yctx func une chaîne de caractères qui référence le capteur de longitude sans ambiguïté, par exemple YGNSSMK1.longitude Retourne : YLongitude un objet de classe qui permet ensuite de contrôler le capteur de longitude. www.yoctopuce.com...
  • Page 439 Utiliser la fonction pour itérer sur les autres capteurs de YLongitude.nextLongitude() longitude. Retourne : YLongitude un pointeur sur un objet , correspondant au premier capteur delongitude accessible en ligne, null si il n'y a pas de capteurs de longitude disponibles. www.yoctopuce.com...
  • Page 440 YLongitude.nextLongitude() longitude. Paramètres : un contexte YAPI. yctx Retourne : YLongitude un pointeur sur un objet , correspondant au premier capteur delongitude accessible en ligne, null si il n'y a pas de capteurs de longitude disponibles. www.yoctopuce.com...
  • Page 441 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YLongitude.FindLongitude 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 442 22. Référence de l'API de haut niveau YLongitude longitude→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Valeurs possibles: Y_ADVMODE_INVALID Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 443 22. Référence de l'API de haut niveau YLongitude longitude→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 444 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 445 22. Référence de l'API de haut niveau YLongitude longitude→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 446 22. Référence de l'API de haut niveau YLongitude longitude→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 447 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 448 "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 449 22. Référence de l'API de haut niveau YLongitude longitude→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 450 "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 451 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 452 22. Référence de l'API de haut niveau YLongitude longitude→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 453 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.

  • Page 454: Invalide Le Cache

    ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du capteur de longitude. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...

  • Page 455: Longitude→Describe()

    è r e s d é c r i v a n t c a p t e u r l o n g i t u d e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 456 Y _ A D V M O D E _ P E R I O D _ A V G u n e v a l e u r p a r m i Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...

  • Page 457: Longitude→Get_Advertisedvalue()

    ) function get_advertisedValue( ) async get_advertisedValue( ) YLongitude target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur de longitude (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...

  • Page 458: Longitude→Get_Currentrawvalue()

    ) YLongitude target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en deg/1000, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...

  • Page 459: Longitude→Get_Currentvalue()

    En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
  • Page 460 ) async 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 461: Longitude→Get_Errormessage()

    ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du capteur de longitude.
  • Page 462 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du capteur de longitude.

  • Page 463: Longitude→Get_Friendlyname()

    (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur de longitude en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 464 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...

  • Page 465: Retourne L'identifiant Matériel Du Capteur De Longitude, Sans Référence Au Module

    ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant le capteur de longitude (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...

  • Page 466: Retourne L'identifiant Matériel Unique Du Capteur De Longitude Au Format

    L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de longitude (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le capteur de longitude (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 467 Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour la longitude depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 468 Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 469 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YLongitude target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur de longitude. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 470 Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour la longitude depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 471 22. Référence de l'API de haut niveau YLongitude longitude→get_module() longitude→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 472 22. Référence de l'API de haut niveau YLongitude longitude→get_module_async() longitude→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 473 à 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 474 ) YLongitude target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 475 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 476 En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 477 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YLongitude 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 478 Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ) YLongitude target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la longitude est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 479 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 480 Si les valeurs des attributs en cache du capteur de longitude sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur de longitude est joignable, sinon www.yoctopuce.com...
  • Page 481 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 482 ) YLongitude 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 483 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 484 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 485 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 486 Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 487 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 488 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la 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 489 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. Longitude.findLongitude() Retourne : un pointeur sur un objet YLongitude accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 490 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 491 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 492 Y_ADVMODE_PERIOD_AVG valeur parmi Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 493 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur maximale observé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 494 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 495 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de longitude. 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 496 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur minimale observé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 497 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 498 être préservé. Paramètres : newval une valeur numérique représentant la résolution des valeurs physique 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 499 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 500 ) function startDataLogger( ) async startDataLogger( ) YLongitude 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 501 ) As Integer int stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ) YLongitude target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 502 Cette fonction annule un précédent appel à muteValueCallbacks() . 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 503 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 504: La Classe Yaltitude

    Interface pour intéragir avec les altimètres, disponibles par exemple dans le Yocto-Altimeter-V2 et le Yocto-GPS La classe permet de lire et de configurer les altimètres Yoctopuce. Elle hérite de la classe YAltitude toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, YSensor enregistreur de données.
  • Page 505 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'altimètre. altitude→get_friendlyName() Retourne un identifiant global de l'altimètre au format NOM_MODULE.NOM_FONCTION altitude→get_functionDescriptor() YFUN_DESCR Retourne un identifiant unique de type correspondant à la fonction. altitude→get_functionId() www.yoctopuce.com...
  • Page 506 Retourne le nom logique de l'altimètre. altitude→get_lowestValue() Retourne la valeur minimale observée pour l'altitude depuis le démarrage du module. altitude→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. altitude→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. altitude→get_qnh() Retourne la pression de référence au niveau de la mer utilisée pour le calcul de l'altitude (QNH).
  • Page 507 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 altitude→startDataLogger() Démarre l'enregistreur de données du module. altitude→stopDataLogger() Arrête l'enregistreur de données du module. altitude→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. altitude→wait_async(callback, context) www.yoctopuce.com...
  • Page 508 22. Référence de l'API de haut niveau Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 509 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'altimètre sans ambiguïté, par exemple YALTIMK2.altitude Retourne : YAltitude un objet de classe qui permet ensuite de contrôler l'altimètre. www.yoctopuce.com...
  • Page 510 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence l'altimètre sans ambiguïté, par exemple func YALTIMK2.altitude Retourne : un objet de classe YAltitude qui permet ensuite de contrôler l'altimètre. www.yoctopuce.com...
  • Page 511 ) static FirstAltitude( ) Utiliser la fonction pour itérer sur les autres altimètres. YAltitude.nextAltitude() Retourne : YAltitude null un pointeur sur un objet , correspondant au premier altimètre accessible en ligne, ou il n'y a pas de altimètres disponibles. www.yoctopuce.com...
  • Page 512 Utiliser la fonction pour itérer sur les autres altimètres. YAltitude.nextAltitude() Paramètres : un contexte YAPI. yctx Retourne : YAltitude null un pointeur sur un objet , correspondant au premier altimètre accessible en ligne, ou il n'y a pas de altimètres disponibles. www.yoctopuce.com...
  • Page 513 Chaque chaîne retournée peut être passée en argument à la méthode YAltitude.FindAltitude pour obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
  • Page 514 22. Référence de l'API de haut niveau YAltitude altitude→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Valeurs possibles: Y_ADVMODE_INVALID Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 515 22. Référence de l'API de haut niveau YAltitude altitude→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 516 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 517 22. Référence de l'API de haut niveau YAltitude altitude→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 518 22. Référence de l'API de haut niveau YAltitude altitude→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 519 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 520 "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 521 22. Référence de l'API de haut niveau YAltitude altitude→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 522 Pression de référence au niveau de la mer utilisée pour le calcul de l'altitude (QNH). double Qnh Ne s'applique qu'aux altimètres barométriques. Modifiable. Ceci permet de compenser les changements de pression atmosphérique dus au climat. Ne s'applique qu'aux altimètres barométriques. N'oubliez pas d'appeler la méthode saveToFlash() module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 523 "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 524 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 525 22. Référence de l'API de haut niveau YAltitude altitude→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 526 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.
  • Page 527 ) void clearCache( ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes de l'altimètre. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 528 î n e c a r a c t è r e s d é c r i v a n t l ' a l t i m è t r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 529 Y _ A D V M O D E _ P E R I O D _ A V G u n e v a l e u r p a r m i Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...
  • Page 530 Task<string> get_advertisedValue( ) get_advertisedValue( ) function get_advertisedValue( ) async get_advertisedValue( ) YAltitude target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'altimètre (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 531 ) YAltitude target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en mètres, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 532 En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
  • Page 533 ) async 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 534 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'altimètre.
  • Page 535 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'altimètre.
  • Page 536 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'altimètre en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 537 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 538 ) string get_functionId( ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant l'altimètre (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 539 ) L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'altimètre (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'altimètre (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 540 YAltitude target get_highestValue Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour l'altitude depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 541 Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 542 String get_logicalName( ) java async Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YAltitude target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'altimètre. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 543 YAltitude target get_lowestValue Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour l'altitude depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 544 22. Référence de l'API de haut niveau YAltitude altitude→get_module() altitude→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 545 22. Référence de l'API de haut niveau YAltitude altitude→get_module_async() altitude→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 546 YAltitude target get_qnh Ne s'applique qu'aux altimètres barométriques. Retourne : une valeur numérique représentant la pression de référence au niveau de la mer utilisée pour le calcul de l'altitude (QNH) En cas d'erreur, déclenche une exception ou retourne Y_QNH_INVALID www.yoctopuce.com...
  • Page 547 à 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 548 ) YAltitude target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 549 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 550 En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 551 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YAltitude 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 552 String get_technology( ) java async Task<string> get_technology( ) get_technology( ) function get_technology( ) async get_technology( ) YAltitude target get_technology les valeur possible sont "barometric" et "gps" Retourne : une chaîne de caractères En cas d'erreur, déclenche une exception ou retourne Y_TECHNOLOGY_INVALID www.yoctopuce.com...
  • Page 553 String get_unit( ) java async Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ) YAltitude target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle l'altitude est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 554 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 555 Si les valeurs des attributs en cache de l'altimètre sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'altimètre est joignable, sinon www.yoctopuce.com...
  • Page 556 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 557 ) YAltitude 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 558 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 559 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 560 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 561 Retourne : YAPI_SUCCESS si l'opération se 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 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 563 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la 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 564 ) function nextAltitude( ) nextAltitude( ) Si vous souhaitez retrouver un altimetre spécifique, utilisez avec un Altitude.findAltitude() hardwareID ou un nom logique. Retourne : un pointeur sur un objet YAltitude accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 565 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 566 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 567 Y_ADVMODE_PERIOD_AVG valeur parmi Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 568 être préservé. saveToFlash() Paramètres : newval une valeur numérique représentant l'altitude actuelle supposé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 569 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur maximale observé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 570 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 571 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'altimètre. Retourne : YAPI_SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 572 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur minimale observé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 573 (QNH) Retourne : YAPI_SUCCESS si l'opération se 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 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 575 être préservé. Paramètres : newval une valeur numérique représentant la résolution des valeurs physique 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 576 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 577 ) function startDataLogger( ) async startDataLogger( ) YAltitude 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 578 ) As Integer int stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ) YAltitude target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 579 Cette fonction annule un précédent appel à muteValueCallbacks() . 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 580 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 581: La Classe Ygroundspeed

    22.7. La classe YGroundSpeed Interface pour intéragir avec les capteurs de vitesse/sol, disponibles par exemple dans le Yocto-GPS La classe permet de lire et de configurer les capteurs de vitesse/sol Yoctopuce. Elle YGroundSpeed hérite de la classe toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, YSensor callbacks, enregistreur de données.
  • Page 582 Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du capteur de vitesse/sol. groundspeed→get_friendlyName() Retourne un identifiant global du capteur de vitesse/sol au format NOM_MODULE.NOM_FONCTION groundspeed→get_functionDescriptor() YFUN_DESCR Retourne un identifiant unique de type correspondant à la fonction. groundspeed→get_functionId() Retourne l'identifiant matériel du capteur de vitesse/sol, sans référence au module. groundspeed→get_hardwareId() www.yoctopuce.com...
  • Page 583 Retourne la valeur minimale observée pour la vitesse/sol depuis le démarrage du module. groundspeed→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. groundspeed→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. groundspeed→get_recordedData(startTime, endTime)
  • Page 584 Arrête l'enregistreur de données du module. groundspeed→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. groundspeed→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 585 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le capteur de vitesse/sol sans ambiguïté, par exemple YGNSSMK1.groundSpeed Retourne : YGroundSpeed un objet de classe qui permet ensuite de contrôler le capteur de vitesse/sol. www.yoctopuce.com...
  • Page 586 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le capteur de vitesse/sol sans ambiguïté, par exemple YGNSSMK1.groundSpeed Retourne : un objet de classe YGroundSpeed qui permet ensuite de contrôler le capteur de vitesse/sol. www.yoctopuce.com...
  • Page 587 Utiliser la fonction pour itérer sur les autres capteurs de YGroundSpeed.nextGroundSpeed() vitesse/sol. Retourne : YGroundSpeed un pointeur sur un objet , correspondant au premier capteur vitesse/sol accessible en ligne, ou null si il n'y a pas de capteurs de vitesse/sol disponibles. www.yoctopuce.com...
  • Page 588 YGroundSpeed.nextGroundSpeed() vitesse/sol. Paramètres : un contexte YAPI. yctx Retourne : YGroundSpeed un pointeur sur un objet , correspondant au premier capteur vitesse/sol accessible en ligne, ou null si il n'y a pas de capteurs de vitesse/sol disponibles. www.yoctopuce.com...
  • Page 589 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le module YGroundSpeed.FindGroundSpeed 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 590 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→AdvMode Mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue). int AdvMode Valeurs possibles: Y_ADVMODE_INVALID Y_ADVMODE_IMMEDIATE Y_ADVMODE_PERIOD_AVG Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 591 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 592 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 593 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→FunctionId Identifiant matériel du senseur, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 594 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→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 595 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 596 "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 597 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→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 598 "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 599 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 600 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 601 être préservé. saveToFlash() Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com. Paramètres : rawValues tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.
  • Page 602 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du capteur de vitesse/sol. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 603 è r e s d é c r i v a n t c a p t e u r v i t e s s e / s o l ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 604 Y _ A D V M O D E _ P E R I O D _ A V G u n e v a l e u r p a r m i Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) En cas d'erreur, déclenche une exception ou retourne Y_ADVMODE_INVALID www.yoctopuce.com...
  • Page 605 ) function get_advertisedValue( ) async get_advertisedValue( ) YGroundSpeed target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du capteur de vitesse/sol (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 606 ) YGroundSpeed target get_currentRawValue Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration), en km/h, sous forme de nombre à virgule En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRAWVALUE_INVALID www.yoctopuce.com...
  • Page 607 En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu à une fréquence qui lui est propre. Si vous rencontrez des problèmes de performances en utilisant la fonction get_currentValue() fréquemment, il vous faudra basculer sur un modèle de callbacks.
  • Page 608 ) async 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 609 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du capteur de vitesse/sol.
  • Page 610 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du capteur de vitesse/sol.
  • Page 611 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le capteur de vitesse/sol en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 612 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 613 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant le capteur de vitesse/sol (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 614 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de vitesse/sol (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le capteur de vitesse/sol (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 615 Peut être réinitialisé à une valeur arbitraire grâce à set_highestValue(). Retourne : une valeur numérique représentant la valeur maximale observée pour la vitesse/sol depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_HIGHESTVALUE_INVALID www.yoctopuce.com...
  • Page 616 Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_LOGFREQUENCY_INVALID www.yoctopuce.com...
  • Page 617 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YGroundSpeed target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du capteur de vitesse/sol. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 618 Peut être réinitialisé à une valeur arbitraire grâce à set_lowestValue(). Retourne : une valeur numérique représentant la valeur minimale observée pour la vitesse/sol depuis le démarrage du module En cas d'erreur, déclenche une exception ou retourne Y_LOWESTVALUE_INVALID www.yoctopuce.com...
  • Page 619 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→get_module() groundspeed→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 620 22. Référence de l'API de haut niveau YGroundSpeed groundspeed→get_module_async() groundspeed→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 621 à 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 622 ) YGroundSpeed target get_reportFrequency Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction En cas d'erreur, déclenche une exception ou retourne Y_REPORTFREQUENCY_INVALID www.yoctopuce.com...
  • Page 623 à la précision réelle du capteur. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : une valeur numérique représentant la résolution des valeurs mesurées En cas d'erreur, déclenche une exception ou retourne Y_RESOLUTION_INVALID www.yoctopuce.com...
  • Page 624 En cas d'erreur, déclenche une exception ou retourne Y_SENSORSTATE_INVALID www.yoctopuce.com...
  • Page 625 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YGroundSpeed 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 626 Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ) YGroundSpeed target get_unit Retourne : une chaîne de caractères représentant l'unité dans laquelle la vitesse/sol est exprimée En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 627 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 628 Si les valeurs des attributs en cache du capteur de vitesse/sol sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le capteur de vitesse/sol est joignable, sinon www.yoctopuce.com...
  • Page 629 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 630 ) YGroundSpeed 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 631 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 632 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 633 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 634 Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 635 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 636 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la 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 637 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. GroundSpeed.findGroundSpeed() Retourne : un pointeur sur un objet YGroundSpeed accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 638 Paramètres : la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux callback YMeasure arguments: l'object fonction dont la valeur a changé, et un objet décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 639 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 640 Y_ADVMODE_PERIOD_AVG valeur parmi Y_ADVMODE_PERIOD_MIN Y_ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publiée jusqu'au hub parent (advertisedValue) Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 641 Utile pour réinitialiser la valeur renvoyée par get_highestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur maximale observé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 642 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 643 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de vitesse/sol. 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 644 Utile pour réinitialiser la valeur renvoyée par get_lowestValue(). Paramètres : une valeur numérique représentant la mémoire de valeur minimale observé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 645 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 646 être préservé. Paramètres : newval une valeur numérique représentant la résolution des valeurs physique 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 647 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 648 ) function startDataLogger( ) async startDataLogger( ) YGroundSpeed 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 649 ) As Integer int stopDataLogger( ) int stopDataLogger( ) int stopDataLogger( ) java async Task<int> stopDataLogger( ) stopDataLogger( ) function stopDataLogger( ) async stopDataLogger( ) YGroundSpeed target stopDataLogger Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. www.yoctopuce.com...
  • Page 650 Cette fonction annule un précédent appel à muteValueCallbacks() . 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 651 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 652: La Classe Ydatalogger

    22. Référence de l'API de haut niveau 22.8. 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 653 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() Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction. datalogger→get_functionId() Retourne l'identifiant matériel de l'enregistreur de données, sans référence au module. datalogger→get_hardwareId() www.yoctopuce.com...
  • Page 654 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 655 Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la get_userData méthode 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 656 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple Y3DMK002.dataLogger Retourne : YDataLogger un objet de classe qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 657 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté, par exemple Y3DMK002.dataLogger Retourne : un objet de classe YDataLogger qui permet ensuite de contrôler l'enregistreur de données. www.yoctopuce.com...
  • Page 658 YDataLogger.nextDataLogger() données. Retourne : YDataLogger un pointeur sur un objet , correspondant au premier enregistreur de données accessible en ligne, ou null si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 659 YDataLogger.nextDataLogger() données. Paramètres : un contexte YAPI. yctx Retourne : YDataLogger un pointeur sur un objet , correspondant au premier enregistreur de données accessible en ligne, ou null si il n'y a pas de enregistreurs de données disponibles. www.yoctopuce.com...
  • Page 660 à 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 661 22. 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 662 Modifiable. N'oubliez pas d'appeler la méthode pour sauver la modification de saveToFlash() configuration. Attention si le module n'a pas de source de temps à sa disposition au démarrage, il va attendre environ 8 sec avant de démarrer automatiquement l'enregistrement avec un horodatage arbitraire. www.yoctopuce.com...
  • Page 663 Vrai si l'enregistreur de données est synchronisé avec la balise de localisation. int BeaconDriven Valeurs possibles: Y_BEACONDRIVEN_INVALID Y_BEACONDRIVEN_OFF Y_BEACONDRIVEN_ON Modifiable. Modifie le mode de synchronisation de l'enregistreur de données . N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 664 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 665 22. 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 666 22. 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 667 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 668 22. 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 669 22. Référence de l'API de haut niveau YDataLogger datalogger→Recording état d'activation de l'enregistreur de données. int Recording Valeurs possibles: Y_RECORDING_INVALID Y_RECORDING_OFF Y_RECORDING_ON Y_RECORDING_PENDING Modifiable. www.yoctopuce.com...
  • Page 670 22. 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 671 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes de l'enregistreur de données. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 672 è 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 673 ) async 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 674 ) function get_advertisedValue( ) async get_advertisedValue( ) YDataLogger target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'enregistreur de données (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 675 ) async get_autoStart( ) YDataLogger target get_autoStart Retourne : Y_AUTOSTART_OFF Y_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 Y_AUTOSTART_INVALID www.yoctopuce.com...
  • Page 676 ) async get_beaconDriven( ) YDataLogger target get_beaconDriven Retourne : Y_BEACONDRIVEN_OFF Y_BEACONDRIVEN_ON soit , soit , selon vrai si l'enregistreur de données est synchronisé avec la balise de localisation En cas d'erreur, déclenche une exception ou retourne Y_BEACONDRIVEN_INVALID www.yoctopuce.com...
  • Page 677 Retourne : un entier représentant le numéro du Run actuel, correspondant au nombre de fois que le module a été mis sous tension avec la fonction d'enregistreur de données active En cas d'erreur, déclenche une exception ou retourne Y_CURRENTRUNINDEX_INVALID www.yoctopuce.com...
  • Page 678 Cette méthode ne fonctionne que si le module utilise un firmware récent, car les objets YDataSet sont pas supportés par les firmwares antérieurs à la révision 13000. Retourne : une liste d'objets YDataSet En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 679 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 680 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
  • Page 681 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.
  • Page 682 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 683 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 684 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : une chaîne de caractères identifiant l'enregistreur de données (ex: relay1 En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 685 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 Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 686 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YDataLogger target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'enregistreur de données. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 687 22. 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 688 22. 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 689 Task<int> get_recording( ) get_recording( ) function get_recording( ) async get_recording( ) YDataLogger target get_recording Retourne : Y_RECORDING_OFF Y_RECORDING_ON Y_RECORDING_PENDING une valeur parmi représentant l'état d'activation de l'enregistreur de données En cas d'erreur, déclenche une exception ou retourne Y_RECORDING_INVALID www.yoctopuce.com...
  • Page 690 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YDataLogger target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 691 Task<long> get_timeUTC( ) get_timeUTC( ) function get_timeUTC( ) async get_timeUTC( ) YDataLogger target get_timeUTC Retourne : un entier représentant le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue En cas d'erreur, déclenche une exception ou retourne Y_TIMEUTC_INVALID www.yoctopuce.com...
  • Page 692 ) java async Task<int> get_usage( ) get_usage( ) function get_usage( ) async get_usage( ) YDataLogger target get_usage Retourne : un entier représentant le pourcentage d'utilisation de la mémoire d'enregistrement En cas d'erreur, déclenche une exception ou retourne Y_USAGE_INVALID www.yoctopuce.com...
  • Page 693 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 694 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 695 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 696 ) 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 697 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 698 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 699 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 700 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la 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 701 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. DataLogger.findDataLogger() Retourne : un pointeur sur un objet YDataLogger accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 702 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 703 , 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 704 Paramètres : newval Y_BEACONDRIVEN_OFF Y_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 705 ê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 706: Paramètres

    Y_RECORDING_PENDING représentant l'état d'activation de l'enregistreur de données Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 707 Paramètres : un entier représentant la référence de temps UTC, afin de l'attacher aux données enregistrées newval Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 708 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 709 Cette fonction annule un précédent appel à muteValueCallbacks() . 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 710 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 711: 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 YoctoProxyAPI.YDataSetProxy import com.yoctopuce.YoctoAPI.YDataSet; java import com.yoctopuce.YoctoAPI.YDataSet; from yocto_module import * require_once('yocto_module.php'); in HTML: <script src="../../lib/yocto_module.js"></script> in node.js: require('yoctolib-es2017/yocto_module.js'); Fonction globales YDataSet.Init(sensorName, startTime, endTime)
  • Page 712 Retourne l'heure absolue de l'entrée spécifiée du résumé des mesures, sous forme du nombre de secondes depuis le 1er janvier 1970 UTC (date/heure au format Unix). dataset→get_preview() Retourne une version résumée des mesures qui pourront être obtenues de ce YDataSet , sous forme d'une YMeasure liste d'objets dataset→get_previewAvgAt(index) www.yoctopuce.com...
  • Page 713 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 714 à 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 715 22. Référence de l'API de haut niveau YDataSet dataset→FunctionId Identifiant matériel de la fonction qui a effectué les mesures, sans référence au module. string FunctionId Par example temperature1 www.yoctopuce.com...
  • Page 716 22. Référence de l'API de haut niveau YDataSet dataset→HardwareId Identifiant matériel unique de la fonction qui a effectué les mesures, 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 THRMCPL1-123456.temperature1 www.yoctopuce.com...
  • Page 717 Nombre de mesures déja chargées pour ce DataSet int MeasuresRecordCount 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. www.yoctopuce.com...
  • Page 718 22. Référence de l'API de haut niveau YDataSet dataset→PreviewRecordCount Nombre d'entrées dans la version résumée des mesures qui pourront être obtenues dans ce YDataSet int PreviewRecordCount www.yoctopuce.com...
  • Page 719 état d'avancement du chargement des données, sur une échelle de 0 à 100. int Progress A l'instanciation de l'objet par la fonction , l'avancement est nul. Au fur et à mesure get_dataSet() des appels à , l'avancement progresse pour atteindre la valeur 100 lorsque toutes les loadMore() mesures ont été chargées. www.yoctopuce.com...
  • Page 720 22. Référence de l'API de haut niveau YDataSet dataset→SummaryAvg Valeur moyenne observée durant l'intervalle de temps couvert par ce DataSet double SummaryAvg www.yoctopuce.com...
  • Page 721 Heure de fin de la dernière mesure du data set, sous forme du nombre de secondes depuis le 1er janvier 1970 UTC (date/heure au format Unix). double SummaryEndTime 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. www.yoctopuce.com...
  • Page 722 22. Référence de l'API de haut niveau YDataSet dataset→SummaryMax Plus grande valeur observée durant l'intervalle de temps couvert par ce DataSet double SummaryMax www.yoctopuce.com...
  • Page 723 22. Référence de l'API de haut niveau YDataSet dataset→SummaryMin Plus petite valeur observée durant l'intervalle de temps couvert par ce DataSet double SummaryMin www.yoctopuce.com...
  • Page 724 Heure absolue de la première mesure du data set, sous forme du nombre de secondes depuis le 1er janvier 1970 UTC (date/heure au format Unix). double SummaryStartTime 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. www.yoctopuce.com...
  • Page 725 22. Référence de l'API de haut niveau YDataSet dataset→Unit Unité dans laquelle la valeur mesurée est exprimée. string Unit www.yoctopuce.com...
  • Page 726 OBSOLÈTE: cette methode a été remplacé par qui retoure des informations plus get_summary() précises. Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la dernière mesure. www.yoctopuce.com...
  • Page 727 ) As String string get_functionId( ) string get_functionId( ) String get_functionId( ) java async Task<string> get_functionId( ) get_functionId( ) function get_functionId( ) async get_functionId( ) Par example temperature1 Retourne : temperature1 une chaîne de caractères identifiant la fonction (ex: www.yoctopuce.com...
  • Page 728 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example THRMCPL1-123456.temperature1 Retourne : une chaîne de caractères identifiant la fonction (ex: THRMCPL1-123456.temperature1 En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 729 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 730 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 731 Retourne la valeur moyenne observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. double get_measuresAvgAt( int index) Paramètres : index un entier dans la plage [ MeasuresRecordCount -1]. Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 732 Paramètres : index un entier dans la plage [ MeasuresRecordCount -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 733 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. double get_measuresMaxAt( int index) Paramètres : index un entier dans la plage [ MeasuresRecordCount -1]. Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 734 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. double get_measuresMinAt( int index) Paramètres : index un entier dans la plage [ MeasuresRecordCount -1]. Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 735 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 736 Paramètres : index un entier dans la plage [ MeasuresRecordCount -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 737 Le résumé des mesures est disponible dès que a été appelé pour la première fois. loadMore() Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps. En cas d'erreur, déclenche une exception ou retourne un tableau vide. www.yoctopuce.com...
  • Page 738 Retourne la valeur moyenne observée durant l'intervalle de temps couvert par l'entrée spécifiée du résumé des mesures. double get_previewAvgAt( int index) Paramètres : index un entier dans la plage [ PreviewRecordCount -1]. Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 739 Paramètres : index un entier dans la plage [ PreviewRecordCount -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 740 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. double get_previewMaxAt( int index) Paramètres : index un entier dans la plage [ PreviewRecordCount -1]. Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 741 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. double get_previewMinAt( int index) Paramètres : index un entier dans la plage [ PreviewRecordCount -1]. Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 742 22. 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 int get_previewRecordCount( ) Retourne : un nombre entier correspondant au nombre d'entrées dans le résumé. www.yoctopuce.com...
  • Page 743 Paramètres : index un entier dans la plage [ PreviewRecordCount -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 744 , l'avancement est nul. Au fur et à mesure des appels à , l'avancement progresse pour atteindre la valeur 100 lorsque toutes les loadMore() mesures ont été chargées. Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées. www.yoctopuce.com...
  • Page 745 à 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 746 - la valeur minimale observée dans l'intervalle de temps - la valeur moyenne observée dans l'intervalle de temps - la valeur maximale observée dans l'intervalle de temps Ce résumé des mesures est disponible dès que a été appelé pour la première fois. loadMore() Retourne : YMeasure un objet www.yoctopuce.com...
  • Page 747 22. 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 double get_summaryAvg( ) Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 748 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 749 22. 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 double get_summaryMax( ) Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 750 22. 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 double get_summaryMin( ) Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 751 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 752 ) string get_unit( ) String get_unit( ) java async Task<string> get_unit( ) get_unit( ) function get_unit( ) async get_unit( ) Retourne : une chaîne de caractères représentant une unité physique. En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID www.yoctopuce.com...
  • Page 753 ) 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 754 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 755: 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 756 -(double) averageValue double get_averageValue( ): double function get_averageValue( ) As Double double get_averageValue( ) double get_averageValue( ) java double get_averageValue( ) get_averageValue( ) function get_averageValue( ) get_averageValue( ) Retourne : un nombre décimal correspondant à la valeur moyenne observée. www.yoctopuce.com...
  • Page 757 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 758 -(double) maxValue double get_maxValue( ): double function get_maxValue( ) As Double double get_maxValue( ) double get_maxValue( ) java double get_maxValue( ) get_maxValue( ) function get_maxValue( ) get_maxValue( ) Retourne : un nombre décimal correspondant à la plus grande valeur observée. www.yoctopuce.com...
  • Page 759 -(double) minValue double get_minValue( ): double function get_minValue( ) As Double double get_minValue( ) double get_minValue( ) java double get_minValue( ) get_minValue( ) function get_minValue( ) get_minValue( ) Retourne : un nombre décimal correspondant à la plus petite valeur observée. www.yoctopuce.com...
  • Page 760 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 761: Problèmes Courants

    23.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 23.2.

  • Page 762: Plateformes Arm: Hf Et El

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

    23. Problèmes courants 23.7. Déconnexions, comportement erratique Si votre Yocto-GPS-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 764 www.yoctopuce.com...

  • Page 765: Caractéristiques

    24. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module Yocto-GPS-V2 Identifiant produit YGNSSMK2 † Révision matérielle Connecteur USB micro-B Largeur 20 mm Longueur 60 mm Poids 20 g Canaux Chipset u-blox NEO-M8Q-01A Fréquence de rafraîchissement 10 Hz Précision...
  • Page 766 24. Caractéristiques www.yoctopuce.com...

Table des Matières