',cmt:'

La librairie de programmation Yoctopuce permet de commande la tension de srotir du module. Vous pouvez affecter une valeur fixe,ou faire des transition de voltage.

'}}; doc['VSource']['FindVSource']={syn:'Permet de retrouver une source de tension d\x27apr\xE8s un identifiant donn\xE9.',lib:'YVSource.FindVSource()',pro:'function FindVSource(func)',cmt:'

Permet de retrouver une source de tension d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que la source de tension soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YVSource.isOnline() pour tester si la source de tension est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence la source de tension sans ambigu\xEFt\xE9'},ret:'un objet de classe YVSource qui permet ensuite de contr\xF4ler la source de tension.'}; doc['VSource']['FirstVSource']={syn:'Commence l\x27\xE9num\xE9ration des sources de tension accessibles par la librairie.',lib:'YVSource.FirstVSource()',pro:'function FirstVSource()',cmt:'

Commence l\x27\xE9num\xE9ration des sources de tension accessibles par la librairie. Utiliser la fonction YVSource.nextVSource() pour it\xE9rer sur les autres sources de tension.

',ret:'un pointeur sur un objet YVSource, correspondant \xE0 la premi\xE8re source de tension accessible en ligne, ou null si il n\x27y a pas de sources de tension disponibles.'}; doc['VSource']['describe']={syn:'Retourne un court texte d\xE9crivant la fonction au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'vsource.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant la fonction au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant la fonction (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'}; doc['VSource']['get_advertisedValue']={syn:'Retourne la valeur courante de la source de tension (pas plus de 6 caract\xE8res).',lib:'vsource.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de la source de tension (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de la source de tension (pas plus de 6 caract\xE8res)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID.'}; doc['VSource']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la fonction.',lib:'vsource.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la fonction. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation de la fonction'}; doc['VSource']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la fonction.',lib:'vsource.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la fonction. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation de la fonction'}; doc['VSource']['get_extPowerFailure']={syn:'Rend TRUE si le voltage de l\x27alimentation externe est trop bas.',lib:'vsource.get_extPowerFailure()',pro:'function get_extPowerFailure()',cmt:'

Rend TRUE si le voltage de l\x27alimentation externe est trop bas.

',ret:'soit Y_EXTPOWERFAILURE_FALSE, soit Y_EXTPOWERFAILURE_TRUE',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_EXTPOWERFAILURE_INVALID.'}; doc['VSource']['get_failure']={syn:'Indique si le module est en condition d\x27erreur.',lib:'vsource.get_failure()',pro:'function get_failure()',cmt:'

Indique si le module est en condition d\x27erreur. Il possible de savoir de quelle erreur il s\x27agit en testant get_overheat, get_overcurrent etc... Lorsqu\x27un condition d\x27erreur est rencont\xE9e, la tension de sortie est mise \xE0 z\xE9ro est ne peut pas \xEAtre chang\xE9e tant la fonction reset() n\x27aura pas appell\xE9e.

',ret:'soit Y_FAILURE_FALSE, soit Y_FAILURE_TRUE',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_FAILURE_INVALID.'}; doc['VSource']['get_friendlyName']={syn:'Retourne un identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION.',lib:'vsource.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global de la fonction au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et de la fonction si ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel de la fonction (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant la fonction en utilisant les noms logiques (ex: MyCustomName.relay1) En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_FRIENDLYNAME_INVALID.'}; doc['VSource']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type YFUN_DESCR correspondant \xE0 la fonction.',lib:'vsource.get_vsourceDescriptor()',pro:'function get_functionDescriptor()',cmt:'

Retourne un identifiant unique de type YFUN_DESCR correspondant \xE0 la fonction. Cet identifiant peut \xEAtre utilis\xE9 pour tester si deux instance de YFunction r\xE9f\xE9rencent physiquement la m\xEAme fonction sur le m\xEAme module.

',ret:'un identifiant de type YFUN_DESCR. Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera Y_FUNCTIONDESCRIPTOR_INVALID'}; doc['VSource']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de la fonction, sans r\xE9f\xE9rence au module.',lib:'vsource.get_vsourceId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de la fonction, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant la fonction (ex: relay1) En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_FUNCTIONID_INVALID.'}; doc['VSource']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique de la fonction au format SERIAL.FUNCTIONID.',lib:'vsource.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique de la fonction au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel de la fonction (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant la fonction (ex: RELAYLO1-123456.relay1) En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_HARDWAREID_INVALID.'}; doc['VSource']['get_logicalName']={syn:'Retourne le nom logique de la source de tension.',lib:'vsource.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de la source de tension.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de la source de tension',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_LOGICALNAME_INVALID.'}; doc['VSource']['get_module']={syn:'Retourne l\x27objet YModule correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'vsource.get_module()',pro:'function get_module()',cmt:'

Retourne l\x27objet YModule correspondant au module Yoctopuce qui h\xE9berge la fonction. Si la fonction ne peut \xEAtre trouv\xE9e sur aucun module, l\x27instance de YModule retourn\xE9e ne sera pas joignable.

',ret:'une instance de YModule'}; doc['VSource']['get_module_async']={syn:'Retourne l\x27objet YModule correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'vsource.get_module_async()',pro:'function get_module_async(callback, context)',cmt:'

Retourne l\x27objet YModule correspondant au module Yoctopuce qui h\xE9berge la fonction. Si la fonction ne peut \xEAtre trouv\xE9e sur aucun module, l\x27instance de YModule retourn\xE9e ne sera pas joignable.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la VM Javascript de Firefox, qui n\x27impl\xE9mente pas le passage de contr\xF4le entre threads durant les appels d\x27entr\xE9e/sortie bloquants.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et l\x27instance demand\xE9e de YModule',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'}; doc['VSource']['get_overCurrent']={syn:'Rend TRUE si l\x27appareil connect\xE9 \xE0 la sortie du module consomme trop de courant.',lib:'vsource.get_overCurrent()',pro:'function get_overCurrent()',cmt:'

Rend TRUE si l\x27appareil connect\xE9 \xE0 la sortie du module consomme trop de courant.

',ret:'soit Y_OVERCURRENT_FALSE, soit Y_OVERCURRENT_TRUE',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_OVERCURRENT_INVALID.'}; doc['VSource']['get_overHeat']={syn:'Rend TRUE si le module est en surchauffe.',lib:'vsource.get_overHeat()',pro:'function get_overHeat()',cmt:'

Rend TRUE si le module est en surchauffe.

',ret:'soit Y_OVERHEAT_FALSE, soit Y_OVERHEAT_TRUE',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_OVERHEAT_INVALID.'}; doc['VSource']['get_overLoad']={syn:'Rend TRUE si le module n\x27est pas capable de tenir la tension de sortie demand\xE9e.',lib:'vsource.get_overLoad()',pro:'function get_overLoad()',cmt:'

Rend TRUE si le module n\x27est pas capable de tenir la tension de sortie demand\xE9e.

',ret:'soit Y_OVERLOAD_FALSE, soit Y_OVERLOAD_TRUE',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_OVERLOAD_INVALID.'}; doc['VSource']['get_regulationFailure']={syn:'Rend TRUE si le voltage de sortie de trop \xE9lev\xE9 par report \xE0 la tension demand\xE9e demand\xE9e.',lib:'vsource.get_regulationFailure()',pro:'function get_regulationFailure()',cmt:'

Rend TRUE si le voltage de sortie de trop \xE9lev\xE9 par report \xE0 la tension demand\xE9e demand\xE9e.

',ret:'soit Y_REGULATIONFAILURE_FALSE, soit Y_REGULATIONFAILURE_TRUE',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_REGULATIONFAILURE_INVALID.'}; doc['VSource']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la tension est exprim\xE9e.',lib:'vsource.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle la tension est exprim\xE9e.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant l\x27unit\xE9 dans laquelle la tension est exprim\xE9e',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_UNIT_INVALID.'}; doc['VSource']['get_userData']={syn:'Retourne le contenu de l\x27attribut userData, pr\xE9c\xE9demment stock\xE9 \xE0 l\x27aide de la m\xE9thode set_userData.',lib:'vsource.get_userData()',pro:'function get_userData()',cmt:'

Retourne le contenu de l\x27attribut userData, pr\xE9c\xE9demment stock\xE9 \xE0 l\x27aide de la m\xE9thode set_userData. Cet attribut n\x27es pas utilis\xE9 directement par l\x27API. Il est \xE0 la disposition de l\x27appelant pour stocker un contexte.

',ret:'l\x27objet stock\xE9 pr\xE9c\xE9demment par l\x27appelant.'}; doc['VSource']['get_voltage']={syn:'Retourne la valeur de la commande de tension de sortie en mV ',lib:'vsource.get_voltage()',pro:'function get_voltage()',cmt:'

Retourne la valeur de la commande de tension de sortie en mV

',ret:'un entier repr\xE9sentant la valeur de la commande de tension de sortie en mV',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_VOLTAGE_INVALID.'}; doc['VSource']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant la fonction est joignable, sans d\xE9clencher d\x27erreur.',lib:'vsource.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant la fonction est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de la fonction sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si la fonction est joignable, false sinon'}; doc['VSource']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant la fonction est joignable, sans d\xE9clencher d\x27erreur.',lib:'vsource.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant la fonction est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de la fonction sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la VM Javascript de Firefox, qui n\x27impl\xE9mente pas le passage de contr\xF4le entre threads durant les appels d\x27entr\xE9e/sortie bloquants.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'}; doc['VSource']['load']={syn:'Met en cache les valeurs courantes de la fonction, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'vsource.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de la fonction, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI_SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur. En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['VSource']['load_async']={syn:'Met en cache les valeurs courantes de la fonction, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'vsource.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de la fonction, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la VM Javascript de Firefox, qui n\x27impl\xE9mente pas le passage de contr\xF4le entre threads durant les appels d\x27entr\xE9e/sortie bloquants.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI_SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'}; doc['VSource']['nextVSource']={syn:'Continue l\x27\xE9num\xE9ration des sources de tension commenc\xE9e \xE0 l\x27aide de yFirstVSource().',lib:'vsource.nextVSource()',pro:'function nextVSource()',cmt:'

Continue l\x27\xE9num\xE9ration des sources de tension commenc\xE9e \xE0 l\x27aide de yFirstVSource().

',ret:'un pointeur sur un objet YVSource accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['VSource']['pulse']={syn:'Active la sortie \xE0 une tension donn\xE9e, et pour dur\xE9e sp\xE9cifi\xE9e, puis revient ensuite spontan\xE9ment \xE0 z\xE9ro volt.',lib:'vsource.pulse()',pro:'function pulse(voltage, ms_duration)',cmt:'

Active la sortie \xE0 une tension donn\xE9e, et pour dur\xE9e sp\xE9cifi\xE9e, puis revient ensuite spontan\xE9ment \xE0 z\xE9ro volt.

',par:{voltage:'tension demand\xE9e, en millivolts',ms_duration:'dur\xE9e de l\x27impulsion, en millisecondes'},ret:'YAPI_SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['VSource']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'vsource.registerValueCallback()',pro:'function registerValueCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e. Ce callback n\x27est appel\xE9 que durant l\x27ex\xE9cution de ySleep ou yHandleEvents. Cela permet \xE0 l\x27appelant de contr\xF4ler quand les callback peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callback ne soient pas appel\xE9s trop tard. Pour d\xE9sactiver un callback, il suffit d\x27appeler cette m\xE9thode en lui passant un pointeur nul.

',par:{callback:'la fonction de callback \xE0 rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l\x27object fonction dont la valeur a chang\xE9, et la cha\xEEne de caract\xE8re d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['VSource']['set_logicalName']={syn:'Modifie le nom logique de la source de tension.',lib:'vsource.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de la source de tension. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de la source de tension'},ret:'YAPI_SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['VSource']['set_userData']={syn:'Enregistre un contexte libre dans l\x27attribut userData de la fonction, afin de le retrouver plus tard \xE0 l\x27aide de la m\xE9thode get_userData.',lib:'vsource.set_userData()',pro:'function set_userData(data)',cmt:'

Enregistre un contexte libre dans l\x27attribut userData de la fonction, afin de le retrouver plus tard \xE0 l\x27aide de la m\xE9thode get_userData. Cet attribut n\x27es pas utilis\xE9 directement par l\x27API. Il est \xE0 la disposition de l\x27appelant pour stocker un contexte.

',par:{data:'objet quelconque \xE0 m\xE9moriser'}}; doc['VSource']['set_voltage']={syn:'R\xE8gle la tension de sortie du module (en milliVolts).',lib:'vsource.set_voltage()',pro:'function set_voltage(newval)',cmt:'

R\xE8gle la tension de sortie du module (en milliVolts).

',par:{newval:'un entier'},ret:'YAPI_SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['VSource']['voltageMove']={syn:'D\xE9clenche une variation constante de la sortie vers une valeur donn\xE9e.',lib:'vsource.voltageMove()',pro:'function voltageMove(target, ms_duration)',cmt:'

D\xE9clenche une variation constante de la sortie vers une valeur donn\xE9e.

',par:{target:'nouvelle valeur de sortie \xE0 la fin de la transition, en milliVolts.',ms_duration:'dur\xE9e de la transition, en millisecondes'},ret:'YAPI_SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['VSource']['wait_async']={syn:'Attend que toutes les commandes asynchrones en cours d\x27ex\xE9cution sur le module soient termin\xE9es, et appelle le callback pass\xE9 en param\xE8tre.',lib:'vsource.wait_async()',pro:'function wait_async(callback, context)',cmt:'

Attend que toutes les commandes asynchrones en cours d\x27ex\xE9cution sur le module soient termin\xE9es, et appelle le callback pass\xE9 en param\xE8tre. La fonction callback peut donc librement utiliser des fonctions synchrones ou asynchrones, sans risquer de bloquer la VM Javascript.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que toutes les commandes en cours d\x27ex\xE9cution sur le module seront termin\xE9es La fonction callback re\xE7oit deux arguments: le contexte fourni par l\x27appelant et l\x27objet fonction concern\xE9.',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout :'}; //--- (end of generated code: VSource) //--- (generated code: Voc) doc['Voc']={'':{syn:'Interface pour int\xE9ragir avec les capteurs de Compos\xE9s Organiques Volatils, disponibles par exemple dans le Yocto-VOC-V3',inc:'<script type='text/javascript' src='yocto_voc.js'></script>',cmt:'

La classe YVoc permet de lire et de configurer les capteurs de Compos\xE9s Organiques Volatils Yoctopuce. Elle h\xE9rite de la classe YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es.

'} ,'FindVoc':{syn:'Permet de retrouver un capteur de Compos\xE9s Organiques Volatils d\x27apr\xE8s un identifiant donn\xE9.',lib:'YVoc.FindVoc()',pro:'function FindVoc(func)',cmt:'

Permet de retrouver un capteur de Compos\xE9s Organiques Volatils d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que le capteur de Compos\xE9s Organiques Volatils soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YVoc.isOnline() pour tester si le capteur de Compos\xE9s Organiques Volatils est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le capteur de Compos\xE9s Organiques Volatils sans ambigu\xEFt\xE9, par exemple YVOCMK03.voc.'},ret:'un objet de classe YVoc qui permet ensuite de contr\xF4ler le capteur de Compos\xE9s Organiques Volatils.'} ,'FirstVoc':{syn:'Commence l\x27\xE9num\xE9ration des capteurs de Compos\xE9s Organiques Volatils accessibles par la librairie.',lib:'YVoc.FirstVoc()',pro:'function FirstVoc()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs de Compos\xE9s Organiques Volatils accessibles par la librairie. Utiliser la fonction YVoc.nextVoc() pour it\xE9rer sur les autres capteurs de Compos\xE9s Organiques Volatils.

',ret:'un pointeur sur un objet YVoc, correspondant au premier capteur de Compos\xE9s Organiques Volatils accessible en ligne, ou null s\x27il n\x27y a pas de capteurs de Compos\xE9s Organiques Volatils disponibles.'} ,'calibrateFromPoints':ds.calibrateFromPoints ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes du capteur de Compos\xE9s Organiques Volatils. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de Compos\xE9s Organiques Volatils au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de Compos\xE9s Organiques Volatils au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant le capteur de Compos\xE9s Organiques Volatils (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advMode':{syn:'Retourne le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).',lib:'%.get_advMode()',pro:'function get_advMode()',cmt:'

Retourne le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).

',ret:'une valeur parmi YVoc.ADVMODE_IMMEDIATE, YVoc.ADVMODE_PERIOD_AVG, YVoc.ADVMODE_PERIOD_MIN et YVoc.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue)',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.ADVMODE_INVALID.'} ,'get_advertisedValue':{syn:'Retourne la valeur courante du capteur de Compos\xE9s Organiques Volatils (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du capteur de Compos\xE9s Organiques Volatils (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur de Compos\xE9s Organiques Volatils (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoc.ADVERTISEDVALUE_INVALID.'} ,'get_currentRawValue':{syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en ppm (vol), sous forme de nombre \xE0 virgule.',lib:'%.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en ppm (vol), sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en ppm (vol), sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.CURRENTRAWVALUE_INVALID.'} ,'get_currentValue':{syn:'Retourne la valeur actuelle du taux de VOC estim\xE9, en ppm (vol), sous forme de nombre \xE0 virgule.',lib:'%.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle du taux de VOC estim\xE9, en ppm (vol), sous forme de nombre \xE0 virgule. Notez qu\x27un appel \xE0 get_currentValue() ne d\xE9clenche pas une mesure dans le module mais retourne simplement la valeur obtenue lors de la derni\xE8re mesure. En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu \xE0 une fr\xE9quence qui lui est propre.

Si vous rencontrez des probl\xE8mes de performances en utilisant la fonction get_currentValue() fr\xE9quemment, il vous faudra basculer sur un mod\xE8le de callbacks. Pour plus de d\xE9tails jetez un coup d\x27oeil au chapitre \x22programmation avanc\xE9e\x22 du manuel de votre module.

',ret:'une valeur numérique représentant la valeur actuelle du taux de VOC estim\xE9, en ppm (vol), sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.CURRENTVALUE_INVALID.'} ,'get_dataLogger':ds.get_dataLogger ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de Compos\xE9s Organiques Volatils.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de Compos\xE9s Organiques Volatils. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du capteur de Compos\xE9s Organiques Volatils.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de Compos\xE9s Organiques Volatils.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de Compos\xE9s Organiques Volatils. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du capteur de Compos\xE9s Organiques Volatils.'} ,'get_friendlyName':{syn:'Retourne un identifiant global du capteur de Compos\xE9s Organiques Volatils au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global du capteur de Compos\xE9s Organiques Volatils au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et du capteur de Compos\xE9s Organiques Volatils s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel du capteur de Compos\xE9s Organiques Volatils (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de Compos\xE9s Organiques Volatils en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoc.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel du capteur de Compos\xE9s Organiques Volatils, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du capteur de Compos\xE9s Organiques Volatils, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de Compos\xE9s Organiques Volatils (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoc.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique du capteur de Compos\xE9s Organiques Volatils au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du capteur de Compos\xE9s Organiques Volatils au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel du capteur de Compos\xE9s Organiques Volatils (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de Compos\xE9s Organiques Volatils (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoc.HARDWAREID_INVALID.'} ,'get_highestValue':{syn:'Retourne la valeur maximale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module.',lib:'%.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module. Peut \xEAtre r\xE9initialis\xE9 \xE0 une valeur arbitraire gr\xE2ce \xE0 set_highestValue().

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.HIGHESTVALUE_INVALID.'} ,'get_logFrequency':{syn:'Retourne la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es.',lib:'%.get_logFrequency()',pro:'function get_logFrequency()',cmt:'

Retourne la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es.

',ret:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.LOGFREQUENCY_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique du capteur de Compos\xE9s Organiques Volatils.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur de Compos\xE9s Organiques Volatils.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de Compos\xE9s Organiques Volatils.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoc.LOGICALNAME_INVALID.'} ,'get_lowestValue':{syn:'Retourne la valeur minimale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module.',lib:'%.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module. Peut \xEAtre r\xE9initialis\xE9 \xE0 une valeur arbitraire gr\xE2ce \xE0 set_lowestValue().

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.LOWESTVALUE_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_recordedData':ds.get_recordedData ,'get_reportFrequency':{syn:'Retourne la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction.',lib:'%.get_reportFrequency()',pro:'function get_reportFrequency()',cmt:'

Retourne la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction.

',ret:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.REPORTFREQUENCY_INVALID.'} ,'get_resolution':{syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'%.get_resolution()',pro:'function get_resolution()',cmt:'

Retourne la r\xE9solution des valeurs mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision num\xE9rique de la repr\xE9sentation des mesures. Elle n\x27est pas forc\xE9ment identique \xE0 la pr\xE9cision r\xE9elle du capteur. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',ret:'une valeur numérique représentant la r\xE9solution des valeurs mesur\xE9es',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.RESOLUTION_INVALID.'} ,'get_sensorState':{syn:'Retourne le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment.',lib:'%.get_sensorState()',pro:'function get_sensorState()',cmt:'

Retourne le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment.

',ret:'un entier représentant le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.SENSORSTATE_INVALID.'} ,'get_serialNumber':ds.get_serialNumber ,'get_unit':{syn:'Retourne l\x27unit\xE9 dans laquelle le taux de VOC estim\xE9 est exprim\xE9e.',lib:'%.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle le taux de VOC estim\xE9 est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle le taux de VOC estim\xE9 est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoc.UNIT_INVALID.'} ,'get_userData':dm.get_userData ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant le capteur de Compos\xE9s Organiques Volatils est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de Compos\xE9s Organiques Volatils est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de Compos\xE9s Organiques Volatils sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si le capteur de Compos\xE9s Organiques Volatils est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant le capteur de Compos\xE9s Organiques Volatils est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de Compos\xE9s Organiques Volatils est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de Compos\xE9s Organiques Volatils sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'load':{syn:'Met en cache les valeurs courantes du capteur de Compos\xE9s Organiques Volatils, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur de Compos\xE9s Organiques Volatils, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'loadCalibrationPoints':ds.loadCalibrationPoints ,'load_async':{syn:'Met en cache les valeurs courantes du capteur de Compos\xE9s Organiques Volatils, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur de Compos\xE9s Organiques Volatils, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextVoc':{syn:'Continue l\x27\xE9num\xE9ration des capteurs de Compos\xE9s Organiques Volatils commenc\xE9e \xE0 l\x27aide de yFirstVoc() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les capteurs de Compos\xE9s Organiques Volatils sont retourn\xE9s.',lib:'%.nextVoc()',pro:'function nextVoc()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de Compos\xE9s Organiques Volatils commenc\xE9e \xE0 l\x27aide de yFirstVoc() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les capteurs de Compos\xE9s Organiques Volatils sont retourn\xE9s. Si vous souhaitez retrouver un capteur de Compos\xE9s Organiques Volatils sp\xE9cifique, utilisez Voc.findVoc() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YVoc accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'registerTimedReportCallback':ds.registerTimedReportCallback ,'registerValueCallback':ds.registerValueCallback ,'set_advMode':{syn:'Modifie le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).',lib:'%.set_advMode()',pro:'function set_advMode(newval)',cmt:'

Modifie le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue). N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une valeur parmi YVoc.ADVMODE_IMMEDIATE, YVoc.ADVMODE_PERIOD_AVG, YVoc.ADVMODE_PERIOD_MIN et YVoc.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue)'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_highestValue':ds.set_highestValue ,'set_logFrequency':ds.set_logFrequency ,'set_logicalName':{syn:'Modifie le nom logique du capteur de Compos\xE9s Organiques Volatils.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur de Compos\xE9s Organiques Volatils. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de Compos\xE9s Organiques Volatils.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_lowestValue':ds.set_lowestValue ,'set_reportFrequency':ds.set_reportFrequency ,'set_resolution':ds.set_resolution ,'set_userData':dm.set_userData ,'startDataLogger':ds.startDataLogger ,'stopDataLogger':ds.stopDataLogger ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'wait_async':dm.wait_async }; //--- (end of generated code: Voc) //--- (generated code: Voltage) doc['Voltage']={'':{syn:'Interface pour int\xE9ragir avec les capteurs de tension, disponibles par exemple dans le Yocto-Motor-DC, le Yocto-Volt et le Yocto-Watt',inc:'<script type='text/javascript' src='yocto_voltage.js'></script>',cmt:'

La classe YVoltage permet de lire et de configurer les capteurs de tension Yoctopuce. Elle h\xE9rite de la classe YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es.

'} ,'FindVoltage':{syn:'Permet de retrouver un capteur de tension d\x27apr\xE8s un identifiant donn\xE9.',lib:'YVoltage.FindVoltage()',pro:'function FindVoltage(func)',cmt:'

Permet de retrouver un capteur de tension d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que le capteur de tension soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YVoltage.isOnline() pour tester si le capteur de tension est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le capteur de tension sans ambigu\xEFt\xE9, par exemple MOTORCTL.voltage.'},ret:'un objet de classe YVoltage qui permet ensuite de contr\xF4ler le capteur de tension.'} ,'FirstVoltage':{syn:'Commence l\x27\xE9num\xE9ration des capteurs de tension accessibles par la librairie.',lib:'YVoltage.FirstVoltage()',pro:'function FirstVoltage()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs de tension accessibles par la librairie. Utiliser la fonction YVoltage.nextVoltage() pour it\xE9rer sur les autres capteurs de tension.

',ret:'un pointeur sur un objet YVoltage, correspondant au premier capteur de tension accessible en ligne, ou null s\x27il n\x27y a pas de capteurs de tension disponibles.'} ,'calibrateFromPoints':ds.calibrateFromPoints ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes du capteur de tension. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de tension au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de tension au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant le capteur de tension (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advMode':{syn:'Retourne le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).',lib:'%.get_advMode()',pro:'function get_advMode()',cmt:'

Retourne le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).

',ret:'une valeur parmi YVoltage.ADVMODE_IMMEDIATE, YVoltage.ADVMODE_PERIOD_AVG, YVoltage.ADVMODE_PERIOD_MIN et YVoltage.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue)',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.ADVMODE_INVALID.'} ,'get_advertisedValue':{syn:'Retourne la valeur courante du capteur de tension (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du capteur de tension (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur de tension (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltage.ADVERTISEDVALUE_INVALID.'} ,'get_currentRawValue':{syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en Volt, sous forme de nombre \xE0 virgule.',lib:'%.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en Volt, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en Volt, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.CURRENTRAWVALUE_INVALID.'} ,'get_currentValue':{syn:'Retourne la valeur actuelle de la tension, en Volt, sous forme de nombre \xE0 virgule.',lib:'%.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la tension, en Volt, sous forme de nombre \xE0 virgule. Notez qu\x27un appel \xE0 get_currentValue() ne d\xE9clenche pas une mesure dans le module mais retourne simplement la valeur obtenue lors de la derni\xE8re mesure. En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu \xE0 une fr\xE9quence qui lui est propre.

Si vous rencontrez des probl\xE8mes de performances en utilisant la fonction get_currentValue() fr\xE9quemment, il vous faudra basculer sur un mod\xE8le de callbacks. Pour plus de d\xE9tails jetez un coup d\x27oeil au chapitre \x22programmation avanc\xE9e\x22 du manuel de votre module.

',ret:'une valeur numérique représentant la valeur actuelle de la tension, en Volt, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.CURRENTVALUE_INVALID.'} ,'get_dataLogger':ds.get_dataLogger ,'get_enabled':{syn:'Retourne l\x27\xE9tat d\x27activation de cette mesure.',lib:'%.get_enabled()',pro:'function get_enabled()',cmt:'

Retourne l\x27\xE9tat d\x27activation de cette mesure.

',ret:'soit YVoltage.ENABLED_FALSE, soit YVoltage.ENABLED_TRUE, selon l\x27\xE9tat d\x27activation de cette mesure',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.ENABLED_INVALID.'} ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de tension.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de tension. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du capteur de tension.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de tension.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de tension. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du capteur de tension.'} ,'get_friendlyName':{syn:'Retourne un identifiant global du capteur de tension au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global du capteur de tension au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et du capteur de tension s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel du capteur de tension (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de tension en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltage.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel du capteur de tension, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du capteur de tension, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de tension (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltage.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique du capteur de tension au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du capteur de tension au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel du capteur de tension (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de tension (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltage.HARDWAREID_INVALID.'} ,'get_highestValue':{syn:'Retourne la valeur maximale observ\xE9e pour la tension depuis le d\xE9marrage du module.',lib:'%.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la tension depuis le d\xE9marrage du module. Peut \xEAtre r\xE9initialis\xE9 \xE0 une valeur arbitraire gr\xE2ce \xE0 set_highestValue().

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la tension depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.HIGHESTVALUE_INVALID.'} ,'get_logFrequency':{syn:'Retourne la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es.',lib:'%.get_logFrequency()',pro:'function get_logFrequency()',cmt:'

Retourne la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es.

',ret:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.LOGFREQUENCY_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique du capteur de tension.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur de tension.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de tension.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltage.LOGICALNAME_INVALID.'} ,'get_lowestValue':{syn:'Retourne la valeur minimale observ\xE9e pour la tension depuis le d\xE9marrage du module.',lib:'%.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la tension depuis le d\xE9marrage du module. Peut \xEAtre r\xE9initialis\xE9 \xE0 une valeur arbitraire gr\xE2ce \xE0 set_lowestValue().

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la tension depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.LOWESTVALUE_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_recordedData':ds.get_recordedData ,'get_reportFrequency':{syn:'Retourne la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction.',lib:'%.get_reportFrequency()',pro:'function get_reportFrequency()',cmt:'

Retourne la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction.

',ret:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.REPORTFREQUENCY_INVALID.'} ,'get_resolution':{syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'%.get_resolution()',pro:'function get_resolution()',cmt:'

Retourne la r\xE9solution des valeurs mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision num\xE9rique de la repr\xE9sentation des mesures. Elle n\x27est pas forc\xE9ment identique \xE0 la pr\xE9cision r\xE9elle du capteur. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',ret:'une valeur numérique représentant la r\xE9solution des valeurs mesur\xE9es',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.RESOLUTION_INVALID.'} ,'get_sensorState':{syn:'Retourne le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment.',lib:'%.get_sensorState()',pro:'function get_sensorState()',cmt:'

Retourne le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment.

',ret:'un entier représentant le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.SENSORSTATE_INVALID.'} ,'get_serialNumber':ds.get_serialNumber ,'get_unit':{syn:'Retourne l\x27unit\xE9 dans laquelle la tension est exprim\xE9e.',lib:'%.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle la tension est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la tension est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltage.UNIT_INVALID.'} ,'get_userData':dm.get_userData ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant le capteur de tension est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de tension est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de tension sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si le capteur de tension est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant le capteur de tension est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de tension est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de tension sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'load':{syn:'Met en cache les valeurs courantes du capteur de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'loadCalibrationPoints':ds.loadCalibrationPoints ,'load_async':{syn:'Met en cache les valeurs courantes du capteur de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextVoltage':{syn:'Continue l\x27\xE9num\xE9ration des capteurs de tension commenc\xE9e \xE0 l\x27aide de yFirstVoltage() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les capteurs de tension sont retourn\xE9s.',lib:'%.nextVoltage()',pro:'function nextVoltage()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de tension commenc\xE9e \xE0 l\x27aide de yFirstVoltage() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les capteurs de tension sont retourn\xE9s. Si vous souhaitez retrouver un capteur de tension sp\xE9cifique, utilisez Voltage.findVoltage() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YVoltage accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'registerTimedReportCallback':ds.registerTimedReportCallback ,'registerValueCallback':ds.registerValueCallback ,'set_advMode':{syn:'Modifie le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).',lib:'%.set_advMode()',pro:'function set_advMode(newval)',cmt:'

Modifie le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue). N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une valeur parmi YVoltage.ADVMODE_IMMEDIATE, YVoltage.ADVMODE_PERIOD_AVG, YVoltage.ADVMODE_PERIOD_MIN et YVoltage.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue)'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_enabled':{syn:'Modifie l\x27\xE9tat d\x27activation de le mesure de tension.',lib:'%.set_enabled()',pro:'function set_enabled(newval)',cmt:'

Modifie l\x27\xE9tat d\x27activation de le mesure de tension. Lorsque la mesure de tension AC est d\xE9sactiv\xE9e, la mesure se fera uniquement en mode DC, et invers\xE9ment. Lorsque les deux mesures AC et DC sont activ\xE9es, le module bascule entre le mode AC et DC en fonction de l\x27amplitude relative des variations AC par rapport \xE0 la tension moyenne. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'soit YVoltage.ENABLED_FALSE, soit YVoltage.ENABLED_TRUE, selon l\x27\xE9tat d\x27activation de le mesure de tension'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_highestValue':ds.set_highestValue ,'set_logFrequency':ds.set_logFrequency ,'set_logicalName':{syn:'Modifie le nom logique du capteur de tension.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur de tension. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de tension.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_lowestValue':ds.set_lowestValue ,'set_reportFrequency':ds.set_reportFrequency ,'set_resolution':ds.set_resolution ,'set_userData':dm.set_userData ,'startDataLogger':ds.startDataLogger ,'stopDataLogger':ds.stopDataLogger ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'wait_async':dm.wait_async }; //--- (end of generated code: Voltage) //--- (generated code: VoltageOutput) doc['VoltageOutput']={'':{syn:'Interface pour int\xE9ragir avec les sorties de tension, disponibles par exemple dans le Yocto-0-10V-Tx',inc:'<script type='text/javascript' src='yocto_voltageoutput.js'></script>',cmt:'

La classe YVoltageOutput permet de piloter une sortie en tension.

'} ,'FindVoltageOutput':{syn:'Permet de retrouver une sortie de tension d\x27apr\xE8s un identifiant donn\xE9.',lib:'YVoltageOutput.FindVoltageOutput()',pro:'function FindVoltageOutput(func)',cmt:'

Permet de retrouver une sortie de tension d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que la sortie de tension soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YVoltageOutput.isOnline() pour tester si la sortie de tension est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence la sortie de tension sans ambigu\xEFt\xE9, par exemple TX010V01.voltageOutput1.'},ret:'un objet de classe YVoltageOutput qui permet ensuite de contr\xF4ler la sortie de tension.'} ,'FirstVoltageOutput':{syn:'Commence l\x27\xE9num\xE9ration des sorties de tension accessibles par la librairie.',lib:'YVoltageOutput.FirstVoltageOutput()',pro:'function FirstVoltageOutput()',cmt:'

Commence l\x27\xE9num\xE9ration des sorties de tension accessibles par la librairie. Utiliser la fonction YVoltageOutput.nextVoltageOutput() pour it\xE9rer sur les autres sorties de tension.

',ret:'un pointeur sur un objet YVoltageOutput, correspondant \xE0 la premi\xE8re sortie de tension accessible en ligne, ou null s\x27il n\x27y a pas de sorties de tension disponibles.'} ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes de la sortie de tension. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de la sortie de tension au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de la sortie de tension au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant la sortie de tension (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advertisedValue':{syn:'Retourne la valeur courante de la sortie de tension (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de la sortie de tension (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de la sortie de tension (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltageOutput.ADVERTISEDVALUE_INVALID.'} ,'get_currentVoltage':{syn:'Retourne la tension de sortie, en V.',lib:'%.get_currentVoltage()',pro:'function get_currentVoltage()',cmt:'

Retourne la tension de sortie, en V.

',ret:'une valeur numérique représentant la tension de sortie, en V',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltageOutput.CURRENTVOLTAGE_INVALID.'} ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la sortie de tension.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la sortie de tension. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation de la sortie de tension.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la sortie de tension.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la sortie de tension. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation de la sortie de tension.'} ,'get_friendlyName':{syn:'Retourne un identifiant global de la sortie de tension au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global de la sortie de tension au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et de la sortie de tension s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel de la sortie de tension (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant la sortie de tension en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltageOutput.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel de la sortie de tension, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de la sortie de tension, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant la sortie de tension (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltageOutput.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique de la sortie de tension au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique de la sortie de tension au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel de la sortie de tension (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant la sortie de tension (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltageOutput.HARDWAREID_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique de la sortie de tension.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de la sortie de tension.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de la sortie de tension.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YVoltageOutput.LOGICALNAME_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_serialNumber':ds.get_serialNumber ,'get_userData':dm.get_userData ,'get_voltageAtStartUp':{syn:'Retourne la tension s\xE9lectionn\xE9e au d\xE9marrage du module, en V.',lib:'%.get_voltageAtStartUp()',pro:'function get_voltageAtStartUp()',cmt:'

Retourne la tension s\xE9lectionn\xE9e au d\xE9marrage du module, en V.

',ret:'une valeur numérique représentant la tension s\xE9lectionn\xE9e au d\xE9marrage du module, en V',ext:'En cas d\x27erreur, déclenche une exception ou retourne YVoltageOutput.VOLTAGEATSTARTUP_INVALID.'} ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant la sortie de tension est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant la sortie de tension est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de la sortie de tension sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si la sortie de tension est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant la sortie de tension est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant la sortie de tension est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de la sortie de tension sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'load':{syn:'Met en cache les valeurs courantes de la sortie de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de la sortie de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'load_async':{syn:'Met en cache les valeurs courantes de la sortie de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de la sortie de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextVoltageOutput':{syn:'Continue l\x27\xE9num\xE9ration des sorties de tension commenc\xE9e \xE0 l\x27aide de yFirstVoltageOutput() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les sorties de tension sont retourn\xE9s.',lib:'%.nextVoltageOutput()',pro:'function nextVoltageOutput()',cmt:'

Continue l\x27\xE9num\xE9ration des sorties de tension commenc\xE9e \xE0 l\x27aide de yFirstVoltageOutput() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les sorties de tension sont retourn\xE9s. Si vous souhaitez retrouver une sortie de tension sp\xE9cifique, utilisez VoltageOutput.findVoltageOutput() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YVoltageOutput accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'registerValueCallback':ds.registerValueCallback ,'set_currentVoltage':{syn:'Modifie la tension de sortie, en V.',lib:'%.set_currentVoltage()',pro:'function set_currentVoltage(newval)',cmt:'

Modifie la tension de sortie, en V. Les valeurs admises sont de 0 \xE0 10V.

',par:{newval:'une valeur numérique représentant la tension de sortie, en V'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_logicalName':{syn:'Modifie le nom logique de la sortie de tension.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de la sortie de tension. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de la sortie de tension.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_userData':dm.set_userData ,'set_voltageAtStartUp':{syn:'Modifie la valeur de tension au d\xE9marrage du module.',lib:'%.set_voltageAtStartUp()',pro:'function set_voltageAtStartUp(newval)',cmt:'

Modifie la valeur de tension au d\xE9marrage du module. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module sinon la modification n\x27aura aucun effet.

',par:{newval:'une valeur numérique représentant la valeur de tension au d\xE9marrage du module'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'voltageMove':{syn:'D\xE9clenche une transition progressive de la tension de sortie.',lib:'%.voltageMove()',pro:'function voltageMove(V_target, ms_duration)',cmt:'

D\xE9clenche une transition progressive de la tension de sortie. N\x27importe quel changement explicite de tension annulera tout processus de transition en cours.

',par:{V_target:'nouvelle valeur de tension \xE0 la fin de la transition (nombre flottant, repr\xE9sentant la tension en V)',ms_duration:'dur\xE9e totale de la transition, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'wait_async':dm.wait_async }; //--- (end of generated code: VoltageOutput) //--- (generated code: WakeUpMonitor) doc['WakeUpMonitor']={'':{syn:'Interface pour int\xE9ragir avec les moniteurs de r\xE9veil, disponibles par exemple dans le YoctoHub-GSM-4G, le YoctoHub-Wireless-SR, le YoctoHub-Wireless-g et le YoctoHub-Wireless-n',inc:'<script type='text/javascript' src='yocto_wakeupmonitor.js'></script>',cmt:'

La classe YWakeUpMonitor prend en charge le contr\xF4le global de toutes les sources de r\xE9veil possibles ainsi que les mises en sommeil automatiques.

'} ,'FindWakeUpMonitor':{syn:'Permet de retrouver un moniteur de r\xE9veil d\x27apr\xE8s un identifiant donn\xE9.',lib:'YWakeUpMonitor.FindWakeUpMonitor()',pro:'function FindWakeUpMonitor(func)',cmt:'

Permet de retrouver un moniteur de r\xE9veil d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que le moniteur de r\xE9veil soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YWakeUpMonitor.isOnline() pour tester si le moniteur de r\xE9veil est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le moniteur de r\xE9veil sans ambigu\xEFt\xE9, par exemple YHUBGSM5.wakeUpMonitor.'},ret:'un objet de classe YWakeUpMonitor qui permet ensuite de contr\xF4ler le moniteur de r\xE9veil.'} ,'FirstWakeUpMonitor':{syn:'Commence l\x27\xE9num\xE9ration des moniteurs de r\xE9veil accessibles par la librairie.',lib:'YWakeUpMonitor.FirstWakeUpMonitor()',pro:'function FirstWakeUpMonitor()',cmt:'

Commence l\x27\xE9num\xE9ration des moniteurs de r\xE9veil accessibles par la librairie. Utiliser la fonction YWakeUpMonitor.nextWakeUpMonitor() pour it\xE9rer sur les autres moniteurs de r\xE9veil.

',ret:'un pointeur sur un objet YWakeUpMonitor, correspondant au premier moniteur de r\xE9veil accessible en ligne, ou null s\x27il n\x27y a pas de moniteurs de r\xE9veil disponibles.'} ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes du moniteur de r\xE9veil. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du moniteur de r\xE9veil au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du moniteur de r\xE9veil au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant le moniteur de r\xE9veil (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advertisedValue':{syn:'Retourne la valeur courante du moniteur de r\xE9veil (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du moniteur de r\xE9veil (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du moniteur de r\xE9veil (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpMonitor.ADVERTISEDVALUE_INVALID.'} ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moniteur de r\xE9veil.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moniteur de r\xE9veil. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du moniteur de r\xE9veil.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moniteur de r\xE9veil.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moniteur de r\xE9veil. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du moniteur de r\xE9veil.'} ,'get_friendlyName':{syn:'Retourne un identifiant global du moniteur de r\xE9veil au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global du moniteur de r\xE9veil au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et du moniteur de r\xE9veil s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel du moniteur de r\xE9veil (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant le moniteur de r\xE9veil en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpMonitor.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel du moniteur de r\xE9veil, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du moniteur de r\xE9veil, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant le moniteur de r\xE9veil (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpMonitor.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique du moniteur de r\xE9veil au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du moniteur de r\xE9veil au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel du moniteur de r\xE9veil (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant le moniteur de r\xE9veil (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpMonitor.HARDWAREID_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique du moniteur de r\xE9veil.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du moniteur de r\xE9veil.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du moniteur de r\xE9veil.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpMonitor.LOGICALNAME_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_nextWakeUp':{syn:'Retourne la prochaine date/heure de r\xE9veil agend\xE9e (format UNIX).',lib:'%.get_nextWakeUp()',pro:'function get_nextWakeUp()',cmt:'

Retourne la prochaine date/heure de r\xE9veil agend\xE9e (format UNIX).

',ret:'un entier représentant la prochaine date/heure de r\xE9veil agend\xE9e (format UNIX)',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpMonitor.NEXTWAKEUP_INVALID.'} ,'get_powerDuration':{syn:'Retourne le temp d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement.',lib:'%.get_powerDuration()',pro:'function get_powerDuration()',cmt:'

Retourne le temp d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement.

',ret:'un entier représentant le temp d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpMonitor.POWERDURATION_INVALID.'} ,'get_serialNumber':ds.get_serialNumber ,'get_sleepCountdown':{syn:'Retourne le temps avant le prochain sommeil.',lib:'%.get_sleepCountdown()',pro:'function get_sleepCountdown()',cmt:'

Retourne le temps avant le prochain sommeil.

',ret:'un entier représentant le temps avant le prochain sommeil',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpMonitor.SLEEPCOUNTDOWN_INVALID.'} ,'get_userData':dm.get_userData ,'get_wakeUpReason':{syn:'Renvoie la raison du dernier r\xE9veil.',lib:'%.get_wakeUpReason()',pro:'function get_wakeUpReason()',cmt:'

Renvoie la raison du dernier r\xE9veil.

',ret:'une valeur parmi YWakeUpMonitor.WAKEUPREASON_USBPOWER, YWakeUpMonitor.WAKEUPREASON_EXTPOWER, YWakeUpMonitor.WAKEUPREASON_ENDOFSLEEP, YWakeUpMonitor.WAKEUPREASON_EXTSIG1, YWakeUpMonitor.WAKEUPREASON_SCHEDULE1 et YWakeUpMonitor.WAKEUPREASON_SCHEDULE2',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpMonitor.WAKEUPREASON_INVALID.'} ,'get_wakeUpState':{syn:'Revoie l\x27\xE9tat actuel du moniteur.',lib:'%.get_wakeUpState()',pro:'function get_wakeUpState()',cmt:'

Revoie l\x27\xE9tat actuel du moniteur.

',ret:'soit YWakeUpMonitor.WAKEUPSTATE_SLEEPING, soit YWakeUpMonitor.WAKEUPSTATE_AWAKE',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpMonitor.WAKEUPSTATE_INVALID.'} ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant le moniteur de r\xE9veil est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le moniteur de r\xE9veil est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du moniteur de r\xE9veil sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si le moniteur de r\xE9veil est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant le moniteur de r\xE9veil est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le moniteur de r\xE9veil est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du moniteur de r\xE9veil sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'load':{syn:'Met en cache les valeurs courantes du moniteur de r\xE9veil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du moniteur de r\xE9veil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'load_async':{syn:'Met en cache les valeurs courantes du moniteur de r\xE9veil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du moniteur de r\xE9veil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextWakeUpMonitor':{syn:'Continue l\x27\xE9num\xE9ration des moniteurs de r\xE9veil commenc\xE9e \xE0 l\x27aide de yFirstWakeUpMonitor() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les moniteurs de r\xE9veil sont retourn\xE9s.',lib:'%.nextWakeUpMonitor()',pro:'function nextWakeUpMonitor()',cmt:'

Continue l\x27\xE9num\xE9ration des moniteurs de r\xE9veil commenc\xE9e \xE0 l\x27aide de yFirstWakeUpMonitor() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les moniteurs de r\xE9veil sont retourn\xE9s. Si vous souhaitez retrouver un moniteur de r\xE9veil sp\xE9cifique, utilisez WakeUpMonitor.findWakeUpMonitor() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YWakeUpMonitor accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'registerValueCallback':ds.registerValueCallback ,'resetSleepCountDown':{syn:'R\xE9initialise le compteur de mise en sommeil.',lib:'%.resetSleepCountDown()',pro:'function resetSleepCountDown()',cmt:'

R\xE9initialise le compteur de mise en sommeil.

',ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur. En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_logicalName':{syn:'Modifie le nom logique du moniteur de r\xE9veil.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du moniteur de r\xE9veil. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du moniteur de r\xE9veil.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_nextWakeUp':{syn:'Modifie les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu.',lib:'%.set_nextWakeUp()',pro:'function set_nextWakeUp(newval)',cmt:'

Modifie les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu.

',par:{newval:'un entier représentant les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_powerDuration':{syn:'Modifie le temps d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement.',lib:'%.set_powerDuration()',pro:'function set_powerDuration(newval)',cmt:'

Modifie le temps d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant le temps d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_sleepCountdown':{syn:'Modifie le temps avant le prochain sommeil .',lib:'%.set_sleepCountdown()',pro:'function set_sleepCountdown(newval)',cmt:'

Modifie le temps avant le prochain sommeil .

',par:{newval:'un entier représentant le temps avant le prochain sommeil'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_userData':dm.set_userData ,'sleep':{syn:'D\xE9clenche une mise en sommeil jusqu\x27\xE0 la prochaine condition de r\xE9veil, l\x27heure du RTC du module doit imp\xE9rativement avoir \xE9t\xE9 r\xE9gl\xE9e au pr\xE9alable.',lib:'%.sleep()',pro:'function sleep(secBeforeSleep)',cmt:'

D\xE9clenche une mise en sommeil jusqu\x27\xE0 la prochaine condition de r\xE9veil, l\x27heure du RTC du module doit imp\xE9rativement avoir \xE9t\xE9 r\xE9gl\xE9e au pr\xE9alable.

',par:{secBeforeSleep:'nombre de seconde avant la mise en sommeil'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'sleepFor':{syn:'D\xE9clenche une mise en sommeil pour un temps donn\xE9 ou jusqu\x27\xE0 la prochaine condition de r\xE9veil, l\x27heure du RTC du module doit imp\xE9rativement avoir \xE9t\xE9 r\xE9gl\xE9e au pr\xE9alable.',lib:'%.sleepFor()',pro:'function sleepFor(secUntilWakeUp, secBeforeSleep)',cmt:'

D\xE9clenche une mise en sommeil pour un temps donn\xE9 ou jusqu\x27\xE0 la prochaine condition de r\xE9veil, l\x27heure du RTC du module doit imp\xE9rativement avoir \xE9t\xE9 r\xE9gl\xE9e au pr\xE9alable. Le compte \xE0 rebours avant la mise en sommeil peut \xEAtre annul\xE9 gr\xE2ce \xE0 resetSleepCountDown.

',par:{secUntilWakeUp:'nombre de secondes avant le prochain r\xE9veil',secBeforeSleep:'nombre de secondes avant la mise en sommeil'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'sleepUntil':{syn:'D\xE9clenche une mise en sommeil jusqu\x27\xE0 une date donn\xE9e ou jusqu\x27\xE0 la prochaine condition de r\xE9veil, l\x27heure du RTC du module doit imp\xE9rativement avoir \xE9t\xE9 r\xE9gl\xE9e au pr\xE9alable.',lib:'%.sleepUntil()',pro:'function sleepUntil(wakeUpTime, secBeforeSleep)',cmt:'

D\xE9clenche une mise en sommeil jusqu\x27\xE0 une date donn\xE9e ou jusqu\x27\xE0 la prochaine condition de r\xE9veil, l\x27heure du RTC du module doit imp\xE9rativement avoir \xE9t\xE9 r\xE9gl\xE9e au pr\xE9alable. Le compte \xE0 rebours avant la mise en sommeil peut \xEAtre annul\xE9 gr\xE2ce \xE0 resetSleepCountDown.

',par:{wakeUpTime:'date/heure du r\xE9veil (format UNIX)',secBeforeSleep:'nombre de secondes avant la mise en sommeil'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'wait_async':dm.wait_async ,'wakeUp':{syn:'Force un r\xE9veil.',lib:'%.wakeUp()',pro:'function wakeUp()',cmt:'

Force un r\xE9veil.

'} }; //--- (end of generated code: WakeUpMonitor) //--- (generated code: WakeUpSchedule) doc['WakeUpSchedule']={'':{syn:'Interface pour int\xE9ragir avec les r\xE9veils agend\xE9s, disponibles par exemple dans le YoctoHub-GSM-4G, le YoctoHub-Wireless-SR, le YoctoHub-Wireless-g et le YoctoHub-Wireless-n',inc:'<script type='text/javascript' src='yocto_wakeupschedule.js'></script>',cmt:'

La classe YWakeUpSchedule impl\xE9mente une condition de r\xE9veil. Le r\xE9veil est sp\xE9cifi\xE9 par un ensemble de mois et/ou jours et/ou heures et/ou minutes o\xF9 il doit se produire.

'} ,'FindWakeUpSchedule':{syn:'Permet de retrouver un r\xE9veil agend\xE9 d\x27apr\xE8s un identifiant donn\xE9.',lib:'YWakeUpSchedule.FindWakeUpSchedule()',pro:'function FindWakeUpSchedule(func)',cmt:'

Permet de retrouver un r\xE9veil agend\xE9 d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que le r\xE9veil agend\xE9 soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YWakeUpSchedule.isOnline() pour tester si le r\xE9veil agend\xE9 est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le r\xE9veil agend\xE9 sans ambigu\xEFt\xE9, par exemple YHUBGSM5.wakeUpSchedule1.'},ret:'un objet de classe YWakeUpSchedule qui permet ensuite de contr\xF4ler le r\xE9veil agend\xE9.'} ,'FirstWakeUpSchedule':{syn:'Commence l\x27\xE9num\xE9ration des r\xE9veils agend\xE9s accessibles par la librairie.',lib:'YWakeUpSchedule.FirstWakeUpSchedule()',pro:'function FirstWakeUpSchedule()',cmt:'

Commence l\x27\xE9num\xE9ration des r\xE9veils agend\xE9s accessibles par la librairie. Utiliser la fonction YWakeUpSchedule.nextWakeUpSchedule() pour it\xE9rer sur les autres r\xE9veils agend\xE9s.

',ret:'un pointeur sur un objet YWakeUpSchedule, correspondant au premier r\xE9veil agend\xE9 accessible en ligne, ou null s\x27il n\x27y a pas de r\xE9veils agend\xE9s disponibles.'} ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes du r\xE9veil agend\xE9. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du r\xE9veil agend\xE9 au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du r\xE9veil agend\xE9 au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant le r\xE9veil agend\xE9 (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advertisedValue':{syn:'Retourne la valeur courante du r\xE9veil agend\xE9 (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du r\xE9veil agend\xE9 (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du r\xE9veil agend\xE9 (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpSchedule.ADVERTISEDVALUE_INVALID.'} ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9veil agend\xE9.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9veil agend\xE9. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du r\xE9veil agend\xE9.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9veil agend\xE9.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9veil agend\xE9. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du r\xE9veil agend\xE9.'} ,'get_friendlyName':{syn:'Retourne un identifiant global du r\xE9veil agend\xE9 au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global du r\xE9veil agend\xE9 au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et du r\xE9veil agend\xE9 s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel du r\xE9veil agend\xE9 (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant le r\xE9veil agend\xE9 en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpSchedule.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel du r\xE9veil agend\xE9, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du r\xE9veil agend\xE9, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant le r\xE9veil agend\xE9 (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpSchedule.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique du r\xE9veil agend\xE9 au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du r\xE9veil agend\xE9 au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel du r\xE9veil agend\xE9 (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant le r\xE9veil agend\xE9 (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpSchedule.HARDWAREID_INVALID.'} ,'get_hours':{syn:'Retourne les heures o\xF9 le r\xE9veil est actif..',lib:'%.get_hours()',pro:'function get_hours()',cmt:'

Retourne les heures o\xF9 le r\xE9veil est actif..

',ret:'un entier représentant les heures o\xF9 le r\xE9veil est actif',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.HOURS_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique du r\xE9veil agend\xE9.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du r\xE9veil agend\xE9.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du r\xE9veil agend\xE9.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWakeUpSchedule.LOGICALNAME_INVALID.'} ,'get_minutes':{syn:'Retourne toutes les minutes de chaque heure o\xF9 le r\xE9veil est actif.',lib:'%.get_minutes()',pro:'function get_minutes()',cmt:'

Retourne toutes les minutes de chaque heure o\xF9 le r\xE9veil est actif.

'} ,'get_minutesA':{syn:'Retourne les minutes de l\x27interval 00-29 de chaque heures o\xF9 le r\xE9veil est actif.',lib:'%.get_minutesA()',pro:'function get_minutesA()',cmt:'

Retourne les minutes de l\x27interval 00-29 de chaque heures o\xF9 le r\xE9veil est actif.

',ret:'un entier représentant les minutes de l\x27interval 00-29 de chaque heures o\xF9 le r\xE9veil est actif',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.MINUTESA_INVALID.'} ,'get_minutesB':{syn:'Retourne les minutes de l\x27interval 30-59 de chaque heure o\xF9 le r\xE9veil est actif.',lib:'%.get_minutesB()',pro:'function get_minutesB()',cmt:'

Retourne les minutes de l\x27interval 30-59 de chaque heure o\xF9 le r\xE9veil est actif.

',ret:'un entier représentant les minutes de l\x27interval 30-59 de chaque heure o\xF9 le r\xE9veil est actif',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.MINUTESB_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_monthDays':{syn:'Retourne les jours du mois o\xF9 le r\xE9veil est actif.',lib:'%.get_monthDays()',pro:'function get_monthDays()',cmt:'

Retourne les jours du mois o\xF9 le r\xE9veil est actif.

',ret:'un entier représentant les jours du mois o\xF9 le r\xE9veil est actif',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.MONTHDAYS_INVALID.'} ,'get_months':{syn:'Retourne les mois o\xF9 le r\xE9veil est actif.',lib:'%.get_months()',pro:'function get_months()',cmt:'

Retourne les mois o\xF9 le r\xE9veil est actif.

',ret:'un entier représentant les mois o\xF9 le r\xE9veil est actif',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.MONTHS_INVALID.'} ,'get_nextOccurence':{syn:'Retourne la date/heure de la prochaine occurence de r\xE9veil.',lib:'%.get_nextOccurence()',pro:'function get_nextOccurence()',cmt:'

Retourne la date/heure de la prochaine occurence de r\xE9veil.

',ret:'un entier représentant la date/heure de la prochaine occurence de r\xE9veil',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.NEXTOCCURENCE_INVALID.'} ,'get_secondsBefore':{syn:'Retourne le nombre de secondes d\x27anticipation pour allumer le syst\xE8me avant l\x27heure de r\xE9veil choisie ',lib:'%.get_secondsBefore()',pro:'function get_secondsBefore()',cmt:'

Retourne le nombre de secondes d\x27anticipation pour allumer le syst\xE8me avant l\x27heure de r\xE9veil choisie

',ret:'un entier représentant le nombre de secondes d\x27anticipation pour allumer le syst\xE8me avant l\x27heure de r\xE9veil choisie',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.SECONDSBEFORE_INVALID.'} ,'get_serialNumber':ds.get_serialNumber ,'get_userData':dm.get_userData ,'get_weekDays':{syn:'Retourne les jours de la semaine o\xF9 le r\xE9veil est actif.',lib:'%.get_weekDays()',pro:'function get_weekDays()',cmt:'

Retourne les jours de la semaine o\xF9 le r\xE9veil est actif.

',ret:'un entier représentant les jours de la semaine o\xF9 le r\xE9veil est actif',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWakeUpSchedule.WEEKDAYS_INVALID.'} ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant le r\xE9veil agend\xE9 est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le r\xE9veil agend\xE9 est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du r\xE9veil agend\xE9 sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si le r\xE9veil agend\xE9 est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant le r\xE9veil agend\xE9 est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le r\xE9veil agend\xE9 est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du r\xE9veil agend\xE9 sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'load':{syn:'Met en cache les valeurs courantes du r\xE9veil agend\xE9, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du r\xE9veil agend\xE9, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'load_async':{syn:'Met en cache les valeurs courantes du r\xE9veil agend\xE9, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du r\xE9veil agend\xE9, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextWakeUpSchedule':{syn:'Continue l\x27\xE9num\xE9ration des r\xE9veils agend\xE9s commenc\xE9e \xE0 l\x27aide de yFirstWakeUpSchedule() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les r\xE9veils agend\xE9s sont retourn\xE9s.',lib:'%.nextWakeUpSchedule()',pro:'function nextWakeUpSchedule()',cmt:'

Continue l\x27\xE9num\xE9ration des r\xE9veils agend\xE9s commenc\xE9e \xE0 l\x27aide de yFirstWakeUpSchedule() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les r\xE9veils agend\xE9s sont retourn\xE9s. Si vous souhaitez retrouver un r\xE9veil agend\xE9 sp\xE9cifique, utilisez WakeUpSchedule.findWakeUpSchedule() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YWakeUpSchedule accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'registerValueCallback':ds.registerValueCallback ,'set_hours':{syn:'Modifie les heures o\xF9 un r\xE9veil doit avoir lieu.',lib:'%.set_hours()',pro:'function set_hours(newval)',cmt:'

Modifie les heures o\xF9 un r\xE9veil doit avoir lieu. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant les heures o\xF9 un r\xE9veil doit avoir lieu'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_logicalName':{syn:'Modifie le nom logique du r\xE9veil agend\xE9.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du r\xE9veil agend\xE9. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du r\xE9veil agend\xE9.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_minutes':{syn:'Modifie toutes les minutes o\xF9 un r\xE9veil doit avoir lieu ',lib:'%.set_minutes()',pro:'function set_minutes(bitmap)',cmt:'

Modifie toutes les minutes o\xF9 un r\xE9veil doit avoir lieu

',par:{bitmap:'Minutes 00-59 de chaque heure o\xF9 le r\xE9veil est actif.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_minutesA':{syn:'Modifie les minutes de l\x27interval 00-29 o\xF9 un r\xE9veil doit avoir lieu.',lib:'%.set_minutesA()',pro:'function set_minutesA(newval)',cmt:'

Modifie les minutes de l\x27interval 00-29 o\xF9 un r\xE9veil doit avoir lieu. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant les minutes de l\x27interval 00-29 o\xF9 un r\xE9veil doit avoir lieu'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_minutesB':{syn:'Modifie les minutes de l\x27interval 30-59 o\xF9 un r\xE9veil doit avoir lieu.',lib:'%.set_minutesB()',pro:'function set_minutesB(newval)',cmt:'

Modifie les minutes de l\x27interval 30-59 o\xF9 un r\xE9veil doit avoir lieu. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant les minutes de l\x27interval 30-59 o\xF9 un r\xE9veil doit avoir lieu'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_monthDays':{syn:'Modifie les jours du mois o\xF9 un r\xE9veil doit avoir lieu.',lib:'%.set_monthDays()',pro:'function set_monthDays(newval)',cmt:'

Modifie les jours du mois o\xF9 un r\xE9veil doit avoir lieu. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant les jours du mois o\xF9 un r\xE9veil doit avoir lieu'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_months':{syn:'Modifie les mois o\xF9 un r\xE9veil doit avoir lieu.',lib:'%.set_months()',pro:'function set_months(newval)',cmt:'

Modifie les mois o\xF9 un r\xE9veil doit avoir lieu. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant les mois o\xF9 un r\xE9veil doit avoir lieu'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_secondsBefore':{syn:'Modifie le nombre de secondes d\x27anticipation pour allumer le syst\xE8me avant l\x27heure de r\xE9veil choisie.',lib:'%.set_secondsBefore()',pro:'function set_secondsBefore(newval)',cmt:'

Modifie le nombre de secondes d\x27anticipation pour allumer le syst\xE8me avant l\x27heure de r\xE9veil choisie. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant le nombre de secondes d\x27anticipation pour allumer le syst\xE8me avant l\x27heure de r\xE9veil choisie'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_userData':dm.set_userData ,'set_weekDays':{syn:'Modifie les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu.',lib:'%.set_weekDays()',pro:'function set_weekDays(newval)',cmt:'

Modifie les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'wait_async':dm.wait_async }; //--- (end of generated code: WakeUpSchedule) //--- (generated code: Watchdog) doc['Watchdog']={'':{syn:'Interface pour int\xE9ragir avec les watchdogs, disponibles par exemple dans le Yocto-WatchdogDC',inc:'<script type='text/javascript' src='yocto_watchdog.js'></script>',cmt:'

La classe YWatchdog permet de piloter un watchdog Yoctopuce. Un watchdog se comporte comme un relais, dot\xE9 d\x27un automatisme suppl\xE9mentaire qui permet couper bri\xE8vement l\x27alimentation d\x27un appareil apr\xE8s un temps d\x27attente donn\xE9, afin de provoquer une r\xE9initialisation compl\xE8te de cet appareil. Il suffit de r\xE9initialiser pr\xE9ventivement le watchdog \xE0 intervale r\xE9gulier dans l\x27application tant que tout se passe bien pour pr\xE9venir la r\xE9initialisation, et d\xE8s que l\x27application se trouvera hors-service, le watchdog causera le red\xE9marrage physique de l\x27appareil. Le watchog peut aussi \xEAtre pilot\xE9 directement \xE0 l\x27aide des m\xE9thodes pulse et delayedPulse pour \xE9teindre un appareil pendant un temps donn\xE9.

'} ,'FindWatchdog':{syn:'Permet de retrouver un watchdog d\x27apr\xE8s un identifiant donn\xE9.',lib:'YWatchdog.FindWatchdog()',pro:'function FindWatchdog(func)',cmt:'

Permet de retrouver un watchdog d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que le watchdog soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YWatchdog.isOnline() pour tester si le watchdog est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le watchdog sans ambigu\xEFt\xE9, par exemple WDOGDC01.watchdog1.'},ret:'un objet de classe YWatchdog qui permet ensuite de contr\xF4ler le watchdog.'} ,'FirstWatchdog':{syn:'Commence l\x27\xE9num\xE9ration des watchdogs accessibles par la librairie.',lib:'YWatchdog.FirstWatchdog()',pro:'function FirstWatchdog()',cmt:'

Commence l\x27\xE9num\xE9ration des watchdogs accessibles par la librairie. Utiliser la fonction YWatchdog.nextWatchdog() pour it\xE9rer sur les autres watchdogs.

',ret:'un pointeur sur un objet YWatchdog, correspondant au premier watchdog accessible en ligne, ou null s\x27il n\x27y a pas de watchdogs disponibles.'} ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes du watchdog. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'delayedPulse':{syn:'Pr\xE9-programme une impulsion ',lib:'%.delayedPulse()',pro:'function delayedPulse(ms_delay, ms_duration)',cmt:'

Pr\xE9-programme une impulsion

',par:{ms_delay:'delai d\x27attente avant l\x27impulsion, en millisecondes',ms_duration:'dur\xE9e de l\x27impulsion, en millisecondes'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du watchdog au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du watchdog au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant le watchdog (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advertisedValue':{syn:'Retourne la valeur courante du watchdog (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du watchdog (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du watchdog (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWatchdog.ADVERTISEDVALUE_INVALID.'} ,'get_autoStart':{syn:'Retourne l\x27\xE9tat du watchdog \xE0 la mise sous tension du module.',lib:'%.get_autoStart()',pro:'function get_autoStart()',cmt:'

Retourne l\x27\xE9tat du watchdog \xE0 la mise sous tension du module.

',ret:'soit YWatchdog.AUTOSTART_OFF, soit YWatchdog.AUTOSTART_ON, selon l\x27\xE9tat du watchdog \xE0 la mise sous tension du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.AUTOSTART_INVALID.'} ,'get_countdown':{syn:'Retourne le nombre de millisecondes restantes avant le d\xE9clenchement d\x27une impulsion pr\xE9programm\xE9e par un appel \xE0 delayedPulse().',lib:'%.get_countdown()',pro:'function get_countdown()',cmt:'

Retourne le nombre de millisecondes restantes avant le d\xE9clenchement d\x27une impulsion pr\xE9programm\xE9e par un appel \xE0 delayedPulse(). Si aucune impulsion n\x27est programm\xE9e, retourne z\xE9ro.

',ret:'un entier représentant le nombre de millisecondes restantes avant le d\xE9clenchement d\x27une impulsion pr\xE9programm\xE9e par un appel \xE0 delayedPulse()',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.COUNTDOWN_INVALID.'} ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du watchdog.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du watchdog. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du watchdog.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du watchdog.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du watchdog. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du watchdog.'} ,'get_friendlyName':{syn:'Retourne un identifiant global du watchdog au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global du watchdog au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et du watchdog s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel du watchdog (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant le watchdog en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWatchdog.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel du watchdog, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du watchdog, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant le watchdog (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWatchdog.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique du watchdog au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du watchdog au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel du watchdog (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant le watchdog (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWatchdog.HARDWAREID_INVALID.'} ,'get_lastTrigger':{syn:'Retourne le numbre de secondes \xE9coul\xE9es depuis la derni\xE8re remise sous tension de la sortie.',lib:'%.get_lastTrigger()',pro:'function get_lastTrigger()',cmt:'

Retourne le numbre de secondes \xE9coul\xE9es depuis la derni\xE8re remise sous tension de la sortie.

',ret:'un entier représentant le numbre de secondes \xE9coul\xE9es depuis la derni\xE8re remise sous tension de la sortie',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.LASTTRIGGER_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique du watchdog.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du watchdog.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du watchdog.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWatchdog.LOGICALNAME_INVALID.'} ,'get_maxTimeOnStateA':{syn:'Retourne le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat A avant de basculer automatiquement dans l\x27\xE9tat B.',lib:'%.get_maxTimeOnStateA()',pro:'function get_maxTimeOnStateA()',cmt:'

Retourne le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat A avant de basculer automatiquement dans l\x27\xE9tat B. Z\xE9ro signifie qu\x27il n\x27y a pas de limitation.

',ret:'un entier représentant le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat A avant de basculer automatiquement dans l\x27\xE9tat B',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.MAXTIMEONSTATEA_INVALID.'} ,'get_maxTimeOnStateB':{syn:'Retourne le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat B avant de basculer automatiquement dans l\x27\xE9tat A.',lib:'%.get_maxTimeOnStateB()',pro:'function get_maxTimeOnStateB()',cmt:'

Retourne le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat B avant de basculer automatiquement dans l\x27\xE9tat A. Z\xE9ro signifie qu\x27il n\x27y a pas de limitation.

',ret:'un entier représentant le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat B avant de basculer automatiquement dans l\x27\xE9tat A',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.MAXTIMEONSTATEB_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_output':{syn:'Retourne l\x27\xE9tat de la sortie du watchdogs, lorsqu\x27il est utilis\xE9 comme un simple interrupteur.',lib:'%.get_output()',pro:'function get_output()',cmt:'

Retourne l\x27\xE9tat de la sortie du watchdogs, lorsqu\x27il est utilis\xE9 comme un simple interrupteur.

',ret:'soit YWatchdog.OUTPUT_OFF, soit YWatchdog.OUTPUT_ON, selon l\x27\xE9tat de la sortie du watchdogs, lorsqu\x27il est utilis\xE9 comme un simple interrupteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.OUTPUT_INVALID.'} ,'get_pulseTimer':{syn:'Retourne le nombre de millisecondes restantes avant le retour \xE0 la position de repos (\xE9tat A), durant la g\xE9n\xE9ration d\x27une impulsion mesur\xE9e.',lib:'%.get_pulseTimer()',pro:'function get_pulseTimer()',cmt:'

Retourne le nombre de millisecondes restantes avant le retour \xE0 la position de repos (\xE9tat A), durant la g\xE9n\xE9ration d\x27une impulsion mesur\xE9e. Si aucune impulsion n\x27est en cours, retourne z\xE9ro.

',ret:'un entier représentant le nombre de millisecondes restantes avant le retour \xE0 la position de repos (\xE9tat A), durant la g\xE9n\xE9ration d\x27une impulsion mesur\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.PULSETIMER_INVALID.'} ,'get_running':{syn:'Retourne l\x27\xE9tat du watchdog.',lib:'%.get_running()',pro:'function get_running()',cmt:'

Retourne l\x27\xE9tat du watchdog.

',ret:'soit YWatchdog.RUNNING_OFF, soit YWatchdog.RUNNING_ON, selon l\x27\xE9tat du watchdog',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.RUNNING_INVALID.'} ,'get_serialNumber':ds.get_serialNumber ,'get_state':{syn:'Retourne l\x27\xE9tat du watchdogs (A pour la position de repos, B pour l\x27\xE9tat actif).',lib:'%.get_state()',pro:'function get_state()',cmt:'

Retourne l\x27\xE9tat du watchdogs (A pour la position de repos, B pour l\x27\xE9tat actif).

',ret:'soit YWatchdog.STATE_A, soit YWatchdog.STATE_B, selon l\x27\xE9tat du watchdogs (A pour la position de repos, B pour l\x27\xE9tat actif)',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.STATE_INVALID.'} ,'get_stateAtPowerOn':{syn:'Retourne l\x27\xE9tat du watchdogs au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour laisser le relais tel quel).',lib:'%.get_stateAtPowerOn()',pro:'function get_stateAtPowerOn()',cmt:'

Retourne l\x27\xE9tat du watchdogs au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour laisser le relais tel quel).

',ret:'une valeur parmi YWatchdog.STATEATPOWERON_UNCHANGED, YWatchdog.STATEATPOWERON_A et YWatchdog.STATEATPOWERON_B représentant l\x27\xE9tat du watchdogs au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour laisser le relais tel quel)',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.STATEATPOWERON_INVALID.'} ,'get_triggerDelay':{syn:'Retourne le d\xE9lai d\x27attente avant qu\x27un reset ne soit automatiquement g\xE9n\xE9r\xE9 par le watchog, en millisecondes.',lib:'%.get_triggerDelay()',pro:'function get_triggerDelay()',cmt:'

Retourne le d\xE9lai d\x27attente avant qu\x27un reset ne soit automatiquement g\xE9n\xE9r\xE9 par le watchog, en millisecondes.

',ret:'un entier représentant le d\xE9lai d\x27attente avant qu\x27un reset ne soit automatiquement g\xE9n\xE9r\xE9 par le watchog, en millisecondes',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.TRIGGERDELAY_INVALID.'} ,'get_triggerDuration':{syn:'Retourne la dur\xE9e d\x27un reset g\xE9n\xE9r\xE9 par le watchog, en millisecondes.',lib:'%.get_triggerDuration()',pro:'function get_triggerDuration()',cmt:'

Retourne la dur\xE9e d\x27un reset g\xE9n\xE9r\xE9 par le watchog, en millisecondes.

',ret:'un entier représentant la dur\xE9e d\x27un reset g\xE9n\xE9r\xE9 par le watchog, en millisecondes',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWatchdog.TRIGGERDURATION_INVALID.'} ,'get_userData':dm.get_userData ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant le watchdog est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le watchdog est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du watchdog sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si le watchdog est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant le watchdog est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le watchdog est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du watchdog sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'load':{syn:'Met en cache les valeurs courantes du watchdog, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du watchdog, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'load_async':{syn:'Met en cache les valeurs courantes du watchdog, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du watchdog, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextWatchdog':{syn:'Continue l\x27\xE9num\xE9ration des watchdogs commenc\xE9e \xE0 l\x27aide de yFirstWatchdog() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les watchdogs sont retourn\xE9s.',lib:'%.nextWatchdog()',pro:'function nextWatchdog()',cmt:'

Continue l\x27\xE9num\xE9ration des watchdogs commenc\xE9e \xE0 l\x27aide de yFirstWatchdog() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les watchdogs sont retourn\xE9s. Si vous souhaitez retrouver un watchdog sp\xE9cifique, utilisez Watchdog.findWatchdog() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YWatchdog accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'pulse':{syn:'Commute le relais \xE0 l\x27\xE9tat B (actif) pour un dur\xE9e sp\xE9cifi\xE9e, puis revient ensuite spontan\xE9ment vers l\x27\xE9tat A (\xE9tat de repos).',lib:'%.pulse()',pro:'function pulse(ms_duration)',cmt:'

Commute le relais \xE0 l\x27\xE9tat B (actif) pour un dur\xE9e sp\xE9cifi\xE9e, puis revient ensuite spontan\xE9ment vers l\x27\xE9tat A (\xE9tat de repos).

',par:{ms_duration:'dur\xE9e de l\x27impulsion, en millisecondes'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'registerValueCallback':ds.registerValueCallback ,'resetWatchdog':{syn:'R\xE9initialise le WatchDog.',lib:'%.resetWatchdog()',pro:'function resetWatchdog()',cmt:'

R\xE9initialise le WatchDog. Quand le watchdog est en fonctionnement cette fonction doit \xEAtre appel\xE9e \xE0 interval r\xE9gulier, pour emp\xE9cher que le watdog ne se d\xE9clenche

',ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_autoStart':{syn:'Modifie l\x27\xE9tat du watching au d\xE9marrage du module.',lib:'%.set_autoStart()',pro:'function set_autoStart(newval)',cmt:'

Modifie l\x27\xE9tat du watching au d\xE9marrage du module. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() et de red\xE9marrer le module pour que le param\xE8tre soit appliqu\xE9.

',par:{newval:'soit YWatchdog.AUTOSTART_OFF, soit YWatchdog.AUTOSTART_ON, selon l\x27\xE9tat du watching au d\xE9marrage du module'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_logicalName':{syn:'Modifie le nom logique du watchdog.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du watchdog. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du watchdog.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_maxTimeOnStateA':{syn:'Modifie le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat A avant de basculer automatiquement dans l\x27\xE9tat B.',lib:'%.set_maxTimeOnStateA()',pro:'function set_maxTimeOnStateA(newval)',cmt:'

Modifie le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat A avant de basculer automatiquement dans l\x27\xE9tat B. Z\xE9ro signifie qu\x27il n\x27y a pas de limitation. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat A avant de basculer automatiquement dans l\x27\xE9tat B'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_maxTimeOnStateB':{syn:'Modifie le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat B avant de basculer automatiquement dans l\x27\xE9tat A.',lib:'%.set_maxTimeOnStateB()',pro:'function set_maxTimeOnStateB(newval)',cmt:'

Modifie le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat B avant de basculer automatiquement dans l\x27\xE9tat A. Z\xE9ro signifie qu\x27il n\x27y a pas de limitation. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant le temps maximal (en ms) pendant lequel le watchdog peut rester dans l\x27\xE9tat B avant de basculer automatiquement dans l\x27\xE9tat A'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_output':{syn:'Modifie l\x27\xE9tat de la sortie du watchdogs, lorsqu\x27il est utilis\xE9 comme un simple interrupteur.',lib:'%.set_output()',pro:'function set_output(newval)',cmt:'

Modifie l\x27\xE9tat de la sortie du watchdogs, lorsqu\x27il est utilis\xE9 comme un simple interrupteur.

',par:{newval:'soit YWatchdog.OUTPUT_OFF, soit YWatchdog.OUTPUT_ON, selon l\x27\xE9tat de la sortie du watchdogs, lorsqu\x27il est utilis\xE9 comme un simple interrupteur'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_running':{syn:'Modifie manuellement l\x27\xE9tat de fonctionnement du watchdog.',lib:'%.set_running()',pro:'function set_running(newval)',cmt:'

Modifie manuellement l\x27\xE9tat de fonctionnement du watchdog.

',par:{newval:'soit YWatchdog.RUNNING_OFF, soit YWatchdog.RUNNING_ON, selon manuellement l\x27\xE9tat de fonctionnement du watchdog'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_state':{syn:'Modifie l\x27\xE9tat du watchdogs (A pour la position de repos, B pour l\x27\xE9tat actif).',lib:'%.set_state()',pro:'function set_state(newval)',cmt:'

Modifie l\x27\xE9tat du watchdogs (A pour la position de repos, B pour l\x27\xE9tat actif).

',par:{newval:'soit YWatchdog.STATE_A, soit YWatchdog.STATE_B, selon l\x27\xE9tat du watchdogs (A pour la position de repos, B pour l\x27\xE9tat actif)'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_stateAtPowerOn':{syn:'Modifie l\x27\xE9tat du watchdogs au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour laisser le relais tel quel).',lib:'%.set_stateAtPowerOn()',pro:'function set_stateAtPowerOn(newval)',cmt:'

Modifie l\x27\xE9tat du watchdogs au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour laisser le relais tel quel). N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module sinon la modification n\x27aura aucun effet.

',par:{newval:'une valeur parmi YWatchdog.STATEATPOWERON_UNCHANGED, YWatchdog.STATEATPOWERON_A et YWatchdog.STATEATPOWERON_B représentant l\x27\xE9tat du watchdogs au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour laisser le relais tel quel)'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_triggerDelay':{syn:'Modifie le d\xE9lai d\x27attente avant qu\x27un reset ne soit g\xE9n\xE9r\xE9 par le watchog, en millisecondes.',lib:'%.set_triggerDelay()',pro:'function set_triggerDelay(newval)',cmt:'

Modifie le d\xE9lai d\x27attente avant qu\x27un reset ne soit g\xE9n\xE9r\xE9 par le watchog, en millisecondes. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant le d\xE9lai d\x27attente avant qu\x27un reset ne soit g\xE9n\xE9r\xE9 par le watchog, en millisecondes'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_triggerDuration':{syn:'Modifie la dur\xE9e des resets g\xE9n\xE9r\xE9s par le watchog, en millisecondes.',lib:'%.set_triggerDuration()',pro:'function set_triggerDuration(newval)',cmt:'

Modifie la dur\xE9e des resets g\xE9n\xE9r\xE9s par le watchog, en millisecondes. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'un entier représentant la dur\xE9e des resets g\xE9n\xE9r\xE9s par le watchog, en millisecondes'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_userData':dm.set_userData ,'toggle':{syn:'Inverse la position du relais.',lib:'%.toggle()',pro:'function toggle()',cmt:'

Inverse la position du relais.

',ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'wait_async':dm.wait_async }; //--- (end of generated code: Watchdog) //--- (generated code: WeighScale) doc['WeighScale']={'':{syn:'Interface pour int\xE9ragir avec les capteurs de poids, disponibles par exemple dans le Yocto-Bridge et le Yocto-MaxiBridge',inc:'<script type='text/javascript' src='yocto_weighscale.js'></script>',cmt:'

La classe YWeighScale permet d\x27obtenir une mesure de poids \xE0 partir d\x27un capteur ratiom\xE9trique. Elle permet de contr\xF4ler le mode d\x27excitation de la cellule, pour \xE9viter les d\xE9rives li\xE9es aux changements de temp\xE9rature de l\x27\xE9lectronique, et d\x27appliquer automatiquement une correction suppl\xE9mentaire en fonction de la temp\xE9rature pour compenser la d\xE9rive de la cellule de poids elle-m\xEAme.

'} ,'FindWeighScale':{syn:'Permet de retrouver un capteur de poids d\x27apr\xE8s un identifiant donn\xE9.',lib:'YWeighScale.FindWeighScale()',pro:'function FindWeighScale(func)',cmt:'

Permet de retrouver un capteur de poids d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que le capteur de poids soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YWeighScale.isOnline() pour tester si le capteur de poids est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le capteur de poids sans ambigu\xEFt\xE9, par exemple YWBRIDG1.weighScale1.'},ret:'un objet de classe YWeighScale qui permet ensuite de contr\xF4ler le capteur de poids.'} ,'FirstWeighScale':{syn:'Commence l\x27\xE9num\xE9ration des capteurs de poids accessibles par la librairie.',lib:'YWeighScale.FirstWeighScale()',pro:'function FirstWeighScale()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs de poids accessibles par la librairie. Utiliser la fonction YWeighScale.nextWeighScale() pour it\xE9rer sur les autres capteurs de poids.

',ret:'un pointeur sur un objet YWeighScale, correspondant au premier capteur de poids accessible en ligne, ou null s\x27il n\x27y a pas de capteurs de poids disponibles.'} ,'calibrateFromPoints':ds.calibrateFromPoints ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes du capteur de poids. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de poids au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de poids au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant le capteur de poids (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advMode':{syn:'Retourne le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).',lib:'%.get_advMode()',pro:'function get_advMode()',cmt:'

Retourne le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).

',ret:'une valeur parmi YWeighScale.ADVMODE_IMMEDIATE, YWeighScale.ADVMODE_PERIOD_AVG, YWeighScale.ADVMODE_PERIOD_MIN et YWeighScale.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue)',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.ADVMODE_INVALID.'} ,'get_advertisedValue':{syn:'Retourne la valeur courante du capteur de poids (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du capteur de poids (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur de poids (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWeighScale.ADVERTISEDVALUE_INVALID.'} ,'get_compTempAvg':{syn:'Retourne la temp\xE9rature moyenn\xE9e utilis\xE9e actuellement pour la compensation thermique.',lib:'%.get_compTempAvg()',pro:'function get_compTempAvg()',cmt:'

Retourne la temp\xE9rature moyenn\xE9e utilis\xE9e actuellement pour la compensation thermique.

',ret:'une valeur numérique représentant la temp\xE9rature moyenn\xE9e utilis\xE9e actuellement pour la compensation thermique',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.COMPTEMPAVG_INVALID.'} ,'get_compTempChg':{syn:'Retourne la variation actuelle de la temp\xE9rature, utilis\xE9e pour la compensation thermique.',lib:'%.get_compTempChg()',pro:'function get_compTempChg()',cmt:'

Retourne la variation actuelle de la temp\xE9rature, utilis\xE9e pour la compensation thermique.

',ret:'une valeur numérique représentant la variation actuelle de la temp\xE9rature, utilis\xE9e pour la compensation thermique',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.COMPTEMPCHG_INVALID.'} ,'get_compensation':{syn:'Retourne la valeur de la compensation thermique courante.',lib:'%.get_compensation()',pro:'function get_compensation()',cmt:'

Retourne la valeur de la compensation thermique courante.

',ret:'une valeur numérique représentant la valeur de la compensation thermique courante',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.COMPENSATION_INVALID.'} ,'get_currentRawValue':{syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en l\x27unit\xE9 sp\xE9cifi\xE9e, sous forme de nombre \xE0 virgule.',lib:'%.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en l\x27unit\xE9 sp\xE9cifi\xE9e, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en l\x27unit\xE9 sp\xE9cifi\xE9e, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.CURRENTRAWVALUE_INVALID.'} ,'get_currentValue':{syn:'Retourne la valeur actuelle de la measure, en l\x27unit\xE9 sp\xE9cifi\xE9e, sous forme de nombre \xE0 virgule.',lib:'%.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la measure, en l\x27unit\xE9 sp\xE9cifi\xE9e, sous forme de nombre \xE0 virgule. Notez qu\x27un appel \xE0 get_currentValue() ne d\xE9clenche pas une mesure dans le module mais retourne simplement la valeur obtenue lors de la derni\xE8re mesure. En effet, en interne, chaque senseur Yoctopuce effectue des mesures en continu \xE0 une fr\xE9quence qui lui est propre.

Si vous rencontrez des probl\xE8mes de performances en utilisant la fonction get_currentValue() fr\xE9quemment, il vous faudra basculer sur un mod\xE8le de callbacks. Pour plus de d\xE9tails jetez un coup d\x27oeil au chapitre \x22programmation avanc\xE9e\x22 du manuel de votre module.

',ret:'une valeur numérique représentant la valeur actuelle de la measure, en l\x27unit\xE9 sp\xE9cifi\xE9e, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.CURRENTVALUE_INVALID.'} ,'get_dataLogger':ds.get_dataLogger ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de poids.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de poids. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du capteur de poids.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de poids.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de poids. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation du capteur de poids.'} ,'get_excitation':{syn:'Retourne la m\xE9thode d\x27excitation de la cellule de poids.',lib:'%.get_excitation()',pro:'function get_excitation()',cmt:'

Retourne la m\xE9thode d\x27excitation de la cellule de poids.

',ret:'une valeur parmi YWeighScale.EXCITATION_OFF, YWeighScale.EXCITATION_DC et YWeighScale.EXCITATION_AC représentant la m\xE9thode d\x27excitation de la cellule de poids',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.EXCITATION_INVALID.'} ,'get_friendlyName':{syn:'Retourne un identifiant global du capteur de poids au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global du capteur de poids au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et du capteur de poids s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel du capteur de poids (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de poids en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWeighScale.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel du capteur de poids, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du capteur de poids, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de poids (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWeighScale.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique du capteur de poids au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du capteur de poids au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel du capteur de poids (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de poids (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWeighScale.HARDWAREID_INVALID.'} ,'get_highestValue':{syn:'Retourne la valeur maximale observ\xE9e pour la measure depuis le d\xE9marrage du module.',lib:'%.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la measure depuis le d\xE9marrage du module. Peut \xEAtre r\xE9initialis\xE9 \xE0 une valeur arbitraire gr\xE2ce \xE0 set_highestValue().

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la measure depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.HIGHESTVALUE_INVALID.'} ,'get_logFrequency':{syn:'Retourne la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es.',lib:'%.get_logFrequency()',pro:'function get_logFrequency()',cmt:'

Retourne la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es.

',ret:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger, ou \x22OFF\x22 si les mesures ne sont pas stock\xE9es dans la m\xE9moire de l\x27enregistreur de donn\xE9es',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.LOGFREQUENCY_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique du capteur de poids.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur de poids.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de poids.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWeighScale.LOGICALNAME_INVALID.'} ,'get_lowestValue':{syn:'Retourne la valeur minimale observ\xE9e pour la measure depuis le d\xE9marrage du module.',lib:'%.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la measure depuis le d\xE9marrage du module. Peut \xEAtre r\xE9initialis\xE9 \xE0 une valeur arbitraire gr\xE2ce \xE0 set_lowestValue().

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la measure depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.LOWESTVALUE_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_recordedData':ds.get_recordedData ,'get_reportFrequency':{syn:'Retourne la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction.',lib:'%.get_reportFrequency()',pro:'function get_reportFrequency()',cmt:'

Retourne la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction.

',ret:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es, ou \x22OFF\x22 si les notifications p\xE9riodiques sont d\xE9sactiv\xE9es pour cette fonction',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.REPORTFREQUENCY_INVALID.'} ,'get_resolution':{syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'%.get_resolution()',pro:'function get_resolution()',cmt:'

Retourne la r\xE9solution des valeurs mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision num\xE9rique de la repr\xE9sentation des mesures. Elle n\x27est pas forc\xE9ment identique \xE0 la pr\xE9cision r\xE9elle du capteur. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',ret:'une valeur numérique représentant la r\xE9solution des valeurs mesur\xE9es',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.RESOLUTION_INVALID.'} ,'get_sensorState':{syn:'Retourne le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment.',lib:'%.get_sensorState()',pro:'function get_sensorState()',cmt:'

Retourne le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment.

',ret:'un entier représentant le code d\x27\xE9tat du capteur, qui vaut z\xE9ro lorsqu\x27une mesure actuelle est disponible, ou un code positif si le capteur n\x27est pas en mesure de fournir une valeur en ce moment',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.SENSORSTATE_INVALID.'} ,'get_serialNumber':ds.get_serialNumber ,'get_tempAvgAdaptRatio':{syn:'Retourne le taux d\x27adaptation pour le calcul de la temp\xE9rature moyenne, en pour mille.',lib:'%.get_tempAvgAdaptRatio()',pro:'function get_tempAvgAdaptRatio()',cmt:'

Retourne le taux d\x27adaptation pour le calcul de la temp\xE9rature moyenne, en pour mille. Le but de ce taux d\x27adaptation est de mod\xE9liser l\x27inertie thermique de la cellule de charge. La temp\xE9rature moyenne de compensation est adapt\xE9e toutes les 10 secondes, en appliquant ce taux d\x27adaptation \xE0 la diff\xE9rence entre la temp\xE9rature ambiante mesur\xE9e et la temp\xE9rature moyenne de compensation actuelle. Le taux d\x27adaptation standard est de 0.2 pour mille, et le taux maximal est de 65 pour mille.

',ret:'une valeur numérique représentant le taux d\x27adaptation pour le calcul de la temp\xE9rature moyenne, en pour mille',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.TEMPAVGADAPTRATIO_INVALID.'} ,'get_tempChgAdaptRatio':{syn:'Retourne le taux d\x27adaptation pour le calcul de la variation de temp\xE9rature, en pour mille.',lib:'%.get_tempChgAdaptRatio()',pro:'function get_tempChgAdaptRatio()',cmt:'

Retourne le taux d\x27adaptation pour le calcul de la variation de temp\xE9rature, en pour mille. La variation de temp\xE9rature est recalcul\xE9e toutes les 10 secondes, en appliquant ce taux d\x27adaptation \xE0 la diff\xE9rence entre la temp\xE9rature ambiante mesur\xE9e et la valeur actuelle de temp\xE9rature de compensation des variations. Le taux d\x27adaptation standard est de 0.6 pour mille, et le taux maximal est de 65 pour mille.

',ret:'une valeur numérique représentant le taux d\x27adaptation pour le calcul de la variation de temp\xE9rature, en pour mille',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.TEMPCHGADAPTRATIO_INVALID.'} ,'get_unit':{syn:'Retourne l\x27unit\xE9 dans laquelle la measure est exprim\xE9e.',lib:'%.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle la measure est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la measure est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.UNIT_INVALID.'} ,'get_userData':dm.get_userData ,'get_zeroTracking':{syn:'Retourne la valeur seuil pour le suivi continu du z\xE9ro.',lib:'%.get_zeroTracking()',pro:'function get_zeroTracking()',cmt:'

Retourne la valeur seuil pour le suivi continu du z\xE9ro. Lorsque ce seuil est sup\xE9rieure \xE0 z\xE9ro, les mesures inf\xE9rieures \xE0 cette valeur sont automatiquement ignor\xE9es et le z\xE9ro est continuellement compens\xE9 en cons\xE9quence.

',ret:'une valeur numérique représentant la valeur seuil pour le suivi continu du z\xE9ro',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWeighScale.ZEROTRACKING_INVALID.'} ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant le capteur de poids est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de poids est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de poids sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si le capteur de poids est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant le capteur de poids est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de poids est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de poids sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'load':{syn:'Met en cache les valeurs courantes du capteur de poids, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur de poids, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'loadCalibrationPoints':ds.loadCalibrationPoints ,'loadOffsetAvgCompensationTable':{syn:'R\xE9cup\xE8re la table de compensation de l\x27offset de poids en fonction de la temp\xE9rature moyenn\xE9e pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_offsetAvgCompensationTable.',lib:'%.loadOffsetAvgCompensationTable()',pro:'function loadOffsetAvgCompensationTable(tempValues, compValues)',cmt:'

R\xE9cup\xE8re la table de compensation de l\x27offset de poids en fonction de la temp\xE9rature moyenn\xE9e pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_offsetAvgCompensationTable. La correction de poids est faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les diff\xE9rentes temp\xE9ratures moyenn\xE9es pour lesquelles une correction d\x27offset est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, qui sera rempli par la fonction avec la correction d\x27offset appliqu\xE9e pour chacun des points de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadOffsetChgCompensationTable':{syn:'R\xE9cup\xE8re la table de compensation en temp\xE9rature de l\x27offset de poids en fonction de la variation de temp\xE9rature pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_offsetChgCompensationTable.',lib:'%.loadOffsetChgCompensationTable()',pro:'function loadOffsetChgCompensationTable(tempValues, compValues)',cmt:'

R\xE9cup\xE8re la table de compensation en temp\xE9rature de l\x27offset de poids en fonction de la variation de temp\xE9rature pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_offsetChgCompensationTable. La correction de poids est faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les diff\xE9rentes variations de temp\xE9rature pour lesquelles une correction d\x27offset est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, qui sera rempli par la fonction avec la correction d\x27offset appliqu\xE9e pour chacun des points de variation de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadSpanAvgCompensationTable':{syn:'R\xE9cup\xE8re la table de compensation en temp\xE9rature de l\x27amplitude de poids en fonction de la temp\xE9rature moyenn\xE9e pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_spanAvgCompensationTable.',lib:'%.loadSpanAvgCompensationTable()',pro:'function loadSpanAvgCompensationTable(tempValues, compValues)',cmt:'

R\xE9cup\xE8re la table de compensation en temp\xE9rature de l\x27amplitude de poids en fonction de la temp\xE9rature moyenn\xE9e pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_spanAvgCompensationTable. La correction de poids est faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les diff\xE9rentes temp\xE9ratures moyenn\xE9es pour lesquelles une correction d\x27amplitude est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, qui sera rempli par la fonction avec la correction d\x27amplitude appliqu\xE9e pour chacun des points de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadSpanChgCompensationTable':{syn:'R\xE9cup\xE8re la table de compensation de l\x27amplitude de poids en fonction de la variation de temp\xE9rature, pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_spanChgCompensationTable.',lib:'%.loadSpanChgCompensationTable()',pro:'function loadSpanChgCompensationTable(tempValues, compValues)',cmt:'

R\xE9cup\xE8re la table de compensation de l\x27amplitude de poids en fonction de la variation de temp\xE9rature, pr\xE9c\xE9demment enregistr\xE9e \xE0 l\x27aide de la fonction set_spanChgCompensationTable. La correction de poids est faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les diff\xE9rentes variations de temp\xE9rature pour lesquelles une correction d\x27amplitude est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, qui sera rempli par la fonction avec la correction d\x27amplitude appliqu\xE9e pour chacun des points de variation de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'load_async':{syn:'Met en cache les valeurs courantes du capteur de poids, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur de poids, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextWeighScale':{syn:'Continue l\x27\xE9num\xE9ration des capteurs de poids commenc\xE9e \xE0 l\x27aide de yFirstWeighScale() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les capteurs de poids sont retourn\xE9s.',lib:'%.nextWeighScale()',pro:'function nextWeighScale()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de poids commenc\xE9e \xE0 l\x27aide de yFirstWeighScale() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les capteurs de poids sont retourn\xE9s. Si vous souhaitez retrouver un capteur de poids sp\xE9cifique, utilisez WeighScale.findWeighScale() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YWeighScale accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'registerTimedReportCallback':ds.registerTimedReportCallback ,'registerValueCallback':ds.registerValueCallback ,'set_advMode':{syn:'Modifie le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue).',lib:'%.set_advMode()',pro:'function set_advMode(newval)',cmt:'

Modifie le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue). N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une valeur parmi YWeighScale.ADVMODE_IMMEDIATE, YWeighScale.ADVMODE_PERIOD_AVG, YWeighScale.ADVMODE_PERIOD_MIN et YWeighScale.ADVMODE_PERIOD_MAX représentant le mode de calcul de la valeur publi\xE9e jusqu\x27au hub parent (advertisedValue)'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_excitation':{syn:'Modifie la m\xE9thode d\x27excitation de la cellule de poids.',lib:'%.set_excitation()',pro:'function set_excitation(newval)',cmt:'

Modifie la m\xE9thode d\x27excitation de la cellule de poids. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une valeur parmi YWeighScale.EXCITATION_OFF, YWeighScale.EXCITATION_DC et YWeighScale.EXCITATION_AC représentant la m\xE9thode d\x27excitation de la cellule de poids'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_highestValue':ds.set_highestValue ,'set_logFrequency':ds.set_logFrequency ,'set_logicalName':{syn:'Modifie le nom logique du capteur de poids.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur de poids. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de poids.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_lowestValue':ds.set_lowestValue ,'set_offsetAvgCompensationTable':{syn:'Enregistre la table de compensation de l\x27offset de poids en fonction de la temp\xE9rature moyenn\xE9e, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la temp\xE9rature moyenn\xE9e.',lib:'%.set_offsetAvgCompensationTable()',pro:'function set_offsetAvgCompensationTable(tempValues, compValues)',cmt:'

Enregistre la table de compensation de l\x27offset de poids en fonction de la temp\xE9rature moyenn\xE9e, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la temp\xE9rature moyenn\xE9e. La correction de poids sera faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, correspondant aux diff\xE9rentes temp\xE9ratures moyenn\xE9es pour lesquelles une correction d\x27offset est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, correspondant \xE0 la correction d\x27offset \xE0 appliquer pour chacun des points de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_offsetChgCompensationTable':{syn:'Enregistre la table de compensation de l\x27offset de poids en fonction de la variation de temp\xE9rature, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la variation de la temp\xE9rature.',lib:'%.set_offsetChgCompensationTable()',pro:'function set_offsetChgCompensationTable(tempValues, compValues)',cmt:'

Enregistre la table de compensation de l\x27offset de poids en fonction de la variation de temp\xE9rature, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la variation de la temp\xE9rature. La correction de poids sera faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, correspondant aux diff\xE9rentes variations de temp\xE9rature pour lesquelles une correction d\x27offset est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, correspondant \xE0 la correction d\x27offset \xE0 appliquer pour chacun des points de variation de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_reportFrequency':ds.set_reportFrequency ,'set_resolution':ds.set_resolution ,'set_spanAvgCompensationTable':{syn:'Enregistre la table de compensation en temp\xE9rature de l\x27amplitude du poids en fonction de la temp\xE9rature moyenn\xE9e, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la temp\xE9rature moyenn\xE9e de compensation.',lib:'%.set_spanAvgCompensationTable()',pro:'function set_spanAvgCompensationTable(tempValues, compValues)',cmt:'

Enregistre la table de compensation en temp\xE9rature de l\x27amplitude du poids en fonction de la temp\xE9rature moyenn\xE9e, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la temp\xE9rature moyenn\xE9e de compensation. La correction de poids sera faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, correspondant aux diff\xE9rentes temp\xE9ratures moyenn\xE9es pour lesquelles une correction d\x27amplitude est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, correspondant \xE0 la correction d\x27amplitude (en pour cents) \xE0 appliquer pour chacun des points de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_spanChgCompensationTable':{syn:'Enregistre la table de compensation de l\x27amplitude du poids en fonction de la variation de temp\xE9rature, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la variation de temp\xE9rature.',lib:'%.set_spanChgCompensationTable()',pro:'function set_spanChgCompensationTable(tempValues, compValues)',cmt:'

Enregistre la table de compensation de l\x27amplitude du poids en fonction de la variation de temp\xE9rature, afin de pouvoir corriger automatiquement le poids mesur\xE9 sur la base de la variation de temp\xE9rature. La correction de poids sera faite par interpolation lin\xE9aire entre les points sp\xE9cifi\xE9s.

',par:{tempValues:'tableau de nombres flottants, correspondant aux diff\xE9rentes variation de temp\xE9rature pour lesquelles une correction d\x27amplitude est sp\xE9cifi\xE9e.',compValues:'tableau de nombres flottants, correspondant \xE0 la correction d\x27amplitude (en pour cents) \xE0 appliquer pour chacun des points de variation de temp\xE9rature, index par index.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_tempAvgAdaptRatio':{syn:'Modifie le taux d\x27adaptation pour le calcul de la temp\xE9rature moyenne, en pour mille.',lib:'%.set_tempAvgAdaptRatio()',pro:'function set_tempAvgAdaptRatio(newval)',cmt:'

Modifie le taux d\x27adaptation pour le calcul de la temp\xE9rature moyenne, en pour mille. Le but de ce taux d\x27adaptation est de mod\xE9liser l\x27inertie thermique de la cellule de charge. La temp\xE9rature moyenne de compensation est adapt\xE9e toutes les 10 secondes, en appliquant ce taux d\x27adaptation \xE0 la diff\xE9rence entre la temp\xE9rature ambiante mesur\xE9e et la temp\xE9rature moyenne de compensation actuelle. Le taux d\x27adaptation standard est de 0.2 pour mille, et le taux maximal est de 65 pour mille. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une valeur numérique représentant le taux d\x27adaptation pour le calcul de la temp\xE9rature moyenne, en pour mille'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_tempChgAdaptRatio':{syn:'Modifie le taux d\x27adaptation pour le calcul de la variation de temp\xE9rature, en pour mille.',lib:'%.set_tempChgAdaptRatio()',pro:'function set_tempChgAdaptRatio(newval)',cmt:'

Modifie le taux d\x27adaptation pour le calcul de la variation de temp\xE9rature, en pour mille. La variation de temp\xE9rature est recalcul\xE9e toutes les 10 secondes, en appliquant ce taux d\x27adaptation \xE0 la diff\xE9rence entre la temp\xE9rature ambiante mesur\xE9e et la valeur actuelle de temp\xE9rature de compensation des variations. Le taux d\x27adaptation standard est de 0.6 pour mille, et le taux maximal est de 65 pour mille. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une valeur numérique représentant le taux d\x27adaptation pour le calcul de la variation de temp\xE9rature, en pour mille'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_unit':{syn:'Modifie l\x27unit\xE9 dans laquelle le poids est exprim\xE9.',lib:'%.set_unit()',pro:'function set_unit(newval)',cmt:'

Modifie l\x27unit\xE9 dans laquelle le poids est exprim\xE9. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle le poids est exprim\xE9'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'set_userData':dm.set_userData ,'set_zeroTracking':{syn:'Modifie la valeur seuil pour le suivi continu du z\xE9ro.',lib:'%.set_zeroTracking()',pro:'function set_zeroTracking(newval)',cmt:'

Modifie la valeur seuil pour le suivi continu du z\xE9ro. Lorsque ce seuil est sup\xE9rieure \xE0 z\xE9ro, les mesures inf\xE9rieures \xE0 cette valeur sont automatiquement ignor\xE9es et le z\xE9ro est continuellement compens\xE9 en cons\xE9quence. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une valeur numérique représentant la valeur seuil pour le suivi continu du z\xE9ro'},ret:'YAPI.SUCCESS si l\x27opération se déroule sans erreur.',ext:'En cas d\x27erreur, déclenche une exception ou retourne un code d\x27erreur négatif.'} ,'setupSpan':{syn:'Configure le facteur de poids et l\x27amplitude maximale de la cellule de poids (stock\xE9s dans le genericSensor correspondant) de sorte \xE0 ce que le signal actuel corresponde au poids de r\xE9f\xE9rence sp\xE9cifi\xE9.',lib:'%.setupSpan()',pro:'function setupSpan(currWeight, maxWeight)',cmt:'

Configure le facteur de poids et l\x27amplitude maximale de la cellule de poids (stock\xE9s dans le genericSensor correspondant) de sorte \xE0 ce que le signal actuel corresponde au poids de r\xE9f\xE9rence sp\xE9cifi\xE9.

',par:{currWeight:'poids de r\xE9f\xE9rence actuellement sur la cellule de charge.',maxWeight:'poids maximum qui sera utilis\xE9 sur la cellule de charge.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'startDataLogger':ds.startDataLogger ,'stopDataLogger':ds.stopDataLogger ,'tare':{syn:'Adapte le biais de mesure de la cellule de poids (stock\xE9 dans le genericSensor correspondant) de sorte \xE0 ce que le signal actuel corresponde \xE0 un poids nul.',lib:'%.tare()',pro:'function tare()',cmt:'

Adapte le biais de mesure de la cellule de poids (stock\xE9 dans le genericSensor correspondant) de sorte \xE0 ce que le signal actuel corresponde \xE0 un poids nul. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'wait_async':dm.wait_async }; //--- (end of generated code: WeighScale) //--- (generated code: Wireless) doc['Wireless']={'':{syn:'Interface pour int\xE9ragir avec les interfaces r\xE9seau sans fil, disponibles par exemple dans le YoctoHub-Wireless, le YoctoHub-Wireless-SR, le YoctoHub-Wireless-g et le YoctoHub-Wireless-n',inc:'<script type='text/javascript' src='yocto_wireless.js'></script>',cmt:'

La classe YWireless permet de configurer et de contr\xF4ler la configuration du r\xE9seau sans fil sur les modules Yoctopuce qui en sont dot\xE9s. Notez que les param\xE8tres TCP/IP sont configur\xE9s s\xE9par\xE9ment, \xE0 l\x27aide de la classe YNetwork.

'} ,'FindWireless':{syn:'Permet de retrouver une interface r\xE9seau sans fil d\x27apr\xE8s un identifiant donn\xE9.',lib:'YWireless.FindWireless()',pro:'function FindWireless(func)',cmt:'

Permet de retrouver une interface r\xE9seau sans fil d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

Cette fonction n\x27exige pas que l\x27interface r\xE9seau sans fil soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode YWireless.isOnline() pour tester si l\x27interface r\xE9seau sans fil est utilisable \xE0 un moment donn\xE9. En cas d\x27ambigu\xEFt\xE9 lorsqu\x27on fait une recherche par nom logique, aucune erreur ne sera notifi\xE9e: la premi\xE8re instance trouv\xE9e sera renvoy\xE9e. La recherche se fait d\x27abord par nom mat\xE9riel, puis par nom logique.

Si un appel \xE0 la m\xE9thode is_online() de cet objet renvoie FAUX alors que vous \xEAtes s\xFBr que le module correspondant est ben branch\xE9, v\xE9rifiez que vous n\x27avez pas oubli\xE9 d\x27appeler registerHub() \xE0 l\x27initialisation de de l\x27application.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence l\x27interface r\xE9seau sans fil sans ambigu\xEFt\xE9, par exemple YHUBWLN1.wireless.'},ret:'un objet de classe YWireless qui permet ensuite de contr\xF4ler l\x27interface r\xE9seau sans fil.'} ,'FirstWireless':{syn:'Commence l\x27\xE9num\xE9ration des interfaces r\xE9seau sans fil accessibles par la librairie.',lib:'YWireless.FirstWireless()',pro:'function FirstWireless()',cmt:'

Commence l\x27\xE9num\xE9ration des interfaces r\xE9seau sans fil accessibles par la librairie. Utiliser la fonction YWireless.nextWireless() pour it\xE9rer sur les autres interfaces r\xE9seau sans fil.

',ret:'un pointeur sur un objet YWireless, correspondant \xE0 la premi\xE8re interface r\xE9seau sans fil accessible en ligne, ou null s\x27il n\x27y a pas de interfaces r\xE9seau sans fil disponibles.'} ,'adhocNetwork':{syn:'Modifie la configuration de l\x27interface r\xE9seau sans fil pour cr\xE9er un r\xE9seau sans fil sans point d\x27acc\xE8s, en mode \x22ad-hoc\x22.',lib:'%.adhocNetwork()',pro:'function adhocNetwork(ssid, securityKey)',cmt:'

Modifie la configuration de l\x27interface r\xE9seau sans fil pour cr\xE9er un r\xE9seau sans fil sans point d\x27acc\xE8s, en mode \x22ad-hoc\x22. Sur le YoctoHub-Wireless-g et le YoctoHub-Wireless-n, il faut utiliser \xE0 la place la fonction softAPNetwork() qui cr\xE9e un pseudo point d\x27acc\xE8s, plus efficace et mieux support\xE9 qu\x27un r\xE9seau ad-hoc.

Si une clef d\x27acc\xE8s est configur\xE9e pour un r\xE9seau ad-hoc, le r\xE9seau sera prot\xE9g\xE9 par une s\xE9curit\xE9 WEP40 (5 caract\xE8res ou 10 chiffres hexad\xE9cimaux) ou WEP128 (13 caract\xE8res ou 26 chiffres hexad\xE9cimaux). Pour r\xE9duire les risques d\x27intrusion, il est recommand\xE9 d\x27utiliser une cl\xE9 WEP128 bas\xE9e sur 26 chiffres hexad\xE9cimaux provenant d\x27une bonne source al\xE9atoire.

N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() et de red\xE9marrer le module pour que le param\xE8tre soit appliqu\xE9.

',par:{ssid:'nom du r\xE9seau sans fil \xE0 cr\xE9er',securityKey:'cl\xE9 d\x27acc\xE8s de r\xE9seau, sous forme de cha\xEEne de caract\xE8res'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'clearCache':{syn:'Invalide le cache.',lib:'%.clearCache()',pro:'function clearCache()',cmt:'

Invalide le cache. Invalide le cache des valeurs courantes de l\x27interface r\xE9seau sans fil. Force le prochain appel \xE0 une m\xE9thode get_xxx() ou loadxxx() pour charger les les donn\xE9es depuis le module.

'} ,'describe':{syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27interface r\xE9seau sans fil au format TYPE(NAME)=SERIAL.FUNCTIONID.',lib:'%.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27interface r\xE9seau sans fil au format TYPE(NAME)=SERIAL.FUNCTIONID. Plus pr\xE9cis\xE9ment, TYPE correspond au type de fonction, NAME correspond au nom utils\xE9 lors du premier acc\xE8s a la fonction, SERIAL correspond au num\xE9ro de s\xE9rie du module si le module est connect\xE9, ou \x22unresolved\x22 sinon, et FUNCTIONID correspond \xE0 l\x27identifiant mat\xE9riel de la fonction si le module est connect\xE9. Par exemple, La methode va retourner Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1 si le module est d\xE9j\xE0 connect\xE9 ou Relay(BadCustomeName.relay1)=unresolved si le module n\x27est pas d\xE9j\xE0 connect\xE9. Cette methode ne declenche aucune transaction USB ou TCP et peut donc \xEAtre utilis\xE9 dans un debuggeur.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant l\x27interface r\xE9seau sans fil (ex: Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1)'} ,'get_advertisedValue':{syn:'Retourne la valeur courante de l\x27interface r\xE9seau sans fil (pas plus de 6 caract\xE8res).',lib:'%.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27interface r\xE9seau sans fil (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27interface r\xE9seau sans fil (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWireless.ADVERTISEDVALUE_INVALID.'} ,'get_channel':{syn:'Retourne le num\xE9ro du canal 802.11 utilis\xE9, ou 0 si le r\xE9seau s\xE9lectionn\xE9 n\x27a pas \xE9t\xE9 trouv\xE9.',lib:'%.get_channel()',pro:'function get_channel()',cmt:'

Retourne le num\xE9ro du canal 802.11 utilis\xE9, ou 0 si le r\xE9seau s\xE9lectionn\xE9 n\x27a pas \xE9t\xE9 trouv\xE9.

',ret:'un entier représentant le num\xE9ro du canal 802.11 utilis\xE9, ou 0 si le r\xE9seau s\xE9lectionn\xE9 n\x27a pas \xE9t\xE9 trouv\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWireless.CHANNEL_INVALID.'} ,'get_detectedWlans':{syn:'Retourne une liste d\x27objets objet YWlanRecord qui d\xE9crivent les r\xE9seaux sans fils d\xE9tect\xE9s.',lib:'%.get_detectedWlans()',pro:'function get_detectedWlans()',cmt:'

Retourne une liste d\x27objets objet YWlanRecord qui d\xE9crivent les r\xE9seaux sans fils d\xE9tect\xE9s. La liste n\x27est pas mise \xE0 jour quand le module est d\xE9j\xE0 connect\xE9 \xE0 un acc\xE8s sans fil (mode \x22infrastructure\x22). Pour forcer la d\xE9tection des r\xE9seaux sans fil, il faut appeler startWlanScan(). L\x27appelant est responsable de la d\xE9sallocation de la liste retourn\xE9e dans les langages ne disposant pas de \x22garbage collection\x22.

',ret:'une liste d\x27objets YWlanRecord, contenant le SSID, le canal, la qualit\xE9 du signal, et l\x27algorithme de s\xE9curit\xE9 utilis\xE9 par le r\xE9seau sans fil',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne une liste vide.'} ,'get_errorMessage':{syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface r\xE9seau sans fil.',lib:'%.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface r\xE9seau sans fil. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'une cha\xEEne de caract\xE8res correspondant au message de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation de l\x27interface r\xE9seau sans fil.'} ,'get_errorType':{syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface r\xE9seau sans fil.',lib:'%.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface r\xE9seau sans fil. Cette m\xE9thode est principalement utile lorsque la librairie Yoctopuce est utilis\xE9e en d\xE9sactivant la gestion des exceptions.

',ret:'un nombre correspondant au code de la derni\xE8re erreur qui s\x27est produit lors de l\x27utilisation de l\x27interface r\xE9seau sans fil.'} ,'get_friendlyName':{syn:'Retourne un identifiant global de l\x27interface r\xE9seau sans fil au format NOM_MODULE.NOM_FONCTION.',lib:'%.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

Retourne un identifiant global de l\x27interface r\xE9seau sans fil au format NOM_MODULE.NOM_FONCTION. Le cha\xEEne retourn\xE9e utilise soit les noms logiques du module et de l\x27interface r\xE9seau sans fil s\x27ils sont d\xE9finis, soit respectivement le num\xE9ro de s\xE9rie du module et l\x27identifant mat\xE9riel de l\x27interface r\xE9seau sans fil (par exemple: MyCustomName.relay1)

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27interface r\xE9seau sans fil en utilisant les noms logiques (ex: MyCustomName.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWireless.FRIENDLYNAME_INVALID.'} ,'get_functionDescriptor':ds.get_functionDescriptor ,'get_functionId':{syn:'Retourne l\x27identifiant mat\xE9riel de l\x27interface r\xE9seau sans fil, sans r\xE9f\xE9rence au module.',lib:'%.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de l\x27interface r\xE9seau sans fil, sans r\xE9f\xE9rence au module. Par example relay1.

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27interface r\xE9seau sans fil (ex: relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWireless.FUNCTIONID_INVALID.'} ,'get_hardwareId':{syn:'Retourne l\x27identifiant mat\xE9riel unique de l\x27interface r\xE9seau sans fil au format SERIAL.FUNCTIONID.',lib:'%.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique de l\x27interface r\xE9seau sans fil au format SERIAL.FUNCTIONID. L\x27identifiant unique est compos\xE9 du num\xE9ro de s\xE9rie du module et de l\x27identifiant mat\xE9riel de l\x27interface r\xE9seau sans fil (par example RELAYLO1-123456.relay1).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27interface r\xE9seau sans fil (ex: RELAYLO1-123456.relay1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWireless.HARDWAREID_INVALID.'} ,'get_linkQuality':{syn:'Retourne la qualit\xE9 de la connection, exprim\xE9e en pourcents.',lib:'%.get_linkQuality()',pro:'function get_linkQuality()',cmt:'

Retourne la qualit\xE9 de la connection, exprim\xE9e en pourcents.

',ret:'un entier représentant la qualit\xE9 de la connection, exprim\xE9e en pourcents',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWireless.LINKQUALITY_INVALID.'} ,'get_logicalName':{syn:'Retourne le nom logique de l\x27interface r\xE9seau sans fil.',lib:'%.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27interface r\xE9seau sans fil.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27interface r\xE9seau sans fil.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne YWireless.LOGICALNAME_INVALID.'} ,'get_message':{syn:'Retourne le dernier message de diagnostique de l\x27interface au r\xE9seau sans fil.',lib:'%.get_message()',pro:'function get_message()',cmt:'

Retourne le dernier message de diagnostique de l\x27interface au r\xE9seau sans fil.

',ret:'une chaîne de caractères représentant le dernier message de diagnostique de l\x27interface au r\xE9seau sans fil',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWireless.MESSAGE_INVALID.'} ,'get_module':ds.get_module ,'get_module_async':ds.get_module_async ,'get_security':{syn:'Retourne l\x27algorithme de s\xE9curit\xE9 utilis\xE9 par le r\xE9seau sans fil s\xE9lectionn\xE9.',lib:'%.get_security()',pro:'function get_security()',cmt:'

Retourne l\x27algorithme de s\xE9curit\xE9 utilis\xE9 par le r\xE9seau sans fil s\xE9lectionn\xE9.

',ret:'une valeur parmi YWireless.SECURITY_UNKNOWN, YWireless.SECURITY_OPEN, YWireless.SECURITY_WEP, YWireless.SECURITY_WPA et YWireless.SECURITY_WPA2 représentant l\x27algorithme de s\xE9curit\xE9 utilis\xE9 par le r\xE9seau sans fil s\xE9lectionn\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWireless.SECURITY_INVALID.'} ,'get_serialNumber':ds.get_serialNumber ,'get_ssid':{syn:'Retourne le nom (SSID) du r\xE9seau sans fil s\xE9lectionn\xE9.',lib:'%.get_ssid()',pro:'function get_ssid()',cmt:'

Retourne le nom (SSID) du r\xE9seau sans fil s\xE9lectionn\xE9.

',ret:'une chaîne de caractères représentant le nom (SSID) du r\xE9seau sans fil s\xE9lectionn\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWireless.SSID_INVALID.'} ,'get_userData':dm.get_userData ,'get_wlanState':{syn:'Retourne l\x27\xE9tat actuel de l\x27interface r\xE9seau sans fil.',lib:'%.get_wlanState()',pro:'function get_wlanState()',cmt:'

Retourne l\x27\xE9tat actuel de l\x27interface r\xE9seau sans fil. L\x27\xE9tat YWireless.WLANSTATE_DOWN indique que l\x27interface n\x27est connect\xE9e \xE0 aucun r\xE9seau. L\x27\xE9tat YWireless.WLANSTATE_SCANNING signifie que la carte r\xE9seau effectue un balayage des fr\xE9quences utilisables. Dans cet \xE9tat le module n\x27est pas joignable et la configuration r\xE9seau n\x27est pas encore appliqu\xE9e. L\x27\xE9tat YWireless.WLANSTATE_CONNECTED signifie que la configuration r\xE9seau a pu \xEAtre appliqu\xE9 et que le module est joignable. Si le l\x27interface est configur\xE9e pour fonctionner en mode ad-hoc ou Soft AP, cela signifie que le r\xE9seau est fonctionnel et que un p\xE9riph\xE9rique peut se connecter au r\xE9seau. L\x27\xE9tat YWireless.WLANSTATE_REJECTED signifie que l\x27interface r\xE9seau n\x27a pas pu joindre le r\xE9seau souhait\xE9. la source de l\x27erreur peut \xEAtre obtenue \xE0 l\x27aide de la m\xE9thode get_message().

',ret:'une valeur parmi YWireless.WLANSTATE_DOWN, YWireless.WLANSTATE_SCANNING, YWireless.WLANSTATE_CONNECTED et YWireless.WLANSTATE_REJECTED représentant l\x27\xE9tat actuel de l\x27interface r\xE9seau sans fil',ext:'En cas d\x27erreur, déclenche une exception ou retourne YWireless.WLANSTATE_INVALID.'} ,'isOnline':{syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau sans fil est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau sans fil est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27interface r\xE9seau sans fil sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

',ret:'true si l\x27interface r\xE9seau sans fil est joignable, false sinon'} ,'isOnline_async':{syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau sans fil est joignable, sans d\xE9clencher d\x27erreur.',lib:'%.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau sans fil est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27interface r\xE9seau sans fil sont valides au moment de l\x27appel, le module est consid\xE9r\xE9 joignable. Cette fonction ne cause en aucun cas d\x27exception, quelle que soit l\x27erreur qui pourrait se produire lors de la v\xE9rification de joignabilit\xE9.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le r\xE9sultat bool\xE9en',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'joinNetwork':{syn:'Modifie la configuration de l\x27interface r\xE9seau sans fil pour se connecter \xE0 un point d\x27acc\xE8s sans fil existant (mode \x22infrastructure\x22).',lib:'%.joinNetwork()',pro:'function joinNetwork(ssid, securityKey)',cmt:'

Modifie la configuration de l\x27interface r\xE9seau sans fil pour se connecter \xE0 un point d\x27acc\xE8s sans fil existant (mode \x22infrastructure\x22). N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() et de red\xE9marrer le module pour que le param\xE8tre soit appliqu\xE9.

',par:{ssid:'nom du r\xE9seau sans fil \xE0 utiliser',securityKey:'cl\xE9 d\x27acc\xE8s au r\xE9seau, sous forme de cha\xEEne de caract\xE8res'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'load':{syn:'Met en cache les valeurs courantes de l\x27interface r\xE9seau sans fil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27interface r\xE9seau sans fil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'loadAttribute':ds.loadAttribute ,'load_async':{syn:'Met en cache les valeurs courantes de l\x27interface r\xE9seau sans fil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'%.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27interface r\xE9seau sans fil, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e. Par d\xE9faut, lorsqu\x27on acc\xE8de \xE0 un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la dur\xE9e standard (5 ms). Cette m\xE9thode peut \xEAtre utilis\xE9e pour marquer occasionellement les donn\xE9es cach\xE9es comme valides pour une plus longue p\xE9riode, par exemple dans le but de r\xE9duire le trafic r\xE9seau.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la machine virtuelle Javascript avec une attente active.

',par:{msValidity:'un entier correspondant \xE0 la dur\xE9e de validit\xE9 attribu\xE9e aux les param\xE8tres charg\xE9s, en millisecondes',callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit trois arguments: le contexte fourni par l\x27appelant, l\x27objet fonction concern\xE9 et le code d\x27erreur (ou YAPI.SUCCESS)',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} ,'muteValueCallbacks':ds.muteValueCallbacks ,'nextWireless':{syn:'Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau sans fil commenc\xE9e \xE0 l\x27aide de yFirstWireless() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les interfaces r\xE9seau sans fil sont retourn\xE9s.',lib:'%.nextWireless()',pro:'function nextWireless()',cmt:'

Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau sans fil commenc\xE9e \xE0 l\x27aide de yFirstWireless() Attention, vous ne pouvez faire aucune supposition sur l\x27ordre dans lequel les interfaces r\xE9seau sans fil sont retourn\xE9s. Si vous souhaitez retrouver une interface r\xE9seau sans fil sp\xE9cifique, utilisez Wireless.findWireless() avec un hardwareID ou un nom logique.

',ret:'un pointeur sur un objet YWireless accessible en ligne, ou null lorsque l\x27\xE9num\xE9ration est termin\xE9e.'} ,'registerValueCallback':ds.registerValueCallback ,'set_logicalName':{syn:'Modifie le nom logique de l\x27interface r\xE9seau sans fil.',lib:'%.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27interface r\xE9seau sans fil. Vous pouvez utiliser yCheckLogicalName() pour v\xE9rifier si votre param\xE8tre est valide. N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27interface r\xE9seau sans fil.'},ret:'YAPI.SUCCESS si l\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'set_userData':dm.set_userData ,'softAPNetwork':{syn:'Modifie la configuration de l\x27interface r\xE9seau sans fil pour cr\xE9er un pseudo point d\x27acc\xE8s sans fil (\x22Soft AP\x22).',lib:'%.softAPNetwork()',pro:'function softAPNetwork(ssid, securityKey)',cmt:'

Modifie la configuration de l\x27interface r\xE9seau sans fil pour cr\xE9er un pseudo point d\x27acc\xE8s sans fil (\x22Soft AP\x22). Cette fonction ne fonctionne que sur le YoctoHub-Wireless-g et le YoctoHub-Wireless-n.

Avec le YoctoHub-Wireless-g, si une clef d\x27acc\xE8s est configur\xE9e pour un r\xE9seau SoftAP, le r\xE9seau sera prot\xE9g\xE9 par une s\xE9curit\xE9 WEP40 (5 caract\xE8res ou 10 chiffres hexad\xE9cimaux) ou WEP128 (13 caract\xE8res ou 26 chiffres hexad\xE9cimaux). Pour r\xE9duire les risques d\x27intrusion, il est recommand\xE9 d\x27utiliser une cl\xE9 WEP128 bas\xE9e sur 26 chiffres hexad\xE9cimaux provenant d\x27une bonne source al\xE9atoire.

Avec le YoctoHub-Wireless-n, si une clef d\x27acc\xE8s est configur\xE9e pour un r\xE9seau SoftAP, le r\xE9seau sera s\xE9curis\xE9 par WPA2.

N\x27oubliez pas d\x27appeler la m\xE9thode saveToFlash() et de red\xE9marrer le module pour que le param\xE8tre soit appliqu\xE9.

',par:{ssid:'nom du r\xE9seau sans fil \xE0 cr\xE9er',securityKey:'cl\xE9 d\x27acc\xE8s de r\xE9seau, sous forme de cha\xEEne de caract\xE8res'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'} ,'startWlanScan':{syn:'D\xE9clenche un balayage des fr\xE9quences utilisable et construit la liste de r\xE9seau sans fils disponible.',lib:'%.startWlanScan()',pro:'function startWlanScan()',cmt:'

D\xE9clenche un balayage des fr\xE9quences utilisable et construit la liste de r\xE9seau sans fils disponible. Pendant le balayage des r\xE9seau sans fils, l\x27interface se d\xE9connecte du r\xE9seau sans fils actuel. A la fin du balayage l\x27interface essaye de se reconnecter au r\xE9seau sans fil. Pendant le balayage le wlanState passe par l\x27\xE9tat YWireless.WLANSTATE_DOWN puis par l\x27\xE9tat YWireless.WLANSTATE_SCANNING. La liste des r\xE9seaux sans fils disponible peut \xEAtre r\xE9cup\xE9r\xE9 avec la m\xE9thode get_detectedWlans() \xE0 partir du moment ou get_wlanState() retourne YWireless.WLANSTATE_REJECTED ou YWireless.WLANSTATE_CONNECTED.

En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.

'} ,'unmuteValueCallbacks':ds.unmuteValueCallbacks ,'wait_async':dm.wait_async }; //--- (end of generated code: Wireless) //--- (generated code: WlanRecord) doc['WlanRecord']={'':{syn:'Description d\x27un r\xE9seau wireless, retourn\xE9e par la m\xE9thode wireless.get_detectedWlans',inc:'<script type='text/javascript' src='yocto_wireless.js'></script>',cmt:'

Les objets YWlanRecord d\xE9crivent un r\xE9seau wireless. Ces objets sont utilis\xE9s en particulier en conjonction avec la classe YWireless.

'} ,'get_channel':{syn:'Retourne le num\xE9ro du canal utilis\xE9 par le r\xE9seau, selon 802.11 b/g/n.',lib:'%.get_channel()',pro:'function get_channel()',cmt:'

Retourne le num\xE9ro du canal utilis\xE9 par le r\xE9seau, selon 802.11 b/g/n.

',ret:'un entier correspondant au num\xE9ro du canal.'} ,'get_linkQuality':{syn:'Retourne la qualit\xE9 de la connection au r\xE9seau sans fil, en pourcents.',lib:'%.get_linkQuality()',pro:'function get_linkQuality()',cmt:'

Retourne la qualit\xE9 de la connection au r\xE9seau sans fil, en pourcents.

',ret:'un entier entre 0 et 100 correspondant \xE0 la qualit\xE9 du signal.'} ,'get_security':{syn:'Retourne l\x27algorithme de s\xE9curit\xE9 utilis\xE9 par le r\xE9seau sans fil.',lib:'%.get_security()',pro:'function get_security()',cmt:'

Retourne l\x27algorithme de s\xE9curit\xE9 utilis\xE9 par le r\xE9seau sans fil. Si le r\xE9seau n\x27est pas s\xE9curis\xE9, la valeur est \x22OPEN\x22.

',ret:'une cha\xEEne de caract\xE8res contenant l\x27algorithme de s\xE9curit\xE9.'} ,'get_ssid':{syn:'Retourne le nom du r\xE9seau sans fil (SSID).',lib:'%.get_ssid()',pro:'function get_ssid()',cmt:'

Retourne le nom du r\xE9seau sans fil (SSID).

',ret:'une cha\xEEne de caract\xE8res contenant le nom du r\xE9seau sans fil (SSID).'} }; //--- (end of generated code: WlanRecord) //--- (generated code: YAPI) doc['YAPI']={'':{syn:'Fonctions g\xE9n\xE9rales',inc:'<script type='text/javascript' src='yocto_api.js'></script>',cmt:'

Ces quelques fonctions g\xE9n\xE9rales permettent l\x27initialisation et la configuration de la librairie Yoctopuce. Dans la plupart des cas, un appel \xE0 yRegisterHub() suffira en tout et pour tout. Ensuite, vous pourrez appeler la fonction globale yFind...() ou yFirst...() correspondant \xE0 votre module pour pouvoir interagir avec lui.

'} ,'CheckLogicalName':{syn:'V\xE9rifie si un nom donn\xE9 est valide comme nom logique pour un module ou une fonction.',lib:'YAPI.CheckLogicalName()',pro:'function CheckLogicalName(name)',cmt:'

V\xE9rifie si un nom donn\xE9 est valide comme nom logique pour un module ou une fonction. Un nom logique valide est form\xE9 de 19 caract\xE8res au maximum, choisis parmi A..Z, a..z, 0..9, _ et -. Lorsqu\x27on configure un nom logique avec une cha\xEEne incorrecte, les caract\xE8res invalides sont ignor\xE9s.

',par:{name:'une cha\xEEne de caract\xE8res contenant le nom v\xE9rifier.'},ret:'true si le nom est valide, false dans le cas contraire.'} ,'DisableExceptions':{syn:'D\xE9sactive l\x27utilisation d\x27exceptions pour la gestion des erreurs.',lib:'YAPI.DisableExceptions()',pro:'function DisableExceptions()',cmt:'

D\xE9sactive l\x27utilisation d\x27exceptions pour la gestion des erreurs. Lorsque les exceptions sont d\xE9sactiv\xE9es, chaque fonction retourne une valeur d\x27erreur sp\xE9cifique selon son type, document\xE9e dans ce manuel de r\xE9f\xE9rence.

'} ,'EnableExceptions':{syn:'R\xE9active l\x27utilisation d\x27exceptions pour la gestion des erreurs.',lib:'YAPI.EnableExceptions()',pro:'function EnableExceptions()',cmt:'

R\xE9active l\x27utilisation d\x27exceptions pour la gestion des erreurs. Attention, lorsque les exceptions sont activ\xE9es, tout appel \xE0 une fonction de la librairie qui \xE9choue d\xE9clenche une exception. Dans le cas o\xF9 celle-ci n\x27est pas intercept\xE9e correctement par le code appelant, soit le debugger se lance, soit le programme de l\x27utilisateur est imm\xE9diatement stopp\xE9 (crash).

'} ,'FreeAPI':{syn:'Attends que toutes les communications en cours avec les modules Yoctopuce soient termin\xE9es puis lib\xE8re les ressources utilis\xE9es par la librairie Yoctopuce.',lib:'YAPI.FreeAPI()',pro:'function FreeAPI()',cmt:'

Attends que toutes les communications en cours avec les modules Yoctopuce soient termin\xE9es puis lib\xE8re les ressources utilis\xE9es par la librairie Yoctopuce.

Du point de vue du syst\xE8me d\x27exploitation, il n\x27est en g\xE9n\xE9ral pas n\xE9cessaire d\x27appeler cette fonction puisque que l\x27OS lib\xE9rera automatiquement les ressources allou\xE9es d\xE8s que le programme sera termin\xE9. Cependant il existe deux situations o\xF9 vous auriez un int\xE9r\xEAt \xE0 l\x27appeler:

- Vous d\xE9sirez lib\xE9rer tous les blocs de m\xE9moire allou\xE9s dynamiquement dans le but d\x27identifier une source de blocs perdus par exemple.

- Votre code envoie des commandes aux modules juste avant de se terminer. Les commandes \xE9tant envoy\xE9es de mani\xE8re asynchrone, sans cet appel le programme risquerait de se terminer avant que toutes les commandes n\x27aient eu le temps de partir.

Vous ne devez plus appeler aucune fonction de la librairie apr\xE8s avoir appel\xE9 yFreeAPI(), sous peine de crash.

'} ,'GetAPIVersion':{syn:'Retourne la version de la librairie Yoctopuce utilis\xE9e.',lib:'YAPI.GetAPIVersion()',pro:'function GetAPIVersion()',cmt:'

Retourne la version de la librairie Yoctopuce utilis\xE9e. La version est retourn\xE9e sous forme d\x27une cha\xEEne de caract\xE8res au format \x22Majeure.Mineure.NoBuild\x22, par exemple \x221.01.5535\x22. Pour les langages utilisant une DLL externe (par exemple C#, VisualBasic ou Delphi), la cha\xEEne contient en outre la version de la DLL au m\xEAme format, par exemple \x221.01.5535 (1.01.5439)\x22.

Si vous d\xE9sirez v\xE9rifier dans votre code que la version de la librairie est compatible avec celle que vous avez utilis\xE9 durant le d\xE9veloppement, v\xE9rifiez que le num\xE9ro majeur soit strictement \xE9gal et que le num\xE9ro mineur soit \xE9gal ou sup\xE9rieur. Le num\xE9ro de build n\x27est pas significatif par rapport \xE0 la compatibilit\xE9 de la librairie.

',ret:'une cha\xEEne de caract\xE8res d\xE9crivant la version de la librairie.'} ,'GetTickCount':{syn:'Retourne la valeur du compteur monotone de temps (en millisecondes).',lib:'YAPI.GetTickCount()',pro:'function GetTickCount()',cmt:'

Retourne la valeur du compteur monotone de temps (en millisecondes). Ce compteur peut \xEAtre utilis\xE9 pour calculer des d\xE9lais en rapport avec les modules Yoctopuce, dont la base de temps est aussi la milliseconde.

',ret:'un long entier contenant la valeur du compteur de millisecondes.'} ,'HandleEvents':{syn:'Maintient la communication de la librairie avec les modules Yoctopuce.',lib:'YAPI.HandleEvents()',pro:'function HandleEvents(errmsg)',cmt:'

Maintient la communication de la librairie avec les modules Yoctopuce. Si votre programme inclut des longues boucles d\x27attente, vous pouvez y inclure un appel \xE0 cette fonction pour que la librairie prenne en charge les informations mise en attente par les modules sur les canaux de communication. Ce n\x27est pas strictement indispensable mais cela peut am\xE9liorer la r\xE9activit\xE9 des la librairie pour les commandes suivantes.

Cette fonction peut signaler une erreur au cas \xE0 la communication avec un module Yoctopuce ne se passerait pas comme attendu.

',par:{errmsg:'une cha\xEEne de caract\xE8res pass\xE9e par r\xE9f\xE9rence, dans laquelle sera stock\xE9 un \xE9ventuel message d\x27erreur.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur retourne un code d\x27erreur n\xE9gatif.'} ,'InitAPI':{syn:'Initialise la librairie de programmation de Yoctopuce explicitement.',lib:'YAPI.InitAPI()',pro:'function InitAPI(mode, errmsg)',cmt:'

Initialise la librairie de programmation de Yoctopuce explicitement. Il n\x27est pas indispensable d\x27appeler yInitAPI(), la librairie sera automatiquement initialis\xE9e de toute mani\xE8re au premier appel \xE0 yRegisterHub().

Lorsque cette fonctin est utilis\xE9e avec comme mode la valeur YAPI.DETECT_NONE, il faut explicitement appeler yRegisterHub() pour indiquer \xE0 la librairie sur quel VirtualHub les modules sont connect\xE9s, avant d\x27essayer d\x27y acc\xE9der.

',par:{mode:'un entier sp\xE9cifiant le type de d\xE9tection automatique de modules \xE0 utiliser. Les valeurs possibles sont YAPI.DETECT_NONE, YAPI.DETECT_USB, YAPI.DETECT_NET et YAPI.DETECT_ALL.',errmsg:'une cha\xEEne de caract\xE8res pass\xE9e par r\xE9f\xE9rence, dans laquelle sera stock\xE9 un \xE9ventuel message d\x27erreur.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur retourne un code d\x27erreur n\xE9gatif.'} ,'PreregisterHub':{syn:'Alternative plus tol\xE9rante \xE0 yRegisterHub().',lib:'YAPI.PreregisterHub()',pro:'function PreregisterHub(url, errmsg)',cmt:'

Alternative plus tol\xE9rante \xE0 yRegisterHub(). Cette fonction a le m\xEAme but et les m\xEAme param\xE8tres que la fonction yRegisterHub(), mais contrairement \xE0 celle-ci yPreregisterHub() ne d\xE9clenche pas d\x27erreur si le hub choisi n\x27est pas joignable au moment de l\x27appel. Si la connexion ne peut \xEAtre \xE9tablie imm\xE9diatement, une t\xE2che d\x27arri\xE8re-plan fera automatiquement et p\xE9riodiquement de nouvelles tentatives. Il est ainsi possible d\x27enregistrer un hub r\xE9seau ind\xE9pendemment de la connectivit\xE9, afin de tenter de ne le contacter que lorsqu\x27on cherche r\xE9ellement un module.

',par:{url:'une cha\xEEne de caract\xE8res contenant \x22usb\x22,\x22callback\x22, ou l\x27URL racine du VirtualHub \xE0 utiliser.',errmsg:'une cha\xEEne de caract\xE8res pass\xE9e par r\xE9f\xE9rence, dans laquelle sera stock\xE9 un \xE9ventuel message d\x27erreur.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur retourne un code d\x27erreur n\xE9gatif.'} ,'RegisterDeviceArrivalCallback':{syn:'Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque fois qu\x27un module est branch\xE9.',lib:'YAPI.RegisterDeviceArrivalCallback()',pro:'function RegisterDeviceArrivalCallback(arrivalCallback)',cmt:'

Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque fois qu\x27un module est branch\xE9. Le callback sera appel\xE9 pendant l\x27\xE9xecution de la fonction yUpdateDeviceList, que vous devrez appeler r\xE9guli\xE8rement.

',par:{arrivalCallback:'une proc\xE9dure qui prend un YModule en param\xE8tre, ou null pour supprimer un callback d\xE9ja enregistr\xE9.'}} ,'RegisterDeviceRemovalCallback':{syn:'Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque fois qu\x27un module est d\xE9branch\xE9.',lib:'YAPI.RegisterDeviceRemovalCallback()',pro:'function RegisterDeviceRemovalCallback(removalCallback)',cmt:'

Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque fois qu\x27un module est d\xE9branch\xE9. Le callback sera appel\xE9 pendant l\x27\xE9xecution de la fonction yUpdateDeviceList, que vous devrez appeler r\xE9guli\xE8rement.

',par:{removalCallback:'une proc\xE9dure qui prend un YModule en param\xE8tre, ou null pour supprimer un callback d\xE9ja enregistr\xE9.'}} ,'RegisterHub':{syn:'Configure la librairie Yoctopuce pour utiliser les modules connect\xE9s sur une machine donn\xE9e.',lib:'YAPI.RegisterHub()',pro:'function RegisterHub(url, errmsg)',cmt:'

Configure la librairie Yoctopuce pour utiliser les modules connect\xE9s sur une machine donn\xE9e. Id\xE9alement cet appel sera fait une fois au d\xE9but de votre application. Le premier param\xE8tre d\xE9termine le fonctionnement de l\x27API, il peut prendre les valeurs suivantes:

usb: Si vous utilisez le mot-cl\xE9 usb, l\x27API utilise les modules Yoctopuce connect\xE9s directement par USB. Certains langages comme PHP, Javascript et Java ne permettent pas un acc\xE8s direct aux couches mat\xE9rielles, usb ne marchera donc pas avec ces langages. Dans ce cas, utilisez un VirtualHub ou un YoctoHub r\xE9seau (voir ci-dessous).

x.x.x.x ou hostname: L\x27API utilise les modules connect\xE9s \xE0 la machine dont l\x27adresse IP est x.x.x.x, ou dont le nom d\x27h\xF4te DNS est hostname. Cette machine peut \xEAtre un ordinateur classique faisant tourner un VirtualHub natif, un VirtualHub for web h\xE9berg\xE9 sur un serveur ou un YoctoHub avec r\xE9seau (YoctoHub-Ethernet / YoctoHub-Wireless). Si vous d\xE9sirez utiliser le VirtualHub tournant sur votre machine locale, utilisez l\x27adresse IP 127.0.0.1. En l\x27absence de r\xE9ponse de la part de l\x27adresse IP donn\xE9e en param\xE8tre, yRegisterHub ne rendra la main qu\x27une fois le d\xE9lai contr\xF4l\xE9 par ySetNetworkTimeout \xE9coul\xE9. Cependant il est possible de tester pr\xE9ventivement une connexion avec yTestHub. Si vous ne pouvez pas vous permettre un d\xE9lai d\x27attente en cas de probl\xE8me de connexion, vous pouvez utiliser la fonction non-bloquante yPregisterHub qui \xE9tablira automatiquement la connexion d\xE8s que possible.

callback Le mot-cl\xE9 callback permet de faire fonctionner l\x27API dans un mode appel\xE9 \x22callback HTTP\x22. C\x27est un mode sp\xE9cial permettant, entre autres, de prendre le contr\xF4le de modules Yoctopuce \xE0 travers un filtre NAT par l\x27interm\xE9diaire d\x27un VirtualHub ou d\x27un Hub Yoctopuce. Il vous suffit de configurer le hub pour qu\x27il appelle votre script \xE0 intervalle r\xE9gulier. Ce mode de fonctionnement n\x27est disponible actuellement qu\x27en PHP et en Node.JS.

Attention, une seule application peut fonctionner \xE0 la fois sur une machine donn\xE9e en acc\xE8s direct \xE0 USB, sinon il y aurait un conflit d\x27acc\xE8s aux modules. Cela signifie en particulier que vous devez stopper le VirtualHub avant de lancer une application utilisant l\x27acc\xE8s direct \xE0 USB. Cette limitation peut \xEAtre contourn\xE9e en passant par un VirtualHub plut\xF4t que d\x27utiliser directement USB.

Si vous d\xE9sirez vous connecter \xE0 un Hub, virtuel ou non, sur lequel le contr\xF4le d\x27acc\xE8s a \xE9t\xE9 activ\xE9, vous devez donner le param\xE8tre url sous la forme:

http://nom:mot_de_passe@adresse:port

Vous pouvez appeler RegisterHub plusieurs fois pour vous connecter \xE0 plusieurs machines diff\xE9rentes. Par contre, il est inutile et contre-productif d\x27appeler RegisterHub avec la m\xEAme adresse plusieurs fois dans la vie de l\x27application. \x09\x09

',par:{url:'une cha\xEEne de caract\xE8res contenant \x22usb\x22,\x22callback\x22, ou l\x27URL racine du VirtualHub \xE0 utiliser.',errmsg:'une cha\xEEne de caract\xE8res pass\xE9e par r\xE9f\xE9rence, dans laquelle sera stock\xE9 un \xE9ventuel message d\x27erreur.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur retourne un code d\x27erreur n\xE9gatif.'} ,'SetTimeout':{syn:'Appelle le callback sp\xE9cifi\xE9 apr\xE8s un temps d\x27attente sp\xE9cifi\xE9.',lib:'YAPI.SetTimeout()',pro:'function SetTimeout(callback, ms_timeout, args)',cmt:'

Appelle le callback sp\xE9cifi\xE9 apr\xE8s un temps d\x27attente sp\xE9cifi\xE9. Cette fonction se comporte plus ou moins comme la fonction Javascript setTimeout, mais durant le temps d\x27attente, elle va appeler yHandleEvents et yUpdateDeviceList p\xE9riodiquement pour maintenir l\x27API \xE0 jour avec les modules connect\xE9s.

',par:{callback:'la fonction \xE0 appeler lorsque le temps d\x27attente est \xE9coul\xE9. Sous Microsoft Internet Explorer, le callback doit \xEAtre sp\xE9cifi\xE9 sous forme d\x27une string \xE0 \xE9valuer.',ms_timeout:'un entier correspondant \xE0 la dur\xE9e de l\x27attente, en millisecondes',args:'des arguments suppl\xE9mentaires peuvent \xEAtre fournis, pour \xEAtre pass\xE9s \xE0 la fonction de callback si n\xE9cessaire.'},ret:'YAPI.SUCCESS'} ,'Sleep':{syn:'Effectue une pause dans l\x27ex\xE9cution du programme pour une dur\xE9e sp\xE9cifi\xE9e.',lib:'YAPI.Sleep()',pro:'function Sleep(ms_duration, errmsg)',cmt:'

Effectue une pause dans l\x27ex\xE9cution du programme pour une dur\xE9e sp\xE9cifi\xE9e. L\x27attente est passive, c\x27est-\xE0-dire qu\x27elle n\x27occupe pas significativement le processeur, de sorte \xE0 le laisser disponible pour les autres processus fonctionnant sur la machine. Durant l\x27attente, la librairie va n\xE9anmoins continuer \xE0 lire p\xE9riodiquement les informations en provenance des modules Yoctopuce en appelant la fonction yHandleEvents() afin de se maintenir \xE0 jour.

Cette fonction peut signaler une erreur au cas \xE0 la communication avec un module Yoctopuce ne se passerait pas comme attendu.

',par:{ms_duration:'un entier correspondant \xE0 la dur\xE9e de la pause, en millisecondes',errmsg:'une cha\xEEne de caract\xE8res pass\xE9e par r\xE9f\xE9rence, dans laquelle sera stock\xE9 un \xE9ventuel message d\x27erreur.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur retourne un code d\x27erreur n\xE9gatif.'} ,'UnregisterHub':{syn:'Configure la librairie Yoctopuce pour ne plus utiliser les modules connect\xE9s sur une machine pr\xE9alablement enregistrer avec RegisterHub.',lib:'YAPI.UnregisterHub()',pro:'function UnregisterHub(url)',cmt:'

Configure la librairie Yoctopuce pour ne plus utiliser les modules connect\xE9s sur une machine pr\xE9alablement enregistrer avec RegisterHub.

',par:{url:'une cha\xEEne de caract\xE8res contenant \x22usb\x22 ou l\x27URL racine du VirtualHub \xE0 ne plus utiliser.'}} ,'UpdateDeviceList':{syn:'Force une mise-\xE0-jour de la liste des modules Yoctopuce connect\xE9s.',lib:'YAPI.UpdateDeviceList()',pro:'function UpdateDeviceList(errmsg)',cmt:'

Force une mise-\xE0-jour de la liste des modules Yoctopuce connect\xE9s. La librairie va v\xE9rifier sur les machines ou ports USB pr\xE9c\xE9demment enregistr\xE9s en utilisant la fonction yRegisterHub si un module a \xE9t\xE9 connect\xE9 ou d\xE9connect\xE9, et le cas \xE9ch\xE9ant appeler les fonctions de callback d\xE9finies par l\x27utilisateur.

Cette fonction peut \xEAtre appel\xE9e aussi souvent que d\xE9sir\xE9, afin de rendre l\x27application r\xE9active aux \xE9v\xE8nements de hot-plug. N\xE9anmoins la d\xE9tection des modules \xE9tant un processus assez lourd, il est recommand\xE9 de ne pas appeler UpdateDeviceList plus d\x27une fois toutes les deux secondes.

',par:{errmsg:'une cha\xEEne de caract\xE8res pass\xE9e par r\xE9f\xE9rence, dans laquelle sera stock\xE9 un \xE9ventuel message d\x27erreur.'},ret:'YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur retourne un code d\x27erreur n\xE9gatif.'} ,'UpdateDeviceList_async':{syn:'Force une mise-\xE0-jour de la liste des modules Yoctopuce connect\xE9s.',lib:'YAPI.UpdateDeviceList_async()',pro:'function UpdateDeviceList_async(callback, context)',cmt:'

Force une mise-\xE0-jour de la liste des modules Yoctopuce connect\xE9s. La librairie va v\xE9rifier sur les machines ou ports USB pr\xE9c\xE9demment enregistr\xE9s en utilisant la fonction yRegisterHub si un module a \xE9t\xE9 connect\xE9 ou d\xE9connect\xE9, et le cas \xE9ch\xE9ant appeler les fonctions de callback d\xE9finies par l\x27utilisateur.

Cette fonction peut \xEAtre appel\xE9e aussi souvent que d\xE9sir\xE9, afin de rendre l\x27application r\xE9active aux \xE9v\xE9nements de hot-plug.

Cette version asynchrone n\x27existe qu\x27en Javascript. Elle utilise une fonction de callback plut\xF4t qu\x27une simple valeur de retour, pour \xE9viter de bloquer la VM Javascript de Firefox, qui n\x27impl\xE9mente pas le passage de contr\xF4le entre threads durant les appels d\x27entr\xE9e/sortie bloquants.

',par:{callback:'fonction de callback qui sera appel\xE9e d\xE8s que le r\xE9sultat sera connu. La fonction callback re\xE7oit deux arguments: le contexte fourni par l\x27appelant et le code de retour (YAPI.SUCCESS si l\x27op\xE9ration se d\xE9roule sans erreur).',context:'contexte fourni par l\x27appelant, et qui sera pass\xE9 tel-quel \xE0 la fonction de callback'},ret:'rien du tout : le r\xE9sultat sera pass\xE9 en param\xE8tre \xE0 la fonction de callback.'} }; //--- (end of generated code: YAPI) //--- (end of generated code) function isProperty(clname,m){return doc[clname][m].lib.indexOf('(')==-1&&Language!='Objective-C';} function isClassMethod(clname,m){return(clname=='YAPI'&&doc[clname][m].pro?doc[clname][m].pro.indexOf('static')>=0:/^[A-Z].*/.test(m));} function MethodType(clname,m){return(isProperty(clname,m)?'property':isClassMethod(clname,m)?'static':'method');} for(clname in doc){for(funcname in doc[clname]){if(isClassMethod(clname,funcname)){sub['y'+funcname]=doc[clname][funcname].lib;}}} function ApplySub(text,clname,attrname){var pos,endpos=0,key,rep,prefix,skip,cname;if(!text)return'';if(sub['null']!='null')text=text.replace('null',''+sub['null']+'');prefix=(clname.substr(0,1)!='Y'?'Y'+clname:clname);skip=2;if(Language.substr(-5)=='Proxy'){if(/^[gs]et_.*/.test(attrname))attrname=attrname.substr(4);prefix=clname.toLowerCase()+'._';if(attrname!='mountPosition'&&attrname!='drawText'){skip+=attrname.length;prefix+=attrname.substr(0,1).toUpperCase()+attrname.substr(1);}}else if(sub['YAPI_SUCCESS']){prefix=sub['YAPI_SUCCESS'].replace('YAPI',prefix).replace('SUCCESS','');}else{prefix+='.';} while((pos=text.toLowerCase().indexOf('',endpos))>=endpos){pos+=4;endpos=text.indexOf('0&&text.substr(pos-7,2)!='VI'&&text.substr(endpos+6,2)!='VI'){cname+='Proxy';} rep=''+cname+'';}}else if((key=inside.match(/^y([A-Z][A-Za-z0-9]+).*/))!==null){ident=key[1];key=key[0].substr(1);if(key.match(/(First|Find)[A-Za-z0-9]+.*/)){if(!UseShortcuts)rep=inside.substr(1);}else{if(!UseShortcuts){rep=sub['YAPI_SUCCESS'].replace('SUCCESS',inside.substr(1));if(doc['YAPI'][ident]){rep=''+rep+'';}}else{if(doc['YAPI'][ident]){rep=''+inside+'';}}}}else if((key=inside.match(/^([A-Za-z][A-Za-z0-9]+)(\.|::)([A-Za-z_0-9]+).*/))!==null){cident=key[1].substr(0,1).toUpperCase()+key[1].substr(1);mident=key[3];if(cident.substr(0,4)!='YAPI'&&cident[0]=='Y')cident=cident.substr(1);if(cident.match(/.*Proxy$/))cident=cident.slice(0,-5);if(!UseShortcuts){rep=inside;}else if(mident.match(/(First|Find)[A-Za-z0-9]+.*/)||cident=='YAPI'){rep='y'+mident;} if(doc[cident]&&doc[cident][mident]){rep=''+rep+'';}}else if((key=inside.match(/^(saveToFlash|isOnline).*/))!==null){rep=''+inside+'';} if(rep)text=text.substr(0,pos)+rep+text.substr(endpos);} return text;} function wdg(n){return document.getElementById(n);} function SetPosition(o,x,y){var it=wdg(o);it.style.top=y;it.style.left=x;} function GetPositionX(o){var it=wdg(o);return parseInt(it.style.left);} function GetPositionY(o){var it=wdg(o);return parseInt(it.style.top);} function GetWidth(o){var it=wdg(o);return parseInt(it.style.width);} function GetHeight(o){var it=wdg(o);return parseInt(it.style.height);} function SetHeight(o,h){var it=wdg(o);h=parseInt(h);if(h<0)h=0;it.style.height=h+"px";} function SetWidth(o,w){var it=wdg(o);w=parseInt(w);if(w<0)w=0;it.style.width=parseInt(w)+"px";} function SetLeft(o,l){var it=wdg(o);it.style.left=parseInt(l)+"px";} function SetTop(o,t){var it=wdg(o);it.style.top=parseInt(t)+"px";} function SetSize(o,w,h){var it=wdg(o);w=parseInt(w);if(w<0)w=0;h=parseInt(h);if(h<0)h=0;it.style.width=w;it.style.height=h;} function GetWindowWidth(){return parseInt(document.body.clientWidth);} function GetWindowHeight(){return parseInt(document.body.clientHeight);} function computeWinWH(){WinW=GetWindowWidth()-2;if(WinW<600)WinW=600;WinH=GetWindowHeight()-2;if(WinH<400)WinH=400;} function getInnerHeight(){var D=document;return Math.max(Math.max(D.body.scrollHeight,D.documentElement.scrollHeight),Math.max(D.body.offsetHeight,D.documentElement.offsetHeight),Math.max(D.body.clientHeight,D.documentElement.clientHeight));} function getInnerWidth(){var D=document;return Math.max(Math.max(D.body.scrollWidth,D.documentElement.scrollWidth),Math.max(D.body.offsetWidth,D.documentElement.offsetWidth),Math.max(D.body.clientWidth,D.documentElement.clientWidth));} function onResize(fct){fct();resizeCallBacks[resizeCallBacks.length]=fct;} function windowResized(){computeWinWH() for(var i=0;i=32)&&(ascii<=127)&&(ascii!=34)&&(ascii!=39))str_out=str_out+str_in.charAt(i);else{var hex=ascii.toString(16).toUpperCase();if(hex.length==1)hex='0'+hex;str_out=str_out+String.fromCharCode(92)+'x'+hex;}} return str_out;} function resizeMargin(){SetSize("MarginLayer",marginSize,WinH-110);SetLeft("FunctionsLayer",marginSize);SetSize("FunctionsLayer",WinW-marginSize,WinH-110);} function resizeSeparator(){SetHeight("separatorLayer",WinH-110);} function positionObject(int_x,int_y){this.x=int_x;this.y=int_y;} function GetEventPosition(event){var x,y;if(event.changedTouches){x=event.changedTouches[0].pageX;y=event.changedTouches[0].pageY;} else{x=event.PageX;y=event.PageY;if(!x){x=event.clientX+document.body.scrollLeft;y=event.clientY+document.body.scrollTop;}} return new positionObject(x,y);} function EnableDrag(var_element,onDragMove,onDragEnd){if(document.addEventListener){var_element.addEventListener("mousedown",Drag_start,false);var_element.addEventListener("touchstart",Drag_start,false);} else if(document.attachEvent) var_element.attachEvent("onmousedown",Drag_start);if(onDragMove)var_element.onDragMove=onDragMove;if(onDragEnd)var_element.onDragEnd=onDragEnd;} var LastDraggedObject=null;function DraggedObject(obj_element,obj_elmtInitialPos,obj_mouseInitalPos){this.element=obj_element;this.elmtInitialPos=obj_elmtInitialPos;this.elmtCurrentPos=new positionObject(obj_elmtInitialPos.x,obj_elmtInitialPos.y);this.mouseInitialPos=obj_mouseInitalPos;} function Drag_start(event){if(!event)event=window.event;var source=event.srcElement;if(event.button!=undefined){if((event.button!=1)&&(document.attachEvent))return;if((event.button!=0)&&(document.addEventListener))return;} if(!source)source=this;if(!source)return;var originalsource=source;while(source.tagName!="DIV"){if(source.tagName=="A")return false;source=source.parentNode;} if(event.preventDefault)event.preventDefault();source.style.cursor="col-resize";lastDraggedObject=new DraggedObject(source,new positionObject(parseInt(source.style.left),parseInt(source.style.top)),GetEventPosition(event));if(document.addEventListener){document.addEventListener("mousemove",Drag_mouseCapture,false);document.addEventListener("mouseup",Drag_stopMouseCapture,false);document.addEventListener("touchmove",Drag_mouseCapture,false);document.addEventListener("touchend",Drag_stopMouseCapture,false);} else if(document.attachEvent){document.attachEvent("onmousemove",Drag_mouseCapture);document.attachEvent("onmouseup",Drag_stopMouseCapture);} document.onmouseup=Drag_stopMouseCapture;} function Drag_mouseCapture(event){if(!event)event=window.event;var position=GetEventPosition(event);if(event.preventDefault)event.preventDefault();var x=(lastDraggedObject.elmtInitialPos.x+position.x-lastDraggedObject.mouseInitialPos.x);var y=(lastDraggedObject.elmtInitialPos.y+position.y-lastDraggedObject.mouseInitialPos.y);var iw=getInnerWidth() var ih=getInnerHeight();var w=lastDraggedObject.element.offsetWidth;var h=lastDraggedObject.element.offsetHeight;if(x>iw-w)x=iw-w;if(y>ih-h)y=ih-h;if(x<0)x=0;if(y<0)y=0;var p={x:x,y:y};if(lastDraggedObject.element.onDragMove) lastDraggedObject.element.onDragMove(lastDraggedObject.element,p);lastDraggedObject.elmtCurrentPos.x=p.x;lastDraggedObject.elmtCurrentPos.y=p.y;lastDraggedObject.element.style.left=p.x+"px";lastDraggedObject.element.style.top=p.y+"px";} function Drag_stopMouseCapture(){if(document.removeEventListener){document.removeEventListener("mousemove",Drag_mouseCapture,false);document.removeEventListener("mouseup",Drag_stopMouseCapture,false);document.removeEventListener("touchmove",Drag_mouseCapture,false);document.removeEventListener("touchend",Drag_stopMouseCapture,false);} else if(document.detachEvent){document.detachEvent("onmousemove",Drag_mouseCapture);document.detachEvent("onmouseup",Drag_stopMouseCapture);} if(lastDraggedObject){lastDraggedObject.element.style.cursor='col-resize';if(lastDraggedObject.element.onDragEnd) lastDraggedObject.element.onDragEnd(lastDraggedObject.element,{x:lastDraggedObject.elmtCurrentPos.x,y:lastDraggedObject.elmtCurrentPos.y});} lastDraggedObject=null;} function marginMove(el,pos){pos.y=80;if(pos.x<100)pos.x=100;if(pos.x>WinW-100)pos.x=WinW-100;marginSize=pos.x;resizeMargin()} function proto(clname,m){var funcproto=doc[clname][m].pro;if(isClassMethod(clname,m)){if(UseShortcuts){funcproto=funcproto.replace(m,'y'+m);}else if(doc[clname][m].lib.substr(0,1)=='['&&funcproto.substr(0,1)!='+'){var params=doc[clname][m].par;var methodpos=funcproto.search(m);var endrettype=methodpos;while(endrettype>0&&funcproto.substr(endrettype-1,1)==' ')endrettype--;var newproto="+("+funcproto.substr(0,endrettype)+") "+m;var pos=methodpos+m.length;for(var p in params){pos+=funcproto.slice(pos).search(/[A-Za-z]/);var argpos=pos+funcproto.slice(pos).search('pos&&funcproto.substr(endargtype-1,1)==' ')endargtype--;var endarg=argpos+funcproto.slice(argpos).search(/[,)]/);newproto+=": ("+funcproto.slice(pos,endargtype)+") "+funcproto.slice(argpos,endarg)+" ";pos=endarg;} funcproto=newproto;}} return funcproto} var lastindex_shown="";var lastname_shown=null;function Show(clname,str_name,nohist){if(!clname&&!str_name){wdg("FunctionsLayerInner").innerHTML=NotFound;return;} var fcthtml=NotFound;lastindex_shown=clname;if(clname&&str_name&&doc[clname]&&doc[clname][str_name]){lastname_shown=str_name;var fct=doc[clname][str_name];var funcname=fct.lib.replace('%',clname.toLowerCase());var funcproto=proto(clname,str_name);if(UseShortcuts&&isClassMethod(clname,str_name)){funcname='y'+str_name+'()';} fcthtml=""+funcname+'' +"

"+funcproto+'' +'

'+ApplySub(fct.cmt,clname,str_name);if(fct.par){fcthtml+=""+ParamLabel+'
\n';fcthtml+='' for(var p in fct.par) fcthtml+='\n';fcthtml+='
'+p+' : '+ApplySub(fct.par[p],clname,str_name)+'

'} if(fct.ret){fcthtml+=""+ReturnLabel+'
\n';fcthtml+='

'+ApplySub(fct.ret,clname,str_name)+'

\n';} if(fct.ext)fcthtml+=ApplySub(fct.ext,clname,str_name);var newstate=clname+'.'+str_name;if(newstate!=history.state&&!nohist){history.pushState(newstate,newstate,'#'+newstate);}} else if(clname&&doc[clname]){fcthtml=""+clname+'
' +"

"+ApplySub(doc[clname][''].syn,clname,str_name)+"

" +(doc[clname][''].inc!=""?"

"+IncludeLabel+"

"+doc[clname][''].inc+"

":"") +"

"+ApplySub(doc[clname][''].cmt,clname,str_name)+"

";var prevmtype='';for(m in doc[clname]){if(m!=''){var funcproto=proto(clname,m);var mtype=MethodType(clname,m);if(prevmtype!=mtype){prevmtype=mtype;fcthtml+=""+MethodTypes[mtype]+"";if(clname!='YAPI'&&clname!='RfidOptions'){fcthtml+="

"+MethodExtra[mtype]+"

";}} fcthtml+="

"+funcproto+'
' +""+ApplySub(doc[clname][m].syn,clname,str_name)+'

';}} var newstate=clname;if(newstate!=history.state&&!nohist){history.pushState(newstate,newstate,'#'+newstate);}} wdg("FunctionsLayerInner").innerHTML=fcthtml;setTimeout("wdg('FunctionsLayer').scrollTop=0;",20);} function expand(source,openonly){if(wdg(source.id+"List").style.display==''&&!openonly){wdg(source.id+"List").style.display='none';wdg(source.id).src=plusimage;} else{wdg(source.id+"List").style.display='';wdg(source.id).src=minusimage;}} function ShowFunctions(str_currentclname){var marginhtml="";for(var clname in doc){var icon=plusimage;var onck=" onclick='expand(this";var iclass="expandColapse";var display="none";var methodlist="";for(var method in doc[clname]){if(method!=''){var funcname=doc[clname][method].lib.replace('%',clname.toLowerCase());var mclass=(ShowIcons?MethodType(clname,method):'noicon');if(UseShortcuts&&mclass=='static')funcname='y'+method+'()';methodlist+=""+funcname+'';}} if(methodlist==""){iclass="noExpand";onck=" ony='(";}else if(str_currentclname==clname){icon=minusimage;onck=" onclick='expand(this";display=""} marginhtml+="  ";marginhtml+=""+clname+'
';if(methodlist!="")marginhtml+="
"+methodlist+"
";if(clname=='YAPI'||clname=='FreeAPI')marginhtml+='
';} wdg("MarginLayer").innerHTML=marginhtml;} function fctMatch(clname,method,values){var found=new Array() var tosearch=new Array() for(var i=0;i=0;if(!found)found=method.search(expr)>=0;if(!found&&fct.inc){if(!found&&fct.syn)found=fct.syn.search(expr)>=0;if(!found)found=fct.inc.search(expr)>=0;} if(!found&&fct.pro)found=fct.pro.search(expr)>=0;if(fct.par) for(var p in fct.par){if(!found)found=p.search(expr)>=0;if(!found)found=fct.par[p].search(expr)>=0;} if(fct.ret){if(!found)found=fct.ret.search(expr)>=0;} if(!found&&fct.cmt)found=fct.cmt.search(expr)>=0;if(!found&&fct.ext)found=fct.ext.search(expr)>=0;if(!found)return false;} return true;} var searchTimer=null;function doSearch(){searchTimer=null;var value=document.forms['yoctoForm'].elements['search'].value;if(value==''){for(var clname in doc){var container=wdg(clname+"List");for(var method in doc[clname]) if(method!=''){var it=wdg(clname+'.'+method);if(it)it.style.display="block";} wdg(clname).style.visibility='visible';var container=wdg(clname+"List");if(container["originalDisplay"]!=""){wdg(clname+"List").style.display='none';wdg(clname).src=plusimage;} else{wdg(clname+"List").style.display='';wdg(clname).src=minusimage;} container["originalDisplay"]=null;} Show(lastindex_shown,lastname_shown);return;} var firstindex='';var firstname='';qvalue=value;value='';for(var i=0;i1){var words=window.location.hash.substr(1).split('.');var cname=words[0];if(cname!="YAPI"&&cname[0]=='Y')cname=cname.substr(1);if(doc[cname]){defclass=words[0];ShowFunctions(defclass);if(words.length>1&&doc[defclass][words[1]]){defmethod=words[1];var idxwdg=wdg('MarginLayer');var itemwdg=wdg(defclass+'.'+defmethod);var scrollTop=Math.max(itemwdg.offsetTop-(idxwdg.clientHeight>>1),0);setTimeout("wdg('MarginLayer').scrollTop="+scrollTop+";",20);}}else{ShowFunctions();}}else{ShowFunctions();} Show(defclass,defmethod,(arg==='NoH'));} function InitHTMLRef(){wdg('langdt').innerHTML=Language;computeWinWH();onResize(function(){SetWidth("BannerLayer",WinW)});onResize(resizeMargin);onResize(function(){SetWidth("FooterLayer",WinW);SetTop("FooterLayer",WinH-30);});onResize(resizeSeparator);EnableDrag(wdg("separatorLayer"),marginMove,marginMove);if(UseShortcuts!=null){var td=wdg("oosyntax");var widget=' '+AbbrevLabel;td.innerHTML=widget;td.title=AbbrevHint;td.alt=AbbrevHint;} if(Language!='LabVIEW'){var rule='';var types=['int','obj','dbl','str','arr','bool'];for(var i=0;i
2024-03-18