Télécharger
Partager
Imprimer la page
  1. Manuels
  2. Marques
  3. Yoctopuce Manuels
  4. Unités de contrôle
  5. YoctoHub-Wireless-g
  6. Mode d'emploi

Yoctopuce YoctoHub-Wireless-g Mode D'emploi

Masquer les pouces
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396

Publicité

Liens rapides

Télécharger ce manuel
YoctoHub-Wireless-g
Mode d'emploi

Publicité

loading

Manuels Connexes pour Yoctopuce YoctoHub-Wireless-g

Sommaire des Matières pour Yoctopuce YoctoHub-Wireless-g

  • Page 1 YoctoHub-Wireless-g Mode d'emploi...

  • Page 3: Table Des Matières

    Table des matières 1. Introduction ..........................2. Présentation ..........................2.1. Les éléments du YoctoHub-Wireless-g ................3. Premiers pas ..........................3.1. Configuration manuelle ....................... 3.2. Configuration automatisée ....................3.3. Connexions ........................4. Montage ............................ 4.1. Fixation ..........................4.2. Fixation d'un sous-module ....................
  • Page 4 7.9. User defined callback ......................8. Programmation ........................8.1. Accès aux modules connectés ..................8.2. Contrôle du YoctoHub-Wireless-g ................... 9. Mise en sommeil ........................9.1. Configuration manuelle du système de réveil ..............9.2. Paramétrage du système de réveil par logiciel ...............

  • Page 5: Introduction

    Les ingénieurs Yoctopuce se sont donnés beaucoup de mal pour que votre YoctoHub-Wireless-g 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 http://www.yoctopuce.com/FR/virtualhub.php...
  • Page 6 www.yoctopuce.com...

  • Page 7: Présentation

    15: Port descendant 3 8: Connecteur d'antenne 16: Indicateur port descendant 3 2.1. Les éléments du YoctoHub-Wireless-g Le numéro de série Chaque Yocto-module a un numéro de série unique attribué en usine, pour les modules YoctoHub- Wireless-g ce numéro commence par YHUBWLN3. Le module peut être piloté par logiciel en utilisant ce numéro de série.

  • Page 8: Le Yocto-Bouton

    USB directement dans les trous espacés de 1.27mm prévus à cet effet, près du connecteur. 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-Wireless-g. www.yoctopuce.com/FR/products/yoctohub-shield www.yoctopuce.com...

  • Page 9: Le Connecteur D'antenne

    UFL, il est fragile et n'est pas conçu pour supporter beaucoup de cycles de connexion/déconnexion. Le YoctoHub-Wireless-g est livré en standard avec un petit câble UFL vers RP-SMA femelle (reverse polarity SMA: filetage extérieur et pin mâle au centre) et une antenne correspondante RP-SMA mâle (filetage intérieur et tube femelle au centre).
  • Page 10 2. Présentation Mise en sommeil En temps normal, le YoctoHub-Wireless-g consomme environ 0,5 Watt, 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 à une heure précise (ou lorsqu'un contact extérieur est fermé).

  • Page 11: Premiers Pas

    3. Premiers pas Ce chapitre a pour but de vous aider à connecter et configurer votre YoctoHub-Wireless-g pour la première fois 3.1. Configuration manuelle Vous pouvez configurer votre YoctoHub-Wireless-g 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-Wireless-g.

  • Page 12: Connexion Au Réseau Sans Fil

    Fenêtre de configuration du module YoctoHub-Wireless-g Connexion au réseau sans fil La première chose à faire consiste à configurer votre YoctoHub-Wireless-g pour qu'il se connecte à votre réseau WiFi. Pour cela cliquez sur le bouton edit correspondant à WLAN settings dans la section Network configuration, la fenêtre de configuration du réseau sans fil apparaît:...
  • Page 13 Vous pouvez aussi choisir le nom réseau de votre YoctoHub-Wireless-g. Vous pourrez ainsi accéder à votre YoctoHub-Wireless-g en utilisant ce nom plutôt que son adresse IP. Une fois la partie réseau configurée, cliquez sur le bouton Save. Cela qui aura pour effet de sauver vos modifications et de fermer la fenêtre de configuration.
  • Page 14 3. Premiers pas Les propriétés du YoctoHub-Wireless-g Cette fenêtre comporte une section qui relate l'état de la partie réseau du YoctoHub-Wireless-g. Vous y trouverez son adresse MAC, adresse IP courante et nom de réseau. Cette section donne aussi l'état de la connexion réseau. Ces états peuvent être: •...

  • Page 15: Configuration Automatisée

    L'interface du YoctoHub-Wireless-g est identique à celle d'un VirtualHub. Si vous avez attribué un nom à votre YoctoHub-Wireless-g, vous pouvez aussi utiliser ce nom sur le réseau local. Par exemple, si vous avez utilisé le nom réseau yoctohub, vous pouvez contacter le module avec l'URL http://yoctohub sous Windows et avec l'URL http://yoctohub.local sous Mac OS X...
  • Page 16 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 17 Vous aurez besoin de vis, d'entretoises et d'un connecteur au pas 1.27mm Vous pouvez ainsi transformer un module Yoctopuce USB en en module réseau tout en gardant un format très compact. Fixation d'un module directement sur le hub Attention, le YoctoHub-Wireless-g est conçu pour piloter des modules Yoctopuce uniquement.
  • Page 18 www.yoctopuce.com...

  • Page 19: Montage

    Exemples de montage sur un support. Le module YoctoHub-Wireless-g 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 20: 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-Wireless-g, et le contact carré sur sur le module doit être connecté au contact carré sur le port descendant du YoctoHub-Wireless-g. Si vous montez un module sur l'autre face ou d'une autre manière, la polarité...

  • Page 21: Utilisation Du Yoctohub-Wireless-G

    Yocto-bouton(1) et Led(2) de localisation d'un module Yocto-Demo. Ces deux éléments sont généralement placés au même endroit sur les modules. L'interface du YoctoHub-Wireless-g est régulièrement testée sur Internet Explorer, Firefox, Chrome et Safari. Elle ne fonctionne pas avec Opéra www.yoctopuce.com...

  • Page 22: Test Des Modules

    Fenêtre "configure" du module Yocto-Demo. Vous n'êtes pas obligé d'avoir un YoctoHub-Wireless-g plus récent qu'un module pour le tester/configurer: tous les éléments spécifiques aux interfaces des modules sont stockés dans la ROM des modules, et non pas dans le YoctoHub- Wireless-g.

  • Page 23: Upgrades Des Firmwares

    5. Utilisation du YoctoHub-Wireless-g 5.4. Upgrades des firmwares Les modules Yoctopuce sont en fait de véritables ordinateurs, ils contiennent même un petit serveur Web. Et comme tous les ordinateurs, il est possible de mettre à jour leur logiciel de contrôle (firmware).
  • Page 24 www.yoctopuce.com...

  • Page 25: Contrôle D'accès

    Pour ce faire, cliquez simplement sur le bouton Configure de la ligne correspondant au YoctoHub- Wireless-g dans l'interface. Cliquez sur le bouton "Configure" de la première ligne Cela aura pour effet de faire apparaître la fenêtre de configuration du YoctoHub-Wireless-g. www.yoctopuce.com...

  • Page 26: Accès "Admin" Protégé

    Le mot de passe admin verrouille les accès en écriture sur les modules. Lorsqu'il est configuré, seuls les accès de type admin permettent d'accéder aux modules en lecture et en écriture. Les utilisateurs utilisant le login admin pourront éditer la configuration des modules vus par ce YoctoHub-Wireless-g comme ils le souhaitent.

  • Page 27: Influence Sur Les Api

    6. Contrôle d'accès 6.3. Influence sur les API Attention, le contrôle d'accès agira aussi sur les API Yoctopuce qui tenteront de se connecter à ce YoctoHub-Wireless-g. Dans les API Yoctopuce, la gestion des droits d'accès est réalisée au niveau de l'appel à la fonction...
  • Page 28 www.yoctopuce.com...

  • Page 29: Interactions Avec L'extérieur

    7. Interactions avec l'extérieur Le YoctoHub-Wireless-g 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 30: Emoncms

    La fenêtre de configuration des callbacks HTTP apparaît. Cette fenêtre va vous permettre de définir comment votre YoctoHub-Wireless-g 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 31: Thinkspeak

    à travers un filtre NAT sans que vous ayez à ouvrir un port. Typiquement cela permet de contrôler depuis un site Web public des modules Yoctopuce installés derrière un router DSL privé. Le YoctoHub-Wireless-g sert alors de passerelle. Vous avez simplement à définir l'URL du script de contrôle sur le serveur HTTP et éventuellement les crédentiels nécessaires pour y accéder.

  • Page 32: User Defined Callback

    Les "User defined callback" vous permettent de personnaliser la manière dont votre YoctoHub- Wireless-g va interagir avec un site Web externe. Vous avez besoin de définir l'URL du serveur Web sur lequel le YoctoHub-Wireless-g va poster l'état de ses devices. Notez que seul le protocole HTTP est supporté (pas de HTTPS).
  • Page 33 Voici un script PHP qui vous permettra de visualiser le contenu des données postées par le callback, suivi du résultat dans la fenêtre de debug. <?php Print(Date('H:i:s')."\r\n"); foreach ($_POST as $key=>$value) { Print("$key=$value\r\n"); ?> Le résultat du test de callback avec un Yocto-PowerRelay et un Yocto-Temperature. www.yoctopuce.com...
  • Page 34 www.yoctopuce.com...

  • Page 35: Programmation

    // l'adresse IP du hub est 192.168.0.10 8.2. Contrôle du YoctoHub-Wireless-g Du point de vue API de programmation, le YoctoHub-Wireless-g 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 36 Files Cette classe permet d'accéder aux fichiers stockées dans la mémoire flash du YoctoHub-Wireless-g. Le YoctoHub-Wireless-g 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-Wireless-g.

  • Page 37: Mise En Sommeil

    9. Mise en sommeil Le YoctoHub-Wireless-g 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 38: 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-Wireless-g 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 39 éveillé après un réveil. Si cette variable est mise à zéro, le module restera éveillé. Le YoctoHub-Wireless-g dispose de deux fonctions wakeUpSchedule ce qui permet de programmer jusqu'a deux types de réveils indépendants.
  • Page 40 www.yoctopuce.com...

  • Page 41: Personnalisation De L'interface Web

    10. Personnalisation de l'interface Web Votre YoctoHub-Wireless-g dispose d'un petit système de fichiers embarqué, qui permet de stocker des fichiers personnalisés utilisables par le YoctoHub-Wireless-g. Le système de fichiers se manipule grâce à la libraire yocto_files. Vous pourrez y stocker les fichiers de votre choix. Au besoin, vous pourrez y stocker une application Web permettant de gérer les modules connectés à...

  • Page 42: Utilisation Par Http

    "123456789" est 0xCBF43926. Utilisation par HTTP Les fichiers que vous avez chargés sur sur votre YoctoHub-Wireless-g sont accessibles par HTTP, à la racine du module (au même niveau que l'API REST). Cela permet de charger par exemple des pages d'interface HTML et Javascript personnalisées.

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

    , si l'on préfère travailler avec des valeurs de yDisableExceptions() retour d'erreur. Ce chapitre ne reprend pas en détail les concepts de programmation des modules Yoctopuce. Vous trouverez des explications plus détaillées dans la documentation des modules que vous souhaitez raccorder à votre YoctoHub-Wireless-g.

  • Page 44: Interface D'un Port De Yocto-Hub

    YoctoHub-Ethernet, un YoctoHub-Wireless-g, un YoctoHub-Shield ou un YoctoHub-GSM-3G-NA. Il 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é.
  • Page 45 SERIAL.FUNCTIONID hubport→get_logicalName() Retourne le nom logique du port de Yocto-hub. hubport→get_module() YModule Retourne l'objet 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() Retourne l'état actuel du port de Yocto-hub.
  • Page 46 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 47 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence le port de Yocto-hub sans ambiguïté, par exemple func YHUBETH1.hubPort1 Retourne : YHubPort un objet de classe qui permet ensuite de contrôler le port de Yocto-hub. www.yoctopuce.com...
  • Page 48 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le port de Yocto-hub sans ambiguïté, par exemple func YHUBETH1.hubPort1 Retourne : un objet de classe YHubPort qui permet ensuite de contrôler le port de Yocto-hub. www.yoctopuce.com...
  • Page 49 Yocto-hub. YHubPort.nextHubPort() Retourne : YHubPort un pointeur sur un objet , correspondant au premier port de Yocto-hub accessible en ligne, ou null si il n'y a pas de port de Yocto-hub disponibles. www.yoctopuce.com...
  • Page 50 Yocto-hub. YHubPort.nextHubPort() Paramètres : un contexte YAPI. yctx Retourne : YHubPort un pointeur sur un objet , correspondant au premier port de Yocto-hub accessible en ligne, ou null si il n'y a pas de port de Yocto-hub disponibles. www.yoctopuce.com...
  • Page 51 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du port de Yocto-hub. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 52 î 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 53 ) function get_advertisedValue( ) async get_advertisedValue( ) YHubPort target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du port de Yocto-hub (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 54 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 Yocto-hub, en kbps En cas d'erreur, déclenche une exception ou retourne Y_BAUDRATE_INVALID www.yoctopuce.com...
  • Page 55 ) function get_enabled( ) async get_enabled( ) YHubPort target get_enabled Retourne : soit Y_ENABLED_FALSE , soit Y_ENABLED_TRUE , selon vrai si le port du Yocto-hub est alimenté, faux sinon En cas d'erreur, déclenche une exception ou retourne Y_ENABLED_INVALID www.yoctopuce.com...
  • Page 56 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du port de Yocto-hub.
  • Page 57 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du port de Yocto- hub.
  • Page 58 Yocto-hub (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le port de Yocto-hub en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 59 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 60 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le port de Yocto-hub (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 61 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du port de Yocto-hub (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le port de Yocto-hub (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 62 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YHubPort target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du port de Yocto-hub. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 63 11. 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 function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 64 11. 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 65 Task<int> get_portState( ) get_portState( ) function get_portState( ) async get_portState( ) YHubPort target get_portState Retourne : une valeur parmi Y_PORTSTATE_OFF Y_PORTSTATE_OVRLD Y_PORTSTATE_ON Y_PORTSTATE_RUN Y_PORTSTATE_PROG représentant l'état actuel du port de Yocto-hub En cas d'erreur, déclenche une exception ou retourne Y_PORTSTATE_INVALID www.yoctopuce.com...
  • Page 66 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async 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 YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 67 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 68 Si les valeurs des attributs en cache du port de Yocto-hub sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le port de Yocto-hub est joignable, false sinon www.yoctopuce.com...
  • Page 69 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 70 ) 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 71 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 72 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 73 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 74 é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 75 ) nextHubPort( ) Si vous souhaitez retrouver un port de Yocto-hub spécifique, utilisez HubPort.findHubPort() avec un hardwareID ou un nom logique. Retourne : un pointeur sur un objet YHubPort accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 76 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 77 Si le port est actif, il sera alimenté. Sinon, l'alimentation du module est coupée. Paramètres : newval soit Y_ENABLED_FALSE , soit Y_ENABLED_TRUE , selon le mode d'activation du port du Yocto-hub Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 78 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du port de Yocto-hub. 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 79 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 80 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 81 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 82: Interface De La Fonction Wireless

    11.2. Interface de la fonction Wireless La classe YWireless permet de configurer et de contrôler la configuration du réseau sans fil sur les modules Yoctopuce qui en sont dotés, par exemple avec un YoctoHub-Wireless-g, un YoctoHub- Wireless-SR ou un YoctoHub-Wireless.
  • Page 83 Retourne le nom logique de l'interface réseau sans fil. wireless→get_message() Retourne le dernier message de diagnostique de l'interface au réseau sans fil. wireless→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. wireless→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. wireless→get_security() Retourne l'algorithme de sécurité...
  • Page 84 Déclenche un balayage des fréquences utilisable et construit la liste de réseau sans fils disponible. wireless→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. wireless→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 85 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence l'interface réseau sans fil sans ambiguïté, par exemple func YHUBWLN3.wireless Retourne : YWireless un objet de classe qui permet ensuite de contrôler l'interface réseau sans fil. www.yoctopuce.com...
  • Page 86 La recherche se fait d'abord par nom matériel, puis par nom logique. Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence l'interface réseau sans fil sans ambiguïté, par exemple func YHUBWLN3.wireless Retourne : un objet de classe YWireless qui permet ensuite de contrôler l'interface réseau sans fil. www.yoctopuce.com...
  • Page 87 YWireless.nextWireless() fil. Retourne : YWireless un pointeur sur un objet , correspondant à la première interface réseau sans fil accessible en ligne, ou null si il n'y a pas de interfaces réseau sans fil disponibles. www.yoctopuce.com...
  • Page 88 Paramètres : un contexte YAPI. yctx Retourne : YWireless un pointeur sur un objet , correspondant à la première interface réseau sans fil accessible en ligne, ou null si il n'y a pas de interfaces réseau sans fil disponibles. www.yoctopuce.com...
  • Page 89 Sur le YoctoHub-Wireless-g, il est recommandé d'utiliser de préférence la fonction softAPNetwork() qui crée un pseudo point d'accès, plus efficace et mieux supporté qu'un réseau ad-hoc. Si une clef d'accès est configurée pour un réseau ad-hoc, le réseau sera protégé par une sécurité...
  • Page 90 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes de l'interface réseau sans fil. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 91 è 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 s a n s f i l ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 92 ) function get_advertisedValue( ) async get_advertisedValue( ) YWireless target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'interface réseau sans fil (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 93 ) async get_channel( ) YWireless target get_channel Retourne : un entier représentant le numéro du canal 802.11 utilisé, ou 0 si le réseau sélectionné n'a pas été trouvé En cas d'erreur, déclenche une exception ou retourne Y_CHANNEL_INVALID www.yoctopuce.com...
  • Page 94 "garbage collection". Retourne : YWlanRecord une liste d'objets , contenant le SSID, le canal, la qualité du signal, et l'algorithme de sécurité utilisé par le réseau sans fil En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 95 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau sans fil.
  • Page 96 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau sans fil.
  • Page 97 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'interface réseau sans fil en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 98 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 99 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'interface réseau sans fil (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 100 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'interface réseau sans fil (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant l'interface réseau sans fil (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 101 ) java async Task<int> get_linkQuality( ) get_linkQuality( ) function get_linkQuality( ) async get_linkQuality( ) YWireless 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 Y_LINKQUALITY_INVALID www.yoctopuce.com...
  • Page 102 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YWireless target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'interface réseau sans fil. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 103 Task<string> get_message( ) get_message( ) function get_message( ) async get_message( ) YWireless 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 Y_MESSAGE_INVALID www.yoctopuce.com...
  • Page 104 11. Référence de l'API de haut niveau YWireless wireless→get_module() wireless→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 105 11. Référence de l'API de haut niveau YWireless wireless→get_module_async() wireless→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 106 ) async get_security( ) YWireless target get_security Retourne : une valeur parmi Y_SECURITY_UNKNOWN Y_SECURITY_OPEN Y_SECURITY_WEP Y_SECURITY_WPA Y_SECURITY_WPA2 représentant l'algorithme de sécurité utilisé par le réseau sans fil sélectionné En cas d'erreur, déclenche une exception ou retourne Y_SECURITY_INVALID www.yoctopuce.com...
  • Page 107 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YWireless target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 108 Task<string> get_ssid( ) get_ssid( ) function get_ssid( ) async get_ssid( ) YWireless target get_ssid Retourne : une chaîne de caractères représentant le nom (SSID) du réseau sans fil sélectionné En cas d'erreur, déclenche une exception ou retourne Y_SSID_INVALID www.yoctopuce.com...
  • Page 109 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 110 Y _ W L A N S T A T E _ S C A N N I N G u n e v a l e u r p a r m i Y_WLANSTATE_CONNECTED Y_WLANSTATE_REJECTED représentant l'état actuel de l'interface réseau sans fil En cas d'erreur, déclenche une exception ou retourne Y_WLANSTATE_INVALID www.yoctopuce.com...
  • Page 111 Si les valeurs des attributs en cache de l'interface réseau sans fil sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si l'interface réseau sans fil est joignable, false sinon www.yoctopuce.com...
  • Page 112 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 113 ) YWireless 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 114 à utiliser ssid securityKey clé d'accès au réseau, sous forme de chaîne de caractères Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 115 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 116 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 117 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 118 é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 119 ) nextWireless( ) Si vous souhaitez retrouver une interface réseau sans fil spécifique, utilisez avec un hardwareID ou un nom logique. Wireless.findWireless() Retourne : un pointeur sur un objet YWireless accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 120 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 121 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'interface réseau sans fil. 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 122 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 123 Cette fonction ne fonctionne que sur le YoctoHub-Wireless-g. Si une clef d'accès est configurée pour un réseau SoftAP, le réseau sera protégé par une sécurité WEP40 (5 caractères ou 10 chiffres hexadécimaux) ou WEP128 (13 caractères ou 26 chiffres hexadécimaux).
  • Page 124 . La wlanState Y_WLANSTATE_DOWN Y_WLANSTATE_SCANNING liste des réseaux sans fils disponible peut être récupéré avec la méthode get_detectedWlans() à partir du moment ou retourne get_wlanState() Y_WLANSTATE_REJECTED Y_WLANSTATE_CONNECTED En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 125 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 126 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 127: Interface De La Fonction Network

    11. Référence de l'API de haut niveau 11.3. Interface de la fonction Network La classe YNetwork permet de contrôler les paramètres TCP/IP des modules Yoctopuce dotés d'une interface réseau, par exemple avec un YoctoHub-Ethernet, un YoctoHub-Wireless-g, un YoctoHub- GSM-3G-NA ou un YoctoHub-GSM-3G-EU.
  • Page 128 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 129 Ping l'adresse choisie pour vérifier la connexion réseau. network→registerValueCallback(callback) Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée. network→set_adminPassword(newval) 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. www.yoctopuce.com...
  • Page 130 Modifie la durée de perte de connection WWW tolérée (en secondes) avant de déclancher un redémarrage automatique pour tenter de récupérer la connectivité Internet. network→triggerCallback() Déclenche un callback HTTP rapidement. network→unmuteValueCallbacks() Réactive l'envoi de chaque changement de la valeur publiée au hub parent. network→useDHCP(fallbackIpAddr, fallbackSubnetMaskLen, fallbackRouter) www.yoctopuce.com...
  • Page 131 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 132 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence l'interface réseau sans ambiguïté, par exemple func YHUBETH1.network Retourne : YNetwork un objet de classe qui permet ensuite de contrôler l'interface réseau. www.yoctopuce.com...
  • Page 133 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence l'interface réseau sans ambiguïté, par exemple func YHUBETH1.network Retourne : un objet de classe YNetwork qui permet ensuite de contrôler l'interface réseau. www.yoctopuce.com...
  • Page 134 Utiliser la fonction pour itérer sur les autres interfaces réseau. YNetwork.nextNetwork() Retourne : YNetwork un pointeur sur un objet , 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 135 YNetwork.nextNetwork() Paramètres : un contexte YAPI. yctx Retourne : YNetwork un pointeur sur un objet , 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 136 Paramètres : nom d'utilisateur pour s'identifier au callback username 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 137 ) java clearCache( ) function clearCache( ) 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 138 è 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 139 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 Y_ADMINPASSWORD_INVALID www.yoctopuce.com...
  • Page 140 Task<string> get_advertisedValue( ) get_advertisedValue( ) function get_advertisedValue( ) async get_advertisedValue( ) YNetwork target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'interface réseau (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 141 ) YNetwork target get_callbackCredentials Retourne : une chaîne de caractères représentant une version hashée du laisser-passer pour le callback de notification s'il a été configuré, ou sinon une chaîne vide En cas d'erreur, déclenche une exception ou retourne Y_CALLBACKCREDENTIALS_INVALID www.yoctopuce.com...
  • Page 142 Y _ C A L L B A C K E N C O D I N G _ M Q T T Y_CALLBACKENCODING_YOCTO_API_JZON Y_CALLBACKENCODING_PRTG représentant l'encodage à utiliser pour représenter les valeurs notifiées par callback En cas d'erreur, déclenche une exception ou retourne Y_CALLBACKENCODING_INVALID www.yoctopuce.com...
  • Page 143 Task<int> get_callbackInitialDelay( ) get_callbackInitialDelay( ) function get_callbackInitialDelay( ) async get_callbackInitialDelay( ) YNetwork target get_callbackInitialDelay Retourne : un entier représentant l'attente initiale avant la première notification par callback, en secondes En cas d'erreur, déclenche une exception ou retourne Y_CALLBACKINITIALDELAY_INVALID www.yoctopuce.com...
  • Page 144 Task<int> get_callbackMaxDelay( ) get_callbackMaxDelay( ) function get_callbackMaxDelay( ) async get_callbackMaxDelay( ) YNetwork target get_callbackMaxDelay Retourne : un entier représentant l'attente entre deux callback HTTP lorsque rien n'est à signaler, en secondes En cas d'erreur, déclenche une exception ou retourne Y_CALLBACKMAXDELAY_INVALID www.yoctopuce.com...
  • Page 145 ) function get_callbackMethod( ) async get_callbackMethod( ) YNetwork target get_callbackMethod Retourne : valeur parmi Y_CALLBACKMETHOD_POST Y_CALLBACKMETHOD_GET Y_CALLBACKMETHOD_PUT représentant la méthode HTTP à utiliser pour signaler les changements d'état par callback En cas d'erreur, déclenche une exception ou retourne Y_CALLBACKMETHOD_INVALID www.yoctopuce.com...
  • Page 146 ) java async Task<int> get_callbackMinDelay( ) get_callbackMinDelay( ) function get_callbackMinDelay( ) async get_callbackMinDelay( ) YNetwork target get_callbackMinDelay Retourne : un entier représentant l'attente minimale entre deux callbacks HTTP, en secondes En cas d'erreur, déclenche une exception ou retourne Y_CALLBACKMINDELAY_INVALID www.yoctopuce.com...
  • Page 147 Task<string> get_callbackSchedule( ) get_callbackSchedule( ) function get_callbackSchedule( ) async get_callbackSchedule( ) YNetwork target get_callbackSchedule Retourne : une chaîne de caractères représentant la planification des callbacks HTTP, sous forme de chaîne de caractères En cas d'erreur, déclenche une exception ou retourne Y_CALLBACKSCHEDULE_INVALID www.yoctopuce.com...
  • Page 148 Task<string> get_callbackUrl( ) get_callbackUrl( ) function get_callbackUrl( ) async 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 Y_CALLBACKURL_INVALID www.yoctopuce.com...
  • Page 149 Task<string> get_defaultPage( ) get_defaultPage( ) function get_defaultPage( ) async 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 Y_DEFAULTPAGE_INVALID www.yoctopuce.com...
  • Page 150 ) YNetwork target get_discoverable Retourne : soit Y_DISCOVERABLE_FALSE , soit Y_DISCOVERABLE_TRUE , 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 Y_DISCOVERABLE_INVALID www.yoctopuce.com...
  • Page 151 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.
  • Page 152 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.
  • Page 153 (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 Y_FRIENDLYNAME_INVALID www.yoctopuce.com...

  • Page 154: Network→Get_Functiondescriptor()

    é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...

  • Page 155: Retourne L'identifiant Matériel De L'interface Réseau, Sans Référence Au Module

    ) As String string get_functionId( ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async 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 Y_FUNCTIONID_INVALID www.yoctopuce.com...

  • Page 156: Network→Get_Hardwareid()

    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 : RELAYLO1-123456.relay1 une chaîne de caractères identifiant l'interface réseau (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...

  • Page 157: Retourne Le Port Tcp Utilisé Pour L'interface Web Du Hub

    Task<int> get_httpPort( ) get_httpPort( ) function get_httpPort( ) async 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 Y_HTTPPORT_INVALID www.yoctopuce.com...

  • Page 158: Retourne L'adresse Ip Utilisée Par Le Module Yoctopuce

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

  • Page 159: Retourne La Configuration Ip De L'interface Réseau

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

  • Page 160: Network→Get_Logicalname()

    String get_logicalName( ) java async Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async 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 Y_LOGICALNAME_INVALID www.yoctopuce.com...

  • Page 161: Network→Get_Macaddress()

    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 Y_MACADDRESS_INVALID www.yoctopuce.com...
  • Page 162 11. 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 function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )

  • Page 163: Retourne L'objet Ymodule Correspondant Au Module Yoctopuce Qui Héberge La Fonction

    11. 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 164 ) async 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 Y_NTPSERVER_INVALID www.yoctopuce.com...

  • Page 165: Network→Get_Poecurrent()

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

  • Page 166: Network→Get_Primarydns()

    ) function get_primaryDNS( ) async 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 Y_PRIMARYDNS_INVALID www.yoctopuce.com...
  • Page 167 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 : une valeur parmi Y_READINESS_DOWN Y_READINESS_EXISTS Y_READINESS_LINKED Y_READINESS_LAN_OK Y_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 Y_READINESS_INVALID www.yoctopuce.com...
  • Page 168 Task<string> get_router( ) get_router( ) function get_router( ) async 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 Y_ROUTER_INVALID www.yoctopuce.com...

  • Page 169: Network→Get_Secondarydns()

    ) function get_secondaryDNS( ) async 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 Y_SECONDARYDNS_INVALID www.yoctopuce.com...

  • Page 170: Network→Get_Serialnumber()

    Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async 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 YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...

  • Page 171: Network→Get_Subnetmask()

    Task<string> get_subnetMask( ) get_subnetMask( ) function get_subnetMask( ) async 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 Y_SUBNETMASK_INVALID www.yoctopuce.com...
  • Page 172 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...

  • Page 173: Network→Get_Userpassword()

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

  • Page 174: Network→Get_Wwwwatchdogdelay()

    Une valeur nulle désactive le redémarrage automatique en cas de perte de connectivité WWW. Retourne : un entier représentant la durée de perte de connection WWW tolérée (en secondes) avant de déclancher un redémarrage automatique pour tenter de récupérer la connectivité Internet En cas d'erreur, déclenche une exception ou retourne Y_WWWWATCHDOGDELAY_INVALID www.yoctopuce.com...

  • Page 175: Network→Isonline()

    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 si l'interface réseau est joignable, false sinon www.yoctopuce.com...
  • Page 176 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...

  • Page 177: Network→Isreadonly()

    ) 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 178 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 179 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 180 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 181: Network→Mutevaluecallbacks()

    é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 182: Network→Nextnetwork()

    ) nextNetwork( ) Si vous souhaitez retrouver une interface réseau spécifique, utilisez Network.findNetwork() avec un hardwareID ou un nom logique. Retourne : un pointeur sur un objet YNetwork accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...

  • Page 183: Ping L'adresse Choisie Pour Vérifier La Connexion Réseau

    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 184: Enregistre La Fonction De Callback Qui Est Appelée À Chaque Changement De La Valeur Publiée

    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 185 "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 186 être préservé. 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 187 Y_CALLBACKENCODING_JSON_NUM Y_CALLBACKENCODING_EMONCMS Y_CALLBACKENCODING_AZURE Y_CALLBACKENCODING_INFLUXDB Y_CALLBACKENCODING_MQTT Y_CALLBACKENCODING_YOCTO_API_JZON Y_CALLBACKENCODING_PRTG 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 188 être préservé. 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 189 être préservé. 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 190 Y_CALLBACKMETHOD_GET une valeur parmi Y_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 191 être préservé. 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 192 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 193 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 194 être préservé. 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 195 , 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 196 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 saveToFlash() du module si le réglage doit être préservé.
  • Page 197 ê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 198 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 199 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 200 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 201 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 202 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 203 "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 204 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 205 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 206 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 207 Par exemple, la valeur 24 représente 255.255.255.0. fallbackRouter adresse de la passerelle à utiliser si aucun serveur DHCP ne répond Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 208 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 209 à 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 210 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 211: Interface De La Fonction Files

    11. Référence de l'API de haut niveau 11.4. Interface de la fonction Files La class YFiles permet d'accéder au système de fichier embarqué sur certains modules Yoctopuce, par exemple avec un YoctoHub-Ethernet, un Yocto-Color-V2, un YoctoHub-Wireless-g ou un Yocto-RS232. Le stockage de fichiers permet par exemple de personnaliser un service web (dans le cas d'un module connecté...
  • Page 212 Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier. files→get_logicalName() Retourne le nom logique du système de fichier. files→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. files→get_serialNumber() Retourne le numéro de série du module, préprogrammé...
  • Page 213 Réactive l'envoi de chaque changement de la valeur publiée au hub parent. files→upload(pathname, content) Télécharge un contenu vers le système de fichier, au chemin d'accès spécifié. files→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 214 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple func YHUBETH1.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 215 Paramètres : yctx un contexte YAPI une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple func YHUBETH1.files Retourne : un objet de classe YFiles qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 216 YFiles.nextFiles() Retourne : YFiles un pointeur sur un objet , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de système de fichier disponibles. www.yoctopuce.com...
  • Page 217 YFiles.nextFiles() Paramètres : un contexte YAPI. yctx Retourne : YFiles un pointeur sur un objet , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de système de fichier disponibles. www.yoctopuce.com...
  • Page 218 ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du système de fichier. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 219 î 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 220 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 221 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 222 $filename) async fileExist( filename) 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 223 ) async 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 224 ) function get_advertisedValue( ) async get_advertisedValue( ) YFiles target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du système de fichier (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 225 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 226 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 227 Task<int> get_filesCount( ) get_filesCount( ) function get_filesCount( ) async get_filesCount( ) YFiles target get_filesCount Retourne : un entier représentant le nombre de fichiers présents dans le système de fichier En cas d'erreur, déclenche une exception ou retourne Y_FILESCOUNT_INVALID www.yoctopuce.com...
  • Page 228 ) function get_freeSpace( ) async get_freeSpace( ) YFiles target get_freeSpace Retourne : un entier représentant l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets En cas d'erreur, déclenche une exception ou retourne Y_FREESPACE_INVALID www.yoctopuce.com...
  • Page 229 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le système de fichier en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 230 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 231 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async 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 Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 232 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du système de fichier (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le système de fichier (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 233 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 234 Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YFiles target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du système de fichier. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 235 11. 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 function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 236 11. 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 237 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async get_serialNumber( ) YFiles target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 238 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 239 Si les valeurs des attributs en cache du système de fichier sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le système de fichier est joignable, false sinon www.yoctopuce.com...
  • Page 240 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 241 ) 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 242 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 243 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 244 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 245 é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 246 ) nextFiles( ) Si vous souhaitez retrouver un système de fichier spécifique, utilisez avec un Files.findFiles() hardwareID ou un nom logique. Retourne : un pointeur sur un objet YFiles accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 247 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 248 é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 249 ê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 250 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 251 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 252 Paramètres : pathname nom complet du fichier, y compris le chemin d'accès. 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 253 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 254: Interface De La Fonction Horloge Temps Real

    11. Référence de l'API de haut niveau 11.5. Interface de la fonction Horloge Temps Real La classe YRealTimeClock permet d'accéder à l'horloge embarquée sur certains modules Yoctopuce, par exemple avec un YoctoHub-Wireless-g, un YoctoHub-GSM-3G-NA, un YoctoHub-GSM-3G-EU ou un YoctoHub-Wireless-SR. Elle fournit la date et l'heure courante de manière persistante, même en cas de coupure de courant de plusieurs jours.
  • Page 255 Retourne l'identifiant matériel unique de l'horloge au format realtimeclock→get_logicalName() Retourne le nom logique de l'horloge. realtimeclock→get_module() YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. realtimeclock→get_module_async(callback, context) YModule Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. realtimeclock→get_serialNumber() Retourne le numéro de série du module, préprogrammé...
  • Page 256 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 257 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence l'horloge sans ambiguïté, par exemple func YHUBWLN3.realTimeClock Retourne : YRealTimeClock un objet de classe qui permet ensuite de contrôler l'horloge. www.yoctopuce.com...
  • Page 258 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'horloge sans ambiguïté, par exemple YHUBWLN3.realTimeClock Retourne : un objet de classe YRealTimeClock qui permet ensuite de contrôler l'horloge. www.yoctopuce.com...
  • Page 259 FirstRealTimeClock( ) Utiliser la fonction pour itérer sur les autres horloge. YRealTimeClock.nextRealTimeClock() Retourne : YRealTimeClock un pointeur sur un objet , correspondant à la première horloge accessible en ligne, ou null si il n'y a pas de horloge disponibles. www.yoctopuce.com...
  • Page 260 YRealTimeClock.nextRealTimeClock() Paramètres : un contexte YAPI. yctx Retourne : YRealTimeClock un pointeur sur un objet , correspondant à la première horloge accessible en ligne, ou null si il n'y a pas de horloge disponibles. www.yoctopuce.com...
  • Page 261 ) void clearCache( ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes de l'horloge. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 262 î n e c a r a c t è r e s d é c r i v a n t l ' h o r l o g e ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 263 Task<string> get_advertisedValue( ) get_advertisedValue( ) function get_advertisedValue( ) async get_advertisedValue( ) YRealTimeClock target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante de l'horloge (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 264 String get_dateTime( ) java async Task<string> get_dateTime( ) get_dateTime( ) function get_dateTime( ) async get_dateTime( ) YRealTimeClock target get_dateTime Retourne : une chaîne de caractères représentant l'heure courante au format "AAAA/MM/JJ hh:mm:ss" En cas d'erreur, déclenche une exception ou retourne Y_DATETIME_INVALID www.yoctopuce.com...
  • Page 265 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'horloge.
  • Page 266 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'horloge.
  • Page 267 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'horloge en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 268 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 269 ) As String string get_functionId( ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'horloge (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 270 ) L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'horloge (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant l'horloge (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 271 String get_logicalName( ) java async Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YRealTimeClock target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'horloge. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 272 11. 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 function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 273 11. 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 274 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async 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 YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 275 ) function get_timeSet( ) async get_timeSet( ) YRealTimeClock target get_timeSet Retourne : soit Y_TIMESET_FALSE , soit Y_TIMESET_TRUE , selon vrai si l'horloge à été mise à l'heure, sinon faux En cas d'erreur, déclenche une exception ou retourne Y_TIMESET_INVALID www.yoctopuce.com...
  • Page 276 ) function get_unixTime( ) async get_unixTime( ) YRealTimeClock target get_unixTime Retourne : un entier représentant l'heure courante au format Unix (nombre de seconds secondes écoulées depuis le 1er janvier 1970) En cas d'erreur, déclenche une exception ou retourne Y_UNIXTIME_INVALID www.yoctopuce.com...
  • Page 277 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 278 ) function get_utcOffset( ) async get_utcOffset( ) YRealTimeClock target get_utcOffset Retourne : un entier représentant le nombre de secondes de décallage entre l'heure courante et l'heure UTC (time zone) En cas d'erreur, déclenche une exception ou retourne Y_UTCOFFSET_INVALID www.yoctopuce.com...
  • Page 279 Si les valeurs des attributs en cache de l'horloge sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si l'horloge est joignable, false sinon www.yoctopuce.com...
  • Page 280 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 281 ) 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 282 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 283 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 284 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 285 é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 286 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. RealTimeClock.findRealTimeClock() Retourne : un pointeur sur un objet YRealTimeClock accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 287 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 288 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique de l'horloge. 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 289 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 290 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 291 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 292 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 293 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...

  • Page 294: Interface De La Fonction Wakeupmonitor

    11.6. Interface de la fonction WakeUpMonitor La classe YWakeUpMonitor prend en charge le contrôle global de toutes les sources de réveil possibles ainsi que les mises en sommeil automatiques, par exemple avec un YoctoHub-Wireless-g, un YoctoHub-GSM-3G-NA, un YoctoHub-GSM-3G-EU ou un YoctoHub-Wireless-SR.
  • Page 295 Retourne l'identifiant matériel unique du moniteur au format wakeupmonitor→get_logicalName() Retourne le nom logique du moniteur. wakeupmonitor→get_module() Retourne l'objet YModule 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 296 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 297 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence le moniteur sans ambiguïté, par exemple func YHUBWLN3.wakeUpMonitor Retourne : YWakeUpMonitor un objet de classe qui permet ensuite de contrôler le moniteur. www.yoctopuce.com...
  • Page 298 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le moniteur sans ambiguïté, par exemple YHUBWLN3.wakeUpMonitor Retourne : un objet de classe YWakeUpMonitor qui permet ensuite de contrôler le moniteur. www.yoctopuce.com...
  • Page 299 FirstWakeUpMonitor( ) Utiliser la fonction pour itérer sur les autres YWakeUpMonitor.nextWakeUpMonitor() Moniteurs. Retourne : YWakeUpMonitor un pointeur sur un objet , correspondant au premier moniteur accessible en ligne, ou null si il n'y a pas de Moniteurs disponibles. www.yoctopuce.com...
  • Page 300 YWakeUpMonitor.nextWakeUpMonitor() Moniteurs. Paramètres : un contexte YAPI. yctx Retourne : YWakeUpMonitor un pointeur sur un objet , correspondant au premier moniteur accessible en ligne, ou null si il n'y a pas de Moniteurs disponibles. www.yoctopuce.com...
  • Page 301 ) void clearCache( ) java clearCache( ) function clearCache( ) async clearCache( ) Invalide le cache des valeurs courantes du moniteur. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 302 î 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 ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 303 Task<string> get_advertisedValue( ) get_advertisedValue( ) function get_advertisedValue( ) async get_advertisedValue( ) YWakeUpMonitor target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du moniteur (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 304 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du moniteur.
  • Page 305 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du moniteur.
  • Page 306 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le moniteur en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 307 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 308 ) As String string get_functionId( ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le moniteur (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 309 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du moniteur (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le moniteur (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 310 String get_logicalName( ) java async Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YWakeUpMonitor target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du moniteur. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 311 11. 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 function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 312 11. 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 313 ) java async Task<long> get_nextWakeUp( ) get_nextWakeUp( ) function get_nextWakeUp( ) async get_nextWakeUp( ) YWakeUpMonitor target get_nextWakeUp Retourne : un entier représentant la prochaine date/heure de réveil agendée (format UNIX) En cas d'erreur, déclenche une exception ou retourne Y_NEXTWAKEUP_INVALID www.yoctopuce.com...
  • Page 314 Task<int> get_powerDuration( ) get_powerDuration( ) function get_powerDuration( ) async get_powerDuration( ) YWakeUpMonitor target get_powerDuration Retourne : un entier représentant le temp d'éveil maximal en secondes avant de retourner en sommeil automatiquement En cas d'erreur, déclenche une exception ou retourne Y_POWERDURATION_INVALID www.yoctopuce.com...
  • Page 315 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async 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 YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 316 ) java async Task<int> get_sleepCountdown( ) get_sleepCountdown( ) function get_sleepCountdown( ) async get_sleepCountdown( ) YWakeUpMonitor target get_sleepCountdown Retourne : un entier représentant le temps avant le prochain sommeil En cas d'erreur, déclenche une exception ou retourne Y_SLEEPCOUNTDOWN_INVALID www.yoctopuce.com...
  • Page 317 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 318 Y _ W A K E U P R E A S O N _ E N D O F S L E E P Y _ W A K E U P R E A S O N _ E X T S I G 1 Y_WAKEUPREASON_SCHEDULE1 Y_WAKEUPREASON_SCHEDULE2 En cas d'erreur, déclenche une exception ou retourne Y_WAKEUPREASON_INVALID www.yoctopuce.com...
  • Page 319 ) As Integer int get_wakeUpState( ) int get_wakeUpState( ) java async Task<int> get_wakeUpState( ) get_wakeUpState( ) function get_wakeUpState( ) async get_wakeUpState( ) YWakeUpMonitor target get_wakeUpState Retourne : soit Y_WAKEUPSTATE_SLEEPING , soit Y_WAKEUPSTATE_AWAKE En cas d'erreur, déclenche une exception ou retourne Y_WAKEUPSTATE_INVALID www.yoctopuce.com...
  • Page 320 Si les valeurs des attributs en cache du moniteur sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true si le moniteur est joignable, false sinon www.yoctopuce.com...
  • Page 321 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 322 ) 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 323 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 324 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 325 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 326 é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 327 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. WakeUpMonitor.findWakeUpMonitor() Retourne : un pointeur sur un objet YWakeUpMonitor accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 328 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 329 ) java async Task<int> resetSleepCountDown( ) resetSleepCountDown( ) function resetSleepCountDown( ) async 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 330 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du moniteur. 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 331 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 332 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 333 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 334 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 335 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 336 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 337 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 338 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 339 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 340 ) int wakeUp( ) -(int) wakeUp function wakeUp( ): LongInt function wakeUp( ) As Integer int wakeUp( ) int wakeUp( ) java async Task<int> wakeUp( ) wakeUp( ) function wakeUp( ) async wakeUp( ) YWakeUpMonitor target wakeUp www.yoctopuce.com...

  • Page 341: Interface De La Fonction Wakeupschedule

    HTML: <script src="../../lib/yocto_wakeupschedule.js"></script> in node.js: require('yoctolib-es2017/yocto_wakeupschedule.js'); <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_proxy.cs import com.yoctopuce.YoctoAPI.YWakeUpSchedule; java import com.yoctopuce.YoctoAPI.YWakeUpSchedule; from yocto_wakeupschedule import * require_once('yocto_wakeupschedule.php'); YWakeUpSchedule.vi Fonction globales yFindWakeUpSchedule(func) Permet de retrouver un réveil agendé d'après un identifiant donné.
  • Page 342 Retourne les minutes de l'interval 30-59 de chaque heure où le réveil est actif. wakeupschedule→get_module() Retourne l'objet YModule 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 343 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 344 à l'initialisation de de l'application. Paramètres : une chaîne de caractères qui référence le réveil agendé sans ambiguïté, par exemple func YHUBWLN3.wakeUpSchedule1 Retourne : YWakeUpSchedule un objet de classe qui permet ensuite de contrôler le réveil agendé. www.yoctopuce.com...
  • Page 345 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 YHUBWLN3.wakeUpSchedule1 Retourne : un objet de classe YWakeUpSchedule qui permet ensuite de contrôler le réveil agendé. www.yoctopuce.com...
  • Page 346 Utiliser la fonction pour itérer sur les autres réveils YWakeUpSchedule.nextWakeUpSchedule() agendés. Retourne : YWakeUpSchedule un pointeur sur un objet , correspondant au premier réveil agendé accessible en ligne, ou null si il n'y a pas de réveils agendés disponibles. www.yoctopuce.com...
  • Page 347 YWakeUpSchedule.nextWakeUpSchedule() agendés. Paramètres : un contexte YAPI. yctx Retourne : YWakeUpSchedule un pointeur sur un objet , correspondant au premier réveil agendé accessible en ligne, ou null si il n'y a pas de réveils agendés disponibles. www.yoctopuce.com...
  • Page 348 ) java clearCache( ) function clearCache( ) 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 349 î 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 350 Task<string> get_advertisedValue( ) get_advertisedValue( ) function get_advertisedValue( ) async get_advertisedValue( ) YWakeUpSchedule target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du réveil agendé (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 351 ) function get_errorMessage( ) get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du réveil agendé.
  • Page 352 ) function get_errorType( ) get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du réveil agendé.
  • Page 353 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le réveil agendé en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne Y_FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 354 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 355 ) String get_functionId( ) java get_functionId( ) function get_functionId( ) async get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le réveil agendé (ex: En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 356 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du réveil agendé (par example RELAYLO1-123456.relay1 Retourne : RELAYLO1-123456.relay1 une chaîne de caractères identifiant le réveil agendé (ex: En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID www.yoctopuce.com...
  • Page 357 ) java async Task<int> get_hours( ) get_hours( ) function get_hours( ) async 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 Y_HOURS_INVALID www.yoctopuce.com...
  • Page 358 String get_logicalName( ) java async Task<string> get_logicalName( ) get_logicalName( ) function get_logicalName( ) async get_logicalName( ) YWakeUpSchedule target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du réveil agendé. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 359 ) s64 get_minutes( ) -(s64) minutes function get_minutes( ): 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( ) YWakeUpSchedule target get_minutes www.yoctopuce.com...
  • Page 360 Task<int> get_minutesA( ) get_minutesA( ) function get_minutesA( ) async get_minutesA( ) YWakeUpSchedule target get_minutesA Retourne : un entier représentant les minutes de l'interval 00-29 de chaque heures où le réveil est actif En cas d'erreur, déclenche une exception ou retourne Y_MINUTESA_INVALID www.yoctopuce.com...
  • Page 361 Task<int> get_minutesB( ) get_minutesB( ) function get_minutesB( ) async get_minutesB( ) YWakeUpSchedule target get_minutesB Retourne : un entier représentant les minutes de l'interval 30-59 de chaque heure où le réveil est actif En cas d'erreur, déclenche une exception ou retourne Y_MINUTESB_INVALID www.yoctopuce.com...
  • Page 362 11. 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 function get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 363 11. 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 364 Task<int> get_monthDays( ) get_monthDays( ) function get_monthDays( ) async get_monthDays( ) YWakeUpSchedule target get_monthDays Retourne : un entier représentant les jours du mois où le réveil est actif En cas d'erreur, déclenche une exception ou retourne Y_MONTHDAYS_INVALID www.yoctopuce.com...
  • Page 365 ) java async Task<int> get_months( ) get_months( ) function get_months( ) async 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 Y_MONTHS_INVALID www.yoctopuce.com...
  • Page 366 ) java async Task<long> get_nextOccurence( ) get_nextOccurence( ) function get_nextOccurence( ) async get_nextOccurence( ) YWakeUpSchedule target get_nextOccurence Retourne : un entier représentant la date/heure de la prochaine occurence de réveil En cas d'erreur, déclenche une exception ou retourne Y_NEXTOCCURENCE_INVALID www.yoctopuce.com...
  • Page 367 Task<string> get_serialNumber( ) get_serialNumber( ) function get_serialNumber( ) async 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 YModule.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 368 ) Object get_userData( ) java get_userData( ) function get_userData( ) async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 369 Task<int> get_weekDays( ) get_weekDays( ) function get_weekDays( ) async get_weekDays( ) YWakeUpSchedule target get_weekDays Retourne : un entier représentant les jours de la semaine où le réveil est actif En cas d'erreur, déclenche une exception ou retourne Y_WEEKDAYS_INVALID www.yoctopuce.com...
  • Page 370 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 si le réveil agendé est joignable, false sinon www.yoctopuce.com...
  • Page 371 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 372 ) 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 373 Paramètres : msValidity un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes Retourne : YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 374 $attrName) async loadAttribute( attrName) Paramètres : attrName le nom de l'attribut désiré Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 375 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 376 é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 377 é c i f i q u e , u t i l i s e z avec un hardwareID ou un nom logique. WakeUpSchedule.findWakeUpSchedule() Retourne : un pointeur sur un objet YWakeUpSchedule accessible en ligne, ou null lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 378 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 379 être préservé. 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 380 ê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 381 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 382 être préservé. 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 383 être préservé. 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 384 être préservé. 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 385 être préservé. 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 386 Object data) java set_userData( data) function set_userData( $data) async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 387 être préservé. 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 388 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 389 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback Retourne : rien du tout. www.yoctopuce.com...
  • Page 390 www.yoctopuce.com...

  • Page 391: Problèmes Courants

    12.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 12.2.

  • Page 392: Plateformes Arm: Hf Et El

    12.5. Module alimenté mais invisible pour l'OS Si votre YoctoHub-Wireless-g 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 393: Déconnexions, Comportement Erratique

    Le but du YoctoHub-Wireless-g 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-Wireless-g 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 394 www.yoctopuce.com...

  • Page 395: Caractéristiques

    13. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module YoctoHub-Wireless-g Identifiant produit YHUBWLN3 † Rev. C Révision matérielle Connecteur USB micro-B Epaisseur 8.1 mm Largeur 58 mm Longueur 60 mm Poids 34 g Classe de protection IEC classe III Temp.
  • Page 396 13. Caractéristiques www.yoctopuce.com...