Home

YoctoHub-Ethernet, Mode d`emploi

1. Yocto bouton 1 et Led 2 de localisation d un module Yocto Demo Ces deux l ments sont g n ralement plac s m me endroit sur les modules 1 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 www yoctopuce com 17 5 Utilisation du YoctoHub Ethernet 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 od YCTOPOC1 00C4D is 20x20mm board with only the bare minimum found in every Yoctopuce device plus one LED It is intended to be used to get familiar with Yoctopuce programming API Kernel Serial YCTOPOC1 00C4D Product name Yocto Demo Logical name Product release 2 Firmware 11443 Consumption 25 MA Beacon Inactive tum Luminosity 50 Actuators Test LED OFF tum Misc Open API Dr Get user manual from yoctopuce com Close 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 ou
2. Cette m thode est principalement utile lorsque la librairie Yoctopuce est utilis e 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 132 www yoctopuce com 10 R f rence de l API de haut niveau files get_filesCount YFiles files files Count Retourne le nombre de fichiers pr sents dans le syst me de fichier function get_filesCount function get_filesCount function get_filesCount int get_filesCount int flesCount function get_filesCount Longint function get_filesCount As Integer int get_filesCount int get_filesCount def get_filesCount YFiles target get_filesCount Retourne un entier repr sentant le nombre de fichiers pr sents dans le syst me de fichier En cas d erreur d clenche une exception ou retourne Y_FILESCOUNT_INVALTD www yoctopuce com 133 10 R f rence de l API de haut niveau files get_freeSpace YFiles files freeSpace Retourne l espace disponible dans le syst me de fichier pour charger des nouveaux fichiers en octets function get_freeSpace function get_freeSpace function get_freeSpace int get_freeSpace int freeSpace function get_freeSpace 1 Longint _vb function get_freeSpace As Integer int get_freeSpace int get_freeSpace def get_freeSpace YFiles targ
3. String newval def set_logicalName newval YNetwork target set_logicalName newval YNetwork 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 newval une cha ne de caract res repr sentant le nom logique de l interface r seau Retourne un code d erreur n gatif 50 55 si l appel se d roule sans erreur En cas d erreur d clenche une exception ou retourne www yoctopuce com 113 10 R f rence de l API de haut niveau network set_primaryDNS YNetwork network setPrimaryDNS Modifie l adresse IP du serveur de noms primaire que le module doit utiliser function set_primaryDNS newval function set_primaryDNS newval function set_primaryDNS newval int set_primaryDNS const string amp newval int setPrimaryDNS NSString newval function set_primaryDNS newval string integer _vb function set_primaryDNS ByVal newval As String As Integer int set_primaryDNS string newval int set_primaryDNS String newval def set_primaryDNS newval 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 newv
4. 38 www yoctopuce com 10 R f rence de l API de haut niveau hubport get_enabled hubport enabled Retourne vrai si le port du Yocto hub est aliment faux sinon function get_enabled function get_enabled function get_enabled Y_ENABLED_enum get_enabled _enum enabled function get_enabled Integer function get_enabled As Integer int int get def get YHubPort target get Retourne soit Y_ENABLED_FALSE soit Y_ENABLED_ TRUE selon vrai si le port du Yocto hub est aliment faux sinon YHubPort En cas d erreur d clenche une exception ou retourne Y_ENABLED_TNVALTD www yoctopuce com 39 10 R f rence de l API de haut niveau hubport get_errorMessage YHubPort hubport errorMessage Retourne le message correspondant la derni re erreur survenue lors de l utilisation du port de Yocto hub function get_errorMessage function get_errorMessage function get_errorMessage string get_errorMessage NSString errorMessage function get_errorMessage string function get_errorMessage As String string get_errorMessage String get_errorMessage def 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 c
5. Bee 2 seess occon KL 11 IOF EM 25 Bech Ban Ca Z E TT 68 HU e T eme Bas E LS d D az gel 5 z DCH 90 ma rl SCH LM ble il m ES 3 8 11 B bes 06 moco mooo 1 ee LY 3 17 17 2 2 SC N Di L EAN SC k TO Graes mm di y ann 20 ERA CC L d PI Hi g 5 0 U Es loco o WOT TUN 0 ER 0 0 t S es e een a e SE 8 SE o 9 Beie DN o 8 LA oran SKS HT E All dimensions are in mm Toutes les dimensions sont en mm YoctoHub Ethernet A4 Scale D Echelle Index A Acc s 21 22 27 Admin 22 Automatis e 10 Blueprint 157 C Callback 24 26 callbackLogin YNetwork 66 Caract ristiques 155 Configuration 8 10 18 23 Connect s 27 Connexions 11 Contr le 21 27 D Defined 24 describe YFiles 125 describe YHubPort 35 describe YNetwork 67 Directe 7 download YFiles 126 download YFiles 127 E
6. NSString router function get_router string function get_router As String string get_router String get_router def get_router YNetwork target get_router Retourne une cha ne de caract res repr sentant l adresse IP du routeur passerelle utilis par le module default gateway En cas d erreur d clenche une exception ou retourne Y_ROUTER_INVALTD 92 www yoctopuce com 10 R f rence de l API de haut niveau network get_secondaryDNS YNetwork network secondaryDNS Retourne l adresse IP du serveur de noms secondaire que le module doit utiliser function get_secondaryDNS function get_secondaryDNS function get_secondaryDNS string get_secondaryDNS NSString secondaryDNS function get_secondaryDNS string function get_secondaryDNS As String string get_secondaryDNS String get_secondaryDNS def get_secondaryDNS YNetwork target get_secondaryDNS Retourne une cha ne de caract res repr sentant l adresse IP du serveur de noms secondaire que le module doit utiliser En cas d erreur d clenche une exception ou retourne Y_SECONDARYDNS_TNVALTD www yoctopuce com 93 10 R f rence de l API de haut niveau network get_subnetMask YNetwork network subnetMask Retourne le masque de sous r seau utilis par le module function get_subnetMask function get_subnetMask function get_subnetMask string get_subnetMask NSS
7. function get_functionDescriptor YFUN_DESCR get_functionDescriptor YFUN_DESCR functionDescriptor function get_functionDescriptor 1 YFUN DESCH function get_functionDescriptor As YFUN DESCH YFUN_DESCR get_functionDescriptor String get_functionDescriptor def get_functionDescriptor Cet identifiant peut tre utilis pour tester si deux instance de YFunct ion 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 www yoctopuce com 81 10 R f rence de l API de haut niveau network get_functionid YNetwork network functionid Retourne l identifiant mat riel de l interface r seau sans r f rence au module function get_functionid function get_functionid function get_functionid string get_functionid NSString functionld vo function get_functionid As String string get_functionid String get_functionld def get_functionld 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 82 www yoctopuce com 10 R f rence de l API de haut niveau network get_hardwareld YNetwork network hardwareld Retourne l identifiant mat riel unique de l interface
8. 5 Press on the Test button to check your parameters 6 When everything works press on the OK button rest Cancel 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 24 www yoctopuce com 7 Interactions avec l ext rieur 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 es des modules intervalle r gulier et chaque fois qu une de ces valeurs change de mani re significative Vous pouvez changer les d lais d attente entre les posts Tests Afin de vous permettre de d boguer le processus le YoctoHub 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 valeur
9. 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 vot
10. 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 func une 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 www yoctopuce com 65 10 R f rence de l API de haut niveau YNetwork FirstNetwork YNetwork yFirstNetwork Commence l num ration des interfaces r seau accessibles par la librairie function yFirstNetwork node is function FirstNetwork function yFirstNetwork YNetwork yFirstNetwork YNetwork yFirstNetwork function yFirstNetwork TYNetwork function yFirstNetwork As YNetwork YNetwork FirstNetwork YNetwork FirstNetwork def 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 siil n y pas de interfaces r seau disponibles 66 www yoctopuce com 10 R f rence de l API de haut niveau network callbackLogin Contacte le callback de not
11. 84 www yoctopuce com 10 R f rence de l API de haut niveau network get_logicalName network logicalName Retourne le nom logique de l interface r seau function get_logicalName function get_logicalName function get_logicalName string get_logicalName NSString logicalName function get_logicalName string function 1 As String string get_logicalName String get_logicalName def get_logicalName YNetwork target get_logicalName Retourne une cha ne de caract res repr sentant le nom logique de l interface r seau En cas d erreur d clenche une exception ou retourne Y_LOGICALNAME TINVALTID YNetwork www yoctopuce com 85 10 R f rence de l API de haut niveau network get_ macAddress YNetwork network macAddress Retourne l adresse MAC de l interface r seau unique pour chaque module function get_macAddress function get_macAddress function get macAddress string get_macAddress NSString macAddress function get_macAddress string function get_macAddress As String string get macAddress String get macAddress def get macAddress 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
12. Enregistre la fonction de callback qui est appel e chaque changement de la valeur publi e function registerValueCallback callback function registerValueCallback callback function registerValueCallback callback int register ValueCallback YFilesValueCallback callback int register ValueCallback YFilesValueCallback callback function registerValueCallback callback TYFilesValueCallback Longint function register ValueCallback As Integer int register ValueCallback ValueCallback callback int register ValueCallback UpdateCallback callback def registerValueCallback callback Ce callback n est appel que durant l ex cution de ySleep 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 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 149 10 R f rence de l API de haut niveau files remove YFiles Efface un fichier sp cifi par son path complet du syst me de fichier _is function remove pathname no
13. La fonction callback re oit trois arguments le contexte fourni par l appelant l objet fonction concern et le code d erreur ou YAPT_ SUCCESS context contexte 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 www yoctopuce com 101 10 R f rence de l API de haut niveau network nextNetwork YNetwork Continue l num ration des interfaces r seau commenc e l aide de yFirstNetwork function nextNetwork kodes function nextNetwork cs function nextNetwork YNetwork nextNetwork YNetwork nextNetwork function nextNetwork TYNetwork function nextNetwork As YNetwork YNetwork nextNetwork YNetwork nextNetwork def nextNetwork Retourne un pointeur sur un objet YNetwork accessible en ligne ou nu 11 lorsque l num ration est termin e 102 www yoctopuce com 10 R f rence de l API de haut niveau network ping Ping str_host pour v rifier la connexion r seau function ping host function ping host function ping host string ping string host NSString ping NSString host function ping host string string function ping As String string ping string host String ping String host def ping host YNetwork target ping host YNetwork Envoie quatre requ tes ICMP ECHO _R
14. Param tres data objet quelconque m moriser www yoctopuce com 59 10 R f rence de l API de haut niveau hubport wait_async YHubPort 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 function wait_async callback context function wait_async callback context La fonction callback peut donc librement utiliser des fonctions synchrones asynchrones sans risquer de bloquer la machine virtuelle Javascript Param tres callback fonction 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 context contexte fourni par l appelant et qui sera pass tel quel la fonction de callback Retourne rien du tout 60 www yoctopuce com 10 R f rence de l API de haut niveau 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 lt script type text javascript src yocto_network js gt lt script gt var yoctolib require yoctolib var YNetwork yoctolib YNetwork require_oncel yocto_network php include yocto_network h import yocto_network h
15. 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 110 www yoctopuce com 10 R f rence de l API de haut niveau network set_callbackUrl YNetwork network setCallbackUri Modifie l adresse URL de callback notifier lors de changement d tat significatifs function set_callbackUrl newval function set_callbackUrl newval function set_callbackUrl newval int set_callbackUrl const string amp newval int setCallbackUrl NSString newval function set_callbackUrl newval string integer function set_callbackUrl ByVal newval As String As Integer int set_callbackUrl string newval int set_callbackUrl String newval def set_callbackUrl newval YNetwork target set_callbackUrl newval N oubliez pas d appeler la m thode saveToFlash du module si le r glage doit tre pr serv S Param tres newval une 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 www yoctopuce com 111 10 R f rence de l API de haut niveau network set_ discoverable YNetwork network setDiscoverable Modifie l tat d activation du protocole d annonce sur le r seau permettant de
16. 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 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 co
17. get_ module YHubPort 46 get module YNetwork 86 get module async YFiles 141 get module async YHubPort 47 get module async YNetwork 87 get_poeCurrent YNetwork 88 get_portState YHubPort 48 get_primaryDNS YNetwork 89 get_readiness YNetwork 90 get_router YNetwork 91 get_secondaryDNS YNetwork 92 get_subnetMask YNetwork 93 get_userData YFiles 142 get_userData YHubPort 49 get_userData YNetwork 94 get_userPassword YNetwork 95 get_wwwWatchdogDelay YNetwork 96 Impatients 7 Influence 22 Interactions 23 Interface 29 32 61 122 Introduction 1 YFiles 143 isOnline YHubPort 50 isOnline YNetwork 97 isOnline_async YFiles 144 isOnline_async YHubPort 51 isOnline_async YNetwork 98 L Limitations 30 load YFiles 145 load YHubPort 52 load YNetwork 99 load async YFiles 146 load YHubPort 53 load async YNetwork 100 Localisation 17 Manuelle 8 Modules 17 18 27 Montage 15 Mots 22 N Network 61 nextFiles YFiles 147 nextHubPort YHubPort 54 nextNetwork YNetwork 101 Niveau 31 P Passe 22 Personnalisation 29 ping YNetwork 102 Port 32 Pour 7 Pr sentation 3 Programmation 27 Prot g 22 R R f rence 31 registerValueCallback YFiles 148 registerValueCallback YHubPort 55 register ValueCallback YNetwork 103 remove YFiles 149 S set_adminPassword YNetwork 104 set_callbackCredentials YNetwork 105 set_callbackEncoding YNetwork 106 set_callbackMax
18. me de fichier commenc e l aide de yFirstFriles files register ValueCallback 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 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 123 10 R f rence de l API de haut niveau YFiles FindFiles YFiles yFindFiles Permet de retrouver un syst me de fichier d apr s un identifiant donn 1 5s function yFindFiles func node js function FindFiles func cs function yFindFiles func YFiles yFindFiles string func YFiles yFindFiles NSString func function yFindFiles func string TYFiles function yFindFiles ByVal func As String As YFiles cs YFiles FindFiles string func java YFiles FindFiles String func def FindFiles func L identifiant peut tre sp cifi
19. pas plus de 6 caract res En cas d erreur d clenche une exception ou retourne Y_ADVERTISEDVALUE INVALID 130 www yoctopuce com 10 R f rence de l API de haut niveau files get_errorMessage YFiles files errorMessage Retourne le message correspondant la derni re erreur survenue lors de l utilisation du syst me de fichier function get_errorMessage function get_errorMessage function get_errorMessage string get_errorMessage NSString errorMessage function get_errorMessage string function get_errorMessage 1 As String string get_errorMessage String get_errorMessage def Cette m thode est principalement utile lorsque la librairie Yoctopuce est utilis e 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 www yoctopuce com 131 10 R f rence de l API de haut niveau files get _errorType YFiles files errorType Retourne le code d erreur correspondant la derni re erreur survenue lors de l utilisation du syst me de fichier function get_errorType function get_errorType function get_errorType YRETCODE get_errorType function get_errorType YRETCODE function get_errorType As YRETCODE YRETCODE get_errorType int def get
20. string newval int String newval def set_logicalName newval YFiles target set_logicalName newval YFiles 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 newval une cha ne de caract res repr sentant le nom logique du syst me de fichier Retourne un code d erreur n gatif 50 55 si l appel se d roule sans erreur En cas d erreur d clenche une exception ou retourne www yoctopuce com 151 10 R f rence de l API de haut niveau files set_userData YFiles files setUserData Enregistre un contexte libre dans l attribut userData de la fonction afin de le retrouver plus tard l aide la m thode get_userData function set_userData data function set_userData data function set_userData data void set_userData void data void setUserData void data procedure set_userData data Tobject procedure set_userData ByVal data As Object void set_userData object data void set_userData Object data def 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 152 www yoctopuce com 10 R f rence de l API de haut niveau fil
21. thode HTTP utiliser pour signaler les changements d tat par callback network set _callbackMinDelay newval Modifie l attente minimale entre deux notifications par callback en secondes network set _callbackUrl newval Modifie l adresse URL de callback notifier lors de changement d tat significatifs 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 _logicalName newval Modifie le nom logique de l interface r seau 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 useDHCP fallbacklpAddr fallbackSubnetMaskLen fallbackRouter Modifie la configuration de l inter
22. Ethernet pour poster des donn es directement sur ThingSpeak Yoctopuce n est en aucune mani re affili ThingSpeak 2 www xively com http www yoctopuce com FR article enregistrer des mesures sur internet Se www thingspeak com 5 http www yoctopuce com FR article alternatives a cosm pour enregistrer des mesures 26 wWww yoctopuce com 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
23. FUNCTIONID function get_hardwareld function get_hardwareld function get_hardwareld string get_hardwareld NSString hardwareld function get_hardwareld As String string get_hardwareld String get_hardwareld def get_hardwareld 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 RELAYL01 123456 relayl Retourne une cha ne de caract res identifiant le syst me de fichier RELAYLO1 123456 relayl En cas d erreur d clenche une exception ou retourne Y_HARDWAREID_INVALID 138 www yoctopuce com 10 R f rence de l API de haut niveau files get Ise YFiles files list Retourne une liste d objets objet YFileRecord qui d crivent les fichiers pr sents dans le syst me de fichier function get_list pattern function get_list pattern function get_list pattern vector lt YFileRecord gt get_list string pattern NSMutableArray list NSString pattern function get_list pattern string TYFileRecordArray function get_list As List List lt YFileRecord gt get_list string pattern ArrayList lt YFileRecord gt get_list String pattern def get_list pattern YFiles target get_list pattern Param tres pattern un 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 fi
24. Premiers pas 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 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 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 njecteur PoE permettant d injecter la puissance sur un seul c ble Ethernet 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 conne
25. SA en te ne sn te 29 9 25 Bil le TEE EE 30 10 R f rence de l API de haut niveau 31 10 1 Interface d un port de Yocto hub su 32 10 2 Interface de la fonction Network 61 10 3 Interface de la fonction Files 122 11 Caract ristiques 155 Ere oA AN ss LR Se QE MR dE 157 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 VirtualHub 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 II convient de fait beaucoup mieux une industrialisation qu un En revanche il
26. YHubPort yoctolib YHubPort require_oncel yocto_hubport php include yocto_hubport h import yocto_hubport h uses yocto_hubport yocto_hubport vb yocto_hubport cs import com yoctopuce YoctoAPI YHubPort from yocto_hubport import Fonction globales yFindHubPort func Permet de retrouver un port de Yocto hub d apr s un identifiant donn yFirstHubPort Commence l num ration des port de Yocto hub accessibles par la librairie M thodes des objets YHubPort hubport describe Retourne un court texte d crivant le 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_DE SCR correspondant la foncti
27. cas d erreur d clenche une exception ou retourne Y_MACADDRESS_TNVALTD 86 www yoctopuce com 10 R f rence de l API de haut niveau network get_module YNetwork network module Retourne l objet YModule correspondant au module Yoctopuce qui h berge la fonction function get_module function get module function get_module YModule get_module YModule module function get_module 1 TYModule function get_module As YModule YModule get_module YModule get_module def 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 www yoctopuce com 87 10 R f rence de l API de haut niveau network get_ module YNetwork network module async Retourne l objet YModule correspondant au module Yoctopuce qui h berge la fonction function get_module_async callback context 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 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 callback fonction de call
28. 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_poeCurrent Retourne le courant consomm par le module depuis Power over Ethernet PoE en milliamp res network get_primaryDNS Retourne l adresse 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 interf
29. integer YRETCODE function load ByVal msValidity As Integer As YRETCODE YRETCODE load int msValidity int load long msValidity def 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 msValidity un entier correspondant la dur e de validit attribu e aux les param tres charg s en millisecondes Retourne YAPI_SUCCESS si l op ration se d roule sans erreur En cas d erreur d clenche une exception ou retourne un code d erreur n gatif 146 www yoctopuce com 10 R f rence de l API de haut niveau files load YFiles Met en cache les valeurs courantes du syst me de fichier avec une dur e de validit sp cifi e function load_async msValidity callback context 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 asy
30. l tat de la connexion r seau Ces tats peuvent tre 0 search for link Le module cherche une liaison r seau Si cet tat persiste il est probable que le c ble r seau n est pas branch 2 network linked une liaison t d tect e 3 LAN ready le r seau local est op rationnel 4 WWW ready le module pu v rifier la connectivit Internet en se connectant un serveur de temps NTP Apr s avoir v rifi que votre module a bien une adresse IP valide vous pouvez fermer la fen tre d tails arr ter votre VirtualHub et d brancher le c ble USB de contr le de votre ordinateur il suffira que le module soit aliment pour l utiliser Vous pouvez d sormais acc der votre YoctoHub 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 Serial Logical Name Description Action YoctoHub Ethernet configure view log file beacon Yocto Thermocouple configure view log file beaco
31. l instance de YModule retourn e ne sera pas joignable Retourne une instance de YModule www yoctopuce com 141 10 R f rence de l API de haut niveau files get module YFiles files module async Retourne l objet YModule correspondant au module Yoctopuce qui h berge la fonction function get_module_async callback context 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 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 callback fonction 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 context contexte 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 142 www yoctopuce com 10 R f rence de l API de haut niveau files get_userData YFiles files userData Retourne le contenu de l attribut userData pr c demment stock l aide de la m thode
32. lectroniques 16 wWww yoctopuce com 5 Utilisation du YoctoHub Ethernet Outre fournir un acc s r seau au 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 favori 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 Serial Logical Name Description Action YHUBETH1 0CA C YoctoHub Ethernet configure view log file beacon al RELAYHI1 0 8 Yocto PowerRelay configure wiew log file beacon TMPSENS1 0546E Yocto Temperature configure view log file beacon H Show device functions 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 la ligne correspondante Vous pouvez faire la m me manipulation en appuyant sur le Yocto bouton d un module connect
33. nom logique du port de Yocto hub function get_logicalName function get_logicalName function get_logicalName string get_logicalName NSString logicalName function get_logicalName string function get_logicalName As String string get_logicalName String get_logicalName def get_logicalName YHubPort target get_logicalName Retourne une cha ne de caract res repr sentant le nom logique du port de Yocto hub En cas d erreur d clenche une exception ou retourne Y_LOGICALNAME TINVALTID 46 www yoctopuce com 10 R f rence de l API de haut niveau hubport get_module YHubPort hubport module Retourne l objet YModule correspondant au module Yoctopuce qui h berge la fonction function get_module function get module function get_module YModule get_module YModule module function get_module 1 TYModule function get_module As YModule YModule get_module YModule get_module def 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 www yoctopuce com 47 10 R f rence de l API de haut niveau hubport get module async YHubPort hubport module async Retourne l objet YModule correspondant au module Yoctopuce qui h berge la fonction function get_module_async callback context function get_module_async callback conte
34. objet YF iles correspondant le premier syst me de fichier accessible en ligne ou null siil n y a pas de syst me de fichier disponibles www yoctopuce com 125 10 R f rence de l API de haut niveau files describe YFiles Retourne un court texte d crivant le syst me de fichier au format TYPE SERIAL FUNCTIONID _is function describe node is function describe prp function describe string describe NSString describe function describe string function describe As String string describe String describe def 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 sile module est d j connect ou Relay BadCustomeName relayl unresolved sile 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 relayli 126 www y
35. roule sans erreur En cas d erreur d clenche une exception ou retourne un code d erreur n gatif www yoctopuce com 105 10 R f rence de l API de haut niveau network set_callbackCredentials YNetwork network setCallbackCredentials Modifie le laisser passer pour se connecter l adresse de callback function set_callbackCredentials newval function set_callbackCredentials newval function set_callbackCredentials newval int set_callbackCredentials const string amp newval int setCallbackCredentials NSString newval function set_callbackCredentials newval string integer function set_callbackCredentials ByVal newval As String As Integer int set_callbackCredentials string newval int set_callbackCredentials String newval def set_callbackCredentials newval 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 newval une c
36. 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 context contexte fourni par l appelant et qui sera pass tel quel la fonction de callback Retourne rien du tout 154 www yoctopuce com 11 Caract ristiques Vous trouverez r sum es ci dessous les principales caract ristiques techniques de votre module YoctoHub Ethernet Epaisseur Largeur Longueur Poids Connecteur USB Canaux Courant Max continu Consommation USB Syt me d exploitation support s Connection r seau Drivers API SDK Librairie USB TCP API SDK Librairie seul TCP RoHS USB Vendor ID USB Device ID Bo ter recommand 22 mm 58 mm 60 mm 34 9 micro B 3 ports 2A 130 mA Windows Linux Intel ARM Mac OS X Android Fast Ethernet Fonctionne sans driver C Objective C VB NET Delphi Python Java Android Javascript Node js PHP Java oui 0x24E0 0x000E YoctoBox HubEth Transp www yoctopuce com 155 11 Caract ristiques 156 www yoctopuce com 60 H 7 E 2 42 _
37. 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 BEE YHUBETH1 0F11C is 58x60mm ready to use Ethernet host for Yoctopuce modules Kernel Serial YHUBETH1 0F11C Product name YoctoHub Ethernet Logical name Product release 1 Firmware 12149 Consumption 133 PoE Inactive on Luminosity 50 Hub Ports Port 1 ON Port 2 ON Port 3 ON Network 4 WWW ready MAC address 00 04 5 IP address 172171772 Test Device name YHUBETH1 0F11C Misc Open API browser pop up Get user manual from yoctopuce com Close Les propri t s du YoctoHub Ethernet www yoctopuce com 9 3 Premiers pas 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
38. set_userData function get_userData function get_userData function get_userData void get_userData void userData function get_userData Tobject function get_userData As Object object get_userData Object get_userData def 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 143 10 R f rence de l API de haut niveau files isOnline YFiles V rifie si le module h bergeant le syst me de fichier est joignable sans d clencher d erreur function isOnline node js function prp function isOnline bool isOnline BOOL isOnline function isOnline boolean ve function isOnline As Boolean isOnline boolean isOnline def 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 sile syst me de fichier est joignable false sinon 144 www yoctopuce com 10 R f rence de l API de haut niveau files isOnline YFiles V rifie si le module h bergeant le sy
39. 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 ADSL priv Le YoctoHub Ethernet sert alors de relais Vous avez simplement d finir l URL du script PHP de contr le et ventuellement les cr dentiels n cessaires pour y acc der Vous trouvez plus d informations sur le fonctionnement du mode callback de l API PHP dans le mode d emploi de vos modules Yoctopuce 7 4 Xively anciennement Cosm Xively est un service de cloud payant mais avec un mode de d veloppement limit gratuit qui vous permettra tracer des graphes avec les donn es issues de vos capteurs Yoctopuce et ce sans crire la moindre ligne de code Vous avez besoin d un compte Xively et de d finir un feed et une clef API sur le site de Xively Entrez ces deux param tres dans l interface du YoctoHub Ethernet c est tout Au besoin vous trouverez des explications plus d taill es sur le blog de Yoctopuce Yoctopuce n est en aucune mani re affili Xively 7 5 Thinkspeak ThingSpeak est un autre service de cloud enti rement gratuit lui qui permet aussi de tracer des graphes avec des donn es issues de vos capteurs Yoctopuce Ce service pr sente quelques limitations de fonctionnalit par rapport Xively mais a l avantage de ne n cessiter aucune license payante Vous trouverez sur le blog de Yoctopuce comment configurer votre YoctoHub
40. 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 www yoctopuce com 27 8 Programmation 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 28 wWww yoctopuce com 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 modu
41. www yoctopuce com 115 10 R f rence de l API de haut niveau network set_userData YNetwork network setUserData 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 function set_userData data function set_userData data function set_userData data void set_userData void data void setUserData void data procedure set_userData data Tobject procedure set_userData ByVal data As Object void set_userData object data void set_userData Object data def 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 116 www yoctopuce com 10 R f rence de l API de haut niveau network set_userPassword YNetwork network setUserPassword Modifie le mode de passe pour l utilisateur user qui devient alors instantan ment n cessaire pour tout acc s au module function set_userPassword newval function set_userPassword newval function set_userPassword newval int set_userPassword const string amp newval int setUser Password NSString newval function set_userPassword newval string integer function set_userPassword ByVal newval As String As Integer int set_userPassword string newval int set_userPassword String newval def set_userP
42. BACKENCODING CSV et Y_CALLBACKENCODING_YOCTO_APT 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_CALILBACKENCODING_INVALTD 72 www yoctopuce com 10 R f rence de l API de haut niveau network get_callbackMaxDelay YNetwork network callbackMaxDelay Retourne l attente maximale entre deux notifications par callback en secondes function get_callbackMaxDelay function get_callbackMaxDelay function get_callbackMaxDelay int get_callbackMaxDelay int callbackMaxDelay function get_callbackMaxDelay 1 Longint function get_callbackMaxDelay As Integer int get_callbackMaxDelay int get_callbackMaxDelay def get_callbackMaxDelay YNetwork target get_callbackMaxDelay Retourne un entier repr sentant l attente maximale entre deux notifications par callback en secondes En cas d erreur d clenche une exception ou retourne Y_CALLBACKMAXDELAY_INVALID www yoctopuce com 73 10 R f rence de l API de haut niveau network get_callbackMethod YNetwork network callbackMethod Retourne la m thode HTTP utiliser pour signaler les changements d tat par callback function get_callbackMethodi function get_callbackMethodi function get_callbackMethod Y_CALLBACKMETHOD_enum get_callbackMethod Y_CALLBACKMETHOD_enum callbackMethod _pas function ge
43. DNS function get_primaryDNS function get_primaryDNS string get_primaryDNS NSString primaryDNS function get_primaryDNS string function get_primaryDNS As String string get_primaryDNS String get_primaryDNS def get_primaryDNS YNetwork target get_primaryDNS Retourne une cha ne de caract res repr sentant l adresse IP du serveur de noms primaire que le module doit utiliser En cas d erreur d clenche une exception ou retourne Y_PRIMARYDNS_TNVALTD 90 www yoctopuce com 10 R f rence de l API de haut niveau network get_readiness YNetwork network readiness Retourne l tat de fonctionnement atteint par l interface r seau function get_readiness function get_readiness function BEADINESS get_readiness Y_READINESS_ readiness function _ Integer function get_readiness As Integer int get_readiness int def get_readiness YNetwork target get_readiness Le niveau z ro 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 at
44. Delay YNetwork 107 set_callbackMethod YNetwork 108 set_callbackMinDelay YNetwork 109 set_callbackUrl YNetwork 110 set_discoverable YNetwork 111 set_enabled YHubPort 56 set_logicalName YFiles 150 set_logicalName YHubPort 57 set_logicalName YNetwork 112 set_primaryDNS YNetwork 113 set_secondaryDNS YNetwork 114 set_userData YFiles 151 set_userData YHubPort 58 set_userData YNetwork 115 set_userPassword YNetwork 116 set_wwwWatchdogDelay YNetwork 117 Sous module 16 T Test 18 Thinkspeak 26 U Upgrades 19 upload YFiles 152 useDHCP YNetwork 118 User 22 24 useStaticiP YNetwork 119 W wait_async YFiles 153 wait_async YHubPort 59 wait_async YNetwork 120 Y YFiles 123 153 yFindFiles 123 yFindHubPort 33 yFindNetwork 64 yFirstFiles 124 yFirstHubPort 34 yFirstNetwork 65 YHubPort 33 59 YNetwork 64 120 Yocto API 26 Yocto hub 32 YoctoHub Ethernet 3 17 27
45. ESPONSER la cible str_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 d h te ou l adresse de la cible Retourne une cha ne de caract res contenant le r sultat du ping www yoctopuce com 103 10 R f rence de l API de haut niveau network registerValueCallback YNetwork Enregistre la fonction de callback qui est appel e chaque changement de la valeur publi e js function register ValueCallback callback node js function register ValueCallback callback prp function register ValueCallback callback int register ValueCallback YNetworkValueCallback callback int register ValueCallback YNetworkValueCallback callback function register ValueCallback callback TYNetworkValueCallback Longint function register ValueCallback As Integer int register ValueCallback ValueCallback callback int register ValueCallback UpdateCallback callback def register ValueCallback callback Ce callback n est appel que durant l ex cution de 1 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 passa
46. Effacement 22 El ments 3 Ext rieur 23 F Files 122 FindFiles YFiles 123 FindHubPort YHubPort 33 FindNetwork YNetwork 64 Firmwares 19 FirstFiles YFiles 124 FirstHubPort YHubPort 34 FirstNetwork YNetwork 65 Fixation 15 16 format_fs YFiles 128 G get_adminPassword YNetwork 68 get_advertisedValue YFiles 129 get_advertisedValue YHubPort 36 get_advertisedValue YNetwork 69 get_baudRate YHubPort 37 get_callbackCredentials YNetwork 70 get_callbackEncoding YNetwork 71 get_callbackMaxDelay YNetwork 72 get_callbackMethod YNetwork 73 get_callbackMinDelay YNetwork 74 get_callbackUrl YNetwork 75 get_discoverable YNetwork 76 get_enabled YHubPort 38 get_errorMessage YFiles 130 get_errorMessage YHubPort 39 get_errorMessage YNetwork 77 get_errorType YFiles 131 get_errorType YHubPort 40 get_errorType YNetwork 78 get_filesCount YFiles 132 get_freeSpace YFiles 133 get_friendlyName YFiles 134 get_friendlyName YHubPort 41 get_friendlyName YNetwork 79 get_functionDescriptor YFiles 135 get_functionDescriptor YHubPort 42 get_functionDescriptor YNetwork 80 get_functionid YFiles 136 get_functionid YHubPort 43 get_functionid YNetwork 81 get_hardwareld YFiles 137 get_hardwareld YHubPort 44 get_hardwareld YNetwork 82 get_ipAddress YNetwork 83 get_list YFiles 138 get_logicalName YFiles 139 get_logicalName YHubPort 45 get_logicalName YNetwork 84 get macAddress YNetwork 85 get_ module YFiles 140
47. Met en cache les valeurs courantes du port de Yocto hub avec une dur e de validit sp cifi e function load msValidity function load msValidity function load msValidity YRETCODE load int msValidity YRETCODE load int msValidity function load msValidity integer YRETCODE function load ByVal msValidity As Integer As YRETCODE YRETCODE load int msValidity int load long msValidity def 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 msValidity un entier correspondant la dur e de validit attribu e aux les param tres charg s en millisecondes Retourne YAPI_SUCCESS si l op ration se d roule sans erreur En cas d erreur d clenche une exception ou retourne un code d erreur n gatif www yoctopuce com 53 10 R f rence de l API de haut niveau hubport load_async YHubPort Met en cache les valeurs courantes du port de Yocto hub avec une dur e de validit sp cifi e function load_async msValidity callback context function load_async msValidity callback context Par d faut lorsqu on acc de un module tous les attributs des fonctions d
48. Password As String string get_adminPassword String get_adminPassword def get_adminPassword 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_TNVALTD www yoctopuce com 69 10 R f rence de l API de haut niveau network get_advertisedValue YNetwork network advertisedValue Retourne la valeur courante de l interface r seau pas plus de 6 caract res function get_advertisedValue function get_advertisedValue function get_advertisedValue string get_advertisedValue NSString advertisedValue function get_advertisedValue string function get_advertisedValue As String string get_advertisedValue String get_advertisedValue def get_advertisedValue YNetwork target get_advertisedValue Retourne une cha ne de caract res repr sentant la valeur courante de l interface r seau pas plus de 6 caract res En cas d erreur d clenche une exception ou retourne Y_ADVERTISEDVALUE INVALID 70 www yoctopuce com 10 R f rence de l API de haut niveau network get_callbackCredentials YNetwork network callbackCredentials Retourne une version hash e du laisser passer pour le callback de notification s il a t configur ou sinon une
49. SCR correspondant la fonction files get_functionid Retourne l identifiant mat riel du syst me de fichier sans r f rence au module files get_hardwareld 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 YModu le correspondant au module Yoctopuce qui h berge la fonction files get module async callback context Retourne l objet YModu le 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 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 nextFiles Continue l num ration des syst
50. YoctoHub Ethernet Mode d emploi Table des mati res mmh Introduction EE 1 Cresenkortrgg en di E 3 2 1 Les l ments du YoctoHub Ethernet 3 POUCES paS rte 7 3 1 Utilisation directe pour les impatients A 7 Tute Cd EE 8 3 3 Configuration automatis e iii 10 RE en Ee 11 Wil TEE 15 Ce E OCH e ENEE 15 4 2 Fixation d un sous module 16 Utilisation du YoctoHub Ethernet 17 5 1 Localisation des modules 17 52 Test des modules 5 58 ee met ne de et ne re nes 18 5 9 Configuration des 104065 18 5 4 Upgrades des firmwares sise 19 Contr le d acc s deeg 21 6 1 Acc s admin tee ET 22 6 2 ACC S User tee RE 22 6 3 ANE E R 5 API eege EEEE EE TE A E 22 6 4 Effacement des mots de passe 22 Interactions avec l ext rieur 55 555550550555555055555555555555 23 KEE GONTIQUrATION BEE 23 72 ET Ree E e EE 24 Tes YOGto APICallback EE 26 Toa Mul Inte 26 Programmation EE Ee 27 8 1 Acc s aux modules connect s aiaia a araa eaea 27 8 2 Contr le du YoctoHub Ethernet 27 9 Personnalisation de l interface Web 29 E DER UE te RO eme ne SU DE ee E ER
51. ace 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 62 www yoctopuce com 10 R f rence de l API de haut niveau network load msValidity Met en cache les valeurs courantes de l interface r seau avec une dur e de validit sp cifi e 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 nextNetwork Continue l num ration des interfaces r seau commenc e l aide de yFirstNetwork network ping host Ping str_host 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 _callbackMaxDelay newval Modifie l attente maximale entre deux notifications par callback en secondes network set _callbackMethod newval Modifie la m
52. acklpAddr int fallbackSubnetMaskLen String fallbackRouter def fallbacklpAddr fallbackSubnetMaskLen fallbackRouter YNetwork target useDHCP fallbacklpAddr 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 adresse utiliser si aucun serveur DHCP ne r pond fallbackSubnetMaskLen longueur 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 fallbackRouter adresse de la passerelle utiliser si aucun serveur DHCP ne r pond Retourne YAPI_SUCCESS si l op ration se d roule sans erreur En cas d erreur d clenche une exception ou retourne un code d erreur n gatif www yoctopuce com 119 10 R f rence de l API de haut niveau network useStaticiP YNetwork Modifie la configuration de l interface r seau pour utiliser une adresse IP assign e manuellement adresse IP statique function useStaticlP ipAddress subnetMaskLen router function useStaticlP ipAddress subnetMaskLen router function useStaticlP ipAddress subnetMaskLen router int useStaticlP string ipAddress int subnetMaskL
53. advertisedValue Retourne la valeur courante du port de Yocto hub pas plus de 6 caract res function get_advertisedValue function get_advertisedValue function get_advertisedValue string get_advertisedValue NSString advertisedValue function get_advertisedValue 1 string function get_advertisedValue As String string get_advertisedValue String get_advertisedValue def get_advertisedValue YHubPori target get_advertisedValue Retourne une cha ne de caract res repr sentant la valeur courante du port de Yocto hub pas plus de 6 caract res En cas d erreur d clenche une exception ou retourne Y_ADVERTISEDVALUE_ INVALID www yoctopuce com 37 10 R f rence de l API de haut niveau hubport get_baudRate YHubPort hubport baudRate Retourne la vitesse de transfert utilis e par le port de Yocto hub en kbps function get_baudRate function get_baudRate function get_baudRate int get_baudRate int baudRate _pas function get_baudRate Longint v function get_baudRate As Integer cs nt get baudRate int get_baudRate def get_baudRate 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_TNVALTD
54. al une 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 114 www yoctopuce com 10 R f rence de l API de haut niveau network set_secondaryDNS YNetwork network setSecondaryDNS Modifie l adresse IP du serveur nom secondaire que le module doit utiliser function set_secondaryDNS newval function set_secondaryDNS newval function set_secondaryDNS newval int set_secondaryDNS const string amp newval int setSecondaryDNS NSString newval function set_secondaryDNS newval string integer function set_secondaryDNS ByVal newval As String As Integer int set_secondaryDNS string newval int set_secondaryDNS String newval def set_secondaryDNS newval 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 newval une 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
55. assword newval 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 newval une 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 www yoctopuce com 117 10 R f rence de l API de haut niveau network set wwwWatchdogDelay YNetwork network setWwwWatchdogDelay 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 function set_wwwWatchdogDelay newval function set_wwwWatchdogDelay newval function set_wwwWatchdogDelay newval int set_wwwWatchdogDelay int newval int setWwwWatchdogDelay int newval _pas function set_wwwWatchdogDelay newval Longint integer vb function set wwwWatchdogDelay ByVal newval As Integer As Integer int set_wwwWatchdogDelay int newval int set_wwwWatchdogDelay int newval def set_wwwWatchdogDelay newval YNetwork target set_wwwWatchdogDelay newval Une valeur nulle d sactive le red marrage automatique en cas d
56. atif www yoctopuce com 107 10 R f rence de l API de haut niveau network set_callbackMaxDelay YNetwork network setCallbackMaxDelay Modifie l attente maximale entre deux notifications par callback en secondes function set_callbackMaxDelay newval function set_callbackMaxDelay newval function set_callbackMaxDelay newval int set_callbackMaxDelay int newval int setCallbackMaxDelay int newval function set_callbackMaxDelay newval Longint integer _vb function set_callbackMaxDelay ByVal newval As Integer As Integer int set_callbackMaxDelay int newval int set_callbackMaxDelay int newval def set_callbackMaxDelay newval YNetwork target set_callbackMaxDelay newval Param tres newval un entier repr sentant l attente maximale entre deux notifications 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 108 www yoctopuce com 10 R f rence de l API de haut niveau network set_callbackMethod YNetwork network setCallbackMethod Modifie la m thode HTTP utiliser pour signaler les changements d tat par callback function set_callbackMethod newval function set_callbackMethod newval function set_callbackMethod newval int set_callbackMethod CALLBACKMETHOD_enum newval int setCallbackMethod Y_CALLBACKMETHOD_enum newval fu
57. back 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 context contexte 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 88 www yoctopuce com 10 R f rence de l API de haut niveau network get_poeCurrent YNetwork network poeCurrent Retourne le courant consomm par le module depuis Power over Ethernet PoE en milliamp res function get_poeCurrent function get_poeCurrent function get_poeCurrent int get_poeCurrent int poeCurrent function get_poeCurrent Longint function get_poeCurrent As Integer int get_poeCurrent int get_poeCurrent def get_poeCurrent 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 en milliamp res En cas d erreur d clenche une exception ou retourne Y_POECURRENT_INVALTD www yoctopuce com 89 10 R f rence de l API de haut niveau network get_primaryDNS YNetwork network primaryDNS Retourne l adresse IP du serveur de noms primaire que le module doit utiliser function get_primary
58. cha ne vide function get_callbackCredentials function get_callbackCredentials function get_callbackCredentials string get_callbackCredentials NSString callbackCredentials function get_callbackCredentials string function get_callbackCredentials As String string get_callbackCredentials String get_callbackCredentials def get_callbackCredentials 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_CALILBACKCREDENTIALS_INVALTID www yoctopuce com 71 10 R f rence de l API de haut niveau network get_callbackEncoding YNetwork network callbackEncoding Retourne l encodage utiliser pour repr senter les valeurs notifi es par callback function get_callbackEncoding function get_callbackEncoding function get_callbackEncoding Y_CALLBACKENCODING_enum get_callbackEncoding Y_CALLBACKENCODING_enum callbackEncoding _pas function get_callbackEncoding Integer function get_callbackEncoding As Integer int get_callbackEncoding int get_callbackEncoding def get_callbackEncoding YNetwork target get_callbackEncoding Retourne une valeur parmi Y_CALLBACKENCODING_FORM Y_CALLBACKENCODING_JSON Y_CALLBACKENCODING_JSON_ARRAY Y_CALL
59. chiers 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 www yoctopuce com 139 10 R f rence de l API de haut niveau files get_logicalName YFiles files logicalName Retourne le nom logique du syst me de fichier function get_logicalName function get_logicalName function get_logicalName string get_logicalName NSString logicalName function get_logicalName string function get_logicalName As String string String get_logicalName def get_logicalName YFiles target get_logicalName Retourne une cha ne de caract res repr sentant le nom logique du syst me de fichier En cas d erreur d clenche une exception ou retourne Y_LOGICALNAME_ INVALTID 140 www yoctopuce com 10 R f rence de l API de haut niveau files get module YFiles files module Retourne l objet YModule correspondant au module Yoctopuce qui h berge la fonction function get_module function get module function get_module YModule get_module YModule module function get_module 1 TYModule function get_module As YModule YModule get_module YModule get_module def get module Si la fonction ne peut tre trouv e sur aucun module
60. cter 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 4 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 www yoctopuce com 11 3 Premiers pas 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 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 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 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
61. ction describe string describe NSString describe function describe string function describe As String string describe String describe def 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 sile module est d j connect ou Relay BadCustomeName relayl unresolved sile 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 relayli 68 www yoctopuce com 10 R f rence de l API de haut niveau network get_adminPassword YNetwork network 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 function get_adminPassword function get_adminPassword function get_adminPassword string get_adminPassword NSString adminPassword function get_adminPassword string function get_admin
62. cto Temperature configure wiew log file beacon af configure wiew log file beacon configure view log file beacon g Show device functions Configure de la premi re ligne www yoctopuce com 23 7 Interactions avec l ext rieur YHUBETH1 0F11C Edit parameters for device YHUBETH1 0F11C and click on the Save button Serial YHUBETH1 0F11C Product name YoctoHub Ethernet Firmware 12149 upgrade Logical name Luminosity II signal leds only Device functions Each function ofthe device has a physical name and a logical name You can change the logical name using the rename button YHUBETH1 0F11Cfiles rename User files 0 file 3728 KB available manage fies YHUBETH1 0F11C hubPort1 rename YHUBETH1 0F11C hubPort2 rename YHUBETH1 0F11C hubPort3 rename YHUBETH1 0F11C network YHUBETH1 0F11C rename Network configuration Device name YHUBETH1 0F11C IP addressing Automatic by DHCP current IP 172 17 17 72 Incoming connections Authentication to read information from the devices NO Authentication to make changes to the devices NO Outgoing callbacks Callback URL Let Callback method POST WW Fom Delay between callbacks min 3 5 mar 600 5 save Cancer Puis ditez la section Outgoing callbacks La fen tre de configuration des callbacks appara t Cette fen tr
63. 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 relayl Retourne une cha ne de caract res identifiant le port de Yocto hub en utilisant les noms logiques ex MyCustomName relayl En cas d erreur d clenche une exception retourne Y_FRIENDLYNAME_INVALID 42 www yoctopuce com 10 R f rence de l API de haut niveau hubport get_functionDescriptor YHubPort hubport functionDescriptor Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction function get_functionDescriptor function get_functionDescriptor function get_functionDescriptor YFUN_DESCR get_functionDescriptor YFUN_DESCR functionDescriptor function get_functionDescriptor 1 YFUN DESCH function get_functionDescriptor As YFUN DESCH YFUN_DESCR get_functionDescriptor String get_functionDescriptor def get_functionDescriptor Cet identifiant peut tre utilis pour tester si deux instance de YFunct ion 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 www yoctopuce com 43 10 R f rence de l API de haut niveau hubport get_functionid YHubPort hubport functionid Retourne l identifiant mat riel du port de Y
64. de js function remove pathname prp function pathname int remove string pathname int remove NSString pathname function remove pathname string Longint function remove As Integer int string pathname int remove String pathname def remove pathname YFiles target remove pathname 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 Tas 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 150 www yoctopuce com 10 R f rence de l API de haut niveau files set_logicalName files setLogicalName Modifie le nom logique du syst me de fichier function set_logicalName newval function set_logicalName newval function set_logicalName newval int set_logicalName const string amp newval int setLogicalName NSString newval function set_logicalName newval string integer function set_logicalName ByVal newval As String As Integer int set_logicalName
65. e changement d tat significatifs function get_callbackUrl function get_callbackUrl function get_callbackUrl string get_callbackUrl NSString callbackUrl function get_callbackUrl string function get_callbackUrl As String string get_callbackUrl String get_callbackUrl def get_callbackUrl YNetwork target get_callbackUrl Retourne une cha ne de caract res repr sentant l adresse URL de callback notifier lors de changement d tat significatifs En cas d erreur d clenche une exception ou retourne Y_CALLBACKURL_INVALID 76 www yoctopuce com 10 R f rence de l API de haut niveau network get_discoverable YNetwork network discoverable Retourne l tat d activation du protocole d annonce sur le r seau permettant de retrouver facilement le module protocols uPnP Bonjour function get_discoverable function get_discoverable function get_discoverable Y_DISCOVERABLE enum get_discoverable Y_DISCOVERABLE_ enum discoverable function get_discoverable 1 Integer function get_discoverable As Integer int get_discoverable int get_discoverable def get_discoverable 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 excepti
66. e 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 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 33 10 R f rence de l API de haut niveau YHubPort FindHubPort YHubPort yFindHubPort Permet de retrouver un port de Yocto hub d apr s un identifiant donn 1 e function yFindHubPort func node js function FindHubPort func ce function yFindHubPort func YHubPort yFindHubPort const string amp func YHubPort yFindHubPort NSString func function yFindHubPort func string TYHubPort function yFindHubPort ByVal func As String As YHubPort 1 cs YHubPort FindHubPort string func java YHubPort FindHubPort String func def FindHubPort func L identifiant peut tre sp cifi sous plusieurs formes e NomLogiqueFonction e NoSerieModule ldentifiantFonction e NoSerieModule NomLogiqueFonction e NomLog
67. e perte de connectivit WWW La plus petite dur e non nulle utilisable est 90 secondes Param tres newval 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 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 118 www yoctopuce com 10 R f rence de l API de haut niveau network useDHCP YNetwork Modifie la configuration de l interface r seau pour utiliser une adresse assign e automatiquement par le serveur DHCP function useDHCP fallbackipAddr fallbackSubnetMaskLen fallbackRouter function useDHCP fallbackipAddr fallbackSubnetMaskLen fallbackRouter function useDHCP SfallbackSubnetMaskLen fallbackRouter int useDHCP string fallbacklpAddr int fallbackSubnetMaskLen string fallbackRouter int useDHCP NSString int fallbackSubnetMaskLen NSString fallbackRouter function useDHCP fallbackipAddr string fallbackSubnetMaskLen Longint fallbackRouter string integer function useDHCP ByVal fallbacklpAddr As String ByVal fallbackSubnetMaskLen As Integer ByVal fallbackRouter As String As Integer int useDHCP string fallbacklpAddr int fallbackSubnetMaskLen string fallbackRouter int useDHCP String fallb
68. e port de Yocto hub disponibles www yoctopuce com 35 10 R f rence de l API de haut niveau hubport describe YHubPort Retourne un court texte d crivant le port de Yocto hub au format NAME SERIAL FUNCTIONID _is function describe node is function describe prp function describe string describe NSString describe function describe string function describe As String string describe String describe def 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 sile module est d j connect ou Relay BadCustomeName relayl unresolved sile 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 Relay MyCustomName relay1 RELAYLO1 123456 relayli 36 www yoctopuce com 10 R f rence de l API de haut niveau hubport get_advertisedValue YHubPort hubport
69. e va vous permettre de d finir comment votre YoctoHub Ethernet va pouvoir interagir avec un serveur Web externe Vous avez plusieurs type d interactions a votre disposition 7 2 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 This VirtualHub can post the advertised values of all devices on a specific URL on a regular basis If you wish to use this feature choose the callback type follow the steps below carefully 1 Specify the Type of callback you want to use Yocto APl callback zl Yoctopuce devices be controled through remote PHP scripts That Yocto AP callback protocol is designed so it can pass trough NAT filters without opening ports See your device user manual PHP programming section for more details 2 Specify the URL to use for reporting values HTTPS protocol is not yet supported Callback URL http ff 3 If your callback requires authentication enter credentials here Digest authentication is recommended but Basic authentication works as well Username D Password 4 Setup the desired frequency of notifications No less than 15 seconds between two notification But notify after 600 seconds in any case
70. elay Retourne l attente minimale entre deux notifications par callback en secondes network get_callbackUrl Retourne l adresse URL de callback notifier lors de changement d tat significatifs 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 www yoctopuce com 61 10 R f rence de l API de haut niveau 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_friendiyName 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_DE SCR correspondant la fonction network get_functionid Retourne l identifiant mat riel de l interface r seau sans r f rence au module network get_hardwareld Retourne l identifiant mat riel unique de l interface r seau au format SERIAL FUNCTIONID network get_ipAddress Retourne l adresse IP utilis e par le module Yoctopuce 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
71. ement utiliser des fonctions synchrones ou asynchrones sans risquer de bloquer la machine virtuelle Javascript Param tres callback fonction 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 context contexte fourni par l appelant et qui sera pass tel quel la fonction de callback Retourne rien du tout www yoctopuce com 121 10 R f rence de l API de haut niveau 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 lt script type text javascript src yocto_files js gt lt script gt var yoctolib require yoctolib var YFiles yoctolib YFiles require_oncel yocto_files php include yocto_files h import yocto_files h uses yocto_files yocto_files vb _files cs import com yoctopuce YoctoAPI YFiles from yocto_files import Fonction globales yFindFiles func Permet de retrouver un syst me de fichier d apr s un identifiant donn yFirstFiles Commence l num ration des syst me de fichier acces
72. en string router int useStaticlP NSString ipAddress int subnetMaskLen NSString router function useStaticlP ipAddress string subnetMaskLen Longint router string integer function useStaticlP ByVal ipAddress As String ByVal subnetMaskLen As Integer ByVal router As String As Integer int useStaticIP string ipAddress int subnetMaskLen string router int useStaticlP String ipAddress int subnetMaskLen String router def useStaticlP ipAddress subnetMaskLen router YNetwork target useStaticlP ipAddress subnetMaskLen router N oubliez pas d appeler la m thode saveToFlashi et de red marrer le module pour que le param tre soit appliqu Param tres ipAddress adresse IP utiliser par le module subnetMaskLen longueur du masque de sous r seau 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 120 www yoctopuce com 10 R f rence de l API de haut niveau network wait_async YNetwork 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 function wait_async callback context function wait_async callback context La fonction callback peut donc libr
73. es upload YFiles T l charge un contenu vers le syst me de fichier au chemin d acc s sp cifi function upload pathname content function upload pathname content function upload pathname content int upload string pathname string content int upload NSString pathname NSData content function upload pathname string content TByteArray Longint procedure upload int upload string pathname int upload String pathname def upload pathname content YFiles target upload pathname content Si un fichier existe d j pour le m me chemin d acc s son contenu est remplac 2 Param tres complet du fichier y compris le chemin d acc s content contenu du fichier t l charger Retourne YAPI_SUCCESS si l op ration se d roule sans erreur En cas d erreur d clenche une exception ou retourne un code d erreur n gatif www yoctopuce com 153 10 R f rence de l API de haut niveau files wait YFiles 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 function wait_async callback context function wait_async callback context La fonction callback peut donc librement utiliser des fonctions synchrones asynchrones sans risquer de bloquer la machine virtuelle Javascript Param tres callback fonction de callback qui sera appel e d
74. et 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_INVALTID 134 www yoctopuce com 10 R f rence de l API de haut niveau files get_friendilyName YFiles files friendiyName Retourne un identifiant global du syst me de fichier au format NOM_MODULE NOM_FONCTION function get_friendlyName function get_friendiyName function get_friendlyName string get_friendlyName NSString friendlyName string get_friendlyName String get_friendlyName def 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 relayl Retourne une cha ne de caract res identifiant le syst me de fichier en utilisant les noms logiques ex MyCustomName relayl cas d erreur d clenche une exception ou retourne Y_FRIENDLYNAME_INVALID www yoctopuce com 135 10 R f rence de l API de haut niveau files get_functionDescriptor YFiles files functionDescriptor Retourne un identifiant unique de type YFUN_DE SCR correspondant la fonction function get_functionDescriptor function get_functionDescriptor functio
75. evez d abord vous procurer le firmware il peut tre t l charg depuis la page produit du module sur le site de Yoctopuce L interface propose aussi un lien direct si elle d tecte que le firmware n est pas our 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 Firmware update E Choose a file for your YCTOPOC1 00C4D device then click on upload File to upload Browse file selected S Upload Cancel 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 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
76. face r seau pour utiliser une adresse assign e automatiquement par le serveur DHCP network useStaticlP ipAddress subnetMaskLen router www yoctopuce com 63 10 R f rence de l API de haut niveau 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 64 www yoctopuce com 10 R f rence de l API de haut niveau YNetwork FindNetwork yFindNetwork Permet de retrouver une interface r seau d apr s un identifiant donn function yFindNetwork func function FindNetwork func function yFindNetwork func YNetwork yFindNetwork const string amp func YNetwork yFindNetwork NSString func function yFindNetwork func string TYNetwork function yFindNetwork ByVal func As String As YNetwork YNetwork FindNetwork string func YNetwork FindNetwork String func def FindNetwork func L identifiant peut tre sp cifi sous plusieurs formes e NomLogiqueFonction NoSerieModule ldentifiantFonction e NoSerieModule NomLogiqueFonction e NomLogiqueModule ldentifiantMat riel e NomLogiqueModule NomLogiqueFonction Cette fonction n exige pas que l interface r seau soit en ligne au moment YNetwork ou elle est appel e l objet retourn
77. ha 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 106 www yoctopuce com 10 R f rence de l API de haut niveau network set_callbackEncoding YNetwork network setCallbackEncoding Modifie l encodage utiliser pour repr senter les valeurs notifi es par callback function set_callbackEncoding newval function set_callbackEncoding newval function set_callbackEncoding newval int set_callbackEncoding newval int setCallbackEncoding Y_CALLBACKENCODING_enum newval function set_callbackEncoding newval Integer integer function set_callbackEncoding ByVal newval As Integer As Integer int set_callbackEncoding int newval int set_callbackEncoding int newval def set_callbackEncoding newval YNetwork target set_callbackEncoding newval Param tres newval une valeur parmi Y_CALLBACKENCODING_FORM Y_CALLBACKENCODING_JSON Y_CALLBACKENCODING_JSON_ARRAY Y_CALLBACKENCODING_ CSV et Y_CALLBACKENCODING_YOCTO_APT 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 g
78. ications importantes pour utiliser votre module YoctoHub Ethernet 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 www yoctopuce com 15 4 Montage 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 si
79. ification et sauvegarde un laisser passer pour s y connecter function callbackLogin username password function callbackLogin username password function callbackLogin username password int callbackLogin string username string password int callbackLogin NSString username NSString password function callbackLogin username string password string integer function callbackLogin ByVal username As String ByVal password As String As Integer int callbackLogin string username string password int callbackLogin String username String password def callbackLogin username password YNetwork target callbackLogin username password YNetwork 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 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 67 10 R f rence de l API de haut niveau network describe YNetwork Retourne un court texte d crivant l interface r seau au format NAME SERIAL FUNCTIONID function describe node is function describe prp fun
80. iqueModule ldentifiantMat riel e NomLogiqueModule NomLogiqueFonction Cette fonction n exige pas que le port de Yocto hub soit en ligne au moment ou elle est appel e l objet retourn sera n anmoins valide Utiliser la m thode YHubPort isOnline pour tester si le port de Yocto hub est utilisable un moment donn En cas d ambigu t lorsqu on fait une recherche par nom logique aucune erreur ne sera notifi e la premi re instance trouv e sera renvoy e La recherche se fait d abord par nom mat riel puis par nom logique Param tres func une 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 34 www yoctopuce com 10 R f rence de l API de haut niveau YHubPort FirstHubPort YHubPort yFirstHubPort Commence l num ration des port de Yocto hub accessibles par la librairie function yFirstHubPort function FirstHubPort function yFirstHubPort YHubPort yFirstHubPort YHubPort yFirstHubPort function yFirstHubPort TYHubPort function yFirstHubPort As YHubPort YHubPort FirstHubPort YHubPort FirstHubPort def FirstHubPort Utiliser la fonction YHubPort nextHubPort pour it rer sur les autres port de Yocto hub Retourne un pointeur sur un objet YHubPort correspondant le premier port de Yocto hub accessible en ligne ou null siil n y a pas d
81. irmware charg sur le module est incomplet ou corrompu La Yocto Led En temps normal la Yocto Led sert indiquer le bon fonctionnement du module elle met alors une faible lumi re bleue qui varie lentement mimant ainsi une respiration La Yocto Led cesse de respirer lorsque le module ne communique plus par exemple s il est aliment par un hub sans connexion avec un ordinateur allum Lorsque vous appuyez sur le Yocto bouton la Led passe en mode Yocto balise elle se met alors flasher plus vite et beaucoup plus fort dans le but de permettre une localisation facile d un module lorsqu on en a plusieurs identiques Il est en effet possible de d clencher la Yocto balise par logiciel tout comme il est possible de d tecter par logiciel une Yocto balise allum e La Yocto Led a une troisi me fonctionnalit moins plaisante lorsque le logiciel interne qui contr le le module rencontre une erreur fatale elle se met flasher SOS en morse Dans ce cas d branchez puis re branchez le module Si le probl me venait se reproduire v rifiez que le module contient bien la derni re version du firmware et dans l affirmative contactez le support Yoctopuce Le connecteur de contr le et d alimentation Power Control port Ce connecteur permet d alimenter le YoctoHub 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 exac
82. ise 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 www yoctopuce com 31 10 R f rence de l API de haut niveau 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 lt script type text javascript src yocto_hubport js gt lt script gt var yoctolib require yoctolib var
83. it 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 callback fonction 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 context contexte 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 www yoctopuce com 99 10 R f rence de l API de haut niveau network load YNetwork Met en cache les valeurs courantes de l interface r seau avec une dur e de validit sp cifi e _is function load msValidity nodejs function load msValidity prp function load msValidity YRETCODE load int msValidity YRETCODE load int msValidity function load msValidity integer YRETCODE function load ByVal msValidity As Integer As YRETCODE YRETCODE load int msValidity int load long msValidity def 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 po
84. l tat actuel du port de Yocto hub YHubPort En cas d erreur d clenche une exception ou retourne Y_PORTSTATE_INVALTID www yoctopuce com 49 10 R f rence de l API de haut niveau hubport get_userData YHubPort hubport userData Retourne le contenu de l attribut userData pr c demment stock l aide de la m thode set_userData function get_userData function get_userData function get_userData void get_userData void userData function get_userData Tobject function get_userData As Object object get_userData Object get_userData def 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 50 www yoctopuce com 10 R f rence de l API de haut niveau hubport isOnline YHubPort V rifie si le module h bergeant le port de Yocto hub est joignable sans d clencher d erreur function isOnline node js function isOnline function isOnline bool isOnline BOOL isOnline function isOnline boolean function isOnline As Boolean bool isOnline boolean isOnline def 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 po
85. l name Luminosity f signal leds only Device functions Each function ofthe device has a physical and logical name You can change the logical name using the rename button YHUBETH1 0F11Cfiles rename User files 0 file 3728 KB available manage fies YHUBETH1 0F11C hubPort1 YHUBETH1 0F11C hubPort2 rename YHUBETH1 0F11C hubPort3 rename YHUBETH1 0F11C network YHUBETH1 0F11C rename Network configuration Device name YHUBETH1 0F11C IP addressing Automatic by DHCP current IP 172 17 17 72 Incoming connections Authentication to read information from the devices NO Authentication to make changes to the devices NO Outgoing callbacks Callback URL est Callback method POST WWW Form Delay between callbacks min 3 5 max 600 s Save SEN La fen tre de configuration du YoctoHub Ethernet 21 6 Contr le d acc s Ce contr le d acc s est contr l depuis la section Incoming connections 1 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
86. 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 3 Ne faites jamais confiance des gens qui vous disent que leur logiciel n a pas de bug 4 Www yoctopuce com 5 condition qu elle ait r ussi acc der au site Web de Yoctopuce www yoctopuce com 19 20 WWW 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 Serial Logical Name Description Action 0 YoctoHub Ethernet configure wiew log file beacon ES RELAYHI1 002C8 Yocto PowerRelay configure view log file beacon THPSENS1 0546E Yocto Temperature configure wiew log file beacon Let LH Show device functions 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 YHUBETH1 0F11C Edit parameters for device YHUBETH1 0F11C and click on the Save button Serial YHUBETH1 0F11C Product name YoctoHub Ethernet Firmware 12149 upgrade Logica
87. les 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 e upload vous permet de cr er un nouveau fichier sur le module dont vous fournissez le contenu get list vous permet de conna tre la liste de fichier pr sents sur le module compris la taille et le CRC32 du contenu download vous permet de le r cup rer dans une variable le contenu d un fichier pr sent sur le module remove permet d effacer un fichier du module e format permet de r initialiser le syst me de fichiers un tat vide non fragment Un programme utilisant le syst me de fichier bien con u devrait toujours commencer par s assurer que les fichiers n cessaires son fonctio
88. mme 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 12 www yoctopuce com 3 Premiers pas 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 entretoises et d un connecteur au pas 1 27mmf 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 le p riph rique 5 http www yoctopuce com FR products accessoires et connectique fix 2 5mm 6 http www yoctopuce com FR products accessoires et connectique board2board 127 www yoctopuce com 13 14 WWW 4 Ce chapitre fournit des expl
89. mple 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 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
90. n Yocto PowerRelay configure view log file beacon 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 YNetwor k disponible dans la librairie de programmation en ligne de commande Apr s avoir effectu un changement de r glage par programmation prenez garde appeler la fonction saveToFlash pour vous assurez que les r glages soient sauv s de mani re permanente dans la m moire flash du module 3 http www yoctopuce com FR libraries php 10 www yoctopuce com 3
91. n get_functionDescriptor YFUN_DESCR get_functionDescriptor YFUN_DESCR functionDescriptor function get_functionDescriptor YFUN_DESCR function get_functionDescriptor As YFUN DESCH YFUN_DESCR get_functionDescriptor String get_functionDescriptor def get_functionDescriptor Cet identifiant peut tre utilis pour tester si deux instance de YFunct ion 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 136 www yoctopuce com 10 R f rence de l API de haut niveau files get_functionid YFiles files functionid Retourne l identifiant mat riel du syst me de fichier sans r f rence au module function get_functionlid function get_functionid function get_functionld string get_functionid NSString functionld function get_functionld As String string get_functionid String get_functionld def get_functionid Par example relay1 Retourne une cha ne de caract res identifiant le syst me de fichier 1 1 En cas d erreur d clenche une exception ou retourne Y_FUNCTIONID_INVALID www yoctopuce com 137 10 R f rence de l API de haut niveau files get_hardwareld YFiles files hardwareld Retourne l identifiant mat riel unique du syst me de fichier au format SERIAL
92. nchrone 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 msValidity un entier correspondant la dur e de validit attribu e aux les param tres charg s millisecondes callback fonction 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 context contexte 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 www yoctopuce com 147 10 R f rence de l API de haut niveau files nextFiles YFiles Continue l num ration des syst me de fichier commenc e l aide de yFirstFiles _is function nextFiles node js function nextFiles php function nextFiles YFiles nextFiles YFiles nextFiles function nextFiles TYFiles function nextFiles As YFiles YFiles nextFiles YFiles nextFiles def nextFiles lt lt x Retourne un pointeur sur un objet YF i les accessible en ligne ou nul 1 lorsque l num ration est termin e 148 www yoctopuce com 10 R f rence de l API de haut niveau files register ValueCallback YFiles
93. nction set_callbackMethod newval Integer integer function set_callbackMethod ByVal newval As Integer As Integer int set_callbackMethod int newval int set_callbackMethod int newval def set_callbackMethod newval YNetwork target set_callbackMethod newval Param tres newval 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 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 109 10 R f rence de l API de haut niveau network set_callbackMinDelay YNetwork network setCallbackMinDelay Modifie l attente minimale entre deux notifications par callback en secondes function set_callbackMinDelay newval function set_callbackMinDelay newval function set_callbackMinDelay newval int set_callbackMinDelay int newval int setCallbackMinDelay int newval function set_callbackMinDelay newval Longint integer _vb function set_callbackMinDelay ByVal newval As Integer As Integer int set_callbackMinDelay int newval int set_callbackMinDelay int newval def set_callbackMinDelay newval YNetwork target set_callbackMinDelay newval Param tres newval un entier repr sentant l attente minimale entre deux notifications par callback en secondes
94. 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 1 http www yoctopuce com FR virtualhub php 2 support yoctopuce com www yoctopuce com WWW 2 Pr sentation am 1 Port USB 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 gt 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 m
95. nnement 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 www yoctopuce com 29 9 Personnalisation de l interface Web 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 9 2 Limitations Le filesystem embarqu sur votre Yoc
96. nt un pointeur nul 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 104 www yoctopuce com 10 R f rence de l API de haut niveau network set_adminPassword YNetwork network setAdminPassword 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 function set_adminPassword newval function set_adminPassword newval function set_adminPassword newval int set_adminPassword const string amp newval int setAdminPassword NSString newval function set_adminPassword newval string integer function set_adminPassword ByVal newval As String As Integer int set_adminPassword string newval int set_adminPassword String newval def set_adminPassword newval 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 newval une 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
97. octo hub sans r f rence au module function get_functionid function get_functionid function get_functionid string get_functionid NSString functionld vo function get_functionid As String string get_functionid String get_functionld def get_functionld 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 44 www yoctopuce com 10 R f rence de l API de haut niveau hubport get_hardwareld YHubPort hubport hardwareld Retourne l identifiant mat riel unique du port de Yocto hub au format SERIAL FUNCTIONTD function get_hardwareld function get_hardwareld function get_hardwareld string get_hardwareld NSString hardwareld function get_hardwareld As String string get_hardwareld String get_hardwareld def get_hardwareld 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 01 123456 1 1 Retourne une cha ne de caract res identifiant le port de Yocto hub ex RELAYLO1 123456 relayl En cas d erreur d clenche une exception ou retourne Y_HARDWAREID_INVALID www yoctopuce com 45 10 R f rence de l API de haut niveau hubport get_logicalName YHubPort hubport logicalName Retourne le
98. octoHub Ethernet d tect sur le r seau par un Mac 3 2 Configuration manuelle Si vous devez utiliser une configuration r seau particuli re 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 Vous aurez besoin d un c ble USB A MicroB Raccordez aussi votre YoctoHub Ethernet un c ble r seau op rationnel Ethernet VirtualHub EC Configuration raccordez par USB votre YoctoHub Ethernet un ordinateur H d USB 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 Serial Logical Name Description Action VIRTHUEO 6 8048 VirtualHub configure view log file sl YHUBETH1 OCAAC YoctoHub Ethernet configure view log file beacon Liste des modules Yoctopuce raccord s par USB votre ordinateur dont votre YoctoHub Ethernet Show device functions 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 1 http www yoctopuce com FR irtualhub php 2 Sauf Opera 8 www yoctopuce com 3 P
99. octopuce com 10 R f rence de l API de haut niveau files download YFiles T l charge le fichier choisi du filesyst me et retourne son contenu function download pathname function download pathname function download pathname string download string pathname NSData download NSString pathname function download pathname string TByteArray function download As Byte def download pathname YFiles target download pathname 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 127 10 R f rence de l API de haut niveau files download YFiles Proc de au chargement du bloc suivant de mesures depuis l enregistreur de donn es du module de mani re asynchrone function download_async pathname callback context function download_async pathname callback context Param tres pathname nom complet du fichier charger y compris le chemin d acc s callback fonction 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 f
100. odules 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 www yoctopuce com 2 Pr sentation 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 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 f
101. on hubport get_functionid Retourne l identifiant mat riel du port de Yocto hub sans r f rence au module hubport get_hardwareld Retourne l identifiant mat riel unique du port de Yocto hub au format SERTAL FUNCTIONID hubport get_logicalName 32 www yoctopuce com 10 R f rence de l API de haut niveau Retourne le nom logique du port de Yocto hub hubport get_ module Retourne l objet YModu le correspondant au module Yoctopuce qui h berge la fonction hubport get module async callback context Retourne l objet YModu le 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 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 nextHubPort Continue l num ration des port de Yocto hub commenc e l aid
102. on ou retourne Y_DISCOVERABLE_TNVALTID www yoctopuce com 77 10 R f rence de l API de haut niveau network get_errorMessage YNetwork network errorMessage Retourne le message correspondant la derni re erreur survenue lors de l utilisation de l interface r seau function get_errorMessage function get_errorMessage function get_errorMessage string get_errorMessage NSString errorMessage function get_errorMessage string function get_errorMessage As String string get_errorMessage String get_errorMessage def 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 78 www yoctopuce com 10 R f rence de l API de haut niveau network get_errorType YNetwork network errorType Retourne le code d erreur correspondant la derni re erreur survenue lors de l utilisation de l interface r seau function get_errorType function get_errorType function get_errorType YRETCODE get_errorType function get_errorType YRETCODE function get_errorType As YRETCODE YRETCODE int get def get Cette m thode est principalement utile lo
103. orme d objet binaire context variable de contexte disposition de l utilisateur Retourne rien 128 www yoctopuce com 10 R f rence de l API de haut niveau files format Tei R tabli le syst me de fichier dans on tat original d fragment function format Tei function format_fs function format_fs int format Tei int format Te function format Tei 1 Longint function format Tei As Integer int format Tei int format Tei def format Tei YFiles target format Te YFiles 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 129 10 R f rence de l API de haut niveau files get_advertisedValue YFiles files advertisedValue Retourne la valeur courante du syst me de fichier pas plus de 6 caract res function get_advertisedValue function get_advertisedValue function get_advertisedValue string get_advertisedValue NSString advertisedValue function get_advertisedValue string function get_advertisedValue As String string get_advertisedValue String get_advertisedValue def get_advertisedValue YFiles target get_advertisedValue Retourne une cha ne de caract res repr sentant la valeur courante du syst me de fichier
104. orrespondant au message de la derni re erreur qui s est produit lors de l utilisation du port de Yocto hub 40 www yoctopuce com 10 R f rence de l API de haut niveau hubport get_errorType YHubPort hubport errorType Retourne le code d erreur correspondant la derni re erreur survenue lors de l utilisation du port de Yocto hub function get_errorType function get_errorType function get_errorType YRETCODE get_errorType function get_errorType YRETCODE function get_errorType As YRETCODE YRETCODE int get def get Cette m thode est principalement utile lorsque la librairie Yoctopuce est utilis e 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 www yoctopuce com 41 10 R f rence de l API de haut niveau hubport get_friendlyName YHubPort hubport friendlyName Retourne un identifiant global du port de Yocto hub au format NOM_ MODULE NOM_FONCTION function get_friendlyName function get_friendiyName function get_friendlyName string get_friendlyName NSString friendlyName string get_friendiyName String get_friendlyName def get_friendlyName Le cha ne retourn e utilise soit les noms logiques du module et du port de Yocto hub si ils sont
105. qui peut tre au connecteur dorsal du YoctoHub Ethernet pour y brancher quatre modules suppl mentaires 4 www yoctopuce com 2 Pr sentation 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 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 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 pou
106. r seau au format SERIAL FUNCTIONID function get_hardwareld function get_hardwareld function get_hardwareld string get_hardwareld NSString hardwareld function get_hardwareld As String string get_hardwareld String get_hardwareld def get_hardwareld 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 01 123456 1 1 Retourne une cha ne de caract res identifiant l interface r seau ex RELAYLO1 123456 relayl En cas d erreur d clenche une exception ou retourne Y_HARDWAREID_INVALID www yoctopuce com 83 10 R f rence de l API de haut niveau network get_ipAddress YNetwork network ipAddress Retourne l adresse IP utilis e par le module Yoctopuce function function get_ipAddress function get_ipAddress string NSString ipAddress function get_ipAddress string function get_ipAddress As String string String get_ipAddress def get_ipAddress 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 utilis e par le module Yoctopuce En cas d erreur d clenche une exception ou retourne Y_TPADDRESS_INVALTID
107. r 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 2 ou une consommation sup rieure 1 8A sur le 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 www yoctopuce com 5 WWW 3 Premiers as 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 L adresse IP est obtenue par DHCP Si aucun serveur DHCP r pond il utilisera une adresse d auto config
108. re 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 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 1 http www yoctopuce com FR virtualhub php 22 www yoctopuce com 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 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 Serial 0 RELAYHI1 THP SENS1 0546E A Logical Name Cliquez sur le bouton Description Action YoctoHub Ethernet Yocto PowerRelay Yo
109. remiers pas YHUBETH1 0F11C Edit parameters for device YHUBETH1 0F11C and click the Save button Serial YHUBETH1 0F11C Product name YoctoHub Ethernet Firmware 12149 Guns Logical name Luminosity D signal leds only Device functions Each function ofthe device has a physical name and a logical name You can change the logical name using the rename button YHUBETH1 0F11C files User files 0 file 3728 KB available YHUBETH1 0F11ChubPort1 YHUBETH1 0F11ChubPort2 YHUBETH1 0F11C hubPort3 YHUBETH1 0F11C network YHUBETH1 0F11C Network configuration Device name YHUBETH1 0F11C IP addressing Automatic by DHCP C2 current IP 172 17 17 72 Incoming connections Authentication to read information from the devices NO Authentication to make changes to the devices NO Outgoing callbacks Callback URL Callback method POST MWWW Form Delay between callbacks min 3 5 max 600 5 Fen tre de configuration du module YoctoHub Ethernet Vous pouvez alors 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
110. retrouver facilement le module protocols uPnP Bonjour function set_discoverable newval function set_discoverable newval function set_discoverable newval int set_discoverable Y DISCOVERABLE_enum newval int setDiscoverable Y_DISCOVERABLE_enum newval function set_discoverable newval Integer integer vb function set_discoverable ByVal newval As Integer As Integer int set_discoverable int newval int set_discoverable int newval def set_discoverable newval YNetwork target set_discoverable newval Param tres newval 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 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 112 www yoctopuce com 10 R f rence de l API de haut niveau network set_logicalName network setLogicalName Modifie le nom logique de l interface r seau function set_logicalName newval function set_logicalName newval function set_logicalName newval int set_logicalName const string amp newval int setLogicalName NSString newval function set_logicalName newval string integer function set_logicalName ByVal newval As String As Integer int set_logicalName string newval int
111. rguments l object fonction dont la valeur a chang et la cha ne de caract re d crivant la nouvelle valeur publi e 56 www yoctopuce com 10 R f rence de l API de haut niveau hubport set_enabled hubport setEnabled Modifie le mode d activation du port du Yocto hub function set_enabled newval function set_enabled newval function set_enabled newval int set_enabled Y ENABLED_enum newval int setEnabled newval function set_enabled newval Integer integer function set_enabled ByVal newval As Integer As Integer int set_enabled int newval int set_enabled int newval def set_enabled newval YHubPort target set_enabled newval YHubPort Si le port est actif il sera aliment Sinon l alimentation du module est coup e Param tres Yocto hub Retourne YAPI_SUCCESS si l op ration se d roule sans erreur newval soit Y_ENABLED_ FALSE soit Y_ENABLED_ TRUE selon le mode d activation du port du En cas d erreur d clenche une exception ou retourne un code d erreur n gatif www yoctopuce com 57 10 R f rence de l API de haut niveau hubport set_logicalName YHubPort hubport setLogicalName Modifie le nom logique du port de Yocto hub function set_logicalName newval function set_logicalName newval function set_logicalName newval int set_logicalName const string amp newval int setLogicalName NSS
112. rsque la librairie Yoctopuce est utilis e 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 www yoctopuce com 79 10 R f rence de l API de haut niveau network get_friendlyName YNetwork network friendiyName Retourne un identifiant global de l interface r seau au format NOM_MODULE NOM_FONCTION function get_friendlyName function get_friendiyName function get_friendlyName string get_friendlyName NSString friendlyName string get_friendiyName String get_friendlyName def 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 exemple MyCustomName relayl Retourne une cha ne de caract res identifiant l interface r seau en utilisant les noms logiques ex MyCustomName relayl En cas d erreur d clenche une exception ou retourne Y_FRIENDLYNAME_INVALID 80 www yoctopuce com 10 R f rence de l API de haut niveau network get_functionDescriptor YNetwork network functionDescriptor Retourne un identifiant unique de type YFUN_DESCR correspondant la fonction function get_functionDescriptor function get_functionDescriptor
113. s sont post es sous une des formes suivantes 1 Si un nom logique a t d fini pour une fonction E UR T NOM LOGIQUE DE LA FONCTION VALI 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 lt php erine Date ER foreach POST as key gt value Print key value r n gt Callback log Here is the server response after a callback URL call Check it works as expected If if does not edit the file on your web server and test again 11 39 29 RELAYHI1 00055 relay1 A TMPSENS1 05E7F dataLogger OFF TMPSENS1 05E7F temperature 25 3 Connection closed Test ciose Le r sultat du test de callback avec un Yocto PowerRelay et un Yocto Temperature Les valeurs notifi es sont celles que vous voyez quand vous cliquez sur show functions dans l interface principale du YoctoHub Ethernet www yoctopuce com 25 7 Interactions avec l ext rieur 7 3 Yocto APl callback L API Yoctopuce PHP est capable de fonctionner en mode callback Dans ce mode un script PHP peut prendre le contr le de vos modules
114. sibles par la librairie M thodes des objets YFiles files describe Retourne un court texte d crivant le 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 format Tei 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 122 www yoctopuce com 10 R f rence de l API de haut niveau Retourne un identifiant unique de type YFUN_DE
115. sous plusieurs formes e NomLogiqueFonction e NoSerieModule IdentifiantFonction e NoSerieModule NomLogiqueFonction e NomLogiqueModule ldentifiantMat riel e NomLogiqueModule NomLogiqueFonction Cette fonction n exige pas que le syst me de fichier soit en ligne au moment ou elle est appel e l objet retourn sera n anmoins valide Utiliser la m thode YFiles isOnline pour tester si le syst me de fichier est utilisable un moment donn En cas d ambigu t lorsqu on fait une recherche par nom logique aucune erreur ne sera notifi e la premi re instance trouv e sera renvoy e La recherche se fait d abord par nom mat riel puis par nom logique Param tres func une cha ne de caract res qui r f rence le syst me de fichier sans ambigu t Retourne un objet de classe YF iles qui permet ensuite de contr ler le syst me de fichier 124 www yoctopuce com 10 R f rence de l API de haut niveau YFiles FirstFiles YFiles yFirstFiles Commence l num ration des syst me de fichier accessibles par la librairie function yFirstFiles nodejs function FirstFiles function yFirstFiles YFiles yFirstFiles YFiles yFirstFiles function yFirstFiles TYFiles function yFirstFiles As YFiles YFiles FirstFiles YFiles FirstFiles def FirstFiles Utiliser la fonction YFiles nextFiles pour it rer sur les autres syst me de fichier Retourne un pointeur sur un
116. st me de fichier est joignable sans d clencher d erreur function isOnline_async callback context 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 callback fonction 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 context contexte 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 www yoctopuce com 145 10 R f rence de l API de haut niveau files load YFiles Met en cache les valeurs courantes du syst me de fichier avec une dur e de validit sp cifi e _is function load msValidity nodejs function load msValidity prp function load msValidity YRETCODE load int msValidity YRETCODE load int msValidity function load msValidity
117. t_callbackMethod Integer v _ function get_callbackMethod As Integer int get_callbackMethod int get_callbackMethod def get_callbackMethod YNetwork target get_callbackMethod Retourne une valeur parmi Y_CALLBACKMETHOD_ POST Y_CALLBACKMETHOD_GET et Y_CALLBACKMETHOD_ 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_CALILBACKMETHOD_INVALTD 74 www yoctopuce com 10 R f rence de l API de haut niveau network get_callbackMinDelay YNetwork network callbackMinDelay Retourne l attente minimale entre deux notifications par callback en secondes function get_callbackMinDelay function get_callbackMinDelay function get_callbackMinDelay int get_callbackMinDelay int callbackMinDelay function get_callbackMinDelay 1 Longint function get_callbackMinDelay As Integer int get_callbackMinDelay int get_callbackMinDelay def get_callbackMinDelay YNetwork target get_callbackMinDelay Retourne un entier repr sentant l attente minimale entre deux notifications par callback en secondes En cas d erreur d clenche une exception ou retourne Y_CALILBACKMINDELAY_TNVALTD www yoctopuce com 75 10 R f rence de l API de haut niveau network get_callbackUri YNetwork network callbackUrl Retourne l adresse URL de callback notifier lors d
118. teint 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 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_TINVALTID www yoctopuce com 91 10 R f rence de l API de haut niveau network get_router YNetwork network router Retourne l adresse IP du routeur passerelle utilis par le module default gateway function get_router nodeis function get_router erp _ function get_router string get_router
119. tement 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 Les ports descendants Vous pouvez connecter jusqu trois modules Yoctopuce sur ces ports 115 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 Si vous d sirez brancher plus de trois modules Yoctopuce utilisez le connecteur dorsal 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 1 court court court long long long court court court 2 support yoctopuce com 3 Le Micro USB Hub fabriqu par Yoctopuce est un hub USB standard et ne fonctionnera pas avec le YoctoHub Ethernet 4 Vous trouverez tr s prochainement sur le site de Yoctopuce un produit YoctoHub Shield
120. toHub Ethernet a quelques limitations techniques Son espace de stockage maximal est 3 5Mo r partis en blocs permettant de stocker jusqu environ 800 fichiers L effacement d un fichier ne r cup re pas n cessairement imm diatement la totalit de la place utilis e par le fichier L espace non lib r sera enti rement r utilis si l on recr e un fichier du m me nom mais pas forc ment si l on cr e des fichiers utilisant chaque fois des noms diff rents Pour cette raison il n est pas recommand de g n rer automatiquement des fichiers avec des noms toujours diff rents L espace non lib r peut tre enti rement r cup r avec la commande format qui lib re la totalit des fichiers Chaque mise jour du firmware provoque implicitement un formattage complet du filesystem Comme toutes les m moires flash la m moire utilis e pour stocker les fichiers a une dur e de vie de 100 000 cycles d effacement environ C est assez mais ce n est pas illimit Prenez donc garde ne pas crire et effacer inutilement des fichiers en boucle tr s rapidement sous peine de d truire votre module 30 www yoctopuce com 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 c
121. tring newval function set_logicalName newval string integer function set_logicalName ByVal newval As String As Integer int string newval int String newval def set_logicalName newval 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 newval une cha ne de caract res repr sentant le nom logique du port de Yocto hub Retourne YAPI_ SUCCESS si l appel se d roule sans erreur En cas d erreur d clenche une exception ou retourne un code d erreur n gatif 58 www yoctopuce com 10 R f rence de l API de haut niveau hubport set_userData YHubPort hubport setUserData 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 function set_userData data function set_userData data function set_userData data void set_userData void data void setUserData void data procedure set_userData data Tobject procedure set_userData ByVal data As Object void set_userData object data void set_userData Object data def set_userData data Cet attribut n es pas utilis directement par l API Il est la disposition de l appelant pour stocker un contexte
122. tring subnetMask function get_subnetMask string function get_subnetMask As String string get_subnetMask String get_subnetMask def get_subnetMask YNetwork target get_subnetMask Retourne une cha ne de caract res repr sentant le masque de sous r seau utilis par le module En cas d erreur d clenche une exception ou retourne Y_SUBNETMASK_TINVALTD 94 www yoctopuce com 10 R f rence de l API de haut niveau network get_userData YNetwork network userData Retourne le contenu de l attribut userData pr c demment stock l aide de la m thode set_userData function get_userData function get_userData function get_userData void get_userData void userData function get_userData Tobject function get_userData As Object object get_userData Object get_userData def 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 95 10 R f rence de l API de haut niveau network get_userPassword YNetwork network 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 function get_userPassword function get_userPassword function get_userPassword string get_userPassword NSString user Pass
123. u 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 msValidity un entier correspondant la dur e de validit attribu e aux les param tres charg s en millisecondes callback fonction 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 YAPT_ SUCCESS context contexte 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 54 www yoctopuce com 10 R f rence de l API de haut niveau hubport nextHubPort YHubPort Continue l num ration des port de Yocto hub commenc e l aide de yFirstHubPort function nextHubPort function nextHubPort function nextHubPort YHubPort nextHubPort YHubPort nextHubPort function nextHubPort TYHubPort function nextHubPort As YHubPort YHubPort nextHubPort YH
124. ubPort nextHubPort def nextHubPort Retourne un pointeur sur un objet YHubPort accessible en ligne ou nul 1 lorsque l num ration est termin e www yoctopuce com 55 10 R f rence de l API de haut niveau hubport register ValueCallback YHubPort Enregistre la fonction de callback qui est appel e chaque changement de la valeur publi e _is function register ValueCallback callback node js function register ValueCallback callback prp function register ValueCallback callback int register ValueCallback YHubPortValueCallback callback int register ValueCallback YHubPortValueCallback callback function register ValueCallback callback TYHubPortValueCallback Longint function register ValueCallback As Integer int register ValueCallback ValueCallback callback int register ValueCallback UpdateCallback callback def register ValueCallback callback Ce callback n est appel que durant l ex cution de 1 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 callback la fonction de callback rappeler ou un pointeur nul La fonction de callback doit accepter deux a
125. ur une plus longue p riode par exemple dans le but de r duire le trafic r seau Param tres msValidity un entier correspondant la dur e de validit attribu e aux les param tres charg s en millisecondes Retourne YAPI_SUCCESS si l op ration se d roule sans erreur En cas d erreur d clenche une exception ou retourne un code d erreur n gatif 100 www yoctopuce com 10 R f rence de l API de haut niveau network load_ async YNetwork Met en cache les valeurs courantes de l interface r seau avec une dur e de validit sp cifi e function load_async msValidity callback context 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 gt Param tres msValidity un entier correspondant la dur e de validit attribu e aux les param tres charg s en millisecondes callback fonction de callback qui sera appel e d s que le r sultat sera connu
126. uration dans la plage 169 254 x y comme la plupart des syst mes d exploitation Le YoctoHub Ethernet indique au serveur DHCP son nom d h te num ro de s rie si le serveur DHCP le supporte ce qui permet de le rep rer plus facilement 1 Binding Mon Interface 21 22 23 24 25 itor Table Address 172 17 17 68 172 17 17 70 172 17 17 72 172 17 17 73 172 17 17 74 MAC Address MEAGCZ PC 60 eb 69 2d c6 2e none 00 08 9b c8 56 39 5 14 da e9 05 e8 31 none 28 37 37 00 6a 7e 1 0 00 04 a3 bd 58 e6 Last Access Thu Jul 18 18 15 33 Mon Jul 22 10 21 51 Thu Jul 18 20 52 00 Thu Jul 18 11 39 31 Thu Jul 18 11 17 38 YoctoHub Ethernet d tect par le serveur DHCP d un petit routeur ZyXEL e Le YoctoHub Ethernet annonce sa pr sence sur le r seau local par le protocole SSDP uPNP ce qui le rend visible par les machines Windows 4 Othe r Devices 4 SDQNAS SX 2000U2 SX46A3C6 YoctoHub Ethernet d tect sur le r seau par PC sous Windows Le YoctoHub Ethernet annonce sa pr sence sur le r seau local par le protocole Bonjour qui le rend visible par les machines Mac OS X www yoctopuce com 3 Premiers pas About Bonjour 8 Webpages METEOETH 0BB2B 19 SDQNAS sx46A3C6 YHUBETH1 0E8A0 Y
127. urrait se produire lors de la v rification de joignabilit Retourne true sile port de Yocto hub est joignable false sinon www yoctopuce com 51 10 R f rence de l API de haut niveau hubport isOnline async YHubPort V rifie si le module h bergeant le port de Yocto hub est joignable sans d clencher d erreur _is function isOnline_async callback context node js function _ 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 callback fonction 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 context contexte 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 52 www yoctopuce com 10 R f rence de l API de haut niveau hubport load YHubPort
128. uses yocto_network yocto_network vb yocto_network cs import com yoctopuce YoctoAPI YNetwork from yocto_network import Fonction globales yFindNetwork func Permet de retrouver une interface r seau d apr s un identifiant donn yFirstNetwork 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 describe Retourne un court texte d crivant 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_callbackMaxDelay Retourne l attente maximale entre deux notifications par callback en secondes network get_callbackMethod Retourne la m thode HTTP utiliser pour signaler les changements d tat par callback network get_callbackMinD
129. vre 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 YCTOPOC1 00C4D Edit parameters for device YCTOPOC1 00C4D and click on the Save button Serial YCTOPOC1 00C4D Product name Yocto Demo Firmware 11443 upgrade Logicalname Luminosity 0 signal leds only Device functions Each function ofthe device has physical name and a logical name You can change the logical name using the rename button YCTOPOC1 00C4D led rename Save Cancel Fen tre configure du module Yocto Demo 2 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 18 www yoctopuce com 5 Utilisation du YoctoHub Ethernet 5 4 Upgrades des firmwares Les modules Yoctopuce sont en fait de v ritables ordinateurs ils contiennent m me un petit serveur Web Et comme tous les ordinateurs il est possible de mettre jour leur logiciel de contr le firmware Des nouveaux firmwares pour chaque module sont r guli rement publi s ils permettent g n ralement d ajouter de nouvelles fonctionnalit s au module et ou de corriger d ventuels bugs Pour mettre jour le firmware d un module vous d
130. word function get_userPassword string function get_userPassword As String string get_userPassword String get_userPassword def get_userPassword YNetwork target get_userPassword Retourne une cha ne de caract res repr sentant une cha ne de hash si un mot de passe a t configur pour l utilisateur user ou sinon une cha ne vide En cas d erreur d clenche une exception ou retourne Y_USERPASSWORD_TINVALTD 96 www yoctopuce com 10 R f rence de l API de haut niveau network get_ wwwWatchdogDelay YNetwork network 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 function get wwwWatchdogDelay function get wwwWatchdogDelay function get wwwWatchdogDelay int get wwwWatchdogDelay int wwwWatchdogDelay function get_wwwWatchdogDelay 1 Longint function get wwwWatchdogDelay As Integer int get wwwWatchdogDelay int get wwwWatchdogDelay def get_wwwWatchdogDelay YNetwork target get_wwwWatchdogDelay Une valeur nulle d sactive le red marrage automatique en cas de perte de connectivit WWW P 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 e
131. xception ou retourne Y_WWWWATCHDOGDELAY_TNVALTD www yoctopuce com 97 10 R f rence de l API de haut niveau network isOnline YNetwork V rifie si le module h bergeant l interface r seau est joignable sans d clencher d erreur _is function isOnline node js function prp function isOnline bool isOnline BOOL isOnline function isOnline boolean ve function isOnline As Boolean _ boolisOnline java boolean isOnline def 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 98 www yoctopuce com 10 R f rence de l API de haut niveau network isOnline YNetwork V rifie si le module h bergeant l interface r seau est joignable sans d clencher d erreur function isOnline_async callback context 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 joignabil
132. xt 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 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 callback fonction 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 context contexte 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 48 www yoctopuce com 10 R f rence de l API de haut niveau hubport get_portState hubport portState Retourne l tat actuel du port de Yocto hub function get_portState function get_portState function get_portState Y_PORTSTATE enum get_poriState Y_PORTSTATE_enum portState function get_portState Integer function get_portState As Integer int get_portState int get_portState def get_poriState 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

YoctoHub-Ethernet, Mode d`emploi

Contents

Download Pdf Manuals

Related Search

Related Contents