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

Yoctopuce YoctoHub-Ethernet Mode D'emploi

Masquer les pouces
Table des Matières

Publicité

Liens rapides

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

Publicité

Table des Matières
loading

Manuels Connexes pour Yoctopuce YoctoHub-Ethernet

Sommaire des Matières pour Yoctopuce YoctoHub-Ethernet

  • Page 1 YoctoHub-Ethernet Mode d'emploi...

  • Page 3: Table Des Matières

    Table des matières 1. Introduction ..........................2. Présentation ..........................2.1. Les éléments du YoctoHub-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 ............................
  • Page 4 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 ................

  • Page 5: Introduction

    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 Yoctopuce http://www.yoctopuce.com/FR/virtualhub.php...
  • Page 6 www.yoctopuce.com...

  • Page 7: Présentation

    11: >Port descendant 3 6: Connection dorsale 12: 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.
  • Page 8 USB directement dans les trous espacés de 1.27mm prévus à cet effet, près du connecteur. court-court-court long-long-long court-court-court support@yoctopuce.com Le Micro-USB-Hub fabriqué par Yoctopuce est un hub USB standard et ne fonctionnera pas avec le YoctoHub-Ethernet. www.yoctopuce.com/FR/products/yoctohub-shield www.yoctopuce.com...
  • Page 9 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) à...
  • Page 10 www.yoctopuce.com...

  • Page 11: Premiers Pas

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

  • Page 12: Configuration Manuelle

    YoctoHub-Ethernet détecté sur le réseau par un Mac 3.2. Configuration manuelle Vous pouvez configurer votre YoctoHub-Ethernet via son port de contrôle USB, en utilisant le VirtualHub Lancez un VirtualHub sur votre ordinateur favori et raccordez votre ordinateur au port power / control port du YoctoHub-Ethernet.
  • Page 13 3. Premiers pas 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).
  • Page 14 3. Premiers pas 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: •...

  • Page 15: Configuration Automatisée

    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...
  • Page 16 Ethernet va tenter de négocier 9W (1.8A) auprès de l'équipement qui fourni le courant sur le câble. 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.
  • Page 17 Alternativement, vous pouvez connecter vos modules de manière plus compacte à l'aide de câbles au pas 1.27mm: tous les modules Yoctopuce disposent en effet de contacts à cet effet. Vous pouvez soit souder des connecteurs 1.27mm sur les modules et utiliser des câbles avec connecteurs 1.27mm, soit souder directement du câble plat au pas 1.27mm.
  • Page 18 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é...

  • Page 19: Montage

    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.

  • Page 20: Fixation D'un Sous-Module

    Prenez garde à bien monter le module sur la face prévue, comme illustré ci-dessus. Les 5 trous du module doivent correspondre aux 5 trous du YoctoHub-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é...

  • Page 21: Utilisation Du Yoctohub-Ethernet

    Vous pouvez faire la même manipulation en appuyant sur le Yocto-bouton d'un module connecté. 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...

  • Page 22: Test Des Modules

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

  • Page 23: Upgrades Des Firmwares

    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.
  • Page 24 www.yoctopuce.com...

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

    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.

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

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

  • Page 27: Effacement Des Mots De Passe

    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 VirtualHub installé...
  • Page 28 www.yoctopuce.com...

  • Page 29: Interactions Avec L'extérieur

    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.

  • Page 30: Emoncms

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

  • Page 31: Influxdb

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

  • Page 32: 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).
  • Page 33 Voici un script PHP qui vous permettra de visualiser le contenu des données postées par le callback, suivi du résultat dans la fenêtre de debug. <?php Print(Date('H:i:s')."\r\n"); foreach ($_POST as $key=>$value) { Print("$key=$value\r\n"); ?> Le résultat du test de callback avec un Yocto-PowerRelay et un Yocto-Temperature. www.yoctopuce.com...
  • Page 34 www.yoctopuce.com...

  • Page 35: Programmation

    // l'adresse IP du hub est 192.168.0.10 8.2. Contrôle du YoctoHub-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.
  • Page 36 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.

  • Page 37: Personnalisation De L'interface Web

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

  • Page 38: Limitations

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

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

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

  • Page 40: La Classe Yhubport

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

  • Page 88: La Classe Ynetwork

    10. Référence de l'API de haut niveau 10.2. La classe YNetwork Interface pour intéragir avec les interfaces réseau, disponibles par exemple dans le YoctoHub-Ethernet, le YoctoHub-GSM-3G-NA, le YoctoHub-GSM-4G et le YoctoHub-Wireless-n La classe permet de contrôler les paramètres TCP/IP des modules Yoctopuce dotés d'une YNetwork interface réseau.
  • Page 89 SERIAL.FUNCTIONID network→HttpPort [modifiable] Port TCP utilisé pour l'interface Web du hub. network→IpAddress [lecture seule] Adresse IP utilisée par le module Yoctopuce. network→IsOnline [lecture seule] Vérifie si le module hébergeant la fonction est joignable, sans déclencher d'erreur. network→LogicalName [modifiable] Nom logique de la fonction.
  • Page 90 Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau. network→get_errorType() Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'interface réseau. network→get_friendlyName() Retourne un identifiant global de l'interface réseau au format NOM_MODULE.NOM_FONCTION network→get_functionDescriptor() www.yoctopuce.com...
  • Page 91 Retourne l'identifiant matériel unique de l'interface réseau au format network→get_httpPort() Retourne le port TCP utilisé pour l'interface Web du hub. network→get_ipAddress() Retourne l'adresse IP utilisée par le module Yoctopuce. network→get_ipConfig() Retourne la configuration IP de l'interface réseau. network→get_logicalName() Retourne le nom logique de l'interface réseau.
  • Page 92 Modifie la page HTML par défaut du hub. network→set_discoverable(newval) Modifie l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour). network→set_httpPort(newval) Modifie le port TCP utilisé pour l'interface Web du hub. network→set_logicalName(newval) www.yoctopuce.com...
  • Page 93 Modifie la configuration de l'interface réseau pour utiliser une adresse IP assignée manuellement (adresse IP statique). network→wait_async(callback, context) Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre. www.yoctopuce.com...
  • Page 94 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence l'interface réseau sans ambiguïté, par exemple YHUBETH1.network Retourne : YNetwork un objet de classe qui permet ensuite de contrôler l'interface réseau. www.yoctopuce.com...
  • Page 95 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence l'interface réseau sans ambiguïté, par exemple YHUBETH1.network Retourne : YNetwork un objet de classe qui permet ensuite de contrôler l'interface réseau. www.yoctopuce.com...
  • Page 96 Utiliser la fonction pour itérer sur les autres interfaces réseau. YNetwork.nextNetwork() Retourne : un pointeur sur un objet YNetwork , correspondant à la première interface réseau accessible en ligne, ou null si il n'y a pas de interfaces réseau disponibles. www.yoctopuce.com...
  • Page 97 YNetwork.nextNetwork() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YNetwork , correspondant à la première interface réseau accessible en ligne, ou null si il n'y a pas de interfaces réseau disponibles. www.yoctopuce.com...
  • Page 98 Chaque chaîne retournée peut être passée en argument à la méthode YNetwork.FindNetwork pour obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
  • Page 99 Modifiable. Modifie le mot de passe pour l'utilisateur "admin", qui devient alors instantanément nécessaire pour toute altération de l'état du module. Si la valeur fournie est une chaîne vide, plus aucun mot de passe n'est nécessaire. N'oubliez pas d'appeler la méthode du module si le saveToFlash() réglage doit être préservé. www.yoctopuce.com...
  • Page 100 10. Référence de l'API de haut niveau YNetwork network→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 101 . Pour une autorisation de type Digest, le hash est le MD5 de la chaîne username:password . Pour une utilisation simplifiée, utilisez la fonction username:realm:password callbackLogin N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 102 10. Référence de l'API de haut niveau YNetwork network→CallbackEncoding Encodage à utiliser pour représenter les valeurs notifiées par callback. int CallbackEncoding Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 103 10. Référence de l'API de haut niveau YNetwork network→CallbackInitialDelay Attente initiale avant la première notification par callback, en secondes. int CallbackInitialDelay Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 104 Attente entre deux callback HTTP lorsque rien n'est à signaler, en secondes. int CallbackMaxDelay Modifiable. Modifie l'attente entre deux callback HTTP lorsque rien n'est à signaler. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 105 10. Référence de l'API de haut niveau YNetwork network→CallbackMethod Méthode HTTP à utiliser pour signaler les changements d'état par callback. int CallbackMethod Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 106 10. Référence de l'API de haut niveau YNetwork network→CallbackMinDelay Attente minimale entre deux callbacks HTTP, en secondes. int CallbackMinDelay Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 107 10. Référence de l'API de haut niveau YNetwork network→CallbackSchedule Planification des callbacks HTTP, sous forme de chaîne de caractères. string CallbackSchedule Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 108 10. Référence de l'API de haut niveau YNetwork network→CallbackUrl Adresse (URL) de callback à notifier lors de changement d'état significatifs. string CallbackUrl Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 109 Il est possible de changer cet page pour un fichier qui a été uploadé sur le hub. Attention, la taille maximale permise pour le nom de fichier est de 15 caractères. Si vous changez ce paramètre, n'oubliez pas d'appeler la méthode du module si le réglage doit être saveToFlash() préservé. www.yoctopuce.com...
  • Page 110 10. Référence de l'API de haut niveau YNetwork network→Discoverable état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour). int Discoverable Modifiable. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé. www.yoctopuce.com...
  • Page 111 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
  • Page 112 10. Référence de l'API de haut niveau YNetwork network→FunctionId Identifiant matériel de l'interface réseau, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 113 10. Référence de l'API de haut niveau YNetwork network→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 114 Modifiable. La valeur par défaut est le port 80, utilisé habituellement pat tous les serveurs web. Indépendamment de la valeur de ce paramètre, le hub répond toujours au port 4444, qui est utilisé par défaut par la librairie de programmation Yoctopuce. Si vous changez ce paramètre, n'oubliez pas d'appeler la méthode du module si le réglage doit être préservé.
  • Page 115 10. Référence de l'API de haut niveau YNetwork network→IpAddress Adresse IP utilisée par le module Yoctopuce. string IpAddress Il peut s'agir d'une adresse configurée statiquement, ou d'une adresse reçue par un serveur DHCP. www.yoctopuce.com...
  • Page 116 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
  • Page 117 10. Référence de l'API de haut niveau YNetwork network→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 118 10. Référence de l'API de haut niveau YNetwork network→MacAddress Adresse MAC de l'interface réseau, unique pour chaque module. string MacAddress L'adresse MAC est aussi présente sur un autocollant sur le module, représentée en chiffres et en code- barres. www.yoctopuce.com...
  • Page 119 Modifiable. Modifie l'adresse IP du serveur NTP que le module doit utiliser. Utilisez une chaine vide pour restaurer l'adresse pré-configurée en usine. N'oubliez pas d'appeler la méthode et de redémarrer le module pour que le paramètre soit appliqué. saveToFlash() www.yoctopuce.com...
  • Page 120 Adresse IP du serveur de noms primaire que le module doit utiliser. string PrimaryDNS Modifiable. En mode DHCP, si une valeur est spécifiée, elle remplacera celle reçue du serveur DHCP. N'oubliez pas d'appeler la méthode et de redémarrer le module pour que le saveToFlash() paramètre soit appliqué. www.yoctopuce.com...
  • Page 121 IP a été obtenue par DHCP. Le niveau 4 (DNS_4) est atteint lorsqu'un serveur DNS est joignable par le réseau. Le niveau 5 (WWW_5) est atteint lorsque la connectivité globale à internet est avérée par l'obtention de l'heure courante sur une serveur NTP. www.yoctopuce.com...
  • Page 122 Modifiable. Modifie l'adresse IP du serveur de nom secondaire que le module doit utiliser. En mode DHCP, si une valeur est spécifiée, elle remplacera celle reçue du serveur DHCP. N'oubliez pas d'appeler la méthode et de redémarrer le module pour que le paramètre soit saveToFlash() appliqué. www.yoctopuce.com...
  • Page 123 10. Référence de l'API de haut niveau YNetwork network→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 124 Modifiable. Modifie le mode de passe pour l'utilisateur "user", qui devient alors instantanément nécessaire pour tout accès au module. Si la valeur fournie est une chaîne vide, plus aucun mot de passe n'est nécessaire. N'oubliez pas d'appeler la méthode du module si le réglage saveToFlash() doit être préservé. www.yoctopuce.com...
  • Page 125 Une valeur nulle désactive le redémarrage automatique en cas de perte de connectivité WWW. Modifiable. Une valeur nulle désactive le redémarrage automatique en cas de perte de connectivité WWW. La plus petite durée non-nulle utilisable est 90 secondes. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 126 Paramètres : username nom d'utilisateur pour s'identifier au callback password mot de passe pour s'identifier au callback Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 127 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes de l'interface réseau. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 128 è r e s d é c r i v a n t l ' i n t e r f a c e r é s e a u ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 129 YNetwork target get_adminPassword Retourne : une chaîne de caractères représentant une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "admin", ou sinon une chaîne vide En cas d'erreur, déclenche une exception ou retourne YNetwork.ADMINPASSWORD_INVALID www.yoctopuce.com...
  • Page 130 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 131 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKCREDENTIALS_INVALID www.yoctopuce.com...
  • Page 132 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKENCODING_INVALID www.yoctopuce.com...
  • Page 133 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKINITIALDELAY_INVALID www.yoctopuce.com...
  • Page 134 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKMAXDELAY_INVALID www.yoctopuce.com...
  • Page 135 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKMETHOD_INVALID www.yoctopuce.com...
  • Page 136 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKMINDELAY_INVALID www.yoctopuce.com...
  • Page 137 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.CALLBACKSCHEDULE_INVALID www.yoctopuce.com...
  • Page 138 ) string get_callbackUrl( ) string get_callbackUrl( ) YNetwork target get_callbackUrl Retourne : une chaîne de caractères représentant l'adresse (URL) de callback à notifier lors de changement d'état significatifs En cas d'erreur, déclenche une exception ou retourne YNetwork.CALLBACKURL_INVALID www.yoctopuce.com...
  • Page 139 ): Promise<string> async get_defaultPage( ) string get_defaultPage( ) string get_defaultPage( ) YNetwork target get_defaultPage Retourne : une chaîne de caractères représentant la page HTML à envoyer pour l'URL "/" En cas d'erreur, déclenche une exception ou retourne YNetwork.DEFAULTPAGE_INVALID www.yoctopuce.com...
  • Page 140 ) YNetwork target get_discoverable Retourne : YNetwork.DISCOVERABLE_FALSE YNetwork.DISCOVERABLE_TRUE soit , soit , selon l'état d'activation du protocole d'annonce sur le réseau permettant de retrouver facilement le module (protocols uPnP/Bonjour) En cas d'erreur, déclenche une exception ou retourne YNetwork.DISCOVERABLE_INVALID www.yoctopuce.com...
  • Page 141 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.
  • Page 142 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'interface réseau.
  • Page 143 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant l'interface réseau en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YNetwork.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 144 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 145 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant l'interface réseau (ex: En cas d'erreur, déclenche une exception ou retourne YNetwork.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 146 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'interface réseau (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant l'interface réseau (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YNetwork.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 147 ): Promise<number> async get_httpPort( ) int get_httpPort( ) int get_httpPort( ) YNetwork target get_httpPort Retourne : un entier représentant le port TCP utilisé pour l'interface Web du hub En cas d'erreur, déclenche une exception ou retourne YNetwork.HTTPPORT_INVALID www.yoctopuce.com...
  • Page 148 Il peut s'agir d'une adresse configurée statiquement, ou d'une adresse reçue par un serveur DHCP. Retourne : une chaîne de caractères représentant l'adresse IP utilisée par le module Yoctopuce En cas d'erreur, déclenche une exception ou retourne YNetwork.IPADDRESS_INVALID www.yoctopuce.com...
  • Page 149 IP de passerelle. Ces trois paramètres sont séparés par le caractère "/" et sont utilisés si aucun serveur DHCP ne répond. Retourne : une chaîne de caractères représentant la configuration IP de l'interface réseau En cas d'erreur, déclenche une exception ou retourne YNetwork.IPCONFIG_INVALID www.yoctopuce.com...
  • Page 150 ) async get_logicalName( ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YNetwork target get_logicalName Retourne : une chaîne de caractères représentant le nom logique de l'interface réseau. En cas d'erreur, déclenche une exception ou retourne YNetwork.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 151 L'adresse MAC est aussi présente sur un autocollant sur le module, représentée en chiffres et en code- barres. Retourne : une chaîne de caractères représentant l'adresse MAC de l'interface réseau, unique pour chaque module En cas d'erreur, déclenche une exception ou retourne YNetwork.MACADDRESS_INVALID www.yoctopuce.com...
  • Page 152 10. Référence de l'API de haut niveau YNetwork network→get_module() network→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 153 10. Référence de l'API de haut niveau YNetwork network→get_module_async() network→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 154 ) string get_ntpServer( ) YNetwork target get_ntpServer Retourne : une chaîne de caractères représentant l'adresse IP du serveur de NTP à utiliser pour maintenir le module à l'heure En cas d'erreur, déclenche une exception ou retourne YNetwork.NTPSERVER_INVALID www.yoctopuce.com...
  • Page 155 La consommation est mesurée après conversion en 5 Volt, et ne doit jamais dépasser 1800 mA. Retourne : un entier représentant le courant consommé par le module depuis Power-over-Ethernet (PoE), en milliampères En cas d'erreur, déclenche une exception ou retourne YNetwork.POECURRENT_INVALID www.yoctopuce.com...
  • Page 156 ) string get_primaryDNS( ) string get_primaryDNS( ) YNetwork target get_primaryDNS Retourne : une chaîne de caractères représentant l'adresse IP du serveur de noms primaire que le module doit utiliser En cas d'erreur, déclenche une exception ou retourne YNetwork.PRIMARYDNS_INVALID www.yoctopuce.com...
  • Page 157 Le niveau 5 (WWW_5) est atteint lorsque la connectivité globale à internet est avérée par l'obtention de l'heure courante sur une serveur NTP. Retourne : YNetwork.READINESS_DOWN YNetwork.READINESS_EXISTS une valeur parmi YNetwork.READINESS_LINKED YNetwork.READINESS_LAN_OK YNetwork.READINESS_WWW_OK représentant l'état de fonctionnement atteint par l'interface réseau En cas d'erreur, déclenche une exception ou retourne YNetwork.READINESS_INVALID www.yoctopuce.com...
  • Page 158 ) string get_router( ) string get_router( ) YNetwork target get_router Retourne : une chaîne de caractères représentant l'adresse IP du routeur (passerelle) utilisé par le module (default gateway) En cas d'erreur, déclenche une exception ou retourne YNetwork.ROUTER_INVALID www.yoctopuce.com...
  • Page 159 ) string get_secondaryDNS( ) string get_secondaryDNS( ) YNetwork target get_secondaryDNS Retourne : une chaîne de caractères représentant l'adresse IP du serveur de noms secondaire que le module doit utiliser En cas d'erreur, déclenche une exception ou retourne YNetwork.SECONDARYDNS_INVALID www.yoctopuce.com...
  • Page 160 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YNetwork target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 161 ): Promise<string> async get_subnetMask( ) string get_subnetMask( ) string get_subnetMask( ) YNetwork target get_subnetMask Retourne : une chaîne de caractères représentant le masque de sous-réseau utilisé par le module En cas d'erreur, déclenche une exception ou retourne YNetwork.SUBNETMASK_INVALID www.yoctopuce.com...
  • Page 162 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 163 YNetwork target get_userPassword Retourne : une chaîne de caractères représentant une chaîne de hash si un mot de passe a été configuré pour l'utilisateur "user", ou sinon une chaîne vide En cas d'erreur, déclenche une exception ou retourne YNetwork.USERPASSWORD_INVALID www.yoctopuce.com...
  • Page 164 ' e r r e u r , d é c l e n c h e u n e e x c e p t i o n r e t o u r n e YNetwork.WWWWATCHDOGDELAY_INVALID www.yoctopuce.com...
  • Page 165 Si les valeurs des attributs en cache de l'interface réseau sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si l'interface réseau est joignable, sinon www.yoctopuce.com...
  • Page 166 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 167 ) YNetwork target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
  • Page 168 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 169 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 170 YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 171 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 172 ): YNetwork | null nextNetwork( ) Si vous souhaitez retrouver une interface réseau spécifique, utilisez Network.findNetwork() avec un hardwareID ou un nom logique. Retourne : YNetwork null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 173 Envoie quatre requêtes ICMP ECHO_REQUEST à la cible host depuis le module. Cette méthode retourne une chaîne de caractères avec le résultat des 4 requêtes ICMP ECHO_RESPONSE. Paramètres : host le nom d'hôte ou l'adresse IP de la cible Retourne : une chaîne de caractères contenant le résultat du ping. www.yoctopuce.com...
  • Page 174 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 175 "admin", qui devient alors newval instantanément nécessaire pour toute altération de l'état du module Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 176 Paramètres : une chaîne de caractères représentant le laisser-passer pour se connecter à l'adresse de callback newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 177 Y N e t w o r k . C A L L B A C K E N C O D I N G _ P R T G YNetwork.CALLBACKENCODING_INFLUXDB_V2 représentant l'encodage à utiliser pour représenter les valeurs notifiées par callback Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 178 être préservé. saveToFlash() Paramètres : un entier représentant l'attente initiale avant la première notification par callback, en secondes newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 179 être préservé. saveToFlash() Paramètres : un entier représentant l'attente entre deux callback HTTP lorsque rien n'est à signaler newval Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...

  • Page 180: Paramètres

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

  • Page 202: La Classe Yfiles

    Interface pour intéragir avec les systèmes de fichier, disponibles par exemple dans le Yocto-Color-V2, le Yocto-Serial, le YoctoHub-Ethernet et le YoctoHub-Wireless-n La class YFiles permet d'accéder au système de fichier embarqué sur certains modules Yoctopuce. Le stockage de fichiers permet par exemple de personnaliser un service web (dans le cas d'un module connecté...
  • Page 203 Retourne l'identifiant matériel du système de fichier, sans référence au module. files→get_hardwareId() SERIAL.FUNCTIONID Retourne l'identifiant matériel unique du système de fichier au format files→get_list(pattern) Retourne une liste d'objets objet YFileRecord qui décrivent les fichiers présents dans le système de fichier. www.yoctopuce.com...
  • Page 204 10. Référence de l'API de haut niveau files→get_logicalName() Retourne le nom logique du système de fichier. files→get_module() Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_module_async(callback, context) Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction. files→get_serialNumber() Retourne le numéro de série du module, préprogrammé...
  • Page 205 à l'initialisation de de l'application. Paramètres : func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 206 Paramètres : yctx un contexte YAPI func une chaîne de caractères qui référence le système de fichier sans ambiguïté, par exemple YRGBLED2.files Retourne : YFiles un objet de classe qui permet ensuite de contrôler le système de fichier. www.yoctopuce.com...
  • Page 207 YFiles.nextFiles() Retourne : un pointeur sur un objet YFiles , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
  • Page 208 YFiles.nextFiles() Paramètres : yctx un contexte YAPI. Retourne : un pointeur sur un objet YFiles , correspondant au premier système de fichier accessible en ligne, ou null si il n'y a pas de systèmes de fichier disponibles. www.yoctopuce.com...
  • Page 209 Chaque chaîne retournée peut être passée en argument à la méthode pour YFiles.FindFiles obtenir une objet permettant d'intéragir avec le module correspondant. Retourne : un tableau de chaînes de caractères, contenant les identifiants matériels de chaque fonction disponible trouvée. www.yoctopuce.com...
  • Page 210 10. Référence de l'API de haut niveau YFiles files→AdvertisedValue Courte chaîne de caractères représentant l'état courant de la fonction. string AdvertisedValue www.yoctopuce.com...
  • Page 211 10. Référence de l'API de haut niveau YFiles files→FilesCount Nombre de fichiers présents dans le système de fichier. int FilesCount www.yoctopuce.com...
  • Page 212 Identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION string FriendlyName Le chaîne retournée utilise soit les noms logiques du module et de la fonction si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de la fonction (par exemple: MyCustomName.relay1 www.yoctopuce.com...
  • Page 213 10. Référence de l'API de haut niveau YFiles files→FunctionId Identifiant matériel du système de fichier, sans référence au module. string FunctionId Par example relay1 www.yoctopuce.com...
  • Page 214 10. Référence de l'API de haut niveau YFiles files→HardwareId Identifiant matériel unique de la fonction au format SERIAL.FUNCTIONID string HardwareId L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction (par example RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 215 Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. www.yoctopuce.com...
  • Page 216 10. Référence de l'API de haut niveau YFiles files→LogicalName Nom logique de la fonction. string LogicalName Modifiable. Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() www.yoctopuce.com...
  • Page 217 10. Référence de l'API de haut niveau YFiles files→SerialNumber Numéro de série du module, préprogrammé en usine. string SerialNumber www.yoctopuce.com...
  • Page 218 ) function clearCache( ) async clearCache( ): Promise<void> async clearCache( ) Invalide le cache des valeurs courantes du système de fichier. Force le prochain appel à une méthode get_xxx() ou loadxxx() pour charger les les données depuis le module. www.yoctopuce.com...
  • Page 219 î n e c a r a c t è r e s d é c r i v a n t s y s t è m e f i c h i e r ( e x : Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 www.yoctopuce.com...
  • Page 220 Paramètres : pathname nom complet du fichier à charger, y compris le chemin d'accès. Retourne : le contenu du fichier chargé sous forme d'objet binaire En cas d'erreur, déclenche une exception ou retourne un contenu vide. www.yoctopuce.com...
  • Page 221 La fonction callback doit prendre trois arguments: - la variable de contexte à disposition de l'utilisateur - l'objet YFiles dont la méthode download_async a été appelée - le contenu du fichier chargé sous forme d'objet binaire variable de contexte à disposition de l'utilisateur context Retourne : rien. www.yoctopuce.com...
  • Page 222 YFiles target fileExist filename Paramètres : filename le nom de fichier. Retourne : vrais si le fichier existe, et faux is le fichier n'existe pas. En cas d'erreur, déclenche une exception. www.yoctopuce.com...
  • Page 223 ) int format_fs( ) YFiles target format_fs entièrement vide. Tous les fichiers précédemment chargés sont irrémédiablement effacés. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 224 ) string get_advertisedValue( ) string get_advertisedValue( ) YFiles target get_advertisedValue Retourne : une chaîne de caractères représentant la valeur courante du système de fichier (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne YFiles.ADVERTISEDVALUE_INVALID www.yoctopuce.com...
  • Page 225 ) get_errorMessage( ): string get_errorMessage( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 226 ) get_errorType( ): number get_errorType( ) Cette méthode est principalement utile lorsque la librairie Yoctopuce est utilisée en désactivant la gestion des exceptions. Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du système de fichier.
  • Page 227 ): Promise<number> async get_filesCount( ) int get_filesCount( ) int get_filesCount( ) YFiles target get_filesCount Retourne : un entier représentant le nombre de fichiers présents dans le système de fichier En cas d'erreur, déclenche une exception ou retourne YFiles.FILESCOUNT_INVALID www.yoctopuce.com...
  • Page 228 ) int get_freeSpace( ) int get_freeSpace( ) YFiles target get_freeSpace Retourne : un entier représentant l'espace disponible dans le système de fichier pour charger des nouveaux fichiers, en octets En cas d'erreur, déclenche une exception ou retourne YFiles.FREESPACE_INVALID www.yoctopuce.com...
  • Page 229 (par exemple: MyCustomName.relay1 Retourne : une chaîne de caractères identifiant le système de fichier en utilisant les noms logiques (ex: MyCustomName.relay1 En cas d'erreur, déclenche une exception ou retourne YFiles.FRIENDLYNAME_INVALID www.yoctopuce.com...
  • Page 230 é t é c o n t a c t é e , v a l e u r r e t o u r n é e s e r a Y$CLASSNAME$.FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com...
  • Page 231 ) async get_functionId( ): Promise<string> async get_functionId( ) string get_functionId( ) string get_functionId( ) Par example relay1 Retourne : relay1 une chaîne de caractères identifiant le système de fichier (ex: En cas d'erreur, déclenche une exception ou retourne YFiles.FUNCTIONID_INVALID www.yoctopuce.com...
  • Page 232 L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du système de fichier (par example RELAYLO1-123456.relay1 Retourne : une chaîne de caractères identifiant le système de fichier (ex: RELAYLO1-123456.relay1 En cas d'erreur, déclenche une exception ou retourne YFiles.HARDWAREID_INVALID www.yoctopuce.com...
  • Page 233 Retourne : YFileRecord une liste d'objets , contenant le nom complet (y compris le chemin d'accès), la taille en octets et le CRC 32-bit du contenu du fichier. En cas d'erreur, déclenche une exception ou retourne une liste vide. www.yoctopuce.com...
  • Page 234 ): Promise<string> async get_logicalName( ) string get_logicalName( ) string get_logicalName( ) YFiles target get_logicalName Retourne : une chaîne de caractères représentant le nom logique du système de fichier. En cas d'erreur, déclenche une exception ou retourne YFiles.LOGICALNAME_INVALID www.yoctopuce.com...
  • Page 235 10. Référence de l'API de haut niveau YFiles files→get_module() files→module() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module( ) YModule * get_module( ) -(YModule*) module TYModule get_module( ): TYModule function get_module( ) As YModule YModule get_module( )
  • Page 236 10. Référence de l'API de haut niveau YFiles files→get_module_async() files→module_async() Retourne l'objet correspondant au module Yoctopuce qui héberge la fonction. YModule function get_module_async( callback, context) Si la fonction ne peut être trouvée sur aucun module, l'instance de retournée ne sera pas YModule joignable.
  • Page 237 ): Promise<string> async get_serialNumber( ) string get_serialNumber( ) string get_serialNumber( ) YFiles target get_serialNumber Retourne : : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine. En cas d'erreur, déclenche une exception ou retourne YFunction.SERIALNUMBER_INVALID. www.yoctopuce.com...
  • Page 238 ) function get_userData( ) async get_userData( ): Promise<object|null> async get_userData( ) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Retourne : l'objet stocké précédemment par l'appelant. www.yoctopuce.com...
  • Page 239 Si les valeurs des attributs en cache du système de fichier sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité. Retourne : true false si le système de fichier est joignable, sinon www.yoctopuce.com...
  • Page 240 à la fonction de callback Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 241 ) YFiles target isReadOnly Retourne vrais si la fonction est protégé en ecriture ou que la fontion n'est pas disponible. Retourne : true si la fonction est protégé en ecriture ou que la fontion n'est pas disponible www.yoctopuce.com...
  • Page 242 Paramètres : un entier correspondant à la durée de validité attribuée aux les paramètres chargés, en msValidity millisecondes Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 243 Paramètres : le nom de l'attribut désiré attrName Retourne : une chaîne de caractères représentant la valeur actuelle de l'attribut. En cas d'erreur, déclenche une exception ou retourne un chaîne vide. www.yoctopuce.com...
  • Page 244 YAPI.SUCCESS d'erreur (ou contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout : le résultat sera passé en paramètre à la fonction de callback. www.yoctopuce.com...
  • Page 245 éviter le déclanchement de callbacks HTTP. N'oubliez pas d'appeler la méthode du module si le réglage doit être préservé. saveToFlash() Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 246 ): YFiles | null nextFiles( ) Si vous souhaitez retrouver un système de fichier spécifique, utilisez Files.findFiles() avec un hardwareID ou un nom logique. Retourne : YFiles null un pointeur sur un objet accessible en ligne, ou lorsque l'énumération est terminée. www.yoctopuce.com...
  • Page 247 Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et la chaîne de caractère décrivant la nouvelle valeur publiée. www.yoctopuce.com...
  • Page 248 éventuellement pas été libéré. Pour s'assurer de libérer la totalité de l'espace du système de fichier, utilisez la fonction format_fs Paramètres : pathname nom complet du fichier, y compris le chemin d'accès. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 249 être préservé. saveToFlash() Paramètres : newval une chaîne de caractères représentant le nom logique du système de fichier. Retourne : YAPI.SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 250 $data) async set_userData( data: object|null): Promise<void> async set_userData( data) Cet attribut n'es pas utilisé directement par l'API. Il est à la disposition de l'appelant pour stocker un contexte. Paramètres : data objet quelconque à mémoriser www.yoctopuce.com...
  • Page 251 Cette fonction annule un précédent appel à . N'oubliez pas d'appeler la muteValueCallbacks() méthode saveToFlash() du module si le réglage doit être préservé. Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 252 Paramètres : nom complet du fichier, y compris le chemin d'accès. pathname content contenu du fichier à télécharger Retourne : YAPI.SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif. www.yoctopuce.com...
  • Page 253 La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné. contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback context Retourne : rien du tout. www.yoctopuce.com...
  • Page 254 www.yoctopuce.com...

  • Page 255: Problèmes Courants

    11.1. Par où commencer ? Si c'est la première fois que vous utilisez un module Yoctopuce et ne savez pas trop par où commencer, allez donc jeter un coup d'œil sur le blog de Yoctopuce. Il y a une section dédiée aux débutants 11.2.

  • Page 256: Plateformes Arm: Hf Et El

    11.5. Module alimenté mais invisible pour l'OS Si votre YoctoHub-Ethernet est branché par USB et que sa LED bleue s'allume, mais que le module n'est pas vu par le système d'exploitation, vérifiez que vous utilisez bien un vrai câble USB avec les fils pour les données, et non pas un câble de charge.

  • Page 257: Déconnexions, Comportement Erratique

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

  • Page 259: Caractéristiques

    12. Caractéristiques Vous trouverez résumées ci-dessous les principales caractéristiques techniques de votre module YoctoHub-Ethernet Identifiant produit YHUBETH1 † Rev. D Révision matérielle Connecteur USB micro-B Epaisseur 22 mm Largeur 58 mm Longueur 60 mm Poids 34 g Canaux 3 ports...
  • Page 260 12. Caractéristiques www.yoctopuce.com...

Table des Matières