Yoctohub-ethernet : manuel d'utilisation

YoctoHub-Ethernet : Manuel d'utilisation

1. Introduction
2. Présentation
2.1 Les éléments du YoctoHub-Ethernet
3. Premiers pas
3.1 Utilisation directe pour les impatients
3.2 Configuration manuelle
3.3 Configuration automatisée
3.4 Connexions
4. Montage
4.1 Fixation
4.2 Fixation d'un sous-module
5. Utilisation du YoctoHub-Ethernet
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-Ethernet
9. Personnalisation de l'interface Web
9.1 Utilisation
9.2 Limitations
10. Référence de l'API de haut niveau
10.1 Interface d'un port de Yocto-hub
10.2 Interface de la fonction Network
10.3 Interface de la fonction Files
11. Caractéristiques
12. Index

1. Introduction

Le module YoctoHub-Ethernet est un module de 60x58mm qui permet de contrôler d'autres modules Yoctopuce à travers Ethernet. Vu de l'extérieur, ce module se comporte exactement comme un ordinateur classique faisant tourner un VirtualHub1: même interface, mêmes fonctionnalités. Le YoctoHub-Ethernet peut être alimenté classiquement à l'aide d'un chargeur USB, mais il peut aussi être aussi alimenté par Power over Ethernet.


Le YoctoHub-Ethernet

Le YoctoHub-Ethernet 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-Ethernet 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-Ethernet.

Yoctopuce vous remercie d'avoir fait l'acquisition de ce YoctoHub-Ethernet 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-Ethernet 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 Yoctopuce2.

2. Présentation


1:Port USB de contrôle + alimentation 7:Port descendant 1
2:Yocto-bouton 8:Indicateur port descendant 1
3:Yocto-Led 9:Port descendant 2
4:Port réseau (100Mb) 10:Indicateur port descendant 2
5:Indicateur de sur-consommation 11:>Port descendant 3
6:Connection dorsale12:Indicateur port descendant 3

2.1. Les éléments du YoctoHub-Ethernet

Le numéro de série

Chaque Yocto-module a un numéro de série unique attribué en usine, pour les modules YoctoHub-Ethernet ce numéro commence par YHUBETH1. 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 morse3. 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 Yoctopuce4.

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

Ce connecteur permet d'alimenter le YoctoHub-Ethernet 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-Ethernet 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-Ethernet 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-Ethernet et le module Yoctopuce n'est pas de l'USB mais un protocole propriétaire plus léger. De ce fait le YoctoHub-Ethernet ne peut pas gérer des périphériques autres que des modules Yoctopuce. Un hub USB standard ne fonctionnera pas non plus5. Si vous désirez brancher plus de trois modules Yoctopuce, utilisez le connecteur dorsal pour y connecter un ou plusieurs YoctoHub-Shield6.

Attention, les connecteurs USB du YoctoHub-Ethernet 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 UTP (réseau)

Ce connecteur permet de connecter le YoctoHub-Ethernet à votre réseau Ethernet. La connection réseau du YoctoHub-Ethernet fonctionne en 100 Mb/s, mais le hub peut très bien être raccordé à un réseau Gigabit ou 10Mb/s.

Le YoctoHub-Ethernet peut aussi être alimenté par ce biais: il suffit de disposer de matériel réseau capable de fournir de l'énergie par Power over Ethernet (PoE) à la norme 802.3af. Ce peut être un switch réseau avec PoE, ou un simple injecteur par exemple. Longtemps réservé au monde professionnel, ce type de matériel est désormais largement distribué à des prix tout à fait abordables. En utilisant le PoE, vous pourrez déporter votre YoctoHub-Ethernet loin de toute prise électrique, en le raccordant uniquement par un simple câble réseau. Les câbles réseau plats et fins sont généralement compatibles avec le standard PoE 802.3af.

Les sondes de courant

Le YoctoHub-Ethernet est capable de mesurer sa propre consommation de courant, en distinguant celle fournie par le connecteur USB et celle fournie par le Power over Ethernet. La distribution du courant sur un bus USB ou sur un réseau PoE étant relativement critique, cette fonctionnalité peut être d'un grand secours. Le YoctoHub-Ethernet est dimensionné pour pouvoir gérer jusqu'à 2A en tout (propre consommation et consommation sur les ports descendants incluses).

Indicateur de sur-consommation

Le YoctoHub-Ethernet analyse en permanence sa consommation. S'il détecte une consommation globale de plus de 2A ou une consommation supérieure à 1.8A sur le PoE, suite à une surcharge sur un des ports descendants par exemple, il va automatiquement désactiver tous les ports descendants et allumer la Led 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-Ethernet 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.

3. Premiers pas

Ce chapitre a pour but de vous aider à connecter et configurer votre YoctoHub-Ethernet pour la première fois

3.1. Utilisation directe pour les impatients

Si vous branchez votre YoctoHub-Ethernet directement au réseau sans le configurer, il est fonctionnel avec la configuration par défaut:

3.2. Configuration manuelle

Vous pouvez configurer votre YoctoHub-Ethernet via son port de contrôle USB, en utilisant le VirtualHub7.

Lancez un VirtualHub sur votre ordinateur favori et raccordez votre ordinateur au port power / control port du YoctoHub-Ethernet. Vous aurez besoin d'un câble USB A-MicroB. Raccordez aussi votre YoctoHub-Ethernet à un câble réseau opérationnel.


Configuration: raccordez par USB votre YoctoHub-Ethernet à 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-Ethernet


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

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


Fenêtre de configuration du module YoctoHub-Ethernet

Vous pouvez choisir si l'adresse IP de votre YoctoHub-Ethernet 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-Ethernet. Vous pourrez ainsi accéder à votre YoctoHub-Ethernet 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-Ethernet, il s'en rappellera même après avoir été privé de courant.

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


Les propriétés du YoctoHub-Ethernet

Cette fenêtre comporte une section qui relate l'état de la partie réseau du YoctoHub-Ethernet. 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:

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-Ethernet 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-Ethernet. Cette interface est en tout point identique à celle du VirtualHub. Vous retrouvez le YoctoHub-Ethernet sur la première ligne et les modules connectés au YoctoHub-Ethernet sur les suivantes.


L'interface du YoctoHub-Ethernet est identique à celle d'un VirtualHub.

Si vous avez attribué un nom à votre YoctoHub-Ethernet, 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-Ethernet. Si vous voulez contacter le module par nom depuis un autre réseau, vous devez utiliser une infrastructure DNS classique.

3.3. Configuration automatisée

Il est possible d'industrialiser la configuration réseau du YoctoHub-Ethernet. 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 commande8.

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.4. Connexions

Alimentation

Le YoctoHub-Ethernet peut être alimenté de deux manières différentes:

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-Ethernet consomme environ 130mA, auxquels il faudra ajouter la consommation de chaque sous-module. Le YoctoHub-Ethernet 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-Ethernet peut être alimenté par un chargeur USB

Power over Ethernet (PoE)

Votre YoctoHub-Ethernet est compatible Power over Ethernet (PoE). Cette technologie consiste à faire passer le courant d'alimentation directement dans le câble réseau. Pour cela vous avez besoin d'un équipement réseau qui alimente le câble Ethernet selon le standard 802.3af 9 Ces équipements se présentent généralement sous la forme d'un Switch PoE, combinant les fonctions "switch Ethernet" et "injecteur de puissance", ou d'un simple Injecteur PoE, permettant d'injecter la puissance sur un seul câble Ethernet. Il existe aussi des routeurs ADSL avec PoE, mais ceux-ci sont relativement rares. Si vous disposez d'un câble réseau relié à l'un de ces équipements, il vous suffit alors de connecter ce câble au YoctoHub-Ethernet pour que celui-ci soit immédiatement opérationnel.


Le YoctoHub-Ethernet peut être alimenté par le câble Ethernet (PoE)

Longtemps réservés au monde professionnel, ces équipements sont désormais facilement accessibles au grand public à des prix tout à fait raisonnables (quelques dizaines d'Euros pour un injecteur, et un peu plus de 100 EUR pour un Switch PoE avec plusieurs ports alimentés). Les câbles réseau plats et fins sont généralement compatibles avec le standard PoE 802.3af.

Le composant PoE du YoctoHub-Ethernet permet de délivrer environ 1.8 A à 5V. Si le YoctoHub-Ethernet détecte une surconsommation sur le PoE, il coupera automatiquement l'alimentation des ports descendants pour se protéger. Ces ports devront être réactivés explicitement, soit par logiciel soit grâce l'interface web du YoctoHub-Ethernet. La sur-consommation est physiquement signalée par la Led rouge overload.

Attention, la distribution de courant entre équipements PoE fait l'objet de négociations. Le YoctoHub-Ethernet va tenter de négocier 9W (1.8A) auprès de l'équipement qui fourni le courant sur le câble. Veillez à ne pas dépasser la puissance disponible sur l'équipement qui fournit le courant. Reportez-vous à la documentation de l'équipement en question pour plus de détails.

Il n'est pas recommandé de brancher en même temps un câble PoE et un chargeur USB sur votre YoctoHub-Ethernet. A priori, cela ne pose pas de problème majeur pour une utilisation très temporaire, mais en utilisation normale vous devez choisir l'une ou l'autre des sources d'alimentation.

Sous-modules

Le YoctoHub-Ethernet 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-Ethernet, 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-Ethernet est conçu pour que vous puissiez fixer un module simple largeur directement dessus. Vous aurez besoin de vis, d'entretoises10 et d'un connecteur au pas 1.27mm11. 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-Ethernet est conçu pour piloter des modules Yoctopuce uniquement. En effet le protocole utilisé entre le YoctoHub-Ethernet 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-Ethernet, 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-Ethernet 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-Ethernet 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-Ethernet, 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-Ethernet 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-Ethernet 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-Ethernet, et le contact carré sur sur le module doit être connecté au contact carré sur le port descendant du YoctoHub-Ethernet. 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-Ethernet 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-Ethernet

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


Interface Web du YoctoHub-Ethernet.

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


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

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

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 15. L'interface propose aussi un lien direct si elle détecte que le firmware n'est pas à jour16. 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-Ethernet 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-Ethernet 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-Ethernet. 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-Ethernet 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-Ethernet 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-Ethernet.


La fenêtre de configuration du YoctoHub-Ethernet

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

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-Ethernet, 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-Ethernet. 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-Ethernet sous la forme login:password@adresse:port, par exemple:


yRegisterHub("admin:mypass@192.168.0.10:4444",errmsg);

6.4. Effacement des mots de passe

Si vous perdez le mot passe de votre YoctoHub-Ethernet, 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-Ethernet, et branchez-le à un ordinateur avec le VirtualHub17 installé en maintenant le Yocto-bouton pressé. Ceci va forcer le YoctoHub-Ethernet à 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-Ethernet 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-Ethernet 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-Ethernet 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-Ethernet.

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

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

ThingSpeak19 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 Yoctopuce20 comment configurer votre YoctoHub-Ethernet 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. 21.

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-Ethernet 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-Ethernet 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-Ethernet 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-Ethernet va interagir avec un site Web externe. Vous avez besoin de définir l'URL du serveur Web sur lequel le YoctoHub-Ethernet 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-Ethernet 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-Ethernet poste avec la méthode POST les valeurs notifiées22 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-Ethernet 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.


<?php
  Print(Date('H:i:s')."\r\n");
  foreach ($_POST as $key=>$value) {
      Print("$key=$value\r\n");
  }
?>


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

8. Programmation

8.1. Accès aux modules connectés

Le YoctoHub-Ethernet 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-Ethernet 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-Ethernet, il suffit de remplacer ce paramètre par l'adresse IP du YoctoHub-Ethernet. Par en exemple, en Delphi:


YRegisterHub("usb",errmsg);

devient


YRegisterHub("192.168.0.10",errmsg); // l'adresse IP du hub est 192.168.0.10

8.2. Contrôle du YoctoHub-Ethernet

Du point de vue API de programmation, le YoctoHub-Ethernet 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-Ethernet, etc.

Network

Cette classe permet de contrôler la partie réseau du YoctoHub-Ethernet, vous pourrez contrôler l'état du link, lire l'adresse MAC, changer l'adresse IP du YoctoHub-Ethernet, 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-Ethernet, 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-Ethernet. Le YoctoHub-Ethernet 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-Ethernet.

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

9. Personnalisation de l'interface Web

Votre YoctoHub-Ethernet dispose d'un petit système de fichiers embarqué, qui permet de stocker des fichiers personnalisés utilisables par le YoctoHub-Ethernet. 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-Ethernet.

9.1. Utilisation

Utilisation interactive

L'interface Web du YoctoHub-Ethernet 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:

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

9.2. Limitations

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

10. 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-Ethernet. 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-Ethernet.

10.1. Interface d'un port de Yocto-hub

Les objets YHubPort permettent de contrôler l'alimentation des ports d'un YoctoHub, ainsi que de détecter si un module y est raccordé et lequel. Un YHubPort reçoit toujours automatiquement comme nom logique le numéro de série unique du module Yoctopuce qui y est connecté.

Pour utiliser les fonctions décrites ici, vous devez inclure:

js
<script type='text/javascript' src='yocto_hubport.js'></script>
cpp
#include "yocto_hubport.h"
m
#import "yocto_hubport.h"
pas
uses yocto_hubport;
vb
yocto_hubport.vb
cs
yocto_hubport.cs
java
import com.yoctopuce.YoctoAPI.YHubPort;
uwp
import com.yoctopuce.YoctoAPI.YHubPort;
py
from yocto_hubport import *
php
require_once('yocto_hubport.php');
es
in HTML: <script src="../../lib/yocto_hubport.js"></script>
in node.js: require('yoctolib-es2017/yocto_hubport.js');
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_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→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().

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

js
function yFindHubPort(func)
cpp
YHubPort* yFindHubPort(string func)
m
+(YHubPort*) FindHubPort: (NSString*) func
pas
function yFindHubPort(func: string): TYHubPort
vb
function yFindHubPort(ByVal func As String) As YHubPort
cs
YHubPort FindHubPort(string func)
java
YHubPort FindHubPort(String func)
uwp
YHubPort FindHubPort(string func)
py
def FindHubPort(func)
php
function yFindHubPort($func)
es
function FindHubPort(func)

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

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 :

funcune chaîne de caractères qui référence le port de Yocto-hub sans ambiguïté

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.

java
YHubPort FindHubPortInContext(YAPIContext yctx, String func)
uwp
YHubPort FindHubPortInContext(YAPIContext yctx, string func)
es
function FindHubPortInContext(yctx, func)

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

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 :

yctxun contexte YAPI
funcune chaîne de caractères qui référence le port de Yocto-hub sans ambiguïté

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.

js
function yFirstHubPort()
cpp
YHubPort* yFirstHubPort()
m
+(YHubPort*) FirstHubPort
pas
function yFirstHubPort(): TYHubPort
vb
function yFirstHubPort() As YHubPort
cs
YHubPort FirstHubPort()
java
YHubPort FirstHubPort()
uwp
YHubPort FirstHubPort()
py
def FirstHubPort()
php
function yFirstHubPort()
es
function FirstHubPort()

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.

java
YHubPort FirstHubPortInContext(YAPIContext yctx)
uwp
YHubPort FirstHubPortInContext(YAPIContext yctx)
es
function FirstHubPortInContext(yctx)

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

Paramètres :

yctxun contexte YAPI.

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.

js
function clearCache()
cpp
void clearCache()
m
-(void) clearCache
pas
procedure clearCache()
vb
procedure clearCache()
cs
void clearCache()
java
void clearCache()
py
def clearCache()
php
function clearCache()
es
function clearCache()

Invalide le cache des valeurs courantes du port de Yocto-hub. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module.

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.

js
function describe()
cpp
string describe()
m
-(NSString*) describe
pas
function describe(): string
vb
function describe() As String
cs
string describe()
java
String describe()
py
def describe()
php
function describe()
es
function describe()

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

js
function get_advertisedValue()
cpp
string get_advertisedValue()
m
-(NSString*) advertisedValue
pas
function get_advertisedValue(): string
vb
function get_advertisedValue() As String
cs
string get_advertisedValue()
java
String get_advertisedValue()
uwp
async Task<string> get_advertisedValue()
py
def get_advertisedValue()
php
function get_advertisedValue()
es
function get_advertisedValue()
cmd
YHubPort target get_advertisedValue

Retourne :

une chaîne de caractères représentant la valeur courante du port de Yocto-hub (pas plus de 6 caractères).

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

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.

js
function get_baudRate()
cpp
int get_baudRate()
m
-(int) baudRate
pas
function get_baudRate(): LongInt
vb
function get_baudRate() As Integer
cs
int get_baudRate()
java
int get_baudRate()
uwp
async Task<int> get_baudRate()
py
def get_baudRate()
php
function get_baudRate()
es
function get_baudRate()
cmd
YHubPort target get_baudRate

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.

js
function get_enabled()
cpp
Y_ENABLED_enum get_enabled()
m
-(Y_ENABLED_enum) enabled
pas
function get_enabled(): Integer
vb
function get_enabled() As Integer
cs
int get_enabled()
java
int get_enabled()
uwp
async Task<int> get_enabled()
py
def get_enabled()
php
function get_enabled()
es
function get_enabled()
cmd
YHubPort target get_enabled

Retourne :

soit Y_ENABLED_FALSE, soit Y_ENABLED_TRUE, selon vrai si le port du Yocto-hub est alimenté, faux sinon

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

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.

js
function get_errorMessage()
cpp
string get_errorMessage()
m
-(NSString*) errorMessage
pas
function get_errorMessage(): string
vb
function get_errorMessage() As String
cs
string get_errorMessage()
java
String get_errorMessage()
py
def get_errorMessage()
php
function get_errorMessage()
es
function get_errorMessage()

Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions.

Retourne :

une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du port de Yocto-hub.

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

js
function get_errorType()
cpp
YRETCODE get_errorType()
pas
function get_errorType(): YRETCODE
vb
function get_errorType() As YRETCODE
cs
YRETCODE get_errorType()
java
int get_errorType()
py
def get_errorType()
php
function get_errorType()
es
function get_errorType()

Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions.

Retourne :

un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du port de Yocto-hub.

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.

js
function get_friendlyName()
cpp
string get_friendlyName()
m
-(NSString*) friendlyName
cs
string get_friendlyName()
java
String get_friendlyName()
py
def get_friendlyName()
php
function get_friendlyName()
es
function get_friendlyName()

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.

js
function get_functionDescriptor()
cpp
YFUN_DESCR get_functionDescriptor()
m
-(YFUN_DESCR) functionDescriptor
pas
function get_functionDescriptor(): YFUN_DESCR
vb
function get_functionDescriptor() As YFUN_DESCR
cs
YFUN_DESCR get_functionDescriptor()
java
String get_functionDescriptor()
py
def get_functionDescriptor()
php
function get_functionDescriptor()
es
function get_functionDescriptor()

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.

js
function get_functionId()
cpp
string get_functionId()
m
-(NSString*) functionId
vb
function get_functionId() As String
cs
string get_functionId()
java
String get_functionId()
py
def get_functionId()
php
function get_functionId()
es
function get_functionId()

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.

js
function get_hardwareId()
cpp
string get_hardwareId()
m
-(NSString*) hardwareId
vb
function get_hardwareId() As String
cs
string get_hardwareId()
java
String get_hardwareId()
py
def get_hardwareId()
php
function get_hardwareId()
es
function get_hardwareId()

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.

js
function get_logicalName()
cpp
string get_logicalName()
m
-(NSString*) logicalName
pas
function get_logicalName(): string
vb
function get_logicalName() As String
cs
string get_logicalName()
java
String get_logicalName()
uwp
async Task<string> get_logicalName()
py
def get_logicalName()
php
function get_logicalName()
es
function get_logicalName()
cmd
YHubPort target get_logicalName

Retourne :

une chaîne de caractères représentant le nom logique du port de Yocto-hub.

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

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.

js
function get_module()
cpp
YModule * get_module()
m
-(YModule*) module
pas
function get_module(): TYModule
vb
function get_module() As YModule
cs
YModule get_module()
java
YModule get_module()
py
def get_module()
php
function get_module()
es
function get_module()

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.

js
function get_module_async(callback, context)

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 :

callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et l'instance demandée de YModule
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

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.

js
function get_portState()
cpp
Y_PORTSTATE_enum get_portState()
m
-(Y_PORTSTATE_enum) portState
pas
function get_portState(): Integer
vb
function get_portState() As Integer
cs
int get_portState()
java
int get_portState()
uwp
async Task<int> get_portState()
py
def get_portState()
php
function get_portState()
es
function get_portState()
cmd
YHubPort target get_portState

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

js
function get_userData()
cpp
void * get_userData()
m
-(id) userData
pas
function get_userData(): Tobject
vb
function get_userData() As Object
cs
object get_userData()
java
Object get_userData()
py
def get_userData()
php
function get_userData()
es
function get_userData()

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

Retourne :

l'objet stocké précédemment par l'appelant.

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.

js
function isOnline()
cpp
bool isOnline()
m
-(BOOL) isOnline
pas
function isOnline(): boolean
vb
function isOnline() As Boolean
cs
bool isOnline()
java
boolean isOnline()
py
def isOnline()
php
function isOnline()
es
function isOnline()

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.

js
function isOnline_async(callback, context)

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 :

callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et le résultat booléen
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

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

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.

js
function load(msValidity)
cpp
YRETCODE load(int msValidity)
m
-(YRETCODE) load: (int) msValidity
pas
function load(msValidity: integer): YRETCODE
vb
function load(ByVal msValidity As Integer) As YRETCODE
cs
YRETCODE load(ulong msValidity)
java
int load(long msValidity)
py
def load(msValidity)
php
function load($msValidity)
es
function load(msValidity)

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 :

msValidityun entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes

Retourne :

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

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

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.

js
function loadAttribute(attrName)
cpp
string loadAttribute(string attrName)
m
-(NSString*) loadAttribute: (NSString*) attrName
pas
function loadAttribute(attrName: string): string
vb
function loadAttribute() As String
cs
string loadAttribute(string attrName)
java
String loadAttribute(String attrName)
uwp
async Task<string> loadAttribute(string attrName)
py
def loadAttribute(attrName)
php
function loadAttribute($attrName)
es
function loadAttribute(attrName)

Paramètres :

attrNamele nom de l'attribut désiré

Retourne :

une chaîne de caractères représentant la valeur actuelle de l'attribut.

En cas d'erreur, déclenche une exception ou retourne un chaîne vide.

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.

js
function load_async(msValidity, callback, context)

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 :

msValidityun entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes
callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et le code d'erreur (ou YAPI_SUCCESS)
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

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.

js
function muteValueCallbacks()
cpp
int muteValueCallbacks()
m
-(int) muteValueCallbacks
pas
function muteValueCallbacks(): LongInt
vb
function muteValueCallbacks() As Integer
cs
int muteValueCallbacks()
java
int muteValueCallbacks()
uwp
async Task<int> muteValueCallbacks()
py
def muteValueCallbacks()
php
function muteValueCallbacks()
es
function muteValueCallbacks()
cmd
YHubPort target muteValueCallbacks

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

js
function nextHubPort()
cpp
YHubPort * nextHubPort()
m
-(YHubPort*) nextHubPort
pas
function nextHubPort(): TYHubPort
vb
function nextHubPort() As YHubPort
cs
YHubPort nextHubPort()
java
YHubPort nextHubPort()
uwp
YHubPort nextHubPort()
py
def nextHubPort()
php
function nextHubPort()
es
function nextHubPort()

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.

js
function registerValueCallback(callback)
cpp
int registerValueCallback(YHubPortValueCallback callback)
m
-(int) registerValueCallback: (YHubPortValueCallback) callback
pas
function registerValueCallback(callback: TYHubPortValueCallback): LongInt
vb
function registerValueCallback() As Integer
cs
int registerValueCallback(ValueCallback callback)
java
int registerValueCallback(UpdateCallback callback)
uwp
async Task<int> registerValueCallback(ValueCallback callback)
py
def registerValueCallback(callback)
php
function registerValueCallback($callback)
es
function registerValueCallback(callback)

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 :

callbackla fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée.

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.

js
function set_enabled(newval)
cpp
int set_enabled(Y_ENABLED_enum newval)
m
-(int) setEnabled: (Y_ENABLED_enum) newval
pas
function set_enabled(newval: Integer): integer
vb
function set_enabled(ByVal newval As Integer) As Integer
cs
int set_enabled(int newval)
java
int set_enabled(int newval)
uwp
async Task<int> set_enabled(int newval)
py
def set_enabled(newval)
php
function set_enabled($newval)
es
function set_enabled(newval)
cmd
YHubPort target set_enabled newval

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

Paramètres :

newvalsoit Y_ENABLED_FALSE, soit Y_ENABLED_TRUE, selon le mode d'activation du port du Yocto-hub

Retourne :

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

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

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.

js
function set_logicalName(newval)
cpp
int set_logicalName(const string& newval)
m
-(int) setLogicalName: (NSString*) newval
pas
function set_logicalName(newval: string): integer
vb
function set_logicalName(ByVal newval As String) As Integer
cs
int set_logicalName(string newval)
java
int set_logicalName(String newval)
uwp
async Task<int> set_logicalName(string newval)
py
def set_logicalName(newval)
php
function set_logicalName($newval)
es
function set_logicalName(newval)
cmd
YHubPort target set_logicalName newval

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 :

newvalune chaîne de caractères représentant le nom logique du port de Yocto-hub.

Retourne :

YAPI_SUCCESS si l'appel se déroule sans erreur.

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

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.

js
function set_userData(data)
cpp
void set_userData(void* data)
m
-(void) setUserData: (id) data
pas
procedure set_userData(data: Tobject)
vb
procedure set_userData(ByVal data As Object)
cs
void set_userData(object data)
java
void set_userData(Object data)
py
def set_userData(data)
php
function set_userData($data)
es
function set_userData(data)

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

Paramètres :

dataobjet quelconque à mémoriser

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.

js
function unmuteValueCallbacks()
cpp
int unmuteValueCallbacks()
m
-(int) unmuteValueCallbacks
pas
function unmuteValueCallbacks(): LongInt
vb
function unmuteValueCallbacks() As Integer
cs
int unmuteValueCallbacks()
java
int unmuteValueCallbacks()
uwp
async Task<int> unmuteValueCallbacks()
py
def unmuteValueCallbacks()
php
function unmuteValueCallbacks()
es
function unmuteValueCallbacks()
cmd
YHubPort target unmuteValueCallbacks

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.

js
function wait_async(callback, context)
es
function wait_async(callback, context)

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

Paramètres :

callbackfonction de callback qui sera appelée dès que toutes les commandes en cours d'exécution sur le module seront terminées La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné.
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

rien du tout.

10.2. Interface de la fonction Network

Les objets YNetwork permettent de contrôler les paramètres TCP/IP des modules Yoctopuce dotés d'une interface réseau.

Pour utiliser les fonctions décrites ici, vous devez inclure:

js
<script type='text/javascript' src='yocto_network.js'></script>
cpp
#include "yocto_network.h"
m
#import "yocto_network.h"
pas
uses yocto_network;
vb
yocto_network.vb
cs
yocto_network.cs
java
import com.yoctopuce.YoctoAPI.YNetwork;
uwp
import com.yoctopuce.YoctoAPI.YNetwork;
py
from yocto_network import *
php
require_once('yocto_network.php');
es
in HTML: <script src="../../lib/yocto_network.js"></script>
in node.js: require('yoctolib-es2017/yocto_network.js');
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 la page HTML à envoyer pour l'URL "/"

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_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→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().

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 la page HTML par défaut 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é.

js
function yFindNetwork(func)
cpp
YNetwork* yFindNetwork(string func)
m
+(YNetwork*) FindNetwork: (NSString*) func
pas
function yFindNetwork(func: string): TYNetwork
vb
function yFindNetwork(ByVal func As String) As YNetwork
cs
YNetwork FindNetwork(string func)
java
YNetwork FindNetwork(String func)
uwp
YNetwork FindNetwork(string func)
py
def FindNetwork(func)
php
function yFindNetwork($func)
es
function FindNetwork(func)

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

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 :

funcune chaîne de caractères qui référence l'interface réseau sans ambiguïté

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.

java
YNetwork FindNetworkInContext(YAPIContext yctx, String func)
uwp
YNetwork FindNetworkInContext(YAPIContext yctx, string func)
es
function FindNetworkInContext(yctx, func)

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

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 :

yctxun contexte YAPI
funcune chaîne de caractères qui référence l'interface réseau sans ambiguïté

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.

js
function yFirstNetwork()
cpp
YNetwork* yFirstNetwork()
m
+(YNetwork*) FirstNetwork
pas
function yFirstNetwork(): TYNetwork
vb
function yFirstNetwork() As YNetwork
cs
YNetwork FirstNetwork()
java
YNetwork FirstNetwork()
uwp
YNetwork FirstNetwork()
py
def FirstNetwork()
php
function yFirstNetwork()
es
function FirstNetwork()

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.

java
YNetwork FirstNetworkInContext(YAPIContext yctx)
uwp
YNetwork FirstNetworkInContext(YAPIContext yctx)
es
function FirstNetworkInContext(yctx)

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

Paramètres :

yctxun contexte YAPI.

Retourne :

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

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.

js
function callbackLogin(username, password)
cpp
int callbackLogin(string username, string password)
m
-(int) callbackLogin: (NSString*) username
  : (NSString*) password
pas
function callbackLogin(username: string, password: string): integer
vb
function callbackLogin(ByVal username As String,
  ByVal password As String) As Integer
cs
int callbackLogin(string username, string password)
java
int callbackLogin(String username, String password)
py
def callbackLogin(username, password)
php
function callbackLogin($username, $password)
es
function callbackLogin(username, password)
cmd
YNetwork target callbackLogin username password

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 :

usernamenom d'utilisateur pour s'identifier au callback
passwordmot de passe pour s'identifier au callback

Retourne :

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

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

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.

js
function clearCache()
cpp
void clearCache()
m
-(void) clearCache
pas
procedure clearCache()
vb
procedure clearCache()
cs
void clearCache()
java
void clearCache()
py
def clearCache()
php
function clearCache()
es
function clearCache()

Invalide le cache des valeurs courantes de l'interface réseau. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module.

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.

js
function describe()
cpp
string describe()
m
-(NSString*) describe
pas
function describe(): string
vb
function describe() As String
cs
string describe()
java
String describe()
py
def describe()
php
function describe()
es
function describe()

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.

js
function get_adminPassword()
cpp
string get_adminPassword()
m
-(NSString*) adminPassword
pas
function get_adminPassword(): string
vb
function get_adminPassword() As String
cs
string get_adminPassword()
java
String get_adminPassword()
uwp
async Task<string> get_adminPassword()
py
def get_adminPassword()
php
function get_adminPassword()
es
function get_adminPassword()
cmd
YNetwork target get_adminPassword

Retourne :

une chaîne de caractères représentant une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "admin", ou sinon une chaîne vide

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

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

js
function get_advertisedValue()
cpp
string get_advertisedValue()
m
-(NSString*) advertisedValue
pas
function get_advertisedValue(): string
vb
function get_advertisedValue() As String
cs
string get_advertisedValue()
java
String get_advertisedValue()
uwp
async Task<string> get_advertisedValue()
py
def get_advertisedValue()
php
function get_advertisedValue()
es
function get_advertisedValue()
cmd
YNetwork target get_advertisedValue

Retourne :

une chaîne de caractères représentant la valeur courante de l'interface réseau (pas plus de 6 caractères).

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

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.

js
function get_callbackCredentials()
cpp
string get_callbackCredentials()
m
-(NSString*) callbackCredentials
pas
function get_callbackCredentials(): string
vb
function get_callbackCredentials() As String
cs
string get_callbackCredentials()
java
String get_callbackCredentials()
uwp
async Task<string> get_callbackCredentials()
py
def get_callbackCredentials()
php
function get_callbackCredentials()
es
function get_callbackCredentials()
cmd
YNetwork target get_callbackCredentials

Retourne :

une chaîne de caractères représentant une version hashée du laisser-passer pour le callback de notification s'il a été configuré, ou sinon une chaîne vide

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

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.

js
function get_callbackEncoding()
cpp
Y_CALLBACKENCODING_enum get_callbackEncoding()
m
-(Y_CALLBACKENCODING_enum) callbackEncoding
pas
function get_callbackEncoding(): Integer
vb
function get_callbackEncoding() As Integer
cs
int get_callbackEncoding()
java
int get_callbackEncoding()
uwp
async Task<int> get_callbackEncoding()
py
def get_callbackEncoding()
php
function get_callbackEncoding()
es
function get_callbackEncoding()
cmd
YNetwork target get_callbackEncoding

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 et Y_CALLBACKENCODING_YOCTO_API_JZON 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.

js
function get_callbackInitialDelay()
cpp
int get_callbackInitialDelay()
m
-(int) callbackInitialDelay
pas
function get_callbackInitialDelay(): LongInt
vb
function get_callbackInitialDelay() As Integer
cs
int get_callbackInitialDelay()
java
int get_callbackInitialDelay()
uwp
async Task<int> get_callbackInitialDelay()
py
def get_callbackInitialDelay()
php
function get_callbackInitialDelay()
es
function get_callbackInitialDelay()
cmd
YNetwork target get_callbackInitialDelay

Retourne :

un entier représentant l'attente initiale avant la première notification par callback, en secondes

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

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.

js
function get_callbackMaxDelay()
cpp
int get_callbackMaxDelay()
m
-(int) callbackMaxDelay
pas
function get_callbackMaxDelay(): LongInt
vb
function get_callbackMaxDelay() As Integer
cs
int get_callbackMaxDelay()
java
int get_callbackMaxDelay()
uwp
async Task<int> get_callbackMaxDelay()
py
def get_callbackMaxDelay()
php
function get_callbackMaxDelay()
es
function get_callbackMaxDelay()
cmd
YNetwork target get_callbackMaxDelay

Retourne :

un entier représentant l'attente entre deux callback HTTP lorsque rien n'est à signaler, en secondes

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

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.

js
function get_callbackMethod()
cpp
Y_CALLBACKMETHOD_enum get_callbackMethod()
m
-(Y_CALLBACKMETHOD_enum) callbackMethod
pas
function get_callbackMethod(): Integer
vb
function get_callbackMethod() As Integer
cs
int get_callbackMethod()
java
int get_callbackMethod()
uwp
async Task<int> get_callbackMethod()
py
def get_callbackMethod()
php
function get_callbackMethod()
es
function get_callbackMethod()
cmd
YNetwork target get_callbackMethod

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.

js
function get_callbackMinDelay()
cpp
int get_callbackMinDelay()
m
-(int) callbackMinDelay
pas
function get_callbackMinDelay(): LongInt
vb
function get_callbackMinDelay() As Integer
cs
int get_callbackMinDelay()
java
int get_callbackMinDelay()
uwp
async Task<int> get_callbackMinDelay()
py
def get_callbackMinDelay()
php
function get_callbackMinDelay()
es
function get_callbackMinDelay()
cmd
YNetwork target get_callbackMinDelay

Retourne :

un entier représentant l'attente minimale entre deux callbacks HTTP, en secondes

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

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.

js
function get_callbackSchedule()
cpp
string get_callbackSchedule()
m
-(NSString*) callbackSchedule
pas
function get_callbackSchedule(): string
vb
function get_callbackSchedule() As String
cs
string get_callbackSchedule()
java
String get_callbackSchedule()
uwp
async Task<string> get_callbackSchedule()
py
def get_callbackSchedule()
php
function get_callbackSchedule()
es
function get_callbackSchedule()
cmd
YNetwork target get_callbackSchedule

Retourne :

une chaîne de caractères représentant la planification des callbacks HTTP, sous forme de chaîne de caractères

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

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.

js
function get_callbackUrl()
cpp
string get_callbackUrl()
m
-(NSString*) callbackUrl
pas
function get_callbackUrl(): string
vb
function get_callbackUrl() As String
cs
string get_callbackUrl()
java
String get_callbackUrl()
uwp
async Task<string> get_callbackUrl()
py
def get_callbackUrl()
php
function get_callbackUrl()
es
function get_callbackUrl()
cmd
YNetwork target get_callbackUrl

Retourne :

une chaîne de caractères représentant l'adresse (URL) de callback à notifier lors de changement d'état significatifs

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

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 "/"

js
function get_defaultPage()
cpp
string get_defaultPage()
m
-(NSString*) defaultPage
pas
function get_defaultPage(): string
vb
function get_defaultPage() As String
cs
string get_defaultPage()
java
String get_defaultPage()
uwp
async Task<string> get_defaultPage()
py
def get_defaultPage()
php
function get_defaultPage()
es
function get_defaultPage()
cmd
YNetwork target get_defaultPage

Retourne :

une chaîne de caractères représentant la page HTML à envoyer pour l'URL "/"

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

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

js
function get_discoverable()
cpp
Y_DISCOVERABLE_enum get_discoverable()
m
-(Y_DISCOVERABLE_enum) discoverable
pas
function get_discoverable(): Integer
vb
function get_discoverable() As Integer
cs
int get_discoverable()
java
int get_discoverable()
uwp
async Task<int> get_discoverable()
py
def get_discoverable()
php
function get_discoverable()
es
function get_discoverable()
cmd
YNetwork target get_discoverable

Retourne :

soit Y_DISCOVERABLE_FALSE, soit Y_DISCOVERABLE_TRUE, selon l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour)

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

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.

js
function get_errorMessage()
cpp
string get_errorMessage()
m
-(NSString*) errorMessage
pas
function get_errorMessage(): string
vb
function get_errorMessage() As String
cs
string get_errorMessage()
java
String get_errorMessage()
py
def get_errorMessage()
php
function get_errorMessage()
es
function get_errorMessage()

Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions.

Retourne :

une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.

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

js
function get_errorType()
cpp
YRETCODE get_errorType()
pas
function get_errorType(): YRETCODE
vb
function get_errorType() As YRETCODE
cs
YRETCODE get_errorType()
java
int get_errorType()
py
def get_errorType()
php
function get_errorType()
es
function get_errorType()

Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions.

Retourne :

un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.

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.

js
function get_friendlyName()
cpp
string get_friendlyName()
m
-(NSString*) friendlyName
cs
string get_friendlyName()
java
String get_friendlyName()
py
def get_friendlyName()
php
function get_friendlyName()
es
function get_friendlyName()

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.

js
function get_functionDescriptor()
cpp
YFUN_DESCR get_functionDescriptor()
m
-(YFUN_DESCR) functionDescriptor
pas
function get_functionDescriptor(): YFUN_DESCR
vb
function get_functionDescriptor() As YFUN_DESCR
cs
YFUN_DESCR get_functionDescriptor()
java
String get_functionDescriptor()
py
def get_functionDescriptor()
php
function get_functionDescriptor()
es
function get_functionDescriptor()

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.

js
function get_functionId()
cpp
string get_functionId()
m
-(NSString*) functionId
vb
function get_functionId() As String
cs
string get_functionId()
java
String get_functionId()
py
def get_functionId()
php
function get_functionId()
es
function get_functionId()

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.

js
function get_hardwareId()
cpp
string get_hardwareId()
m
-(NSString*) hardwareId
vb
function get_hardwareId() As String
cs
string get_hardwareId()
java
String get_hardwareId()
py
def get_hardwareId()
php
function get_hardwareId()
es
function get_hardwareId()

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

Retourne :

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 la page HTML à envoyer pour l'URL "/"

js
function get_httpPort()
cpp
int get_httpPort()
m
-(int) httpPort
pas
function get_httpPort(): LongInt
vb
function get_httpPort() As Integer
cs
int get_httpPort()
java
int get_httpPort()
uwp
async Task<int> get_httpPort()
py
def get_httpPort()
php
function get_httpPort()
es
function get_httpPort()
cmd
YNetwork target get_httpPort

Retourne :

un entier représentant la page HTML à envoyer pour l'URL "/"

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.

js
function get_ipAddress()
cpp
string get_ipAddress()
m
-(NSString*) ipAddress
pas
function get_ipAddress(): string
vb
function get_ipAddress() As String
cs
string get_ipAddress()
java
String get_ipAddress()
uwp
async Task<string> get_ipAddress()
py
def get_ipAddress()
php
function get_ipAddress()
es
function get_ipAddress()
cmd
YNetwork target get_ipAddress

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.

js
function get_ipConfig()
cpp
string get_ipConfig()
m
-(NSString*) ipConfig
pas
function get_ipConfig(): string
vb
function get_ipConfig() As String
cs
string get_ipConfig()
java
String get_ipConfig()
uwp
async Task<string> get_ipConfig()
py
def get_ipConfig()
php
function get_ipConfig()
es
function get_ipConfig()
cmd
YNetwork target get_ipConfig

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.

js
function get_logicalName()
cpp
string get_logicalName()
m
-(NSString*) logicalName
pas
function get_logicalName(): string
vb
function get_logicalName() As String
cs
string get_logicalName()
java
String get_logicalName()
uwp
async Task<string> get_logicalName()
py
def get_logicalName()
php
function get_logicalName()
es
function get_logicalName()
cmd
YNetwork target get_logicalName

Retourne :

une chaîne de caractères représentant le nom logique de l'interface réseau.

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

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.

js
function get_macAddress()
cpp
string get_macAddress()
m
-(NSString*) macAddress
pas
function get_macAddress(): string
vb
function get_macAddress() As String
cs
string get_macAddress()
java
String get_macAddress()
uwp
async Task<string> get_macAddress()
py
def get_macAddress()
php
function get_macAddress()
es
function get_macAddress()
cmd
YNetwork target get_macAddress

L'adresse MAC est aussi présente sur un autocollant sur le module, représentée en chiffres et en code-barres.

Retourne :

une chaîne de caractères représentant l'adresse MAC de l'interface réseau, unique pour chaque module

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

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.

js
function get_module()
cpp
YModule * get_module()
m
-(YModule*) module
pas
function get_module(): TYModule
vb
function get_module() As YModule
cs
YModule get_module()
java
YModule get_module()
py
def get_module()
php
function get_module()
es
function get_module()

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.

js
function get_module_async(callback, context)

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 :

callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et l'instance demandée de YModule
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

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.

js
function get_ntpServer()
cpp
string get_ntpServer()
m
-(NSString*) ntpServer
pas
function get_ntpServer(): string
vb
function get_ntpServer() As String
cs
string get_ntpServer()
java
String get_ntpServer()
uwp
async Task<string> get_ntpServer()
py
def get_ntpServer()
php
function get_ntpServer()
es
function get_ntpServer()
cmd
YNetwork target get_ntpServer

Retourne :

une chaîne de caractères représentant l'adresse IP du serveur de NTP à utiliser pour maintenir le module à l'heure

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

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.

js
function get_poeCurrent()
cpp
int get_poeCurrent()
m
-(int) poeCurrent
pas
function get_poeCurrent(): LongInt
vb
function get_poeCurrent() As Integer
cs
int get_poeCurrent()
java
int get_poeCurrent()
uwp
async Task<int> get_poeCurrent()
py
def get_poeCurrent()
php
function get_poeCurrent()
es
function get_poeCurrent()
cmd
YNetwork target get_poeCurrent

La consommation est mesurée après conversion en 5 Volt, et ne doit jamais dépasser 1800 mA.

Retourne :

un entier représentant le courant consommé par le module depuis Power-over-Ethernet (PoE), en milliampères

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

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.

js
function get_primaryDNS()
cpp
string get_primaryDNS()
m
-(NSString*) primaryDNS
pas
function get_primaryDNS(): string
vb
function get_primaryDNS() As String
cs
string get_primaryDNS()
java
String get_primaryDNS()
uwp
async Task<string> get_primaryDNS()
py
def get_primaryDNS()
php
function get_primaryDNS()
es
function get_primaryDNS()
cmd
YNetwork target get_primaryDNS

Retourne :

une chaîne de caractères représentant l'adresse IP du serveur de noms primaire que le module doit utiliser

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

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.

js
function get_readiness()
cpp
Y_READINESS_enum get_readiness()
m
-(Y_READINESS_enum) readiness
pas
function get_readiness(): Integer
vb
function get_readiness() As Integer
cs
int get_readiness()
java
int get_readiness()
uwp
async Task<int> get_readiness()
py
def get_readiness()
php
function get_readiness()
es
function get_readiness()
cmd
YNetwork target get_readiness

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

js
function get_router()
cpp
string get_router()
m
-(NSString*) router
pas
function get_router(): string
vb
function get_router() As String
cs
string get_router()
java
String get_router()
uwp
async Task<string> get_router()
py
def get_router()
php
function get_router()
es
function get_router()
cmd
YNetwork target get_router

Retourne :

une chaîne de caractères représentant l'adresse IP du routeur (passerelle) utilisé par le module (default gateway)

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

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.

js
function get_secondaryDNS()
cpp
string get_secondaryDNS()
m
-(NSString*) secondaryDNS
pas
function get_secondaryDNS(): string
vb
function get_secondaryDNS() As String
cs
string get_secondaryDNS()
java
String get_secondaryDNS()
uwp
async Task<string> get_secondaryDNS()
py
def get_secondaryDNS()
php
function get_secondaryDNS()
es
function get_secondaryDNS()
cmd
YNetwork target get_secondaryDNS

Retourne :

une chaîne de caractères représentant l'adresse IP du serveur de noms secondaire que le module doit utiliser

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

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.

js
function get_subnetMask()
cpp
string get_subnetMask()
m
-(NSString*) subnetMask
pas
function get_subnetMask(): string
vb
function get_subnetMask() As String
cs
string get_subnetMask()
java
String get_subnetMask()
uwp
async Task<string> get_subnetMask()
py
def get_subnetMask()
php
function get_subnetMask()
es
function get_subnetMask()
cmd
YNetwork target get_subnetMask

Retourne :

une chaîne de caractères représentant le masque de sous-réseau utilisé par le module

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

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.

js
function get_userData()
cpp
void * get_userData()
m
-(id) userData
pas
function get_userData(): Tobject
vb
function get_userData() As Object
cs
object get_userData()
java
Object get_userData()
py
def get_userData()
php
function get_userData()
es
function get_userData()

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

Retourne :

l'objet stocké précédemment par l'appelant.

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.

js
function get_userPassword()
cpp
string get_userPassword()
m
-(NSString*) userPassword
pas
function get_userPassword(): string
vb
function get_userPassword() As String
cs
string get_userPassword()
java
String get_userPassword()
uwp
async Task<string> get_userPassword()
py
def get_userPassword()
php
function get_userPassword()
es
function get_userPassword()
cmd
YNetwork target get_userPassword

Retourne :

une chaîne de caractères représentant une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "user", ou sinon une chaîne vide

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

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.

js
function get_wwwWatchdogDelay()
cpp
int get_wwwWatchdogDelay()
m
-(int) wwwWatchdogDelay
pas
function get_wwwWatchdogDelay(): LongInt
vb
function get_wwwWatchdogDelay() As Integer
cs
int get_wwwWatchdogDelay()
java
int get_wwwWatchdogDelay()
uwp
async Task<int> get_wwwWatchdogDelay()
py
def get_wwwWatchdogDelay()
php
function get_wwwWatchdogDelay()
es
function get_wwwWatchdogDelay()
cmd
YNetwork target get_wwwWatchdogDelay

Une valeur nulle désactive le redémarrage automatique en cas de perte de connectivité WWW.

Retourne :

un entier représentant la durée de perte de connection WWW tolérée (en secondes) avant de déclancher un redémarrage automatique pour tenter de récupérer la connectivité Internet

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

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.

js
function isOnline()
cpp
bool isOnline()
m
-(BOOL) isOnline
pas
function isOnline(): boolean
vb
function isOnline() As Boolean
cs
bool isOnline()
java
boolean isOnline()
py
def isOnline()
php
function isOnline()
es
function isOnline()

Si les valeurs des attributs en cache de l'interface réseau sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité.

Retourne :

true si l'interface réseau est joignable, false sinon

network→isOnline_async()network.isOnline_async()

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

js
function isOnline_async(callback, context)

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 :

callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et le résultat booléen
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

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

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.

js
function load(msValidity)
cpp
YRETCODE load(int msValidity)
m
-(YRETCODE) load: (int) msValidity
pas
function load(msValidity: integer): YRETCODE
vb
function load(ByVal msValidity As Integer) As YRETCODE
cs
YRETCODE load(ulong msValidity)
java
int load(long msValidity)
py
def load(msValidity)
php
function load($msValidity)
es
function load(msValidity)

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 :

msValidityun entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes

Retourne :

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

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

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.

js
function loadAttribute(attrName)
cpp
string loadAttribute(string attrName)
m
-(NSString*) loadAttribute: (NSString*) attrName
pas
function loadAttribute(attrName: string): string
vb
function loadAttribute() As String
cs
string loadAttribute(string attrName)
java
String loadAttribute(String attrName)
uwp
async Task<string> loadAttribute(string attrName)
py
def loadAttribute(attrName)
php
function loadAttribute($attrName)
es
function loadAttribute(attrName)

Paramètres :

attrNamele nom de l'attribut désiré

Retourne :

une chaîne de caractères représentant la valeur actuelle de l'attribut.

En cas d'erreur, déclenche une exception ou retourne un chaîne vide.

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.

js
function load_async(msValidity, callback, context)

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 :

msValidityun entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes
callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et le code d'erreur (ou YAPI_SUCCESS)
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

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.

js
function muteValueCallbacks()
cpp
int muteValueCallbacks()
m
-(int) muteValueCallbacks
pas
function muteValueCallbacks(): LongInt
vb
function muteValueCallbacks() As Integer
cs
int muteValueCallbacks()
java
int muteValueCallbacks()
uwp
async Task<int> muteValueCallbacks()
py
def muteValueCallbacks()
php
function muteValueCallbacks()
es
function muteValueCallbacks()
cmd
YNetwork target muteValueCallbacks

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

js
function nextNetwork()
cpp
YNetwork * nextNetwork()
m
-(YNetwork*) nextNetwork
pas
function nextNetwork(): TYNetwork
vb
function nextNetwork() As YNetwork
cs
YNetwork nextNetwork()
java
YNetwork nextNetwork()
uwp
YNetwork nextNetwork()
py
def nextNetwork()
php
function nextNetwork()
es
function nextNetwork()

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.

js
function ping(host)
cpp
string ping(string host)
m
-(NSString*) ping: (NSString*) host
pas
function ping(host: string): string
vb
function ping() As String
cs
string ping(string host)
java
String ping(String host)
uwp
async Task<string> ping(string host)
py
def ping(host)
php
function ping($host)
es
function ping(host)
cmd
YNetwork target ping host

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 :

hostle nom d'hôte ou l'adresse IP de la cible

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.

js
function registerValueCallback(callback)
cpp
int registerValueCallback(YNetworkValueCallback callback)
m
-(int) registerValueCallback: (YNetworkValueCallback) callback
pas
function registerValueCallback(callback: TYNetworkValueCallback): LongInt
vb
function registerValueCallback() As Integer
cs
int registerValueCallback(ValueCallback callback)
java
int registerValueCallback(UpdateCallback callback)
uwp
async Task<int> registerValueCallback(ValueCallback callback)
py
def registerValueCallback(callback)
php
function registerValueCallback($callback)
es
function registerValueCallback(callback)

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 :

callbackla fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée.

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.

js
function set_adminPassword(newval)
cpp
int set_adminPassword(const string& newval)
m
-(int) setAdminPassword: (NSString*) newval
pas
function set_adminPassword(newval: string): integer
vb
function set_adminPassword(ByVal newval As String) As Integer
cs
int set_adminPassword(string newval)
java
int set_adminPassword(String newval)
uwp
async Task<int> set_adminPassword(string newval)
py
def set_adminPassword(newval)
php
function set_adminPassword($newval)
es
function set_adminPassword(newval)
cmd
YNetwork target set_adminPassword newval

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 :

newvalune chaîne de caractères représentant le mot de passe pour l'utilisateur "admin", qui devient alors instantanément nécessaire pour toute altération de l'état du module

Retourne :

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

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

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.

js
function set_callbackCredentials(newval)
cpp
int set_callbackCredentials(const string& newval)
m
-(int) setCallbackCredentials: (NSString*) newval
pas
function set_callbackCredentials(newval: string): integer
vb
function set_callbackCredentials(ByVal newval As String) As Integer
cs
int set_callbackCredentials(string newval)
java
int set_callbackCredentials(String newval)
uwp
async Task<int> set_callbackCredentials(string newval)
py
def set_callbackCredentials(newval)
php
function set_callbackCredentials($newval)
es
function set_callbackCredentials(newval)
cmd
YNetwork target set_callbackCredentials newval

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 :

newvalune chaîne de caractères représentant le laisser-passer pour se connecter à l'adresse de callback

Retourne :

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

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

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.

js
function set_callbackEncoding(newval)
cpp
int set_callbackEncoding(Y_CALLBACKENCODING_enum newval)
m
-(int) setCallbackEncoding: (Y_CALLBACKENCODING_enum) newval
pas
function set_callbackEncoding(newval: Integer): integer
vb
function set_callbackEncoding(ByVal newval As Integer) As Integer
cs
int set_callbackEncoding(int newval)
java
int set_callbackEncoding(int newval)
uwp
async Task<int> set_callbackEncoding(int newval)
py
def set_callbackEncoding(newval)
php
function set_callbackEncoding($newval)
es
function set_callbackEncoding(newval)
cmd
YNetwork target set_callbackEncoding newval

Paramètres :

newvalune 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 et Y_CALLBACKENCODING_YOCTO_API_JZON représentant l'encodage à utiliser pour représenter les valeurs notifiées par callback

Retourne :

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

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

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.

js
function set_callbackInitialDelay(newval)
cpp
int set_callbackInitialDelay(int newval)
m
-(int) setCallbackInitialDelay: (int) newval
pas
function set_callbackInitialDelay(newval: LongInt): integer
vb
function set_callbackInitialDelay(ByVal newval As Integer) As Integer
cs
int set_callbackInitialDelay(int newval)
java
int set_callbackInitialDelay(int newval)
uwp
async Task<int> set_callbackInitialDelay(int newval)
py
def set_callbackInitialDelay(newval)
php
function set_callbackInitialDelay($newval)
es
function set_callbackInitialDelay(newval)
cmd
YNetwork target set_callbackInitialDelay newval

Paramètres :

newvalun entier représentant l'attente initiale avant la première notification par callback, en secondes

Retourne :

YAPI_SUCCESS si 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.

js
function set_callbackMaxDelay(newval)
cpp
int set_callbackMaxDelay(int newval)
m
-(int) setCallbackMaxDelay: (int) newval
pas
function set_callbackMaxDelay(newval: LongInt): integer
vb
function set_callbackMaxDelay(ByVal newval As Integer) As Integer
cs
int set_callbackMaxDelay(int newval)
java
int set_callbackMaxDelay(int newval)
uwp
async Task<int> set_callbackMaxDelay(int newval)
py
def set_callbackMaxDelay(newval)
php
function set_callbackMaxDelay($newval)
es
function set_callbackMaxDelay(newval)
cmd
YNetwork target set_callbackMaxDelay newval

Paramètres :

newvalun entier représentant l'attente entre deux callback HTTP lorsque rien n'est à signaler

Retourne :

YAPI_SUCCESS si 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.

js
function set_callbackMethod(newval)
cpp
int set_callbackMethod(Y_CALLBACKMETHOD_enum newval)
m
-(int) setCallbackMethod: (Y_CALLBACKMETHOD_enum) newval
pas
function set_callbackMethod(newval: Integer): integer
vb
function set_callbackMethod(ByVal newval As Integer) As Integer
cs
int set_callbackMethod(int newval)
java
int set_callbackMethod(int newval)
uwp
async Task<int> set_callbackMethod(int newval)
py
def set_callbackMethod(newval)
php
function set_callbackMethod($newval)
es
function set_callbackMethod(newval)
cmd
YNetwork target set_callbackMethod newval

Paramètres :

newvalune 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

Retourne :

YAPI_SUCCESS si 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.

js
function set_callbackMinDelay(newval)
cpp
int set_callbackMinDelay(int newval)
m
-(int) setCallbackMinDelay: (int) newval
pas
function set_callbackMinDelay(newval: LongInt): integer
vb
function set_callbackMinDelay(ByVal newval As Integer) As Integer
cs
int set_callbackMinDelay(int newval)
java
int set_callbackMinDelay(int newval)
uwp
async Task<int> set_callbackMinDelay(int newval)
py
def set_callbackMinDelay(newval)
php
function set_callbackMinDelay($newval)
es
function set_callbackMinDelay(newval)
cmd
YNetwork target set_callbackMinDelay newval

Paramètres :

newvalun entier représentant l'attente minimale entre deux callbacks HTTP, en secondes

Retourne :

YAPI_SUCCESS si 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.

js
function set_callbackSchedule(newval)
cpp
int set_callbackSchedule(const string& newval)
m
-(int) setCallbackSchedule: (NSString*) newval
pas
function set_callbackSchedule(newval: string): integer
vb
function set_callbackSchedule(ByVal newval As String) As Integer
cs
int set_callbackSchedule(string newval)
java
int set_callbackSchedule(String newval)
uwp
async Task<int> set_callbackSchedule(string newval)
py
def set_callbackSchedule(newval)
php
function set_callbackSchedule($newval)
es
function set_callbackSchedule(newval)
cmd
YNetwork target set_callbackSchedule newval

Paramètres :

newvalune chaîne de caractères représentant la planification des callbacks HTTP, sous forme de chaîne de caractères

Retourne :

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

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

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.

js
function set_callbackUrl(newval)
cpp
int set_callbackUrl(const string& newval)
m
-(int) setCallbackUrl: (NSString*) newval
pas
function set_callbackUrl(newval: string): integer
vb
function set_callbackUrl(ByVal newval As String) As Integer
cs
int set_callbackUrl(string newval)
java
int set_callbackUrl(String newval)
uwp
async Task<int> set_callbackUrl(string newval)
py
def set_callbackUrl(newval)
php
function set_callbackUrl($newval)
es
function set_callbackUrl(newval)
cmd
YNetwork target set_callbackUrl newval

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

Paramètres :

newvalune chaîne de caractères représentant l'adresse (URL) de callback à notifier lors de changement d'état significatifs

Retourne :

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

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

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.

js
function set_defaultPage(newval)
cpp
int set_defaultPage(const string& newval)
m
-(int) setDefaultPage: (NSString*) newval
pas
function set_defaultPage(newval: string): integer
vb
function set_defaultPage(ByVal newval As String) As Integer
cs
int set_defaultPage(string newval)
java
int set_defaultPage(String newval)
uwp
async Task<int> set_defaultPage(string newval)
py
def set_defaultPage(newval)
php
function set_defaultPage($newval)
es
function set_defaultPage(newval)
cmd
YNetwork target set_defaultPage newval

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.

Paramètres :

newvalune chaîne de caractères représentant la page HTML par défaut du hub

Retourne :

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

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

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

js
function set_discoverable(newval)
cpp
int set_discoverable(Y_DISCOVERABLE_enum newval)
m
-(int) setDiscoverable: (Y_DISCOVERABLE_enum) newval
pas
function set_discoverable(newval: Integer): integer
vb
function set_discoverable(ByVal newval As Integer) As Integer
cs
int set_discoverable(int newval)
java
int set_discoverable(int newval)
uwp
async Task<int> set_discoverable(int newval)
py
def set_discoverable(newval)
php
function set_discoverable($newval)
es
function set_discoverable(newval)
cmd
YNetwork target set_discoverable newval

Paramètres :

newvalsoit 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)

Retourne :

YAPI_SUCCESS si 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 la page HTML par défaut du hub.

js
function set_httpPort(newval)
cpp
int set_httpPort(int newval)
m
-(int) setHttpPort: (int) newval
pas
function set_httpPort(newval: LongInt): integer
vb
function set_httpPort(ByVal newval As Integer) As Integer
cs
int set_httpPort(int newval)
java
int set_httpPort(int newval)
uwp
async Task<int> set_httpPort(int newval)
py
def set_httpPort(newval)
php
function set_httpPort($newval)
es
function set_httpPort(newval)
cmd
YNetwork target set_httpPort newval

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.

Paramètres :

newvalun entier représentant la page HTML par défaut du hub

Retourne :

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

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

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.

js
function set_logicalName(newval)
cpp
int set_logicalName(const string& newval)
m
-(int) setLogicalName: (NSString*) newval
pas
function set_logicalName(newval: string): integer
vb
function set_logicalName(ByVal newval As String) As Integer
cs
int set_logicalName(string newval)
java
int set_logicalName(String newval)
uwp
async Task<int> set_logicalName(string newval)
py
def set_logicalName(newval)
php
function set_logicalName($newval)
es
function set_logicalName(newval)
cmd
YNetwork target set_logicalName newval

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 :

newvalune chaîne de caractères représentant le nom logique de l'interface réseau.

Retourne :

YAPI_SUCCESS si l'appel se déroule sans erreur.

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

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.

js
function set_ntpServer(newval)
cpp
int set_ntpServer(const string& newval)
m
-(int) setNtpServer: (NSString*) newval
pas
function set_ntpServer(newval: string): integer
vb
function set_ntpServer(ByVal newval As String) As Integer
cs
int set_ntpServer(string newval)
java
int set_ntpServer(String newval)
uwp
async Task<int> set_ntpServer(string newval)
py
def set_ntpServer(newval)
php
function set_ntpServer($newval)
es
function set_ntpServer(newval)
cmd
YNetwork target set_ntpServer newval

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

Paramètres :

newvalune chaîne de caractères représentant l'adresse IP du serveur NTP que le module doit utiliser

Retourne :

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

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

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

js
function set_periodicCallbackSchedule(interval, offset)
cpp
int set_periodicCallbackSchedule(string interval, int offset)
m
-(int) setPeriodicCallbackSchedule: (NSString*) interval
  : (int) offset
pas
function set_periodicCallbackSchedule(interval: string,
  offset: LongInt): LongInt
vb
function set_periodicCallbackSchedule() As Integer
cs
int set_periodicCallbackSchedule(string interval, int offset)
java
int set_periodicCallbackSchedule(String interval, int offset)
uwp
async Task<int> set_periodicCallbackSchedule(string interval,
  int offset)
py
def set_periodicCallbackSchedule(interval, offset)
php
function set_periodicCallbackSchedule($interval, $offset)
es
function set_periodicCallbackSchedule(interval, offset)
cmd
YNetwork target set_periodicCallbackSchedule interval offset

Paramètres :

intervalla périodicité du callback sous forme textuelle, exprimée en secondes, minutes ou en heures. Par exemple: "60s", "5m", "1h", "48h".
offsetun entier décrivant le décalage du callback par rapport au début de la période. Par exemple, si la périodicité est 24h, un offset de 7 déclanchera le callback chaque jour à 7h du matin.

Retourne :

YAPI_SUCCESS when the call succeeds.

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

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.

js
function set_primaryDNS(newval)
cpp
int set_primaryDNS(const string& newval)
m
-(int) setPrimaryDNS: (NSString*) newval
pas
function set_primaryDNS(newval: string): integer
vb
function set_primaryDNS(ByVal newval As String) As Integer
cs
int set_primaryDNS(string newval)
java
int set_primaryDNS(String newval)
uwp
async Task<int> set_primaryDNS(string newval)
py
def set_primaryDNS(newval)
php
function set_primaryDNS($newval)
es
function set_primaryDNS(newval)
cmd
YNetwork target set_primaryDNS newval

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 :

newvalune chaîne de caractères représentant l'adresse IP du serveur de noms primaire que le module doit utiliser

Retourne :

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

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

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.

js
function set_secondaryDNS(newval)
cpp
int set_secondaryDNS(const string& newval)
m
-(int) setSecondaryDNS: (NSString*) newval
pas
function set_secondaryDNS(newval: string): integer
vb
function set_secondaryDNS(ByVal newval As String) As Integer
cs
int set_secondaryDNS(string newval)
java
int set_secondaryDNS(String newval)
uwp
async Task<int> set_secondaryDNS(string newval)
py
def set_secondaryDNS(newval)
php
function set_secondaryDNS($newval)
es
function set_secondaryDNS(newval)
cmd
YNetwork target set_secondaryDNS newval

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 :

newvalune chaîne de caractères représentant l'adresse IP du serveur de nom secondaire que le module doit utiliser

Retourne :

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

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

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.

js
function set_userData(data)
cpp
void set_userData(void* data)
m
-(void) setUserData: (id) data
pas
procedure set_userData(data: Tobject)
vb
procedure set_userData(ByVal data As Object)
cs
void set_userData(object data)
java
void set_userData(Object data)
py
def set_userData(data)
php
function set_userData($data)
es
function set_userData(data)

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

Paramètres :

dataobjet quelconque à mémoriser

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.

js
function set_userPassword(newval)
cpp
int set_userPassword(const string& newval)
m
-(int) setUserPassword: (NSString*) newval
pas
function set_userPassword(newval: string): integer
vb
function set_userPassword(ByVal newval As String) As Integer
cs
int set_userPassword(string newval)
java
int set_userPassword(String newval)
uwp
async Task<int> set_userPassword(string newval)
py
def set_userPassword(newval)
php
function set_userPassword($newval)
es
function set_userPassword(newval)
cmd
YNetwork target set_userPassword newval

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 :

newvalune chaîne de caractères représentant le mode de passe pour l'utilisateur "user", qui devient alors instantanément nécessaire pour tout accès au module

Retourne :

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

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

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.

js
function set_wwwWatchdogDelay(newval)
cpp
int set_wwwWatchdogDelay(int newval)
m
-(int) setWwwWatchdogDelay: (int) newval
pas
function set_wwwWatchdogDelay(newval: LongInt): integer
vb
function set_wwwWatchdogDelay(ByVal newval As Integer) As Integer
cs
int set_wwwWatchdogDelay(int newval)
java
int set_wwwWatchdogDelay(int newval)
uwp
async Task<int> set_wwwWatchdogDelay(int newval)
py
def set_wwwWatchdogDelay(newval)
php
function set_wwwWatchdogDelay($newval)
es
function set_wwwWatchdogDelay(newval)
cmd
YNetwork target set_wwwWatchdogDelay newval

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.

Paramètres :

newvalun 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

Retourne :

YAPI_SUCCESS si 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.

js
function triggerCallback()
cpp
int triggerCallback()
m
-(int) triggerCallback
pas
function triggerCallback(): LongInt
vb
function triggerCallback() As Integer
cs
int triggerCallback()
java
int triggerCallback()
uwp
async Task<int> triggerCallback()
py
def triggerCallback()
php
function triggerCallback()
es
function triggerCallback()
cmd
YNetwork target triggerCallback

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.

js
function unmuteValueCallbacks()
cpp
int unmuteValueCallbacks()
m
-(int) unmuteValueCallbacks
pas
function unmuteValueCallbacks(): LongInt
vb
function unmuteValueCallbacks() As Integer
cs
int unmuteValueCallbacks()
java
int unmuteValueCallbacks()
uwp
async Task<int> unmuteValueCallbacks()
py
def unmuteValueCallbacks()
php
function unmuteValueCallbacks()
es
function unmuteValueCallbacks()
cmd
YNetwork target unmuteValueCallbacks

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.

js
function useDHCP(fallbackIpAddr, fallbackSubnetMaskLen, fallbackRouter)
cpp
int useDHCP(string fallbackIpAddr,
  int fallbackSubnetMaskLen,
  string fallbackRouter)
m
-(int) useDHCP: (NSString*) fallbackIpAddr
  : (int) fallbackSubnetMaskLen
  : (NSString*) fallbackRouter
pas
function useDHCP(fallbackIpAddr: string,
  fallbackSubnetMaskLen: LongInt,
  fallbackRouter: string): LongInt
vb
function useDHCP() As Integer
cs
int useDHCP(string fallbackIpAddr,
  int fallbackSubnetMaskLen,
  string fallbackRouter)
java
int useDHCP(String fallbackIpAddr,
  int fallbackSubnetMaskLen,
  String fallbackRouter)
uwp
async Task<int> useDHCP(string fallbackIpAddr,
  int fallbackSubnetMaskLen,
  string fallbackRouter)
py
def useDHCP(fallbackIpAddr, fallbackSubnetMaskLen, fallbackRouter)
php
function useDHCP($fallbackIpAddr, $fallbackSubnetMaskLen, $fallbackRouter)
es
function useDHCP(fallbackIpAddr, fallbackSubnetMaskLen, fallbackRouter)
cmd
YNetwork target useDHCP fallbackIpAddr fallbackSubnetMaskLen fallbackRouter

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 :

fallbackIpAddradresse IP à utiliser si aucun serveur DHCP ne répond
fallbackSubnetMaskLenlongueur du masque de sous-réseau à utiliser si aucun serveur DHCP ne répond. Par exemple, la valeur 24 représente 255.255.255.0.
fallbackRouteradresse de la passerelle à utiliser si aucun serveur DHCP ne répond

Retourne :

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

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

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.

js
function useDHCPauto()
cpp
int useDHCPauto()
m
-(int) useDHCPauto
pas
function useDHCPauto(): LongInt
vb
function useDHCPauto() As Integer
cs
int useDHCPauto()
java
int useDHCPauto()
uwp
async Task<int> useDHCPauto()
py
def useDHCPauto()
php
function useDHCPauto()
es
function useDHCPauto()
cmd
YNetwork target useDHCPauto

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

js
function useStaticIP(ipAddress, subnetMaskLen, router)
cpp
int useStaticIP(string ipAddress, int subnetMaskLen, string router)
m
-(int) useStaticIP: (NSString*) ipAddress
  : (int) subnetMaskLen
  : (NSString*) router
pas
function useStaticIP(ipAddress: string,
  subnetMaskLen: LongInt,
  router: string): LongInt
vb
function useStaticIP() As Integer
cs
int useStaticIP(string ipAddress,
  int subnetMaskLen,
  string router)
java
int useStaticIP(String ipAddress,
  int subnetMaskLen,
  String router)
uwp
async Task<int> useStaticIP(string ipAddress,
  int subnetMaskLen,
  string router)
py
def useStaticIP(ipAddress, subnetMaskLen, router)
php
function useStaticIP($ipAddress, $subnetMaskLen, $router)
es
function useStaticIP(ipAddress, subnetMaskLen, router)
cmd
YNetwork target useStaticIP ipAddress subnetMaskLen router

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

Paramètres :

ipAddressadresse IP à utiliser par le module
subnetMaskLenlongueur du masque de sous-réseau à utiliser. Par exemple, la valeur 24 représente 255.255.255.0.
routeradresse IP de la passerelle à utiliser ("default gateway")

Retourne :

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

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

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.

js
function wait_async(callback, context)
es
function wait_async(callback, context)

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

Paramètres :

callbackfonction de callback qui sera appelée dès que toutes les commandes en cours d'exécution sur le module seront terminées La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné.
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

rien du tout.

10.3. Interface de la fonction Files

L'interface de stockage de fichiers permet de stocker des fichiers sur certains modules, par exemple pour personnaliser un service web (dans le cas d'un module connecté au réseau) ou pour ajouter un police de caractères (dans le cas d'un module d'affichage).

Pour utiliser les fonctions décrites ici, vous devez inclure:

js
<script type='text/javascript' src='yocto_files.js'></script>
cpp
#include "yocto_files.h"
m
#import "yocto_files.h"
pas
uses yocto_files;
vb
yocto_files.vb
cs
yocto_files.cs
java
import com.yoctopuce.YoctoAPI.YFiles;
uwp
import com.yoctopuce.YoctoAPI.YFiles;
py
from yocto_files import *
php
require_once('yocto_files.php');
es
in HTML: <script src="../../lib/yocto_files.js"></script>
in node.js: require('yoctolib-es2017/yocto_files.js');
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_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→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().

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

js
function yFindFiles(func)
cpp
YFiles* yFindFiles(string func)
m
+(YFiles*) FindFiles: (NSString*) func
pas
function yFindFiles(func: string): TYFiles
vb
function yFindFiles(ByVal func As String) As YFiles
cs
YFiles FindFiles(string func)
java
YFiles FindFiles(String func)
uwp
YFiles FindFiles(string func)
py
def FindFiles(func)
php
function yFindFiles($func)
es
function FindFiles(func)

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

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 :

funcune chaîne de caractères qui référence le système de fichier sans ambiguïté

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.

java
YFiles FindFilesInContext(YAPIContext yctx, String func)
uwp
YFiles FindFilesInContext(YAPIContext yctx, string func)
es
function FindFilesInContext(yctx, func)

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

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 :

yctxun contexte YAPI
funcune chaîne de caractères qui référence le système de fichier sans ambiguïté

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.

js
function yFirstFiles()
cpp
YFiles* yFirstFiles()
m
+(YFiles*) FirstFiles
pas
function yFirstFiles(): TYFiles
vb
function yFirstFiles() As YFiles
cs
YFiles FirstFiles()
java
YFiles FirstFiles()
uwp
YFiles FirstFiles()
py
def FirstFiles()
php
function yFirstFiles()
es
function FirstFiles()

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.

java
YFiles FirstFilesInContext(YAPIContext yctx)
uwp
YFiles FirstFilesInContext(YAPIContext yctx)
es
function FirstFilesInContext(yctx)

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

Paramètres :

yctxun contexte YAPI.

Retourne :

un pointeur sur un objet YFiles, correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systè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.

js
function clearCache()
cpp
void clearCache()
m
-(void) clearCache
pas
procedure clearCache()
vb
procedure clearCache()
cs
void clearCache()
java
void clearCache()
py
def clearCache()
php
function clearCache()
es
function clearCache()

Invalide le cache des valeurs courantes du système de fichier. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module.

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.

js
function describe()
cpp
string describe()
m
-(NSString*) describe
pas
function describe(): string
vb
function describe() As String
cs
string describe()
java
String describe()
py
def describe()
php
function describe()
es
function describe()

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.

js
function download(pathname)
cpp
string download(string pathname)
m
-(NSMutableData*) download: (NSString*) pathname
pas
function download(pathname: string): TByteArray
vb
function download() As Byte
cs
byte[] download(string pathname)
java
byte[] download(String pathname)
uwp
async Task<byte[]> download(string pathname)
py
def download(pathname)
php
function download($pathname)
es
function download(pathname)
cmd
YFiles target download pathname

Paramètres :

pathnamenom complet du fichier à charger, y compris le chemin d'accès.

Retourne :

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

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

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.

js
function download_async(pathname, callback, context)

Paramètres :

pathnamenom complet du fichier à charger, y compris le chemin d'accès.
callbackfonction fournie par l'utilisateur, qui sera appelée lorsque la suite du chargement aura été effectué. La fonction callback doit prendre trois arguments: - la variable de contexte à disposition de l'utilisateur - l'objet YFiles dont la méthode download_async a été appelée - le contenu du fichier chargé sous forme d'objet binaire
contextvariable de contexte à disposition de l'utilisateur

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.

js
function fileExist(filename)
cpp
bool fileExist(string filename)
m
-(bool) fileExist: (NSString*) filename
pas
function fileExist(filename: string): boolean
vb
function fileExist() As Boolean
cs
bool fileExist(string filename)
java
boolean fileExist(String filename)
uwp
async Task<bool> fileExist(string filename)
py
def fileExist(filename)
php
function fileExist($filename)
es
function fileExist(filename)
cmd
YFiles target fileExist filename

Paramètres :

filenamele nom de fichier.

Retourne :

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

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

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

js
function format_fs()
cpp
int format_fs()
m
-(int) format_fs
pas
function format_fs(): LongInt
vb
function format_fs() As Integer
cs
int format_fs()
java
int format_fs()
uwp
async Task<int> format_fs()
py
def format_fs()
php
function format_fs()
es
function format_fs()
cmd
YFiles target format_fs

entièrement vide. Tous les fichiers précédemment chargés sont irrémédiablement effacés.

Retourne :

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

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

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

js
function get_advertisedValue()
cpp
string get_advertisedValue()
m
-(NSString*) advertisedValue
pas
function get_advertisedValue(): string
vb
function get_advertisedValue() As String
cs
string get_advertisedValue()
java
String get_advertisedValue()
uwp
async Task<string> get_advertisedValue()
py
def get_advertisedValue()
php
function get_advertisedValue()
es
function get_advertisedValue()
cmd
YFiles target get_advertisedValue

Retourne :

une chaîne de caractères représentant la valeur courante du système de fichier (pas plus de 6 caractères).

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

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.

js
function get_errorMessage()
cpp
string get_errorMessage()
m
-(NSString*) errorMessage
pas
function get_errorMessage(): string
vb
function get_errorMessage() As String
cs
string get_errorMessage()
java
String get_errorMessage()
py
def get_errorMessage()
php
function get_errorMessage()
es
function get_errorMessage()

Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions.

Retourne :

une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.

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

js
function get_errorType()
cpp
YRETCODE get_errorType()
pas
function get_errorType(): YRETCODE
vb
function get_errorType() As YRETCODE
cs
YRETCODE get_errorType()
java
int get_errorType()
py
def get_errorType()
php
function get_errorType()
es
function get_errorType()

Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions.

Retourne :

un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.

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.

js
function get_filesCount()
cpp
int get_filesCount()
m
-(int) filesCount
pas
function get_filesCount(): LongInt
vb
function get_filesCount() As Integer
cs
int get_filesCount()
java
int get_filesCount()
uwp
async Task<int> get_filesCount()
py
def get_filesCount()
php
function get_filesCount()
es
function get_filesCount()
cmd
YFiles target get_filesCount

Retourne :

un entier représentant le nombre de fichiers présents dans le système de fichier

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

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.

js
function get_freeSpace()
cpp
int get_freeSpace()
m
-(int) freeSpace
pas
function get_freeSpace(): LongInt
vb
function get_freeSpace() As Integer
cs
int get_freeSpace()
java
int get_freeSpace()
uwp
async Task<int> get_freeSpace()
py
def get_freeSpace()
php
function get_freeSpace()
es
function get_freeSpace()
cmd
YFiles target get_freeSpace

Retourne :

un entier représentant l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets

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

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.

js
function get_friendlyName()
cpp
string get_friendlyName()
m
-(NSString*) friendlyName
cs
string get_friendlyName()
java
String get_friendlyName()
py
def get_friendlyName()
php
function get_friendlyName()
es
function get_friendlyName()

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.

js
function get_functionDescriptor()
cpp
YFUN_DESCR get_functionDescriptor()
m
-(YFUN_DESCR) functionDescriptor
pas
function get_functionDescriptor(): YFUN_DESCR
vb
function get_functionDescriptor() As YFUN_DESCR
cs
YFUN_DESCR get_functionDescriptor()
java
String get_functionDescriptor()
py
def get_functionDescriptor()
php
function get_functionDescriptor()
es
function get_functionDescriptor()

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.

js
function get_functionId()
cpp
string get_functionId()
m
-(NSString*) functionId
vb
function get_functionId() As String
cs
string get_functionId()
java
String get_functionId()
py
def get_functionId()
php
function get_functionId()
es
function get_functionId()

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.

js
function get_hardwareId()
cpp
string get_hardwareId()
m
-(NSString*) hardwareId
vb
function get_hardwareId() As String
cs
string get_hardwareId()
java
String get_hardwareId()
py
def get_hardwareId()
php
function get_hardwareId()
es
function get_hardwareId()

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.

js
function get_list(pattern)
cpp
vector<YFileRecord> get_list(string pattern)
m
-(NSMutableArray*) list: (NSString*) pattern
pas
function get_list(pattern: string): TYFileRecordArray
vb
function get_list() As List
cs
List<YFileRecord> get_list(string pattern)
java
ArrayList<YFileRecord> get_list(String pattern)
uwp
async Task<List<YFileRecord>> get_list(string pattern)
py
def get_list(pattern)
php
function get_list($pattern)
es
function get_list(pattern)
cmd
YFiles target get_list pattern

Paramètres :

patternun filtre optionel sur les noms de fichiers retournés, pouvant contenir des astérisques et des points d'interrogations comme jokers. Si le pattern fourni est vide, tous les fichiers sont retournés.

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.

js
function get_logicalName()
cpp
string get_logicalName()
m
-(NSString*) logicalName
pas
function get_logicalName(): string
vb
function get_logicalName() As String
cs
string get_logicalName()
java
String get_logicalName()
uwp
async Task<string> get_logicalName()
py
def get_logicalName()
php
function get_logicalName()
es
function get_logicalName()
cmd
YFiles target get_logicalName

Retourne :

une chaîne de caractères représentant le nom logique du système de fichier.

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

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.

js
function get_module()
cpp
YModule * get_module()
m
-(YModule*) module
pas
function get_module(): TYModule
vb
function get_module() As YModule
cs
YModule get_module()
java
YModule get_module()
py
def get_module()
php
function get_module()
es
function get_module()

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.

js
function get_module_async(callback, context)

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 :

callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et l'instance demandée de YModule
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

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

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.

js
function get_userData()
cpp
void * get_userData()
m
-(id) userData
pas
function get_userData(): Tobject
vb
function get_userData() As Object
cs
object get_userData()
java
Object get_userData()
py
def get_userData()
php
function get_userData()
es
function get_userData()

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

Retourne :

l'objet stocké précédemment par l'appelant.

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.

js
function isOnline()
cpp
bool isOnline()
m
-(BOOL) isOnline
pas
function isOnline(): boolean
vb
function isOnline() As Boolean
cs
bool isOnline()
java
boolean isOnline()
py
def isOnline()
php
function isOnline()
es
function isOnline()

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.

js
function isOnline_async(callback, context)

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 :

callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et le résultat booléen
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

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

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.

js
function load(msValidity)
cpp
YRETCODE load(int msValidity)
m
-(YRETCODE) load: (int) msValidity
pas
function load(msValidity: integer): YRETCODE
vb
function load(ByVal msValidity As Integer) As YRETCODE
cs
YRETCODE load(ulong msValidity)
java
int load(long msValidity)
py
def load(msValidity)
php
function load($msValidity)
es
function load(msValidity)

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 :

msValidityun entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes

Retourne :

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

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

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.

js
function loadAttribute(attrName)
cpp
string loadAttribute(string attrName)
m
-(NSString*) loadAttribute: (NSString*) attrName
pas
function loadAttribute(attrName: string): string
vb
function loadAttribute() As String
cs
string loadAttribute(string attrName)
java
String loadAttribute(String attrName)
uwp
async Task<string> loadAttribute(string attrName)
py
def loadAttribute(attrName)
php
function loadAttribute($attrName)
es
function loadAttribute(attrName)

Paramètres :

attrNamele nom de l'attribut désiré

Retourne :

une chaîne de caractères représentant la valeur actuelle de l'attribut.

En cas d'erreur, déclenche une exception ou retourne un chaîne vide.

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.

js
function load_async(msValidity, callback, context)

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 :

msValidityun entier correspondant à la durée de validité attribuée aux les paramètres chargés, en millisecondes
callbackfonction de callback qui sera appelée dès que le résultat sera connu. La fonction callback reçoit trois arguments: le contexte fourni par l'appelant, l'objet fonction concerné et le code d'erreur (ou YAPI_SUCCESS)
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

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.

js
function muteValueCallbacks()
cpp
int muteValueCallbacks()
m
-(int) muteValueCallbacks
pas
function muteValueCallbacks(): LongInt
vb
function muteValueCallbacks() As Integer
cs
int muteValueCallbacks()
java
int muteValueCallbacks()
uwp
async Task<int> muteValueCallbacks()
py
def muteValueCallbacks()
php
function muteValueCallbacks()
es
function muteValueCallbacks()
cmd
YFiles target muteValueCallbacks

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

js
function nextFiles()
cpp
YFiles * nextFiles()
m
-(YFiles*) nextFiles
pas
function nextFiles(): TYFiles
vb
function nextFiles() As YFiles
cs
YFiles nextFiles()
java
YFiles nextFiles()
uwp
YFiles nextFiles()
py
def nextFiles()
php
function nextFiles()
es
function nextFiles()

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.

js
function registerValueCallback(callback)
cpp
int registerValueCallback(YFilesValueCallback callback)
m
-(int) registerValueCallback: (YFilesValueCallback) callback
pas
function registerValueCallback(callback: TYFilesValueCallback): LongInt
vb
function registerValueCallback() As Integer
cs
int registerValueCallback(ValueCallback callback)
java
int registerValueCallback(UpdateCallback callback)
uwp
async Task<int> registerValueCallback(ValueCallback callback)
py
def registerValueCallback(callback)
php
function registerValueCallback($callback)
es
function registerValueCallback(callback)

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 :

callbackla fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée.

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.

js
function remove(pathname)
cpp
int remove(string pathname)
m
-(int) remove: (NSString*) pathname
pas
function remove(pathname: string): LongInt
vb
function remove() As Integer
cs
int remove(string pathname)
java
int remove(String pathname)
uwp
async Task<int> remove(string pathname)
py
def remove(pathname)
php
function remove($pathname)
es
function remove(pathname)
cmd
YFiles target remove pathname

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 :

pathnamenom complet du fichier, y compris le chemin d'accès.

Retourne :

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

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

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.

js
function set_logicalName(newval)
cpp
int set_logicalName(const string& newval)
m
-(int) setLogicalName: (NSString*) newval
pas
function set_logicalName(newval: string): integer
vb
function set_logicalName(ByVal newval As String) As Integer
cs
int set_logicalName(string newval)
java
int set_logicalName(String newval)
uwp
async Task<int> set_logicalName(string newval)
py
def set_logicalName(newval)
php
function set_logicalName($newval)
es
function set_logicalName(newval)
cmd
YFiles target set_logicalName newval

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 :

newvalune chaîne de caractères représentant le nom logique du système de fichier.

Retourne :

YAPI_SUCCESS si l'appel se déroule sans erreur.

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

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.

js
function set_userData(data)
cpp
void set_userData(void* data)
m
-(void) setUserData: (id) data
pas
procedure set_userData(data: Tobject)
vb
procedure set_userData(ByVal data As Object)
cs
void set_userData(object data)
java
void set_userData(Object data)
py
def set_userData(data)
php
function set_userData($data)
es
function set_userData(data)

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

Paramètres :

dataobjet quelconque à mémoriser

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.

js
function unmuteValueCallbacks()
cpp
int unmuteValueCallbacks()
m
-(int) unmuteValueCallbacks
pas
function unmuteValueCallbacks(): LongInt
vb
function unmuteValueCallbacks() As Integer
cs
int unmuteValueCallbacks()
java
int unmuteValueCallbacks()
uwp
async Task<int> unmuteValueCallbacks()
py
def unmuteValueCallbacks()
php
function unmuteValueCallbacks()
es
function unmuteValueCallbacks()
cmd
YFiles target unmuteValueCallbacks

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

js
function upload(pathname, content)
cpp
int upload(string pathname, string content)
m
-(int) upload: (NSString*) pathname
  : (NSData*) content
pas
function upload(pathname: string, content: TByteArray): LongInt
vb
procedure upload()
cs
int upload(string pathname)
java
int upload(String pathname, byte[] content)
uwp
async Task<int> upload(string pathname)
py
def upload(pathname, content)
php
function upload($pathname, $content)
es
function upload(pathname, content)
cmd
YFiles target upload pathname content

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

Paramètres :

pathnamenom complet du fichier, y compris le chemin d'accès.
contentcontenu du fichier à télécharger

Retourne :

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

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

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.

js
function wait_async(callback, context)
es
function wait_async(callback, context)

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

Paramètres :

callbackfonction de callback qui sera appelée dès que toutes les commandes en cours d'exécution sur le module seront terminées La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné.
contextcontexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne :

rien du tout.

11. Caractéristiques

Vous trouverez résumées ci dessous les principales caractéristiques techniques de votre module YoctoHub-Ethernet

Epaisseur22 mm
Largeur58 mm
Longueur60 mm
Poids34 g
Connecteur USBmicro-B
Canaux3 ports
Courant Max (continu)2 A
Consommation USB130 mA
Sytème d'exploitation supportésWindows, Linux (Intel + ARM), Mac OS X, Android
Connection réseauFast-Ethernet
DriversFonctionne sans driver
API / SDK / Librairie (USB+TCP)C++, Objective-C, C#, VB .NET, Delphi, Python, Java/Android
API / SDK / Librairie (seul.TCP)Javascript, Node.js, PHP, Java
RoHSoui
USB Vendor ID0x24E0
USB Device ID0x000E
Boîter recommandéYoctoBox-HubEth-Transp

12. Index

A
API
C
callbackLogin
clearCache
D
describe
download
download_async
F
fileExist
FindFiles
FindFilesInContext
FindHubPort
FindHubPortInContext
FindNetwork
FindNetworkInContext
FirstFiles
FirstFilesInContext
FirstHubPort
FirstHubPortInContext
FirstNetwork
FirstNetworkInContext
format_fs
G
get_adminPassword
get_advertisedValue
get_baudRate
get_callbackCredentials
get_callbackEncoding
get_callbackInitialDelay
get_callbackMaxDelay
get_callbackMethod
get_callbackMinDelay
get_callbackSchedule
get_callbackUrl
get_defaultPage
get_discoverable
get_enabled
get_errorMessage
get_errorType
get_filesCount
get_freeSpace
get_friendlyName
get_functionDescriptor
get_functionId
get_hardwareId
get_httpPort
get_ipAddress
get_ipConfig
get_list
get_logicalName
get_macAddress
get_module
get_module_async
get_ntpServer
get_poeCurrent
get_portState
get_primaryDNS
get_readiness
get_router
get_secondaryDNS
get_subnetMask
get_userData
get_userPassword
get_wwwWatchdogDelay
H
HTTPCallbacks
I
isOnline
isOnline_async
L
load
load_async
loadAttribute
M
muteValueCallbacks
N
nextFiles
nextHubPort
nextNetwork
P
ping
R
registerValueCallback
remove
S
set_adminPassword
set_callbackCredentials
set_callbackEncoding
set_callbackInitialDelay
set_callbackMaxDelay
set_callbackMethod
set_callbackMinDelay
set_callbackSchedule
set_callbackUrl
set_defaultPage
set_discoverable
set_enabled
set_httpPort
set_logicalName
set_ntpServer
set_periodicCallbackSchedule
set_primaryDNS
set_secondaryDNS
set_userData
set_userPassword
set_wwwWatchdogDelay
T
techspec
triggerCallback
U
unmuteValueCallbacks
upload
useDHCP
useDHCPauto
useStaticIP
W
wait_async
Y
YFiles
YHubPort
YNetwork


  1. http://www.yoctopuce.com/FR/virtualhub.php
  2. support@yoctopuce.com
  3. court-court-court long-long-long court-court-court
  4. support@yoctopuce.com
  5. Le Micro-USB-Hub fabriqué par Yoctopuce est un hub USB standard et ne fonctionnera pas avec le YoctoHub-Ethernet.
  6. www.yoctopuce.com/FR/products/yoctohub-shield
  7. http://www.yoctopuce.com/FR/virtualhub.php
  8. http://www.yoctopuce.com/FR/libraries.php
  9. Le YoctoHub-Ethernet extrait la puissance du câble Ethernet à l'aide d'un composant AG9705M, qui implémente les deux alternatives A et B décrites dans le standard 802.3af. L'isolation galvanique entre le module et le réseau supporte 1500V.
  10. http://www.yoctopuce.com/FR/products/accessoires-et-connectique/fix-2-5mm
  11. http://www.yoctopuce.com/FR/products/accessoires-et-connectique/board2board-127
  12. L'interface du YoctoHub-Ethernet est régulièrement testée sur Internet Explorer, Firefox, Chrome et Safari. Elle ne fonctionne pas avec Opéra
  13. Vous n'êtes pas obligé d'avoir un YoctoHub-Ethernet plus récent qu'un module pour le tester/configurer: tous les éléments spécifiques aux interfaces des modules sont stockés dans la ROM des modules, et non pas dans le YoctoHub-Ethernet.
  14. Ne faites jamais confiance à des gens qui vous disent que leur logiciel n'a pas de bug :-)
  15. www.yoctopuce.com
  16. A condition qu'elle ait réussi à accéder au site Web de Yoctopuce
  17. http://www.yoctopuce.com/FR/virtualhub.php
  18. http://www.yoctopuce.com/FR/article/utiliser-emoncms-sur-un-serveur-prive
  19. www.thingspeak.com
  20. http://www.yoctopuce.com/FR/article/alternatives-a-cosm-pour-enregistrer-des-mesures
  21. http://www.yoctopuce.com/FR/article/utiliser-les-capteurs-yoctopuce-avec-influxdb-et-grafana
  22. Les valeurs notifiées sont celles que vous voyez quand vous cliquez sur show functions dans l'interface principale du YoctoHub-Ethernet .
Yoctopuce, get your stuff connected.