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
5. Utilisation du YoctoHub-Wireless-g
5.1 Localisation des modules
5.2 Test des modules
5.3 Configuration des modules
5.4 Upgrades des firmwares
6. Contrôle d'accès
6.1 Accès "admin" protégé
6.2 Accès "user" protégé
6.3 Influence sur les API
6.4 Effacement des mots de passe
7. Interactions avec l'extérieur
7.1 Configuration
7.2 Emoncms
7.3 Valarm.net
7.4 ThinkSpeak
7.5 Microsoft Azure
7.6 Xively (anciennement Cosm)
7.7 InfluxDB
7.8 Yocto-API callback
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
10. Personnalisation de l'interface Web
10.1 Utilisation
10.2 Limitations
11. Référence de l'API de haut niveau
11.1 Interface d'un port de Yocto-hub
11.2 Interface de la fonction Wireless
11.3 Interface de la fonction Network
11.4 Interface de la fonction Files
11.5 Interface de la fonction Horloge Temps Real
11.6 Interface de la fonction WakeUpMonitor
11.7 Interface de la fonction WakeUpSchedule
12. Problèmes courants
12.1 Par où commencer ?
12.2 Linux et USB
12.3 Plateformes ARM: HF et EL
12.4 Les exemples de programmation n'ont pas l'air de marcher
12.5 Module alimenté mais invisible pour l'OS
12.6 Another process named xxx is already using yAPI
12.7 Déconnexions, comportement erratique
12.8 Impossible de contacter les sous-devices par USB
12.9 Module endommagé
13. Caractéristiques
14. Index

1. Introduction

Le YoctoHub-Wireless-g est un module électronique de 60x58mm qui permet de contrôler d'autres modules Yoctopuce à travers une connection réseau sans fil. Vu de l'extérieur, ce module se comporte exactement comme un ordinateur classique faisant tourner un VirtualHub¹: même interface, mêmes fonctionnalités.

Le YoctoHub-Wireless-g

Le YoctoHub-Wireless-g a été conçu pour être déployé facilement et ne pas demander de maintenance particulière. Contrairement à un mini-PC, il n'utilise pas un système d'exploitation complexe. Quelques réglages simples permettent son utilisation dans toutes sortes d'environnements réseau. Ces réglages peuvent être effectués manuellement ou de manière automatisée, par USB. Il convient de ce fait beaucoup mieux à une industrialisation qu'un mini-PC. En revanche, il ne permet pas l'exécution de programmes supplémentaires écrits par l'utilisateur.

Le YoctoHub-Wireless-g n'est pas un hub USB standard avec accès réseau. Bien qu'utilisant du câblage USB, ses ports descendants utilisent un protocole propriétaire, plus simple qu'USB. Il n'est par conséquent pas possible de contrôler, ni même d'alimenter, des périphériques USB standards avec un YoctoHub-Wireless-g.

Yoctopuce vous remercie d'avoir fait l'acquisition de ce YoctoHub-Wireless-g et espère sincèrement qu'il vous donnera entière satisfaction. 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².

2. Présentation

1:	Yocto-bouton	9:	Neutralisatation de la mise en sommeil
2:	Port USB de contrôle + alimentation	10:	Connexion dorsale
3:	Yocto-Led	11:	Port descendant 1
4:	Indicateur de sur-consommation	12:	Indicateur port descendant 1
5:	Indicateur de transfert réseau	13:	Port descendant 2
6:	Touche réveil	14:	Indicateur port descendant 2
7:	Touche mise en sommeil	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. Ce numéro de série ne peut pas être changé.

Le nom logique

Le nom logique est similaire au numéro de série, c'est une chaîne de caractères sensée être unique qui permet référencer le module par logiciel. Cependant, contrairement au numéro de série, le nom logique peut être modifié à volonté. L'intérêt est de pouvoir fabriquer plusieurs exemplaires du même projet sans avoir à modifier le logiciel de pilotage. Il suffit de programmer les mêmes noms logiques dans chaque exemplaire. Attention, le comportement d'un projet devient imprévisible s'il contient plusieurs modules avec le même nom logique et que le logiciel de pilotage essaye d'accéder à l'un de ces modules à l'aide de son nom logique. A leur sortie d'usine, les modules n'ont pas de nom logique assigné, c'est à vous de le définir.

Le Yocto-bouton

Le Yocto-bouton a deux fonctions. Premièrement, il permet d'activer la Yocto-balise (voir la Yocto-Led ci-dessous). Deuxièmement, si vous branchez un Yocto-module en maintenant ce bouton appuyé, il vous sera possible de reprogrammer son firmware avec une nouvelle version. Notez qu'il existe une méthode plus simple pour mettre à jour le firmware depuis l'interface utilisateur, mais cette méthode-là peut fonctionner même lorsque le firmware chargé sur le module est incomplet ou corrompu.

La Yocto-Led

En temps normal, la Yocto-Led sert à indiquer le bon fonctionnement du module: elle émet alors une faible lumière bleue qui varie lentement mimant ainsi une respiration. La Yocto-Led cesse de respirer lorsque le module ne communique plus, par exemple s'il est alimenté par un hub sans connexion avec un ordinateur allumé.

Lorsque vous appuyez sur le Yocto-bouton, la Led passe en mode Yocto-balise: elle se met alors à flasher plus vite et beaucoup plus fort, dans le but de permettre une localisation facile d'un module lorsqu'on en a plusieurs identiques. Il est en effet possible de déclencher la Yocto-balise par logiciel, tout comme il est possible de détecter par logiciel une Yocto-balise allumée.

La Yocto-Led a une troisième fonctionnalité moins plaisante: lorsque le logiciel interne qui contrôle le module rencontre une erreur fatale, elle se met à flasher SOS en morse³. Dans ce cas, débranchez puis re-branchez le module. Si le problème venait à se reproduire, vérifiez que le module contient bien la dernière version du firmware et, dans l'affirmative, contactez le support Yoctopuce⁴.

Le connecteur de contrôle et d'alimentation (Power / Control port)

Ce connecteur permet d'alimenter le YoctoHub-Wireless-g et les modules qui lui sont connectés à l'aide d'un simple chargeur USB. Ce connecteur permet aussi de prendre le contrôle du YoctoHub-Wireless-g par USB, exactement comme on pourrait le faire avec un module Yoctopuce classique. C'est particulièrement utile lorsque que l'on désire configurer le YoctoHub-Wireless-g sans connaître son adresse IP.

Les ports descendants

Vous pouvez connecter jusqu'à trois modules Yoctopuce sur ces ports. Ils seront alors accessibles comme s'ils étaient branchés à un ordinateur faisant tourner un VirtualHub. Attention, le protocole entre le YoctoHub-Wireless-g et le module Yoctopuce n'est pas de l'USB mais un protocole propriétaire plus léger. De ce fait le YoctoHub-Wireless-g ne peut pas gérer des périphériques autres que des modules Yoctopuce. Un hub USB standard ne fonctionnera pas non plus⁵. Si vous désirez brancher plus de trois modules Yoctopuce, utilisez le connecteur dorsal pour y connecter un ou plusieurs YoctoHub-Shield⁶.

Attention, les connecteurs USB du YoctoHub-Wireless-g sont simplement soudés en surface et peuvent être arrachés si la prise USB venait à faire fortement levier. Si les pistes sont restées en place, le connecteur peut être ressoudé à l'aide d'un bon fer et de flux. Alternativement, vous pouvez souder un fil USB directement dans les trous espacés de 1.27mm prévus à cet effet, près du connecteur.

Le connecteur d'antenne

Le YoctoHub-Wireless-g dispose d'un connecteur d'antenne coaxial ultra miniature (UFL). Prenez soin du connecteur 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). Vous pouvez utiliser une autre antenne de votre choix, pour autant qu'elle soit conçue pour la gamme de fréquence 2.4 GHz et qu'elle ait le bon connecteur. Méfiez vous des différentes variantes de connecteurs SMA: il existe des antennes pour chacune des quatre combinaisons SMA/RP-SMA et mâle/femelle, mais seule une antenne RP-SMA mâle est utilisable avec le câble d'antenne fourni. Prenez garde aussi au fait que l'utilisation d'antennes à fort gain peut vous amener à émettre un signal supérieur à la norme autorisée dans votre pays.

Connexion de l'antenne.

-

Indicateur de sur-consommation

Le YoctoHub-Wireless-g analyse en permanence sa consommation. S'il détecte une consommation globale de plus de 2A suite à une surcharge sur un des ports descendants par exemple, il va automatiquement désactiver tous les ports descendants et allumer l'indicateur de sur-consommation. Pour isoler la source du problème, vous pouvez réactiver les ports un à un, en surveillant l'augmentation de la consommation. Alternativement, si connaissez la source du problème de sur-consommation et savez l'avoir résolu, vous pouvez redémarrer le YoctoHub-Wireless-g pour réactiver tous les ports.

Notez que l'indicateur de sur-consommation est une mesure de protection qui peut éviter la surchauffe, mais ce n'est pas une garantie de protection contre les court- circuits.

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é). Cette fonctionnalité est très utile pour construire des installations de mesure fonctionnant sur batterie. Lorsque que le YoctoHub-Wireless-g est en sommeil, la quasi totalité de l'électronique du module ainsi que les modules Yoctopuce connectés sont hors tension, ce qui réduit sa consommation totale à 75 µW (15 µA).

La mise en sommeil et le réveil peuvent être soit programmés sur base horaire, soit contrôlés par logiciel, soit contrôlés manuellement à l'aide de deux boutons poussoirs présents sur le circuit du YoctoHub-Wireless-g. Vous y trouverez aussi deux paires de contacts qui permettent de dériver ces deux boutons.

Dérivation des boutons de mise en sommeil et de réveil.

Le YoctoHub-Wireless-g dispose d'un interrupteur qui permet de désactiver au niveau hardware la fonctionnalité de mise en sommeil. Cette fonctionnalité est utile en particulier durant les phases de développement/déverminage de votre projet, ainsi que pour effectuer les mises à jour du firmware.

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. Vous aurez besoin d'un câble USB A-MicroB.

Configuration: raccordez par USB votre YoctoHub-Wireless-g à un ordinateur

Lancez alors votre browser favori sur l'url de votre VirtualHub. Il s'agit généralement http://127.0.0.1:4444. Vous obtiendrez la liste des modules Yoctopuce connectés par USB, dont votre YoctoHub-Wireless-g

Liste des modules Yoctopuce raccordés par USB à votre ordinateur, dont votre YoctoHub-Wireless-g

Cliquez sur le bouton configure correspondant à votre YoctoHub-Wireless-g, votre obtiendrez la fenêtre de configuration du module. Cette fenêtre comporte une section Network configuration.

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:

Fenêtre de configuration du réseau sans fil.

Vous pouvez alors choisir si vous souhaitez connecter votre YoctoHub-Wireless-g à un reseau existant, ou si vous préférez entrer manuellement le SSID du réseau que vous voulez utiliser.

Vous pouvez aussi configurez le YoctoHub-Wireless-g pour qu'il génère son propre réseau sans fil en mode Software enabled Access Point (SoftAP). Vous pourrez alors vous connecter directement sur le YoctoHub-Wireless-g sans avoir a passer par un serveur d'infrastructure (point d'accès). Soyez toutefois conscients que ce mode de fonctionnement SoftAP a des limitations par rapport à un vrai réseau WiFi. En particulier il n'est pas possible d'avoir plus que quatre clients connectés au réseau en même temps.

Après avoir entré les paramètres de réseau sans fil et éventuellement les avoir testés, vous pouvez cliquer sur le bouton Ok pour fermer cette fenêtre de configuration et retourner à la fenêtre de configuration générale.

Vous pouvez aussi, en cas de besoin, configurer quelle adresse IP doit être attribuée au YoctoHub-Wireless-g. Pour ce faire, cliquez sur le bouton edit en face de la ligne ip adressing.

Vous pouvez choisir si l'adresse IP de votre YoctoHub-Wireless-g doit être attribuée par DHCP ou si elle doit être fixe. L'option DHCP est recommandée dans la mesure où cette fonctionnalité est supportée par la plupart des boîtiers ADSL (c'est la configuration par défaut). Si vous ne savez pas ce qu'est un serveur DCHP mais avez l'habitude de brancher des appareils sur votre réseau et de les voir marcher sans problème, ne touchez à rien.

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. Ces modifications étant sauvées dans la mémoire persistante du YoctoHub-Wireless-g, il s'en rappellera même après avoir été privé de courant.

Cliquez sur le numéro de série correspondant à votre YoctoHub-Wireless-g. Cela ouvrira la fenêtre détails de votre module:

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:

• 0- search for link: Le module cherche une liaison réseau. Si cet état persiste, il est probable que le réseau wifi recherché n'est pas à proximité
• 1- network exists: le réseau wifi recherché a été détecté
• 2- network linked: le YoctoHub-Wireless-g a pu se connecter au réseau.
• 3- LAN ready: le réseau local est opérationnel (adresse IP obtenue)
• 4- WWW ready: le module a pu vérifier la connectivité à Internet en se connectant à un serveur de temps (NTP).

Après avoir vérifié que votre module a bien une adresse IP valide, vous pouvez fermer la fenêtre détails, arrêter votre VirtualHub et débrancher le câble USB de contrôle de votre ordinateur: il suffira que le module soit alimenté pour l'utiliser.

Vous pouvez désormais accéder à votre YoctoHub-Wireless-g en tapant directement son adresse IP dans la barre d'adresse de votre browser favori. Le module répond au port HTTP standard, mais aussi au port 4444 utilisé par le VirtualHub. Si l'adresse IP de votre module est 192.168.0.10, vous pourrez donc le joindre avec l'URL http://192.168.0.10.

Vous obtiendrez alors directement l'interface du YoctoHub-Wireless-g. Cette interface est en tout point identique à celle du VirtualHub. Vous retrouvez le YoctoHub-Wireless-g sur la première ligne et les modules connectés au YoctoHub-Wireless-g sur les suivantes.

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 et Linux. Notez que cette technique est limitée au sous-réseau du YoctoHub-Wireless-g. Si vous voulez contacter le module par nom depuis un autre réseau, vous devez utiliser une infrastructure DNS classique.

3.2. Configuration automatisée

Il est possible d'industrialiser la configuration réseau du YoctoHub-Wireless-g. Vous trouverez dans les chapitres suivants de cette documentation la description des fonctions de programmation permettant de relire l'adresse Ethernet d'un module (adresse MAC), et de configurer tous ses paramètres réseau.

Les fonctions de configuration réseau sont aussi accessibles par ligne de commande, en utilisant l'utilitaire YNetwork disponible dans la librairie de programmation en ligne de commande⁸.

Après avoir effectué un changement de réglage par programmation, prenez garde à appeler la fonction saveToFlash() pour vous assurez que les réglages soient sauvés de manière permanente dans la mémoire flash du module.

3.3. Connexions

Alimentation

Le YoctoHub-Wireless-g doit être alimenté par la prise USB de contrôle.

USB

Branchez simplement un chargeur USB dans le port power / control port, assurez-vous tout de même que le chargeur soit d'une puissance électrique suffisante: le YoctoHub-Wireless-g consomme environ 160mA, auxquels il faudra ajouter la consommation de chaque sous-module. Le YoctoHub-Wireless-g est conçu pour gérer 2A au maximum, c'est pourquoi un chargeur USB capable de délivrer au moins 2A est recommandé. Par ailleurs, vous devrez veiller à ce que la consommation totale de l'ensemble hub + sous-modules ne dépasse pas cette limite.

Le YoctoHub-Wireless-g peut être alimenté par un chargeur USB

Sous-modules

Le YoctoHub-Wireless-g est capable de piloter tous les modules Yoctopuce de la gamme Yocto. Ces modules peuvent êtres connectés directement aux ports descendants, ils seront détectés automatiquement. Vous aurez besoin pour cela de câbles USB MicroB-MicroB. Vous pouvez utiliser des câbles OTG ou non, cela n'a pas d'importance.

Connexion des sous-modules à l'aide de câbles USB

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. Si vous choisissez cette dernière option, il est recommandé d'utiliser du câble plat mono-brin, moins souple que le multi-brin mais beaucoup plus facile à souder. Soyez particulièrement attentif aux polarités: Le YoctoHub-Wireless-g, tout comme l'ensemble de modules de la gamme Yoctopuce, n'est pas protégé contre les inversions de polarité. Une telle inversion a toutes les chances de détruire vos équipements. Assurez-vous que la position du contact carré de part et d'autre du câble correspondent.

Connexion des sous-modules à l'aide de câble nappe

Le YoctoHub-Wireless-g est conçu pour que vous puissiez fixer un module simple largeur directement dessus. 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. En effet le protocole utilisé entre le YoctoHub-Wireless-g et les sous-modules n'est pas de l'USB mais un protocole propriétaire, beaucoup plus léger. Si d'aventure vous branchez un périphérique autre qu'un module Yoctopuce sur un des ports descendants du YoctoHub-Wireless-g, le port en question sera automatiquement désactivé pour éviter d'endommager le périphérique.

4. Montage

Ce chapitre fournit des explications importantes pour utiliser votre module YoctoHub-Wireless-g en situation réelle. Prenez soin de le lire avant d'aller trop loin dans votre projet si vous voulez éviter les mauvaises surprises.

4.1. Fixation

Pendant la mise au point de votre projet, vous pouvez vous contenter de laisser le hub se promener au bout de son câble. Veillez simplement à ce qu'il ne soit pas en contact avec quoi que soit de conducteur (comme vos outils). Une fois votre projet pratiquement terminé, il faudra penser à faire en sorte que vos modules ne puissent pas se promener à l'intérieur.

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.

Veillez à que l'électronique module ne soit pas en contact avec le support. La méthode recommandée consiste à utiliser des entretoises. Vous pouvez monter le module dans le sens qui vous convient: mais vous devez conscient du fait que les composants électroniques du YoctoHub-Wireless-g, la partie réseau en particulier, dégagent de la chaleur. Vous devrez donc faire en sorte que la chaleur ne puisse pas s'accumuler.

4.2. Fixation d'un sous-module

Le YoctoHub-Wireless-g est conçu pour que vous puissiez visser un module simple largeur directement dessus. Par simple largeur, on entend les modules de 20 mm de large. Tous les modules simple largeur ont leurs 5 trous de fixation et le connecteur USB au même endroit. Le sous-module peut être fixé à l'aide de vis et d'entretoises. Il y a derrière les connecteurs USB du YoctoHub-Wireless-g et du sous-module un ensemble de 4 contacts qui permettent d'effectuer la connexion électrique entre le hub et le sous-module. Si vous ne vous sentez pas suffisamment à l'aise avec un fer à souder, vous pouvez aussi aussi utiliser un simple câble USB MicroB-MicroB, OTG ou non.

Fixation d'un module directement sur le hub

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é du connecteur sera inversée et vous risquez fort d'endommager définitivement votre matériel.

Tous les accessoires nécessaires à la fixation d'un module sur votre YoctoHub-Wireless-g sont relativement courants. Vous pourrez les trouver sur le site de Yoctopuce tout comme sur la plupart des sites vendant du matériel électronique. Attention cependant, la tête des vis servant à fixer le sous-module devra avoir un diamètre maximum de 4.5 millimètres, sous peine d'endommager les composants électroniques.

5. Utilisation du YoctoHub-Wireless-g

Outre fournir un accès réseau aux module Yoctopuce, le YoctoHub-Wireless-g permet de tester et configurer vos modules Yoctopuce. Pour ce faire connectez-vous sur votre YoctoHub-Wireless-g à l'aide de votre navigateur internet favori¹¹. Utilisez l'adresse IP du YoctoHub-Wireless-g ou encore son nom réseau, par exemple http://192.168.0.10. Une liste comprenant votre YoctoHub-Wireless-g ainsi que les modules qui lui sont connectés devrait apparaître.

Interface Web du YoctoHub-Wireless-g.

5.1. Localisation des modules

L'interface principale vous montre une ligne par module connecté, si vous avez plusieurs modules du même modèle, vous pouvez localiser un module particulier en cliquant sur le bouton beacon correspondant: cela aura pour effet de faire clignoter la Led bleue du module et d'afficher sur l'interface une pastille bleue au début de la ligne correspondante. Vous pouvez faire la même manipulation en appuyant sur le Yocto-bouton d'un module connecté.

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.

5.2. Test des modules

Pour tester un module, cliquez simplement sur le numéro de série d'un module dans l'interface, une fenêtre spécifique au module s'ouvrira. Cette fenêtre permet généralement d'activer les fonctions principales du module. Reportez-vous au manuel du module correspondant pour plus de détails.¹²

Fenêtre "détails" du module Yocto-Demo, obtenue via l'interface du YoctoHub-Wireless-g.

5.3. Configuration des modules

Vous pouvez configurer un module en cliquant sur le bouton Configure correspondant dans l'interface principale, une fenêtre spécifique au module s'ouvre alors. Cette fenêtre permet au minimum de donner un nom logique au module ainsi que de mettre à jour son firmware. Reportez-vous au manuel du module correspondant pour plus de détails.

Fenêtre "configure" du module Yocto-Demo.

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). Des nouveaux firmwares pour chaque module sont régulièrement publiés, ils permettent généralement d'ajouter de nouvelles fonctionnalités au module, et/ou de corriger d'éventuels bugs¹³.

Pour mettre à jour le firmware d'un module, vous devez d'abord vous procurer le firmware, il peut être téléchargé depuis la page produit du module sur le site de Yoctopuce ¹⁴. L'interface propose aussi un lien direct si elle détecte que le firmware n'est pas à jour¹⁵. Ces firmwares se présentent sous la forme de fichiers .byn de quelques dizaines de Kilo-octets, sauvez celui qui vous intéresse sur votre disque local.

Fenêtre de mise à jour du firmware.

Une fois votre fichier de firmware disponible localement, ouvrez la fenêtre configuration d'un module et cliquez sur le bouton upgrade. L'interface va vous demander de choisir le fichier de firmware que vous désirez utiliser. Entrez le nom du fichier et cliquez sur Upload. A partir de là, tout est automatique, le YoctoHub-Wireless-g va faire redémarrer le module en mode "mise à jour", mettre à jour le firmware, puis redémarrer le module en mode normal. Les réglages de configuration du module seront préservés. Ne débranchez pas le module pendant la procédure de mise à jour.

Le firmware du YoctoHub-Wireless-g peut être mis à jour de la même manière

En cas de perte de contrôle pendant une mise à jour du firmware (panne de courant ou débranchement involontaire), il est toujours possible de forcer manuellement un rechargement du firmware, même si le sous-module n'apparaît même plus dans la fenêtre du YoctoHub-Wireless-g. Pour ce faire, débranchez le sous-module et rebranchez-le en maintenant le Yocto-bouton pressé. Le module démarrera alors dans le mode de mise à jour du firmware, et vous pourrez recommencer la procédure de chargement.

6. Contrôle d'accès

Le YoctoHub-Wireless-g vous permet d'instaurer un contrôle d'accès à vos modules Yoctopuce. 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.

La fenêtre de configuration du YoctoHub-Wireless-g

Ce contrôle d'accès est contrôlé depuis la section Incoming connections. Il peut se faire à deux niveaux distincts.

6.1. 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.

6.2. Accès "user" protégé

Le mot de passe user verrouille toute utilisation des modules. Lorsqu'il est configuré, toute utilisation sans mot de passe devient impossible. Les accès de type user ne permettent d'accéder aux modules qu'en lecture seule c'est-à-dire seulement pour consulter l'état des modules. Si vous instaurez simultanément un contrôle d'accès de type user et de type admin, les utilisateurs utilisant le login user ne pourront pas modifier la configuration des modules vus par ce YoctoHub-Wireless-g.

Si vous configurez un accès admin, sans configurer d'accès user, les utilisateurs pourront continuer à consulter vos modules en lecture sans avoir à entrer de mot de passe.

Pour configurer l'accès au YoctoHub-Wireless-g, cliquez sur le bouton edit des lignes Authentication to read the information from the devices ou Authentication to write information to the devices

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 RegisterHub(): vous devrez donner l'adresse du YoctoHub-Wireless-g sous la forme login:password@adresse:port, par exemple:

6.4. Effacement des mots de passe

Si vous perdez le mot passe de votre YoctoHub-Wireless-g, vous pouvez reprendre le contrôle de votre module en réinitialisant tous ses réglages à la valeur par défaut. Pour ce faire, procurez-vous un câble USB pour le YoctoHub-Wireless-g, et branchez-le à un ordinateur avec le VirtualHub¹⁶ installé en maintenant le Yocto-bouton pressé. Ceci va forcer le YoctoHub-Wireless-g à démarrer en mode de mise à jour du firmware. Il apparaît alors dans le VirtualHub en dessous de la liste des modules. Cliquez sur son numéro de série et choisissez un fichier de firmware à charger sur le module. Une fois le firmware rechargé avec cette méthode, le module sera réinitialisé avec les réglages d'usine, sans contrôle d'accès.

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.

7.1. Configuration

Pour utiliser cette fonctionnalité, cliquez simplement sur le bouton Configure de la ligne correspondant au YoctoHub-Wireless-g dans l'interface, puis cliquez sur le bouton edit de la section Outgoing callback.

Cliquez sur le bouton "Configure" de la première ligne

Puis éditez la section Outgoing callbacks.

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.

7.2. Emoncms

Emoncms.org est un service de cloud open-source gratuit où vous pouvez vous inscrire pour poster les données de vos capteurs, et qui vous permettra de les visualiser en temps réel par Internet et de tracer des graphiques d'historique, et ce sans écrire la moindre ligne de code. Il suffit d'indiquer dans le fenêtre de configuration votre clé d'API fournie par Emoncms, ainsi que le numéro de noeud (arbitraire) que vous désirez attribuer à votre YoctoHub-Wireless-g.

Il est aussi possible d'installer Emoncms sur votre propre serveur, afin de garder le contrôle sur vos données. Vous trouverez des explications plus détaillées sur le blog de Yoctopuce¹⁷.

Yoctopuce n'est en aucune manière affilié à Emoncms.org.

7.3. Valarm.net

Valarm est un service de cloud professionnel où vous pouvez vous inscrire pour poster les données de vos capteurs, et qui offre des fonctions avancées notemment pour la configuration à distance des modules Yoctopuce et la géolocalisation des mesures.

Valarm est revendeur des produits Yoctopuce, mais Yoctopuce n'est pas autrement affilié à Valarm.

7.4. ThinkSpeak

ThingSpeak¹⁸ est un autre service de cloud entièrement gratuit, qui permet non seulement de tracer des graphes de données, mais aussi de lancer certaines actions lorsque des conditions sur les mesures se réalisent. L'interface de ce service est un peu moins soignée que Emoncms, mais vous trouverez sur le blog de Yoctopuce¹⁹ comment configurer votre YoctoHub-Wireless-g pour poster des données directement sur ThingSpeak.

Yoctopuce n'est en aucune manière affilié à ThingSpeak.

7.5. Microsoft Azure

Azure est la plateforme de cloud de Microsoft, comprenant une collection de services intégrés - base de donnée, calculs, etc. Pour plus de détails, consulter le site azure.microsoft.com. Vous pouvez poster vos données directement sur un Service Mobile Azure, en utilisant l'API Rest NoSQL standard de Azure.

Yoctopuce n'est en aucune manière affilié à Microsoft.

7.6. Xively (anciennement Cosm)

Xively est un service de cloud payant où vous pourriez poster les données de vos capteurs. Notez que depuis la fin 2015, Xively concentre son activité sur les grosses entreprises et les clients OEM. De ce fait, le service Xively n'est plus forcément disponible pour n'importe qui. Pour plus de détails, consultez xively.com.

Yoctopuce n'est en aucune manière affilié à Xively.

7.7. InfluxDB

InfluxDB est une base de données dédiée spécifiquement à stocker des séries temporelles de mesures et d'événements. Elle est très efficace pour retrouver des séries de mesures pour une plage de temps donnée, y compris en les rassemblant pour en faire un résumé. Vous pouvez facilement l'installer sur votre propre ordinateur pour enregistrer vos données, et dessiner des graphiques. Vous trouverez un guide pas-à-pas pour configurer InfluxDB et Grafana avec les modules Yoctopuce sur le blog de Yoctopuce. ²⁰.

Yoctopuce n'est en aucune manière affilié à InfluxData ni à Grafana.

7.8. Yocto-API callback

Avec certains langages de programmation, l'API Yoctopuce est capable de fonctionner en mode callback HTTP. Dans ce mode un script sur le serveur web peut prendre le contrôle de vos modules à 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. Dans le script serveur, vous devez alors initialiser la librairie Yoctopuce avec l'appel suivant:

RegisterHub("http://callback");

Il existe deux possibilités pour utiliser l'API Yoctopuce enmode callback. La première, disponible en PHP, Java et Node.JS est basée sur des connections en pur HTTP. Le YoctoHub-Wireless-g poste l'intégralité de son état au serveur, et reçoit en retour des commandes du script sur le serveur. Ce fonctionnement implique quelques limitations: les intéractions complexes, comme la récupération de données depuis l'enregistreur de données sur les capteurs, ne sont pas possible.

Le deuxième mode fonctionnement de l'API par callback est l'utilisation des callbacks WebSocket. Ce mode est disponible uniquement avec les serveurs Java et Node.JS. Les WebSockets sont une extension standard de HTTP, qui permet l'établissement d'une liaison bidirectionnelle complète sur une liaison HTTP. Lorsqu'un script serveur est connecté à un YoctoHub-Wireless-g au travers d'un callback WebSocket, l'API Yoctopuce peut être utilisée sans la moindre limitation.

7.9. 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).

La fenêtre de configurations des callbacks

Si vous désirez protéger votre script de callback, vous pouvez configurer un contrôle d'accès HTTP standard sur le serveur Web. Le YoctoHub-Wireless-g sait comment gérer les méthodes standard d'identification de HTTP: indiquez simplement le nom d'utilisateur et le mot de passe nécessaires pour accéder à la page. Il est possible d'utiliser la méthode "Basic" aussi bien que la méthode "Digest", mais il est recommandé d'utiliser la méthode "Digest", car elle est basée sur un protocole de question-réponse qui évite la transmission du mot de passe sur le réseau et évite aussi les copies d'autorisation.

Le YoctoHub-Wireless-g poste avec la méthode POST les valeurs notifiées²¹ des modules à intervalle régulier, et à chaque fois qu'une de ces valeurs change de manière significative. Vous pouvez changer les délais d'attente entre les posts.

Tests

Afin de vous permettre de déboguer le processus, le YoctoHub-Wireless-g vous permet de visualiser la réponse au callback envoyé par le serveur Web. Cliquez simplement sur le bouton test une fois que vous avez renseigné tous les champs. Si le résultat vous paraît satisfaisant, fermez la fenêtre de debug, et cliquez sur Ok.

Formats

Les valeurs sont postées sous une des formes suivantes:

1. Si un nom logique a été défini pour une fonction:

NOM_LOGIQUE_DE_LA_FONCTION = VALEUR

2. Si un nom logique a été défini pour le module, mais pas pour la fonction:

NOM_DU_MODULE#NOM_HARDWARE = VALUE

3. Si aucun nom logique n'a été attribué:

NUMERO_DE_SERIE#NOM_HARDWARE = VALEUR

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.

Le résultat du test de callback avec un Yocto-PowerRelay et un Yocto-Temperature.

8. Programmation

8.1. Accès aux modules connectés

Le YoctoHub-Wireless-g se comporte exactement comme un ordinateur faisant tourner un VirtualHub. La seule différence entre un programme utilisant l'API Yoctopuce utilisant des modules en USB natif et ce même programme utilisant des modules Yoctopuce connecté à un YoctoHub-Wireless-g se situe au niveau de l'appel a registerHub. Pour utiliser des modules USB connectés en natif, le paramètre de RegisterHub est usb, pour utiliser des modules connectés à un YoctoHub-Wireless-g, il suffit de remplacer ce paramètre par l'adresse IP du YoctoHub-Wireless-g. Par en exemple, en Delphi:

devient

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.

Module

Cette classe, commune à tous les modules Yoctopuce permet de contrôler le module en temps que tel. Elle vous permettra de contrôler la Yocto-Led, de connaître la consommation sur USB du YoctoHub-Wireless-g, etc.

Wireless

Cette classe permet de contrôler la configuration du réseau sans fil du YoctoHub-Wireless-g, en particulier le SSID et la clé d'accès au réseau sans fil.

Network

Cette classe permet de contrôler la partie réseau du YoctoHub-Wireless-g, vous pourrez contrôler l'état du link, lire l'adresse MAC, changer l'adresse IP du YoctoHub-Wireless-g, connaître la consommation sur PoE, etc.

HubPort

Cette classe permet de contrôler la partie hub. Vous pourrez activer ou désactiver les ports du YoctoHub-Wireless-g, vous pourrez aussi savoir quel module est connecté à quel port.

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.

WakeMonitor

Cette classe permet de contrôler la mise en sommeil du YoctoHub-Wireless-g.

WakeSchedule

Cette classe permet d'agender un ou plusieurs réveils du YoctoHub-Wireless-g.

Vous trouverez quelques exemples de contrôle du YoctoHub-Wireless-g par programmation dans les librairies Yoctopuce, disponibles gratuitement sur le site de Yoctopuce.

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. Le système de mise en sommeil peut être configuré manuellement à l'aide d'une interface, ou piloté par logiciel.

9.1. Configuration manuelle du système de réveil

Les conditions de réveil peuvent être configurées manuellement en vous connectant sur l'interface du YoctoHub-Wireless-g. Dans la section Wake-up scheduler de la fenêtre de configuration générale, cliquez sur le bouton setup correspondant à l'un des "wakeup-schedule". Une fenêtre qui permet d'agender des réveils plus ou moins réguliers s'ouvre. Il suffit de sélectionner les cases correspondant aux occurrences désirées. Les sections laissées vides seront ignorée.

Fenêtre de configuration des réveils, ici toutes les 10 minutes entre 9h et 17h

De même, vous pouvez configurer directement sur l'interface du YoctoHub-Wireless-g le temps d'éveil maximal désiré, après lequel le module retournera automatiquement en sommeil profond. Si vous utilisez votre YoctoHub-Wireless-g sur batteries, ceci vous assurera de ne pas vider les batteries même si aucun ordre de mise en sommeil explicite n'est reçu.

9.2. Paramétrage du système de réveil par logiciel

Au niveau de l'interface de programmation, le système de réveil est implémenté a l'aide de deux types de fonction : La fonction wakeUpMonitor et la fonction WakeUpSchedule.

wakeUpMonitor

La fonction wakeUpMonitor gère l'éveil et la mise en sommeil proprement dits. Elle met à disposition toutes les fonctionnalités de contrôle immédiate: éveil immédiat, mise en sommeil immédiate, calcul de la date du prochain réveil etc... Le fonction wakeUpMonitor permet aussi de définir le temps maximum pendant lequel le YoctoHub-Wireless-g peut rester éveil avant de de se mettre automatiquement en sommeil.

wakeUpSchedule

La fonction wakeUpSchedule permet de programmer une condition de réveil. Elle dispose de cinq variables qui permet de définir des correspondance sur les minutes, heure, jour de la semaine, jour dans le mois, et mois. Ces variables sont des variables entières dont chaque bit défini une correspondance. Schématiquement, chaque ensemble de minutes, jours, heures est représenté sous la forme d'un ensemble de case avec chacune un coefficient qui est une puissante de deux, exactement comme dans l'interface correspondante du YoctoHub-Wireless-g.

Par exemple le bit 0 des heures correspond à l'heure zéro, le bit 1 correspond à l'heure une, le bit 2 correspond à 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.

Exemple de réveil à 12 H

Pour que le module se reveille à 0 heure, 6 heures et 12 heures, il faut mettre les bit 0,6,et 12 à un, ce qui correspondant à la valeur 2^0+ 2^6 + 2^12 = 1 + 64 + 4096 = 4161

Exemple de réveil à 0, 6 et 12 H

Les variables peuvent être combinées, pour qu'un réveil ait lieu tous les jours à 6H05, 6h10, 12h05 et 12h10 il suffit de mettre les heures à 2^6 + 2^12 = 4060 et les minutes à 2^5 + 2^10= 1056. Les variables laissée à zéro sont ignorées.

Exemple de réveil à 6H05, 6h10, 12h05 et 12h10

Notez que si vous désirez programmer un réveil à 6H05 et 12h10, mais pas 6h10 et 12h10, vous aurez besoin d'utiliser deux fonctions wakeUpSchedule différentes.

Ce paradigme permet de programmer des réveils assez complexe. Ainsi pour programmer un réveil tous les premiers mardis du mois, faut mettre à un le deuxième bit des jours de la semaine et les sept premiers bit des jours du mois.

Exemple de réveil tous les premiers mardi du mois

Certains languages de programmation, dont Javascript et Python, ne supportent pas les entiers 64 bits, ce qui pose un problème pour encoder les minutes. C'est pourquoi les minutes sont à la fois accessibles via un entier 64 bits minutes et deux entiers 32 bits, minutesA et minutesB, qui eux sont disponibles dans tous les languages actuels.

Les minutes sont aussi disponibles sous forme de deux entiers 32 bits.

La fonction wakeUpSchedule dispose d'une variable supplémentaire qui permet de définir le temps, en secondes, durant lequel le module restera é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.

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 à votre YoctoHub-Wireless-g.

10.1. Utilisation

Utilisation interactive

L'interface Web du YoctoHub-Wireless-g fournit une interface sommaire pour manipuler le contenu du système de fichiers: cliquez simplement sur le bouton configuration correspondant à votre module dans l'interface du hub, puis sur le bouton manage files. Les fichiers présents sont listés, et vous pouvez les visualiser, les effacer ou en ajouter (téléchargement).

En raison de sa petite taille, le système de fichiers ne possède pas de notion explicite de répertoire. Vous pouvez toutefois utiliser la barre oblique "/" à l'intérieur des noms de fichiers pour les classer comme s'ils étaient dans des répertoires.

Utilisation programmée

Le système de fichiers s'utilise avec la librairie yocto_files. Les fonctions de bases sont disponibles:

• upload vous permet de créer un nouveau fichier sur le module, dont vous fournissez le contenu;
• get_list vous permet de connaître la liste de fichier présents sur le module, y compris la taille et le CRC32 du contenu;
• download vous permet de le récupérer dans une variable le contenu d'un fichier présent sur le module;
• remove permet d'effacer un fichier du module.
• format permet de réinitialiser le système de fichiers à un état vide, non fragmenté.

Un programme utilisant le système de fichier bien conçu devrait toujours commencer par s'assurer que les fichiers nécessaires à son fonctionnement sont présents sur le module, et si nécessaire les charger sur le module. Cela permet de gérer de manière transparente les mises à jour logicielles et le déploiement de l'application sur des nouveaux modules. Pour faciliter la détection des versions de fichiers présents sur le module, la méthode get_list retourne pour chaque fichier une signature sur 32 bit appelée CRC (Cyclic Redundancy Check), qui identifie de manière fiable le contenu du fichier. Ainsi, si le CRC du fichier correspond, il y a moins d'une chance sur 4 milliards que son contenu ne soit pas le bon. Vous pouvez même calculer dans votre programme par avance le CRC du contenu que vous désirez, et ainsi le vérifier sans avoir à transférer le fichier. La fonction CRC utilisée par le système de fichiers Yoctopuce est la même que celle d'Ethernet, Gzip, PNG, etc. Sa valeur caractéristique pour la chaîne de neuf caractères "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. Vous ne pouvez toutefois pas remplacer le contenu d'un fichier préchargé sur le module, mais seulement en ajouter des nouveaux.

Interfaces utilisateur et optimisation

Puisque que pouvez sauver des fichiers directement sur la mémoire flash du module et les accéder depuis l'extérieur, il est très facile de construire une application WEB pour contrôler les modules connectés au hub et de la stocker directement sur le hub. C'est un moyen très pratique pour construire des systèmes télécommandables depuis un smart-phone ou une tablette. Cependant le $PRODANME$ est plus limité qu'un serveur WEB normal: il n'accepte qu'un nombre limité de connexions en parallèle. La plupart des browsers WEB actuels ayant tendance à ouvrir un maximum de connexions en parallèle pour charger tous les éléments d'une page WEB, cela peut mener à des temps de chargement très long. Pour éviter cela, essayez de garder vos pages WEB aussi compactes que possible en incluant le code javascript et CSS directement dans la page. Si vous le pouvez, incluez aussi les images en base64.

10.2. Limitations

Le filesystem embarqué sur votre YoctoHub-Wireless-g a quelques limitations techniques:

• Son espace de stockage maximal est 3.5Mo, répartis en blocs permettant de stocker jusqu'à environ 800 fichiers
• L'effacement d'un fichier ne récupère pas nécessairement immédiatement la totalité de la place utilisée par le fichier. L'espace non libéré sera entièrement réutilisé si l'on recrée un fichier du même nom, mais pas forcément si l'on crée des fichiers utilisant chaque fois des noms différents. Pour cette raison, il n'est pas recommandé de générer automatiquement des fichiers avec des noms toujours différents.
• L'espace non libéré peut être entièrement récupéré avec la commande format, qui libère la totalité des fichiers.
• Chaque mise à jour du firmware provoque implicitement un formattage complet du filesystem.
• Comme toutes les mémoires flash, la mémoire utilisée pour stocker les fichiers a une durée de vie de 100'000 cycles d'effacement environ. C'est assez, mais ce n'est pas illimité. Prenez donc garde à ne pas écrire et effacer inutilement des fichiers en boucle très rapidement, sous peine de détruire votre module.

11. Référence de l'API de haut niveau

Ce chapitre résume les fonctions de l'API de haut niveau pour commander votre YoctoHub-Wireless-g. La syntaxe et les types précis peuvent varier d'un langage à l'autre mais, sauf avis contraire toutes sont disponibles dans chaque language. Pour une information plus précise sur les types des arguments et des valeurs de retour dans un langage donné, veuillez vous référer au fichier de définition pour ce langage (yocto_api.* ainsi que les autres fichiers yocto_* définissant les interfaces des fonctions).

Dans les langages qui supportent les exceptions, toutes ces fonctions vont par défaut générer des exceptions en cas d'erreur plutôt que de retourner la valeur d'erreur documentée pour chaque fonction, afin de faciliter le déboguage. Il est toutefois possible de désactiver l'utilisation d'exceptions à l'aide de la fonction yDisableExceptions(), si l'on préfère travailler avec des valeurs de 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.

11.1. Interface d'un port de Yocto-hub

La classe YHubPort permet de contrôler l'alimentation des ports d'un YoctoHub, par exemple avec un 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é.

Fonction globales
yFindHubPort(func)
Permet de retrouver un port de Yocto-hub d'après un identifiant donné.
yFindHubPortInContext(yctx, func)
Permet de retrouver un port de Yocto-hub d'après un identifiant donné dans un Context YAPI.
yFirstHubPort()
Commence l'énumération des port de Yocto-hub accessibles par la librairie.
yFirstHubPortInContext(yctx)
Commence l'énumération des port de Yocto-hub accessibles par la librairie.
Méthodes des objets YHubPort
hubport→clearCache()
Invalide le cache.
hubport→describe()
Retourne un court texte décrivant de manière non-ambigüe l'instance du port de Yocto-hub au format TYPE(NAME)=SERIAL.FUNCTIONID.
hubport→get_advertisedValue()
Retourne la valeur courante du port de Yocto-hub (pas plus de 6 caractères).
hubport→get_baudRate()
Retourne la vitesse de transfert utilisée par le port de Yocto-hub, en kbps.
hubport→get_enabled()
Retourne vrai si le port du Yocto-hub est alimenté, faux sinon.
hubport→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du port de Yocto-hub.
hubport→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du port de Yocto-hub.
hubport→get_friendlyName()
Retourne un identifiant global du port de Yocto-hub au format NOM_MODULE.NOM_FONCTION.
hubport→get_functionDescriptor()
Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.
hubport→get_functionId()
Retourne l'identifiant matériel du port de Yocto-hub, sans référence au module.
hubport→get_hardwareId()
Retourne l'identifiant matériel unique du port de Yocto-hub au format SERIAL.FUNCTIONID.
hubport→get_logicalName()
Retourne le nom logique du port de Yocto-hub.
hubport→get_module()
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
hubport→get_module_async(callback, context)
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
hubport→get_portState()
Retourne l'état actuel du port de Yocto-hub.
hubport→get_serialNumber()
Retourne le numéro de série du module, préprogrammé en usine.
hubport→get_userData()
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData.
hubport→isOnline()
Vérifie si le module hébergeant le port de Yocto-hub est joignable, sans déclencher d'erreur.
hubport→isOnline_async(callback, context)
Vérifie si le module hébergeant le port de Yocto-hub est joignable, sans déclencher d'erreur.
hubport→isReadOnly()
Test si la fonction est en lecture seule.
hubport→load(msValidity)
Met en cache les valeurs courantes du port de Yocto-hub, avec une durée de validité spécifiée.
hubport→loadAttribute(attrName)
Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.
hubport→load_async(msValidity, callback, context)
Met en cache les valeurs courantes du port de Yocto-hub, avec une durée de validité spécifiée.
hubport→muteValueCallbacks()
Désactive l'envoi de chaque changement de la valeur publiée au hub parent.
hubport→nextHubPort()
Continue l'énumération des port de Yocto-hub commencée à l'aide de yFirstHubPort() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les port de Yocto-hub sont retournés.
hubport→registerValueCallback(callback)
Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.
hubport→set_enabled(newval)
Modifie le mode d'activation du port du Yocto-hub.
hubport→set_logicalName(newval)
Modifie le nom logique du port de Yocto-hub.
hubport→set_userData(data)
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.

YHubPort.FindHubPort()
yFindHubPort()yFindHubPort()yFindHubPort()[YHubPort FindHubPort: ]yFindHubPort()yFindHubPort()YHubPort.FindHubPort()YHubPort.FindHubPort()YHubPort.FindHubPort()YHubPort.FindHubPort()yFindHubPort()YHubPort.FindHubPort()

Permet de retrouver un port de Yocto-hub d'après un identifiant donné.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que le port de Yocto-hub soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YHubPort.isOnline() pour tester si le port de Yocto-hub est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Si un appel à la méthode is_online() de cet objet renvoie FAUX alors que vous êtes sûr que le module correspondant est bien branché, vérifiez que vous n'avez pas oublié d'appeler registerHub() à l'initialisation de de l'application.

Paramètres :

Retourne :

un objet de classe YHubPort qui permet ensuite de contrôler le port de Yocto-hub.

YHubPort.FindHubPortInContext()
yFindHubPortInContext()YHubPort.FindHubPortInContext()YHubPort.FindHubPortInContext()YHubPort.FindHubPortInContext()

Permet de retrouver un port de Yocto-hub d'après un identifiant donné dans un Context YAPI.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que le port de Yocto-hub soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YHubPort.isOnline() pour tester si le port de Yocto-hub est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres :

Retourne :

un objet de classe YHubPort qui permet ensuite de contrôler le port de Yocto-hub.

YHubPort.FirstHubPort()
yFirstHubPort()yFirstHubPort()yFirstHubPort()[YHubPort FirstHubPort]yFirstHubPort()yFirstHubPort()YHubPort.FirstHubPort()YHubPort.FirstHubPort()YHubPort.FirstHubPort()YHubPort.FirstHubPort()yFirstHubPort()YHubPort.FirstHubPort()

Commence l'énumération des port de Yocto-hub accessibles par la librairie.

Utiliser la fonction YHubPort.nextHubPort() pour itérer sur les autres port de Yocto-hub.

Retourne :

un pointeur sur un objet YHubPort, correspondant au premier port de Yocto-hub accessible en ligne, ou null si il n'y a pas de port de Yocto-hub disponibles.

YHubPort.FirstHubPortInContext()
yFirstHubPortInContext()YHubPort.FirstHubPortInContext()YHubPort.FirstHubPortInContext()YHubPort.FirstHubPortInContext()

Commence l'énumération des port de Yocto-hub accessibles par la librairie.

Utiliser la fonction YHubPort.nextHubPort() pour itérer sur les autres port de Yocto-hub.

Paramètres :

Retourne :

un pointeur sur un objet YHubPort, correspondant au premier port de Yocto-hub accessible en ligne, ou null si il n'y a pas de port de Yocto-hub disponibles.

hubport→clearCache()hubport.clearCache()hubport→clearCache()[hubport clearCache]hubport.clearCache()hubport.clearCache()hubport.clearCache()hubport.clearCache()hubport.clearCache()hubport→clearCache()hubport.clearCache()

Invalide le cache.

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.

hubport→describe()hubport.describe()hubport→describe()[hubport describe]hubport.describe()hubport.describe()hubport.describe()hubport.describe()hubport.describe()hubport→describe()hubport.describe()

Retourne un court texte décrivant de manière non-ambigüe l'instance du port de Yocto-hub au format TYPE(NAME)=SERIAL.FUNCTIONID.

Plus précisément, TYPE correspond au type de fonction, NAME correspond au nom utilsé lors du premier accès a la fonction, SERIAL correspond au numéro de série du module si le module est connecté, ou "unresolved" sinon, et FUNCTIONID correspond à l'identifiant matériel de la fonction si le module est connecté. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est déjà connecté ou Relay(BadCustomeName.relay1)=unresolved si le module n'est pas déjà connecté. Cette methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur.

Retourne :

une chaîne de caractères décrivant le port de Yocto-hub (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)

hubport→get_advertisedValue()
hubport→advertisedValue()hubport.get_advertisedValue()hubport→get_advertisedValue()[hubport advertisedValue]hubport.get_advertisedValue()hubport.get_advertisedValue()hubport.get_advertisedValue()hubport.get_advertisedValue()hubport.get_advertisedValue()hubport.get_advertisedValue()hubport→get_advertisedValue()hubport.get_advertisedValue()YHubPort get_advertisedValue

Retourne la valeur courante du port de Yocto-hub (pas plus de 6 caractères).

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.

hubport→get_baudRate()
hubport→baudRate()hubport.get_baudRate()hubport→get_baudRate()[hubport baudRate]hubport.get_baudRate()hubport.get_baudRate()hubport.get_baudRate()hubport.get_baudRate()hubport.get_baudRate()hubport.get_baudRate()hubport→get_baudRate()hubport.get_baudRate()YHubPort get_baudRate

Retourne la vitesse de transfert utilisée par le port de Yocto-hub, en kbps.

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.

hubport→get_enabled()
hubport→enabled()hubport.get_enabled()hubport→get_enabled()[hubport enabled]hubport.get_enabled()hubport.get_enabled()hubport.get_enabled()hubport.get_enabled()hubport.get_enabled()hubport.get_enabled()hubport→get_enabled()hubport.get_enabled()YHubPort get_enabled

Retourne vrai si le port du Yocto-hub est alimenté, faux sinon.

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.

hubport→get_errorMessage()
hubport→errorMessage()hubport.get_errorMessage()hubport→get_errorMessage()[hubport errorMessage]hubport.get_errorMessage()hubport.get_errorMessage()hubport.get_errorMessage()hubport.get_errorMessage()hubport.get_errorMessage()hubport→get_errorMessage()hubport.get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du port de Yocto-hub.

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.

hubport→get_errorType()
hubport→errorType()hubport.get_errorType()hubport→get_errorType()[hubport errorType]hubport.get_errorType()hubport.get_errorType()hubport.get_errorType()hubport.get_errorType()hubport.get_errorType()hubport→get_errorType()hubport.get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du port de Yocto-hub.

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.

hubport→get_friendlyName()
hubport→friendlyName()hubport.get_friendlyName()hubport→get_friendlyName()[hubport friendlyName]hubport.get_friendlyName()hubport.get_friendlyName()hubport.get_friendlyName()hubport→get_friendlyName()hubport.get_friendlyName()

Retourne un identifiant global du port de Yocto-hub au format NOM_MODULE.NOM_FONCTION.

Le chaîne retournée utilise soit les noms logiques du module et du port de Yocto-hub si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel du port de 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.

hubport→get_functionDescriptor()
hubport→functionDescriptor()hubport.get_functionDescriptor()hubport→get_functionDescriptor()[hubport functionDescriptor]hubport.get_functionDescriptor()hubport.get_functionDescriptor()hubport.get_functionDescriptor()hubport.get_functionDescriptor()hubport.get_functionDescriptor()hubport→get_functionDescriptor()hubport.get_functionDescriptor()

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

Cet identifiant peut être utilisé pour tester si deux instance de YFunction référencent physiquement la même fonction sur le même module.

Retourne :

un identifiant de type YFUN_DESCR.

Si la fonction n'a jamais été contactée, la valeur retournée sera Y_FUNCTIONDESCRIPTOR_INVALID

hubport→get_functionId()
hubport→functionId()hubport.get_functionId()hubport→get_functionId()[hubport functionId]hubport.get_functionId()hubport.get_functionId()hubport.get_functionId()hubport.get_functionId()hubport→get_functionId()hubport.get_functionId()

Retourne l'identifiant matériel du port de Yocto-hub, sans référence au module.

Par example relay1.

Retourne :

une chaîne de caractères identifiant le port de Yocto-hub (ex: relay1)

En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID.

hubport→get_hardwareId()
hubport→hardwareId()hubport.get_hardwareId()hubport→get_hardwareId()[hubport hardwareId]hubport.get_hardwareId()hubport.get_hardwareId()hubport.get_hardwareId()hubport.get_hardwareId()hubport→get_hardwareId()hubport.get_hardwareId()

Retourne l'identifiant matériel unique du port de Yocto-hub au format SERIAL.FUNCTIONID.

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 :

une chaîne de caractères identifiant le port de Yocto-hub (ex: RELAYLO1-123456.relay1)

En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID.

hubport→get_logicalName()
hubport→logicalName()hubport.get_logicalName()hubport→get_logicalName()[hubport logicalName]hubport.get_logicalName()hubport.get_logicalName()hubport.get_logicalName()hubport.get_logicalName()hubport.get_logicalName()hubport.get_logicalName()hubport→get_logicalName()hubport.get_logicalName()YHubPort get_logicalName

Retourne le nom logique du port de Yocto-hub.

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.

hubport→get_module()
hubport→module()hubport.get_module()hubport→get_module()[hubport module]hubport.get_module()hubport.get_module()hubport.get_module()hubport.get_module()hubport.get_module()hubport→get_module()hubport.get_module()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Retourne :

une instance de YModule

hubport→get_module_async()
hubport→module_async()hubport.get_module_async()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

hubport→get_portState()
hubport→portState()hubport.get_portState()hubport→get_portState()[hubport portState]hubport.get_portState()hubport.get_portState()hubport.get_portState()hubport.get_portState()hubport.get_portState()hubport.get_portState()hubport→get_portState()hubport.get_portState()YHubPort get_portState

Retourne l'état actuel du port de Yocto-hub.

Retourne :

une valeur parmi Y_PORTSTATE_OFF, Y_PORTSTATE_OVRLD, Y_PORTSTATE_ON, Y_PORTSTATE_RUN et 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.

hubport→get_serialNumber()
hubport→serialNumber()hubport.get_serialNumber()hubport→get_serialNumber()[hubport serialNumber]hubport.get_serialNumber()hubport.get_serialNumber()hubport.get_serialNumber()hubport.get_serialNumber()hubport.get_serialNumber()hubport.get_serialNumber()hubport→get_serialNumber()hubport.get_serialNumber()YHubPort get_serialNumber

Retourne le numéro de série du module, préprogrammé en usine.

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.

hubport→get_userData()
hubport→userData()hubport.get_userData()hubport→get_userData()[hubport userData]hubport.get_userData()hubport.get_userData()hubport.get_userData()hubport.get_userData()hubport.get_userData()hubport→get_userData()hubport.get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_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.

hubport→isOnline()hubport.isOnline()hubport→isOnline()[hubport isOnline]hubport.isOnline()hubport.isOnline()hubport.isOnline()hubport.isOnline()hubport.isOnline()hubport→isOnline()hubport.isOnline()

Vérifie si le module hébergeant le port de Yocto-hub est joignable, sans déclencher d'erreur.

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

hubport→isOnline_async()hubport.isOnline_async()

Vérifie si le module hébergeant le port de Yocto-hub est joignable, sans déclencher d'erreur.

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é.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

hubport→isReadOnly()hubport→isReadOnly()[hubport isReadOnly]hubport.isReadOnly()hubport.isReadOnly()hubport.isReadOnly()hubport.isReadOnly()hubport.isReadOnly()hubport.isReadOnly()hubport→isReadOnly()hubport.isReadOnly()YHubPort isReadOnly

Test si la fonction est en lecture seule.

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

hubport→load()hubport.load()hubport→load()[hubport load: ]hubport.load()hubport.load()hubport.load()hubport.load()hubport.load()hubport→load()hubport.load()

Met en cache les valeurs courantes du port de Yocto-hub, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

hubport→loadAttribute()hubport.loadAttribute()hubport→loadAttribute()[hubport loadAttribute: ]hubport.loadAttribute()hubport.loadAttribute()hubport.loadAttribute()hubport.loadAttribute()hubport.loadAttribute()hubport.loadAttribute()hubport→loadAttribute()hubport.loadAttribute()

Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.

Paramètres :

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.

hubport→load_async()hubport.load_async()

Met en cache les valeurs courantes du port de Yocto-hub, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

hubport→muteValueCallbacks()hubport.muteValueCallbacks()hubport→muteValueCallbacks()[hubport muteValueCallbacks]hubport.muteValueCallbacks()hubport.muteValueCallbacks()hubport.muteValueCallbacks()hubport.muteValueCallbacks()hubport.muteValueCallbacks()hubport.muteValueCallbacks()hubport→muteValueCallbacks()hubport.muteValueCallbacks()YHubPort muteValueCallbacks

Désactive l'envoi de chaque changement de la valeur publiée au hub parent.

Vous pouvez utiliser cette fonction pour économiser la bande passante et le CPU sur les machines de faible puissance, ou pour éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

hubport→nextHubPort()hubport.nextHubPort()hubport→nextHubPort()[hubport nextHubPort]hubport.nextHubPort()hubport.nextHubPort()hubport.nextHubPort()hubport.nextHubPort()hubport.nextHubPort()hubport.nextHubPort()hubport→nextHubPort()hubport.nextHubPort()

Continue l'énumération des port de Yocto-hub commencée à l'aide de yFirstHubPort() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les port de Yocto-hub sont retournés.

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.

hubport→registerValueCallback()hubport.registerValueCallback()hubport→registerValueCallback()[hubport registerValueCallback: ]hubport.registerValueCallback()hubport.registerValueCallback()hubport.registerValueCallback()hubport.registerValueCallback()hubport.registerValueCallback()hubport.registerValueCallback()hubport→registerValueCallback()hubport.registerValueCallback()

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

Ce callback n'est appelé que durant l'exécution de ySleep ou yHandleEvents. Cela permet à l'appelant de contrôler quand les callback peuvent se produire. Il est important d'appeler l'une de ces deux fonctions périodiquement pour garantir que les callback ne soient pas appelés trop tard. Pour désactiver un callback, il suffit d'appeler cette méthode en lui passant un pointeur nul.

Paramètres :

hubport→set_enabled()
hubport→setEnabled()hubport.set_enabled()hubport→set_enabled()[hubport setEnabled: ]hubport.set_enabled()hubport.set_enabled()hubport.set_enabled()hubport.set_enabled()hubport.set_enabled()hubport.set_enabled()hubport→set_enabled()hubport.set_enabled()YHubPort set_enabled

Modifie le mode d'activation du port du Yocto-hub.

Si le port est actif, il sera alimenté. Sinon, l'alimentation du module est coupée.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

hubport→set_logicalName()
hubport→setLogicalName()hubport.set_logicalName()hubport→set_logicalName()[hubport setLogicalName: ]hubport.set_logicalName()hubport.set_logicalName()hubport.set_logicalName()hubport.set_logicalName()hubport.set_logicalName()hubport.set_logicalName()hubport→set_logicalName()hubport.set_logicalName()YHubPort set_logicalName

Modifie le nom logique du port de Yocto-hub.

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

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.

hubport→set_userData()
hubport→setUserData()hubport.set_userData()hubport→set_userData()[hubport setUserData: ]hubport.set_userData()hubport.set_userData()hubport.set_userData()hubport.set_userData()hubport.set_userData()hubport→set_userData()hubport.set_userData()

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.

Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte.

Paramètres :

hubport→unmuteValueCallbacks()hubport.unmuteValueCallbacks()hubport→unmuteValueCallbacks()[hubport unmuteValueCallbacks]hubport.unmuteValueCallbacks()hubport.unmuteValueCallbacks()hubport.unmuteValueCallbacks()hubport.unmuteValueCallbacks()hubport.unmuteValueCallbacks()hubport.unmuteValueCallbacks()hubport→unmuteValueCallbacks()hubport.unmuteValueCallbacks()YHubPort unmuteValueCallbacks

Réactive l'envoi de chaque changement de la valeur publiée au hub parent.

Cette fonction annule un précédent appel à muteValueCallbacks(). N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

hubport→wait_async()hubport.wait_async()hubport.wait_async()

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.

La fonction callback peut donc librement utiliser des fonctions synchrones ou asynchrones, sans risquer de bloquer la machine virtuelle Javascript.

Paramètres :

Retourne :

rien du tout.

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.

Fonction globales
yFindWireless(func)
Permet de retrouver une interface réseau sans fil d'après un identifiant donné.
yFindWirelessInContext(yctx, func)
Permet de retrouver une interface réseau sans fil d'après un identifiant donné dans un Context YAPI.
yFirstWireless()
Commence l'énumération des interfaces réseau sans fil accessibles par la librairie.
yFirstWirelessInContext(yctx)
Commence l'énumération des interfaces réseau sans fil accessibles par la librairie.
Méthodes des objets YWireless
wireless→adhocNetwork(ssid, securityKey)
Modifie la configuration de l'interface réseau sans fil pour créer un réseau sans fil sans point d'accès, en mode "ad-hoc".
wireless→clearCache()
Invalide le cache.
wireless→describe()
Retourne un court texte décrivant de manière non-ambigüe l'instance de l'interface réseau sans fil au format TYPE(NAME)=SERIAL.FUNCTIONID.
wireless→get_advertisedValue()
Retourne la valeur courante de l'interface réseau sans fil (pas plus de 6 caractères).
wireless→get_channel()
Retourne le numéro du canal 802.11 utilisé, ou 0 si le réseau sélectionné n'a pas été trouvé.
wireless→get_detectedWlans()
Retourne une liste d'objets objet YFileRecord qui décrivent les réseaux sans fils détectés.
wireless→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau sans fil.
wireless→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau sans fil.
wireless→get_friendlyName()
Retourne un identifiant global de l'interface réseau sans fil au format NOM_MODULE.NOM_FONCTION.
wireless→get_functionDescriptor()
Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.
wireless→get_functionId()
Retourne l'identifiant matériel de l'interface réseau sans fil, sans référence au module.
wireless→get_hardwareId()
Retourne l'identifiant matériel unique de l'interface réseau sans fil au format SERIAL.FUNCTIONID.
wireless→get_linkQuality()
Retourne la qualité de la connection, exprimée en pourcents.
wireless→get_logicalName()
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)
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
wireless→get_security()
Retourne l'algorithme de sécurité utilisé par le réseau sans fil sélectionné.
wireless→get_serialNumber()
Retourne le numéro de série du module, préprogrammé en usine.
wireless→get_ssid()
Retourne le nom (SSID) du réseau sans fil sélectionné.
wireless→get_userData()
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData.
wireless→get_wlanState()
Retourne l'état actuel de l'interface réseau sans fil.
wireless→isOnline()
Vérifie si le module hébergeant l'interface réseau sans fil est joignable, sans déclencher d'erreur.
wireless→isOnline_async(callback, context)
Vérifie si le module hébergeant l'interface réseau sans fil est joignable, sans déclencher d'erreur.
wireless→isReadOnly()
Test si la fonction est en lecture seule.
wireless→joinNetwork(ssid, securityKey)
Modifie la configuration de l'interface réseau sans fil pour se connecter à un point d'accès sans fil existant (mode "infrastructure").
wireless→load(msValidity)
Met en cache les valeurs courantes de l'interface réseau sans fil, avec une durée de validité spécifiée.
wireless→loadAttribute(attrName)
Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.
wireless→load_async(msValidity, callback, context)
Met en cache les valeurs courantes de l'interface réseau sans fil, avec une durée de validité spécifiée.
wireless→muteValueCallbacks()
Désactive l'envoi de chaque changement de la valeur publiée au hub parent.
wireless→nextWireless()
Continue l'énumération des interfaces réseau sans fil commencée à l'aide de yFirstWireless() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les interfaces réseau sans fil sont retournés.
wireless→registerValueCallback(callback)
Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.
wireless→set_logicalName(newval)
Modifie le nom logique de l'interface réseau sans fil.
wireless→set_userData(data)
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.
wireless→softAPNetwork(ssid, securityKey)
Modifie la configuration de l'interface réseau sans fil pour créer un pseudo point d'accès sans fil ("Soft AP").
wireless→startWlanScan()
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.

YWireless.FindWireless()
yFindWireless()yFindWireless()yFindWireless()[YWireless FindWireless: ]yFindWireless()yFindWireless()YWireless.FindWireless()YWireless.FindWireless()YWireless.FindWireless()YWireless.FindWireless()yFindWireless()YWireless.FindWireless()

Permet de retrouver une interface réseau sans fil d'après un identifiant donné.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que l'interface réseau sans fil soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YWireless.isOnline() pour tester si l'interface réseau sans fil est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Si un appel à la méthode is_online() de cet objet renvoie FAUX alors que vous êtes sûr que le module correspondant est bien branché, vérifiez que vous n'avez pas oublié d'appeler registerHub() à l'initialisation de de l'application.

Paramètres :

Retourne :

un objet de classe YWireless qui permet ensuite de contrôler l'interface réseau sans fil.

YWireless.FindWirelessInContext()
yFindWirelessInContext()YWireless.FindWirelessInContext()YWireless.FindWirelessInContext()YWireless.FindWirelessInContext()

Permet de retrouver une interface réseau sans fil d'après un identifiant donné dans un Context YAPI.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que l'interface réseau sans fil soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YWireless.isOnline() pour tester si l'interface réseau sans fil est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres :

Retourne :

un objet de classe YWireless qui permet ensuite de contrôler l'interface réseau sans fil.

YWireless.FirstWireless()
yFirstWireless()yFirstWireless()yFirstWireless()[YWireless FirstWireless]yFirstWireless()yFirstWireless()YWireless.FirstWireless()YWireless.FirstWireless()YWireless.FirstWireless()YWireless.FirstWireless()yFirstWireless()YWireless.FirstWireless()

Commence l'énumération des interfaces réseau sans fil accessibles par la librairie.

Utiliser la fonction YWireless.nextWireless() pour itérer sur les autres interfaces réseau sans fil.

Retourne :

un pointeur sur un objet YWireless, 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.

YWireless.FirstWirelessInContext()
yFirstWirelessInContext()YWireless.FirstWirelessInContext()YWireless.FirstWirelessInContext()YWireless.FirstWirelessInContext()

Commence l'énumération des interfaces réseau sans fil accessibles par la librairie.

Utiliser la fonction YWireless.nextWireless() pour itérer sur les autres interfaces réseau sans fil.

Paramètres :

Retourne :

un pointeur sur un objet YWireless, 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.

wireless→adhocNetwork()wireless.adhocNetwork()wireless→adhocNetwork()[wireless adhocNetwork: ]wireless.adhocNetwork()wireless.adhocNetwork()wireless.adhocNetwork()wireless.adhocNetwork()wireless.adhocNetwork()wireless.adhocNetwork()wireless→adhocNetwork()wireless.adhocNetwork()YWireless adhocNetwork

Modifie la configuration de l'interface réseau sans fil pour créer un réseau sans fil sans point d'accès, en mode "ad-hoc".

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é WEP40 (5 caractères ou 10 chiffres hexadécimaux) ou WEP128 (13 caractères ou 26 chiffres hexadécimaux). Pour réduire les risques d'intrusion, il est recommandé d'utiliser une clé WEP128 basée sur 26 chiffres hexadécimaux provenant d'une bonne source aléatoire.

N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

wireless→clearCache()wireless.clearCache()wireless→clearCache()[wireless clearCache]wireless.clearCache()wireless.clearCache()wireless.clearCache()wireless.clearCache()wireless.clearCache()wireless→clearCache()wireless.clearCache()

Invalide le cache.

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.

wireless→describe()wireless.describe()wireless→describe()[wireless describe]wireless.describe()wireless.describe()wireless.describe()wireless.describe()wireless.describe()wireless→describe()wireless.describe()

Retourne un court texte décrivant de manière non-ambigüe l'instance de l'interface réseau sans fil au format TYPE(NAME)=SERIAL.FUNCTIONID.

Plus précisément, TYPE correspond au type de fonction, NAME correspond au nom utilsé lors du premier accès a la fonction, SERIAL correspond au numéro de série du module si le module est connecté, ou "unresolved" sinon, et FUNCTIONID correspond à l'identifiant matériel de la fonction si le module est connecté. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est déjà connecté ou Relay(BadCustomeName.relay1)=unresolved si le module n'est pas déjà connecté. Cette methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur.

Retourne :

une chaîne de caractères décrivant l'interface réseau sans fil (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)

wireless→get_advertisedValue()
wireless→advertisedValue()wireless.get_advertisedValue()wireless→get_advertisedValue()[wireless advertisedValue]wireless.get_advertisedValue()wireless.get_advertisedValue()wireless.get_advertisedValue()wireless.get_advertisedValue()wireless.get_advertisedValue()wireless.get_advertisedValue()wireless→get_advertisedValue()wireless.get_advertisedValue()YWireless get_advertisedValue

Retourne la valeur courante de l'interface réseau sans fil (pas plus de 6 caractères).

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.

wireless→get_channel()
wireless→channel()wireless.get_channel()wireless→get_channel()[wireless channel]wireless.get_channel()wireless.get_channel()wireless.get_channel()wireless.get_channel()wireless.get_channel()wireless.get_channel()wireless→get_channel()wireless.get_channel()YWireless get_channel

Retourne le numéro du canal 802.11 utilisé, ou 0 si le réseau sélectionné n'a pas été trouvé.

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.

wireless→get_detectedWlans()
wireless→detectedWlans()wireless.get_detectedWlans()wireless→get_detectedWlans()[wireless detectedWlans]wireless.get_detectedWlans()wireless.get_detectedWlans()wireless.get_detectedWlans()wireless.get_detectedWlans()wireless.get_detectedWlans()wireless.get_detectedWlans()wireless→get_detectedWlans()wireless.get_detectedWlans()YWireless get_detectedWlans

Retourne une liste d'objets objet YFileRecord qui décrivent les réseaux sans fils détectés.

La liste n'est pas mise à jour quand le module est déjà connecté à un accès sans fil (mode "infrastructure"). Pour forcer la détection des réseaux sans fil, il faut appeler startWlanScan(). L'appelant est responsable de la désallocation de la liste retournée dans les langages ne disposant pas de "garbage collection".

Retourne :

une liste d'objets YWlanRecord, 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.

wireless→get_errorMessage()
wireless→errorMessage()wireless.get_errorMessage()wireless→get_errorMessage()[wireless errorMessage]wireless.get_errorMessage()wireless.get_errorMessage()wireless.get_errorMessage()wireless.get_errorMessage()wireless.get_errorMessage()wireless→get_errorMessage()wireless.get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau sans fil.

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.

wireless→get_errorType()
wireless→errorType()wireless.get_errorType()wireless→get_errorType()[wireless errorType]wireless.get_errorType()wireless.get_errorType()wireless.get_errorType()wireless.get_errorType()wireless.get_errorType()wireless→get_errorType()wireless.get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau sans fil.

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.

wireless→get_friendlyName()
wireless→friendlyName()wireless.get_friendlyName()wireless→get_friendlyName()[wireless friendlyName]wireless.get_friendlyName()wireless.get_friendlyName()wireless.get_friendlyName()wireless→get_friendlyName()wireless.get_friendlyName()

Retourne un identifiant global de l'interface réseau sans fil au format NOM_MODULE.NOM_FONCTION.

Le chaîne retournée utilise soit les noms logiques du module et de l'interface réseau sans fil si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de l'interface réseau sans fil (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.

wireless→get_functionDescriptor()
wireless→functionDescriptor()wireless.get_functionDescriptor()wireless→get_functionDescriptor()[wireless functionDescriptor]wireless.get_functionDescriptor()wireless.get_functionDescriptor()wireless.get_functionDescriptor()wireless.get_functionDescriptor()wireless.get_functionDescriptor()wireless→get_functionDescriptor()wireless.get_functionDescriptor()

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

Cet identifiant peut être utilisé pour tester si deux instance de YFunction référencent physiquement la même fonction sur le même module.

Retourne :

un identifiant de type YFUN_DESCR.

Si la fonction n'a jamais été contactée, la valeur retournée sera Y_FUNCTIONDESCRIPTOR_INVALID

wireless→get_functionId()
wireless→functionId()wireless.get_functionId()wireless→get_functionId()[wireless functionId]wireless.get_functionId()wireless.get_functionId()wireless.get_functionId()wireless.get_functionId()wireless→get_functionId()wireless.get_functionId()

Retourne l'identifiant matériel de l'interface réseau sans fil, sans référence au module.

Par example relay1.

Retourne :

une chaîne de caractères identifiant l'interface réseau sans fil (ex: relay1)

En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID.

wireless→get_hardwareId()
wireless→hardwareId()wireless.get_hardwareId()wireless→get_hardwareId()[wireless hardwareId]wireless.get_hardwareId()wireless.get_hardwareId()wireless.get_hardwareId()wireless.get_hardwareId()wireless→get_hardwareId()wireless.get_hardwareId()

Retourne l'identifiant matériel unique de l'interface réseau sans fil au format SERIAL.FUNCTIONID.

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 :

une chaîne de caractères identifiant l'interface réseau sans fil (ex: RELAYLO1-123456.relay1)

En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID.

wireless→get_linkQuality()
wireless→linkQuality()wireless.get_linkQuality()wireless→get_linkQuality()[wireless linkQuality]wireless.get_linkQuality()wireless.get_linkQuality()wireless.get_linkQuality()wireless.get_linkQuality()wireless.get_linkQuality()wireless.get_linkQuality()wireless→get_linkQuality()wireless.get_linkQuality()YWireless get_linkQuality

Retourne la qualité de la connection, exprimée en pourcents.

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.

wireless→get_logicalName()
wireless→logicalName()wireless.get_logicalName()wireless→get_logicalName()[wireless logicalName]wireless.get_logicalName()wireless.get_logicalName()wireless.get_logicalName()wireless.get_logicalName()wireless.get_logicalName()wireless.get_logicalName()wireless→get_logicalName()wireless.get_logicalName()YWireless get_logicalName

Retourne le nom logique de l'interface réseau sans fil.

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.

wireless→get_message()
wireless→message()wireless.get_message()wireless→get_message()[wireless message]wireless.get_message()wireless.get_message()wireless.get_message()wireless.get_message()wireless.get_message()wireless.get_message()wireless→get_message()wireless.get_message()YWireless get_message

Retourne le dernier message de diagnostique de l'interface au réseau sans fil.

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.

wireless→get_module()
wireless→module()wireless.get_module()wireless→get_module()[wireless module]wireless.get_module()wireless.get_module()wireless.get_module()wireless.get_module()wireless.get_module()wireless→get_module()wireless.get_module()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Retourne :

une instance de YModule

wireless→get_module_async()
wireless→module_async()wireless.get_module_async()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

wireless→get_security()
wireless→security()wireless.get_security()wireless→get_security()[wireless security]wireless.get_security()wireless.get_security()wireless.get_security()wireless.get_security()wireless.get_security()wireless.get_security()wireless→get_security()wireless.get_security()YWireless get_security

Retourne l'algorithme de sécurité utilisé par le réseau sans fil sélectionné.

Retourne :

une valeur parmi Y_SECURITY_UNKNOWN, Y_SECURITY_OPEN, Y_SECURITY_WEP, Y_SECURITY_WPA et 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.

wireless→get_serialNumber()
wireless→serialNumber()wireless.get_serialNumber()wireless→get_serialNumber()[wireless serialNumber]wireless.get_serialNumber()wireless.get_serialNumber()wireless.get_serialNumber()wireless.get_serialNumber()wireless.get_serialNumber()wireless.get_serialNumber()wireless→get_serialNumber()wireless.get_serialNumber()YWireless get_serialNumber

Retourne le numéro de série du module, préprogrammé en usine.

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.

wireless→get_ssid()
wireless→ssid()wireless.get_ssid()wireless→get_ssid()[wireless ssid]wireless.get_ssid()wireless.get_ssid()wireless.get_ssid()wireless.get_ssid()wireless.get_ssid()wireless.get_ssid()wireless→get_ssid()wireless.get_ssid()YWireless get_ssid

Retourne le nom (SSID) du réseau sans fil sélectionné.

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.

wireless→get_userData()
wireless→userData()wireless.get_userData()wireless→get_userData()[wireless userData]wireless.get_userData()wireless.get_userData()wireless.get_userData()wireless.get_userData()wireless.get_userData()wireless→get_userData()wireless.get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_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.

wireless→get_wlanState()
wireless→wlanState()wireless.get_wlanState()wireless→get_wlanState()[wireless wlanState]wireless.get_wlanState()wireless.get_wlanState()wireless.get_wlanState()wireless.get_wlanState()wireless.get_wlanState()wireless.get_wlanState()wireless→get_wlanState()wireless.get_wlanState()YWireless get_wlanState

Retourne l'état actuel de l'interface réseau sans fil.

L'état Y_WLANSTATE_DOWN indique que l'interface n'est connectée à aucun réseau. L'état Y_WLANSTATE_SCANNING signifie que la carte réseau effectue un balayage des fréquences utilisables. Dans cet état le module n'est pas joignable et la configuration réseau n'est pas encore appliquée. L'état Y_WLANSTATE_CONNECTED signifie que la configuration réseau a pu être appliqué et que le module est joignable. Si le l'interface est configurée pour fonctionner en mode ad-hoc ou Soft AP, cela signifie que le réseau est fonctionnel et que un périphérique peut se connecter au réseau. L'état Y_WLANSTATE_REJECTED signifie que l'interface réseau n'a pas pu joindre le réseau souhaité. la source de l'erreur peut être obtenue à l'aide de la méthode get_message().

Retourne :

une valeur parmi Y_WLANSTATE_DOWN, Y_WLANSTATE_SCANNING, Y_WLANSTATE_CONNECTED et 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.

wireless→isOnline()wireless.isOnline()wireless→isOnline()[wireless isOnline]wireless.isOnline()wireless.isOnline()wireless.isOnline()wireless.isOnline()wireless.isOnline()wireless→isOnline()wireless.isOnline()

Vérifie si le module hébergeant l'interface réseau sans fil est joignable, sans déclencher d'erreur.

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

wireless→isOnline_async()wireless.isOnline_async()

Vérifie si le module hébergeant l'interface réseau sans fil est joignable, sans déclencher d'erreur.

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é.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

wireless→isReadOnly()wireless→isReadOnly()[wireless isReadOnly]wireless.isReadOnly()wireless.isReadOnly()wireless.isReadOnly()wireless.isReadOnly()wireless.isReadOnly()wireless.isReadOnly()wireless→isReadOnly()wireless.isReadOnly()YWireless isReadOnly

Test si la fonction est en lecture seule.

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

wireless→joinNetwork()wireless.joinNetwork()wireless→joinNetwork()[wireless joinNetwork: ]wireless.joinNetwork()wireless.joinNetwork()wireless.joinNetwork()wireless.joinNetwork()wireless.joinNetwork()wireless.joinNetwork()wireless→joinNetwork()wireless.joinNetwork()YWireless joinNetwork

Modifie la configuration de l'interface réseau sans fil pour se connecter à un point d'accès sans fil existant (mode "infrastructure").

N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

wireless→load()wireless.load()wireless→load()[wireless load: ]wireless.load()wireless.load()wireless.load()wireless.load()wireless.load()wireless→load()wireless.load()

Met en cache les valeurs courantes de l'interface réseau sans fil, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

wireless→loadAttribute()wireless.loadAttribute()wireless→loadAttribute()[wireless loadAttribute: ]wireless.loadAttribute()wireless.loadAttribute()wireless.loadAttribute()wireless.loadAttribute()wireless.loadAttribute()wireless.loadAttribute()wireless→loadAttribute()wireless.loadAttribute()

Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.

Paramètres :

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.

wireless→load_async()wireless.load_async()

Met en cache les valeurs courantes de l'interface réseau sans fil, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

wireless→muteValueCallbacks()wireless.muteValueCallbacks()wireless→muteValueCallbacks()[wireless muteValueCallbacks]wireless.muteValueCallbacks()wireless.muteValueCallbacks()wireless.muteValueCallbacks()wireless.muteValueCallbacks()wireless.muteValueCallbacks()wireless.muteValueCallbacks()wireless→muteValueCallbacks()wireless.muteValueCallbacks()YWireless muteValueCallbacks

Désactive l'envoi de chaque changement de la valeur publiée au hub parent.

Vous pouvez utiliser cette fonction pour économiser la bande passante et le CPU sur les machines de faible puissance, ou pour éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

wireless→nextWireless()wireless.nextWireless()wireless→nextWireless()[wireless nextWireless]wireless.nextWireless()wireless.nextWireless()wireless.nextWireless()wireless.nextWireless()wireless.nextWireless()wireless.nextWireless()wireless→nextWireless()wireless.nextWireless()

Continue l'énumération des interfaces réseau sans fil commencée à l'aide de yFirstWireless() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les interfaces réseau sans fil sont retournés.

Si vous souhaitez retrouver une interface réseau sans fil spécifique, utilisez Wireless.findWireless() avec un hardwareID ou un nom logique.

Retourne :

un pointeur sur un objet YWireless accessible en ligne, ou null lorsque l'énumération est terminée.

wireless→registerValueCallback()wireless.registerValueCallback()wireless→registerValueCallback()[wireless registerValueCallback: ]wireless.registerValueCallback()wireless.registerValueCallback()wireless.registerValueCallback()wireless.registerValueCallback()wireless.registerValueCallback()wireless.registerValueCallback()wireless→registerValueCallback()wireless.registerValueCallback()

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

Ce callback n'est appelé que durant l'exécution de ySleep ou yHandleEvents. Cela permet à l'appelant de contrôler quand les callback peuvent se produire. Il est important d'appeler l'une de ces deux fonctions périodiquement pour garantir que les callback ne soient pas appelés trop tard. Pour désactiver un callback, il suffit d'appeler cette méthode en lui passant un pointeur nul.

Paramètres :

wireless→set_logicalName()
wireless→setLogicalName()wireless.set_logicalName()wireless→set_logicalName()[wireless setLogicalName: ]wireless.set_logicalName()wireless.set_logicalName()wireless.set_logicalName()wireless.set_logicalName()wireless.set_logicalName()wireless.set_logicalName()wireless→set_logicalName()wireless.set_logicalName()YWireless set_logicalName

Modifie le nom logique de l'interface réseau sans fil.

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

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.

wireless→set_userData()
wireless→setUserData()wireless.set_userData()wireless→set_userData()[wireless setUserData: ]wireless.set_userData()wireless.set_userData()wireless.set_userData()wireless.set_userData()wireless.set_userData()wireless→set_userData()wireless.set_userData()

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.

Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte.

Paramètres :

wireless→softAPNetwork()wireless.softAPNetwork()wireless→softAPNetwork()[wireless softAPNetwork: ]wireless.softAPNetwork()wireless.softAPNetwork()wireless.softAPNetwork()wireless.softAPNetwork()wireless.softAPNetwork()wireless.softAPNetwork()wireless→softAPNetwork()wireless.softAPNetwork()YWireless softAPNetwork

Modifie la configuration de l'interface réseau sans fil pour créer un pseudo point d'accès sans fil ("Soft AP").

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). Pour réduire les risques d'intrusion, il est recommandé d'utiliser une clé WEP128 basée sur 26 chiffres hexadécimaux provenant d'une bonne source aléatoire.

N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

wireless→startWlanScan()wireless.startWlanScan()wireless→startWlanScan()[wireless startWlanScan]wireless.startWlanScan()wireless.startWlanScan()wireless.startWlanScan()wireless.startWlanScan()wireless.startWlanScan()wireless.startWlanScan()wireless→startWlanScan()wireless.startWlanScan()YWireless startWlanScan

Déclenche un balayage des fréquences utilisable et construit la liste de réseau sans fils disponible.

Pendant le balayage des réseau sans fils, l'interface se déconnecte du réseau sans fils actuel. A la fin du balayage l'interface essaye de se reconnecter au réseau sans fil. Pendant le balayage le wlanState passe par l'état Y_WLANSTATE_DOWN puis par l'état Y_WLANSTATE_SCANNING. La liste des réseaux sans fils disponible peut être récupéré avec la méthode get_detectedWlans() à partir du moment ou get_wlanState() retourne Y_WLANSTATE_REJECTED ou Y_WLANSTATE_CONNECTED.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

wireless→unmuteValueCallbacks()wireless.unmuteValueCallbacks()wireless→unmuteValueCallbacks()[wireless unmuteValueCallbacks]wireless.unmuteValueCallbacks()wireless.unmuteValueCallbacks()wireless.unmuteValueCallbacks()wireless.unmuteValueCallbacks()wireless.unmuteValueCallbacks()wireless.unmuteValueCallbacks()wireless→unmuteValueCallbacks()wireless.unmuteValueCallbacks()YWireless unmuteValueCallbacks

Réactive l'envoi de chaque changement de la valeur publiée au hub parent.

Cette fonction annule un précédent appel à muteValueCallbacks(). N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

wireless→wait_async()wireless.wait_async()wireless.wait_async()

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.

La fonction callback peut donc librement utiliser des fonctions synchrones ou asynchrones, sans risquer de bloquer la machine virtuelle Javascript.

Paramètres :

Retourne :

rien du tout.

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.

Fonction globales
yFindNetwork(func)
Permet de retrouver une interface réseau d'après un identifiant donné.
yFindNetworkInContext(yctx, func)
Permet de retrouver une interface réseau d'après un identifiant donné dans un Context YAPI.
yFirstNetwork()
Commence l'énumération des interfaces réseau accessibles par la librairie.
yFirstNetworkInContext(yctx)
Commence l'énumération des interfaces réseau accessibles par la librairie.
Méthodes des objets YNetwork
network→callbackLogin(username, password)
Contacte le callback de notification et sauvegarde un laisser-passer pour s'y connecter.
network→clearCache()
Invalide le cache.
network→describe()
Retourne un court texte décrivant de manière non-ambigüe l'instance de l'interface réseau au format TYPE(NAME)=SERIAL.FUNCTIONID.
network→get_adminPassword()
Retourne une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "admin", ou sinon une chaîne vide.
network→get_advertisedValue()
Retourne la valeur courante de l'interface réseau (pas plus de 6 caractères).
network→get_callbackCredentials()
Retourne une version hashée du laisser-passer pour le callback de notification s'il a été configuré, ou sinon une chaîne vide.
network→get_callbackEncoding()
Retourne l'encodage à utiliser pour représenter les valeurs notifiées par callback.
network→get_callbackInitialDelay()
Retourne l'attente initiale avant la première notification par callback, en secondes.
network→get_callbackMaxDelay()
Retourne l'attente entre deux callback HTTP lorsque rien n'est à signaler, en secondes.
network→get_callbackMethod()
Retourne la méthode HTTP à utiliser pour signaler les changements d'état par callback.
network→get_callbackMinDelay()
Retourne l'attente minimale entre deux callbacks HTTP, en secondes.
network→get_callbackSchedule()
Retourne la planification des callbacks HTTP, sous forme de chaîne de caractères.
network→get_callbackUrl()
Retourne l'adresse (URL) de callback à notifier lors de changement d'état significatifs.
network→get_defaultPage()
Retourne la page HTML à envoyer pour l'URL "/"
network→get_discoverable()
Retourne l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour).
network→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau.
network→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau.
network→get_friendlyName()
Retourne un identifiant global de l'interface réseau au format NOM_MODULE.NOM_FONCTION.
network→get_functionDescriptor()
Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.
network→get_functionId()
Retourne l'identifiant matériel de l'interface réseau, sans référence au module.
network→get_hardwareId()
Retourne l'identifiant matériel unique de l'interface réseau au format SERIAL.FUNCTIONID.
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.
network→get_macAddress()
Retourne l'adresse MAC de l'interface réseau, unique pour chaque module.
network→get_module()
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
network→get_module_async(callback, context)
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
network→get_ntpServer()
Retourne l'adresse IP du serveur de NTP à utiliser pour maintenir le module à l'heure.
network→get_poeCurrent()
Retourne le courant consommé par le module depuis Power-over-Ethernet (PoE), en milliampères.
network→get_primaryDNS()
Retourne l'adresse IP du serveur de noms primaire que le module doit utiliser.
network→get_readiness()
Retourne l'état de fonctionnement atteint par l'interface réseau.
network→get_router()
Retourne l'adresse IP du routeur (passerelle) utilisé par le module (default gateway).
network→get_secondaryDNS()
Retourne l'adresse IP du serveur de noms secondaire que le module doit utiliser.
network→get_serialNumber()
Retourne le numéro de série du module, préprogrammé en usine.
network→get_subnetMask()
Retourne le masque de sous-réseau utilisé par le module.
network→get_userData()
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData.
network→get_userPassword()
Retourne une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "user", ou sinon une chaîne vide.
network→get_wwwWatchdogDelay()
Retourne 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→isOnline()
Vérifie si le module hébergeant l'interface réseau est joignable, sans déclencher d'erreur.
network→isOnline_async(callback, context)
Vérifie si le module hébergeant l'interface réseau est joignable, sans déclencher d'erreur.
network→isReadOnly()
Test si la fonction est en lecture seule.
network→load(msValidity)
Met en cache les valeurs courantes de l'interface réseau, avec une durée de validité spécifiée.
network→loadAttribute(attrName)
Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.
network→load_async(msValidity, callback, context)
Met en cache les valeurs courantes de l'interface réseau, avec une durée de validité spécifiée.
network→muteValueCallbacks()
Désactive l'envoi de chaque changement de la valeur publiée au hub parent.
network→nextNetwork()
Continue l'énumération des interfaces réseau commencée à l'aide de yFirstNetwork() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les interfaces réseau sont retournés.
network→ping(host)
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.
network→set_callbackCredentials(newval)
Modifie le laisser-passer pour se connecter à l'adresse de callback.
network→set_callbackEncoding(newval)
Modifie l'encodage à utiliser pour représenter les valeurs notifiées par callback.
network→set_callbackInitialDelay(newval)
Modifie l'attente initiale avant la première notification par callback, en secondes.
network→set_callbackMaxDelay(newval)
Modifie l'attente entre deux callback HTTP lorsque rien n'est à signaler.
network→set_callbackMethod(newval)
Modifie la méthode HTTP à utiliser pour signaler les changements d'état par callback.
network→set_callbackMinDelay(newval)
Modifie l'attente minimale entre deux callbacks HTTP, en secondes.
network→set_callbackSchedule(newval)
Modifie la planification des callbacks HTTP, sous forme de chaîne de caractères.
network→set_callbackUrl(newval)
Modifie l'adresse (URL) de callback à notifier lors de changement d'état significatifs.
network→set_defaultPage(newval)
Modifie la page HTML par défaut du hub.
network→set_discoverable(newval)
Modifie l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour).
network→set_httpPort(newval)
Modifie le port TCP utilisé pour l'interface Web du hub.
network→set_logicalName(newval)
Modifie le nom logique de l'interface réseau.
network→set_ntpServer(newval)
Modifie l'adresse IP du serveur NTP que le module doit utiliser.
network→set_periodicCallbackSchedule(interval, offset)
Configure la planification de callbacks HTTP périodiques (fonction simplifiée).
network→set_primaryDNS(newval)
Modifie l'adresse IP du serveur de noms primaire que le module doit utiliser.
network→set_secondaryDNS(newval)
Modifie l'adresse IP du serveur de nom secondaire que le module doit utiliser.
network→set_userData(data)
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.
network→set_userPassword(newval)
Modifie le mode de passe pour l'utilisateur "user", qui devient alors instantanément nécessaire pour tout accès au module.
network→set_wwwWatchdogDelay(newval)
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)
Modifie la configuration de l'interface réseau pour utiliser une adresse assignée automatiquement par le serveur DHCP.
network→useDHCPauto()
Modifie la configuration de l'interface réseau pour utiliser une adresse assignée automatiquement par le serveur DHCP.
network→useStaticIP(ipAddress, subnetMaskLen, router)
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.

YNetwork.FindNetwork()
yFindNetwork()yFindNetwork()yFindNetwork()[YNetwork FindNetwork: ]yFindNetwork()yFindNetwork()YNetwork.FindNetwork()YNetwork.FindNetwork()YNetwork.FindNetwork()YNetwork.FindNetwork()yFindNetwork()YNetwork.FindNetwork()

Permet de retrouver une interface réseau d'après un identifiant donné.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que l'interface réseau soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YNetwork.isOnline() pour tester si l'interface réseau est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Si un appel à la méthode is_online() de cet objet renvoie FAUX alors que vous êtes sûr que le module correspondant est bien branché, vérifiez que vous n'avez pas oublié d'appeler registerHub() à l'initialisation de de l'application.

Paramètres :

Retourne :

un objet de classe YNetwork qui permet ensuite de contrôler l'interface réseau.

YNetwork.FindNetworkInContext()
yFindNetworkInContext()YNetwork.FindNetworkInContext()YNetwork.FindNetworkInContext()YNetwork.FindNetworkInContext()

Permet de retrouver une interface réseau d'après un identifiant donné dans un Context YAPI.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que l'interface réseau soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YNetwork.isOnline() pour tester si l'interface réseau est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres :

Retourne :

un objet de classe YNetwork qui permet ensuite de contrôler l'interface réseau.

YNetwork.FirstNetwork()
yFirstNetwork()yFirstNetwork()yFirstNetwork()[YNetwork FirstNetwork]yFirstNetwork()yFirstNetwork()YNetwork.FirstNetwork()YNetwork.FirstNetwork()YNetwork.FirstNetwork()YNetwork.FirstNetwork()yFirstNetwork()YNetwork.FirstNetwork()

Commence l'énumération des interfaces réseau accessibles par la librairie.

Utiliser la fonction YNetwork.nextNetwork() pour itérer sur les autres interfaces réseau.

Retourne :

un pointeur sur un objet YNetwork, correspondant à la première interface réseau accessible en ligne, ou null si il n'y a pas de interfaces réseau disponibles.

YNetwork.FirstNetworkInContext()
yFirstNetworkInContext()YNetwork.FirstNetworkInContext()YNetwork.FirstNetworkInContext()YNetwork.FirstNetworkInContext()

Commence l'énumération des interfaces réseau accessibles par la librairie.

Utiliser la fonction YNetwork.nextNetwork() pour itérer sur les autres interfaces réseau.

Paramètres :

Retourne :

un pointeur sur un objet YNetwork, correspondant à la première interface réseau accessible en ligne, ou null si il n'y a pas de interfaces réseau disponibles.

network→callbackLogin()network.callbackLogin()network→callbackLogin()[network callbackLogin: ]network.callbackLogin()network.callbackLogin()network.callbackLogin()network.callbackLogin()network.callbackLogin()network→callbackLogin()network.callbackLogin()YNetwork callbackLogin

Contacte le callback de notification et sauvegarde un laisser-passer pour s'y connecter.

Le mot de passe ne sera pas stocké dans le module, mais seulement une version hashée non réversible. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→clearCache()network.clearCache()network→clearCache()[network clearCache]network.clearCache()network.clearCache()network.clearCache()network.clearCache()network.clearCache()network→clearCache()network.clearCache()

Invalide le cache.

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.

network→describe()network.describe()network→describe()[network describe]network.describe()network.describe()network.describe()network.describe()network.describe()network→describe()network.describe()

Retourne un court texte décrivant de manière non-ambigüe l'instance de l'interface réseau au format TYPE(NAME)=SERIAL.FUNCTIONID.

Plus précisément, TYPE correspond au type de fonction, NAME correspond au nom utilsé lors du premier accès a la fonction, SERIAL correspond au numéro de série du module si le module est connecté, ou "unresolved" sinon, et FUNCTIONID correspond à l'identifiant matériel de la fonction si le module est connecté. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est déjà connecté ou Relay(BadCustomeName.relay1)=unresolved si le module n'est pas déjà connecté. Cette methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur.

Retourne :

une chaîne de caractères décrivant l'interface réseau (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)

network→get_adminPassword()
network→adminPassword()network.get_adminPassword()network→get_adminPassword()[network adminPassword]network.get_adminPassword()network.get_adminPassword()network.get_adminPassword()network.get_adminPassword()network.get_adminPassword()network.get_adminPassword()network→get_adminPassword()network.get_adminPassword()YNetwork get_adminPassword

Retourne une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "admin", ou sinon une chaîne vide.

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.

network→get_advertisedValue()
network→advertisedValue()network.get_advertisedValue()network→get_advertisedValue()[network advertisedValue]network.get_advertisedValue()network.get_advertisedValue()network.get_advertisedValue()network.get_advertisedValue()network.get_advertisedValue()network.get_advertisedValue()network→get_advertisedValue()network.get_advertisedValue()YNetwork get_advertisedValue

Retourne la valeur courante de l'interface réseau (pas plus de 6 caractères).

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.

network→get_callbackCredentials()
network→callbackCredentials()network.get_callbackCredentials()network→get_callbackCredentials()[network callbackCredentials]network.get_callbackCredentials()network.get_callbackCredentials()network.get_callbackCredentials()network.get_callbackCredentials()network.get_callbackCredentials()network.get_callbackCredentials()network→get_callbackCredentials()network.get_callbackCredentials()YNetwork get_callbackCredentials

Retourne une version hashée du laisser-passer pour le callback de notification s'il a été configuré, ou sinon une chaîne vide.

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.

network→get_callbackEncoding()
network→callbackEncoding()network.get_callbackEncoding()network→get_callbackEncoding()[network callbackEncoding]network.get_callbackEncoding()network.get_callbackEncoding()network.get_callbackEncoding()network.get_callbackEncoding()network.get_callbackEncoding()network.get_callbackEncoding()network→get_callbackEncoding()network.get_callbackEncoding()YNetwork get_callbackEncoding

Retourne l'encodage à utiliser pour représenter les valeurs notifiées par callback.

Retourne :

une valeur parmi Y_CALLBACKENCODING_FORM, Y_CALLBACKENCODING_JSON, Y_CALLBACKENCODING_JSON_ARRAY, Y_CALLBACKENCODING_CSV, Y_CALLBACKENCODING_YOCTO_API, Y_CALLBACKENCODING_JSON_NUM, Y_CALLBACKENCODING_EMONCMS, Y_CALLBACKENCODING_AZURE, Y_CALLBACKENCODING_INFLUXDB, Y_CALLBACKENCODING_MQTT, Y_CALLBACKENCODING_YOCTO_API_JZON et 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.

network→get_callbackInitialDelay()
network→callbackInitialDelay()network.get_callbackInitialDelay()network→get_callbackInitialDelay()[network callbackInitialDelay]network.get_callbackInitialDelay()network.get_callbackInitialDelay()network.get_callbackInitialDelay()network.get_callbackInitialDelay()network.get_callbackInitialDelay()network.get_callbackInitialDelay()network→get_callbackInitialDelay()network.get_callbackInitialDelay()YNetwork get_callbackInitialDelay

Retourne l'attente initiale avant la première notification par callback, en secondes.

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.

network→get_callbackMaxDelay()
network→callbackMaxDelay()network.get_callbackMaxDelay()network→get_callbackMaxDelay()[network callbackMaxDelay]network.get_callbackMaxDelay()network.get_callbackMaxDelay()network.get_callbackMaxDelay()network.get_callbackMaxDelay()network.get_callbackMaxDelay()network.get_callbackMaxDelay()network→get_callbackMaxDelay()network.get_callbackMaxDelay()YNetwork get_callbackMaxDelay

Retourne l'attente entre deux callback HTTP lorsque rien n'est à signaler, en secondes.

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.

network→get_callbackMethod()
network→callbackMethod()network.get_callbackMethod()network→get_callbackMethod()[network callbackMethod]network.get_callbackMethod()network.get_callbackMethod()network.get_callbackMethod()network.get_callbackMethod()network.get_callbackMethod()network.get_callbackMethod()network→get_callbackMethod()network.get_callbackMethod()YNetwork get_callbackMethod

Retourne la méthode HTTP à utiliser pour signaler les changements d'état par callback.

Retourne :

une valeur parmi Y_CALLBACKMETHOD_POST, Y_CALLBACKMETHOD_GET et 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.

network→get_callbackMinDelay()
network→callbackMinDelay()network.get_callbackMinDelay()network→get_callbackMinDelay()[network callbackMinDelay]network.get_callbackMinDelay()network.get_callbackMinDelay()network.get_callbackMinDelay()network.get_callbackMinDelay()network.get_callbackMinDelay()network.get_callbackMinDelay()network→get_callbackMinDelay()network.get_callbackMinDelay()YNetwork get_callbackMinDelay

Retourne l'attente minimale entre deux callbacks HTTP, en secondes.

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.

network→get_callbackSchedule()
network→callbackSchedule()network.get_callbackSchedule()network→get_callbackSchedule()[network callbackSchedule]network.get_callbackSchedule()network.get_callbackSchedule()network.get_callbackSchedule()network.get_callbackSchedule()network.get_callbackSchedule()network.get_callbackSchedule()network→get_callbackSchedule()network.get_callbackSchedule()YNetwork get_callbackSchedule

Retourne la planification des callbacks HTTP, sous forme de chaîne de caractères.

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.

network→get_callbackUrl()
network→callbackUrl()network.get_callbackUrl()network→get_callbackUrl()[network callbackUrl]network.get_callbackUrl()network.get_callbackUrl()network.get_callbackUrl()network.get_callbackUrl()network.get_callbackUrl()network.get_callbackUrl()network→get_callbackUrl()network.get_callbackUrl()YNetwork get_callbackUrl

Retourne l'adresse (URL) de callback à notifier lors de changement d'état significatifs.

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.

network→get_defaultPage()
network→defaultPage()network.get_defaultPage()network→get_defaultPage()[network defaultPage]network.get_defaultPage()network.get_defaultPage()network.get_defaultPage()network.get_defaultPage()network.get_defaultPage()network.get_defaultPage()network→get_defaultPage()network.get_defaultPage()YNetwork get_defaultPage

Retourne la page HTML à envoyer pour l'URL "/"

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.

network→get_discoverable()
network→discoverable()network.get_discoverable()network→get_discoverable()[network discoverable]network.get_discoverable()network.get_discoverable()network.get_discoverable()network.get_discoverable()network.get_discoverable()network.get_discoverable()network→get_discoverable()network.get_discoverable()YNetwork get_discoverable

Retourne l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour).

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.

network→get_errorMessage()
network→errorMessage()network.get_errorMessage()network→get_errorMessage()[network errorMessage]network.get_errorMessage()network.get_errorMessage()network.get_errorMessage()network.get_errorMessage()network.get_errorMessage()network→get_errorMessage()network.get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau.

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.

network→get_errorType()
network→errorType()network.get_errorType()network→get_errorType()[network errorType]network.get_errorType()network.get_errorType()network.get_errorType()network.get_errorType()network.get_errorType()network→get_errorType()network.get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau.

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.

network→get_friendlyName()
network→friendlyName()network.get_friendlyName()network→get_friendlyName()[network friendlyName]network.get_friendlyName()network.get_friendlyName()network.get_friendlyName()network→get_friendlyName()network.get_friendlyName()

Retourne un identifiant global de l'interface réseau au format NOM_MODULE.NOM_FONCTION.

Le chaîne retournée utilise soit les noms logiques du module et de l'interface réseau si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de l'interface réseau (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.

network→get_functionDescriptor()
network→functionDescriptor()network.get_functionDescriptor()network→get_functionDescriptor()[network functionDescriptor]network.get_functionDescriptor()network.get_functionDescriptor()network.get_functionDescriptor()network.get_functionDescriptor()network.get_functionDescriptor()network→get_functionDescriptor()network.get_functionDescriptor()

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

Cet identifiant peut être utilisé pour tester si deux instance de YFunction référencent physiquement la même fonction sur le même module.

Retourne :

un identifiant de type YFUN_DESCR.

Si la fonction n'a jamais été contactée, la valeur retournée sera Y_FUNCTIONDESCRIPTOR_INVALID

network→get_functionId()
network→functionId()network.get_functionId()network→get_functionId()[network functionId]network.get_functionId()network.get_functionId()network.get_functionId()network.get_functionId()network→get_functionId()network.get_functionId()

Retourne l'identifiant matériel de l'interface réseau, sans référence au module.

Par example relay1.

Retourne :

une chaîne de caractères identifiant l'interface réseau (ex: relay1)

En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID.

network→get_hardwareId()
network→hardwareId()network.get_hardwareId()network→get_hardwareId()[network hardwareId]network.get_hardwareId()network.get_hardwareId()network.get_hardwareId()network.get_hardwareId()network→get_hardwareId()network.get_hardwareId()

Retourne l'identifiant matériel unique de l'interface réseau au format SERIAL.FUNCTIONID.

L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'interface réseau (par example RELAYLO1-123456.relay1).

Retourne :

une chaîne de caractères identifiant l'interface réseau (ex: RELAYLO1-123456.relay1)

En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID.

network→get_httpPort()
network→httpPort()network.get_httpPort()network→get_httpPort()[network httpPort]network.get_httpPort()network.get_httpPort()network.get_httpPort()network.get_httpPort()network.get_httpPort()network.get_httpPort()network→get_httpPort()network.get_httpPort()YNetwork get_httpPort

Retourne le port TCP utilisé pour l'interface Web du hub.

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.

network→get_ipAddress()
network→ipAddress()network.get_ipAddress()network→get_ipAddress()[network ipAddress]network.get_ipAddress()network.get_ipAddress()network.get_ipAddress()network.get_ipAddress()network.get_ipAddress()network.get_ipAddress()network→get_ipAddress()network.get_ipAddress()YNetwork get_ipAddress

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.

network→get_ipConfig()
network→ipConfig()network.get_ipConfig()network→get_ipConfig()[network ipConfig]network.get_ipConfig()network.get_ipConfig()network.get_ipConfig()network.get_ipConfig()network.get_ipConfig()network.get_ipConfig()network→get_ipConfig()network.get_ipConfig()YNetwork get_ipConfig

Retourne la configuration IP de l'interface réseau.

Si l'interface réseau est configurée pour utiliser une adresse IP assignée manuellement (adresse IP statique) la chaîne commence par "STATIC:" et est suivie pas l'adresse IP, la longueur du masque de sous-réseau et l'adresse IP de la passerelle. Ces trois paramètres sont séparés par le caractère "/". Par exemple: "STATIC:192.168.1.14/16/192.168.1.1"

Si l'interface réseau est configurée pour utiliser une adresse assignée automatiquement par DHCP la chaîne commence par "DHCP:" et est suivie d'une adresse IP, d'une longueur du masque de sous-réseau et d'une adresse 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.

network→get_logicalName()
network→logicalName()network.get_logicalName()network→get_logicalName()[network logicalName]network.get_logicalName()network.get_logicalName()network.get_logicalName()network.get_logicalName()network.get_logicalName()network.get_logicalName()network→get_logicalName()network.get_logicalName()YNetwork get_logicalName

Retourne le nom logique de l'interface réseau.

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.

network→get_macAddress()
network→macAddress()network.get_macAddress()network→get_macAddress()[network macAddress]network.get_macAddress()network.get_macAddress()network.get_macAddress()network.get_macAddress()network.get_macAddress()network.get_macAddress()network→get_macAddress()network.get_macAddress()YNetwork get_macAddress

Retourne l'adresse MAC de l'interface réseau, unique pour chaque module.

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.

network→get_module()
network→module()network.get_module()network→get_module()[network module]network.get_module()network.get_module()network.get_module()network.get_module()network.get_module()network→get_module()network.get_module()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Retourne :

une instance de YModule

network→get_module_async()
network→module_async()network.get_module_async()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

network→get_ntpServer()
network→ntpServer()network.get_ntpServer()network→get_ntpServer()[network ntpServer]network.get_ntpServer()network.get_ntpServer()network.get_ntpServer()network.get_ntpServer()network.get_ntpServer()network.get_ntpServer()network→get_ntpServer()network.get_ntpServer()YNetwork get_ntpServer

Retourne l'adresse IP du serveur de NTP à utiliser pour maintenir le module à l'heure.

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.

network→get_poeCurrent()
network→poeCurrent()network.get_poeCurrent()network→get_poeCurrent()[network poeCurrent]network.get_poeCurrent()network.get_poeCurrent()network.get_poeCurrent()network.get_poeCurrent()network.get_poeCurrent()network.get_poeCurrent()network→get_poeCurrent()network.get_poeCurrent()YNetwork get_poeCurrent

Retourne le courant consommé par le module depuis Power-over-Ethernet (PoE), en milliampères.

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.

network→get_primaryDNS()
network→primaryDNS()network.get_primaryDNS()network→get_primaryDNS()[network primaryDNS]network.get_primaryDNS()network.get_primaryDNS()network.get_primaryDNS()network.get_primaryDNS()network.get_primaryDNS()network.get_primaryDNS()network→get_primaryDNS()network.get_primaryDNS()YNetwork get_primaryDNS

Retourne l'adresse IP du serveur de noms primaire que le module doit utiliser.

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.

network→get_readiness()
network→readiness()network.get_readiness()network→get_readiness()[network readiness]network.get_readiness()network.get_readiness()network.get_readiness()network.get_readiness()network.get_readiness()network.get_readiness()network→get_readiness()network.get_readiness()YNetwork get_readiness

Retourne l'état de fonctionnement atteint par l'interface réseau.

Le niveau zéro (DOWN_0) signifie qu'aucun support réseau matériel n'a été détecté. Soit il n'y a pas de signal sur le cable réseau, soit le point d'accès sans fil choisi n'est pas détecté. Le niveau 1 (LIVE_1) est atteint lorsque le réseau est détecté, mais n'est pas encore connecté. Pour un réseau sans fil, cela confirme la l'existence du SSID configuré. Le niveau 2 (LINK_2) est atteint lorsque le support matériel du réseau est fonctionnel. Pour une connection réseau filaire, le niveau 2 signifie que le cable est connecté aux deux bouts. Pour une connection à un point d'accès réseau sans fil, il démontre que les paramètres de sécurités configurés sont corrects. Pour une connection sans fil en mode ad-hoc, cela signifie qu'il y a au moins un partenaire sur le réseau ad-hoc. Le niveau 3 (DHCP_3) est atteint lorsque qu'une adresse IP a été obtenue par DHCP. Le niveau 4 (DNS_4) est atteint lorsqu'un serveur DNS est joignable par le réseau. Le niveau 5 (WWW_5) est atteint lorsque la connectivité globale à internet est avérée par l'obtention de l'heure courante sur une serveur NTP.

Retourne :

une valeur parmi Y_READINESS_DOWN, Y_READINESS_EXISTS, Y_READINESS_LINKED, Y_READINESS_LAN_OK et 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.

network→get_router()
network→router()network.get_router()network→get_router()[network router]network.get_router()network.get_router()network.get_router()network.get_router()network.get_router()network.get_router()network→get_router()network.get_router()YNetwork get_router

Retourne l'adresse IP du routeur (passerelle) utilisé par le module (default gateway).

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.

network→get_secondaryDNS()
network→secondaryDNS()network.get_secondaryDNS()network→get_secondaryDNS()[network secondaryDNS]network.get_secondaryDNS()network.get_secondaryDNS()network.get_secondaryDNS()network.get_secondaryDNS()network.get_secondaryDNS()network.get_secondaryDNS()network→get_secondaryDNS()network.get_secondaryDNS()YNetwork get_secondaryDNS

Retourne l'adresse IP du serveur de noms secondaire que le module doit utiliser.

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.

network→get_serialNumber()
network→serialNumber()network.get_serialNumber()network→get_serialNumber()[network serialNumber]network.get_serialNumber()network.get_serialNumber()network.get_serialNumber()network.get_serialNumber()network.get_serialNumber()network.get_serialNumber()network→get_serialNumber()network.get_serialNumber()YNetwork get_serialNumber

Retourne le numéro de série du module, préprogrammé en usine.

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.

network→get_subnetMask()
network→subnetMask()network.get_subnetMask()network→get_subnetMask()[network subnetMask]network.get_subnetMask()network.get_subnetMask()network.get_subnetMask()network.get_subnetMask()network.get_subnetMask()network.get_subnetMask()network→get_subnetMask()network.get_subnetMask()YNetwork get_subnetMask

Retourne le masque de sous-réseau utilisé par le module.

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.

network→get_userData()
network→userData()network.get_userData()network→get_userData()[network userData]network.get_userData()network.get_userData()network.get_userData()network.get_userData()network.get_userData()network→get_userData()network.get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_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.

network→get_userPassword()
network→userPassword()network.get_userPassword()network→get_userPassword()[network userPassword]network.get_userPassword()network.get_userPassword()network.get_userPassword()network.get_userPassword()network.get_userPassword()network.get_userPassword()network→get_userPassword()network.get_userPassword()YNetwork get_userPassword

Retourne une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "user", ou sinon une chaîne vide.

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.

network→get_wwwWatchdogDelay()
network→wwwWatchdogDelay()network.get_wwwWatchdogDelay()network→get_wwwWatchdogDelay()[network wwwWatchdogDelay]network.get_wwwWatchdogDelay()network.get_wwwWatchdogDelay()network.get_wwwWatchdogDelay()network.get_wwwWatchdogDelay()network.get_wwwWatchdogDelay()network.get_wwwWatchdogDelay()network→get_wwwWatchdogDelay()network.get_wwwWatchdogDelay()YNetwork get_wwwWatchdogDelay

Retourne 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.

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.

network→isOnline()network.isOnline()network→isOnline()[network isOnline]network.isOnline()network.isOnline()network.isOnline()network.isOnline()network.isOnline()network→isOnline()network.isOnline()

Vérifie si le module hébergeant l'interface réseau est joignable, sans déclencher d'erreur.

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

network→isOnline_async()network.isOnline_async()

Vérifie si le module hébergeant l'interface réseau est joignable, sans déclencher d'erreur.

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é.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

network→isReadOnly()network→isReadOnly()[network isReadOnly]network.isReadOnly()network.isReadOnly()network.isReadOnly()network.isReadOnly()network.isReadOnly()network.isReadOnly()network→isReadOnly()network.isReadOnly()YNetwork isReadOnly

Test si la fonction est en lecture seule.

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

network→load()network.load()network→load()[network load: ]network.load()network.load()network.load()network.load()network.load()network→load()network.load()

Met en cache les valeurs courantes de l'interface réseau, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→loadAttribute()network.loadAttribute()network→loadAttribute()[network loadAttribute: ]network.loadAttribute()network.loadAttribute()network.loadAttribute()network.loadAttribute()network.loadAttribute()network.loadAttribute()network→loadAttribute()network.loadAttribute()

Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.

Paramètres :

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.

network→load_async()network.load_async()

Met en cache les valeurs courantes de l'interface réseau, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

network→muteValueCallbacks()network.muteValueCallbacks()network→muteValueCallbacks()[network muteValueCallbacks]network.muteValueCallbacks()network.muteValueCallbacks()network.muteValueCallbacks()network.muteValueCallbacks()network.muteValueCallbacks()network.muteValueCallbacks()network→muteValueCallbacks()network.muteValueCallbacks()YNetwork muteValueCallbacks

Désactive l'envoi de chaque changement de la valeur publiée au hub parent.

Vous pouvez utiliser cette fonction pour économiser la bande passante et le CPU sur les machines de faible puissance, ou pour éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→nextNetwork()network.nextNetwork()network→nextNetwork()[network nextNetwork]network.nextNetwork()network.nextNetwork()network.nextNetwork()network.nextNetwork()network.nextNetwork()network.nextNetwork()network→nextNetwork()network.nextNetwork()

Continue l'énumération des interfaces réseau commencée à l'aide de yFirstNetwork() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les interfaces réseau sont retournés.

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.

network→ping()network.ping()network→ping()[network ping: ]network.ping()network.ping()network.ping()network.ping()network.ping()network.ping()network→ping()network.ping()YNetwork ping

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 :

Retourne :

une chaîne de caractères contenant le résultat du ping.

network→registerValueCallback()network.registerValueCallback()network→registerValueCallback()[network registerValueCallback: ]network.registerValueCallback()network.registerValueCallback()network.registerValueCallback()network.registerValueCallback()network.registerValueCallback()network.registerValueCallback()network→registerValueCallback()network.registerValueCallback()

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

Ce callback n'est appelé que durant l'exécution de ySleep ou yHandleEvents. Cela permet à l'appelant de contrôler quand les callback peuvent se produire. Il est important d'appeler l'une de ces deux fonctions périodiquement pour garantir que les callback ne soient pas appelés trop tard. Pour désactiver un callback, il suffit d'appeler cette méthode en lui passant un pointeur nul.

Paramètres :

network→set_adminPassword()
network→setAdminPassword()network.set_adminPassword()network→set_adminPassword()[network setAdminPassword: ]network.set_adminPassword()network.set_adminPassword()network.set_adminPassword()network.set_adminPassword()network.set_adminPassword()network.set_adminPassword()network→set_adminPassword()network.set_adminPassword()YNetwork set_adminPassword

Modifie le mot de passe pour l'utilisateur "admin", qui devient alors instantanément nécessaire pour toute altération de l'état du module.

Si la valeur fournie est une chaîne vide, plus aucun mot de passe n'est nécessaire. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackCredentials()
network→setCallbackCredentials()network.set_callbackCredentials()network→set_callbackCredentials()[network setCallbackCredentials: ]network.set_callbackCredentials()network.set_callbackCredentials()network.set_callbackCredentials()network.set_callbackCredentials()network.set_callbackCredentials()network.set_callbackCredentials()network→set_callbackCredentials()network.set_callbackCredentials()YNetwork set_callbackCredentials

Modifie le laisser-passer pour se connecter à l'adresse de callback.

Le laisser-passer doit être fourni tel que retourné par la fonction get_callbackCredentials, sous la forme username:hash. La valeur du hash dépend de la méthode d'autorisation implémentée par le callback. Pour une autorisation de type Basic, le hash est le MD5 de la chaîne username:password. Pour une autorisation de type Digest, le hash est le MD5 de la chaîne username:realm:password. Pour une utilisation simplifiée, utilisez la fonction callbackLogin. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackEncoding()
network→setCallbackEncoding()network.set_callbackEncoding()network→set_callbackEncoding()[network setCallbackEncoding: ]network.set_callbackEncoding()network.set_callbackEncoding()network.set_callbackEncoding()network.set_callbackEncoding()network.set_callbackEncoding()network.set_callbackEncoding()network→set_callbackEncoding()network.set_callbackEncoding()YNetwork set_callbackEncoding

Modifie l'encodage à utiliser pour représenter les valeurs notifiées par callback.

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackInitialDelay()
network→setCallbackInitialDelay()network.set_callbackInitialDelay()network→set_callbackInitialDelay()[network setCallbackInitialDelay: ]network.set_callbackInitialDelay()network.set_callbackInitialDelay()network.set_callbackInitialDelay()network.set_callbackInitialDelay()network.set_callbackInitialDelay()network.set_callbackInitialDelay()network→set_callbackInitialDelay()network.set_callbackInitialDelay()YNetwork set_callbackInitialDelay

Modifie l'attente initiale avant la première notification par callback, en secondes.

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackMaxDelay()
network→setCallbackMaxDelay()network.set_callbackMaxDelay()network→set_callbackMaxDelay()[network setCallbackMaxDelay: ]network.set_callbackMaxDelay()network.set_callbackMaxDelay()network.set_callbackMaxDelay()network.set_callbackMaxDelay()network.set_callbackMaxDelay()network.set_callbackMaxDelay()network→set_callbackMaxDelay()network.set_callbackMaxDelay()YNetwork set_callbackMaxDelay

Modifie l'attente entre deux callback HTTP lorsque rien n'est à signaler.

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackMethod()
network→setCallbackMethod()network.set_callbackMethod()network→set_callbackMethod()[network setCallbackMethod: ]network.set_callbackMethod()network.set_callbackMethod()network.set_callbackMethod()network.set_callbackMethod()network.set_callbackMethod()network.set_callbackMethod()network→set_callbackMethod()network.set_callbackMethod()YNetwork set_callbackMethod

Modifie la méthode HTTP à utiliser pour signaler les changements d'état par callback.

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackMinDelay()
network→setCallbackMinDelay()network.set_callbackMinDelay()network→set_callbackMinDelay()[network setCallbackMinDelay: ]network.set_callbackMinDelay()network.set_callbackMinDelay()network.set_callbackMinDelay()network.set_callbackMinDelay()network.set_callbackMinDelay()network.set_callbackMinDelay()network→set_callbackMinDelay()network.set_callbackMinDelay()YNetwork set_callbackMinDelay

Modifie l'attente minimale entre deux callbacks HTTP, en secondes.

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackSchedule()
network→setCallbackSchedule()network.set_callbackSchedule()network→set_callbackSchedule()[network setCallbackSchedule: ]network.set_callbackSchedule()network.set_callbackSchedule()network.set_callbackSchedule()network.set_callbackSchedule()network.set_callbackSchedule()network.set_callbackSchedule()network→set_callbackSchedule()network.set_callbackSchedule()YNetwork set_callbackSchedule

Modifie la planification des callbacks HTTP, sous forme de chaîne de caractères.

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_callbackUrl()
network→setCallbackUrl()network.set_callbackUrl()network→set_callbackUrl()[network setCallbackUrl: ]network.set_callbackUrl()network.set_callbackUrl()network.set_callbackUrl()network.set_callbackUrl()network.set_callbackUrl()network.set_callbackUrl()network→set_callbackUrl()network.set_callbackUrl()YNetwork set_callbackUrl

Modifie l'adresse (URL) de callback à notifier lors de changement d'état significatifs.

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_defaultPage()
network→setDefaultPage()network.set_defaultPage()network→set_defaultPage()[network setDefaultPage: ]network.set_defaultPage()network.set_defaultPage()network.set_defaultPage()network.set_defaultPage()network.set_defaultPage()network.set_defaultPage()network→set_defaultPage()network.set_defaultPage()YNetwork set_defaultPage

Modifie la page HTML par défaut du hub.

Si aucune valeur n'est attribuée le hub retourne index.html qui est l'interface web du hub. Il est possible de changer cet page pour un fichier qui a été uploadé sur le hub. Attention, la taille maximale permise pour le nom de fichier est de 15 caractères. Si vous changez ce paramètre, n'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_discoverable()
network→setDiscoverable()network.set_discoverable()network→set_discoverable()[network setDiscoverable: ]network.set_discoverable()network.set_discoverable()network.set_discoverable()network.set_discoverable()network.set_discoverable()network.set_discoverable()network→set_discoverable()network.set_discoverable()YNetwork set_discoverable

Modifie l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour).

N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_httpPort()
network→setHttpPort()network.set_httpPort()network→set_httpPort()[network setHttpPort: ]network.set_httpPort()network.set_httpPort()network.set_httpPort()network.set_httpPort()network.set_httpPort()network.set_httpPort()network→set_httpPort()network.set_httpPort()YNetwork set_httpPort

Modifie le port TCP utilisé pour l'interface Web du hub.

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é.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_logicalName()
network→setLogicalName()network.set_logicalName()network→set_logicalName()[network setLogicalName: ]network.set_logicalName()network.set_logicalName()network.set_logicalName()network.set_logicalName()network.set_logicalName()network.set_logicalName()network→set_logicalName()network.set_logicalName()YNetwork set_logicalName

Modifie le nom logique de l'interface réseau.

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

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.

network→set_ntpServer()
network→setNtpServer()network.set_ntpServer()network→set_ntpServer()[network setNtpServer: ]network.set_ntpServer()network.set_ntpServer()network.set_ntpServer()network.set_ntpServer()network.set_ntpServer()network.set_ntpServer()network→set_ntpServer()network.set_ntpServer()YNetwork set_ntpServer

Modifie l'adresse IP du serveur NTP que le module doit utiliser.

Utilisez une chaine vide pour restaurer l'adresse pré-configurée en usine. N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_periodicCallbackSchedule()
network→setPeriodicCallbackSchedule()network.set_periodicCallbackSchedule()network→set_periodicCallbackSchedule()[network setPeriodicCallbackSchedule: ]network.set_periodicCallbackSchedule()network.set_periodicCallbackSchedule()network.set_periodicCallbackSchedule()network.set_periodicCallbackSchedule()network.set_periodicCallbackSchedule()network.set_periodicCallbackSchedule()network→set_periodicCallbackSchedule()network.set_periodicCallbackSchedule()YNetwork set_periodicCallbackSchedule

Configure la planification de callbacks HTTP périodiques (fonction simplifiée).

Paramètres :

Retourne :

YAPI_SUCCESS when the call succeeds.

On failure, throws an exception or returns a negative error code.

network→set_primaryDNS()
network→setPrimaryDNS()network.set_primaryDNS()network→set_primaryDNS()[network setPrimaryDNS: ]network.set_primaryDNS()network.set_primaryDNS()network.set_primaryDNS()network.set_primaryDNS()network.set_primaryDNS()network.set_primaryDNS()network→set_primaryDNS()network.set_primaryDNS()YNetwork set_primaryDNS

Modifie l'adresse IP du serveur de noms primaire que le module doit utiliser.

En mode DHCP, si une valeur est spécifiée, elle remplacera celle reçue du serveur DHCP. N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_secondaryDNS()
network→setSecondaryDNS()network.set_secondaryDNS()network→set_secondaryDNS()[network setSecondaryDNS: ]network.set_secondaryDNS()network.set_secondaryDNS()network.set_secondaryDNS()network.set_secondaryDNS()network.set_secondaryDNS()network.set_secondaryDNS()network→set_secondaryDNS()network.set_secondaryDNS()YNetwork set_secondaryDNS

Modifie l'adresse IP du serveur de nom secondaire que le module doit utiliser.

En mode DHCP, si une valeur est spécifiée, elle remplacera celle reçue du serveur DHCP. N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_userData()
network→setUserData()network.set_userData()network→set_userData()[network setUserData: ]network.set_userData()network.set_userData()network.set_userData()network.set_userData()network.set_userData()network→set_userData()network.set_userData()

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.

Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte.

Paramètres :

network→set_userPassword()
network→setUserPassword()network.set_userPassword()network→set_userPassword()[network setUserPassword: ]network.set_userPassword()network.set_userPassword()network.set_userPassword()network.set_userPassword()network.set_userPassword()network.set_userPassword()network→set_userPassword()network.set_userPassword()YNetwork set_userPassword

Modifie le mode de passe pour l'utilisateur "user", qui devient alors instantanément nécessaire pour tout accès au module.

Si la valeur fournie est une chaîne vide, plus aucun mot de passe n'est nécessaire. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→set_wwwWatchdogDelay()
network→setWwwWatchdogDelay()network.set_wwwWatchdogDelay()network→set_wwwWatchdogDelay()[network setWwwWatchdogDelay: ]network.set_wwwWatchdogDelay()network.set_wwwWatchdogDelay()network.set_wwwWatchdogDelay()network.set_wwwWatchdogDelay()network.set_wwwWatchdogDelay()network.set_wwwWatchdogDelay()network→set_wwwWatchdogDelay()network.set_wwwWatchdogDelay()YNetwork set_wwwWatchdogDelay

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.

Une valeur nulle désactive le redémarrage automatique en cas de perte de connectivité WWW. La plus petite durée non-nulle utilisable est 90 secondes. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→triggerCallback()network.triggerCallback()network→triggerCallback()[network triggerCallback]network.triggerCallback()network.triggerCallback()network.triggerCallback()network.triggerCallback()network.triggerCallback()network.triggerCallback()network→triggerCallback()network.triggerCallback()YNetwork triggerCallback

Déclenche un callback HTTP rapidement.

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.

network→unmuteValueCallbacks()network.unmuteValueCallbacks()network→unmuteValueCallbacks()[network unmuteValueCallbacks]network.unmuteValueCallbacks()network.unmuteValueCallbacks()network.unmuteValueCallbacks()network.unmuteValueCallbacks()network.unmuteValueCallbacks()network.unmuteValueCallbacks()network→unmuteValueCallbacks()network.unmuteValueCallbacks()YNetwork unmuteValueCallbacks

Réactive l'envoi de chaque changement de la valeur publiée au hub parent.

Cette fonction annule un précédent appel à muteValueCallbacks(). N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→useDHCP()network.useDHCP()network→useDHCP()[network useDHCP: ]network.useDHCP()network.useDHCP()network.useDHCP()network.useDHCP()network.useDHCP()network.useDHCP()network→useDHCP()network.useDHCP()YNetwork useDHCP

Modifie la configuration de l'interface réseau pour utiliser une adresse assignée automatiquement par le serveur DHCP.

En attendant qu'une adresse soit reçue (et indéfiniment si aucun serveur DHCP ne répond), le module utilisera les paramètres IP spécifiés à cette fonction. N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→useDHCPauto()network.useDHCPauto()network→useDHCPauto()[network useDHCPauto]network.useDHCPauto()network.useDHCPauto()network.useDHCPauto()network.useDHCPauto()network.useDHCPauto()network.useDHCPauto()network→useDHCPauto()network.useDHCPauto()YNetwork useDHCPauto

Modifie la configuration de l'interface réseau pour utiliser une adresse assignée automatiquement par le serveur DHCP.

En attendant qu'une adresse soit reçue (et indéfiniment si aucun serveur DHCP ne répond), le module utilise une adresse IP du réseau 169.254.0.0/16 (APIPA). N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→useStaticIP()network.useStaticIP()network→useStaticIP()[network useStaticIP: ]network.useStaticIP()network.useStaticIP()network.useStaticIP()network.useStaticIP()network.useStaticIP()network.useStaticIP()network→useStaticIP()network.useStaticIP()YNetwork useStaticIP

Modifie la configuration de l'interface réseau pour utiliser une adresse IP assignée manuellement (adresse IP statique).

N'oubliez pas d'appeler la méthode saveToFlash() et de redémarrer le module pour que le paramètre soit appliqué.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

network→wait_async()network.wait_async()network.wait_async()

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.

La fonction callback peut donc librement utiliser des fonctions synchrones ou asynchrones, sans risquer de bloquer la machine virtuelle Javascript.

Paramètres :

Retourne :

rien du tout.

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é au réseau) ou pour d'ajouter un police de caractères (dans le cas d'un module d'affichage).

Fonction globales
yFindFiles(func)
Permet de retrouver un système de fichier d'après un identifiant donné.
yFindFilesInContext(yctx, func)
Permet de retrouver un système de fichier d'après un identifiant donné dans un Context YAPI.
yFirstFiles()
Commence l'énumération des système de fichier accessibles par la librairie.
yFirstFilesInContext(yctx)
Commence l'énumération des système de fichier accessibles par la librairie.
Méthodes des objets YFiles
files→clearCache()
Invalide le cache.
files→describe()
Retourne un court texte décrivant de manière non-ambigüe l'instance du système de fichier au format TYPE(NAME)=SERIAL.FUNCTIONID.
files→download(pathname)
Télécharge le fichier choisi du filesystème et retourne son contenu.
files→download_async(pathname, callback, context)
Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, de manière asynchrone.
files→fileExist(filename)
Test si un fichier esit dans le système de fichier du module.
files→format_fs()
Rétabli le système de fichier dans on état original, défragmenté.
files→get_advertisedValue()
Retourne la valeur courante du système de fichier (pas plus de 6 caractères).
files→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du système de fichier.
files→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du système de fichier.
files→get_filesCount()
Retourne le nombre de fichiers présents dans le système de fichier.
files→get_freeSpace()
Retourne l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets.
files→get_friendlyName()
Retourne un identifiant global du système de fichier au format NOM_MODULE.NOM_FONCTION.
files→get_functionDescriptor()
Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.
files→get_functionId()
Retourne l'identifiant matériel du système de fichier, sans référence au module.
files→get_hardwareId()
Retourne l'identifiant matériel unique du système de fichier au format SERIAL.FUNCTIONID.
files→get_list(pattern)
Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier.
files→get_logicalName()
Retourne le nom logique du système de fichier.
files→get_module()
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
files→get_module_async(callback, context)
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
files→get_serialNumber()
Retourne le numéro de série du module, préprogrammé en usine.
files→get_userData()
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData.
files→isOnline()
Vérifie si le module hébergeant le système de fichier est joignable, sans déclencher d'erreur.
files→isOnline_async(callback, context)
Vérifie si le module hébergeant le système de fichier est joignable, sans déclencher d'erreur.
files→isReadOnly()
Test si la fonction est en lecture seule.
files→load(msValidity)
Met en cache les valeurs courantes du système de fichier, avec une durée de validité spécifiée.
files→loadAttribute(attrName)
Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.
files→load_async(msValidity, callback, context)
Met en cache les valeurs courantes du système de fichier, avec une durée de validité spécifiée.
files→muteValueCallbacks()
Désactive l'envoi de chaque changement de la valeur publiée au hub parent.
files→nextFiles()
Continue l'énumération des système de fichier commencée à l'aide de yFirstFiles() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les système de fichier sont retournés.
files→registerValueCallback(callback)
Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.
files→remove(pathname)
Efface un fichier, spécifié par son path complet, du système de fichier.
files→set_logicalName(newval)
Modifie le nom logique du système de fichier.
files→set_userData(data)
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.
files→unmuteValueCallbacks()
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.

YFiles.FindFiles()
yFindFiles()yFindFiles()yFindFiles()[YFiles FindFiles: ]yFindFiles()yFindFiles()YFiles.FindFiles()YFiles.FindFiles()YFiles.FindFiles()YFiles.FindFiles()yFindFiles()YFiles.FindFiles()

Permet de retrouver un système de fichier d'après un identifiant donné.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que le système de fichier soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YFiles.isOnline() pour tester si le système de fichier est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Si un appel à la méthode is_online() de cet objet renvoie FAUX alors que vous êtes sûr que le module correspondant est bien branché, vérifiez que vous n'avez pas oublié d'appeler registerHub() à l'initialisation de de l'application.

Paramètres :

Retourne :

un objet de classe YFiles qui permet ensuite de contrôler le système de fichier.

YFiles.FindFilesInContext()
yFindFilesInContext()YFiles.FindFilesInContext()YFiles.FindFilesInContext()YFiles.FindFilesInContext()

Permet de retrouver un système de fichier d'après un identifiant donné dans un Context YAPI.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que le système de fichier soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YFiles.isOnline() pour tester si le système de fichier est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres :

Retourne :

un objet de classe YFiles qui permet ensuite de contrôler le système de fichier.

YFiles.FirstFiles()
yFirstFiles()yFirstFiles()yFirstFiles()[YFiles FirstFiles]yFirstFiles()yFirstFiles()YFiles.FirstFiles()YFiles.FirstFiles()YFiles.FirstFiles()YFiles.FirstFiles()yFirstFiles()YFiles.FirstFiles()

Commence l'énumération des système de fichier accessibles par la librairie.

Utiliser la fonction YFiles.nextFiles() pour itérer sur les autres système de fichier.

Retourne :

un pointeur sur un objet YFiles, correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de système de fichier disponibles.

YFiles.FirstFilesInContext()
yFirstFilesInContext()YFiles.FirstFilesInContext()YFiles.FirstFilesInContext()YFiles.FirstFilesInContext()

Commence l'énumération des système de fichier accessibles par la librairie.

Utiliser la fonction YFiles.nextFiles() pour itérer sur les autres système de fichier.

Paramètres :

Retourne :

un pointeur sur un objet YFiles, correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de système de fichier disponibles.

files→clearCache()files.clearCache()files→clearCache()[files clearCache]files.clearCache()files.clearCache()files.clearCache()files.clearCache()files.clearCache()files→clearCache()files.clearCache()

Invalide le cache.

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.

files→describe()files.describe()files→describe()[files describe]files.describe()files.describe()files.describe()files.describe()files.describe()files→describe()files.describe()

Retourne un court texte décrivant de manière non-ambigüe l'instance du système de fichier au format TYPE(NAME)=SERIAL.FUNCTIONID.

Plus précisément, TYPE correspond au type de fonction, NAME correspond au nom utilsé lors du premier accès a la fonction, SERIAL correspond au numéro de série du module si le module est connecté, ou "unresolved" sinon, et FUNCTIONID correspond à l'identifiant matériel de la fonction si le module est connecté. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est déjà connecté ou Relay(BadCustomeName.relay1)=unresolved si le module n'est pas déjà connecté. Cette methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur.

Retourne :

une chaîne de caractères décrivant le système de fichier (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)

files→download()files.download()files→download()[files download: ]files.download()files.download()files.download()files.download()files.download()files.download()files→download()files.download()YFiles download

Télécharge le fichier choisi du filesystème et retourne son contenu.

Paramètres :

Retourne :

le contenu du fichier chargé sous forme d'objet binaire

En cas d'erreur, déclenche une exception ou retourne un contenu vide.

files→download_async()files.download_async()

Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, de manière asynchrone.

Paramètres :

Retourne :

rien.

files→fileExist()files.fileExist()files→fileExist()[files fileExist: ]files.fileExist()files.fileExist()files.fileExist()files.fileExist()files.fileExist()files.fileExist()files→fileExist()files.fileExist()YFiles fileExist

Test si un fichier esit dans le système de fichier du module.

Paramètres :

Retourne :

vrais si le fichier existe, et faux is le fichier n'existe pas.

En cas d'erreur, déclenche une exception.

files→format_fs()files.format_fs()files→format_fs()[files format_fs]files.format_fs()files.format_fs()files.format_fs()files.format_fs()files.format_fs()files.format_fs()files→format_fs()files.format_fs()YFiles format_fs

Rétabli le système de fichier dans on état original, défragmenté.

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.

files→get_advertisedValue()
files→advertisedValue()files.get_advertisedValue()files→get_advertisedValue()[files advertisedValue]files.get_advertisedValue()files.get_advertisedValue()files.get_advertisedValue()files.get_advertisedValue()files.get_advertisedValue()files.get_advertisedValue()files→get_advertisedValue()files.get_advertisedValue()YFiles get_advertisedValue

Retourne la valeur courante du système de fichier (pas plus de 6 caractères).

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.

files→get_errorMessage()
files→errorMessage()files.get_errorMessage()files→get_errorMessage()[files errorMessage]files.get_errorMessage()files.get_errorMessage()files.get_errorMessage()files.get_errorMessage()files.get_errorMessage()files→get_errorMessage()files.get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du système de fichier.

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.

files→get_errorType()
files→errorType()files.get_errorType()files→get_errorType()[files errorType]files.get_errorType()files.get_errorType()files.get_errorType()files.get_errorType()files.get_errorType()files→get_errorType()files.get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du système de fichier.

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.

files→get_filesCount()
files→filesCount()files.get_filesCount()files→get_filesCount()[files filesCount]files.get_filesCount()files.get_filesCount()files.get_filesCount()files.get_filesCount()files.get_filesCount()files.get_filesCount()files→get_filesCount()files.get_filesCount()YFiles get_filesCount

Retourne le nombre de fichiers présents dans le système de fichier.

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.

files→get_freeSpace()
files→freeSpace()files.get_freeSpace()files→get_freeSpace()[files freeSpace]files.get_freeSpace()files.get_freeSpace()files.get_freeSpace()files.get_freeSpace()files.get_freeSpace()files.get_freeSpace()files→get_freeSpace()files.get_freeSpace()YFiles get_freeSpace

Retourne l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets.

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.

files→get_friendlyName()
files→friendlyName()files.get_friendlyName()files→get_friendlyName()[files friendlyName]files.get_friendlyName()files.get_friendlyName()files.get_friendlyName()files→get_friendlyName()files.get_friendlyName()

Retourne un identifiant global du système de fichier au format NOM_MODULE.NOM_FONCTION.

Le chaîne retournée utilise soit les noms logiques du module et du système de fichier si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel du système de fichier (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.

files→get_functionDescriptor()
files→functionDescriptor()files.get_functionDescriptor()files→get_functionDescriptor()[files functionDescriptor]files.get_functionDescriptor()files.get_functionDescriptor()files.get_functionDescriptor()files.get_functionDescriptor()files.get_functionDescriptor()files→get_functionDescriptor()files.get_functionDescriptor()

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

Cet identifiant peut être utilisé pour tester si deux instance de YFunction référencent physiquement la même fonction sur le même module.

Retourne :

un identifiant de type YFUN_DESCR.

Si la fonction n'a jamais été contactée, la valeur retournée sera Y_FUNCTIONDESCRIPTOR_INVALID

files→get_functionId()
files→functionId()files.get_functionId()files→get_functionId()[files functionId]files.get_functionId()files.get_functionId()files.get_functionId()files.get_functionId()files→get_functionId()files.get_functionId()

Retourne l'identifiant matériel du système de fichier, sans référence au module.

Par example relay1.

Retourne :

une chaîne de caractères identifiant le système de fichier (ex: relay1)

En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID.

files→get_hardwareId()
files→hardwareId()files.get_hardwareId()files→get_hardwareId()[files hardwareId]files.get_hardwareId()files.get_hardwareId()files.get_hardwareId()files.get_hardwareId()files→get_hardwareId()files.get_hardwareId()

Retourne l'identifiant matériel unique du système de fichier au format SERIAL.FUNCTIONID.

L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du système de fichier (par example RELAYLO1-123456.relay1).

Retourne :

une chaîne de caractères identifiant le système de fichier (ex: RELAYLO1-123456.relay1)

En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID.

files→get_list()
files→list()files.get_list()files→get_list()[files list: ]files.get_list()files.get_list()files.get_list()files.get_list()files.get_list()files.get_list()files→get_list()files.get_list()YFiles get_list

Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier.

Paramètres :

Retourne :

une liste d'objets YFileRecord, 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.

files→get_logicalName()
files→logicalName()files.get_logicalName()files→get_logicalName()[files logicalName]files.get_logicalName()files.get_logicalName()files.get_logicalName()files.get_logicalName()files.get_logicalName()files.get_logicalName()files→get_logicalName()files.get_logicalName()YFiles get_logicalName

Retourne le nom logique du système de fichier.

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.

files→get_module()
files→module()files.get_module()files→get_module()[files module]files.get_module()files.get_module()files.get_module()files.get_module()files.get_module()files→get_module()files.get_module()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Retourne :

une instance de YModule

files→get_module_async()
files→module_async()files.get_module_async()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

files→get_serialNumber()
files→serialNumber()files.get_serialNumber()files→get_serialNumber()[files serialNumber]files.get_serialNumber()files.get_serialNumber()files.get_serialNumber()files.get_serialNumber()files.get_serialNumber()files.get_serialNumber()files→get_serialNumber()files.get_serialNumber()YFiles get_serialNumber

Retourne le numéro de série du module, préprogrammé en usine.

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.

files→get_userData()
files→userData()files.get_userData()files→get_userData()[files userData]files.get_userData()files.get_userData()files.get_userData()files.get_userData()files.get_userData()files→get_userData()files.get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_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.

files→isOnline()files.isOnline()files→isOnline()[files isOnline]files.isOnline()files.isOnline()files.isOnline()files.isOnline()files.isOnline()files→isOnline()files.isOnline()

Vérifie si le module hébergeant le système de fichier est joignable, sans déclencher d'erreur.

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

files→isOnline_async()files.isOnline_async()

Vérifie si le module hébergeant le système de fichier est joignable, sans déclencher d'erreur.

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é.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

files→isReadOnly()files→isReadOnly()[files isReadOnly]files.isReadOnly()files.isReadOnly()files.isReadOnly()files.isReadOnly()files.isReadOnly()files.isReadOnly()files→isReadOnly()files.isReadOnly()YFiles isReadOnly

Test si la fonction est en lecture seule.

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

files→load()files.load()files→load()[files load: ]files.load()files.load()files.load()files.load()files.load()files→load()files.load()

Met en cache les valeurs courantes du système de fichier, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

files→loadAttribute()files.loadAttribute()files→loadAttribute()[files loadAttribute: ]files.loadAttribute()files.loadAttribute()files.loadAttribute()files.loadAttribute()files.loadAttribute()files.loadAttribute()files→loadAttribute()files.loadAttribute()

Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.

Paramètres :

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.

files→load_async()files.load_async()

Met en cache les valeurs courantes du système de fichier, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

files→muteValueCallbacks()files.muteValueCallbacks()files→muteValueCallbacks()[files muteValueCallbacks]files.muteValueCallbacks()files.muteValueCallbacks()files.muteValueCallbacks()files.muteValueCallbacks()files.muteValueCallbacks()files.muteValueCallbacks()files→muteValueCallbacks()files.muteValueCallbacks()YFiles muteValueCallbacks

Désactive l'envoi de chaque changement de la valeur publiée au hub parent.

Vous pouvez utiliser cette fonction pour économiser la bande passante et le CPU sur les machines de faible puissance, ou pour éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

files→nextFiles()files.nextFiles()files→nextFiles()[files nextFiles]files.nextFiles()files.nextFiles()files.nextFiles()files.nextFiles()files.nextFiles()files.nextFiles()files→nextFiles()files.nextFiles()

Continue l'énumération des système de fichier commencée à l'aide de yFirstFiles() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les système de fichier sont retournés.

Si vous souhaitez retrouver un système de fichier spécifique, utilisez Files.findFiles() avec un hardwareID ou un nom logique.

Retourne :

un pointeur sur un objet YFiles accessible en ligne, ou null lorsque l'énumération est terminée.

files→registerValueCallback()files.registerValueCallback()files→registerValueCallback()[files registerValueCallback: ]files.registerValueCallback()files.registerValueCallback()files.registerValueCallback()files.registerValueCallback()files.registerValueCallback()files.registerValueCallback()files→registerValueCallback()files.registerValueCallback()

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

Ce callback n'est appelé que durant l'exécution de ySleep ou yHandleEvents. Cela permet à l'appelant de contrôler quand les callback peuvent se produire. Il est important d'appeler l'une de ces deux fonctions périodiquement pour garantir que les callback ne soient pas appelés trop tard. Pour désactiver un callback, il suffit d'appeler cette méthode en lui passant un pointeur nul.

Paramètres :

files→remove()files.remove()files→remove()[files remove: ]files.remove()files.remove()files.remove()files.remove()files.remove()files.remove()files→remove()files.remove()YFiles remove

Efface un fichier, spécifié par son path complet, du système de fichier.

A cause de la fragmentation, l'effacement d'un fichier ne libère pas toujours la totalité de l'espace qu'il occuppe. Par contre, la ré-écriture d'un fichier du même nom récupérera dans tout les cas l'espace qui n'aurait é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 :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

files→set_logicalName()
files→setLogicalName()files.set_logicalName()files→set_logicalName()[files setLogicalName: ]files.set_logicalName()files.set_logicalName()files.set_logicalName()files.set_logicalName()files.set_logicalName()files.set_logicalName()files→set_logicalName()files.set_logicalName()YFiles set_logicalName

Modifie le nom logique du système de fichier.

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :

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.

files→set_userData()
files→setUserData()files.set_userData()files→set_userData()[files setUserData: ]files.set_userData()files.set_userData()files.set_userData()files.set_userData()files.set_userData()files→set_userData()files.set_userData()

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.

Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte.

Paramètres :

files→unmuteValueCallbacks()files.unmuteValueCallbacks()files→unmuteValueCallbacks()[files unmuteValueCallbacks]files.unmuteValueCallbacks()files.unmuteValueCallbacks()files.unmuteValueCallbacks()files.unmuteValueCallbacks()files.unmuteValueCallbacks()files.unmuteValueCallbacks()files→unmuteValueCallbacks()files.unmuteValueCallbacks()YFiles unmuteValueCallbacks

Réactive l'envoi de chaque changement de la valeur publiée au hub parent.

Cette fonction annule un précédent appel à muteValueCallbacks(). N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

files→upload()files.upload()files→upload()[files upload: ]files.upload()files.upload()files.upload()files.upload()files.upload()files.upload()files→upload()files.upload()YFiles upload

Télécharge un contenu vers le système de fichier, au chemin d'accès spécifié.

Si un fichier existe déjà pour le même chemin d'accès, son contenu est remplacé.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

files→wait_async()files.wait_async()files.wait_async()

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.

La fonction callback peut donc librement utiliser des fonctions synchrones ou asynchrones, sans risquer de bloquer la machine virtuelle Javascript.

Paramètres :

Retourne :

rien du tout.

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. Elle est le fondement des fonctions de réveil automatique implémentées par le WakeUpScheduler. L'heure courante peut représenter aussi bien une heure locale qu'une heure UTC, mais aucune adaptation automatique n'est fait au changement d'heure été/hiver.

Fonction globales
yFindRealTimeClock(func)
Permet de retrouver une horloge d'après un identifiant donné.
yFindRealTimeClockInContext(yctx, func)
Permet de retrouver une horloge d'après un identifiant donné dans un Context YAPI.
yFirstRealTimeClock()
Commence l'énumération des horloge accessibles par la librairie.
yFirstRealTimeClockInContext(yctx)
Commence l'énumération des horloge accessibles par la librairie.
Méthodes des objets YRealTimeClock
realtimeclock→clearCache()
Invalide le cache.
realtimeclock→describe()
Retourne un court texte décrivant de manière non-ambigüe l'instance de l'horloge au format TYPE(NAME)=SERIAL.FUNCTIONID.
realtimeclock→get_advertisedValue()
Retourne la valeur courante de l'horloge (pas plus de 6 caractères).
realtimeclock→get_dateTime()
Retourne l'heure courante au format "AAAA/MM/JJ hh:mm:ss".
realtimeclock→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'horloge.
realtimeclock→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'horloge.
realtimeclock→get_friendlyName()
Retourne un identifiant global de l'horloge au format NOM_MODULE.NOM_FONCTION.
realtimeclock→get_functionDescriptor()
Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.
realtimeclock→get_functionId()
Retourne l'identifiant matériel de l'horloge, sans référence au module.
realtimeclock→get_hardwareId()
Retourne l'identifiant matériel unique de l'horloge au format SERIAL.FUNCTIONID.
realtimeclock→get_logicalName()
Retourne le nom logique de l'horloge.
realtimeclock→get_module()
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
realtimeclock→get_module_async(callback, context)
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
realtimeclock→get_serialNumber()
Retourne le numéro de série du module, préprogrammé en usine.
realtimeclock→get_timeSet()
Retourne vrai si l'horloge à été mise à l'heure, sinon faux.
realtimeclock→get_unixTime()
Retourne l'heure courante au format Unix (nombre de seconds secondes écoulées depuis le 1er janvier 1970).
realtimeclock→get_userData()
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData.
realtimeclock→get_utcOffset()
Retourne le nombre de secondes de décallage entre l'heure courante et l'heure UTC (time zone).
realtimeclock→isOnline()
Vérifie si le module hébergeant l'horloge est joignable, sans déclencher d'erreur.
realtimeclock→isOnline_async(callback, context)
Vérifie si le module hébergeant l'horloge est joignable, sans déclencher d'erreur.
realtimeclock→isReadOnly()
Test si la fonction est en lecture seule.
realtimeclock→load(msValidity)
Met en cache les valeurs courantes de l'horloge, avec une durée de validité spécifiée.
realtimeclock→loadAttribute(attrName)
Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.
realtimeclock→load_async(msValidity, callback, context)
Met en cache les valeurs courantes de l'horloge, avec une durée de validité spécifiée.
realtimeclock→muteValueCallbacks()
Désactive l'envoi de chaque changement de la valeur publiée au hub parent.
realtimeclock→nextRealTimeClock()
Continue l'énumération des horloge commencée à l'aide de yFirstRealTimeClock() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les horloge sont retournés.
realtimeclock→registerValueCallback(callback)
Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.
realtimeclock→set_logicalName(newval)
Modifie le nom logique de l'horloge.
realtimeclock→set_unixTime(newval)
Modifie l'heure courante.
realtimeclock→set_userData(data)
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.
realtimeclock→set_utcOffset(newval)
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.

YRealTimeClock.FindRealTimeClock()
yFindRealTimeClock()yFindRealTimeClock()yFindRealTimeClock()[YRealTimeClock FindRealTimeClock: ]yFindRealTimeClock()yFindRealTimeClock()YRealTimeClock.FindRealTimeClock()YRealTimeClock.FindRealTimeClock()YRealTimeClock.FindRealTimeClock()YRealTimeClock.FindRealTimeClock()yFindRealTimeClock()YRealTimeClock.FindRealTimeClock()

Permet de retrouver une horloge d'après un identifiant donné.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que l'horloge soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YRealTimeClock.isOnline() pour tester si l'horloge est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Si un appel à la méthode is_online() de cet objet renvoie FAUX alors que vous êtes sûr que le module correspondant est bien branché, vérifiez que vous n'avez pas oublié d'appeler registerHub() à l'initialisation de de l'application.

Paramètres :

Retourne :

un objet de classe YRealTimeClock qui permet ensuite de contrôler l'horloge.

YRealTimeClock.FindRealTimeClockInContext()
yFindRealTimeClockInContext()YRealTimeClock.FindRealTimeClockInContext()YRealTimeClock.FindRealTimeClockInContext()YRealTimeClock.FindRealTimeClockInContext()

Permet de retrouver une horloge d'après un identifiant donné dans un Context YAPI.

L'identifiant peut être spécifié sous plusieurs formes:

• NomLogiqueFonction
• NoSerieModule.IdentifiantFonction
• NoSerieModule.NomLogiqueFonction
• NomLogiqueModule.IdentifiantMatériel
• NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que l'horloge soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YRealTimeClock.isOnline() pour tester si l'horloge est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres :

Retourne :

un objet de classe YRealTimeClock qui permet ensuite de contrôler l'horloge.

YRealTimeClock.FirstRealTimeClock()
yFirstRealTimeClock()yFirstRealTimeClock()yFirstRealTimeClock()[YRealTimeClock FirstRealTimeClock]yFirstRealTimeClock()yFirstRealTimeClock()YRealTimeClock.FirstRealTimeClock()YRealTimeClock.FirstRealTimeClock()YRealTimeClock.FirstRealTimeClock()YRealTimeClock.FirstRealTimeClock()yFirstRealTimeClock()YRealTimeClock.FirstRealTimeClock()

Commence l'énumération des horloge accessibles par la librairie.

Utiliser la fonction YRealTimeClock.nextRealTimeClock() pour itérer sur les autres horloge.

Retourne :

un pointeur sur un objet YRealTimeClock, correspondant à la première horloge accessible en ligne, ou null si il n'y a pas de horloge disponibles.

YRealTimeClock.FirstRealTimeClockInContext()
yFirstRealTimeClockInContext()YRealTimeClock.FirstRealTimeClockInContext()YRealTimeClock.FirstRealTimeClockInContext()YRealTimeClock.FirstRealTimeClockInContext()

Commence l'énumération des horloge accessibles par la librairie.

Utiliser la fonction YRealTimeClock.nextRealTimeClock() pour itérer sur les autres horloge.

Paramètres :

Retourne :

un pointeur sur un objet YRealTimeClock, correspondant à la première horloge accessible en ligne, ou null si il n'y a pas de horloge disponibles.

realtimeclock→clearCache()realtimeclock.clearCache()realtimeclock→clearCache()[realtimeclock clearCache]realtimeclock.clearCache()realtimeclock.clearCache()realtimeclock.clearCache()realtimeclock.clearCache()realtimeclock.clearCache()realtimeclock→clearCache()realtimeclock.clearCache()

Invalide le cache.

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.

realtimeclock→describe()realtimeclock.describe()realtimeclock→describe()[realtimeclock describe]realtimeclock.describe()realtimeclock.describe()realtimeclock.describe()realtimeclock.describe()realtimeclock.describe()realtimeclock→describe()realtimeclock.describe()

Retourne un court texte décrivant de manière non-ambigüe l'instance de l'horloge au format TYPE(NAME)=SERIAL.FUNCTIONID.

Plus précisément, TYPE correspond au type de fonction, NAME correspond au nom utilsé lors du premier accès a la fonction, SERIAL correspond au numéro de série du module si le module est connecté, ou "unresolved" sinon, et FUNCTIONID correspond à l'identifiant matériel de la fonction si le module est connecté. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est déjà connecté ou Relay(BadCustomeName.relay1)=unresolved si le module n'est pas déjà connecté. Cette methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur.

Retourne :

une chaîne de caractères décrivant l'horloge (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)

realtimeclock→get_advertisedValue()
realtimeclock→advertisedValue()realtimeclock.get_advertisedValue()realtimeclock→get_advertisedValue()[realtimeclock advertisedValue]realtimeclock.get_advertisedValue()realtimeclock.get_advertisedValue()realtimeclock.get_advertisedValue()realtimeclock.get_advertisedValue()realtimeclock.get_advertisedValue()realtimeclock.get_advertisedValue()realtimeclock→get_advertisedValue()realtimeclock.get_advertisedValue()YRealTimeClock get_advertisedValue

Retourne la valeur courante de l'horloge (pas plus de 6 caractères).

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.

realtimeclock→get_dateTime()
realtimeclock→dateTime()realtimeclock.get_dateTime()realtimeclock→get_dateTime()[realtimeclock dateTime]realtimeclock.get_dateTime()realtimeclock.get_dateTime()realtimeclock.get_dateTime()realtimeclock.get_dateTime()realtimeclock.get_dateTime()realtimeclock.get_dateTime()realtimeclock→get_dateTime()realtimeclock.get_dateTime()YRealTimeClock get_dateTime

Retourne l'heure courante au format "AAAA/MM/JJ hh:mm:ss".

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.

realtimeclock→get_errorMessage()
realtimeclock→errorMessage()realtimeclock.get_errorMessage()realtimeclock→get_errorMessage()[realtimeclock errorMessage]realtimeclock.get_errorMessage()realtimeclock.get_errorMessage()realtimeclock.get_errorMessage()realtimeclock.get_errorMessage()realtimeclock.get_errorMessage()realtimeclock→get_errorMessage()realtimeclock.get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'horloge.

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.

realtimeclock→get_errorType()
realtimeclock→errorType()realtimeclock.get_errorType()realtimeclock→get_errorType()[realtimeclock errorType]realtimeclock.get_errorType()realtimeclock.get_errorType()realtimeclock.get_errorType()realtimeclock.get_errorType()realtimeclock.get_errorType()realtimeclock→get_errorType()realtimeclock.get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'horloge.

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.

realtimeclock→get_friendlyName()
realtimeclock→friendlyName()realtimeclock.get_friendlyName()realtimeclock→get_friendlyName()[realtimeclock friendlyName]realtimeclock.get_friendlyName()realtimeclock.get_friendlyName()realtimeclock.get_friendlyName()realtimeclock→get_friendlyName()realtimeclock.get_friendlyName()

Retourne un identifiant global de l'horloge au format NOM_MODULE.NOM_FONCTION.

Le chaîne retournée utilise soit les noms logiques du module et de l'horloge si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de l'horloge (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.

realtimeclock→get_functionDescriptor()
realtimeclock→functionDescriptor()realtimeclock.get_functionDescriptor()realtimeclock→get_functionDescriptor()[realtimeclock functionDescriptor]realtimeclock.get_functionDescriptor()realtimeclock.get_functionDescriptor()realtimeclock.get_functionDescriptor()realtimeclock.get_functionDescriptor()realtimeclock.get_functionDescriptor()realtimeclock→get_functionDescriptor()realtimeclock.get_functionDescriptor()

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

Cet identifiant peut être utilisé pour tester si deux instance de YFunction référencent physiquement la même fonction sur le même module.

Retourne :

un identifiant de type YFUN_DESCR.

Si la fonction n'a jamais été contactée, la valeur retournée sera Y_FUNCTIONDESCRIPTOR_INVALID

realtimeclock→get_functionId()
realtimeclock→functionId()realtimeclock.get_functionId()realtimeclock→get_functionId()[realtimeclock functionId]realtimeclock.get_functionId()realtimeclock.get_functionId()realtimeclock.get_functionId()realtimeclock.get_functionId()realtimeclock→get_functionId()realtimeclock.get_functionId()

Retourne l'identifiant matériel de l'horloge, sans référence au module.

Par example relay1.

Retourne :

une chaîne de caractères identifiant l'horloge (ex: relay1)

En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID.

realtimeclock→get_hardwareId()
realtimeclock→hardwareId()realtimeclock.get_hardwareId()realtimeclock→get_hardwareId()[realtimeclock hardwareId]realtimeclock.get_hardwareId()realtimeclock.get_hardwareId()realtimeclock.get_hardwareId()realtimeclock.get_hardwareId()realtimeclock→get_hardwareId()realtimeclock.get_hardwareId()

Retourne l'identifiant matériel unique de l'horloge au format SERIAL.FUNCTIONID.

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 :

une chaîne de caractères identifiant l'horloge (ex: RELAYLO1-123456.relay1)

En cas d'erreur, déclenche une exception ou retourne Y_HARDWAREID_INVALID.

realtimeclock→get_logicalName()
realtimeclock→logicalName()realtimeclock.get_logicalName()realtimeclock→get_logicalName()[realtimeclock logicalName]realtimeclock.get_logicalName()realtimeclock.get_logicalName()realtimeclock.get_logicalName()realtimeclock.get_logicalName()realtimeclock.get_logicalName()realtimeclock.get_logicalName()realtimeclock→get_logicalName()realtimeclock.get_logicalName()YRealTimeClock get_logicalName

Retourne le nom logique de l'horloge.

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.

realtimeclock→get_module()
realtimeclock→module()realtimeclock.get_module()realtimeclock→get_module()[realtimeclock module]realtimeclock.get_module()realtimeclock.get_module()realtimeclock.get_module()realtimeclock.get_module()realtimeclock.get_module()realtimeclock→get_module()realtimeclock.get_module()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Retourne :

une instance de YModule

realtimeclock→get_module_async()
realtimeclock→module_async()realtimeclock.get_module_async()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

realtimeclock→get_serialNumber()
realtimeclock→serialNumber()realtimeclock.get_serialNumber()realtimeclock→get_serialNumber()[realtimeclock serialNumber]realtimeclock.get_serialNumber()realtimeclock.get_serialNumber()realtimeclock.get_serialNumber()realtimeclock.get_serialNumber()realtimeclock.get_serialNumber()realtimeclock.get_serialNumber()realtimeclock→get_serialNumber()realtimeclock.get_serialNumber()YRealTimeClock get_serialNumber

Retourne le numéro de série du module, préprogrammé en usine.

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.

realtimeclock→get_timeSet()
realtimeclock→timeSet()realtimeclock.get_timeSet()realtimeclock→get_timeSet()[realtimeclock timeSet]realtimeclock.get_timeSet()realtimeclock.get_timeSet()realtimeclock.get_timeSet()realtimeclock.get_timeSet()realtimeclock.get_timeSet()realtimeclock.get_timeSet()realtimeclock→get_timeSet()realtimeclock.get_timeSet()YRealTimeClock get_timeSet

Retourne vrai si l'horloge à été mise à l'heure, sinon faux.

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.

realtimeclock→get_unixTime()
realtimeclock→unixTime()realtimeclock.get_unixTime()realtimeclock→get_unixTime()[realtimeclock unixTime]realtimeclock.get_unixTime()realtimeclock.get_unixTime()realtimeclock.get_unixTime()realtimeclock.get_unixTime()realtimeclock.get_unixTime()realtimeclock.get_unixTime()realtimeclock→get_unixTime()realtimeclock.get_unixTime()YRealTimeClock get_unixTime

Retourne l'heure courante au format Unix (nombre de seconds secondes écoulées depuis le 1er janvier 1970).

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.

realtimeclock→get_userData()
realtimeclock→userData()realtimeclock.get_userData()realtimeclock→get_userData()[realtimeclock userData]realtimeclock.get_userData()realtimeclock.get_userData()realtimeclock.get_userData()realtimeclock.get_userData()realtimeclock.get_userData()realtimeclock→get_userData()realtimeclock.get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_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.

realtimeclock→get_utcOffset()
realtimeclock→utcOffset()realtimeclock.get_utcOffset()realtimeclock→get_utcOffset()[realtimeclock utcOffset]realtimeclock.get_utcOffset()realtimeclock.get_utcOffset()realtimeclock.get_utcOffset()realtimeclock.get_utcOffset()realtimeclock.get_utcOffset()realtimeclock.get_utcOffset()realtimeclock→get_utcOffset()realtimeclock.get_utcOffset()YRealTimeClock get_utcOffset

Retourne le nombre de secondes de décallage entre l'heure courante et l'heure UTC (time zone).

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.

realtimeclock→isOnline()realtimeclock.isOnline()realtimeclock→isOnline()[realtimeclock isOnline]realtimeclock.isOnline()realtimeclock.isOnline()realtimeclock.isOnline()realtimeclock.isOnline()realtimeclock.isOnline()realtimeclock→isOnline()realtimeclock.isOnline()

Vérifie si le module hébergeant l'horloge est joignable, sans déclencher d'erreur.

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

realtimeclock→isOnline_async()realtimeclock.isOnline_async()

Vérifie si le module hébergeant l'horloge est joignable, sans déclencher d'erreur.

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é.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

realtimeclock→isReadOnly()realtimeclock→isReadOnly()[realtimeclock isReadOnly]realtimeclock.isReadOnly()realtimeclock.isReadOnly()realtimeclock.isReadOnly()realtimeclock.isReadOnly()realtimeclock.isReadOnly()realtimeclock.isReadOnly()realtimeclock→isReadOnly()realtimeclock.isReadOnly()YRealTimeClock isReadOnly

Test si la fonction est en lecture seule.

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

realtimeclock→load()realtimeclock.load()realtimeclock→load()[realtimeclock load: ]realtimeclock.load()realtimeclock.load()realtimeclock.load()realtimeclock.load()realtimeclock.load()realtimeclock→load()realtimeclock.load()

Met en cache les valeurs courantes de l'horloge, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Paramètres :

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

realtimeclock→loadAttribute()realtimeclock.loadAttribute()realtimeclock→loadAttribute()[realtimeclock loadAttribute: ]realtimeclock.loadAttribute()realtimeclock.loadAttribute()realtimeclock.loadAttribute()realtimeclock.loadAttribute()realtimeclock.loadAttribute()realtimeclock.loadAttribute()realtimeclock→loadAttribute()realtimeclock.loadAttribute()

Retourne la valeur actuelle d'un attribut spécifique de la fonction, sous forme de texte, le plus rapidement possible mais sans passer par le cache.

Paramètres :

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.

realtimeclock→load_async()realtimeclock.load_async()

Met en cache les valeurs courantes de l'horloge, avec une durée de validité spécifiée.

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

Paramètres :

Retourne :

rien du tout : le résultat sera passé en paramètre à la fonction de callback.

realtimeclock→muteValueCallbacks()realtimeclock.muteValueCallbacks()realtimeclock→muteValueCallbacks()[realtimeclock muteValueCallbacks]realtimeclock.muteValueCallbacks()realtimeclock.muteValueCallbacks()realtimeclock.muteValueCallbacks()realtimeclock.muteValueCallbacks()realtimeclock.muteValueCallbacks()realtimeclock.muteValueCallbacks()realtimeclock→muteValueCallbacks()realtimeclock.muteValueCallbacks()YRealTimeClock muteValueCallbacks

Désactive l'envoi de chaque changement de la valeur publiée au hub parent.

Vous pouvez utiliser cette fonction pour économiser la bande passante et le CPU sur les machines de faible puissance, ou pour éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur.

En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

realtimeclock→nextRealTimeClock()realtimeclock.nextRealTimeClock()realtimeclock→nextRealTimeClock()[realtimeclock nextRealTimeClock]realtimeclock.nextRealTimeClock()realtimeclock.nextRealTimeClock()realtimeclock.nextRealTimeClock()realtimeclock.nextRealTimeClock()realtimeclock.nextRealTimeClock()realtimeclock.nextRealTimeClock()realtimeclock→nextRealTimeClock()realtimeclock.nextRealTimeClock()

Continue l'énumération des horloge commencée à l'aide de yFirstRealTimeClock() Attention, vous ne pouvez faire aucune supposition sur l'ordre dans lequel les horloge sont retournés.

Si vous souhaitez retrouver une horloge spécifique, utilisez RealTimeClock.findRealTimeClock() avec un hardwareID ou un nom logique.

Retourne :

un pointeur sur un objet YRealTimeClock accessible en ligne, ou null lorsque l'énumération est terminée.

realtimeclock→registerValueCallback()realtimeclock.registerValueCallback()realtimeclock→registerValueCallback()[realtimeclock registerValueCallback: ]realtimeclock.registerValueCallback()realtimeclock.registerValueCallback()realtimeclock.registerValueCallback()realtimeclock.registerValueCallback()realtimeclock.registerValueCallback()realtimeclock.registerValueCallback()realtimeclock→registerValueCallback()realtimeclock.registerValueCallback()

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

Ce callback n'est appelé que durant l'exécution de ySleep ou yHandleEvents. Cela permet à l'appelant de contrôler quand les callback peuvent se produire. Il est important d'appeler l'une de ces deux fonctions périodiquement pour garantir que les callback ne soient pas appelés trop tard. Pour désactiver un callback, il suffit d'appeler cette méthode en lui passant un pointeur nul.

Paramètres :

realtimeclock→set_logicalName()
realtimeclock→setLogicalName()realtimeclock.set_logicalName()realtimeclock→set_logicalName()[realtimeclock setLogicalName: ]realtimeclock.set_logicalName()realtimeclock.set_logicalName()realtimeclock.set_logicalName()realtimeclock.set_logicalName()realtimeclock.set_logicalName()realtimeclock.set_logicalName()realtimeclock→set_logicalName()realtimeclock.set_logicalName()YRealTimeClock set_logicalName

Modifie le nom logique de l'horloge.

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres :