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

Yoctopuce YoctoHub-GSM-2G Mode D'emploi

Masquer les pouces
1
2
Table Des Matières
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
Table des Matières

Publicité

Liens rapides

Télécharger ce manuel
YoctoHub-GSM-2G
Mode d'emploi

Publicité

Table des Matières
loading

Manuels Connexes pour Yoctopuce YoctoHub-GSM-2G

Sommaire des Matières pour Yoctopuce YoctoHub-GSM-2G

  • Page 1 YoctoHub-GSM-2G Mode d'emploi...

  • Page 3: Table Des Matières

    Table des matières 1. Introduction ..........................1.1. Accessoires optionnels ...................... 2. Présentation ..........................2.1. Les éléments du YoctoHub-GSM-2G ................. 3. Premiers pas ..........................3.1. Configuration manuelle ....................... 3.2. Fenêtre d'état du hub ......................3.3. Configuration automatisée ....................3.4. Connexions ........................
  • Page 4 9.7. Déconnexions, comportement erratique ............... 9.8. RegisterHub d'un VirtualHub déconnecte le précédent ..........9.9. Commandes ignorées ..................... 9.10. Impossible de contacter les sous-devices par USB ........... 9.11. Network Readiness coincé à ..................9.12. Module endommagé ...................... 10. Caractéristiques ......................www.yoctopuce.com...

  • Page 5: Introduction

    Les ingénieurs Yoctopuce se sont donnés beaucoup de mal pour que votre YoctoHub-GSM-2G soit facile à installer n'importe où et soit facile utiliser en toutes circonstances. Néanmoins, si ce module venait à vous décevoir, n'hésitez pas à contacter le support Yoctopuce Pour une liste détaillée des bandes de fréquence supportées par pays, consultez la page Wikipedia...

  • Page 6: Accessoires Optionnels

    GSM-2G. Vis et entretoises Pour fixer le module YoctoHub-GSM-2G à un support, vous pouvez placer des petites vis de 3mm avec une tête de 8mm au maximum dans les trous prévus ad-hoc. Il est conseillé de les visser dans des entretoises filetées, que vous pourrez fixer sur le support. Vous trouverez plus de détail à ce sujet dans le chapitre concernant le montage et la connectique.
  • Page 7 1. Introduction Yoctopuce. Vous trouverez plus d'informations à propos de ces boîtiers sur le site de Yoctopuce. Le boîtier recommandé pour votre YoctoHub-GSM-2G est le modèle YoctoBox-HubWlan-Transp. Votre YoctoHub-GSM-2G peut être installé dans un boitier. www.yoctopuce.com...
  • Page 8 www.yoctopuce.com...

  • Page 9: Présentation

    8: Support pour carte SIM (dessous) 17: Indicateur port descendant 3 9: Connecteur d'antenne 2.1. Les éléments du YoctoHub-GSM-2G Le numéro de série Chaque Yocto-module a un numéro de série unique attribué en usine, pour les modules YoctoHub- GSM-2G ce numéro commence par YHUBGSM1. Le module peut être piloté par logiciel en utilisant ce numéro de série.
  • Page 10 être ressoudé à l'aide d'un bon fer et de flux. Alternativement, vous pouvez court-court-court long-long-long court-court-court support@yoctopuce.com Le Micro-USB-Hub fabriqué par Yoctopuce est un hub USB standard et ne fonctionnera pas avec le YoctoHub-GSM-2G. www.yoctopuce.com/FR/products/yoctohub-shield www.yoctopuce.com...
  • Page 11 SIM, ces adaptateur peuvent être achetés dans n'importe quel magasin de téléphone portable. avec le YoctoHub-GSM-2G. Le support SIM est de type push-push: pressez pour insérer la SIM jusqu'à- ce qu'elle soit en position et produise un petit clic. Re-pressez une deuxième fois éjecter la SIM de son support.
  • Page 12 Mise en sommeil En moyenne, le YoctoHub-GSM-2G consomme environ 0,5 Watt (100mA), auquel il faut ajouter la consommation des modules qui lui sont connectés. Mais il est capable de se mettre en sommeil pour réduire sa consommation d'énergie au strict minimum, et de se réveiller à...

  • Page 13: Premiers Pas

    3. Premiers pas Ce chapitre a pour but de vous aider à connecter et configurer votre YoctoHub-GSM-2G pour la première fois 3.1. Configuration manuelle Vous pouvez configurer votre YoctoHub-GSM-2G via son port de contrôle USB, en utilisant le VirtualHub Lancez un VirtualHub sur votre ordinateur favori et raccordez votre ordinateur au port power / control port du YoctoHub-GSM-2G.
  • Page 14 Fenêtre de configuration du module YoctoHub-GSM-2G Connexion au réseau cellulaire GSM La première chose à faire consiste à configurer votre YoctoHub-GSM-2G pour qu'il se connecte à votre réseau GSM. Pour cela cliquez sur le bouton edit correspondant à GSM configuration dans la section Network configuration, et la fenêtre de configuration du réseau cellulaire GSM apparaît:...
  • Page 15 Vous pouvez aussi spécifier dans votre YoctoHub-GSM-2G le contexte quel cas vous désirez activer la connection IP (transfert de données). Vous pouvez soit la désactiver complètement si vous n'êtes intéressé...

  • Page 16: Fenêtre D'état Du Hub

    Internet, mais Internet ne dispose pas d'adresse publique pour le contacter. Ceci signifie que vous ne pourrez pas vous connecter à distance sur votre YoctoHub-GSM-2G depuis n'importe quel ordinateur, juste en tapant son adresse IP dans un navigateur internet.
  • Page 17 Si cet état persiste, vérifiez que votre SIM est valable et que l'opérateur cellulaire choisi correspond. • 2- network linked: le YoctoHub-GSM-2G a pu se connecter au réseau GSM, mais n'a pas encore établi de connection IP. Si cet état persiste, vérifiez vos réglages APN.

  • Page 18: Configuration Automatisée

    Le YoctoHub-GSM-2G peut être alimenté par un chargeur USB Sous-modules Le YoctoHub-GSM-2G est capable de piloter tous les modules Yoctopuce de la gamme Yocto. Ces modules peuvent êtres connectés directement aux ports descendants, ils seront détectés automatiquement. Vous aurez besoin pour cela de câbles USB MicroB-MicroB. Vous pouvez utiliser des câbles OTG ou non, cela n'a pas d'importance.
  • Page 19 Alternativement, vous pouvez connecter vos modules de manière plus compacte à l'aide de câbles au pas 1.27mm: tous les modules Yoctopuce disposent en effet de contacts à cet effet. Vous pouvez soit souder des connecteurs 1.27mm sur les modules et utiliser des câbles avec connecteurs 1.27mm, soit souder directement du câble plat au pas 1.27mm.
  • Page 20 Attention, le YoctoHub-GSM-2G est conçu pour piloter des modules Yoctopuce uniquement. En effet le protocole utilisé entre le YoctoHub-GSM-2G et les sous-modules n'est pas de l'USB mais un protocole propriétaire, beaucoup plus léger. Si d'aventure vous branchez un périphérique autre qu'un module Yoctopuce sur un des ports descendants du YoctoHub-GSM-2G, le port en question sera automatiquement désactivé...

  • Page 21: Montage

    Exemples de montage sur un support. Le module YoctoHub-GSM-2G dispose de trous de montage 3mm. 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 8mm, sous peine d'endommager les circuits du module.

  • Page 22: Fixation D'un Sous-Module

    Prenez garde à bien monter le module sur la face prévue, comme illustré ci-dessus. Les 5 trous du module doivent correspondre aux 5 trous du YoctoHub-GSM-2G, et le contact carré sur sur le module doit être connecté au contact carré sur le port descendant du YoctoHub-GSM-2G. Si vous montez un module sur l'autre face ou d'une autre manière, la polarité...

  • Page 23: Interactions Avec L'extérieur

    5. Interactions avec l'extérieur Le YoctoHub-GSM-2G est capable de poster sur le site web de votre choix l'état des modules qu'il voit. Les valeurs sont postées à intervalles réguliers et à chaque fois qu'une valeur change de manière significative. Cette fonctionnalité, appelée Callback HTTP, vous permettra d'interfacer vos modules Yoctopuce avec divers services web.

  • Page 24: Emoncms

    La fenêtre de configuration des callbacks HTTP apparaît. Cette fenêtre va vous permettre de définir comment votre YoctoHub-GSM-2G va interagir avec un serveur Web externe. Vous avez plusieurs type d'interactions a votre disposition. Pour chaque type, un wizard vous guidera pour fournir les paramètres adéquats.

  • Page 25: Valarm.net

    Vous pouvez facilement l'installer sur Windows pour enregistrer les mesures et obtenir des graphiques de vos capteurs. Pour plus de détails, voir fr.paessler.com/prtg. Vous trouverez un guide pas-à-pas pour configurer PRTG avec les modules Yoctopuce sur le blog de Yoctopuce Yoctopuce n'est en aucune manière affilié...

  • Page 26: User Defined Callback

    Les "User defined callback" vous permettent de personnaliser la manière dont votre YoctoHub- GSM-2G va interagir avec un site Web externe. Vous avez besoin de définir l'URL du serveur Web sur lequel le YoctoHub-GSM-2G va poster l'état de ses devices. Notez que seul le protocole HTTP est supporté (pas de HTTPS).
  • Page 27 5. Interactions avec l'extérieur Tests Afin de vous permettre de déboguer le processus, le YoctoHub-GSM-2G vous permet de visualiser la réponse au callback envoyé par le serveur Web. Cliquez simplement sur le bouton test une fois que vous avez renseigné tous les champs. Si le résultat vous paraît satisfaisant, fermez la fenêtre de debug, et cliquez sur Ok.
  • Page 28 www.yoctopuce.com...

  • Page 29: Programmation

    // l'adresse IP du hub est 192.168.0.10 6.2. Contrôle du YoctoHub-GSM-2G Du point de vue API de programmation, le YoctoHub-GSM-2G est un module comme les autres. Il est parfaitement contrôlable depuis l'API Yoctopuce. Pour ce faire, vous aurez besoin des classes suivantes.
  • Page 30 Files Cette classe permet d'accéder aux fichiers stockées dans la mémoire flash du YoctoHub-GSM-2G. Le YoctoHub-GSM-2G dispose en effet d'un petit système de fichiers qui vous permet de stocker par exemple une Web App contrôlant les modules connectés au YoctoHub-GSM-2G.

  • Page 31: Mise En Sommeil

    7. Mise en sommeil Le YoctoHub-GSM-2G dispose d'une horloge en temp réel (RTC) alimentée par un super condensateur, qui se recharge automatiquement lorsque le module est sous tension mais permet de maintenir l'heure sans aucune alimentation pendant plusieurs jours. Ce RTC est utilisé pour piloter un système de mise en sommeil afin d'économiser l'énergie.

  • Page 32: Paramétrage Du Système De Réveil Par Logiciel

    à l'heure 2 etc. Chaque case se voit affecter une puissante de deux Ainsi pour programmer le YoctoHub-GSM-2G pour qu'il se réveille tout les jours a midi, il mettre le bit 12 à 1, ce qui correspond à la valeur 2^12 = 4096.
  • Page 33 éveillé après un réveil. Si cette variable est mise à zéro, le module restera éveillé. Le YoctoHub-GSM-2G dispose de deux fonctions wakeUpSchedule ce qui permet de programmer jusqu'a deux types de réveils indépendants.
  • Page 34 www.yoctopuce.com...

  • Page 35: Référence De L'api De Haut Niveau

    8. Référence de l'API de haut niveau Ce chapitre résume les fonctions de l'API de haut niveau pour commander votre YoctoHub-GSM-2G. La syntaxe et les types précis peuvent varier d'un langage à l'autre mais, sauf avis contraire toutes sont disponibles dans chaque language. Pour une information plus précise sur les types des arguments et des valeurs de retour dans un langage donné, veuillez vous référer au fichier de...

  • Page 36: La Classe Yhubport

    YHubPort permet de détecter si un module y est raccordé et lequel. Un YHubPort reçoit toujours automatiquement comme nom logique le numéro de série unique du module Yoctopuce qui y est connecté. Pour utiliser les fonctions décrites ici, vous devez inclure: in HTML: <script src="../../lib/yocto_hubport.js"></script>...
  • Page 37 Retourne l'identifiant matériel unique du port de YoctoHub au format SERIAL.FUNCTIONID hubport→get_logicalName() Retourne le nom logique du port de YoctoHub. hubport→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. hubport→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. hubport→get_portState() www.yoctopuce.com...
  • Page 38 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 hubport→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. hubport→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 39 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le port de YoctoHub sans ambiguïté, par exemple YHUBETH1.hubPort1 Retourne : YHubPort un objet de classe qui permet ensuite de contrôler le port de YoctoHub. www.yoctopuce.com...
  • Page 40 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le port de YoctoHub sans ambiguïté, par exemple YHUBETH1.hubPort1 Retourne : YHubPort un objet de classe qui permet ensuite de contrôler le port de YoctoHub. www.yoctopuce.com...
  • Page 41 YoctoHub. YHubPort.nextHubPort() Retourne : un pointeur sur un objet YHubPort , correspondant au premier port de YoctoHub accessible en ligne, ou null si il n'y a pas de ports de YoctoHub disponibles. www.yoctopuce.com...
  • Page 42 YoctoHub. YHubPort.nextHubPort() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YHubPort , correspondant au premier port de YoctoHub accessible en ligne, ou null si il n'y a pas de ports de YoctoHub disponibles. www.yoctopuce.com...
  • Page 43 Chaque chaîne retournée peut être passée en argument à la méthode YHubPort.FindHubPort 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 44 8. Référence de l'API de haut niveau YHubPort hubport→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 45 8. Référence de l'API de haut niveau YHubPort hubport→Enabled Vrai si le port du YoctoHub est alimenté, faux sinon. int Enabled Modifiable. Modifie le mode d'activation du port du YoctoHub. Si le port est actif, il sera alimenté. Sinon, l'alimentation du module est coupée. www.yoctopuce.com...
  • Page 46 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 47 8. Référence de l'API de haut niveau YHubPort hubport→FunctionId Identifiant matériel du port de YoctoHub, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 48 8. Référence de l'API de haut niveau YHubPort hubport→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 49 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 50 8. Référence de l'API de haut niveau YHubPort hubport→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 51 8. Référence de l'API de haut niveau YHubPort hubport→PortState état actuel du port de YoctoHub. int PortState www.yoctopuce.com...
  • Page 52 8. Référence de l'API de haut niveau YHubPort hubport→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 53 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du port de YoctoHub. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 54 î n e c a r a c t è r e s d é c r i v a n t p o r t Y o c t o H u b ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 55 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YHubPort.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 56 La valeur par défaut est 1000 kbps, une valeur inférieure révèle des problèmes de communication. Retourne : un entier représentant la vitesse de transfert utilisée par le port de YoctoHub, en kbps En cas d'erreur, déclenche une exception ou retourne YHubPort.BAUDRATE_INVALID www.yoctopuce.com...
  • Page 57 ) int get_enabled( ) int get_enabled( ) YHubPort target get_enabled Retourne : YHubPort.ENABLED_FALSE YHubPort.ENABLED_TRUE soit , soit , selon vrai si le port du YoctoHub est alimenté, faux sinon En cas d'erreur, déclenche une exception ou retourne YHubPort.ENABLED_INVALID www.yoctopuce.com...
  • Page 58 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du port de YoctoHub.
  • Page 59 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du port de YoctoHub.
  • Page 60 YoctoHub (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le port de YoctoHub en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YHubPort.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 61 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 62 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le port de YoctoHub (ex: En cas d'erreur, déclenche une exception ou retourne YHubPort.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 63 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du port de YoctoHub (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le port de YoctoHub (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YHubPort.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 64 ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YHubPort target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du port de YoctoHub. En cas d'erreur, déclenche une exception ou retourne YHubPort.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 65 8. Référence de l'API de haut niveau YHubPort hubport→get_module() hubport→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 66 8. Référence de l'API de haut niveau YHubPort hubport→get_module_async() hubport→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 67 é s e n t a n t l ' é t a t a c t u e l d u p o r t d e Y o c t o H u b En cas d'erreur, déclenche une exception ou retourne YHubPort.PORTSTATE_INVALID www.yoctopuce.com...
  • Page 68 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YHubPort target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 69 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 70 Si les valeurs des attributs en cache du port de YoctoHub sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le port de YoctoHub est joignable, sinon www.yoctopuce.com...
  • Page 71 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 72 ) YHubPort 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 73 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 74 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 75 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 76 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 77 ): YHubPort | null nextHubPort( ) Si vous souhaitez retrouver un port de YoctoHub spécifique, utilisez HubPort.findHubPort() avec un hardwareID ou un nom logique. Retourne : YHubPort null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 78 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 79 Si le port est actif, il sera alimenté. Sinon, l'alimentation du module est coupée. Paramètres : newval soit YHubPort.ENABLED_FALSE , soit YHubPort.ENABLED_TRUE , selon le mode d'activation du port du YoctoHub Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 80 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du port de YoctoHub. 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 81 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 82 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 83 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 84: La Classe Ycellular

    La classe permet de configurer et de contrôler la configuration du réseau cellulaire sur les YCellular modules Yoctopuce qui en sont dotés. Notez que les paramètres TCP/IP sont configurés séparément, à l'aide de la classe YNetwork Pour utiliser les fonctions décrites ici, vous devez inclure: <script type='text/javascript' src='yocto_cellular.js'></script>...
  • Page 85 Retourne vrai si le mode avion est activé (radio désactivée). cellular→get_apn() Retourne le nom du point d'accès (APN) à utiliser, si nécessaire. cellular→get_apnSecret() Retourne une string opaque si des paramètres d'identification sur l'APN ont été configurés dans le module, ou une chaîne vide autrement. www.yoctopuce.com...
  • Page 86 Retourne le nom logique de l'interface cellulaire. cellular→get_message() Retourne le dernier message de diagnostique de l'interface au réseau sans fil. cellular→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. cellular→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. cellular→get_pin() Retourne une string opaque si un code PIN a été...
  • Page 87 Configure les paramètres d'identification pour se connecter à l'APN. cellular→set_dataReceived(newval) Modifie la valeur du compteur d'octets reçus. cellular→set_dataSent(newval) Modifie la valeur du compteur d'octets envoyés. cellular→set_enableData(newval) Modifie la condition dans laquelle le service de données IP (GRPS) doit être activé. cellular→set_lockedOperator(newval) www.yoctopuce.com...
  • Page 88 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 cellular→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. cellular→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 89 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'interface cellulaire sans ambiguïté, par exemple YHUBGSM1.cellular Retourne : YCellular un objet de classe qui permet ensuite de contrôler l'interface cellulaire. www.yoctopuce.com...
  • Page 90 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'interface cellulaire sans ambiguïté, par exemple YHUBGSM1.cellular Retourne : YCellular un objet de classe qui permet ensuite de contrôler l'interface cellulaire. www.yoctopuce.com...
  • Page 91 Utiliser la fonction pour itérer sur les autres interfaces réseau YCellular.nextCellular() cellulaire. Retourne : un pointeur sur un objet YCellular , correspondant à la première interface cellulaire accessible en ligne, null si il n'y a pas de interfaces réseau cellulaire disponibles. www.yoctopuce.com...
  • Page 92 YCellular.nextCellular() cellulaire. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YCellular , correspondant à la première interface cellulaire accessible en ligne, null si il n'y a pas de interfaces réseau cellulaire disponibles. www.yoctopuce.com...
  • Page 93 Chaque chaîne retournée peut être passée en argument à la méthode YCellular.FindCellular 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 94 8. Référence de l'API de haut niveau YCellular cellular→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 95 Lorsque l'APN est vide, celui proposé par l'opérateur cellulaire est utilisée. Modifiable. Retourne le nom du point d'accès (APN) à utiliser, si nécessaire. Lorsque l'APN est vide, celui proposé par l'opérateur cellulaire est utilisée. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 96 8. Référence de l'API de haut niveau YCellular cellular→CellOperator Nom de l'opérateur de réseau cellulaire actuellement utilisé. string CellOperator www.yoctopuce.com...
  • Page 97 Attention, l'utilisation de données en roaming peut conduire à des coûts de télécommunication exhorbitants ! Lorsque le service de donnée n'est pas actif, seules les communications par SMS sont possibles. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 98 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 99 8. Référence de l'API de haut niveau YCellular cellular→FunctionId Identifiant matériel de l'interface cellulaire, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 100 8. Référence de l'API de haut niveau YCellular cellular→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 101 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 102 8. Référence de l'API de haut niveau YCellular cellular→LinkQuality Qualité de la connection, exprimée en pourcents. int LinkQuality www.yoctopuce.com...
  • Page 103 Modifiable. Modifie le nom de l'opérateur de réseau cellulaire à utiliser. Si le nom est une chaîne vide, le choix sera fait automatiquement selon la carte SIM. Sinon, seul l'opérateur choisi sera utilisé. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 104 8. Référence de l'API de haut niveau YCellular cellular→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 105 "Enter SIM PUK" et il faut alors entrer le code PUK de la carte SIM avec la méthode sendPUK N'oubliez pas d'appeler la méthode du module pour que le paramètre soit saveToFlash() sauvegardé dans la flash. www.yoctopuce.com...
  • Page 106 8. Référence de l'API de haut niveau YCellular cellular→PingInterval Intervalle entre les tests de connectivité spontanés, en secondes. int PingInterval Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 107 Le suffixe "/[wait]ms" peut être ajouté pour réduire la cadence d'émission de sorte à ce qu'il y ait au minimum le nombre spécifié de millisecondes d'intervalle entre l'envoi de chaque byte. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 108 8. Référence de l'API de haut niveau YCellular cellular→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 109 état. N'utilisez cette fonction qu'avec la plus grande prudence ! Paramètres : la commande AT à exécuter, comme par exemple: "+CCLK?" Retourne : une chaîne de caractères contenant le résultat de la commande. Les lignes vides sont automatiquement filtrées du résultat. www.yoctopuce.com...
  • Page 110 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'interface cellulaire. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 111 ) async clearDataCounters( ): Promise<number> async clearDataCounters( ) int clearDataCounters( ) int clearDataCounters( ) YCellular target clearDataCounters Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 112 YCellular target decodePLMN mccmnc Paramètres : mccmnc une chaîne de caractères commençant par un code MCC, suivi par un code MNC. Retourne : une chaîne contenant le nom usuel de l'opérateur correspondant. www.yoctopuce.com...
  • Page 113 è r e s d é c r i v a n t l ' i n t e r f a c e c e l l u l a i r e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 114 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YCellular.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 115 ) int get_airplaneMode( ) int get_airplaneMode( ) YCellular target get_airplaneMode Retourne : YCellular.AIRPLANEMODE_OFF YCellular.AIRPLANEMODE_ON soit , soit , selon vrai si le mode avion est activé (radio désactivée) En cas d'erreur, déclenche une exception ou retourne YCellular.AIRPLANEMODE_INVALID www.yoctopuce.com...
  • Page 116 Lorsque l'APN est vide, celui proposé par l'opérateur cellulaire est utilisée. Retourne : une chaîne de caractères représentant le nom du point d'accès (APN) à utiliser, si nécessaire En cas d'erreur, déclenche une exception ou retourne YCellular.APN_INVALID www.yoctopuce.com...
  • Page 117 Pour configurer ces paramètres, utilisez la méthode set_apnAuth() Retourne : une chaîne de caractères représentant une string opaque si des paramètres d'identification sur l'APN ont été configurés dans le module, ou une chaîne vide autrement En cas d'erreur, déclenche une exception ou retourne YCellular.APNSECRET_INVALID www.yoctopuce.com...
  • Page 118 Cette fonction peut typiquement prendre 30 secondes à une minute pour rendre la main. Notez qu'en général une SIM ne permet de se connecter qu'à certains opérateur, et donc pas forcément à tous ceux listés par cette fonction. Retourne : une liste de noms d'opérateur. www.yoctopuce.com...
  • Page 119 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YCellular.CELLIDENTIFIER_INVALID www.yoctopuce.com...
  • Page 120 ): Promise<string> async get_cellOperator( ) string get_cellOperator( ) string get_cellOperator( ) YCellular target get_cellOperator Retourne : une chaîne de caractères représentant le nom de l'opérateur de réseau cellulaire actuellement utilisé En cas d'erreur, déclenche une exception ou retourne YCellular.CELLOPERATOR_INVALID www.yoctopuce.com...
  • Page 121 Y C e l l u l a r . C E L L T Y P E _ L T E _ M Y C e l l u l a r . C E L L T Y P E _ N B _ I O T YCellular.CELLTYPE_EC_GSM_IOT En cas d'erreur, déclenche une exception ou retourne YCellular.CELLTYPE_INVALID www.yoctopuce.com...
  • Page 122 ) async get_dataReceived( ): Promise<number> async get_dataReceived( ) int get_dataReceived( ) int get_dataReceived( ) YCellular target get_dataReceived Retourne : un entier représentant le nombre d'octets reçus jusqu'à présent En cas d'erreur, déclenche une exception ou retourne YCellular.DATARECEIVED_INVALID www.yoctopuce.com...
  • Page 123 ) async get_dataSent( ): Promise<number> async get_dataSent( ) int get_dataSent( ) int get_dataSent( ) YCellular target get_dataSent Retourne : un entier représentant le nombre d'octets envoyés jusqu'à présent En cas d'erreur, déclenche une exception ou retourne YCellular.DATASENT_INVALID www.yoctopuce.com...
  • Page 124 YCellular.ENABLEDATA_ROAMING YCellular.ENABLEDATA_NEVER YCellular.ENABLEDATA_NEUTRALITY représentant la condition dans laquelle le service de données IP (GRPS) doit être activé En cas d'erreur, déclenche une exception ou retourne YCellular.ENABLEDATA_INVALID www.yoctopuce.com...
  • Page 125 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'interface cellulaire.
  • Page 126 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'interface cellulaire.
  • Page 127 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'interface cellulaire en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YCellular.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 128 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 129 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'interface cellulaire (ex: En cas d'erreur, déclenche une exception ou retourne YCellular.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 130 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'interface cellulaire (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'interface cellulaire (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YCellular.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 131 SIM, sur 2 ou 3 chiffres selon la zone géographique. Retourne : une chaîne de caractères représentant le "International Mobile Subscriber Identity" (MSI) qui identifie de manière unique la carte SIM En cas d'erreur, déclenche une exception ou retourne YCellular.IMSI_INVALID www.yoctopuce.com...
  • Page 132 ) async get_linkQuality( ): Promise<number> async get_linkQuality( ) int get_linkQuality( ) int get_linkQuality( ) YCellular target get_linkQuality Retourne : un entier représentant la qualité de la connection, exprimée en pourcents En cas d'erreur, déclenche une exception ou retourne YCellular.LINKQUALITY_INVALID www.yoctopuce.com...
  • Page 133 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YCellular.LOCKEDOPERATOR_INVALID www.yoctopuce.com...
  • Page 134 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YCellular target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'interface cellulaire. En cas d'erreur, déclenche une exception ou retourne YCellular.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 135 ) string get_message( ) string get_message( ) YCellular target get_message Retourne : une chaîne de caractères représentant le dernier message de diagnostique de l'interface au réseau sans fil En cas d'erreur, déclenche une exception ou retourne YCellular.MESSAGE_INVALID www.yoctopuce.com...
  • Page 136 8. Référence de l'API de haut niveau YCellular cellular→get_module() cellular→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 137 8. Référence de l'API de haut niveau YCellular cellular→get_module_async() cellular→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 138 PIN a été configuré dans le module pour accéder à la carte SIM, ou une chaîne vide il n'a pas été configuré ou si la SIM a rejeté le code indiqué En cas d'erreur, déclenche une exception ou retourne YCellular.PIN_INVALID www.yoctopuce.com...
  • Page 139 ): Promise<number> async get_pingInterval( ) int get_pingInterval( ) int get_pingInterval( ) YCellular target get_pingInterval Retourne : un entier représentant l'intervalle entre les tests de connectivité spontanés, en secondes En cas d'erreur, déclenche une exception ou retourne YCellular.PINGINTERVAL_INVALID www.yoctopuce.com...
  • Page 140 ASCII continu ou "Byte" pour un flux binaire continue. Retourne : une chaîne de caractères représentant le type de protocole utilisé sur la communication série, sous forme d'une chaîne de caractères En cas d'erreur, déclenche une exception ou retourne YCellular.RADIOCONFIG_INVALID www.yoctopuce.com...
  • Page 141 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YCellular target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 142 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 143 Si les valeurs des attributs en cache de l'interface cellulaire 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'interface cellulaire est joignable, sinon www.yoctopuce.com...
  • Page 144 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 145 ) YCellular 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 146 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 147 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 148 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 149 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 150 ): YCellular | null nextCellular( ) Si vous souhaitez retrouver une interface cellulaire spécifique, utilisez Cellular.findCellular() avec un hardwareID ou un nom logique. Retourne : YCellular null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 151 ): Promise<YCellRecord[] async quickCellSurvey( ) YCellRecordProxy[] quickCellSurvey( ) vector<YCellRecordProxy> quickCellSurvey( ) YCellular target quickCellSurvey La première antenne listée est la cellule active, et les suivantes sont les cellules voisines listée par la cellule active. Retourne : une liste de YCellRecord www.yoctopuce.com...
  • Page 152 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 153 Paramètres : code PUK de la carte SIM newPin nouveau code PIN à configurer dans la carte SIM Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 154 Paramètres : newval soit YCellular.AIRPLANEMODE_OFF , soit YCellular.AIRPLANEMODE_ON , selon l'état du mode avion (radio désactivé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 155 Lorsque l'APN est vide, celui proposé par l'opérateur cellulaire est utilisée. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Paramètres : une chaîne de caractères newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 156 Les protocoles PAP et CHAP sont tous deux supportés. Paramètres : username nom d'utilisateur password mot de passe Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 157 YCellular target set_dataReceived newval Paramètres : newval un entier représentant la valeur du compteur d'octets reçus Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 158 YCellular target set_dataSent newval Paramètres : newval un entier représentant la valeur du compteur d'octets envoyés Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 159 Y C e l l u l a r . E N A B L E D A T A _ H O M E N E T W O R K YCellular.ENABLEDATA_ROAMING YCellular.ENABLEDATA_NEVER YCellular.ENABLEDATA_NEUTRALITY représentant la condition dans laquelle le service de données IP (GRPS) doit être activé Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 160 être préservé. Paramètres : une chaîne de caractères représentant le nom de l'opérateur de réseau cellulaire à utiliser 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 161 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'interface cellulaire. 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 162 PIN utilisé par le module pour accéder à la carte 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 163 être préservé. saveToFlash() Paramètres : un entier représentant l'intervalle entre les tests de connectivité spontanés, en secondes 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 164 être préservé. Paramètres : une chaîne de caractères représentant le type de protocol utilisé sur la communication série newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 165 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 166 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 167 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 168: La Classe Ynetwork

    Interface pour intéragir avec les interfaces réseau, disponibles par exemple dans le YoctoHub-Ethernet, le YoctoHub-GSM-3G-NA, le YoctoHub-GSM-4G et le YoctoHub-Wireless-n La classe permet de contrôler les paramètres TCP/IP des modules Yoctopuce dotés d'une YNetwork interface réseau. Pour utiliser les fonctions décrites ici, vous devez inclure: in HTML: <script src="../../lib/yocto_network.js"></script>...
  • Page 169 SERIAL.FUNCTIONID network→HttpPort [modifiable] Port TCP utilisé pour l'interface Web du hub. network→IpAddress [lecture seule] Adresse IP utilisée par le module Yoctopuce. network→IsOnline [lecture seule] Vérifie si le module hébergeant la fonction est joignable, sans déclencher d'erreur. network→LogicalName [modifiable] Nom logique de la fonction.
  • Page 170 Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau. network→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau. network→get_friendlyName() Retourne un identifiant global de l'interface réseau au format NOM_MODULE.NOM_FONCTION network→get_functionDescriptor() www.yoctopuce.com...
  • Page 171 Retourne l'identifiant matériel unique de l'interface réseau au format network→get_httpPort() Retourne le port TCP utilisé pour l'interface Web du hub. network→get_ipAddress() Retourne l'adresse IP utilisée par le module Yoctopuce. network→get_ipConfig() Retourne la configuration IP de l'interface réseau. network→get_logicalName() Retourne le nom logique de l'interface réseau.
  • Page 172 Modifie la page HTML par défaut du hub. network→set_discoverable(newval) Modifie l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour). network→set_httpPort(newval) Modifie le port TCP utilisé pour l'interface Web du hub. network→set_logicalName(newval) www.yoctopuce.com...
  • Page 173 Modifie la configuration de l'interface réseau pour utiliser une adresse IP assignée manuellement (adresse IP statique). network→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 174 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'interface réseau sans ambiguïté, par exemple YHUBETH1.network Retourne : YNetwork un objet de classe qui permet ensuite de contrôler l'interface réseau. www.yoctopuce.com...
  • Page 175 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'interface réseau sans ambiguïté, par exemple YHUBETH1.network Retourne : YNetwork un objet de classe qui permet ensuite de contrôler l'interface réseau. www.yoctopuce.com...
  • Page 176 Utiliser la fonction pour itérer sur les autres interfaces réseau. YNetwork.nextNetwork() Retourne : un pointeur sur un objet YNetwork , correspondant à la première interface réseau accessible en ligne, ou null si il n'y a pas de interfaces réseau disponibles. www.yoctopuce.com...
  • Page 177 YNetwork.nextNetwork() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YNetwork , correspondant à la première interface réseau accessible en ligne, ou null si il n'y a pas de interfaces réseau disponibles. www.yoctopuce.com...
  • Page 178 Chaque chaîne retournée peut être passée en argument à la méthode YNetwork.FindNetwork 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 179 Modifiable. Modifie le mot de passe pour l'utilisateur "admin", qui devient alors instantanément nécessaire pour toute altération de l'état du module. Si la valeur fournie est une chaîne vide, plus aucun mot de passe n'est nécessaire. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
  • Page 180 8. Référence de l'API de haut niveau YNetwork network→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 181 . Pour une autorisation de type Digest, le hash est le MD5 de la chaîne username:password . Pour une utilisation simplifiée, utilisez la fonction username:realm:password callbackLogin N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 182 8. Référence de l'API de haut niveau YNetwork network→CallbackEncoding Encodage à utiliser pour représenter les valeurs notifiées par callback. int CallbackEncoding Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 183 8. Référence de l'API de haut niveau YNetwork network→CallbackInitialDelay Attente initiale avant la première notification par callback, en secondes. int CallbackInitialDelay Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 184 Attente entre deux callback HTTP lorsque rien n'est à signaler, en secondes. int CallbackMaxDelay Modifiable. Modifie l'attente entre deux callback HTTP lorsque rien n'est à signaler. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 185 8. Référence de l'API de haut niveau YNetwork network→CallbackMethod Méthode HTTP à utiliser pour signaler les changements d'état par callback. int CallbackMethod Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 186 8. Référence de l'API de haut niveau YNetwork network→CallbackMinDelay Attente minimale entre deux callbacks HTTP, en secondes. int CallbackMinDelay Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 187 8. Référence de l'API de haut niveau YNetwork network→CallbackSchedule Planification des callbacks HTTP, sous forme de chaîne de caractères. string CallbackSchedule Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 188 8. Référence de l'API de haut niveau YNetwork network→CallbackUrl Adresse (URL) de callback à notifier lors de changement d'état significatifs. string CallbackUrl Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 189 Il est possible de changer cet page pour un fichier qui a été uploadé sur le hub. Attention, la taille maximale permise pour le nom de fichier est de 15 caractères. Si vous changez ce paramètre, n'oubliez pas d'appeler la méthode du module si le réglage doit être saveToFlash() préservé. www.yoctopuce.com...
  • Page 190 8. Référence de l'API de haut niveau YNetwork network→Discoverable état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour). int Discoverable Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 191 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 192 8. Référence de l'API de haut niveau YNetwork network→FunctionId Identifiant matériel de l'interface réseau, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 193 8. Référence de l'API de haut niveau YNetwork network→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 194 Modifiable. La valeur par défaut est le port 80, utilisé habituellement pat tous les serveurs web. Indépendamment de la valeur de ce paramètre, le hub répond toujours au port 4444, qui est utilisé par défaut par la librairie de programmation Yoctopuce. Si vous changez ce paramètre, n'oubliez pas d'appeler la méthode du module si le réglage doit être préservé.
  • Page 195 8. Référence de l'API de haut niveau YNetwork network→IpAddress Adresse IP utilisée par le module Yoctopuce. string IpAddress Il peut s'agir d'une adresse configurée statiquement, ou d'une adresse reçue par un serveur DHCP. www.yoctopuce.com...
  • Page 196 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 197 8. Référence de l'API de haut niveau YNetwork network→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 198 8. Référence de l'API de haut niveau YNetwork network→MacAddress Adresse MAC de l'interface réseau, unique pour chaque module. string MacAddress L'adresse MAC est aussi présente sur un autocollant sur le module, représentée en chiffres et en code- barres. www.yoctopuce.com...
  • Page 199 Modifiable. Modifie l'adresse IP du serveur NTP que le module doit utiliser. Utilisez une chaine vide pour restaurer l'adresse pré-configurée en usine. N'oubliez pas d'appeler la méthode et de redémarrer le module pour que le paramètre soit appliqué. saveToFlash() www.yoctopuce.com...
  • Page 200 Adresse IP du serveur de noms primaire que le module doit utiliser. string PrimaryDNS Modifiable. En mode DHCP, si une valeur est spécifiée, elle remplacera celle reçue du serveur DHCP. N'oubliez pas d'appeler la méthode et de redémarrer le module pour que le saveToFlash() paramètre soit appliqué. www.yoctopuce.com...
  • Page 201 IP a été obtenue par DHCP. Le niveau 4 (DNS_4) est atteint lorsqu'un serveur DNS est joignable par le réseau. Le niveau 5 (WWW_5) est atteint lorsque la connectivité globale à internet est avérée par l'obtention de l'heure courante sur une serveur NTP. www.yoctopuce.com...
  • Page 202 Modifiable. Modifie l'adresse IP du serveur de nom secondaire que le module doit utiliser. En mode DHCP, si une valeur est spécifiée, elle remplacera celle reçue du serveur DHCP. N'oubliez pas d'appeler la méthode et de redémarrer le module pour que le paramètre soit saveToFlash() appliqué. www.yoctopuce.com...
  • Page 203 8. Référence de l'API de haut niveau YNetwork network→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 204 Modifiable. Modifie le mode de passe pour l'utilisateur "user", qui devient alors instantanément nécessaire pour tout accès au module. Si la valeur fournie est une chaîne vide, plus aucun mot de passe n'est nécessaire. N'oubliez pas d'appeler la méthode du module si le réglage saveToFlash() doit être préservé. www.yoctopuce.com...
  • Page 205 Une valeur nulle désactive le redémarrage automatique en cas de perte de connectivité WWW. Modifiable. Une valeur nulle désactive le redémarrage automatique en cas de perte de connectivité WWW. La plus petite durée non-nulle utilisable est 90 secondes. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 206 Paramètres : username nom d'utilisateur pour s'identifier au callback password mot de passe pour s'identifier au callback Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 207 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'interface réseau. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 208 è r e s d é c r i v a n t l ' i n t e r f a c e r é s e a u ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 209 YNetwork target get_adminPassword Retourne : une chaîne de caractères représentant une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "admin", ou sinon une chaîne vide En cas d'erreur, déclenche une exception ou retourne YNetwork.ADMINPASSWORD_INVALID www.yoctopuce.com...
  • Page 210 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 211 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKCREDENTIALS_INVALID www.yoctopuce.com...
  • Page 212 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKENCODING_INVALID www.yoctopuce.com...
  • Page 213 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKINITIALDELAY_INVALID www.yoctopuce.com...
  • Page 214 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKMAXDELAY_INVALID www.yoctopuce.com...
  • Page 215 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKMETHOD_INVALID www.yoctopuce.com...
  • Page 216 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKMINDELAY_INVALID www.yoctopuce.com...
  • Page 217 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKSCHEDULE_INVALID www.yoctopuce.com...
  • Page 218 ) string get_callbackUrl( ) string get_callbackUrl( ) YNetwork target get_callbackUrl Retourne : une chaîne de caractères représentant l'adresse (URL) de callback à notifier lors de changement d'état significatifs En cas d'erreur, déclenche une exception ou retourne YNetwork.CALLBACKURL_INVALID www.yoctopuce.com...
  • Page 219 ): Promise<string> async get_defaultPage( ) string get_defaultPage( ) string get_defaultPage( ) YNetwork target get_defaultPage Retourne : une chaîne de caractères représentant la page HTML à envoyer pour l'URL "/" En cas d'erreur, déclenche une exception ou retourne YNetwork.DEFAULTPAGE_INVALID www.yoctopuce.com...
  • Page 220 ) YNetwork target get_discoverable Retourne : YNetwork.DISCOVERABLE_FALSE YNetwork.DISCOVERABLE_TRUE soit , soit , selon l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour) En cas d'erreur, déclenche une exception ou retourne YNetwork.DISCOVERABLE_INVALID www.yoctopuce.com...
  • Page 221 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.
  • Page 222 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.
  • Page 223 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'interface réseau en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YNetwork.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 224 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 225 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'interface réseau (ex: En cas d'erreur, déclenche une exception ou retourne YNetwork.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 226 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'interface réseau (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'interface réseau (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YNetwork.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 227 ): Promise<number> async get_httpPort( ) int get_httpPort( ) int get_httpPort( ) YNetwork target get_httpPort Retourne : un entier représentant le port TCP utilisé pour l'interface Web du hub En cas d'erreur, déclenche une exception ou retourne YNetwork.HTTPPORT_INVALID www.yoctopuce.com...
  • Page 228 Il peut s'agir d'une adresse configurée statiquement, ou d'une adresse reçue par un serveur DHCP. Retourne : une chaîne de caractères représentant l'adresse IP utilisée par le module Yoctopuce En cas d'erreur, déclenche une exception ou retourne YNetwork.IPADDRESS_INVALID www.yoctopuce.com...
  • Page 229 IP de passerelle. Ces trois paramètres sont séparés par le caractère "/" et sont utilisés si aucun serveur DHCP ne répond. Retourne : une chaîne de caractères représentant la configuration IP de l'interface réseau En cas d'erreur, déclenche une exception ou retourne YNetwork.IPCONFIG_INVALID www.yoctopuce.com...
  • Page 230 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YNetwork target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'interface réseau. En cas d'erreur, déclenche une exception ou retourne YNetwork.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 231 L'adresse MAC est aussi présente sur un autocollant sur le module, représentée en chiffres et en code- barres. Retourne : une chaîne de caractères représentant l'adresse MAC de l'interface réseau, unique pour chaque module En cas d'erreur, déclenche une exception ou retourne YNetwork.MACADDRESS_INVALID www.yoctopuce.com...
  • Page 232 8. Référence de l'API de haut niveau YNetwork network→get_module() network→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 233 8. Référence de l'API de haut niveau YNetwork network→get_module_async() network→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 234 ) string get_ntpServer( ) YNetwork target get_ntpServer Retourne : une chaîne de caractères représentant l'adresse IP du serveur de NTP à utiliser pour maintenir le module à l'heure En cas d'erreur, déclenche une exception ou retourne YNetwork.NTPSERVER_INVALID www.yoctopuce.com...
  • Page 235 La consommation est mesurée après conversion en 5 Volt, et ne doit jamais dépasser 1800 mA. Retourne : un entier représentant le courant consommé par le module depuis Power-over-Ethernet (PoE), en milliampères En cas d'erreur, déclenche une exception ou retourne YNetwork.POECURRENT_INVALID www.yoctopuce.com...
  • Page 236 ) string get_primaryDNS( ) string get_primaryDNS( ) YNetwork target get_primaryDNS Retourne : une chaîne de caractères représentant l'adresse IP du serveur de noms primaire que le module doit utiliser En cas d'erreur, déclenche une exception ou retourne YNetwork.PRIMARYDNS_INVALID www.yoctopuce.com...
  • Page 237 Le niveau 5 (WWW_5) est atteint lorsque la connectivité globale à internet est avérée par l'obtention de l'heure courante sur une serveur NTP. Retourne : YNetwork.READINESS_DOWN YNetwork.READINESS_EXISTS une valeur parmi YNetwork.READINESS_LINKED YNetwork.READINESS_LAN_OK YNetwork.READINESS_WWW_OK représentant l'état de fonctionnement atteint par l'interface réseau En cas d'erreur, déclenche une exception ou retourne YNetwork.READINESS_INVALID www.yoctopuce.com...
  • Page 238 ) string get_router( ) string get_router( ) YNetwork target get_router Retourne : une chaîne de caractères représentant l'adresse IP du routeur (passerelle) utilisé par le module (default gateway) En cas d'erreur, déclenche une exception ou retourne YNetwork.ROUTER_INVALID www.yoctopuce.com...
  • Page 239 ) string get_secondaryDNS( ) string get_secondaryDNS( ) YNetwork target get_secondaryDNS Retourne : une chaîne de caractères représentant l'adresse IP du serveur de noms secondaire que le module doit utiliser En cas d'erreur, déclenche une exception ou retourne YNetwork.SECONDARYDNS_INVALID www.yoctopuce.com...
  • Page 240 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YNetwork target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 241 ): Promise<string> async get_subnetMask( ) string get_subnetMask( ) string get_subnetMask( ) YNetwork target get_subnetMask Retourne : une chaîne de caractères représentant le masque de sous-réseau utilisé par le module En cas d'erreur, déclenche une exception ou retourne YNetwork.SUBNETMASK_INVALID www.yoctopuce.com...
  • Page 242 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 243 YNetwork target get_userPassword Retourne : une chaîne de caractères représentant une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "user", ou sinon une chaîne vide En cas d'erreur, déclenche une exception ou retourne YNetwork.USERPASSWORD_INVALID www.yoctopuce.com...
  • Page 244 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.WWWWATCHDOGDELAY_INVALID www.yoctopuce.com...
  • Page 245 Si les valeurs des attributs en cache de l'interface réseau 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'interface réseau est joignable, sinon www.yoctopuce.com...
  • Page 246 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 247 ) YNetwork 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 248 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 249 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 250 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 251 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 252 ): YNetwork | null nextNetwork( ) Si vous souhaitez retrouver une interface réseau spécifique, utilisez Network.findNetwork() avec un hardwareID ou un nom logique. Retourne : YNetwork null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 253 Envoie quatre requêtes ICMP ECHO_REQUEST à la cible host depuis le module. Cette méthode retourne une chaîne de caractères avec le résultat des 4 requêtes ICMP ECHO_RESPONSE. Paramètres : host le nom d'hôte ou l'adresse IP de la cible Retourne : une chaîne de caractères contenant le résultat du ping. www.yoctopuce.com...
  • Page 254 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 255 "admin", qui devient alors newval instantanément nécessaire pour toute altération de l'état 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 256 Paramètres : une chaîne de caractères représentant le laisser-passer pour se connecter à l'adresse de callback 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 257 Y N e t w o r k . C A L L B A C K E N C O D I N G _ P R T G YNetwork.CALLBACKENCODING_INFLUXDB_V2 représentant l'encodage à utiliser pour représenter les valeurs notifiées par callback Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 258 être préservé. saveToFlash() Paramètres : un entier représentant l'attente initiale avant la première notification par callback, en secondes 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 259 être préservé. saveToFlash() Paramètres : un entier représentant l'attente entre deux callback HTTP lorsque rien n'est à signaler 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 260: Paramètres

    YNetwork.CALLBACKMETHOD_GET YNetwork.CALLBACKMETHOD_PUT représentant la méthode HTTP à utiliser pour signaler les changements d'état par callback Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 261 être préservé. saveToFlash() Paramètres : un entier représentant l'attente minimale entre deux callbacks HTTP, en secondes 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 262 Paramètres : une chaîne de caractères représentant la planification des callbacks HTTP, sous forme de chaîne newval 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 263 Paramètres : une chaîne de caractères représentant l'adresse (URL) de callback à notifier lors de changement newval d'état significatifs Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 264 être préservé. saveToFlash() Paramètres : une chaîne de caractères représentant la page HTML par défaut du hub 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 265 , soit selon l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour) Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 266 La valeur par défaut est le port 80, utilisé habituellement pat tous les serveurs web. Indépendamment de la valeur de ce paramètre, le hub répond toujours au port 4444, qui est utilisé par défaut par la librairie de programmation Yoctopuce. Si vous changez ce paramètre, n'oubliez pas d'appeler la méthode du module si le réglage doit être préservé.
  • Page 267 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'interface réseau. 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 268 Paramètres : une chaîne de caractères représentant l'adresse IP du serveur NTP que le module doit utiliser 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 269 Par exemple, si la périodicité est 24h, un offset de 7 déclanchera le callback chaque jour à 7h du matin. Retourne : YAPI.SUCCESS when the call succeeds. On failure, throws an exception or returns a negative error code. www.yoctopuce.com...
  • Page 270 IP du serveur de noms primaire que le module newval doit utiliser Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 271 IP du serveur de nom secondaire que le module newval doit utiliser Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 272 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 273 "user", qui devient alors newval instantanément nécessaire pour tout accès au 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 274 WWW tolérée (en secondes) avant de newval déclancher un redémarrage automatique pour tenter de récupérer la connectivité Internet Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 275 Cette fonction peut même être appellée à l'intérieur d'un callback HTTP, dans quel cas le callback HTTP suivant sera appelé 5 secondes après la fin du callback courant, indépendamment de l'intervalle minimal configuré dans le module. Retourne : une chaîne de caractères contenant le résultat du ping. www.yoctopuce.com...
  • Page 276 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 277 IP à utiliser si aucun serveur DHCP ne répond longueur du masque de sous-réseau à utiliser si aucun serveur DHCP ne fallbackSubnetMaskLen répond. Par exemple, la valeur 24 représente 255.255.255.0. fallbackRouter adresse de la passerelle à utiliser si aucun serveur DHCP ne répond www.yoctopuce.com...
  • Page 278 8. 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 279 IP du réseau 169.254.0.0/16 (APIPA). N'oubliez pas d'appeler la méthode et de redémarrer le module pour que le paramètre soit appliqué. 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 280 à utiliser. Par exemple, la valeur 24 représente 255.255.255.0. router adresse IP de la passerelle à utiliser ("default gateway") Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 281 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 282: La Classe Yfiles

    Interface pour intéragir avec les systèmes de fichier, disponibles par exemple dans le Yocto-Color-V2, le Yocto-Serial, le YoctoHub-Ethernet et le YoctoHub-Wireless-n La class YFiles permet d'accéder au système de fichier embarqué sur certains modules Yoctopuce. Le stockage de fichiers permet par exemple de personnaliser un service web (dans le cas d'un module connecté...
  • Page 283 Retourne l'identifiant matériel du système de fichier, sans référence au module. files→get_hardwareId() SERIAL.FUNCTIONID Retourne l'identifiant matériel unique du système de fichier au format files→get_list(pattern) Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier. www.yoctopuce.com...
  • Page 284 8. Référence de l'API de haut niveau files→get_logicalName() Retourne le nom logique du système de fichier. files→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_serialNumber() Retourne le numéro de série du module, préprogrammé...
  • Page 285 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 286 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 287 YFiles.nextFiles() Retourne : un pointeur sur un objet YFiles , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
  • Page 288 YFiles.nextFiles() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YFiles , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
  • Page 289 Chaque chaîne retournée peut être passée en argument à la méthode pour YFiles.FindFiles obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
  • Page 290 8. Référence de l'API de haut niveau YFiles files→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 291 8. Référence de l'API de haut niveau YFiles files→FilesCount Nombre de fichiers présents dans le système de fichier. int FilesCount www.yoctopuce.com...
  • Page 292 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 293 8. Référence de l'API de haut niveau YFiles files→FunctionId Identifiant matériel du système de fichier, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 294 8. Référence de l'API de haut niveau YFiles files→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 295 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 296 8. Référence de l'API de haut niveau YFiles files→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 297 8. Référence de l'API de haut niveau YFiles files→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 298 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du système de fichier. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 299 î n e c a r a c t è r e s d é c r i v a n t s y s t è m e f i c h i e r ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 300 Paramètres : pathname nom complet du fichier à charger, y compris le chemin d'accès. Retourne : le contenu du fichier chargé sous forme d'objet binaire En cas d'erreur, déclenche une exception ou retourne un contenu vide. www.yoctopuce.com...
  • Page 301 La fonction callback doit prendre trois arguments: - la variable de contexte à disposition de l'utilisateur - l'objet YFiles dont la méthode download_async a été appelée - le contenu du fichier chargé sous forme d'objet binaire variable de contexte à disposition de l'utilisateur context Retourne : rien. www.yoctopuce.com...
  • Page 302 YFiles target fileExist filename Paramètres : filename le nom de fichier. Retourne : vrais si le fichier existe, et faux is le fichier n'existe pas. En cas d'erreur, déclenche une exception. www.yoctopuce.com...
  • Page 303 ) int format_fs( ) YFiles target format_fs entièrement vide. Tous les fichiers précédemment chargés sont irrémédiablement effacés. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 304 ) string get_advertisedValue( ) string get_advertisedValue( ) YFiles target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du système de fichier (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YFiles.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 305 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 306 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 307 ): Promise<number> async get_filesCount( ) int get_filesCount( ) int get_filesCount( ) YFiles target get_filesCount Retourne : un entier représentant le nombre de fichiers présents dans le système de fichier En cas d'erreur, déclenche une exception ou retourne YFiles.FILESCOUNT_INVALID www.yoctopuce.com...
  • Page 308 ) int get_freeSpace( ) int get_freeSpace( ) YFiles target get_freeSpace Retourne : un entier représentant l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets En cas d'erreur, déclenche une exception ou retourne YFiles.FREESPACE_INVALID www.yoctopuce.com...
  • Page 309 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le système de fichier en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YFiles.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 310 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 311 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le système de fichier (ex: En cas d'erreur, déclenche une exception ou retourne YFiles.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 312 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du système de fichier (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le système de fichier (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YFiles.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 313 Retourne : YFileRecord une liste d'objets , contenant le nom complet (y compris le chemin d'accès), la taille en octets et le CRC 32-bit du contenu du fichier. En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 314 ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YFiles target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du système de fichier. En cas d'erreur, déclenche une exception ou retourne YFiles.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 315 8. Référence de l'API de haut niveau YFiles files→get_module() files→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 316 8. Référence de l'API de haut niveau YFiles files→get_module_async() files→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 317 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YFiles target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 318 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 319 Si les valeurs des attributs en cache du système de fichier sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le système de fichier est joignable, sinon www.yoctopuce.com...
  • Page 320 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 321 ) YFiles target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
  • Page 322 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 323 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 324 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 325 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 326 ): YFiles | null nextFiles( ) Si vous souhaitez retrouver un système de fichier spécifique, utilisez Files.findFiles() avec un hardwareID ou un nom logique. Retourne : YFiles null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 327 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 328 éventuellement pas été libéré. Pour s'assurer de libérer la totalité de l'espace du système de fichier, utilisez la fonction format_fs Paramètres : pathname nom complet du fichier, y compris le chemin d'accès. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 329 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du système de fichier. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 330 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 331 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 332 Paramètres : nom complet du fichier, y compris le chemin d'accès. pathname content contenu du fichier à télécharger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 333 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 334: La Classe Yrealtimeclock

    à l'horloge embarquée sur certains modules YRealTimeClock Yoctopuce. Elle fournit la date et l'heure courante de manière persistante, même en cas de coupure de courant de plusieurs jours. Elle est le fondement des fonctions de réveil automatique implémentées par le WakeUpScheduler.
  • Page 335 SERIAL.FUNCTIONID realtimeclock→get_logicalName() Retourne le nom logique de l'horloge à temps réel. realtimeclock→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. realtimeclock→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. realtimeclock→get_serialNumber() Retourne le numéro de série du module, préprogrammé en usine.
  • Page 336 Modifie le nombre de secondes de décalage entre l'heure courante et l'heure UTC (time zone). realtimeclock→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. realtimeclock→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 337 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'horloge à temps réel sans ambiguïté, par exemple YHUBGSM3.realTimeClock Retourne : YRealTimeClock un objet de classe qui permet ensuite de contrôler l'horloge à temps réel. www.yoctopuce.com...
  • Page 338 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'horloge à temps réel sans ambiguïté, par exemple YHUBGSM3.realTimeClock Retourne : YRealTimeClock un objet de classe qui permet ensuite de contrôler l'horloge à temps réel. www.yoctopuce.com...
  • Page 339 YRealTimeClock.nextRealTimeClock() à temps réel. Retourne : un pointeur sur un objet YRealTimeClock , correspondant à la première horloge à temps réel null accessible en ligne, ou si il n'y a pas de horloges à temps réel disponibles. www.yoctopuce.com...
  • Page 340 Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YRealTimeClock , correspondant à la première horloge à temps réel null accessible en ligne, ou si il n'y a pas de horloges à temps réel disponibles. www.yoctopuce.com...
  • Page 341 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le YRealTimeClock.FindRealTimeClock 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 342 8. Référence de l'API de haut niveau YRealTimeClock realtimeclock→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 343 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 344 8. Référence de l'API de haut niveau YRealTimeClock realtimeclock→FunctionId Identifiant matériel de l'horloge à temps réel, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 345 8. Référence de l'API de haut niveau YRealTimeClock realtimeclock→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 346 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 347 8. Référence de l'API de haut niveau YRealTimeClock realtimeclock→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 348 8. Référence de l'API de haut niveau YRealTimeClock realtimeclock→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 349 Modifiable. Modifie le nombre de secondes de décalage entre l'heure courante et l'heure UTC (time zone). Le décallage est automatiquement arrondi au quart d'heure le plus proche. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 350 ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'horloge à temps réel. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 351 è r e s d é c r i v a n t l ' h o r l o g e à t e m p s r é e l ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 352 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 353 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.DATETIME_INVALID www.yoctopuce.com...
  • Page 354 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'horloge à...
  • Page 355 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'horloge à...
  • Page 356 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 357 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 358 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 359 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 360 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 361 8. Référence de l'API de haut niveau YRealTimeClock realtimeclock→get_module() realtimeclock→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 362 8. Référence de l'API de haut niveau YRealTimeClock realtimeclock→get_module_async() realtimeclock→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 363 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YRealTimeClock target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 364 ) int get_timeSet( ) int get_timeSet( ) YRealTimeClock target get_timeSet Retourne : YRealTimeClock.TIMESET_FALSE YRealTimeClock.TIMESET_TRUE soit , soit , selon vrai si l'horloge à été mise à l'heure, sinon faux En cas d'erreur, déclenche une exception ou retourne YRealTimeClock.TIMESET_INVALID www.yoctopuce.com...
  • Page 365 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.UNIXTIME_INVALID www.yoctopuce.com...
  • Page 366 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 367 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YRealTimeClock.UTCOFFSET_INVALID www.yoctopuce.com...
  • Page 368 Si les valeurs des attributs en cache de l'horloge à temps réel 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'horloge à temps réel est joignable, sinon www.yoctopuce.com...
  • Page 369 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 370 ) YRealTimeClock 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 371 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 372 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 373 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 374 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 375 é c i f i q u e , u t i l i s e z RealTimeClock.findRealTimeClock() avec un hardwareID ou un nom logique. Retourne : YRealTimeClock null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 376 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 377 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'horloge à temps réel. 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 378 L'heure est passée au format Unix (nombre de seconds secondes écoulées depuis le 1er janvier 1970). Paramètres : newval un entier représentant l'heure courante Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 379 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 380 UTC newval (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 381 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 382 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...

  • Page 383: La Classe Ywakeupmonitor

    <script type='text/javascript' src='yocto_wakeupmonitor.js'></script> #include "yocto_wakeupmonitor.h" #import "yocto_wakeupmonitor.h" uses yocto_wakeupmonitor; yocto_wakeupmonitor.vb yocto_wakeupmonitor.cs import com.yoctopuce.YoctoAPI.YWakeUpMonitor; java import com.yoctopuce.YoctoAPI.YWakeUpMonitor; from yocto_wakeupmonitor import * require_once('yocto_wakeupmonitor.php'); in HTML: import { YWakeUpMonitor } from '../../dist/esm/yocto_wakeupmonitor.js'; in Node.js: import { YWakeUpMonitor } from 'yoctolib-cjs/yocto_wakeupmonitor.js';...
  • Page 384 SERIAL.FUNCTIONID wakeupmonitor→get_logicalName() Retourne le nom logique du moniteur de réveil. wakeupmonitor→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. wakeupmonitor→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. wakeupmonitor→get_nextWakeUp() Retourne la prochaine date/heure de réveil agendée (format UNIX).
  • Page 385 Déclenche une mise en sommeil jusqu'à la prochaine condition de réveil, l'heure du RTC du module doit impérativement avoir été réglée au préalable. wakeupmonitor→sleepFor(secUntilWakeUp, secBeforeSleep) Déclenche une mise en sommeil pour un temps donné ou jusqu'à la prochaine condition de réveil, l'heure du RTC du module doit impérativement avoir été réglée au préalable. www.yoctopuce.com...
  • Page 386 Réactive l'envoi de chaque changement de la valeur publiée au hub parent. wakeupmonitor→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. wakeupmonitor→wakeUp() Force un réveil. www.yoctopuce.com...
  • Page 387 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le moniteur de réveil sans ambiguïté, par exemple YHUBGSM3.wakeUpMonitor Retourne : YWakeUpMonitor un objet de classe qui permet ensuite de contrôler le moniteur de réveil. www.yoctopuce.com...
  • Page 388 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le moniteur de réveil sans ambiguïté, par exemple YHUBGSM3.wakeUpMonitor Retourne : YWakeUpMonitor un objet de classe qui permet ensuite de contrôler le moniteur de réveil. www.yoctopuce.com...
  • Page 389 YWakeUpMonitor.nextWakeUpMonitor() de réveil. Retourne : un pointeur sur un objet YWakeUpMonitor , correspondant au premier moniteur de réveil accessible en null ligne, ou si il n'y a pas de moniteurs de réveil disponibles. www.yoctopuce.com...
  • Page 390 YWakeUpMonitor.nextWakeUpMonitor() de réveil. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YWakeUpMonitor , correspondant au premier moniteur de réveil accessible en null ligne, ou si il n'y a pas de moniteurs de réveil disponibles. www.yoctopuce.com...
  • Page 391 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le YWakeUpMonitor.FindWakeUpMonitor 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 392 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 393 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 394 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→FunctionId Identifiant matériel du moniteur de réveil, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 395 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→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 396 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 397 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→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 398 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→NextWakeUp Prochaine date/heure de réveil agendée (format UNIX). long NextWakeUp Modifiable. Modifie les jours de la semaine où un réveil doit avoir lieu. www.yoctopuce.com...
  • Page 399 Temp d'éveil maximal en secondes avant de retourner en sommeil automatiquement. int PowerDuration Modifiable. Modifie le temps d'éveil maximal en secondes avant de retourner en sommeil automatiquement. N'oubliez pas d'appeler la méthode du module si le réglage doit saveToFlash() être préservé. www.yoctopuce.com...
  • Page 400 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 401 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du moniteur de réveil. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 402 î n e c a r a c t è r e s d é c r i v a n t m o n i t e u r r é v e i l ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 403 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 404 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du moniteur de réveil.
  • Page 405 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du moniteur de réveil.
  • Page 406 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 407 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 408 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 409 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 410 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 411 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→get_module() wakeupmonitor→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 412 8. Référence de l'API de haut niveau YWakeUpMonitor wakeupmonitor→get_module_async() wakeupmonitor→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 413 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.NEXTWAKEUP_INVALID www.yoctopuce.com...
  • Page 414 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.POWERDURATION_INVALID www.yoctopuce.com...
  • Page 415 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YWakeUpMonitor target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 416 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.SLEEPCOUNTDOWN_INVALID www.yoctopuce.com...
  • Page 417 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 418 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.WAKEUPREASON_INVALID www.yoctopuce.com...
  • Page 419 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpMonitor.WAKEUPSTATE_INVALID www.yoctopuce.com...
  • Page 420 Si les valeurs des attributs en cache du moniteur de réveil 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 moniteur de réveil est joignable, sinon www.yoctopuce.com...
  • Page 421 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 422 ) YWakeUpMonitor target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
  • Page 423 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 424 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 425 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 426 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 427 é c i f i q u e , u t i l i s e z WakeUpMonitor.findWakeUpMonitor() avec un hardwareID ou un nom logique. Retourne : YWakeUpMonitor null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 428 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 429 ) async resetSleepCountDown( ): Promise<number> async resetSleepCountDown( ) int resetSleepCountDown( ) int resetSleepCountDown( ) YWakeUpMonitor target resetSleepCountDown Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 430 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du moniteur de réveil. 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 431 Paramètres : newval un entier représentant les jours de la semaine où un réveil doit avoir lieu Retourne : YAPI.SUCCESS si l'opération se 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 Paramètres : un entier représentant le temps d'éveil maximal en secondes avant de retourner en sommeil newval automatiquement Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 433 YWakeUpMonitor target set_sleepCountdown newval Paramètres : newval un entier représentant le temps avant le prochain sommeil Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 434 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 435 YWakeUpMonitor target sleep secBeforeSleep Paramètres : secBeforeSleep nombre de seconde avant la mise en sommeil Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 436 Paramètres : secUntilWakeUp nombre de secondes avant le prochain réveil secBeforeSleep nombre de secondes avant la mise en sommeil Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 437 Le compte à rebours avant la mise en sommeil peut être annulé grâce à resetSleepCountDown. Paramètres : wakeUpTime date/heure du réveil (format UNIX) secBeforeSleep nombre de secondes avant la mise en sommeil Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 438 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 439 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
  • Page 440 LongInt wakeUp( ): LongInt function wakeUp( ) As Integer int wakeUp( ) int wakeUp( ) java async Task<int> wakeUp( ) wakeUp( ) function wakeUp( ) async wakeUp( ): Promise<number> async wakeUp( ) int wakeUp( ) int wakeUp( ) YWakeUpMonitor target wakeUp www.yoctopuce.com...

  • Page 441: La Classe Ywakeupschedule

    <script type='text/javascript' src='yocto_wakeupschedule.js'></script> #include "yocto_wakeupschedule.h" #import "yocto_wakeupschedule.h" uses yocto_wakeupschedule; yocto_wakeupschedule.vb yocto_wakeupschedule.cs import com.yoctopuce.YoctoAPI.YWakeUpSchedule; java import com.yoctopuce.YoctoAPI.YWakeUpSchedule; from yocto_wakeupschedule import * require_once('yocto_wakeupschedule.php'); in HTML: import { YWakeUpSchedule } from '../../dist/esm/yocto_wakeupschedule.js'; in Node.js: import { YWakeUpSchedule } from 'yoctolib-cjs/yocto_wakeupschedule.js';...
  • Page 442 Retourne l'identifiant matériel du réveil agendé, sans référence au module. wakeupschedule→get_hardwareId() SERIAL.FUNCTIONID Retourne l'identifiant matériel unique du réveil agendé au format wakeupschedule→get_hours() Retourne les heures où le réveil est actif.. wakeupschedule→get_logicalName() Retourne le nom logique du réveil agendé. www.yoctopuce.com...
  • Page 443 Retourne les minutes de l'interval 30-59 de chaque heure où le réveil est actif. wakeupschedule→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. wakeupschedule→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
  • Page 444 Modifie les jours de la semaine où un réveil doit avoir lieu. wakeupschedule→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. wakeupschedule→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 445 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le réveil agendé sans ambiguïté, par exemple YHUBGSM3.wakeUpSchedule1 Retourne : YWakeUpSchedule un objet de classe qui permet ensuite de contrôler le réveil agendé. www.yoctopuce.com...
  • Page 446 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le réveil agendé sans ambiguïté, par exemple YHUBGSM3.wakeUpSchedule1 Retourne : YWakeUpSchedule un objet de classe qui permet ensuite de contrôler le réveil agendé. www.yoctopuce.com...
  • Page 447 Utiliser la fonction pour itérer sur les autres réveils YWakeUpSchedule.nextWakeUpSchedule() agendés. Retourne : un pointeur sur un objet YWakeUpSchedule , correspondant au premier réveil agendé accessible en null ligne, ou si il n'y a pas de réveils agendés disponibles. www.yoctopuce.com...
  • Page 448 YWakeUpSchedule.nextWakeUpSchedule() agendés. Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YWakeUpSchedule , correspondant au premier réveil agendé accessible en null ligne, ou si il n'y a pas de réveils agendés disponibles. www.yoctopuce.com...
  • Page 449 à m é t h o d e pour obtenir une objet permettant d'intéragir avec le YWakeUpSchedule.FindWakeUpSchedule 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 450 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 451 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 452 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→FunctionId Identifiant matériel du réveil agendé, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 453 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→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 454 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→Hours S heures où le réveil est actif.. int Hours Modifiable. Modifie les heures où un réveil doit avoir lieu. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 455 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 456 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→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 457 S minutes de l'interval 00-29 de chaque heures où le réveil est actif. int MinutesA Modifiable. Modifie les minutes de l'interval 00-29 où un réveil doit avoir lieu. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 458 S minutes de l'interval 30-59 de chaque heure où le réveil est actif. int MinutesB Modifiable. Modifie les minutes de l'interval 30-59 où un réveil doit avoir lieu. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 459 YWakeUpSchedule wakeupschedule→MonthDays S jours du mois où le réveil est actif. int MonthDays Modifiable. Modifie les jours du mois où un réveil doit avoir lieu. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 460 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→Months S mois où le réveil est actif. int Months Modifiable. Modifie les mois où un réveil doit avoir lieu. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 461 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→NextOccurence Date/heure de la prochaine occurence de réveil. long NextOccurence www.yoctopuce.com...
  • Page 462 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 463 S jours de la semaine où le réveil est actif. int WeekDays Modifiable. Modifie les jours de la semaine où un réveil doit avoir lieu. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 464 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du réveil agendé. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 465 î n e c a r a c t è r e s d é c r i v a n t r é v e i l a g e n d é ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 466 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 467 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du réveil agendé.
  • Page 468 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du réveil agendé.
  • Page 469 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 470 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 471 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 472 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 473 ) async get_hours( ): Promise<number> async get_hours( ) int get_hours( ) int get_hours( ) YWakeUpSchedule target get_hours Retourne : un entier représentant les heures où le réveil est actif En cas d'erreur, déclenche une exception ou retourne YWakeUpSchedule.HOURS_INVALID www.yoctopuce.com...
  • Page 474 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 475 ): int64 function get_minutes( ) As Long long get_minutes( ) long get_minutes( ) java async Task<long> get_minutes( ) get_minutes( ) function get_minutes( ) async get_minutes( ): Promise<number> async get_minutes( ) long get_minutes( ) s64 get_minutes( ) YWakeUpSchedule target get_minutes www.yoctopuce.com...
  • Page 476 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.MINUTESA_INVALID www.yoctopuce.com...
  • Page 477 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.MINUTESB_INVALID www.yoctopuce.com...
  • Page 478 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→get_module() wakeupschedule→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 479 8. Référence de l'API de haut niveau YWakeUpSchedule wakeupschedule→get_module_async() wakeupschedule→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 480 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.MONTHDAYS_INVALID www.yoctopuce.com...
  • Page 481 ) async get_months( ): Promise<number> async get_months( ) int get_months( ) int get_months( ) YWakeUpSchedule target get_months Retourne : un entier représentant les mois où le réveil est actif En cas d'erreur, déclenche une exception ou retourne YWakeUpSchedule.MONTHS_INVALID www.yoctopuce.com...
  • Page 482 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.NEXTOCCURENCE_INVALID www.yoctopuce.com...
  • Page 483 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YWakeUpSchedule target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 484 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 485 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YWakeUpSchedule.WEEKDAYS_INVALID www.yoctopuce.com...
  • Page 486 Si les valeurs des attributs en cache du réveil agendé 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 réveil agendé est joignable, sinon www.yoctopuce.com...
  • Page 487 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 488 ) YWakeUpSchedule 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 489 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 490 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 491 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 492 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 493 é c i f i q u e , u t i l i s e z WakeUpSchedule.findWakeUpSchedule() avec un hardwareID ou un nom logique. Retourne : YWakeUpSchedule null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 494 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 495 être préservé. saveToFlash() Paramètres : un entier représentant les heures où un réveil doit avoir lieu 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 496 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du réveil agendé. 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 497 YWakeUpSchedule target set_minutes bitmap Paramètres : bitmap Minutes 00-59 de chaque heure où le réveil est actif. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 498 Paramètres : un entier représentant les minutes de l'interval 00-29 où un réveil doit avoir lieu 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 499 Paramètres : un entier représentant les minutes de l'interval 30-59 où un réveil doit avoir lieu 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 500 être préservé. saveToFlash() Paramètres : un entier représentant les jours du mois où un réveil doit avoir lieu 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 501 être préservé. saveToFlash() Paramètres : un entier représentant les mois où un réveil doit avoir lieu 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 502 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 503 Paramètres : un entier représentant les jours de la semaine où un réveil doit avoir lieu 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 504 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 505 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
  • Page 506 www.yoctopuce.com...

  • Page 507: Problèmes Courants

    9.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 9.2.

  • Page 508: Plateformes Arm: Hf Et El

    9.5. Module alimenté mais invisible pour l'OS Si votre YoctoHub-GSM-2G 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 509: Déconnexions, Comportement Erratique

    Le but du YoctoHub-GSM-2G est de fournir une connectivité réseau aux sous-modules qui lui sont connecté, il ne se comporte pas comme un hub USB. Le port USB du YoctoHub-GSM-2G ne sert qu'à l'alimenter et le configurer. Pour accéder aux modules connectés au hub, vous devez impérativement passer par une connexion réseau.
  • Page 510 www.yoctopuce.com...

  • Page 511: Caractéristiques

    10. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module YoctoHub-GSM-2G Identifiant produit YHUBGSM1 † Rev. C Révision matérielle Connecteur USB micro-B Epaisseur 9.5 mm Largeur 58 mm Longueur 60 mm Poids 34 g Chipset Telit GL865-QUAD Fréquence...
  • Page 512 10. Caractéristiques www.yoctopuce.com...

Table des Matières