',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:

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

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: Network) doc['Network']={'':{syn:'Interface de la fonction Network',inc:'<script type='text/javascript' src='yocto_network.js'></script>',cmt:'

Les objets YNetwork permettent de contr\xF4ler les param\xE8tres TCP/IP des modules Yoctopuce dot\xE9s d\x27une interface r\xE9seau.

'}}; doc['Network']['FindNetwork']={syn:'Permet de retrouver une interface r\xE9seau d\x27apr\xE8s un identifiant donn\xE9.',lib:'YNetwork.FindNetwork()',pro:'function FindNetwork(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27interface r\xE9seau soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YNetwork.isOnline()` pour tester si l\x27interface r\xE9seau 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 l\x27interface r\xE9seau sans ambigu\xEFt\xE9'},ret:'un objet de classe `YNetwork` qui permet ensuite de contr\xF4ler l\x27interface r\xE9seau.'}; doc['Network']['FirstNetwork']={syn:'Commence l\x27\xE9num\xE9ration des interfaces r\xE9seau accessibles par la librairie.',lib:'YNetwork.FirstNetwork()',pro:'function FirstNetwork()',cmt:'

Commence l\x27\xE9num\xE9ration des interfaces r\xE9seau accessibles par la librairie. Utiliser la fonction `YNetwork.nextNetwork()` pour it\xE9rer sur les autres interfaces r\xE9seau.

',ret:'un pointeur sur un objet `YNetwork`, correspondant \xE0 la premi\xE8re interface r\xE9seau accessible en ligne, ou `null` si il n\x27y a pas de interfaces r\xE9seau disponibles.'}; doc['Network']['callbackLogin']={syn:'Contacte le callback de notification et sauvegarde un laisser-passer pour s\x27y connecter.',lib:'network.callbackLogin()',pro:'function callbackLogin(username, password)',cmt:'

Contacte le callback de notification et sauvegarde un laisser-passer pour s\x27y connecter. Le mot de passe ne sera pas stock\xE9 dans le module, mais seulement une version hash\xE9e non r\xE9versible. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

',par:{username:'nom d\x27utilisateur pour s\x27identifier au callback',password:'mot de passe pour s\x27identifier au callback'},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.'}; doc['Network']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27interface r\xE9seau au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'network.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27interface r\xE9seau 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 (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Network']['get_adminPassword']={syn:'Retourne une cha\xEEne de hash si un mot de passe a \xE9t\xE9 configur\xE9 pour l\x27utilisateur \x22admin\x22, ou sinon une cha\xEEne vide.',lib:'network.get_adminPassword()',pro:'function get_adminPassword()',cmt:'

Retourne une cha\xEEne de hash si un mot de passe a \xE9t\xE9 configur\xE9 pour l\x27utilisateur \x22admin\x22, ou sinon une cha\xEEne vide.

',ret:'une chaîne de caractères représentant une cha\xEEne de hash si un mot de passe a \xE9t\xE9 configur\xE9 pour l\x27utilisateur \x22admin\x22, ou sinon une cha\xEEne vide',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ADMINPASSWORD_INVALID`.'}; doc['Network']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27interface r\xE9seau (pas plus de 6 caract\xE8res).',lib:'network.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27interface r\xE9seau (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Network']['get_callbackCredentials']={syn:'Retourne une version hash\xE9e du laisser-passer pour le callback de notification s\x27il a \xE9t\xE9 configur\xE9, ou sinon une cha\xEEne vide.',lib:'network.get_callbackCredentials()',pro:'function get_callbackCredentials()',cmt:'

Retourne une version hash\xE9e du laisser-passer pour le callback de notification s\x27il a \xE9t\xE9 configur\xE9, ou sinon une cha\xEEne vide.

',ret:'une chaîne de caractères représentant une version hash\xE9e du laisser-passer pour le callback de notification s\x27il a \xE9t\xE9 configur\xE9, ou sinon une cha\xEEne vide',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CALLBACKCREDENTIALS_INVALID`.'}; doc['Network']['get_callbackEncoding']={syn:'Retourne l\x27encodage \xE0 utiliser pour repr\xE9senter les valeurs notifi\xE9es par callback.',lib:'network.get_callbackEncoding()',pro:'function get_callbackEncoding()',cmt:'

Retourne l\x27encodage \xE0 utiliser pour repr\xE9senter les valeurs notifi\xE9es par callback.

',ret:'une valeur parmi `Y_CALLBACKENCODING_FORM`, `Y_CALLBACKENCODING_JSON`, `Y_CALLBACKENCODING_JSON_ARRAY`, `Y_CALLBACKENCODING_CSV` et `Y_CALLBACKENCODING_YOCTO_API` représentant l\x27encodage \xE0 utiliser pour repr\xE9senter les valeurs notifi\xE9es par callback',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CALLBACKENCODING_INVALID`.'}; doc['Network']['get_callbackMaxDelay']={syn:'Retourne l\x27attente maximale entre deux notifications par callback, en secondes.',lib:'network.get_callbackMaxDelay()',pro:'function get_callbackMaxDelay()',cmt:'

Retourne l\x27attente maximale entre deux notifications par callback, en secondes.

',ret:'un entier représentant l\x27attente maximale entre deux notifications par callback, en secondes',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CALLBACKMAXDELAY_INVALID`.'}; doc['Network']['get_callbackMethod']={syn:'Retourne la m\xE9thode HTTP \xE0 utiliser pour signaler les changements d\x27\xE9tat par callback.',lib:'network.get_callbackMethod()',pro:'function get_callbackMethod()',cmt:'

Retourne la m\xE9thode HTTP \xE0 utiliser pour signaler les changements d\x27\xE9tat par callback.

',ret:'une valeur parmi `Y_CALLBACKMETHOD_POST`, `Y_CALLBACKMETHOD_GET` et `Y_CALLBACKMETHOD_PUT` représentant la m\xE9thode HTTP \xE0 utiliser pour signaler les changements d\x27\xE9tat par callback',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CALLBACKMETHOD_INVALID`.'}; doc['Network']['get_callbackMinDelay']={syn:'Retourne l\x27attente minimale entre deux notifications par callback, en secondes.',lib:'network.get_callbackMinDelay()',pro:'function get_callbackMinDelay()',cmt:'

Retourne l\x27attente minimale entre deux notifications par callback, en secondes.

',ret:'un entier représentant l\x27attente minimale entre deux notifications par callback, en secondes',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CALLBACKMINDELAY_INVALID`.'}; doc['Network']['get_callbackUrl']={syn:'Retourne l\x27adresse (URL) de callback \xE0 notifier lors de changement d\x27\xE9tat significatifs.',lib:'network.get_callbackUrl()',pro:'function get_callbackUrl()',cmt:'

Retourne l\x27adresse (URL) de callback \xE0 notifier lors de changement d\x27\xE9tat significatifs.

',ret:'une chaîne de caractères représentant l\x27adresse (URL) de callback \xE0 notifier lors de changement d\x27\xE9tat significatifs',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CALLBACKURL_INVALID`.'}; doc['Network']['get_discoverable']={syn:'Retourne l\x27\xE9tat d\x27activation du protocole d\x27annonce sur le r\xE9seau permettant de retrouver facilement le module (protocols uPnP/Bonjour).',lib:'network.get_discoverable()',pro:'function get_discoverable()',cmt:'

Retourne l\x27\xE9tat d\x27activation du protocole d\x27annonce sur le r\xE9seau permettant de retrouver facilement le module (protocols uPnP/Bonjour).

',ret:'soit `Y_DISCOVERABLE_FALSE`, soit `Y_DISCOVERABLE_TRUE`, selon l\x27\xE9tat d\x27activation du protocole d\x27annonce sur le r\xE9seau permettant de retrouver facilement le module (protocols uPnP/Bonjour)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DISCOVERABLE_INVALID`.'}; doc['Network']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface r\xE9seau.',lib:'network.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. 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.'}; doc['Network']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface r\xE9seau.',lib:'network.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. 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.'}; doc['Network']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27interface r\xE9seau au format `NOM_MODULE.NOM_FONCTION`.',lib:'network.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27interface r\xE9seau en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Network']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'network.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Network']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27interface r\xE9seau, sans r\xE9f\xE9rence au module.',lib:'network.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27interface r\xE9seau 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 (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27interface r\xE9seau (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Network']['get_ipAddress']={syn:'Retourne l\x27adresse IP utilis\xE9e par le module Yoctopuce.',lib:'network.get_ipAddress()',pro:'function get_ipAddress()',cmt:'

Retourne l\x27adresse IP utilis\xE9e par le module Yoctopuce. Il peut s\x27agir d\x27une adresse configur\xE9e statiquement, ou d\x27une adresse re\xE7ue par un serveur DHCP.

',ret:'une chaîne de caractères représentant l\x27adresse IP utilis\xE9e par le module Yoctopuce',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_IPADDRESS_INVALID`.'}; doc['Network']['get_logicalName']={syn:'Retourne le nom logique de l\x27interface r\xE9seau.',lib:'network.get_logicalName()',pro:'function get_logicalName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27interface r\xE9seau.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Network']['get_macAddress']={syn:'Retourne l\x27adresse MAC de l\x27interface r\xE9seau, unique pour chaque module.',lib:'network.get_macAddress()',pro:'function get_macAddress()',cmt:'

Retourne l\x27adresse MAC de l\x27interface r\xE9seau, unique pour chaque module. L\x27adresse MAC est aussi pr\xE9sente sur un autocollant sur le module, repr\xE9sent\xE9e en chiffres et en code-barres.

',ret:'une chaîne de caractères représentant l\x27adresse MAC de l\x27interface r\xE9seau, unique pour chaque module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_MACADDRESS_INVALID`.'}; doc['Network']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'network.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['Network']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'network.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['Network']['get_poeCurrent']={syn:'Retourne le courant consomm\xE9 par le module depuis Power-over-Ethernet (PoE), en milliamp\xE8res.',lib:'network.get_poeCurrent()',pro:'function get_poeCurrent()',cmt:'

Retourne le courant consomm\xE9 par le module depuis Power-over-Ethernet (PoE), en milliamp\xE8res. La consommation est mesur\xE9e apr\xE8s conversion en 5 Volt, et ne doit jamais d\xE9passer 1800 mA.

',ret:'un entier représentant le courant consomm\xE9 par le module depuis Power-over-Ethernet (PoE), en milliamp\xE8res',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_POECURRENT_INVALID`.'}; doc['Network']['get_primaryDNS']={syn:'Retourne l\x27adresse IP du serveur de noms primaire que le module doit utiliser.',lib:'network.get_primaryDNS()',pro:'function get_primaryDNS()',cmt:'

Retourne l\x27adresse IP du serveur de noms primaire que le module doit utiliser.

',ret:'une chaîne de caractères représentant l\x27adresse IP du serveur de noms primaire que le module doit utiliser',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PRIMARYDNS_INVALID`.'}; doc['Network']['get_readiness']={syn:'Retourne l\x27\xE9tat de fonctionnement atteint par l\x27interface r\xE9seau.',lib:'network.get_readiness()',pro:'function get_readiness()',cmt:'

Retourne l\x27\xE9tat de fonctionnement atteint par l\x27interface r\xE9seau. Le niveau z\xE9ro (DOWN_0) signifie qu\x27aucun support r\xE9seau mat\xE9riel n\x27a \xE9t\xE9 d\xE9tect\xE9. Soit il n\x27y a pas de signal sur le cable r\xE9seau, soit le point d\x27acc\xE8s sans fil choisi n\x27est pas d\xE9tect\xE9. Le niveau 1 (LIVE_1) est atteint lorsque le r\xE9seau est d\xE9tect\xE9, mais n\x27est pas encore connect\xE9. Pour un r\xE9seau sans fil, cela confirme la l\x27existence du SSID configur\xE9. Le niveau 2 (LINK_2) est atteint lorsque le support mat\xE9riel du r\xE9seau est fonctionnel. Pour une connection r\xE9seau filaire, le niveau 2 signifie que le cable est connect\xE9 aux deux bouts. Pour une connection \xE0 un point d\x27acc\xE8s r\xE9seau sans fil, il d\xE9montre que les param\xE8tres de s\xE9curit\xE9s configur\xE9s sont corrects. Pour une connection sans fil en mode ad-hoc, cela signifie qu\x27il y a au moins un partenaire sur le r\xE9seau ad-hoc. Le niveau 3 (DHCP_3) est atteint lorsque qu\x27une adresse IP a \xE9t\xE9 obtenue par DHCP. Le niveau 4 (DNS_4) est atteint lorsqu\x27un serveur DNS est joignable par le r\xE9seau. Le niveau 5 (WWW_5) est atteint lorsque la connectivit\xE9 globale \xE0 internet est av\xE9r\xE9e par l\x27obtention de l\x27heure courante sur une serveur NTP.

',ret:'une valeur parmi `Y_READINESS_DOWN`, `Y_READINESS_EXISTS`, `Y_READINESS_LINKED`, `Y_READINESS_LAN_OK` et `Y_READINESS_WWW_OK` représentant l\x27\xE9tat de fonctionnement atteint par l\x27interface r\xE9seau',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_READINESS_INVALID`.'}; doc['Network']['get_router']={syn:'Retourne l\x27adresse IP du routeur (passerelle) utilis\xE9 par le module (default gateway).',lib:'network.get_router()',pro:'function get_router()',cmt:'

Retourne l\x27adresse IP du routeur (passerelle) utilis\xE9 par le module (default gateway).

',ret:'une chaîne de caractères représentant l\x27adresse IP du routeur (passerelle) utilis\xE9 par le module (default gateway)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ROUTER_INVALID`.'}; doc['Network']['get_secondaryDNS']={syn:'Retourne l\x27adresse IP du serveur de noms secondaire que le module doit utiliser.',lib:'network.get_secondaryDNS()',pro:'function get_secondaryDNS()',cmt:'

Retourne l\x27adresse IP du serveur de noms secondaire que le module doit utiliser.

',ret:'une chaîne de caractères représentant l\x27adresse IP du serveur de noms secondaire que le module doit utiliser',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SECONDARYDNS_INVALID`.'}; doc['Network']['get_subnetMask']={syn:'Retourne le masque de sous-r\xE9seau utilis\xE9 par le module.',lib:'network.get_subnetMask()',pro:'function get_subnetMask()',cmt:'

Retourne le masque de sous-r\xE9seau utilis\xE9 par le module.

',ret:'une chaîne de caractères représentant le masque de sous-r\xE9seau utilis\xE9 par le module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SUBNETMASK_INVALID`.'}; doc['Network']['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:'network.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['Network']['get_userPassword']={syn:'Retourne une cha\xEEne de hash si un mot de passe a \xE9t\xE9 configur\xE9 pour l\x27utilisateur \x22user\x22, ou sinon une cha\xEEne vide.',lib:'network.get_userPassword()',pro:'function get_userPassword()',cmt:'

Retourne une cha\xEEne de hash si un mot de passe a \xE9t\xE9 configur\xE9 pour l\x27utilisateur \x22user\x22, ou sinon une cha\xEEne vide.

',ret:'une chaîne de caractères représentant une cha\xEEne de hash si un mot de passe a \xE9t\xE9 configur\xE9 pour l\x27utilisateur \x22user\x22, ou sinon une cha\xEEne vide',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_USERPASSWORD_INVALID`.'}; doc['Network']['get_wwwWatchdogDelay']={syn:'Retourne la dur\xE9e de perte de connection WWW tol\xE9r\xE9e (en secondes) avant de d\xE9clancher un red\xE9marrage automatique pour tenter de r\xE9cup\xE9rer la connectivit\xE9 Internet.',lib:'network.get_wwwWatchdogDelay()',pro:'function get_wwwWatchdogDelay()',cmt:'

Retourne la dur\xE9e de perte de connection WWW tol\xE9r\xE9e (en secondes) avant de d\xE9clancher un red\xE9marrage automatique pour tenter de r\xE9cup\xE9rer la connectivit\xE9 Internet. Une valeur nulle d\xE9sactive le red\xE9marrage automatique en cas de perte de connectivit\xE9 WWW.

',ret:'un entier représentant la dur\xE9e de perte de connection WWW tol\xE9r\xE9e (en secondes) avant de d\xE9clancher un red\xE9marrage automatique pour tenter de r\xE9cup\xE9rer la connectivit\xE9 Internet',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_WWWWATCHDOGDELAY_INVALID`.'}; doc['Network']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau est joignable, sans d\xE9clencher d\x27erreur.',lib:'network.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27interface r\xE9seau 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 est joignable, `false` sinon'}; doc['Network']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau est joignable, sans d\xE9clencher d\x27erreur.',lib:'network.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27interface r\xE9seau 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.'}; doc['Network']['load']={syn:'Met en cache les valeurs courantes de l\x27interface r\xE9seau, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'network.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27interface r\xE9seau, 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.'}; doc['Network']['load_async']={syn:'Met en cache les valeurs courantes de l\x27interface r\xE9seau, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'network.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27interface r\xE9seau, 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.'}; doc['Network']['nextNetwork']={syn:'Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau commenc\xE9e \xE0 l\x27aide de `yFirstNetwork()`.',lib:'network.nextNetwork()',pro:'function nextNetwork()',cmt:'

Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau commenc\xE9e \xE0 l\x27aide de `yFirstNetwork()`.

',ret:'un pointeur sur un objet `YNetwork` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Network']['ping']={syn:'Ping str_host pour v\xE9rifier la connexion r\xE9seau.',lib:'network.ping()',pro:'function ping(host)',cmt:'

Ping str_host pour v\xE9rifier la connexion r\xE9seau. Envoie quatre requ\xEAtes ICMP ECHO_RESPONSER \xE0 la cible str_host depuis le module. Cette m\xE9thode retourne une cha\xEEne de caract\xE8res avec le r\xE9sultat des 4 requ\xEAtes ICMP ECHO_RESPONSE.

',par:{host:'le nom d\x27h\xF4te ou l\x27adresse IP de la cible'},ret:'une cha\xEEne de caract\xE8res contenant le r\xE9sultat du ping.'}; doc['Network']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'network.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['Network']['set_adminPassword']={syn:'Modifie le mot de passe pour l\x27utilisateur \x22admin\x22, qui devient alors instantan\xE9ment n\xE9cessaire pour toute alt\xE9ration de l\x27\xE9tat du module.',lib:'network.set_adminPassword()',pro:'function set_adminPassword(newval)',cmt:'

Modifie le mot de passe pour l\x27utilisateur \x22admin\x22, qui devient alors instantan\xE9ment n\xE9cessaire pour toute alt\xE9ration de l\x27\xE9tat du module. Si la valeur fournie est une cha\xEEne vide, plus aucun mot de passe n\x27est n\xE9cessaire. 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 le mot de passe pour l\x27utilisateur \x22admin\x22, qui devient alors instantan\xE9ment n\xE9cessaire pour toute alt\xE9ration de l\x27\xE9tat 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.'}; doc['Network']['set_callbackCredentials']={syn:'Modifie le laisser-passer pour se connecter \xE0 l\x27adresse de callback.',lib:'network.set_callbackCredentials()',pro:'function set_callbackCredentials(newval)',cmt:'

Modifie le laisser-passer pour se connecter \xE0 l\x27adresse de callback. Le laisser-passer doit \xEAtre fourni tel que retourn\xE9 par la fonction `get_callbackCredentials`, sous la forme `username:hash`. La valeur du hash d\xE9pend de la m\xE9thode d\x27autorisation impl\xE9ment\xE9e par le callback. Pour une autorisation de type Basic, le hash est le MD5 de la cha\xEEne `username:password`. Pour une autorisation de type Digest, le hash est le MD5 de la cha\xEEne `username:realm:password`. Pour une utilisation simplifi\xE9e, utilisez la fonction `callbackLogin`. 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 le laisser-passer pour se connecter \xE0 l\x27adresse de callback'},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.'}; doc['Network']['set_callbackEncoding']={syn:'Modifie l\x27encodage \xE0 utiliser pour repr\xE9senter les valeurs notifi\xE9es par callback.',lib:'network.set_callbackEncoding()',pro:'function set_callbackEncoding(newval)',cmt:'

Modifie l\x27encodage \xE0 utiliser pour repr\xE9senter les valeurs notifi\xE9es par callback.

',par:{newval:'une valeur parmi `Y_CALLBACKENCODING_FORM`, `Y_CALLBACKENCODING_JSON`, `Y_CALLBACKENCODING_JSON_ARRAY`, `Y_CALLBACKENCODING_CSV` et `Y_CALLBACKENCODING_YOCTO_API` représentant l\x27encodage \xE0 utiliser pour repr\xE9senter les valeurs notifi\xE9es par callback'},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.'}; doc['Network']['set_callbackMaxDelay']={syn:'Modifie l\x27attente maximale entre deux notifications par callback, en secondes.',lib:'network.set_callbackMaxDelay()',pro:'function set_callbackMaxDelay(newval)',cmt:'

Modifie l\x27attente maximale entre deux notifications par callback, en secondes.

',par:{newval:'un entier représentant l\x27attente maximale entre deux notifications par callback, en secondes'},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.'}; doc['Network']['set_callbackMethod']={syn:'Modifie la m\xE9thode HTTP \xE0 utiliser pour signaler les changements d\x27\xE9tat par callback.',lib:'network.set_callbackMethod()',pro:'function set_callbackMethod(newval)',cmt:'

Modifie la m\xE9thode HTTP \xE0 utiliser pour signaler les changements d\x27\xE9tat par callback.

',par:{newval:'une valeur parmi `Y_CALLBACKMETHOD_POST`, `Y_CALLBACKMETHOD_GET` et `Y_CALLBACKMETHOD_PUT` représentant la m\xE9thode HTTP \xE0 utiliser pour signaler les changements d\x27\xE9tat par callback'},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.'}; doc['Network']['set_callbackMinDelay']={syn:'Modifie l\x27attente minimale entre deux notifications par callback, en secondes.',lib:'network.set_callbackMinDelay()',pro:'function set_callbackMinDelay(newval)',cmt:'

Modifie l\x27attente minimale entre deux notifications par callback, en secondes.

',par:{newval:'un entier représentant l\x27attente minimale entre deux notifications par callback, en secondes'},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.'}; doc['Network']['set_callbackUrl']={syn:'Modifie l\x27adresse (URL) de callback \xE0 notifier lors de changement d\x27\xE9tat significatifs.',lib:'network.set_callbackUrl()',pro:'function set_callbackUrl(newval)',cmt:'

Modifie l\x27adresse (URL) de callback \xE0 notifier lors de changement d\x27\xE9tat significatifs. 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\x27adresse (URL) de callback \xE0 notifier lors de changement d\x27\xE9tat significatifs'},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.'}; doc['Network']['set_discoverable']={syn:'Modifie l\x27\xE9tat d\x27activation du protocole d\x27annonce sur le r\xE9seau permettant de retrouver facilement le module (protocols uPnP/Bonjour).',lib:'network.set_discoverable()',pro:'function set_discoverable(newval)',cmt:'

Modifie l\x27\xE9tat d\x27activation du protocole d\x27annonce sur le r\xE9seau permettant de retrouver facilement le module (protocols uPnP/Bonjour).

',par:{newval:'soit `Y_DISCOVERABLE_FALSE`, soit `Y_DISCOVERABLE_TRUE`, selon l\x27\xE9tat d\x27activation du protocole d\x27annonce sur le r\xE9seau permettant de retrouver facilement le module (protocols uPnP/Bonjour)'},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.'}; doc['Network']['set_logicalName']={syn:'Modifie le nom logique de l\x27interface r\xE9seau.',lib:'network.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27interface r\xE9seau. 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.'},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.'}; doc['Network']['set_primaryDNS']={syn:'Modifie l\x27adresse IP du serveur de noms primaire que le module doit utiliser.',lib:'network.set_primaryDNS()',pro:'function set_primaryDNS(newval)',cmt:'

Modifie l\x27adresse IP du serveur de noms primaire que le module doit utiliser. En mode DHCP, si une valeur est sp\xE9cifi\xE9e, elle remplacera celle re\xE7ue du serveur DHCP. 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:'une chaîne de caractères représentant l\x27adresse IP du serveur de noms primaire que le module doit utiliser'},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.'}; doc['Network']['set_secondaryDNS']={syn:'Modifie l\x27adresse IP du serveur de nom secondaire que le module doit utiliser.',lib:'network.set_secondaryDNS()',pro:'function set_secondaryDNS(newval)',cmt:'

Modifie l\x27adresse IP du serveur de nom secondaire que le module doit utiliser. En mode DHCP, si une valeur est sp\xE9cifi\xE9e, elle remplacera celle re\xE7ue du serveur DHCP. 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:'une chaîne de caractères représentant l\x27adresse IP du serveur de nom secondaire que le module doit utiliser'},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.'}; doc['Network']['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:'network.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['Network']['set_userPassword']={syn:'Modifie le mode de passe pour l\x27utilisateur \x22user\x22, qui devient alors instantan\xE9ment n\xE9cessaire pour tout acc\xE8s au module.',lib:'network.set_userPassword()',pro:'function set_userPassword(newval)',cmt:'

Modifie le mode de passe pour l\x27utilisateur \x22user\x22, qui devient alors instantan\xE9ment n\xE9cessaire pour tout acc\xE8s au module. Si la valeur fournie est une cha\xEEne vide, plus aucun mot de passe n\x27est n\xE9cessaire. 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 le mode de passe pour l\x27utilisateur \x22user\x22, qui devient alors instantan\xE9ment n\xE9cessaire pour tout acc\xE8s au 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.'}; doc['Network']['set_wwwWatchdogDelay']={syn:'Modifie la dur\xE9e de perte de connection WWW tol\xE9r\xE9e (en secondes) avant de d\xE9clancher un red\xE9marrage automatique pour tenter de r\xE9cup\xE9rer la connectivit\xE9 Internet.',lib:'network.set_wwwWatchdogDelay()',pro:'function set_wwwWatchdogDelay(newval)',cmt:'

Modifie la dur\xE9e de perte de connection WWW tol\xE9r\xE9e (en secondes) avant de d\xE9clancher un red\xE9marrage automatique pour tenter de r\xE9cup\xE9rer la connectivit\xE9 Internet. Une valeur nulle d\xE9sactive le red\xE9marrage automatique en cas de perte de connectivit\xE9 WWW. La plus petite dur\xE9e non-nulle utilisable est 90 secondes.

',par:{newval:'un entier représentant la dur\xE9e de perte de connection WWW tol\xE9r\xE9e (en secondes) avant de d\xE9clancher un red\xE9marrage automatique pour tenter de r\xE9cup\xE9rer la connectivit\xE9 Internet'},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.'}; doc['Network']['useDHCP']={syn:'Modifie la configuration de l\x27interface r\xE9seau pour utiliser une adresse assign\xE9e automatiquement par le serveur DHCP.',lib:'network.useDHCP()',pro:'function useDHCP(fallbackIpAddr, fallbackSubnetMaskLen, fallbackRouter)',cmt:'

Modifie la configuration de l\x27interface r\xE9seau pour utiliser une adresse assign\xE9e automatiquement par le serveur DHCP. En attendant qu\x27une adresse soit re\xE7ue (et ind\xE9finiment si aucun serveur DHCP ne r\xE9pond), le module utilisera les param\xE8tres IP sp\xE9cifi\xE9s \xE0 cette fonction. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` et de red\xE9marrer le module pour que le param\xE8tre soit appliqu\xE9.

',par:{fallbackIpAddr:'adresse IP \xE0 utiliser si aucun serveur DHCP ne r\xE9pond',fallbackSubnetMaskLen:'longueur du masque de sous-r\xE9seau \xE0 utiliser si aucun serveur DHCP ne r\xE9pond. Par exemple, la valeur 24 repr\xE9sente 255.255.255.0.',fallbackRouter:'adresse de la passerelle \xE0 utiliser si aucun serveur DHCP ne r\xE9pond'},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['Network']['useStaticIP']={syn:'Modifie la configuration de l\x27interface r\xE9seau pour utiliser une adresse IP assign\xE9e manuellement (adresse IP statique).',lib:'network.useStaticIP()',pro:'function useStaticIP(ipAddress, subnetMaskLen, router)',cmt:'

Modifie la configuration de l\x27interface r\xE9seau pour utiliser une adresse IP assign\xE9e manuellement (adresse IP statique). N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` et de red\xE9marrer le module pour que le param\xE8tre soit appliqu\xE9.

',par:{ipAddress:'adresse IP \xE0 utiliser par le module',subnetMaskLen:'longueur du masque de sous-r\xE9seau \xE0 utiliser. Par exemple, la valeur 24 repr\xE9sente 255.255.255.0.',router:'adresse IP de la passerelle \xE0 utiliser (\x22default gateway\x22)'},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['Network']['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:'network.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 machine virtuelle 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: Network) //--- (generated code: Wireless) doc['Wireless']={'':{syn:'Interface de la fonction Wireless',inc:'<script type='text/javascript' src='yocto_wireless.js'></script>',cmt:'

La fonction YWireless permet de configurer et de contr\xF4ler la configuration du r\xE9seau sans fil sur les modules Yoctopuce qui en sont dot\xE9s.

'}}; doc['Wireless']['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:

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

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.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence l\x27interface r\xE9seau sans fil sans ambigu\xEFt\xE9'},ret:'un objet de classe `YWireless` qui permet ensuite de contr\xF4ler l\x27interface r\xE9seau sans fil.'}; doc['Wireless']['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` si il n\x27y a pas de interfaces r\xE9seau sans fil disponibles.'}; doc['Wireless']['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:'wireless.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, il est recommand\xE9 d\x27utiliser de pr\xE9f\xE9rence 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.'}; doc['Wireless']['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:'wireless.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`)'}; doc['Wireless']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27interface r\xE9seau sans fil (pas plus de 6 caract\xE8res).',lib:'wireless.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 `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Wireless']['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:'wireless.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 `Y_CHANNEL_INVALID`.'}; doc['Wireless']['get_detectedWlans']={syn:'Retourne une liste d\x27objets objet YFileRecord qui d\xE9crivent les r\xE9seaux sans fils d\xE9tect\xE9s.',lib:'wireless.get_detectedWlans()',pro:'function get_detectedWlans()',cmt:'

Retourne une liste d\x27objets objet YFileRecord 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 `addhocNetwork()` pour se d\xE9connecter du r\xE9seau actuel. L\x27appelant est responsable de la d\xE9sallocation de la liste retourn\xE9e.

',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.'}; doc['Wireless']['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:'wireless.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.'}; doc['Wireless']['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:'wireless.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.'}; doc['Wireless']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27interface r\xE9seau sans fil au format `NOM_MODULE.NOM_FONCTION`.',lib:'wireless.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 si ils 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 `Y_FRIENDLYNAME_INVALID`.'}; doc['Wireless']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'wireless.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Wireless']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27interface r\xE9seau sans fil, sans r\xE9f\xE9rence au module.',lib:'wireless.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 `Y_FUNCTIONID_INVALID`.'}; doc['Wireless']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique de l\x27interface r\xE9seau sans fil au format `SERIAL.FUNCTIONID`.',lib:'wireless.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 `Y_HARDWAREID_INVALID`.'}; doc['Wireless']['get_linkQuality']={syn:'Retourne la qualit\xE9 de la connection, exprim\xE9e en pourcents.',lib:'wireless.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 `Y_LINKQUALITY_INVALID`.'}; doc['Wireless']['get_logicalName']={syn:'Retourne le nom logique de l\x27interface r\xE9seau sans fil.',lib:'wireless.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 `Y_LOGICALNAME_INVALID`.'}; doc['Wireless']['get_message']={syn:'Retourne le dernier message de diagnostique de l\x27interface au r\xE9seau sans fil.',lib:'wireless.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 `Y_MESSAGE_INVALID`.'}; doc['Wireless']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'wireless.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['Wireless']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'wireless.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['Wireless']['get_security']={syn:'Retourne l\x27algorithme de s\xE9curit\xE9 utilis\xE9 par le r\xE9seau sans-fil s\xE9lectionn\xE9.',lib:'wireless.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 `Y_SECURITY_UNKNOWN`, `Y_SECURITY_OPEN`, `Y_SECURITY_WEP`, `Y_SECURITY_WPA` et `Y_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 `Y_SECURITY_INVALID`.'}; doc['Wireless']['get_ssid']={syn:'Retourne le nom (SSID) du r\xE9seau sans-fil s\xE9lectionn\xE9.',lib:'wireless.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 `Y_SSID_INVALID`.'}; doc['Wireless']['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:'wireless.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['Wireless']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau sans fil est joignable, sans d\xE9clencher d\x27erreur.',lib:'wireless.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'}; doc['Wireless']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface r\xE9seau sans fil est joignable, sans d\xE9clencher d\x27erreur.',lib:'wireless.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.'}; doc['Wireless']['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:'wireless.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.'}; doc['Wireless']['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:'wireless.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.'}; doc['Wireless']['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:'wireless.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.'}; doc['Wireless']['nextWireless']={syn:'Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau sans fil commenc\xE9e \xE0 l\x27aide de `yFirstWireless()`.',lib:'wireless.nextWireless()',pro:'function nextWireless()',cmt:'

Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau sans fil commenc\xE9e \xE0 l\x27aide de `yFirstWireless()`.

',ret:'un pointeur sur un objet `YWireless` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Wireless']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'wireless.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['Wireless']['set_logicalName']={syn:'Modifie le nom logique de l\x27interface r\xE9seau sans fil.',lib:'wireless.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.'}; doc['Wireless']['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:'wireless.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['Wireless']['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:'wireless.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.

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.

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.'}; doc['Wireless']['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:'wireless.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 machine virtuelle 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: Wireless) //--- (generated code: Voc) doc['Voc']={'':{syn:'Interface de la fonction Voc',inc:'<script type='text/javascript' src='yocto_voc.js'></script>',cmt:'

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

'}}; doc['Voc']['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:

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

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.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le capteur de Compos\xE9s Organiques Volatils sans ambigu\xEFt\xE9'},ret:'un objet de classe `YVoc` qui permet ensuite de contr\xF4ler le capteur de Compos\xE9s Organiques Volatils.'}; doc['Voc']['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` si il n\x27y a pas de capteurs de Compos\xE9s Organiques Volatils disponibles.'}; doc['Voc']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'voc.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Voc']['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:'voc.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`)'}; doc['Voc']['get_advertisedValue']={syn:'Retourne la valeur courante du capteur de Compos\xE9s Organiques Volatils (pas plus de 6 caract\xE8res).',lib:'voc.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 `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Voc']['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:'voc.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 `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Voc']['get_currentValue']={syn:'Retourne la valeur actuelle du taux de VOC estim\xE9, en ppm (vol), sous forme de nombre \xE0 virgule.',lib:'voc.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.

',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 `Y_CURRENTVALUE_INVALID`.'}; doc['Voc']['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:'voc.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.'}; doc['Voc']['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:'voc.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.'}; doc['Voc']['get_friendlyName']={syn:'Retourne un identifiant global du capteur de Compos\xE9s Organiques Volatils au format `NOM_MODULE.NOM_FONCTION`.',lib:'voc.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 si ils 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 `Y_FRIENDLYNAME_INVALID`.'}; doc['Voc']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'voc.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Voc']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du capteur de Compos\xE9s Organiques Volatils, sans r\xE9f\xE9rence au module.',lib:'voc.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 `Y_FUNCTIONID_INVALID`.'}; doc['Voc']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du capteur de Compos\xE9s Organiques Volatils au format `SERIAL.FUNCTIONID`.',lib:'voc.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 `Y_HARDWAREID_INVALID`.'}; doc['Voc']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module.',lib:'voc.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.

',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 `Y_HIGHESTVALUE_INVALID`.'}; doc['Voc']['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:'voc.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Voc']['get_logicalName']={syn:'Retourne le nom logique du capteur de Compos\xE9s Organiques Volatils.',lib:'voc.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 `Y_LOGICALNAME_INVALID`.'}; doc['Voc']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour le taux de VOC estim\xE9 depuis le d\xE9marrage du module.',lib:'voc.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.

',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 `Y_LOWESTVALUE_INVALID`.'}; doc['Voc']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'voc.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['Voc']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'voc.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['Voc']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'voc.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Voc']['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:'voc.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Voc']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'voc.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Voc']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle le taux de VOC estim\xE9 est exprim\xE9e.',lib:'voc.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 `Y_UNIT_INVALID`.'}; doc['Voc']['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:'voc.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['Voc']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de Compos\xE9s Organiques Volatils est joignable, sans d\xE9clencher d\x27erreur.',lib:'voc.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'}; doc['Voc']['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:'voc.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.'}; doc['Voc']['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:'voc.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.'}; doc['Voc']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'voc.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Voc']['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:'voc.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.'}; doc['Voc']['nextVoc']={syn:'Continue l\x27\xE9num\xE9ration des capteurs de Compos\xE9s Organiques Volatils commenc\xE9e \xE0 l\x27aide de `yFirstVoc()`.',lib:'voc.nextVoc()',pro:'function nextVoc()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de Compos\xE9s Organiques Volatils commenc\xE9e \xE0 l\x27aide de `yFirstVoc()`.

',ret:'un pointeur sur un objet `YVoc` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Voc']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'voc.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Voc']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'voc.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['Voc']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'voc.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Voc']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'voc.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Voc']['set_logicalName']={syn:'Modifie le nom logique du capteur de Compos\xE9s Organiques Volatils.',lib:'voc.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.'}; doc['Voc']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'voc.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Voc']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'voc.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Voc']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'voc.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Voc']['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:'voc.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['Voc']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'voc.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Voc']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'voc.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Voc']['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:'voc.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 machine virtuelle 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: Voc) //--- (generated code: Watchdog) doc['Watchdog']={'':{syn:'Interface de la fonction Watchdog',inc:'<script type='text/javascript' src='yocto_watchdog.js'></script>',cmt:'

La fonction WatchDog est g\xE9r\xE9e comme un relais qui couperait bri\xE8vement l\x27alimentation d\x27un appareil apr\xE8s un d\x27attente temps donn\xE9 afin de provoquer une r\xE9initialisation compl\xE8te de cet appareil. Il suffit d\x27appeler le watchdog \xE0 intervale r\xE9gulier pour l\x27emp\xEAcher de provoquer la r\xE9initialisation. Le watchog peut aussi \xEAtre pilot\xE9 directement \xE0 l\x27aide des m\xE9thode pulse et delayedpulse pour \xE9teindre un appareil pendant un temps donn\xE9.

'}}; doc['Watchdog']['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:

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

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.

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

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

',ret:'un pointeur sur un objet `YWatchdog`, correspondant au premier watchdog accessible en ligne, ou `null` si il n\x27y a pas de watchdog disponibles.'}; doc['Watchdog']['delayedPulse']={syn:'Pr\xE9-programme une impulsion ',lib:'watchdog.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.'}; doc['Watchdog']['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:'watchdog.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`)'}; doc['Watchdog']['get_advertisedValue']={syn:'Retourne la valeur courante du watchdog (pas plus de 6 caract\xE8res).',lib:'watchdog.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 `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Watchdog']['get_autoStart']={syn:'Retourne l\x27\xE9tat du watchdog \xE0 la mise sous tension du module.',lib:'watchdog.get_autoStart()',pro:'function get_autoStart()',cmt:'

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

',ret:'soit `Y_AUTOSTART_OFF`, soit `Y_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 `Y_AUTOSTART_INVALID`.'}; doc['Watchdog']['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:'watchdog.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 `Y_COUNTDOWN_INVALID`.'}; doc['Watchdog']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du watchdog.',lib:'watchdog.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.'}; doc['Watchdog']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du watchdog.',lib:'watchdog.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.'}; doc['Watchdog']['get_friendlyName']={syn:'Retourne un identifiant global du watchdog au format `NOM_MODULE.NOM_FONCTION`.',lib:'watchdog.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 si ils 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 `Y_FRIENDLYNAME_INVALID`.'}; doc['Watchdog']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'watchdog.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Watchdog']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du watchdog, sans r\xE9f\xE9rence au module.',lib:'watchdog.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 `Y_FUNCTIONID_INVALID`.'}; doc['Watchdog']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du watchdog au format `SERIAL.FUNCTIONID`.',lib:'watchdog.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 `Y_HARDWAREID_INVALID`.'}; doc['Watchdog']['get_logicalName']={syn:'Retourne le nom logique du watchdog.',lib:'watchdog.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 `Y_LOGICALNAME_INVALID`.'}; doc['Watchdog']['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:'watchdog.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 `Y_MAXTIMEONSTATEA_INVALID`.'}; doc['Watchdog']['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:'watchdog.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 `Y_MAXTIMEONSTATEB_INVALID`.'}; doc['Watchdog']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'watchdog.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['Watchdog']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'watchdog.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['Watchdog']['get_output']={syn:'Retourne l\x27\xE9tat de la sortie du watchdog, lorsqu\x27il est utilis\xE9 comme un simple interrupteur.',lib:'watchdog.get_output()',pro:'function get_output()',cmt:'

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

',ret:'soit `Y_OUTPUT_OFF`, soit `Y_OUTPUT_ON`, selon l\x27\xE9tat de la sortie du watchdog, lorsqu\x27il est utilis\xE9 comme un simple interrupteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_OUTPUT_INVALID`.'}; doc['Watchdog']['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:'watchdog.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 `Y_PULSETIMER_INVALID`.'}; doc['Watchdog']['get_running']={syn:'Retourne l\x27\xE9tat du watchdog.',lib:'watchdog.get_running()',pro:'function get_running()',cmt:'

Retourne l\x27\xE9tat du watchdog.

',ret:'soit `Y_RUNNING_OFF`, soit `Y_RUNNING_ON`, selon l\x27\xE9tat du watchdog',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_RUNNING_INVALID`.'}; doc['Watchdog']['get_state']={syn:'Retourne l\x27\xE9tat du watchdog (A pour la position de repos, B pour l\x27\xE9tat actif).',lib:'watchdog.get_state()',pro:'function get_state()',cmt:'

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

',ret:'soit `Y_STATE_A`, soit `Y_STATE_B`, selon l\x27\xE9tat du watchdog (A pour la position de repos, B pour l\x27\xE9tat actif)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_STATE_INVALID`.'}; doc['Watchdog']['get_stateAtPowerOn']={syn:'Retourne l\x27\xE9tat du watchdog au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour aucun changement).',lib:'watchdog.get_stateAtPowerOn()',pro:'function get_stateAtPowerOn()',cmt:'

Retourne l\x27\xE9tat du watchdog au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour aucun changement).

',ret:'une valeur parmi `Y_STATEATPOWERON_UNCHANGED`, `Y_STATEATPOWERON_A` et `Y_STATEATPOWERON_B` représentant l\x27\xE9tat du watchdog au d\xE9marrage du module (A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour aucun changement)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_STATEATPOWERON_INVALID`.'}; doc['Watchdog']['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:'watchdog.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 `Y_TRIGGERDELAY_INVALID`.'}; doc['Watchdog']['get_triggerDuration']={syn:'Retourne la dur\xE9e d\x27un reset g\xE9n\xE9r\xE9 par le watchog, en millisecondes.',lib:'watchdog.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 `Y_TRIGGERDURATION_INVALID`.'}; doc['Watchdog']['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:'watchdog.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['Watchdog']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le watchdog est joignable, sans d\xE9clencher d\x27erreur.',lib:'watchdog.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'}; doc['Watchdog']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le watchdog est joignable, sans d\xE9clencher d\x27erreur.',lib:'watchdog.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.'}; doc['Watchdog']['load']={syn:'Met en cache les valeurs courantes du watchdog, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'watchdog.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.'}; doc['Watchdog']['load_async']={syn:'Met en cache les valeurs courantes du watchdog, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'watchdog.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.'}; doc['Watchdog']['nextWatchdog']={syn:'Continue l\x27\xE9num\xE9ration des watchdog commenc\xE9e \xE0 l\x27aide de `yFirstWatchdog()`.',lib:'watchdog.nextWatchdog()',pro:'function nextWatchdog()',cmt:'

Continue l\x27\xE9num\xE9ration des watchdog commenc\xE9e \xE0 l\x27aide de `yFirstWatchdog()`.

',ret:'un pointeur sur un objet `YWatchdog` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Watchdog']['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:'watchdog.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.'}; doc['Watchdog']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'watchdog.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['Watchdog']['resetWatchdog']={syn:'R\xE9initialise le WatchDog.',lib:'watchdog.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.'}; doc['Watchdog']['set_autoStart']={syn:'Modifie l\x27\xE9tat du watching au d\xE9marrage du module.',lib:'watchdog.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 `Y_AUTOSTART_OFF`, soit `Y_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.'}; doc['Watchdog']['set_logicalName']={syn:'Modifie le nom logique du watchdog.',lib:'watchdog.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.'}; doc['Watchdog']['set_maxTimeOnStateA']={syn:'R\xE8gle 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:'watchdog.set_maxTimeOnStateA()',pro:'function set_maxTimeOnStateA(newval)',cmt:'

R\xE8gle 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

',par:{newval:'un entier'},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.'}; doc['Watchdog']['set_maxTimeOnStateB']={syn:'R\xE8gle 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:'watchdog.set_maxTimeOnStateB()',pro:'function set_maxTimeOnStateB(newval)',cmt:'

R\xE8gle 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

',par:{newval:'un entier'},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.'}; doc['Watchdog']['set_output']={syn:'Modifie l\x27\xE9tat de la sortie du watchdog, lorsqu\x27il est utilis\xE9 comme un simple interrupteur.',lib:'watchdog.set_output()',pro:'function set_output(newval)',cmt:'

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

',par:{newval:'soit `Y_OUTPUT_OFF`, soit `Y_OUTPUT_ON`, selon l\x27\xE9tat de la sortie du watchdog, 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.'}; doc['Watchdog']['set_running']={syn:'Modifie manuellement l\x27\xE9tat de fonctionnement du watchdog.',lib:'watchdog.set_running()',pro:'function set_running(newval)',cmt:'

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

',par:{newval:'soit `Y_RUNNING_OFF`, soit `Y_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.'}; doc['Watchdog']['set_state']={syn:'Modifie l\x27\xE9tat du watchdog (A pour la position de repos, B pour l\x27\xE9tat actif).',lib:'watchdog.set_state()',pro:'function set_state(newval)',cmt:'

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

',par:{newval:'soit `Y_STATE_A`, soit `Y_STATE_B`, selon l\x27\xE9tat du watchdog (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.'}; doc['Watchdog']['set_stateAtPowerOn']={syn:'Pr\xE9-programme l\x27\xE9tat du watchdog au d\xE9marrage du module(A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour aucun changement).',lib:'watchdog.set_stateAtPowerOn()',pro:'function set_stateAtPowerOn(newval)',cmt:'

Pr\xE9-programme l\x27\xE9tat du watchdog au d\xE9marrage du module(A pour la position de repos, B pour l\x27\xE9tat actif, UNCHANGED pour aucun changement). N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module sinon la modification n\x27aura aucun effet.

',par:{newval:'une valeur parmi `Y_STATEATPOWERON_UNCHANGED`, `Y_STATEATPOWERON_A` et `Y_STATEATPOWERON_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.'}; doc['Watchdog']['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:'watchdog.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.

',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.'}; doc['Watchdog']['set_triggerDuration']={syn:'Modifie la dur\xE9e des resets g\xE9n\xE9r\xE9s par le watchog, en millisecondes.',lib:'watchdog.set_triggerDuration()',pro:'function set_triggerDuration(newval)',cmt:'

Modifie la dur\xE9e des resets g\xE9n\xE9r\xE9s par le watchog, en millisecondes.

',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.'}; doc['Watchdog']['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:'watchdog.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['Watchdog']['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:'watchdog.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 machine virtuelle 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: Watchdog) //--- (generated code: Power) doc['Power']={'':{syn:'Interface de la fonction Power',inc:'<script type='text/javascript' src='yocto_power.js'></script>',cmt:'

La classe YPower permet de lire et de configurer les capteurs de puissance Yoctopuce. Elle h\xE9rite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es. De plus, elle d\x27acc\xE9der au compteur d\x27\xE9nergie et \xE0 l\x27estimation du facteur de puissance.

'}}; doc['Power']['FindPower']={syn:'Permet de retrouver un capteur de puissance electrique d\x27apr\xE8s un identifiant donn\xE9.',lib:'YPower.FindPower()',pro:'function FindPower(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le capteur de puissance electrique soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YPower.isOnline()` pour tester si le capteur de puissance electrique 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 le capteur de puissance electrique sans ambigu\xEFt\xE9'},ret:'un objet de classe `YPower` qui permet ensuite de contr\xF4ler le capteur de puissance electrique.'}; doc['Power']['FirstPower']={syn:'Commence l\x27\xE9num\xE9ration des capteurs de puissance electrique accessibles par la librairie.',lib:'YPower.FirstPower()',pro:'function FirstPower()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs de puissance electrique accessibles par la librairie. Utiliser la fonction `YPower.nextPower()` pour it\xE9rer sur les autres capteurs de puissance electrique.

',ret:'un pointeur sur un objet `YPower`, correspondant au premier capteur de puissance electrique accessible en ligne, ou `null` si il n\x27y a pas de capteurs de puissance electrique disponibles.'}; doc['Power']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'power.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Power']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de puissance electrique au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'power.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de puissance electrique 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 puissance electrique (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Power']['get_advertisedValue']={syn:'Retourne la valeur courante du capteur de puissance electrique (pas plus de 6 caract\xE8res).',lib:'power.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur de puissance electrique (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Power']['get_cosPhi']={syn:'Retourne le facteur de puissance (rapport entre la puissance r\xE9elle consomm\xE9e, en W, et la puissance apparente fournie, en VA).',lib:'power.get_cosPhi()',pro:'function get_cosPhi()',cmt:'

Retourne le facteur de puissance (rapport entre la puissance r\xE9elle consomm\xE9e, en W, et la puissance apparente fournie, en VA).

',ret:'une valeur numérique représentant le facteur de puissance (rapport entre la puissance r\xE9elle consomm\xE9e, en W, et la puissance apparente fournie, en VA)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_COSPHI_INVALID`.'}; doc['Power']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en Watt, sous forme de nombre \xE0 virgule.',lib:'power.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en Watt, 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 Watt, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Power']['get_currentValue']={syn:'Retourne la valeur actuelle de la puissance \xE9lectrique, en Watt, sous forme de nombre \xE0 virgule.',lib:'power.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la puissance \xE9lectrique, en Watt, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de la puissance \xE9lectrique, en Watt, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Power']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de puissance electrique.',lib:'power.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de puissance electrique. 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 puissance electrique.'}; doc['Power']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de puissance electrique.',lib:'power.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 puissance electrique. 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 puissance electrique.'}; doc['Power']['get_friendlyName']={syn:'Retourne un identifiant global du capteur de puissance electrique au format `NOM_MODULE.NOM_FONCTION`.',lib:'power.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de puissance electrique en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Power']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'power.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Power']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du capteur de puissance electrique, sans r\xE9f\xE9rence au module.',lib:'power.get_functionId()',pro:'function get_functionId()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de puissance electrique (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['Power']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du capteur de puissance electrique au format `SERIAL.FUNCTIONID`.',lib:'power.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du capteur de puissance electrique 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 puissance electrique (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de puissance electrique (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Power']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la puissance \xE9lectrique depuis le d\xE9marrage du module.',lib:'power.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la puissance \xE9lectrique depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la puissance \xE9lectrique depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Power']['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:'power.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Power']['get_logicalName']={syn:'Retourne le nom logique du capteur de puissance electrique.',lib:'power.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur de puissance electrique.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de puissance electrique.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Power']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la puissance \xE9lectrique depuis le d\xE9marrage du module.',lib:'power.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la puissance \xE9lectrique depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la puissance \xE9lectrique depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Power']['get_meter']={syn:'Retourne la valeur actuelle du compteur d\x27energie, calcul\xE9e par le wattm\xE8tre en int\xE9grant la consommation instantan\xE9e.',lib:'power.get_meter()',pro:'function get_meter()',cmt:'

Retourne la valeur actuelle du compteur d\x27energie, calcul\xE9e par le wattm\xE8tre en int\xE9grant la consommation instantan\xE9e. Ce compteur est r\xE9initialis\xE9 \xE0 chaque d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur actuelle du compteur d\x27energie, calcul\xE9e par le wattm\xE8tre en int\xE9grant la consommation instantan\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_METER_INVALID`.'}; doc['Power']['get_meterTimer']={syn:'Retourne le temps \xE9coul\xE9 depuis la derni\xE8re initilialisation du compteur d\x27\xE9nergie, en secondes ',lib:'power.get_meterTimer()',pro:'function get_meterTimer()',cmt:'

Retourne le temps \xE9coul\xE9 depuis la derni\xE8re initilialisation du compteur d\x27\xE9nergie, en secondes

',ret:'un entier représentant le temps \xE9coul\xE9 depuis la derni\xE8re initilialisation du compteur d\x27\xE9nergie, en secondes',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_METERTIMER_INVALID`.'}; doc['Power']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'power.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['Power']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'power.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['Power']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'power.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Power']['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:'power.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Power']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'power.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Power']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la puissance \xE9lectrique est exprim\xE9e.',lib:'power.get_unit()',pro:'function get_unit()',cmt:'

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

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la puissance \xE9lectrique est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Power']['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:'power.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['Power']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de puissance electrique est joignable, sans d\xE9clencher d\x27erreur.',lib:'power.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de puissance electrique est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de puissance electrique 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 puissance electrique est joignable, `false` sinon'}; doc['Power']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de puissance electrique est joignable, sans d\xE9clencher d\x27erreur.',lib:'power.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de puissance electrique est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de puissance electrique 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.'}; doc['Power']['load']={syn:'Met en cache les valeurs courantes du capteur de puissance electrique, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'power.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur de puissance electrique, 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.'}; doc['Power']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'power.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Power']['load_async']={syn:'Met en cache les valeurs courantes du capteur de puissance electrique, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'power.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur de puissance electrique, 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.'}; doc['Power']['nextPower']={syn:'Continue l\x27\xE9num\xE9ration des capteurs de puissance electrique commenc\xE9e \xE0 l\x27aide de `yFirstPower()`.',lib:'power.nextPower()',pro:'function nextPower()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de puissance electrique commenc\xE9e \xE0 l\x27aide de `yFirstPower()`.

',ret:'un pointeur sur un objet `YPower` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Power']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'power.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Power']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'power.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['Power']['reset']={syn:'R\xE9initialise le compteur d\x27\xE9nergie.',lib:'power.reset()',pro:'function reset()',cmt:'

R\xE9initialise le compteur d\x27\xE9nergie.

',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['Power']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'power.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Power']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'power.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Power']['set_logicalName']={syn:'Modifie le nom logique du capteur de puissance electrique.',lib:'power.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur de puissance electrique. 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 puissance electrique.'},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.'}; doc['Power']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'power.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Power']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'power.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Power']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'power.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Power']['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:'power.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['Power']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'power.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Power']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'power.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Power']['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:'power.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 machine virtuelle 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: Power) //--- (generated code: Display) doc['Display']={'':{syn:'Interface de la fonction Display',inc:'<script type='text/javascript' src='yocto_display.js'></script>',cmt:'

L\x27interface de contr\xF4le des \xE9crans Yoctopuce est con\xE7ue pour afficher facilement des informations et des images. Le module est capable de g\xE9rer seul la superposition de plusieurs couches graphiques, qui peuvent \xEAtre dessin\xE9es individuellement, sans affichage imm\xE9diat, puis librement positionn\xE9es sur l\x27\xE9cran. Il est aussi capable de rejouer des s\xE9quences de commandes pr\xE9-enregistr\xE9es (animations).

'}}; doc['Display']['FindDisplay']={syn:'Permet de retrouver un ecran d\x27apr\xE8s un identifiant donn\xE9.',lib:'YDisplay.FindDisplay()',pro:'function FindDisplay(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27ecran soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YDisplay.isOnline()` pour tester si l\x27ecran 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 l\x27ecran sans ambigu\xEFt\xE9'},ret:'un objet de classe `YDisplay` qui permet ensuite de contr\xF4ler l\x27ecran.'}; doc['Display']['FirstDisplay']={syn:'Commence l\x27\xE9num\xE9ration des \xE9cran accessibles par la librairie.',lib:'YDisplay.FirstDisplay()',pro:'function FirstDisplay()',cmt:'

Commence l\x27\xE9num\xE9ration des \xE9cran accessibles par la librairie. Utiliser la fonction `YDisplay.nextDisplay()` pour it\xE9rer sur les autres \xE9cran.

',ret:'un pointeur sur un objet `YDisplay`, correspondant au premier \xE9cran accessible en ligne, ou `null` si il n\x27y a pas de \xE9cran disponibles.'}; doc['Display']['copyLayerContent']={syn:'Copie le contentu d\x27un couche d\x27affichage vers une autre couche.',lib:'display.copyLayerContent()',pro:'function copyLayerContent(srcLayerId, dstLayerId)',cmt:'

Copie le contentu d\x27un couche d\x27affichage vers une autre couche. La couleur et la transparence de tous les pixels de la couche de destination sont chang\xE9s pour correspondre \xE0 la couche source. Cette m\xE9thode modifie le contenu affich\xE9, mais n\x27a aucun effet sur les propri\xE9t\xE9s de l\x27objet layer lui-m\xEAme. Notez que la couche z\xE9ro n\x27a pas de transparence (elle est toujours opaque).

',par:{srcLayerId:'l\x27identifiant de la couche d\x27origine (un chiffre parmi 0..layerCount-1)',dstLayerId:'l\x27identifiant de la couche de destination (un chiffre parmi 0..layerCount-1)'},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['Display']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27ecran au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'display.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27ecran 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\x27ecran (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Display']['fade']={syn:'Change la luminosit\xE9 de l\x27\xE9cran en douceur, pour produire un effet de fade-in ou fade-out.',lib:'display.fade()',pro:'function fade(brightness, duration)',cmt:'

Change la luminosit\xE9 de l\x27\xE9cran en douceur, pour produire un effet de fade-in ou fade-out.

',par:{brightness:'nouvelle valeur de luminosit\xE9 de l\x27\xE9cran',duration:'dur\xE9e en millisecondes de la transition.'},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['Display']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27ecran (pas plus de 6 caract\xE8res).',lib:'display.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27ecran (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27ecran (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Display']['get_brightness']={syn:'Retourne la luminosit\xE9 des leds informatives du module (valeur entre 0 et 100).',lib:'display.get_brightness()',pro:'function get_brightness()',cmt:'

Retourne la luminosit\xE9 des leds informatives du module (valeur entre 0 et 100).

',ret:'un entier représentant la luminosit\xE9 des leds informatives du module (valeur entre 0 et 100)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_BRIGHTNESS_INVALID`.'}; doc['Display']['get_displayHeight']={syn:'Retourne la hauteur de l\x27\xE9cran, en pixels.',lib:'display.get_displayHeight()',pro:'function get_displayHeight()',cmt:'

Retourne la hauteur de l\x27\xE9cran, en pixels.

',ret:'un entier représentant la hauteur de l\x27\xE9cran, en pixels',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DISPLAYHEIGHT_INVALID`.'}; doc['Display']['get_displayLayer']={syn:'Retourne un objet YDisplayLayer utilisable pour dessiner sur la couche d\x27affichage correspondante.',lib:'display.get_displayLayer()',pro:'function get_displayLayer(layerId)',cmt:'

Retourne un objet YDisplayLayer utilisable pour dessiner sur la couche d\x27affichage correspondante. Le contenu n\x27est visible sur l\x27\xE9cran que lorsque la couche est active sur l\x27\xE9cran (et non masqu\xE9e par une couche sup\xE9rieure).

',par:{layerId:'l\x27identifiant de la couche d\x27affichage d\xE9sir\xE9e (un chiffre parmi 0..layerCount-1)'},ret:'un objet `YDisplayLayer`',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `null`.'}; doc['Display']['get_displayType']={syn:'Retourne le type de l\x27\xE9cran: monochrome, niveaux de gris ou couleur.',lib:'display.get_displayType()',pro:'function get_displayType()',cmt:'

Retourne le type de l\x27\xE9cran: monochrome, niveaux de gris ou couleur.

',ret:'une valeur parmi `Y_DISPLAYTYPE_MONO`, `Y_DISPLAYTYPE_GRAY` et `Y_DISPLAYTYPE_RGB` représentant le type de l\x27\xE9cran: monochrome, niveaux de gris ou couleur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DISPLAYTYPE_INVALID`.'}; doc['Display']['get_displayWidth']={syn:'Retourne la largeur de l\x27\xE9cran, en pixels.',lib:'display.get_displayWidth()',pro:'function get_displayWidth()',cmt:'

Retourne la largeur de l\x27\xE9cran, en pixels.

',ret:'un entier représentant la largeur de l\x27\xE9cran, en pixels',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DISPLAYWIDTH_INVALID`.'}; doc['Display']['get_enabled']={syn:'Retourne vrai si le l\x27ecran est aliment\xE9, faux sinon.',lib:'display.get_enabled()',pro:'function get_enabled()',cmt:'

Retourne vrai si le l\x27ecran est aliment\xE9, faux sinon.

',ret:'soit `Y_ENABLED_FALSE`, soit `Y_ENABLED_TRUE`, selon vrai si le l\x27ecran est aliment\xE9, faux sinon',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ENABLED_INVALID`.'}; doc['Display']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27ecran.',lib:'display.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27ecran. 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\x27ecran.'}; doc['Display']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27ecran.',lib:'display.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\x27ecran. 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\x27ecran.'}; doc['Display']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27ecran au format `NOM_MODULE.NOM_FONCTION`.',lib:'display.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27ecran en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Display']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'display.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Display']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27ecran, sans r\xE9f\xE9rence au module.',lib:'display.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27ecran 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\x27ecran (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27ecran (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Display']['get_layerCount']={syn:'Retourne le nombre des couches affichables disponibles.',lib:'display.get_layerCount()',pro:'function get_layerCount()',cmt:'

Retourne le nombre des couches affichables disponibles.

',ret:'un entier représentant le nombre des couches affichables disponibles',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LAYERCOUNT_INVALID`.'}; doc['Display']['get_layerHeight']={syn:'Retourne la hauteur des couches affichables, en pixels.',lib:'display.get_layerHeight()',pro:'function get_layerHeight()',cmt:'

Retourne la hauteur des couches affichables, en pixels.

',ret:'un entier représentant la hauteur des couches affichables, en pixels',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LAYERHEIGHT_INVALID`.'}; doc['Display']['get_layerWidth']={syn:'Retourne la largeur des couches affichables, en pixels.',lib:'display.get_layerWidth()',pro:'function get_layerWidth()',cmt:'

Retourne la largeur des couches affichables, en pixels.

',ret:'un entier représentant la largeur des couches affichables, en pixels',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LAYERWIDTH_INVALID`.'}; doc['Display']['get_logicalName']={syn:'Retourne le nom logique de l\x27ecran.',lib:'display.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27ecran.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27ecran.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Display']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'display.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['Display']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'display.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['Display']['get_orientation']={syn:'Retourne l\x27orientation s\xE9lectionn\xE9e pour l\x27\xE9cran.',lib:'display.get_orientation()',pro:'function get_orientation()',cmt:'

Retourne l\x27orientation s\xE9lectionn\xE9e pour l\x27\xE9cran.

',ret:'une valeur parmi `Y_ORIENTATION_LEFT`, `Y_ORIENTATION_UP`, `Y_ORIENTATION_RIGHT` et `Y_ORIENTATION_DOWN` représentant l\x27orientation s\xE9lectionn\xE9e pour l\x27\xE9cran',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ORIENTATION_INVALID`.'}; doc['Display']['get_startupSeq']={syn:'Retourne le nom de la s\xE9quence \xE0 jouer \xE0 la mise sous tension de l\x27\xE9cran.',lib:'display.get_startupSeq()',pro:'function get_startupSeq()',cmt:'

Retourne le nom de la s\xE9quence \xE0 jouer \xE0 la mise sous tension de l\x27\xE9cran.

',ret:'une chaîne de caractères représentant le nom de la s\xE9quence \xE0 jouer \xE0 la mise sous tension de l\x27\xE9cran',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_STARTUPSEQ_INVALID`.'}; doc['Display']['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:'display.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['Display']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27ecran est joignable, sans d\xE9clencher d\x27erreur.',lib:'display.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27ecran est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27ecran 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\x27ecran est joignable, `false` sinon'}; doc['Display']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27ecran est joignable, sans d\xE9clencher d\x27erreur.',lib:'display.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27ecran est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27ecran 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.'}; doc['Display']['load']={syn:'Met en cache les valeurs courantes de l\x27ecran, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'display.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27ecran, 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.'}; doc['Display']['load_async']={syn:'Met en cache les valeurs courantes de l\x27ecran, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'display.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27ecran, 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.'}; doc['Display']['newSequence']={syn:'Enclanche l\x27enregistrement de toutes les commandes d\x27affichage suivantes dans une s\xE9quence, qui pourra \xEAtre rejou\xE9e ult\xE9rieurement.',lib:'display.newSequence()',pro:'function newSequence()',cmt:'

Enclanche l\x27enregistrement de toutes les commandes d\x27affichage suivantes dans une s\xE9quence, qui pourra \xEAtre rejou\xE9e ult\xE9rieurement. Le nom de la s\xE9quence sera donn\xE9 au moment de l\x27appel \xE0 `saveSequence()`, une fois la s\xE9quence termin\xE9e.

',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['Display']['nextDisplay']={syn:'Continue l\x27\xE9num\xE9ration des \xE9cran commenc\xE9e \xE0 l\x27aide de `yFirstDisplay()`.',lib:'display.nextDisplay()',pro:'function nextDisplay()',cmt:'

Continue l\x27\xE9num\xE9ration des \xE9cran commenc\xE9e \xE0 l\x27aide de `yFirstDisplay()`.

',ret:'un pointeur sur un objet `YDisplay` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Display']['pauseSequence']={syn:'Attend pour la dur\xE9e sp\xE9cifi\xE9e (en millisecondes) avant de jouer les commandes suivantes de la s\xE9quence active.',lib:'display.pauseSequence()',pro:'function pauseSequence(delay_ms)',cmt:'

Attend pour la dur\xE9e sp\xE9cifi\xE9e (en millisecondes) avant de jouer les commandes suivantes de la s\xE9quence active. Cette m\xE9thode peut \xEAtre utilis\xE9e lors de l\x27enregistrement d\x27une s\xE9quence d\x27affichage, pour ins\xE9rer une attente mesur\xE9e lors de l\x27ex\xE9cution (mais sans effet imm\xE9diat). Cette m\xE9thode peut aussi \xEAtre appel\xE9e dynamiquement pendant l\x27ex\xE9cution d\x27une s\xE9quence enregistr\xE9e, pour suspendre temporairement ou reprendre l\x27ex\xE9cution. Pour annuler une attente, appelez simplement la m\xE9thode avec une attente de z\xE9ro.

',par:{delay_ms:'la dur\xE9e de l\x27attente, 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['Display']['playSequence']={syn:'Joue une s\xE9quence d\x27affichage pr\xE9alablement enregistr\xE9e \xE0 l\x27aide des m\xE9thodes `newSequence()` et `saveSequence()`.',lib:'display.playSequence()',pro:'function playSequence(sequenceName)',cmt:'

Joue une s\xE9quence d\x27affichage pr\xE9alablement enregistr\xE9e \xE0 l\x27aide des m\xE9thodes `newSequence()` et `saveSequence()`.

',par:{sequenceName:'le nom de la nouvelle s\xE9quence cr\xE9\xE9e'},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['Display']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'display.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['Display']['resetAll']={syn:'Efface le contenu de l\x27\xE9cran et remet toutes les couches \xE0 leur \xE9tat initial.',lib:'display.resetAll()',pro:'function resetAll()',cmt:'

Efface le contenu de l\x27\xE9cran et remet toutes les couches \xE0 leur \xE9tat initial. Utiliser cette fonction dans une sequence va tuer stopper l\x27affichage de la sequence: ne pas utiliser cette fonction pour r\xE9initialiser l\x27\xE9cran au d\xE9but d\x27une s\xE9quence.

',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['Display']['saveSequence']={syn:'Termine l\x27enregistrement d\x27une s\xE9quence et la sauvegarde sur la m\xE9moire interne de l\x27\xE9cran, sous le nom choisi.',lib:'display.saveSequence()',pro:'function saveSequence(sequenceName)',cmt:'

Termine l\x27enregistrement d\x27une s\xE9quence et la sauvegarde sur la m\xE9moire interne de l\x27\xE9cran, sous le nom choisi. La s\xE9quence peut \xEAtre rejou\xE9e ult\xE9rieurement \xE0 l\x27aide de la m\xE9thode `playSequence()`.

',par:{sequenceName:'le nom de la nouvelle s\xE9quence cr\xE9\xE9e'},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['Display']['set_brightness']={syn:'Modifie la luminosit\xE9de l\x27\xE9cran.',lib:'display.set_brightness()',pro:'function set_brightness(newval)',cmt:'

Modifie la luminosit\xE9de l\x27\xE9cran. Le param\xEAtre est une valeur entre 0 et 100. 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 luminosit\xE9de l\x27\xE9cran'},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.'}; doc['Display']['set_enabled']={syn:'Modifie l\x27\xE9tat d\x27activit\xE9 de l\x27\xE9cran.',lib:'display.set_enabled()',pro:'function set_enabled(newval)',cmt:'

Modifie l\x27\xE9tat d\x27activit\xE9 de l\x27\xE9cran.

',par:{newval:'soit `Y_ENABLED_FALSE`, soit `Y_ENABLED_TRUE`, selon l\x27\xE9tat d\x27activit\xE9 de l\x27\xE9cran'},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.'}; doc['Display']['set_logicalName']={syn:'Modifie le nom logique de l\x27ecran.',lib:'display.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27ecran. 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\x27ecran.'},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.'}; doc['Display']['set_orientation']={syn:'Modifie l\x27orientation de l\x27\xE9cran.',lib:'display.set_orientation()',pro:'function set_orientation(newval)',cmt:'

Modifie l\x27orientation de l\x27\xE9cran. 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 `Y_ORIENTATION_LEFT`, `Y_ORIENTATION_UP`, `Y_ORIENTATION_RIGHT` et `Y_ORIENTATION_DOWN` représentant l\x27orientation de l\x27\xE9cran'},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.'}; doc['Display']['set_startupSeq']={syn:'Modifie le nom de la s\xE9quence \xE0 jouer \xE0 la mise sous tension de l\x27\xE9cran.',lib:'display.set_startupSeq()',pro:'function set_startupSeq(newval)',cmt:'

Modifie le nom de la s\xE9quence \xE0 jouer \xE0 la mise sous tension de l\x27\xE9cran. 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 le nom de la s\xE9quence \xE0 jouer \xE0 la mise sous tension de l\x27\xE9cran'},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.'}; doc['Display']['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:'display.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['Display']['stopSequence']={syn:'Arr\xEAte imm\xE9diatement la s\xE9quence d\x27affichage actuellement jou\xE9e sur l\x27\xE9cran.',lib:'display.stopSequence()',pro:'function stopSequence()',cmt:'

Arr\xEAte imm\xE9diatement la s\xE9quence d\x27affichage actuellement jou\xE9e sur l\x27\xE9cran. L\x27affichage est laiss\xE9 tel quel.

',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['Display']['swapLayerContent']={syn:'Permute le contentu de deux couches d\x27affichage.',lib:'display.swapLayerContent()',pro:'function swapLayerContent(layerIdA, layerIdB)',cmt:'

Permute le contentu de deux couches d\x27affichage. La couleur et la transparence de tous les pixels des deux couches sont permut\xE9es. Cette m\xE9thode modifie le contenu affich\xE9, mais n\x27a aucun effet sur les propri\xE9t\xE9s de l\x27objet layer lui-m\xEAme. En particulier, la visibilit\xE9 des deux couches reste inchang\xE9e. Cela permet d\x27impl\xE9menter tr\xE8s efficacement un affichage par double-buffering, en utilisant une couche cach\xE9e et une couche visible. Notez que la couche z\xE9ro n\x27a pas de transparence (elle est toujours opaque).

',par:{layerIdA:'l\x27identifiant de la premi\xE8re couche (un chiffre parmi 0..layerCount-1)',layerIdB:'l\x27identifiant de la deuxi\xE8me couche (un chiffre parmi 0..layerCount-1)'},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['Display']['upload']={syn:'T\xE9l\xE9charge un contenu arbitraire (par exemple une image GIF) vers le syst\xE8me de fichier de l\x27\xE9cran, au chemin d\x27acc\xE8s sp\xE9cifi\xE9.',lib:'display.upload()',pro:'function upload(pathname, content)',cmt:'

T\xE9l\xE9charge un contenu arbitraire (par exemple une image GIF) vers le syst\xE8me de fichier de l\x27\xE9cran, au chemin d\x27acc\xE8s sp\xE9cifi\xE9. Si un fichier existe d\xE9j\xE0 pour le m\xEAme chemin d\x27acc\xE8s, son contenu est remplac\xE9.

',par:{pathname:'nom complet du fichier, y compris le chemin d\x27acc\xE8s.',content:'contenu du fichier \xE0 t\xE9l\xE9charger'},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['Display']['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:'display.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 machine virtuelle 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: Display) //--- (generated code: DisplayLayer) doc['DisplayLayer']={'':{syn:'Interface des objets DisplayLayer',inc:'<script type='text/javascript' src='yocto_display.js'></script>',cmt:'

Un DisplayLayer est une couche de contenu affichable (images, texte, etc.). Le contenu n\x27est visible sur l\x27\xE9cran que lorsque la couche est active sur l\x27\xE9cran (et non masqu\xE9e par une couche sup\xE9rieure).

'}}; doc['DisplayLayer']['clear']={syn:'Efface tout le contenu de la couche de dessin, de sorte \xE0 ce qu\x27elle redevienne enti\xE8rement transparente.',lib:'displaylayer.clear()',pro:'function clear()',cmt:'

Efface tout le contenu de la couche de dessin, de sorte \xE0 ce qu\x27elle redevienne enti\xE8rement transparente. Cette m\xE9thode ne change pas les r\xE9glages de le couche. Si vous d\xE9sirez remettre la couche dans son \xE9tat initial, utilisez plut\xF4t la m\xE9thode `reset()`.

',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['DisplayLayer']['clearConsole']={syn:'Efface le contenu de la zone de console, et repositionne le curseur de la console en haut \xE0 gauche de la zone.',lib:'displaylayer.clearConsole()',pro:'function clearConsole()',cmt:'

Efface le contenu de la zone de console, et repositionne le curseur de la console en haut \xE0 gauche de la zone.

',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['DisplayLayer']['consoleOut']={syn:'Affiche un message dans la zone de console, et d\xE9place le curseur de la console \xE0 la fin du texte.',lib:'displaylayer.consoleOut()',pro:'function consoleOut(text)',cmt:'

Affiche un message dans la zone de console, et d\xE9place le curseur de la console \xE0 la fin du texte. Le curseur revient automatiquement en d\xE9but de ligne suivante lorsqu\x27un saut de ligne est rencontr\xE9, ou lorsque la marge droite est atteinte. Lorsque le texte \xE0 afficher s\x27appr\xEAte \xE0 d\xE9passer la marge inf\xE9rieure, le contenu de la zone de console est automatiquement d\xE9cal\xE9 vers le haut afin de laisser la place \xE0 la nouvelle ligne de texte.

',par:{text:'le message \xE0 afficher'},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['DisplayLayer']['drawBar']={syn:'Dessine un rectangle plein \xE0 une position sp\xE9cifi\xE9e.',lib:'displaylayer.drawBar()',pro:'function drawBar(x1, y1, x2, y2)',cmt:'

Dessine un rectangle plein \xE0 une position sp\xE9cifi\xE9e.

',par:{x1:'la distance en pixels depuis la gauche de la couche jusqu\x27au bord gauche du rectangle',y1:'la distance en pixels depuis le haut de la couche jusqu\x27au bord sup\xE9rieur du rectangle',x2:'la distance en pixels depuis la gauche de la couche jusqu\x27au bord droit du rectangle',y2:'la distance en pixels depuis le haut de la couche jusqu\x27au bord inf\xE9rieur du rectangle'},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['DisplayLayer']['drawBitmap']={syn:'Dessine un bitmap \xE0 la position sp\xE9cifi\xE9e de la couche.',lib:'displaylayer.drawBitmap()',pro:'function drawBitmap(x, y, w, bitmap, bgcol)',cmt:'

Dessine un bitmap \xE0 la position sp\xE9cifi\xE9e de la couche. Le bitmap est pass\xE9 sous forme d\x27un objet binaire, o\xF9 chaque bit correspond \xE0 un pixel, de gauche \xE0 droite et de haut en bas. Le bit de poids fort de chaque octet correspond au pixel de gauche, et le bit de poids faible au pixel le plus \xE0 droite. Les bits \xE0 1 sont dessin\xE9s avec la couleur active de la couche. Les bits \xE0 0 avec la couleur de fond sp\xE9cifi\xE9e, sauf si la valeur -1 a \xE9t\xE9 choisie, auquel cas ils ne sont pas dessin\xE9s (ils sont consid\xE9r\xE9s comme transparents). Chaque ligne commence sur un nouvel octet. La hauteur du bitmap est donn\xE9e implicitement par la taille de l\x27objet binaire.

',par:{x:'la distance en pixels depuis la gauche de la couche jusqu\x27au bord gauche du bitmap',y:'la distance en pixels depuis le haut de la couche jusqu\x27au bord sup\xE9rieur du bitmap',w:'la largeur du bitmap, en pixels',bitmap:'l\x27objet binaire contenant le bitmap',bgcol:'le niveau de gris \xE0 utiliser pour les bits \xE0 z\xE9ro (0 = noir, 255 = blanc), ou -1 pour lasser les pixels inchang\xE9s'},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['DisplayLayer']['drawCircle']={syn:'Dessine un cercle vide \xE0 une position sp\xE9cifi\xE9e.',lib:'displaylayer.drawCircle()',pro:'function drawCircle(x, y, r)',cmt:'

Dessine un cercle vide \xE0 une position sp\xE9cifi\xE9e.

',par:{x:'la distance en pixels depuis la gauche de la couche jusqu\x27au centre du cercle',y:'la distance en pixels depuis le haut de la couche jusqu\x27au centre du cercle',r:'le rayon du cercle, en pixels'},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['DisplayLayer']['drawDisc']={syn:'Dessine un disque plein \xE0 une position sp\xE9cifi\xE9e.',lib:'displaylayer.drawDisc()',pro:'function drawDisc(x, y, r)',cmt:'

Dessine un disque plein \xE0 une position sp\xE9cifi\xE9e.

',par:{x:'la distance en pixels depuis la gauche de la couche jusqu\x27au centre du disque',y:'la distance en pixels depuis le haut de la couche jusqu\x27au centre du disque',r:'le rayon du disque, en pixels'},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['DisplayLayer']['drawImage']={syn:'Dessine une image GIF \xE0 la position sp\xE9cifi\xE9e de la couche.',lib:'displaylayer.drawImage()',pro:'function drawImage(x, y, imagename)',cmt:'

Dessine une image GIF \xE0 la position sp\xE9cifi\xE9e de la couche. L\x27image GIF doit avoir \xE9t\xE9 pr\xE9alablement pr\xE9charg\xE9e dans la m\xE9moire du module. Si vous rencontrez des probl\xE8mes \xE0 l\x27utilisation d\x27une image bitmap, consultez les logs du module pour voir si vous n\x27y trouvez pas un message \xE0 propos d\x27un fichier d\x27image manquant ou d\x27un format de fichier invalide.

',par:{x:'la distance en pixels depuis la gauche de la couche jusqu\x27au bord gauche de l\x27image',y:'la distance en pixels depuis le haut de la couche jusqu\x27au bord sup\xE9rieur de l\x27image',imagename:'le nom du fichier GIF \xE0 afficher'},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['DisplayLayer']['drawPixel']={syn:'Dessine un pixel unique \xE0 une position sp\xE9cifi\xE9e.',lib:'displaylayer.drawPixel()',pro:'function drawPixel(x, y)',cmt:'

Dessine un pixel unique \xE0 une position sp\xE9cifi\xE9e.

',par:{x:'la distance en pixels depuis la gauche de la couche',y:'la distance en pixels depuis le haut de la couche'},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['DisplayLayer']['drawRect']={syn:'Dessine un rectangle vide \xE0 une position sp\xE9cifi\xE9e.',lib:'displaylayer.drawRect()',pro:'function drawRect(x1, y1, x2, y2)',cmt:'

Dessine un rectangle vide \xE0 une position sp\xE9cifi\xE9e.

',par:{x1:'la distance en pixels depuis la gauche de la couche jusqu\x27au bord gauche du rectangle',y1:'la distance en pixels depuis le haut de la couche jusqu\x27au bord sup\xE9rieur du rectangle',x2:'la distance en pixels depuis la gauche de la couche jusqu\x27au bord droit du rectangle',y2:'la distance en pixels depuis le haut de la couche jusqu\x27au bord inf\xE9rieur du rectangle'},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['DisplayLayer']['drawText']={syn:'Affiche un texte \xE0 la position sp\xE9cifi\xE9e de la couche.',lib:'displaylayer.drawText()',pro:'function drawText(x, y, anchor, text)',cmt:'

Affiche un texte \xE0 la position sp\xE9cifi\xE9e de la couche. Le point du texte qui sera align\xE9 sur la position sp\xE9cifi\xE9e est appel\xE9 point d\x27ancrage, et peut \xEAtre choisi parmi plusieurs options.

',par:{x:'la distance en pixels depuis la gauche de la couche jusqu\x27au point d\x27ancrage du texte',y:'la distance en pixels depuis le haut de la couche jusqu\x27au point d\x27ancrage du texte',anchor:'le point d\x27ancrage du texte, choisi parmi l\x27\xE9num\xE9ration `Y_ALIGN`: `Y_ALIGN_TOP_LEFT`, `Y_ALIGN_CENTER_LEFT`, `Y_ALIGN_BASELINE_LEFT`, `Y_ALIGN_BOTTOM_LEFT`, `Y_ALIGN_TOP_CENTER`, `Y_ALIGN_CENTER`, `Y_ALIGN_BASELINE_CENTER`, `Y_ALIGN_BOTTOM_CENTER`, `Y_ALIGN_TOP_DECIMAL`, `Y_ALIGN_CENTER_DECIMAL`, `Y_ALIGN_BASELINE_DECIMAL`, `Y_ALIGN_BOTTOM_DECIMAL`, `Y_ALIGN_TOP_RIGHT`, `Y_ALIGN_CENTER_RIGHT`, `Y_ALIGN_BASELINE_RIGHT`, `Y_ALIGN_BOTTOM_RIGHT`.',text:'le texte \xE0 afficher'},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['DisplayLayer']['get_display']={syn:'Retourne l\x27YDisplay parent.',lib:'displaylayer.get_display()',pro:'function get_display()',cmt:'

Retourne l\x27YDisplay parent. Retourne l\x27objet YDisplay parent du YDisplayLayer courant.

',ret:'un objet `YDisplay`'}; doc['DisplayLayer']['get_displayHeight']={syn:'Retourne la hauteur de l\x27\xE9cran, en pixels.',lib:'displaylayer.get_displayHeight()',pro:'function get_displayHeight()',cmt:'

Retourne la hauteur de l\x27\xE9cran, en pixels.

',ret:'un entier repr\xE9sentant la hauteur de l\x27\xE9cran, en pixels',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_DISPLAYHEIGHT_INVALID.'}; doc['DisplayLayer']['get_displayWidth']={syn:'Retourne la largeur de l\x27\xE9cran, en pixels.',lib:'displaylayer.get_displayWidth()',pro:'function get_displayWidth()',cmt:'

Retourne la largeur de l\x27\xE9cran, en pixels.

',ret:'un entier repr\xE9sentant la largeur de l\x27\xE9cran, en pixels',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_DISPLAYWIDTH_INVALID.'}; doc['DisplayLayer']['get_layerHeight']={syn:'Retourne la hauteur des couches affichables, en pixels.',lib:'displaylayer.get_layerHeight()',pro:'function get_layerHeight()',cmt:'

Retourne la hauteur des couches affichables, en pixels.

',ret:'un entier repr\xE9sentant la hauteur des couches affichables, en pixels. En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_LAYERHEIGHT_INVALID.'}; doc['DisplayLayer']['get_layerWidth']={syn:'Retourne la largeur des couches affichables, en pixels.',lib:'displaylayer.get_layerWidth()',pro:'function get_layerWidth()',cmt:'

Retourne la largeur des couches affichables, en pixels.

',ret:'un entier repr\xE9sentant la largeur des couches affichables, en pixels',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne Y_LAYERWIDTH_INVALID.'}; doc['DisplayLayer']['hide']={syn:'Cache la couche de dessin.',lib:'displaylayer.hide()',pro:'function hide()',cmt:'

Cache la couche de dessin. L\x27etat de la couche est pr\xE9serv\xE9, mais la couche ne sera plus plus affich\xE9s \xE0 l\x27\xE9cran jusqu\x27au prochain appel \xE0 `unhide()`. Le fait de cacher la couche am\xE9liore les performances de toutes les primitives d\x27affichage, car il \xE9vite de consacrer inutilement des cycles de calcul \xE0 afficher les \xE9tats interm\xE9diaires (technique de double-buffering).

',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['DisplayLayer']['lineTo']={syn:'Dessine une ligne depuis le point de dessin courant jusqu\x27\xE0 la position sp\xE9cifi\xE9e.',lib:'displaylayer.lineTo()',pro:'function lineTo(x, y)',cmt:'

Dessine une ligne depuis le point de dessin courant jusqu\x27\xE0 la position sp\xE9cifi\xE9e. Le pixel final sp\xE9cifi\xE9 est inclus dans la ligne dessin\xE9e. Le point de dessin courant est d\xE9plac\xE9 \xE0 au point final de la ligne.

',par:{x:'la distance en pixels depuis la gauche de la couche jusqu\x27au point final',y:'la distance en pixels depuis le haut de la couche jusqu\x27au point final'},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['DisplayLayer']['moveTo']={syn:'D\xE9place le point de dessin courant de cette couche \xE0 la position sp\xE9cifi\xE9e.',lib:'displaylayer.moveTo()',pro:'function moveTo(x, y)',cmt:'

D\xE9place le point de dessin courant de cette couche \xE0 la position sp\xE9cifi\xE9e.

',par:{x:'la distance en pixels depuis la gauche de la couche de dessin',y:'la distance en pixels depuis le haut de la couche de dessin'},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['DisplayLayer']['reset']={syn:'Remet la couche de dessin dans son \xE9tat initial (enti\xE8rement transparente, r\xE9glages par d\xE9faut).',lib:'displaylayer.reset()',pro:'function reset()',cmt:'

Remet la couche de dessin dans son \xE9tat initial (enti\xE8rement transparente, r\xE9glages par d\xE9faut). R\xE9initialise la position du point de dessin courant au coin sup\xE9rieur gauche, et la couleur de dessin \xE0 la valeur la plus lumineuse. Si vous d\xE9sirez simplement effacer le contenu de la couche, utilisez plut\xF4t la m\xE9thode `clear()`.

',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['DisplayLayer']['selectColorPen']={syn:'Choisit la couleur du crayon \xE0 utiliser pour tous les appels suivants aux fonctions de dessin.',lib:'displaylayer.selectColorPen()',pro:'function selectColorPen(color)',cmt:'

Choisit la couleur du crayon \xE0 utiliser pour tous les appels suivants aux fonctions de dessin. La couleur est fournie sous forme de couleur RGB. Pour les \xE9crans monochromes ou en niveaux de gris, la couleur est automatiquement ramen\xE9e dans les valeurs permises.

',par:{color:'la couleur RGB d\xE9sir\xE9e (sous forme d\x27entier 24 bits)'},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['DisplayLayer']['selectEraser']={syn:'Choisit une gomme plut\xF4t qu\x27un crayon pour tous les appels suivants aux fonctions de dessin, \xE0 l\x27exception de copie d\x27images bitmaps.',lib:'displaylayer.selectEraser()',pro:'function selectEraser()',cmt:'

Choisit une gomme plut\xF4t qu\x27un crayon pour tous les appels suivants aux fonctions de dessin, \xE0 l\x27exception de copie d\x27images bitmaps. Tous les points dessin\xE9s \xE0 la gomme redeviennent transparents (comme ils l\x27\xE9taient lorsque la couche \xE9tait vide), rendant ainsi visibles les couches inf\xE9rieures.

',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['DisplayLayer']['selectFont']={syn:'S\xE9lectionne la police de caract\xE8res \xE0 utiliser pour les fonctions d\x27affichage de texte suivantes.',lib:'displaylayer.selectFont()',pro:'function selectFont(fontname)',cmt:'

S\xE9lectionne la police de caract\xE8res \xE0 utiliser pour les fonctions d\x27affichage de texte suivantes. La police est sp\xE9cifi\xE9e par le nom de son fichier. Vous pouvez utiliser l\x27une des polices pr\xE9d\xE9finies dans le module, ou une autre police que vous avez pr\xE9alablement pr\xE9charg\xE9 dans la m\xE9moire du module. Si vous rencontrez des probl\xE8mes \xE0 l\x27utilisation d\x27une police de caract\xE8res, consultez les logs du module pour voir si vous n\x27y trouvez pas un message \xE0 propos d\x27un fichier de police manquant ou d\x27un format de fichier invalide.

',par:{fontname:'le nom du fichier d\xE9finissant la police 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.'}; doc['DisplayLayer']['selectGrayPen']={syn:'Choisit le niveau de gris \xE0 utiliser pour tous les appels suivants aux fonctions de dessin.',lib:'displaylayer.selectGrayPen()',pro:'function selectGrayPen(graylevel)',cmt:'

Choisit le niveau de gris \xE0 utiliser pour tous les appels suivants aux fonctions de dessin. Le niveau de gris est fourni sous forme d\x27un chiffre allant de 0 (noir) \xE0 255 (blanc, ou la couleur la plus claire de l\x27\xE9cran, quelle qu\x27elle soit). Pour les \xE9crans monochromes (sans niveaux de gris), tout valeur inf\xE9rieure \xE0 128 conduit \xE0 un point noir, et toue valeur sup\xE9rieure ou \xE9gale \xE0 128 devient un point lumineux.

',par:{graylevel:'le niveau de gris d\xE9sir\xE9, de 0 \xE0 255'},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['DisplayLayer']['setAntialiasingMode']={syn:'Active ou d\xE9sactive l\x27anti-aliasing pour tracer les lignes et les cercles.',lib:'displaylayer.setAntialiasingMode()',pro:'function setAntialiasingMode(mode)',cmt:'

Active ou d\xE9sactive l\x27anti-aliasing pour tracer les lignes et les cercles. L\x27anti-aliasing est att\xE9nue la pixelisation des images lorsqu\x27on regarde l\x27\xE9cran depuis une distance suffisante, mais peut aussi donner parfois une impression de flou lorsque l\x27\xE9cran est regard\xE9 de tr\xE8s pr\xE8s. Au final, c\x27est un choix esth\xE9tique qui vous revient. L\x27anti-aliasing est activ\xE9 par d\xE9faut pour les \xE9crans en niveaux de gris et les \xE9crans couleurs, mais vous pouvez le d\xE9sactiver si vous pr\xE9f\xE9rez. Ce r\xE9glage n\x27a pas d\x27effet sur les \xE9crans monochromes.

',par:{mode:'true pour activer l\x27antialiasing, false pour le d\xE9sactiver.'},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['DisplayLayer']['setConsoleBackground']={syn:'Configure la couleur de fond utilis\xE9e par la fonction `clearConsole` et par le d\xE9filement automatique de la console.',lib:'displaylayer.setConsoleBackground()',pro:'function setConsoleBackground(bgcol)',cmt:'

Configure la couleur de fond utilis\xE9e par la fonction `clearConsole` et par le d\xE9filement automatique de la console.

',par:{bgcol:'le niveau de gris \xE0 utiliser pour le fond lors de d\xE9filement (0 = noir, 255 = blanc), ou -1 pour un fond transparent'},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['DisplayLayer']['setConsoleMargins']={syn:'Configure les marges d\x27affichage pour la fonction `consoleOut`.',lib:'displaylayer.setConsoleMargins()',pro:'function setConsoleMargins(x1, y1, x2, y2)',cmt:'

Configure les marges d\x27affichage pour la fonction `consoleOut`.

',par:{x1:'la distance en pixels depuis la gauche de la couche jusqu\x27\xE0 la marge gauche',y1:'la distance en pixels depuis le haut de la couche jusqu\x27\xE0 la marge sup\xE9rieure',x2:'la distance en pixels depuis la gauche de la couche jusqu\x27\xE0 la marge droite',y2:'la distance en pixels depuis le haut de la couche jusqu\x27\xE0 la marge inf\xE9rieure'},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['DisplayLayer']['setConsoleWordWrap']={syn:'Configure le mode de retour \xE0 la ligne utilis\xE9 par la fonction `consoleOut`.',lib:'displaylayer.setConsoleWordWrap()',pro:'function setConsoleWordWrap(wordwrap)',cmt:'

Configure le mode de retour \xE0 la ligne utilis\xE9 par la fonction `consoleOut`.

',par:{wordwrap:'`true` pour retourner \xE0 la ligne entre les mots seulements, `false` pour retourner \xE0 l\x27extr\xEAme droite de chaque ligne.'},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['DisplayLayer']['setLayerPosition']={syn:'D\xE9place la position de la couche de dessin par rapport au coin sup\xE9rieur gauche de l\x27\xE9cran.',lib:'displaylayer.setLayerPosition()',pro:'function setLayerPosition(x, y, scrollTime)',cmt:'

D\xE9place la position de la couche de dessin par rapport au coin sup\xE9rieur gauche de l\x27\xE9cran. Lorsqu\x27une dur\xE9e de d\xE9filement est configur\xE9e, la position d\x27affichage de la couche est automatiquement mise \xE0 jour durant les millisecondes suivantes pour animer le d\xE9placement.

',par:{x:'la distance en pixels depuis la gauche de l\x27\xE9cran jusqu\x27\xE0 l\x27origine de la couche.',y:'la distance en pixels depuis le haut de l\x27\xE9cran jusqu\x27\xE0 l\x27origine de la couche.',scrollTime:'dur\xE9e en millisecondes du d\xE9placement, ou 0 si le d\xE9placement doit \xEAtre imm\xE9diat.'},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['DisplayLayer']['unhide']={syn:'Affiche la couche.',lib:'displaylayer.unhide()',pro:'function unhide()',cmt:'

Affiche la couche. Affiche a nouveau la couche apr\xE8s la command hide.

',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.'}; //--- (end of generated code: DisplayLayer) //--- (generated code: Files) doc['Files']={'':{syn:'Interface de la fonction Files',inc:'<script type='text/javascript' src='yocto_files.js'></script>',cmt:'

L\x27interface de stockage de fichiers permet de stocker des fichiers sur certains modules, par exemple pour personnaliser un service web (dans le cas d\x27un module connect\xE9 au r\xE9seau) ou pour ajouter un police de caract\xE8res (dans le cas d\x27un module d\x27affichage).

'}}; doc['Files']['FindFiles']={syn:'Permet de retrouver un syst\xE8me de fichier d\x27apr\xE8s un identifiant donn\xE9.',lib:'YFiles.FindFiles()',pro:'function FindFiles(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le syst\xE8me de fichier soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YFiles.isOnline()` pour tester si le syst\xE8me de fichier 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 le syst\xE8me de fichier sans ambigu\xEFt\xE9'},ret:'un objet de classe `YFiles` qui permet ensuite de contr\xF4ler le syst\xE8me de fichier.'}; doc['Files']['FirstFiles']={syn:'Commence l\x27\xE9num\xE9ration des syst\xE8me de fichier accessibles par la librairie.',lib:'YFiles.FirstFiles()',pro:'function FirstFiles()',cmt:'

Commence l\x27\xE9num\xE9ration des syst\xE8me de fichier accessibles par la librairie. Utiliser la fonction `YFiles.nextFiles()` pour it\xE9rer sur les autres syst\xE8me de fichier.

',ret:'un pointeur sur un objet `YFiles`, correspondant au premier syst\xE8me de fichier accessible en ligne, ou `null` si il n\x27y a pas de syst\xE8me de fichier disponibles.'}; doc['Files']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du syst\xE8me de fichier au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'files.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du syst\xE8me de fichier 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 syst\xE8me de fichier (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Files']['download']={syn:'T\xE9l\xE9charge le fichier choisi du filesyst\xE8me et retourne son contenu.',lib:'files.download()',pro:'function download(pathname)',cmt:'

T\xE9l\xE9charge le fichier choisi du filesyst\xE8me et retourne son contenu.

',par:{pathname:'nom complet du fichier \xE0 charger, y compris le chemin d\x27acc\xE8s.'},ret:'le contenu du fichier charg\xE9 sous forme d\x27objet binaire',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un contenu vide.'}; doc['Files']['download_async']={syn:'Proc\xE8de au chargement du bloc suivant de mesures depuis l\x27enregistreur de donn\xE9es du module, de mani\xE8re asynchrone.',lib:'files.download_async()',pro:'function download_async(pathname, callback, context)',cmt:'

Proc\xE8de au chargement du bloc suivant de mesures depuis l\x27enregistreur de donn\xE9es du module, de mani\xE8re asynchrone.

',par:{pathname:'nom complet du fichier \xE0 charger, y compris le chemin d\x27acc\xE8s.',callback:'fonction fournie par l\x27utilisateur, qui sera appel\xE9e lorsque la suite du chargement aura \xE9t\xE9 effectu\xE9. La fonction callback doit prendre trois arguments: - la variable de contexte \xE0 disposition de l\x27utilisateur - l\x27objet YFiles dont la m\xE9thode download_async a \xE9t\xE9 appel\xE9e - le contenu du fichier charg\xE9 sous forme d\x27objet binaire',context:'variable de contexte \xE0 disposition de l\x27utilisateur'},ret:'rien.'}; doc['Files']['format_fs']={syn:'R\xE9tabli le syst\xE8me de fichier dans on \xE9tat original, d\xE9fragment\xE9.',lib:'files.format_fs()',pro:'function format_fs()',cmt:'

R\xE9tabli le syst\xE8me de fichier dans on \xE9tat original, d\xE9fragment\xE9. enti\xE8rement vide. Tous les fichiers pr\xE9c\xE9demment charg\xE9s sont irr\xE9m\xE9diablement effac\xE9s.

',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['Files']['get_advertisedValue']={syn:'Retourne la valeur courante du syst\xE8me de fichier (pas plus de 6 caract\xE8res).',lib:'files.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du syst\xE8me de fichier (pas plus de 6 caract\xE8res).

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

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du syst\xE8me de fichier. 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 syst\xE8me de fichier.'}; doc['Files']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du syst\xE8me de fichier.',lib:'files.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du syst\xE8me de fichier. 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 syst\xE8me de fichier.'}; doc['Files']['get_filesCount']={syn:'Retourne le nombre de fichiers pr\xE9sents dans le syst\xE8me de fichier.',lib:'files.get_filesCount()',pro:'function get_filesCount()',cmt:'

Retourne le nombre de fichiers pr\xE9sents dans le syst\xE8me de fichier.

',ret:'un entier représentant le nombre de fichiers pr\xE9sents dans le syst\xE8me de fichier',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_FILESCOUNT_INVALID`.'}; doc['Files']['get_freeSpace']={syn:'Retourne l\x27espace disponible dans le syst\xE8me de fichier pour charger des nouveaux fichiers, en octets.',lib:'files.get_freeSpace()',pro:'function get_freeSpace()',cmt:'

Retourne l\x27espace disponible dans le syst\xE8me de fichier pour charger des nouveaux fichiers, en octets.

',ret:'un entier représentant l\x27espace disponible dans le syst\xE8me de fichier pour charger des nouveaux fichiers, en octets',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_FREESPACE_INVALID`.'}; doc['Files']['get_friendlyName']={syn:'Retourne un identifiant global du syst\xE8me de fichier au format `NOM_MODULE.NOM_FONCTION`.',lib:'files.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le syst\xE8me de fichier en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Files']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'files.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Files']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du syst\xE8me de fichier, sans r\xE9f\xE9rence au module.',lib:'files.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du syst\xE8me de fichier, sans r\xE9f\xE9rence au module. Par example `relay1`.

',ret:'une cha\xEEne de caract\xE8res identifiant le syst\xE8me de fichier (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['Files']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du syst\xE8me de fichier au format `SERIAL.FUNCTIONID`.',lib:'files.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du syst\xE8me de fichier 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 syst\xE8me de fichier (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le syst\xE8me de fichier (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Files']['get_list']={syn:'Retourne une liste d\x27objets objet YFileRecord qui d\xE9crivent les fichiers pr\xE9sents dans le syst\xE8me de fichier.',lib:'files.get_list()',pro:'function get_list(pattern)',cmt:'

Retourne une liste d\x27objets objet YFileRecord qui d\xE9crivent les fichiers pr\xE9sents dans le syst\xE8me de fichier.

',par:{pattern:'un filtre optionel sur les noms de fichiers retourn\xE9s, pouvant contenir des ast\xE9risques et des points d\x27interrogations comme jokers. Si le pattern fourni est vide, tous les fichiers sont retourn\xE9s.'},ret:'une liste d\x27objets `YFileRecord`, contenant le nom complet (y compris le chemin d\x27acc\xE8s), la taille en octets et le CRC 32-bit du contenu du fichier.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne une liste vide.'}; doc['Files']['get_logicalName']={syn:'Retourne le nom logique du syst\xE8me de fichier.',lib:'files.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du syst\xE8me de fichier.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du syst\xE8me de fichier.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Files']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'files.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['Files']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'files.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['Files']['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:'files.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['Files']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le syst\xE8me de fichier est joignable, sans d\xE9clencher d\x27erreur.',lib:'files.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le syst\xE8me de fichier est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du syst\xE8me de fichier 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 syst\xE8me de fichier est joignable, `false` sinon'}; doc['Files']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le syst\xE8me de fichier est joignable, sans d\xE9clencher d\x27erreur.',lib:'files.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le syst\xE8me de fichier est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du syst\xE8me de fichier 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.'}; doc['Files']['load']={syn:'Met en cache les valeurs courantes du syst\xE8me de fichier, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'files.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du syst\xE8me de fichier, 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.'}; doc['Files']['load_async']={syn:'Met en cache les valeurs courantes du syst\xE8me de fichier, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'files.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du syst\xE8me de fichier, 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.'}; doc['Files']['nextFiles']={syn:'Continue l\x27\xE9num\xE9ration des syst\xE8me de fichier commenc\xE9e \xE0 l\x27aide de `yFirstFiles()`.',lib:'files.nextFiles()',pro:'function nextFiles()',cmt:'

Continue l\x27\xE9num\xE9ration des syst\xE8me de fichier commenc\xE9e \xE0 l\x27aide de `yFirstFiles()`.

',ret:'un pointeur sur un objet `YFiles` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Files']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'files.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['Files']['remove']={syn:'Efface un fichier, sp\xE9cifi\xE9 par son path complet, du syst\xE8me de fichier.',lib:'files.remove()',pro:'function remove(pathname)',cmt:'

Efface un fichier, sp\xE9cifi\xE9 par son path complet, du syst\xE8me de fichier. A cause de la fragmentation, l\x27effacement d\x27un fichier ne lib\xE8re pas toujours la totalit\xE9 de l\x27espace qu\x27il occuppe. Par contre, la r\xE9-\xE9criture d\x27un fichier du m\xEAme nom r\xE9cup\xE9rera dans tout les cas l\x27espace qui n\x27aurait \xE9ventuellement pas \xE9t\xE9 lib\xE9r\xE9. Pour s\x27assurer de lib\xE9rer la totalit\xE9 de l\x27espace du syst\xE8me de fichier, utilisez la fonction `format_fs`.

',par:{pathname:'nom complet du fichier, y compris le chemin d\x27acc\xE8s.'},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['Files']['set_logicalName']={syn:'Modifie le nom logique du syst\xE8me de fichier.',lib:'files.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du syst\xE8me de fichier. 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 syst\xE8me de fichier.'},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.'}; doc['Files']['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:'files.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['Files']['upload']={syn:'T\xE9l\xE9charge un contenu vers le syst\xE8me de fichier, au chemin d\x27acc\xE8s sp\xE9cifi\xE9.',lib:'files.upload()',pro:'function upload(pathname, content)',cmt:'

T\xE9l\xE9charge un contenu vers le syst\xE8me de fichier, au chemin d\x27acc\xE8s sp\xE9cifi\xE9. Si un fichier existe d\xE9j\xE0 pour le m\xEAme chemin d\x27acc\xE8s, son contenu est remplac\xE9.

',par:{pathname:'nom complet du fichier, y compris le chemin d\x27acc\xE8s.',content:'contenu du fichier \xE0 t\xE9l\xE9charger'},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['Files']['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:'files.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 machine virtuelle 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: Files) //--- (generated code: RealTimeClock) doc['RealTimeClock']={'':{syn:'Interface de la fonction Horloge Temps Real',inc:'<script type='text/javascript' src='yocto_realtimeclock.js'></script>',cmt:'

La fonction RealTimeClock fourni la date et l\x27heure courante de mani\xE8re persistante, m\xEAme en cas de coupure de courant de plusieurs jours. Elle est le fondement des fonctions de r\xE9veil automatique impl\xE9ment\xE9es par le WakeUpScheduler. L\x27heure courante peut repr\xE9senter aussi bien une heure locale qu\x27une heure UTC, mais aucune adaptation automatique n\x27est fait au changement d\x27heure \xE9t\xE9/hiver.

'}}; doc['RealTimeClock']['FindRealTimeClock']={syn:'Permet de retrouver une horloge d\x27apr\xE8s un identifiant donn\xE9.',lib:'YRealTimeClock.FindRealTimeClock()',pro:'function FindRealTimeClock(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27horloge soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YRealTimeClock.isOnline()` pour tester si l\x27horloge 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 l\x27horloge sans ambigu\xEFt\xE9'},ret:'un objet de classe `YRealTimeClock` qui permet ensuite de contr\xF4ler l\x27horloge.'}; doc['RealTimeClock']['FirstRealTimeClock']={syn:'Commence l\x27\xE9num\xE9ration des horloge accessibles par la librairie.',lib:'YRealTimeClock.FirstRealTimeClock()',pro:'function FirstRealTimeClock()',cmt:'

Commence l\x27\xE9num\xE9ration des horloge accessibles par la librairie. Utiliser la fonction `YRealTimeClock.nextRealTimeClock()` pour it\xE9rer sur les autres horloge.

',ret:'un pointeur sur un objet `YRealTimeClock`, correspondant \xE0 la premi\xE8re horloge accessible en ligne, ou `null` si il n\x27y a pas de horloge disponibles.'}; doc['RealTimeClock']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27horloge au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'realtimeclock.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27horloge 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\x27horloge (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['RealTimeClock']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27horloge (pas plus de 6 caract\xE8res).',lib:'realtimeclock.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27horloge (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27horloge (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['RealTimeClock']['get_dateTime']={syn:'Retourne l\x27heure courante au format \x22AAAA/MM/JJ hh:mm:ss\x22 ',lib:'realtimeclock.get_dateTime()',pro:'function get_dateTime()',cmt:'

Retourne l\x27heure courante au format \x22AAAA/MM/JJ hh:mm:ss\x22

',ret:'une chaîne de caractères représentant l\x27heure courante au format \x22AAAA/MM/JJ hh:mm:ss\x22',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DATETIME_INVALID`.'}; doc['RealTimeClock']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27horloge.',lib:'realtimeclock.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27horloge. 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\x27horloge.'}; doc['RealTimeClock']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27horloge.',lib:'realtimeclock.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\x27horloge. 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\x27horloge.'}; doc['RealTimeClock']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27horloge au format `NOM_MODULE.NOM_FONCTION`.',lib:'realtimeclock.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27horloge en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['RealTimeClock']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'realtimeclock.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['RealTimeClock']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27horloge, sans r\xE9f\xE9rence au module.',lib:'realtimeclock.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27horloge 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\x27horloge (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27horloge (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['RealTimeClock']['get_logicalName']={syn:'Retourne le nom logique de l\x27horloge.',lib:'realtimeclock.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27horloge.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27horloge.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['RealTimeClock']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'realtimeclock.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['RealTimeClock']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'realtimeclock.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['RealTimeClock']['get_timeSet']={syn:'Retourne vrai si l\x27horloge \xE0 \xE9t\xE9 mise \xE0 l\x27heure, sinon faux.',lib:'realtimeclock.get_timeSet()',pro:'function get_timeSet()',cmt:'

Retourne vrai si l\x27horloge \xE0 \xE9t\xE9 mise \xE0 l\x27heure, sinon faux.

',ret:'soit `Y_TIMESET_FALSE`, soit `Y_TIMESET_TRUE`, selon vrai si l\x27horloge \xE0 \xE9t\xE9 mise \xE0 l\x27heure, sinon faux',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_TIMESET_INVALID`.'}; doc['RealTimeClock']['get_unixTime']={syn:'Retourne l\x27heure courante au format Unix (nombre de seconds secondes \xE9coul\xE9es depuis le 1er janvier 1970).',lib:'realtimeclock.get_unixTime()',pro:'function get_unixTime()',cmt:'

Retourne l\x27heure courante au format Unix (nombre de seconds secondes \xE9coul\xE9es depuis le 1er janvier 1970).

',ret:'un entier représentant l\x27heure courante au format Unix (nombre de seconds secondes \xE9coul\xE9es depuis le 1er janvier 1970)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIXTIME_INVALID`.'}; doc['RealTimeClock']['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:'realtimeclock.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['RealTimeClock']['get_utcOffset']={syn:'Retourne le nombre de secondes de d\xE9callage entre l\x27heure courante et l\x27heure UTC (time zone).',lib:'realtimeclock.get_utcOffset()',pro:'function get_utcOffset()',cmt:'

Retourne le nombre de secondes de d\xE9callage entre l\x27heure courante et l\x27heure UTC (time zone).

',ret:'un entier représentant le nombre de secondes de d\xE9callage entre l\x27heure courante et l\x27heure UTC (time zone)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UTCOFFSET_INVALID`.'}; doc['RealTimeClock']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27horloge est joignable, sans d\xE9clencher d\x27erreur.',lib:'realtimeclock.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27horloge est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27horloge 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\x27horloge est joignable, `false` sinon'}; doc['RealTimeClock']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27horloge est joignable, sans d\xE9clencher d\x27erreur.',lib:'realtimeclock.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27horloge est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27horloge 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.'}; doc['RealTimeClock']['load']={syn:'Met en cache les valeurs courantes de l\x27horloge, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'realtimeclock.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27horloge, 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.'}; doc['RealTimeClock']['load_async']={syn:'Met en cache les valeurs courantes de l\x27horloge, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'realtimeclock.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27horloge, 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.'}; doc['RealTimeClock']['nextRealTimeClock']={syn:'Continue l\x27\xE9num\xE9ration des horloge commenc\xE9e \xE0 l\x27aide de `yFirstRealTimeClock()`.',lib:'realtimeclock.nextRealTimeClock()',pro:'function nextRealTimeClock()',cmt:'

Continue l\x27\xE9num\xE9ration des horloge commenc\xE9e \xE0 l\x27aide de `yFirstRealTimeClock()`.

',ret:'un pointeur sur un objet `YRealTimeClock` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['RealTimeClock']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'realtimeclock.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['RealTimeClock']['set_logicalName']={syn:'Modifie le nom logique de l\x27horloge.',lib:'realtimeclock.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27horloge. 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\x27horloge.'},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.'}; doc['RealTimeClock']['set_unixTime']={syn:'Modifie l\x27heure courante.',lib:'realtimeclock.set_unixTime()',pro:'function set_unixTime(newval)',cmt:'

Modifie l\x27heure courante. L\x27heure est pass\xE9e au format Unix (nombre de seconds secondes \xE9coul\xE9es depuis le 1er janvier 1970). Si l\x27heure UTC est connue, l\x27attribut utcOffset sera automatiquement ajust\xE9 en fonction de l\x27heure configur\xE9e.

',par:{newval:'un entier représentant l\x27heure courante'},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.'}; doc['RealTimeClock']['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:'realtimeclock.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['RealTimeClock']['set_utcOffset']={syn:'Modifie le nombre de secondes de d\xE9calage entre l\x27heure courante et l\x27heure UTC (time zone).',lib:'realtimeclock.set_utcOffset()',pro:'function set_utcOffset(newval)',cmt:'

Modifie le nombre de secondes de d\xE9calage entre l\x27heure courante et l\x27heure UTC (time zone). Le d\xE9callage est automatiquement arrondi au quart d\x27heure le plus proche. Si l\x27heure UTC est connue, l\x27heure courante sera automatiquement adapt\xE9e en fonction du d\xE9calage choisi.

',par:{newval:'un entier représentant le nombre de secondes de d\xE9calage entre l\x27heure courante et l\x27heure UTC (time zone)'},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.'}; doc['RealTimeClock']['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:'realtimeclock.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 machine virtuelle 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: RealTimeClock) //--- (generated code: WakeUpMonitor) doc['WakeUpMonitor']={'':{syn:'Interface de la fonction WakeUpMonitor',inc:'<script type='text/javascript' src='yocto_wakeupmonitor.js'></script>',cmt:'

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

'}}; doc['WakeUpMonitor']['FindWakeUpMonitor']={syn:'Permet de retrouver un moniteur d\x27apr\xE8s un identifiant donn\xE9.',lib:'YWakeUpMonitor.FindWakeUpMonitor()',pro:'function FindWakeUpMonitor(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le moniteur 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 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 le moniteur sans ambigu\xEFt\xE9'},ret:'un objet de classe `YWakeUpMonitor` qui permet ensuite de contr\xF4ler le moniteur.'}; doc['WakeUpMonitor']['FirstWakeUpMonitor']={syn:'Commence l\x27\xE9num\xE9ration des Moniteurs accessibles par la librairie.',lib:'YWakeUpMonitor.FirstWakeUpMonitor()',pro:'function FirstWakeUpMonitor()',cmt:'

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

',ret:'un pointeur sur un objet `YWakeUpMonitor`, correspondant au premier moniteur accessible en ligne, ou `null` si il n\x27y a pas de Moniteurs disponibles.'}; doc['WakeUpMonitor']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du moniteur au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'wakeupmonitor.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du moniteur 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 (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['WakeUpMonitor']['get_advertisedValue']={syn:'Retourne la valeur courante du moniteur (pas plus de 6 caract\xE8res).',lib:'wakeupmonitor.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

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

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moniteur. 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.'}; doc['WakeUpMonitor']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moniteur.',lib:'wakeupmonitor.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. 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.'}; doc['WakeUpMonitor']['get_friendlyName']={syn:'Retourne un identifiant global du moniteur au format `NOM_MODULE.NOM_FONCTION`.',lib:'wakeupmonitor.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le moniteur en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['WakeUpMonitor']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'wakeupmonitor.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['WakeUpMonitor']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du moniteur, sans r\xE9f\xE9rence au module.',lib:'wakeupmonitor.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du moniteur 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 (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le moniteur (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['WakeUpMonitor']['get_logicalName']={syn:'Retourne le nom logique du moniteur.',lib:'wakeupmonitor.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du moniteur.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du moniteur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['WakeUpMonitor']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'wakeupmonitor.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['WakeUpMonitor']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'wakeupmonitor.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['WakeUpMonitor']['get_nextWakeUp']={syn:'Retourne la prochaine date/heure de r\xE9veil agend\xE9e (format UNIX) ',lib:'wakeupmonitor.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 `Y_NEXTWAKEUP_INVALID`.'}; doc['WakeUpMonitor']['get_powerDuration']={syn:'Retourne le temp d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement.',lib:'wakeupmonitor.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 `Y_POWERDURATION_INVALID`.'}; doc['WakeUpMonitor']['get_sleepCountdown']={syn:'Retourne le temps avant le prochain sommeil.',lib:'wakeupmonitor.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 `Y_SLEEPCOUNTDOWN_INVALID`.'}; doc['WakeUpMonitor']['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:'wakeupmonitor.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['WakeUpMonitor']['get_wakeUpReason']={syn:'Renvoie la raison du dernier r\xE9veil.',lib:'wakeupmonitor.get_wakeUpReason()',pro:'function get_wakeUpReason()',cmt:'

Renvoie la raison du dernier r\xE9veil.

',ret:'une valeur parmi `Y_WAKEUPREASON_USBPOWER`, `Y_WAKEUPREASON_EXTPOWER`, `Y_WAKEUPREASON_ENDOFSLEEP`, `Y_WAKEUPREASON_EXTSIG1`, `Y_WAKEUPREASON_SCHEDULE1` et `Y_WAKEUPREASON_SCHEDULE2`',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_WAKEUPREASON_INVALID`.'}; doc['WakeUpMonitor']['get_wakeUpState']={syn:'Revoie l\x27\xE9tat actuel du moniteur ',lib:'wakeupmonitor.get_wakeUpState()',pro:'function get_wakeUpState()',cmt:'

Revoie l\x27\xE9tat actuel du moniteur

',ret:'soit `Y_WAKEUPSTATE_SLEEPING`, soit `Y_WAKEUPSTATE_AWAKE`',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_WAKEUPSTATE_INVALID`.'}; doc['WakeUpMonitor']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le moniteur est joignable, sans d\xE9clencher d\x27erreur.',lib:'wakeupmonitor.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le moniteur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du moniteur 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 est joignable, `false` sinon'}; doc['WakeUpMonitor']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le moniteur est joignable, sans d\xE9clencher d\x27erreur.',lib:'wakeupmonitor.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le moniteur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du moniteur 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.'}; doc['WakeUpMonitor']['load']={syn:'Met en cache les valeurs courantes du moniteur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'wakeupmonitor.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du moniteur, 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.'}; doc['WakeUpMonitor']['load_async']={syn:'Met en cache les valeurs courantes du moniteur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'wakeupmonitor.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du moniteur, 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.'}; doc['WakeUpMonitor']['nextWakeUpMonitor']={syn:'Continue l\x27\xE9num\xE9ration des Moniteurs commenc\xE9e \xE0 l\x27aide de `yFirstWakeUpMonitor()`.',lib:'wakeupmonitor.nextWakeUpMonitor()',pro:'function nextWakeUpMonitor()',cmt:'

Continue l\x27\xE9num\xE9ration des Moniteurs commenc\xE9e \xE0 l\x27aide de `yFirstWakeUpMonitor()`.

',ret:'un pointeur sur un objet `YWakeUpMonitor` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['WakeUpMonitor']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'wakeupmonitor.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['WakeUpMonitor']['resetSleepCountDown']={syn:'R\xE9initialise le compteur de mise en sommeil.',lib:'wakeupmonitor.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.'}; doc['WakeUpMonitor']['set_logicalName']={syn:'Modifie le nom logique du moniteur.',lib:'wakeupmonitor.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du moniteur. 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.'},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.'}; doc['WakeUpMonitor']['set_nextWakeUp']={syn:'Modifie les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu.',lib:'wakeupmonitor.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.'}; doc['WakeUpMonitor']['set_powerDuration']={syn:'Modifie le temps d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement.',lib:'wakeupmonitor.set_powerDuration()',pro:'function set_powerDuration(newval)',cmt:'

Modifie le temps d\x27\xE9veil maximal en secondes avant de retourner en sommeil automatiquement.

',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.'}; doc['WakeUpMonitor']['set_sleepCountdown']={syn:'Modifie le temps avant le prochain sommeil .',lib:'wakeupmonitor.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.'}; doc['WakeUpMonitor']['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:'wakeupmonitor.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['WakeUpMonitor']['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:'wakeupmonitor.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.'}; doc['WakeUpMonitor']['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:'wakeupmonitor.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.'}; doc['WakeUpMonitor']['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:'wakeupmonitor.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.'}; doc['WakeUpMonitor']['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:'wakeupmonitor.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 machine virtuelle 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.'}; doc['WakeUpMonitor']['wakeUp']={syn:'Force un r\xE9veil.',lib:'wakeupmonitor.wakeUp()',pro:'function wakeUp()',cmt:'

Force un r\xE9veil.

'}; //--- (end of generated code: WakeUpMonitor) //--- (generated code: WakeUpSchedule) doc['WakeUpSchedule']={'':{syn:'Interface de la fonction WakeUpSchedule',inc:'<script type='text/javascript' src='yocto_wakeupschedule.js'></script>',cmt:'

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

'}}; doc['WakeUpSchedule']['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:

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

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.

',par:{func:'une cha\xEEne de caract\xE8res qui r\xE9f\xE9rence le r\xE9veil agend\xE9 sans ambigu\xEFt\xE9'},ret:'un objet de classe `YWakeUpSchedule` qui permet ensuite de contr\xF4ler le r\xE9veil agend\xE9.'}; doc['WakeUpSchedule']['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` si il n\x27y a pas de r\xE9veils agend\xE9s disponibles.'}; doc['WakeUpSchedule']['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:'wakeupschedule.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`)'}; doc['WakeUpSchedule']['get_advertisedValue']={syn:'Retourne la valeur courante du r\xE9veil agend\xE9 (pas plus de 6 caract\xE8res).',lib:'wakeupschedule.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 `Y_ADVERTISEDVALUE_INVALID`.'}; doc['WakeUpSchedule']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9veil agend\xE9.',lib:'wakeupschedule.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.'}; doc['WakeUpSchedule']['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:'wakeupschedule.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.'}; doc['WakeUpSchedule']['get_friendlyName']={syn:'Retourne un identifiant global du r\xE9veil agend\xE9 au format `NOM_MODULE.NOM_FONCTION`.',lib:'wakeupschedule.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 si ils 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 `Y_FRIENDLYNAME_INVALID`.'}; doc['WakeUpSchedule']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'wakeupschedule.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['WakeUpSchedule']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du r\xE9veil agend\xE9, sans r\xE9f\xE9rence au module.',lib:'wakeupschedule.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 `Y_FUNCTIONID_INVALID`.'}; doc['WakeUpSchedule']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du r\xE9veil agend\xE9 au format `SERIAL.FUNCTIONID`.',lib:'wakeupschedule.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 `Y_HARDWAREID_INVALID`.'}; doc['WakeUpSchedule']['get_hours']={syn:'Retourne les heures o\xF9 le r\xE9veil est actif..',lib:'wakeupschedule.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 `Y_HOURS_INVALID`.'}; doc['WakeUpSchedule']['get_logicalName']={syn:'Retourne le nom logique du r\xE9veil agend\xE9.',lib:'wakeupschedule.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 `Y_LOGICALNAME_INVALID`.'}; doc['WakeUpSchedule']['get_minutes']={syn:'Retourne toutes les minutes de chaque heure o\xF9 le r\xE9veil est actif.',lib:'wakeupschedule.get_minutes()',pro:'function get_minutes()',cmt:'

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

'}; doc['WakeUpSchedule']['get_minutesA']={syn:'Retourne les minutes de l\x27interval 00-29 de chaque heures o\xF9 le r\xE9veil est actif.',lib:'wakeupschedule.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 `Y_MINUTESA_INVALID`.'}; doc['WakeUpSchedule']['get_minutesB']={syn:'Retourne les minutes de l\x27interval 30-59 de chaque heure o\xF9 le r\xE9veil est actif.',lib:'wakeupschedule.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 `Y_MINUTESB_INVALID`.'}; doc['WakeUpSchedule']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'wakeupschedule.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['WakeUpSchedule']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'wakeupschedule.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['WakeUpSchedule']['get_monthDays']={syn:'Retourne les jours du mois o\xF9 le r\xE9veil est actif..',lib:'wakeupschedule.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 `Y_MONTHDAYS_INVALID`.'}; doc['WakeUpSchedule']['get_months']={syn:'Retourne les mois o\xF9 le r\xE9veil est actif..',lib:'wakeupschedule.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 `Y_MONTHS_INVALID`.'}; doc['WakeUpSchedule']['get_nextOccurence']={syn:'Retourne la date/heure de la prochaine occurence de r\xE9veil ',lib:'wakeupschedule.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 `Y_NEXTOCCURENCE_INVALID`.'}; doc['WakeUpSchedule']['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:'wakeupschedule.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['WakeUpSchedule']['get_weekDays']={syn:'Retourne les jours de la semaine o\xF9 le r\xE9veil est actif..',lib:'wakeupschedule.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 `Y_WEEKDAYS_INVALID`.'}; doc['WakeUpSchedule']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le r\xE9veil agend\xE9 est joignable, sans d\xE9clencher d\x27erreur.',lib:'wakeupschedule.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'}; doc['WakeUpSchedule']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le r\xE9veil agend\xE9 est joignable, sans d\xE9clencher d\x27erreur.',lib:'wakeupschedule.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.'}; doc['WakeUpSchedule']['load']={syn:'Met en cache les valeurs courantes du r\xE9veil agend\xE9, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'wakeupschedule.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.'}; doc['WakeUpSchedule']['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:'wakeupschedule.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.'}; doc['WakeUpSchedule']['nextWakeUpSchedule']={syn:'Continue l\x27\xE9num\xE9ration des r\xE9veils agend\xE9s commenc\xE9e \xE0 l\x27aide de `yFirstWakeUpSchedule()`.',lib:'wakeupschedule.nextWakeUpSchedule()',pro:'function nextWakeUpSchedule()',cmt:'

Continue l\x27\xE9num\xE9ration des r\xE9veils agend\xE9s commenc\xE9e \xE0 l\x27aide de `yFirstWakeUpSchedule()`.

',ret:'un pointeur sur un objet `YWakeUpSchedule` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['WakeUpSchedule']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'wakeupschedule.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['WakeUpSchedule']['set_hours']={syn:'Modifie les heures o\xF9 un r\xE9veil doit avoir lieu ',lib:'wakeupschedule.set_hours()',pro:'function set_hours(newval)',cmt:'

Modifie les heures o\xF9 un r\xE9veil doit avoir lieu

',par:{newval:'un entier'},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.'}; doc['WakeUpSchedule']['set_logicalName']={syn:'Modifie le nom logique du r\xE9veil agend\xE9.',lib:'wakeupschedule.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.'}; doc['WakeUpSchedule']['set_minutes']={syn:'Modifie toutes les minutes o\xF9 un r\xE9veil doit avoir lieu ',lib:'wakeupschedule.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.'}; doc['WakeUpSchedule']['set_minutesA']={syn:'Modifie les minutes de l\x27interval 00-29 o\xF9 un r\xE9veil doit avoir lieu ',lib:'wakeupschedule.set_minutesA()',pro:'function set_minutesA(newval)',cmt:'

Modifie les minutes de l\x27interval 00-29 o\xF9 un r\xE9veil doit avoir lieu

',par:{newval:'un entier'},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.'}; doc['WakeUpSchedule']['set_minutesB']={syn:'Modifie les minutes de l\x27interval 30-59 o\xF9 un r\xE9veil doit avoir lieu.',lib:'wakeupschedule.set_minutesB()',pro:'function set_minutesB(newval)',cmt:'

Modifie les minutes de l\x27interval 30-59 o\xF9 un r\xE9veil doit avoir lieu.

',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.'}; doc['WakeUpSchedule']['set_monthDays']={syn:'Modifie les jours du mois o\xF9 un r\xE9veil doit avoir lieu ',lib:'wakeupschedule.set_monthDays()',pro:'function set_monthDays(newval)',cmt:'

Modifie les jours du mois o\xF9 un r\xE9veil doit avoir lieu

',par:{newval:'un entier'},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.'}; doc['WakeUpSchedule']['set_months']={syn:'Modifie les mois o\xF9 un r\xE9veil doit avoir lieu ',lib:'wakeupschedule.set_months()',pro:'function set_months(newval)',cmt:'

Modifie les mois o\xF9 un r\xE9veil doit avoir lieu

',par:{newval:'un entier'},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.'}; doc['WakeUpSchedule']['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:'wakeupschedule.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['WakeUpSchedule']['set_weekDays']={syn:'Modifie les jours de la semaine o\xF9 un r\xE9veil doit avoir lieu ',lib:'wakeupschedule.set_weekDays()',pro:'function set_weekDays(newval)',cmt:'

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

',par:{newval:'un entier'},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.'}; doc['WakeUpSchedule']['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:'wakeupschedule.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 machine virtuelle 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: WakeUpSchedule) //--- (generated code: GenericSensor) doc['GenericSensor']={'':{syn:'Interface de la fonction GenericSensor',inc:'<script type='text/javascript' src='yocto_genericsensor.js'></script>',cmt:'

La classe YGenericSensor permet de lire et de configurer les transducteurs de signaux Yoctopuce. Elle h\xE9rite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es. De plus, elle permet de configurer une conversion automatique entre le signal mesur\xE9 et la grandeur physique repr\xE9sent\xE9e.

'}}; doc['GenericSensor']['FindGenericSensor']={syn:'Permet de retrouver un capteur g\xE9n\xE9rique d\x27apr\xE8s un identifiant donn\xE9.',lib:'YGenericSensor.FindGenericSensor()',pro:'function FindGenericSensor(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le capteur g\xE9n\xE9rique soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YGenericSensor.isOnline()` pour tester si le capteur g\xE9n\xE9rique 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 le capteur g\xE9n\xE9rique sans ambigu\xEFt\xE9'},ret:'un objet de classe `YGenericSensor` qui permet ensuite de contr\xF4ler le capteur g\xE9n\xE9rique.'}; doc['GenericSensor']['FirstGenericSensor']={syn:'Commence l\x27\xE9num\xE9ration des capteurs g\xE9n\xE9riques accessibles par la librairie.',lib:'YGenericSensor.FirstGenericSensor()',pro:'function FirstGenericSensor()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs g\xE9n\xE9riques accessibles par la librairie. Utiliser la fonction `YGenericSensor.nextGenericSensor()` pour it\xE9rer sur les autres capteurs g\xE9n\xE9riques.

',ret:'un pointeur sur un objet `YGenericSensor`, correspondant au premier capteur g\xE9n\xE9rique accessible en ligne, ou `null` si il n\x27y a pas de capteurs g\xE9n\xE9riques disponibles.'}; doc['GenericSensor']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'genericsensor.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['GenericSensor']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur g\xE9n\xE9rique au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'genericsensor.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur g\xE9n\xE9rique 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 g\xE9n\xE9rique (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['GenericSensor']['get_advertisedValue']={syn:'Retourne la valeur courante du capteur g\xE9n\xE9rique (pas plus de 6 caract\xE8res).',lib:'genericsensor.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur g\xE9n\xE9rique (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['GenericSensor']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration).',lib:'genericsensor.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration).

',ret:'une valeur numérique représentant la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['GenericSensor']['get_currentValue']={syn:'Retourne la valeur mesur\xE9e actuelle.',lib:'genericsensor.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur mesur\xE9e actuelle.

',ret:'une valeur numérique représentant la valeur mesur\xE9e actuelle',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['GenericSensor']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur g\xE9n\xE9rique.',lib:'genericsensor.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur g\xE9n\xE9rique. 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 g\xE9n\xE9rique.'}; doc['GenericSensor']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur g\xE9n\xE9rique.',lib:'genericsensor.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 g\xE9n\xE9rique. 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 g\xE9n\xE9rique.'}; doc['GenericSensor']['get_friendlyName']={syn:'Retourne un identifiant global du capteur g\xE9n\xE9rique au format `NOM_MODULE.NOM_FONCTION`.',lib:'genericsensor.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur g\xE9n\xE9rique en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['GenericSensor']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'genericsensor.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['GenericSensor']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du capteur g\xE9n\xE9rique, sans r\xE9f\xE9rence au module.',lib:'genericsensor.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du capteur g\xE9n\xE9rique, sans r\xE9f\xE9rence au module. Par example `relay1`.

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur g\xE9n\xE9rique (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['GenericSensor']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du capteur g\xE9n\xE9rique au format `SERIAL.FUNCTIONID`.',lib:'genericsensor.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du capteur g\xE9n\xE9rique 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 g\xE9n\xE9rique (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur g\xE9n\xE9rique (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['GenericSensor']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la measure depuis le d\xE9marrage du module.',lib:'genericsensor.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la measure depuis le d\xE9marrage du module.

',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 `Y_HIGHESTVALUE_INVALID`.'}; doc['GenericSensor']['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:'genericsensor.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['GenericSensor']['get_logicalName']={syn:'Retourne le nom logique du capteur g\xE9n\xE9rique.',lib:'genericsensor.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur g\xE9n\xE9rique.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur g\xE9n\xE9rique.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['GenericSensor']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la measure depuis le d\xE9marrage du module.',lib:'genericsensor.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la measure depuis le d\xE9marrage du module.

',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 `Y_LOWESTVALUE_INVALID`.'}; doc['GenericSensor']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'genericsensor.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['GenericSensor']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'genericsensor.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['GenericSensor']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'genericsensor.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['GenericSensor']['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:'genericsensor.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['GenericSensor']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'genericsensor.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['GenericSensor']['get_signalBias']={syn:'Retourne le biais du signal \xE9lectrique pour la correction du point z\xE9ro.',lib:'genericsensor.get_signalBias()',pro:'function get_signalBias()',cmt:'

Retourne le biais du signal \xE9lectrique pour la correction du point z\xE9ro. Un biais positif correspond \xE0 la correction d\x27un signal trop positif, tandis qu\x27un biais n\xE9gatif correspond \xE0 la correction d\x27un signal trop n\xE9gatif.

',ret:'une valeur numérique représentant le biais du signal \xE9lectrique pour la correction du point z\xE9ro',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SIGNALBIAS_INVALID`.'}; doc['GenericSensor']['get_signalRange']={syn:'Retourne la plage de signal \xE9lectrique utilis\xE9e par le capteur.',lib:'genericsensor.get_signalRange()',pro:'function get_signalRange()',cmt:'

Retourne la plage de signal \xE9lectrique utilis\xE9e par le capteur.

',ret:'une chaîne de caractères représentant la plage de signal \xE9lectrique utilis\xE9e par le capteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SIGNALRANGE_INVALID`.'}; doc['GenericSensor']['get_signalSampling']={syn:'Retourne la m\xE9thode d\x27\xE9chantillonnage du signal utilis\xE9e.',lib:'genericsensor.get_signalSampling()',pro:'function get_signalSampling()',cmt:'

Retourne la m\xE9thode d\x27\xE9chantillonnage du signal utilis\xE9e. La m\xE9thode `HIGH_RATE` effectue les mesures le plus rapidement possible, sans aucun filtrage. La m\xE9thode `HIGH_RATE_FILTERED` rajoute un filtre m\xE9dian sur une fen\xEAtre de 7 \xE9chantillons. La m\xE9thode `LOW_NOISE` utilise une fr\xE9quence d\x27aquisition r\xE9duite pour r\xE9duire le bruit. La m\xE9thode `LOW_NOISE_FILTERED` combine la fr\xE9quence r\xE9duite avec un filtre m\xE9dian, pour obtenir des mesures aussi stables que possible m\xEAme sur un signal bruit\xE9.

',ret:'une valeur parmi `Y_SIGNALSAMPLING_HIGH_RATE`, `Y_SIGNALSAMPLING_HIGH_RATE_FILTERED`, `Y_SIGNALSAMPLING_LOW_NOISE` et `Y_SIGNALSAMPLING_LOW_NOISE_FILTERED` représentant la m\xE9thode d\x27\xE9chantillonnage du signal utilis\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SIGNALSAMPLING_INVALID`.'}; doc['GenericSensor']['get_signalUnit']={syn:'Retourne l\x27unit\xE9 du signal \xE9lectrique utilis\xE9e par le capteur.',lib:'genericsensor.get_signalUnit()',pro:'function get_signalUnit()',cmt:'

Retourne l\x27unit\xE9 du signal \xE9lectrique utilis\xE9e par le capteur.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 du signal \xE9lectrique utilis\xE9e par le capteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SIGNALUNIT_INVALID`.'}; doc['GenericSensor']['get_signalValue']={syn:'Retourne la valeur mesur\xE9e du signal \xE9lectrique utilis\xE9e par le capteur.',lib:'genericsensor.get_signalValue()',pro:'function get_signalValue()',cmt:'

Retourne la valeur mesur\xE9e du signal \xE9lectrique utilis\xE9e par le capteur.

',ret:'une valeur numérique représentant la valeur mesur\xE9e du signal \xE9lectrique utilis\xE9e par le capteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SIGNALVALUE_INVALID`.'}; doc['GenericSensor']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la measure est exprim\xE9e.',lib:'genericsensor.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 `Y_UNIT_INVALID`.'}; doc['GenericSensor']['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:'genericsensor.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['GenericSensor']['get_valueRange']={syn:'Retourne la plage de valeurs physiques mesur\xE9s par le capteur.',lib:'genericsensor.get_valueRange()',pro:'function get_valueRange()',cmt:'

Retourne la plage de valeurs physiques mesur\xE9s par le capteur.

',ret:'une chaîne de caractères représentant la plage de valeurs physiques mesur\xE9s par le capteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_VALUERANGE_INVALID`.'}; doc['GenericSensor']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur g\xE9n\xE9rique est joignable, sans d\xE9clencher d\x27erreur.',lib:'genericsensor.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur g\xE9n\xE9rique est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur g\xE9n\xE9rique 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 g\xE9n\xE9rique est joignable, `false` sinon'}; doc['GenericSensor']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur g\xE9n\xE9rique est joignable, sans d\xE9clencher d\x27erreur.',lib:'genericsensor.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur g\xE9n\xE9rique est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur g\xE9n\xE9rique 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.'}; doc['GenericSensor']['load']={syn:'Met en cache les valeurs courantes du capteur g\xE9n\xE9rique, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'genericsensor.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur g\xE9n\xE9rique, 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.'}; doc['GenericSensor']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'genericsensor.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['GenericSensor']['load_async']={syn:'Met en cache les valeurs courantes du capteur g\xE9n\xE9rique, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'genericsensor.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur g\xE9n\xE9rique, 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.'}; doc['GenericSensor']['nextGenericSensor']={syn:'Continue l\x27\xE9num\xE9ration des capteurs g\xE9n\xE9riques commenc\xE9e \xE0 l\x27aide de `yFirstGenericSensor()`.',lib:'genericsensor.nextGenericSensor()',pro:'function nextGenericSensor()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs g\xE9n\xE9riques commenc\xE9e \xE0 l\x27aide de `yFirstGenericSensor()`.

',ret:'un pointeur sur un objet `YGenericSensor` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['GenericSensor']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'genericsensor.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['GenericSensor']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'genericsensor.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['GenericSensor']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'genericsensor.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['GenericSensor']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'genericsensor.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['GenericSensor']['set_logicalName']={syn:'Modifie le nom logique du capteur g\xE9n\xE9rique.',lib:'genericsensor.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur g\xE9n\xE9rique. 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 g\xE9n\xE9rique.'},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.'}; doc['GenericSensor']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'genericsensor.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['GenericSensor']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'genericsensor.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['GenericSensor']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'genericsensor.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['GenericSensor']['set_signalBias']={syn:'Modifie le biais du signal \xE9lectrique pour la correction du point z\xE9ro.',lib:'genericsensor.set_signalBias()',pro:'function set_signalBias(newval)',cmt:'

Modifie le biais du signal \xE9lectrique pour la correction du point z\xE9ro. Si votre signal \xE9lectrique est positif lorsqu\x27il devrait \xEAtre nul, configurez un biais positif de la m\xEAme valeur afin de corriger l\x27erreur.

',par:{newval:'une valeur numérique représentant le biais du signal \xE9lectrique pour la correction du point 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.'}; doc['GenericSensor']['set_signalRange']={syn:'Modifie la plage de signal \xE9lectrique utilis\xE9e par le capteur.',lib:'genericsensor.set_signalRange()',pro:'function set_signalRange(newval)',cmt:'

Modifie la plage de signal \xE9lectrique utilis\xE9e par le capteur.

',par:{newval:'une chaîne de caractères représentant la plage de signal \xE9lectrique utilis\xE9e par le capteur'},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.'}; doc['GenericSensor']['set_signalSampling']={syn:'Modifie la m\xE9thode d\x27\xE9chantillonnage du signal \xE0 utiliser.',lib:'genericsensor.set_signalSampling()',pro:'function set_signalSampling(newval)',cmt:'

Modifie la m\xE9thode d\x27\xE9chantillonnage du signal \xE0 utiliser. La m\xE9thode `HIGH_RATE` effectue les mesures le plus rapidement possible, sans aucun filtrage. La m\xE9thode `HIGH_RATE_FILTERED` rajoute un filtre m\xE9dian sur une fen\xEAtre de 7 \xE9chantillons. La m\xE9thode `LOW_NOISE` utilise une fr\xE9quence d\x27aquisition r\xE9duite pour r\xE9duire le bruit. La m\xE9thode `LOW_NOISE_FILTERED` combine la fr\xE9quence r\xE9duite avec un filtre m\xE9dian, pour obtenir des mesures aussi stables que possible m\xEAme sur un signal bruit\xE9.

',par:{newval:'une valeur parmi `Y_SIGNALSAMPLING_HIGH_RATE`, `Y_SIGNALSAMPLING_HIGH_RATE_FILTERED`, `Y_SIGNALSAMPLING_LOW_NOISE` et `Y_SIGNALSAMPLING_LOW_NOISE_FILTERED` représentant la m\xE9thode d\x27\xE9chantillonnage du signal \xE0 utiliser'},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.'}; doc['GenericSensor']['set_unit']={syn:'Change l\x27unit\xE9 dans laquelle la valeur mesur\xE9e est exprim\xE9e.',lib:'genericsensor.set_unit()',pro:'function set_unit(newval)',cmt:'

Change l\x27unit\xE9 dans laquelle la valeur mesur\xE9e est exprim\xE9e. 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'},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.'}; doc['GenericSensor']['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:'genericsensor.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['GenericSensor']['set_valueRange']={syn:'Modifie la plage de valeurs physiques mesur\xE9s par le capteur.',lib:'genericsensor.set_valueRange()',pro:'function set_valueRange(newval)',cmt:'

Modifie la plage de valeurs physiques mesur\xE9s par le capteur. Le changement de plage peut avoir pour effet de bord un changement automatique de la r\xE9solution affich\xE9e.

',par:{newval:'une chaîne de caractères représentant la plage de valeurs physiques mesur\xE9s par le capteur'},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.'}; doc['GenericSensor']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'genericsensor.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['GenericSensor']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'genericsensor.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['GenericSensor']['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:'genericsensor.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 machine virtuelle 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.'}; doc['GenericSensor']['zeroAdjust']={syn:'Ajuste le biais du signal de sorte \xE0 ce que la valeur actuelle du signal soit interpr\xE9t\xE9e comme z\xE9ro (tare).',lib:'genericsensor.zeroAdjust()',pro:'function zeroAdjust()',cmt:'

Ajuste le biais du signal de sorte \xE0 ce que la valeur actuelle du signal soit interpr\xE9t\xE9e comme z\xE9ro (tare).

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; //--- (end of generated code: GenericSensor) //--- (generated code: DigitalIO) doc['DigitalIO']={'':{syn:'Interface de la fonction DigitalIO',inc:'<script type='text/javascript' src='yocto_digitalio.js'></script>',cmt:'

La librairie de programmation Yoctopuce permet simplement de changer l\x27\xE9tat de chaque bit du port d\x27entr\xE9e sortie. Il est possible de changer tous les bits du port \xE0 la fois, ou de les changer ind\xE9pendament. La librairie permet aussi de cr\xE9er des courtes impulsions de dur\xE9e d\xE9termin\xE9e. Le comportement \xE9lectrique de chanque entr\xE9e/sortie peut \xEAtre modifi\xE9 (open drain et polarit\xE9 inverse).

'}}; doc['DigitalIO']['FindDigitalIO']={syn:'Permet de retrouver un port d\x27E/S digital d\x27apr\xE8s un identifiant donn\xE9.',lib:'YDigitalIO.FindDigitalIO()',pro:'function FindDigitalIO(func)',cmt:'

Permet de retrouver un port d\x27E/S digital d\x27apr\xE8s un identifiant donn\xE9. L\x27identifiant peut \xEAtre sp\xE9cifi\xE9 sous plusieurs formes:

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le port d\x27E/S digital soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YDigitalIO.isOnline()` pour tester si le port d\x27E/S digital 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 le port d\x27E/S digital sans ambigu\xEFt\xE9'},ret:'un objet de classe `YDigitalIO` qui permet ensuite de contr\xF4ler le port d\x27E/S digital.'}; doc['DigitalIO']['FirstDigitalIO']={syn:'Commence l\x27\xE9num\xE9ration des ports d\x27E/S digitaux accessibles par la librairie.',lib:'YDigitalIO.FirstDigitalIO()',pro:'function FirstDigitalIO()',cmt:'

Commence l\x27\xE9num\xE9ration des ports d\x27E/S digitaux accessibles par la librairie. Utiliser la fonction `YDigitalIO.nextDigitalIO()` pour it\xE9rer sur les autres ports d\x27E/S digitaux.

',ret:'un pointeur sur un objet `YDigitalIO`, correspondant au premier port d\x27E/S digital accessible en ligne, ou `null` si il n\x27y a pas de ports d\x27E/S digitaux disponibles.'}; doc['DigitalIO']['delayedPulse']={syn:'Pr\xE9programme une impulsion de dur\xE9e sp\xE9cifi\xE9e sur un bit choisi.',lib:'digitalio.delayedPulse()',pro:'function delayedPulse(bitno, ms_delay, ms_duration)',cmt:'

Pr\xE9programme une impulsion de dur\xE9e sp\xE9cifi\xE9e sur un bit choisi. Le bit va passer \xE0 1 puis automatiquement revenir \xE0 0 apr\xE8s le temps donn\xE9.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0',ms_delay:'d\xE9lai d\x27attente avant l\x27impulsion, en millisecondes',ms_duration:'dur\xE9e de l\x27impulsion d\xE9sir\xE9e, en millisecondes. Notez que la r\xE9solution temporelle du module n\x27est pas garantie \xE0 la milliseconde.'},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['DigitalIO']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du port d\x27E/S digital au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'digitalio.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du port d\x27E/S digital 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 port d\x27E/S digital (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['DigitalIO']['get_advertisedValue']={syn:'Retourne la valeur courante du port d\x27E/S digital (pas plus de 6 caract\xE8res).',lib:'digitalio.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du port d\x27E/S digital (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du port d\x27E/S digital (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['DigitalIO']['get_bitDirection']={syn:'Retourne la direction d\x27un seul bit du port d\x27E/S.',lib:'digitalio.get_bitDirection()',pro:'function get_bitDirection(bitno)',cmt:'

Retourne la direction d\x27un seul bit du port d\x27E/S. (0 signifie que le bit est une entr\xE9e, 1 une sortie)

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0'},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['DigitalIO']['get_bitOpenDrain']={syn:'Retourne la direction d\x27un seul bit du port d\x27E/S.',lib:'digitalio.get_bitOpenDrain()',pro:'function get_bitOpenDrain(bitno)',cmt:'

Retourne la direction d\x27un seul bit du port d\x27E/S.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0'},ret:'0 repr\xE9sente une entr\xE9e ou une sortie digitale standard, 1 repr\xE9sente une entr\xE9e ou sortie en mode collecteur ouvert (drain ouvert)..',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['DigitalIO']['get_bitPolarity']={syn:'Retourne la polarit\xE9 d\x27un seul bit du port d\x27E/S.',lib:'digitalio.get_bitPolarity()',pro:'function get_bitPolarity(bitno)',cmt:'

Retourne la polarit\xE9 d\x27un seul bit du port d\x27E/S. 0 signifie que l\x27entr\xE9e sortie est en mode normal, 1 qu\x27elle est en mode inverse

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0'},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['DigitalIO']['get_bitState']={syn:'Retourne l\x27\xE9tat d\x27un seul bit du port d\x27E/S.',lib:'digitalio.get_bitState()',pro:'function get_bitState(bitno)',cmt:'

Retourne l\x27\xE9tat d\x27un seul bit du port d\x27E/S.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0'},ret:'l\x27\xE9tat du bit (0 ou 1).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['DigitalIO']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port d\x27E/S digital.',lib:'digitalio.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port d\x27E/S digital. 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 port d\x27E/S digital.'}; doc['DigitalIO']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port d\x27E/S digital.',lib:'digitalio.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port d\x27E/S digital. 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 port d\x27E/S digital.'}; doc['DigitalIO']['get_friendlyName']={syn:'Retourne un identifiant global du port d\x27E/S digital au format `NOM_MODULE.NOM_FONCTION`.',lib:'digitalio.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le port d\x27E/S digital en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['DigitalIO']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'digitalio.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['DigitalIO']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du port d\x27E/S digital, sans r\xE9f\xE9rence au module.',lib:'digitalio.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du port d\x27E/S digital, sans r\xE9f\xE9rence au module. Par example `relay1`.

',ret:'une cha\xEEne de caract\xE8res identifiant le port d\x27E/S digital (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['DigitalIO']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du port d\x27E/S digital au format `SERIAL.FUNCTIONID`.',lib:'digitalio.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du port d\x27E/S digital 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 port d\x27E/S digital (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le port d\x27E/S digital (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['DigitalIO']['get_logicalName']={syn:'Retourne le nom logique du port d\x27E/S digital.',lib:'digitalio.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du port d\x27E/S digital.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du port d\x27E/S digital.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['DigitalIO']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'digitalio.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['DigitalIO']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'digitalio.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['DigitalIO']['get_outputVoltage']={syn:'Retourne la source de tension utilis\xE9e pour piloter les bits en sortie.',lib:'digitalio.get_outputVoltage()',pro:'function get_outputVoltage()',cmt:'

Retourne la source de tension utilis\xE9e pour piloter les bits en sortie.

',ret:'une valeur parmi `Y_OUTPUTVOLTAGE_USB_5V`, `Y_OUTPUTVOLTAGE_USB_3V` et `Y_OUTPUTVOLTAGE_EXT_V` représentant la source de tension utilis\xE9e pour piloter les bits en sortie',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_OUTPUTVOLTAGE_INVALID`.'}; doc['DigitalIO']['get_portDirection']={syn:'Retourne la direction des bits du port (bitmap): 0 repr\xE9sente un bit en entr\xE9e, 1 repr\xE9sente un bit en sortie.',lib:'digitalio.get_portDirection()',pro:'function get_portDirection()',cmt:'

Retourne la direction des bits du port (bitmap): 0 repr\xE9sente un bit en entr\xE9e, 1 repr\xE9sente un bit en sortie.

',ret:'un entier représentant la direction des bits du port (bitmap): 0 repr\xE9sente un bit en entr\xE9e, 1 repr\xE9sente un bit en sortie',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PORTDIRECTION_INVALID`.'}; doc['DigitalIO']['get_portOpenDrain']={syn:'Retourne le type d\x27interface \xE9lectrique de chaque bit du port (bitmap).',lib:'digitalio.get_portOpenDrain()',pro:'function get_portOpenDrain()',cmt:'

Retourne le type d\x27interface \xE9lectrique de chaque bit du port (bitmap). 0 repr\xE9sente une entr\xE9e ou une sortie digitale standard, 1 repr\xE9sente une entr\xE9e ou sortie en mode collecteur ouvert (drain ouvert).

',ret:'un entier représentant le type d\x27interface \xE9lectrique de chaque bit du port (bitmap)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PORTOPENDRAIN_INVALID`.'}; doc['DigitalIO']['get_portPolarity']={syn:'Retourne la polarit\xE9 des bits du port (bitmap).',lib:'digitalio.get_portPolarity()',pro:'function get_portPolarity()',cmt:'

Retourne la polarit\xE9 des bits du port (bitmap). Pour chaque bit \xE0 0 l\x27entr\xE9e sortie correspondante fonctionne mani\xE8re normale, pour chaque bit \xE0 1 elle fonctionne ne mani\xE8re invers\xE9e.

',ret:'un entier représentant la polarit\xE9 des bits du port (bitmap)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PORTPOLARITY_INVALID`.'}; doc['DigitalIO']['get_portSize']={syn:'Retourne le nombre de bits impl\xE9ment\xE9s dans le port d\x27E/S.',lib:'digitalio.get_portSize()',pro:'function get_portSize()',cmt:'

Retourne le nombre de bits impl\xE9ment\xE9s dans le port d\x27E/S.

',ret:'un entier représentant le nombre de bits impl\xE9ment\xE9s dans le port d\x27E/S',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PORTSIZE_INVALID`.'}; doc['DigitalIO']['get_portState']={syn:'Retourne l\x27\xE9tat du port d\x27E/S digital: le bit 0 repr\xE9sente l\x27input 0 et ainsi de suite.',lib:'digitalio.get_portState()',pro:'function get_portState()',cmt:'

Retourne l\x27\xE9tat du port d\x27E/S digital: le bit 0 repr\xE9sente l\x27input 0 et ainsi de suite.

',ret:'un entier représentant l\x27\xE9tat du port d\x27E/S digital: le bit 0 repr\xE9sente l\x27input 0 et ainsi de suite',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PORTSTATE_INVALID`.'}; doc['DigitalIO']['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:'digitalio.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['DigitalIO']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le port d\x27E/S digital est joignable, sans d\xE9clencher d\x27erreur.',lib:'digitalio.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le port d\x27E/S digital est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du port d\x27E/S digital 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 port d\x27E/S digital est joignable, `false` sinon'}; doc['DigitalIO']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le port d\x27E/S digital est joignable, sans d\xE9clencher d\x27erreur.',lib:'digitalio.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le port d\x27E/S digital est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du port d\x27E/S digital 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.'}; doc['DigitalIO']['load']={syn:'Met en cache les valeurs courantes du port d\x27E/S digital, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'digitalio.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du port d\x27E/S digital, 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.'}; doc['DigitalIO']['load_async']={syn:'Met en cache les valeurs courantes du port d\x27E/S digital, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'digitalio.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du port d\x27E/S digital, 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.'}; doc['DigitalIO']['nextDigitalIO']={syn:'Continue l\x27\xE9num\xE9ration des ports d\x27E/S digitaux commenc\xE9e \xE0 l\x27aide de `yFirstDigitalIO()`.',lib:'digitalio.nextDigitalIO()',pro:'function nextDigitalIO()',cmt:'

Continue l\x27\xE9num\xE9ration des ports d\x27E/S digitaux commenc\xE9e \xE0 l\x27aide de `yFirstDigitalIO()`.

',ret:'un pointeur sur un objet `YDigitalIO` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['DigitalIO']['pulse']={syn:'D\xE9clenche une impulsion de dur\xE9e sp\xE9cifi\xE9e sur un bit choisi.',lib:'digitalio.pulse()',pro:'function pulse(bitno, ms_duration)',cmt:'

D\xE9clenche une impulsion de dur\xE9e sp\xE9cifi\xE9e sur un bit choisi. Le bit va passer \xE0 1 puis automatiquement revenir \xE0 0 apr\xE8s le temps donn\xE9.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0',ms_duration:'dur\xE9e de l\x27impulsion d\xE9sir\xE9e, en millisecondes. Notez que la r\xE9solution temporelle du module n\x27est pas garantie \xE0 la milliseconde.'},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['DigitalIO']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'digitalio.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['DigitalIO']['set_bitDirection']={syn:'Change la direction d\x27un seul bit du port d\x27E/S.',lib:'digitalio.set_bitDirection()',pro:'function set_bitDirection(bitno, bitdirection)',cmt:'

Change la direction d\x27un seul bit du port d\x27E/S.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0',bitdirection:'nouvelle valeur de la direction, 0=entr\xE9e, 1=sortie. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9 apr\xE8s un red\xE9marrage du module.'},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['DigitalIO']['set_bitOpenDrain']={syn:'Change le type d\x27interface \xE9lectrique d\x27un seul bit du port d\x27E/S.',lib:'digitalio.set_bitOpenDrain()',pro:'function set_bitOpenDrain(bitno, opendrain)',cmt:'

Change le type d\x27interface \xE9lectrique d\x27un seul bit du port d\x27E/S.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0',opendrain:'0 pour faire une entr\xE9e ou une sortie digitale standard, 1 pour une entr\xE9e ou sortie en mode collecteur ouvert (drain ouvert). N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9 apr\xE8s un red\xE9marrage du module.'},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['DigitalIO']['set_bitPolarity']={syn:'Change la polarit\xE9 d\x27un seul bit du port d\x27E/S.',lib:'digitalio.set_bitPolarity()',pro:'function set_bitPolarity(bitno, bitpolarity)',cmt:'

Change la polarit\xE9 d\x27un seul bit du port d\x27E/S.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0',bitpolarity:'nouvelle valeur de la plarit\xE9. 0=mode normal, 1=mode inverse. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9 apr\xE8s un red\xE9marrage du module.'},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['DigitalIO']['set_bitState']={syn:'Change l\x27\xE9tat d\x27un seul bit du port d\x27E/S.',lib:'digitalio.set_bitState()',pro:'function set_bitState(bitno, bitstate)',cmt:'

Change l\x27\xE9tat d\x27un seul bit du port d\x27E/S.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0',bitstate:'nouvel \xE9tat du bit (1 ou 0)'},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['DigitalIO']['set_logicalName']={syn:'Modifie le nom logique du port d\x27E/S digital.',lib:'digitalio.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du port d\x27E/S digital. 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 port d\x27E/S digital.'},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.'}; doc['DigitalIO']['set_outputVoltage']={syn:'Modifie la source de tension utilis\xE9e pour piloter les bits en sortie.',lib:'digitalio.set_outputVoltage()',pro:'function set_outputVoltage(newval)',cmt:'

Modifie la source de tension utilis\xE9e pour piloter les bits en sortie. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9 apr\xE8s un red\xE9marrage du module.

',par:{newval:'une valeur parmi `Y_OUTPUTVOLTAGE_USB_5V`, `Y_OUTPUTVOLTAGE_USB_3V` et `Y_OUTPUTVOLTAGE_EXT_V` représentant la source de tension utilis\xE9e pour piloter les bits en sortie'},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.'}; doc['DigitalIO']['set_portDirection']={syn:'Modifie la direction des bits du port (bitmap): 0 repr\xE9sente un bit en entr\xE9e, 1 repr\xE9sente un bit en sortie.',lib:'digitalio.set_portDirection()',pro:'function set_portDirection(newval)',cmt:'

Modifie la direction des bits du port (bitmap): 0 repr\xE9sente un bit en entr\xE9e, 1 repr\xE9sente un bit en sortie. 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 direction des bits du port (bitmap): 0 repr\xE9sente un bit en entr\xE9e, 1 repr\xE9sente un bit en sortie'},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.'}; doc['DigitalIO']['set_portOpenDrain']={syn:'Modifie le type d\x27interface \xE9lectrique de chaque bit du port (bitmap).',lib:'digitalio.set_portOpenDrain()',pro:'function set_portOpenDrain(newval)',cmt:'

Modifie le type d\x27interface \xE9lectrique de chaque bit du port (bitmap). 0 repr\xE9sente une entr\xE9e ou une sortie digitale standard, 1 repr\xE9sente une entr\xE9e ou sortie en mode collecteur ouvert (drain ouvert). 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 type d\x27interface \xE9lectrique de chaque bit du port (bitmap)'},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.'}; doc['DigitalIO']['set_portPolarity']={syn:'Modifie la polarit\xE9e des bits du port (bitmap): Pour chaque bit \xE0 0 l\x27entr\xE9e sortie correspondante fonctionne mani\xE8re normale, pour chaque bit \xE0 1 elle fonctionne ne mani\xE8re invers\xE9e.',lib:'digitalio.set_portPolarity()',pro:'function set_portPolarity(newval)',cmt:'

Modifie la polarit\xE9e des bits du port (bitmap): Pour chaque bit \xE0 0 l\x27entr\xE9e sortie correspondante fonctionne mani\xE8re normale, pour chaque bit \xE0 1 elle fonctionne ne mani\xE8re invers\xE9e.

',par:{newval:'un entier représentant la polarit\xE9e des bits du port (bitmap): Pour chaque bit \xE0 0 l\x27entr\xE9e sortie correspondante fonctionne mani\xE8re normale, pour chaque bit \xE0 1 elle fonctionne ne mani\xE8re invers\xE9e'},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.'}; doc['DigitalIO']['set_portState']={syn:'Modifie l\x27\xE9tat du port d\x27E/S digital: le bit 0 repr\xE9sente l\x27input 0 et ainsi de suite.',lib:'digitalio.set_portState()',pro:'function set_portState(newval)',cmt:'

Modifie l\x27\xE9tat du port d\x27E/S digital: le bit 0 repr\xE9sente l\x27input 0 et ainsi de suite. Seuls les bits configur\xE9s en sortie dans `portDirection` sont affect\xE9s.

',par:{newval:'un entier représentant l\x27\xE9tat du port d\x27E/S digital: le bit 0 repr\xE9sente l\x27input 0 et ainsi de suite'},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.'}; doc['DigitalIO']['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:'digitalio.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['DigitalIO']['toggle_bitState']={syn:'Inverse l\x27\xE9tat d\x27un seul bit du port d\x27E/S.',lib:'digitalio.toggle_bitState()',pro:'function toggle_bitState(bitno)',cmt:'

Inverse l\x27\xE9tat d\x27un seul bit du port d\x27E/S.

',par:{bitno:'index du bit dans le port; le bit de poid faible est \xE0 l\x27index 0'},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['DigitalIO']['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:'digitalio.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 machine virtuelle 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: DigitalIO) //--- (generated code: OsControl) doc['OsControl']={'':{syn:'contr\xF4le d\x27OS',inc:'<script type='text/javascript' src='yocto_oscontrol.js'></script>',cmt:'

L\x27objet OsControl permet de controler le syst\xE8m d\x27exploitation sur lequel tourne un VirtualHub. OsControl n\x27est disponible que dans le VirtualHub software. Attention, cette fonctionnalit\xE9 doit \xEAtre explicitement activ\xE9 au lancement du VirtualHub, avec l\x27option -o.

'}}; doc['OsControl']['FindOsControl']={syn:'Permet de retrouver un contr\xF4le d\x27OS d\x27apr\xE8s un identifiant donn\xE9.',lib:'YOsControl.FindOsControl()',pro:'function FindOsControl(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le contr\xF4le d\x27OS soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YOsControl.isOnline()` pour tester si le contr\xF4le d\x27OS 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 le contr\xF4le d\x27OS sans ambigu\xEFt\xE9'},ret:'un objet de classe `YOsControl` qui permet ensuite de contr\xF4ler le contr\xF4le d\x27OS.'}; doc['OsControl']['FirstOsControl']={syn:'Commence l\x27\xE9num\xE9ration des contr\xF4le d\x27OS accessibles par la librairie.',lib:'YOsControl.FirstOsControl()',pro:'function FirstOsControl()',cmt:'

Commence l\x27\xE9num\xE9ration des contr\xF4le d\x27OS accessibles par la librairie. Utiliser la fonction `YOsControl.nextOsControl()` pour it\xE9rer sur les autres contr\xF4le d\x27OS.

',ret:'un pointeur sur un objet `YOsControl`, correspondant au premier contr\xF4le d\x27OS accessible en ligne, ou `null` si il n\x27y a pas de contr\xF4le d\x27OS disponibles.'}; doc['OsControl']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du contr\xF4le d\x27OS au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'oscontrol.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du contr\xF4le d\x27OS 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 contr\xF4le d\x27OS (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['OsControl']['get_advertisedValue']={syn:'Retourne la valeur courante du contr\xF4le d\x27OS (pas plus de 6 caract\xE8res).',lib:'oscontrol.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du contr\xF4le d\x27OS (pas plus de 6 caract\xE8res).

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

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du contr\xF4le d\x27OS. 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 contr\xF4le d\x27OS.'}; doc['OsControl']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du contr\xF4le d\x27OS.',lib:'oscontrol.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du contr\xF4le d\x27OS. 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 contr\xF4le d\x27OS.'}; doc['OsControl']['get_friendlyName']={syn:'Retourne un identifiant global du contr\xF4le d\x27OS au format `NOM_MODULE.NOM_FONCTION`.',lib:'oscontrol.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le contr\xF4le d\x27OS en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['OsControl']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'oscontrol.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['OsControl']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du contr\xF4le d\x27OS, sans r\xE9f\xE9rence au module.',lib:'oscontrol.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du contr\xF4le d\x27OS, sans r\xE9f\xE9rence au module. Par example `relay1`.

',ret:'une cha\xEEne de caract\xE8res identifiant le contr\xF4le d\x27OS (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['OsControl']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du contr\xF4le d\x27OS au format `SERIAL.FUNCTIONID`.',lib:'oscontrol.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du contr\xF4le d\x27OS 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 contr\xF4le d\x27OS (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le contr\xF4le d\x27OS (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['OsControl']['get_logicalName']={syn:'Retourne le nom logique du contr\xF4le d\x27OS.',lib:'oscontrol.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du contr\xF4le d\x27OS.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du contr\xF4le d\x27OS.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['OsControl']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'oscontrol.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['OsControl']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'oscontrol.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['OsControl']['get_shutdownCountdown']={syn:'Retourne le nombre de secondes restantes avant un arr\xEAt de l\x27OS, ou z\xE9ro si aucun arr\xEAt n\x27a \xE9t\xE9 agend\xE9.',lib:'oscontrol.get_shutdownCountdown()',pro:'function get_shutdownCountdown()',cmt:'

Retourne le nombre de secondes restantes avant un arr\xEAt de l\x27OS, ou z\xE9ro si aucun arr\xEAt n\x27a \xE9t\xE9 agend\xE9.

',ret:'un entier représentant le nombre de secondes restantes avant un arr\xEAt de l\x27OS, ou z\xE9ro si aucun arr\xEAt n\x27a \xE9t\xE9 agend\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SHUTDOWNCOUNTDOWN_INVALID`.'}; doc['OsControl']['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:'oscontrol.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['OsControl']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le contr\xF4le d\x27OS est joignable, sans d\xE9clencher d\x27erreur.',lib:'oscontrol.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le contr\xF4le d\x27OS est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du contr\xF4le d\x27OS 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 contr\xF4le d\x27OS est joignable, `false` sinon'}; doc['OsControl']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le contr\xF4le d\x27OS est joignable, sans d\xE9clencher d\x27erreur.',lib:'oscontrol.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le contr\xF4le d\x27OS est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du contr\xF4le d\x27OS 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.'}; doc['OsControl']['load']={syn:'Met en cache les valeurs courantes du contr\xF4le d\x27OS, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'oscontrol.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du contr\xF4le d\x27OS, 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.'}; doc['OsControl']['load_async']={syn:'Met en cache les valeurs courantes du contr\xF4le d\x27OS, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'oscontrol.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du contr\xF4le d\x27OS, 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.'}; doc['OsControl']['nextOsControl']={syn:'Continue l\x27\xE9num\xE9ration des contr\xF4le d\x27OS commenc\xE9e \xE0 l\x27aide de `yFirstOsControl()`.',lib:'oscontrol.nextOsControl()',pro:'function nextOsControl()',cmt:'

Continue l\x27\xE9num\xE9ration des contr\xF4le d\x27OS commenc\xE9e \xE0 l\x27aide de `yFirstOsControl()`.

',ret:'un pointeur sur un objet `YOsControl` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['OsControl']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'oscontrol.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['OsControl']['set_logicalName']={syn:'Modifie le nom logique du contr\xF4le d\x27OS.',lib:'oscontrol.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du contr\xF4le d\x27OS. 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 contr\xF4le d\x27OS.'},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.'}; doc['OsControl']['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:'oscontrol.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['OsControl']['shutdown']={syn:'Agende un arr\xEAt de l\x27OS dans un nombre donn\xE9 de secondes.',lib:'oscontrol.shutdown()',pro:'function shutdown(secBeforeShutDown)',cmt:'

Agende un arr\xEAt de l\x27OS dans un nombre donn\xE9 de secondes.

',par:{secBeforeShutDown:'nombre de secondes avant l\x27arr\xEAt'},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['OsControl']['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:'oscontrol.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 machine virtuelle 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: OsControl) //--- (generated code: DataSet) doc['DataSet']={'':{syn:'S\xE9quence de donn\xE9es enregistr\xE9es',inc:'<script type='text/javascript' src='yocto_api.js'></script>',cmt:'

Les objets YDataSet permettent de r\xE9cup\xE9rer un ensemble de mesures enregistr\xE9es correspondant \xE0 un capteur donn\xE9, pour une p\xE9riode choisie. Ils permettent le chargement progressif des donn\xE9es. Lorsque l\x27objet YDataSet est instanci\xE9 par la fonction `get_recordedData()`, aucune donn\xE9e n\x27est encore charg\xE9e du module. Ce sont les appels successifs \xE0 la m\xE9thode `loadMore()` qui proc\xE8dent au chargement effectif des donn\xE9es depuis l\x27enregistreur de donn\xE9es.

Un r\xE9sum\xE9 des mesures disponibles est disponible via la fonction `get_preview()` d\xE8s le premier appel \xE0 `loadMore()`. Les mesures elles-m\xEAme sont disponibles via la fonction `get_measures()` au fur et \xE0 mesure de leur chargement.

Cette classe ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets YDataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

'}}; doc['DataSet']['get_endTimeUTC']={syn:'Retourne l\x27heure absolue de la fin des mesures disponibles, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix).',lib:'dataset.get_endTimeUTC()',pro:'function get_endTimeUTC()',cmt:'

Retourne l\x27heure absolue de la fin des mesures disponibles, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix). Lorsque l\x27objet YDataSet est cr\xE9\xE9, l\x27heure de fin est celle qui a \xE9t\xE9 pass\xE9e en param\xE8tre \xE0 la fonction `get_dataSet`. D\xE8s le premier appel \xE0 la m\xE9thode `loadMore()`, l\x27heure de fin est mise \xE0 jour \xE0 la derni\xE8re mesure effectivement disponible dans l\x27enregistreur de donn\xE9es pour la plage sp\xE9cifi\xE9e.

',ret:'un entier positif correspondant au nombre de secondes \xE9coul\xE9es entre le 1er janvier 1970 et la derni\xE8re mesure.'}; doc['DataSet']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de la fonction qui a effectu\xE9 les mesures, sans r\xE9f\xE9rence au module.',lib:'dataset.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de la fonction qui a effectu\xE9 les mesures, sans r\xE9f\xE9rence au module. Par example `temperature1`.

',ret:'une cha\xEEne de caract\xE8res identifiant la fonction (ex: `temperature1`)'}; doc['DataSet']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique de la fonction qui a effectu\xE9 les mesures, au format `SERIAL.FUNCTIONID`.',lib:'dataset.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique de la fonction qui a effectu\xE9 les mesures, 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 `THRMCPL1-123456.temperature1`).

',ret:'une cha\xEEne de caract\xE8res identifiant la fonction (ex: `THRMCPL1-123456.temperature1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['DataSet']['get_measures']={syn:'Retourne toutes les mesures d\xE9j\xE0 disponibles pour le DataSet, sous forme d\x27une liste d\x27objets YMeasure.',lib:'dataset.get_measures()',pro:'function get_measures()',cmt:'

Retourne toutes les mesures d\xE9j\xE0 disponibles pour le DataSet, sous forme d\x27une liste d\x27objets YMeasure. Chaque \xE9l\xE9ment contient: - le moment ou la mesure a d\xE9but\xE9 - le moment ou la mesure s\x27est termin\xE9e - la valeur minimale observ\xE9e dans l\x27intervalle de temps - la valeur moyenne observ\xE9e dans l\x27intervalle de temps - la valeur maximale observ\xE9e dans l\x27intervalle de temps

Avant d\x27appeler cette m\xE9thode, vous devez appeler `loadMore()` pour charger des donn\xE9es depuis l\x27enregistreur sur le module. L\x27appel doit \xEAtre r\xE9p\xE9t\xE9 plusieurs fois pour charger toutes les donn\xE9es, mais vous pouvez commencer \xE0 utiliser les donn\xE9es disponibles avant qu\x27elles n\x27aient \xE9t\xE9 toutes charg\xE9es

Les mesures les plus anciennes sont toujours charg\xE9es les premi\xE8res, et les plus r\xE9centes en dernier. De ce fait, les timestamps dans la table des mesures sont normalement par ordre chronologique. La seule exception est dans le cas o\xF9 il y a eu un ajustement de l\x27horloge UTC de l\x27enregistreur de donn\xE9es pendant l\x27enregistrement.

',ret:'un tableau d\x27enregistrements, chaque enregistrement repr\xE9sentant une mesure effectu\xE9e \xE0 un moment pr\xE9cis.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['DataSet']['get_preview']={syn:'Retourne une version r\xE9sum\xE9e des mesures qui pourront \xEAtre obtenues de ce YDataSet, sous forme d\x27une liste d\x27objets YMeasure.',lib:'dataset.get_preview()',pro:'function get_preview()',cmt:'

Retourne une version r\xE9sum\xE9e des mesures qui pourront \xEAtre obtenues de ce YDataSet, sous forme d\x27une liste d\x27objets YMeasure. Chaque \xE9l\xE9ment contient: - le d\xE9but d\x27un intervalle de temps - la fin d\x27un intervalle de temps - la valeur minimale observ\xE9e dans l\x27intervalle de temps - la valeur moyenne observ\xE9e dans l\x27intervalle de temps - la valeur maximale observ\xE9e dans l\x27intervalle de temps

Le r\xE9sum\xE9 des mesures est disponible d\xE8s que `loadMore()` a \xE9t\xE9 appel\xE9 pour la premi\xE8re fois.

',ret:'un tableau d\x27enregistrements, chaque enregistrement repr\xE9sentant les mesures observ\xE9e durant un certain intervalle de temps.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['DataSet']['get_progress']={syn:'Retourne l\x27\xE9tat d\x27avancement du chargement des donn\xE9es, sur une \xE9chelle de 0 \xE0 100.',lib:'dataset.get_progress()',pro:'function get_progress()',cmt:'

Retourne l\x27\xE9tat d\x27avancement du chargement des donn\xE9es, sur une \xE9chelle de 0 \xE0 100. A l\x27instanciation de l\x27objet par la fonction `get_dataSet()`, l\x27avancement est nul. Au fur et \xE0 mesure des appels \xE0 `loadMore()`, l\x27avancement progresse pour atteindre la valeur 100 lorsque toutes les mesures ont \xE9t\xE9 charg\xE9es.

',ret:'un nombre entier entre 0 et 100 repr\xE9sentant l\x27avancement du chargement des donn\xE9es demand\xE9es.'}; doc['DataSet']['get_startTimeUTC']={syn:'Retourne l\x27heure absolue du d\xE9but des mesures disponibels, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix).',lib:'dataset.get_startTimeUTC()',pro:'function get_startTimeUTC()',cmt:'

Retourne l\x27heure absolue du d\xE9but des mesures disponibels, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix). Lorsque l\x27objet YDataSet est cr\xE9\xE9, l\x27heure de d\xE9part est celle qui a \xE9t\xE9 pass\xE9e en param\xE8tre \xE0 la fonction `get_dataSet`. D\xE8s le premier appel \xE0 la m\xE9thode `loadMore()`, l\x27heure de d\xE9part est mise \xE0 jour \xE0 la premi\xE8re mesure effectivement disponible dans l\x27enregistreur de donn\xE9es pour la plage sp\xE9cifi\xE9e.

',ret:'un entier positif correspondant au nombre de secondes \xE9coul\xE9es entre le 1er janvier 1970 et la premi\xE8re mesure enregistr\xE9e.'}; doc['DataSet']['get_summary']={syn:'Retourne un objet YMeasure r\xE9sumant tout le YDataSet.',lib:'dataset.get_summary()',pro:'function get_summary()',cmt:'

Retourne un objet YMeasure r\xE9sumant tout le YDataSet. Il inclut les information suivantes: - le moment de la premi\xE8re mesure - le moment de la derni\xE8re mesure - la valeur minimale observ\xE9e dans l\x27intervalle de temps - la valeur moyenne observ\xE9e dans l\x27intervalle de temps - la valeur maximale observ\xE9e dans l\x27intervalle de temps

Ce r\xE9sum\xE9 des mesures est disponible d\xE8s que `loadMore()` a \xE9t\xE9 appel\xE9 pour la premi\xE8re fois.

',ret:'un objet YMeasure'}; doc['DataSet']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la valeur mesur\xE9e est exprim\xE9e.',lib:'dataset.get_unit()',pro:'function get_unit()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant une unit\xE9 physique.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['DataSet']['loadMore']={syn:'Proc\xE8de au chargement du bloc suivant de mesures depuis l\x27enregistreur de donn\xE9es du module, et met \xE0 jour l\x27indicateur d\x27avancement.',lib:'dataset.loadMore()',pro:'function loadMore()',cmt:'

Proc\xE8de au chargement du bloc suivant de mesures depuis l\x27enregistreur de donn\xE9es du module, et met \xE0 jour l\x27indicateur d\x27avancement.

',ret:'un nombre entier entre 0 et 100 repr\xE9sentant l\x27avancement du chargement des donn\xE9es demand\xE9es, ou un code d\x27erreur n\xE9gatif en cas de probl\xE8me.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['DataSet']['loadMore_async']={syn:'Proc\xE8de au chargement du bloc suivant de mesures depuis l\x27enregistreur de donn\xE9es du module, de mani\xE8re asynchrone.',lib:'dataset.loadMore_async()',pro:'function loadMore_async(callback, context)',cmt:'

Proc\xE8de au chargement du bloc suivant de mesures depuis l\x27enregistreur de donn\xE9es du module, de mani\xE8re asynchrone.

',par:{callback:'fonction fournie par l\x27utilisateur, qui sera appel\xE9e lorsque la suite du chargement aura \xE9t\xE9 effectu\xE9. La fonction callback doit prendre trois arguments: - la variable de contexte \xE0 disposition de l\x27utilisateur - l\x27objet YDataSet dont la m\xE9thode loadMore_async a \xE9t\xE9 appel\xE9e - le r\xE9sultat de l\x27appel: soit l\x27\xE9tat d\x27avancement du chargement (0...100), ou un code d\x27erreur n\xE9gatif en cas de probl\xE8me.',context:'variable de contexte \xE0 disposition de l\x27utilisateur'},ret:'rien.'}; //--- (end of generated code: DataSet) //--- (generated code: Measure) doc['Measure']={'':{syn:'Valeur mesur\xE9e',inc:'<script type='text/javascript' src='yocto_api.js'></script>',cmt:'

Les objets YMeasure sont utilis\xE9s dans l\x27interface de programmation Yoctopuce pour repr\xE9senter une valeur observ\xE9e un moment donn\xE9e. Ces objets sont utilis\xE9s en particulier en conjonction avec la classe YDataSet.

'}}; doc['Measure']['get_averageValue']={syn:'Retourne la valeur moyenne observ\xE9e durant l\x27intervalle de temps couvert par la mesure.',lib:'measure.get_averageValue()',pro:'function get_averageValue()',cmt:'

Retourne la valeur moyenne observ\xE9e durant l\x27intervalle de temps couvert par la mesure.

',ret:'un nombre d\xE9cimal correspondant \xE0 la valeur moyenne observ\xE9e.'}; doc['Measure']['get_endTimeUTC']={syn:'Retourne l\x27heure absolue de la fin de la mesure, sous forme du nombre de secondes depuis le 1er janvier 1970 UTC (date/heure au format Unix).',lib:'measure.get_endTimeUTC()',pro:'function get_endTimeUTC()',cmt:'

Retourne l\x27heure absolue de la fin de la mesure, sous forme du nombre de secondes depuis le 1er janvier 1970 UTC (date/heure au format Unix). Lors que l\x27enregistrement de donn\xE9es se fait \xE0 une fr\xE9quence sup\xE9rieure \xE0 une mesure par seconde, le timestamp peuvent inclurent une fraction d\xE9cimale.

',ret:'un nombre r\xE9el positif correspondant au nombre de secondes \xE9coul\xE9es entre le 1er janvier 1970 UTC et la fin de la mesure.'}; doc['Measure']['get_maxValue']={syn:'Retourne la plus grande valeur observ\xE9e durant l\x27intervalle de temps couvert par la mesure.',lib:'measure.get_maxValue()',pro:'function get_maxValue()',cmt:'

Retourne la plus grande valeur observ\xE9e durant l\x27intervalle de temps couvert par la mesure.

',ret:'un nombre d\xE9cimal correspondant \xE0 la plus grande valeur observ\xE9e.'}; doc['Measure']['get_minValue']={syn:'Retourne la plus petite valeur observ\xE9e durant l\x27intervalle de temps couvert par la mesure.',lib:'measure.get_minValue()',pro:'function get_minValue()',cmt:'

Retourne la plus petite valeur observ\xE9e durant l\x27intervalle de temps couvert par la mesure.

',ret:'un nombre d\xE9cimal correspondant \xE0 la plus petite valeur observ\xE9e.'}; doc['Measure']['get_startTimeUTC']={syn:'Retourne l\x27heure absolue du d\xE9but de la mesure, sous forme du nombre de secondes depuis le 1er janvier 1970 UTC (date/heure au format Unix).',lib:'measure.get_startTimeUTC()',pro:'function get_startTimeUTC()',cmt:'

Retourne l\x27heure absolue du d\xE9but de la mesure, sous forme du nombre de secondes depuis le 1er janvier 1970 UTC (date/heure au format Unix). Lors que l\x27enregistrement de donn\xE9es se fait \xE0 une fr\xE9quence sup\xE9rieure \xE0 une mesure par seconde, le timestamp peuvent inclurent une fraction d\xE9cimale.

',ret:'un nombre r\xE9el positif correspondant au nombre de secondes \xE9coul\xE9es entre le 1er janvier 1970 UTC et la d\xE9but de la mesure.'}; //--- (end of generated code: Measure) //--- (generated code: AnalogSensorS16) doc['AnalogSensorS16']={'':{syn:'AnalogSensorS16',inc:'
',cmt:'

La librairie de programmation Yoctopuce permet lire une valeur instantan\xE9e du capteur, ainsi que les extr\xE9mas atteints.

'}}; doc['AnalogSensorS16']['FindAnalogSensorS16']={syn:'Permet de retrouver $AFUNCTION$ d\x27apr\xE8s un identifiant donn\xE9.',lib:'YAnalogSensorS16.FindAnalogSensorS16()',pro:'function FindAnalogSensorS16(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que $THEFUNCTION$ soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YAnalogSensorS16.isOnline()` pour tester si $THEFUNCTION$ 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 $THEFUNCTION$ sans ambigu\xEFt\xE9'},ret:'un objet de classe `YAnalogSensorS16` qui permet ensuite de contr\xF4ler $THEFUNCTION$.'}; doc['AnalogSensorS16']['FirstAnalogSensorS16']={syn:'Commence l\x27\xE9num\xE9ration des $FUNCTIONS$ accessibles par la librairie.',lib:'YAnalogSensorS16.FirstAnalogSensorS16()',pro:'function FirstAnalogSensorS16()',cmt:'

Commence l\x27\xE9num\xE9ration des $FUNCTIONS$ accessibles par la librairie. Utiliser la fonction `YAnalogSensorS16.nextAnalogSensorS16()` pour it\xE9rer sur les autres $FUNCTIONS$.

',ret:'un pointeur sur un objet `YAnalogSensorS16`, correspondant \xE0 $THEFIRSTFUNCTION$ accessible en ligne, ou `null` si il n\x27y a pas de $FUNCTIONS$ disponibles.'}; doc['AnalogSensorS16']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'analogsensors16.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['AnalogSensorS16']['describe']={syn:'Retourne un court texte d\xE9crivant la fonction au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'analogsensors16.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['AnalogSensorS16']['get_advertisedValue']={syn:'Retourne la valeur courante de $THEFUNCTION$ (pas plus de 6 caract\xE8res).',lib:'analogsensors16.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de $THEFUNCTION$ (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de $THEFUNCTION$ (pas plus de 6 caract\xE8res)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['AnalogSensorS16']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration).',lib:'analogsensors16.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration).

',ret:'une valeur num\xE9rique repr\xE9sentant la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['AnalogSensorS16']['get_currentValue']={syn:'Retourne la valeur mesur\xE9e actuelle.',lib:'analogsensors16.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur mesur\xE9e actuelle.

',ret:'une valeur num\xE9rique repr\xE9sentant la valeur mesur\xE9e actuelle',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['AnalogSensorS16']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la fonction.',lib:'analogsensors16.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['AnalogSensorS16']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la fonction.',lib:'analogsensors16.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['AnalogSensorS16']['get_friendlyName']={syn:'Retourne un identifiant global de la fonction au format `NOM_MODULE.NOM_FONCTION`.',lib:'analogsensors16.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['AnalogSensorS16']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'analogsensors16.get_functionDescriptor()',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['AnalogSensorS16']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de la fonction, sans r\xE9f\xE9rence au module.',lib:'analogsensors16.get_functionId()',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['AnalogSensorS16']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique de la fonction au format `SERIAL.FUNCTIONID`.',lib:'analogsensors16.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['AnalogSensorS16']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e.',lib:'analogsensors16.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e.

',ret:'une valeur num\xE9rique repr\xE9sentant la valeur maximale observ\xE9e',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['AnalogSensorS16']['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:'analogsensors16.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\xEEne de caract\xE8res repr\xE9sentant 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\xE9clenche une exception ou retourne `Y_LOGFREQUENCY_INVALID`.'}; doc['AnalogSensorS16']['get_logicalName']={syn:'Retourne le nom logique de $THEFUNCTION$.',lib:'analogsensors16.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de $THEFUNCTION$.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de $THEFUNCTION$',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['AnalogSensorS16']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e.',lib:'analogsensors16.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e.

',ret:'une valeur num\xE9rique repr\xE9sentant la valeur minimale observ\xE9e',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['AnalogSensorS16']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'analogsensors16.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['AnalogSensorS16']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'analogsensors16.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['AnalogSensorS16']['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:'analogsensors16.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\xEEne de caract\xE8res repr\xE9sentant 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\xE9clenche une exception ou retourne `Y_REPORTFREQUENCY_INVALID`.'}; doc['AnalogSensorS16']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'analogsensors16.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.

',ret:'une valeur num\xE9rique repr\xE9sentant la r\xE9solution des valeurs mesur\xE9es',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_RESOLUTION_INVALID`.'}; doc['AnalogSensorS16']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la valeur mesur\xE9e est exprim\xE9e.',lib:'analogsensors16.get_unit()',pro:'function get_unit()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant l\x27unit\xE9 dans laquelle la valeur mesur\xE9e est exprim\xE9e',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['AnalogSensorS16']['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:'analogsensors16.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['AnalogSensorS16']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant la fonction est joignable, sans d\xE9clencher d\x27erreur.',lib:'analogsensors16.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['AnalogSensorS16']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant la fonction est joignable, sans d\xE9clencher d\x27erreur.',lib:'analogsensors16.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['AnalogSensorS16']['load']={syn:'Met en cache les valeurs courantes de la fonction, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'analogsensors16.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['AnalogSensorS16']['load_async']={syn:'Met en cache les valeurs courantes de la fonction, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'analogsensors16.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['AnalogSensorS16']['nextAnalogSensorS16']={syn:'Continue l\x27\xE9num\xE9ration des $FUNCTIONS$ commenc\xE9e \xE0 l\x27aide de `yFirstAnalogSensorS16()`.',lib:'analogsensors16.nextAnalogSensorS16()',pro:'function nextAnalogSensorS16()',cmt:'

Continue l\x27\xE9num\xE9ration des $FUNCTIONS$ commenc\xE9e \xE0 l\x27aide de `yFirstAnalogSensorS16()`.

',ret:'un pointeur sur un objet `YAnalogSensorS16` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['AnalogSensorS16']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'analogsensors16.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['AnalogSensorS16']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'analogsensors16.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur num\xE9rique repr\xE9sentant la m\xE9moire de valeur maximale observ\xE9e'},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['AnalogSensorS16']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'analogsensors16.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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['AnalogSensorS16']['set_logicalName']={syn:'Modifie le nom logique de $THEFUNCTION$.',lib:'analogsensors16.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de $THEFUNCTION$. 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 $THEFUNCTION$'},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['AnalogSensorS16']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'analogsensors16.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur num\xE9rique repr\xE9sentant la m\xE9moire de valeur minimale observ\xE9e'},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['AnalogSensorS16']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'analogsensors16.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une cha\xEEne de caract\xE8res repr\xE9sentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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['AnalogSensorS16']['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:'analogsensors16.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['AnalogSensorS16']['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:'analogsensors16.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: AnalogSensorS16) //--- (generated code: Sensor) doc['Sensor']={'':{syn:'Interface des fonctions de type senseur',inc:'<script type='text/javascript' src='yocto_api.js'></script>',cmt:'

La classe YSensor est la classe parente de tous les senseurs Yoctopuce. Elle permet de lire la valeur courante et l\x27unit\xE9 de n\x27importe quel capteur, de lire les valeurs min/max, de configurer la fr\xE9quence d\x27enregistrement autonome des donn\xE9es et de r\xE9cup\xE9rer les mesures enregistr\xE9es. Elle permet aussi d\x27enregistrer un callback appel\xE9 lorsque la valeur mesur\xE9e change ou \xE0 intervalle pr\xE9d\xE9fini. L\x27utilisation de cette classe plut\xF4t qu\x27une de ces sous-classes permet de cr\xE9er des application g\xE9n\xE9riques, compatibles m\xEAme avec les capteurs Yoctopuce futurs. Note: la classe YAnButton est le seul type d\x27entr\xE9e analogique qui n\x27h\xE9rite pas de YSensor.

'}}; doc['Sensor']['FindSensor']={syn:'Permet de retrouver un senseur d\x27apr\xE8s un identifiant donn\xE9.',lib:'YSensor.FindSensor()',pro:'function FindSensor(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le senseur soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YSensor.isOnline()` pour tester si le senseur 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 le senseur sans ambigu\xEFt\xE9'},ret:'un objet de classe `YSensor` qui permet ensuite de contr\xF4ler le senseur.'}; doc['Sensor']['FirstSensor']={syn:'Commence l\x27\xE9num\xE9ration des senseurs accessibles par la librairie.',lib:'YSensor.FirstSensor()',pro:'function FirstSensor()',cmt:'

Commence l\x27\xE9num\xE9ration des senseurs accessibles par la librairie. Utiliser la fonction `YSensor.nextSensor()` pour it\xE9rer sur les autres senseurs.

',ret:'un pointeur sur un objet `YSensor`, correspondant au premier senseur accessible en ligne, ou `null` si il n\x27y a pas de senseurs disponibles.'}; doc['Sensor']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'sensor.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Sensor']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du senseur au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'sensor.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du senseur 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 senseur (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Sensor']['get_advertisedValue']={syn:'Retourne la valeur courante du senseur (pas plus de 6 caract\xE8res).',lib:'sensor.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du senseur (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Sensor']['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:'sensor.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 `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Sensor']['get_currentValue']={syn:'Retourne la valeur actuelle de la measure, en l\x27unit\xE9 sp\xE9cifi\xE9e, sous forme de nombre \xE0 virgule.',lib:'sensor.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.

',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 `Y_CURRENTVALUE_INVALID`.'}; doc['Sensor']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du senseur.',lib:'sensor.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du senseur. 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 senseur.'}; doc['Sensor']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du senseur.',lib:'sensor.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du senseur. 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 senseur.'}; doc['Sensor']['get_friendlyName']={syn:'Retourne un identifiant global du senseur au format `NOM_MODULE.NOM_FONCTION`.',lib:'sensor.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le senseur en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Sensor']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'sensor.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Sensor']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du senseur, sans r\xE9f\xE9rence au module.',lib:'sensor.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du senseur 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 senseur (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le senseur (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Sensor']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la measure depuis le d\xE9marrage du module.',lib:'sensor.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la measure depuis le d\xE9marrage du module.

',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 `Y_HIGHESTVALUE_INVALID`.'}; doc['Sensor']['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:'sensor.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Sensor']['get_logicalName']={syn:'Retourne le nom logique du senseur.',lib:'sensor.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du senseur.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du senseur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Sensor']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la measure depuis le d\xE9marrage du module.',lib:'sensor.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la measure depuis le d\xE9marrage du module.

',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 `Y_LOWESTVALUE_INVALID`.'}; doc['Sensor']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'sensor.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['Sensor']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'sensor.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['Sensor']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'sensor.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Sensor']['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:'sensor.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Sensor']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'sensor.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Sensor']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la measure est exprim\xE9e.',lib:'sensor.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 `Y_UNIT_INVALID`.'}; doc['Sensor']['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:'sensor.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['Sensor']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le senseur est joignable, sans d\xE9clencher d\x27erreur.',lib:'sensor.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le senseur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du senseur 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 senseur est joignable, `false` sinon'}; doc['Sensor']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le senseur est joignable, sans d\xE9clencher d\x27erreur.',lib:'sensor.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le senseur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du senseur 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.'}; doc['Sensor']['load']={syn:'Met en cache les valeurs courantes du senseur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'sensor.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du senseur, 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.'}; doc['Sensor']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'sensor.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Sensor']['load_async']={syn:'Met en cache les valeurs courantes du senseur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'sensor.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du senseur, 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.'}; doc['Sensor']['nextSensor']={syn:'Continue l\x27\xE9num\xE9ration des senseurs commenc\xE9e \xE0 l\x27aide de `yFirstSensor()`.',lib:'sensor.nextSensor()',pro:'function nextSensor()',cmt:'

Continue l\x27\xE9num\xE9ration des senseurs commenc\xE9e \xE0 l\x27aide de `yFirstSensor()`.

',ret:'un pointeur sur un objet `YSensor` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Sensor']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'sensor.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Sensor']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'sensor.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['Sensor']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'sensor.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Sensor']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'sensor.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Sensor']['set_logicalName']={syn:'Modifie le nom logique du senseur.',lib:'sensor.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du senseur. 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 senseur.'},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.'}; doc['Sensor']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'sensor.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Sensor']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'sensor.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Sensor']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'sensor.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Sensor']['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:'sensor.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['Sensor']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'sensor.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Sensor']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'sensor.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Sensor']['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:'sensor.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 machine virtuelle 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: Sensor) //--- (generated code: Accelerometer) doc['Accelerometer']={'':{syn:'Interface de la fonction Accelerometer',inc:'<script type='text/javascript' src='yocto_accelerometer.js'></script>',cmt:'

La classe YSensor est la classe parente de tous les senseurs Yoctopuce. Elle permet de lire la valeur courante et l\x27unit\xE9 de n\x27importe quel capteur, de lire les valeurs min/max, de configurer la fr\xE9quence d\x27enregistrement autonome des donn\xE9es et de r\xE9cup\xE9rer les mesures enregistr\xE9es. Elle permet aussi d\x27enregistrer un callback appel\xE9 lorsque la valeur mesur\xE9e change ou \xE0 intervalle pr\xE9d\xE9fini. L\x27utilisation de cette classe plut\xF4t qu\x27une de ces sous-classes permet de cr\xE9er des application g\xE9n\xE9riques, compatibles m\xEAme avec les capteurs Yoctopuce futurs. Note: la classe YAnButton est le seul type d\x27entr\xE9e analogique qui n\x27h\xE9rite pas de YSensor.

'}}; doc['Accelerometer']['FindAccelerometer']={syn:'Permet de retrouver un acc\xE9l\xE9rom\xE8tre d\x27apr\xE8s un identifiant donn\xE9.',lib:'YAccelerometer.FindAccelerometer()',pro:'function FindAccelerometer(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27acc\xE9l\xE9rom\xE8tre soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YAccelerometer.isOnline()` pour tester si l\x27acc\xE9l\xE9rom\xE8tre 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 l\x27acc\xE9l\xE9rom\xE8tre sans ambigu\xEFt\xE9'},ret:'un objet de classe `YAccelerometer` qui permet ensuite de contr\xF4ler l\x27acc\xE9l\xE9rom\xE8tre.'}; doc['Accelerometer']['FirstAccelerometer']={syn:'Commence l\x27\xE9num\xE9ration des acc\xE9l\xE9rom\xE8tres accessibles par la librairie.',lib:'YAccelerometer.FirstAccelerometer()',pro:'function FirstAccelerometer()',cmt:'

Commence l\x27\xE9num\xE9ration des acc\xE9l\xE9rom\xE8tres accessibles par la librairie. Utiliser la fonction `YAccelerometer.nextAccelerometer()` pour it\xE9rer sur les autres acc\xE9l\xE9rom\xE8tres.

',ret:'un pointeur sur un objet `YAccelerometer`, correspondant au premier acc\xE9l\xE9rom\xE8tre accessible en ligne, ou `null` si il n\x27y a pas de acc\xE9l\xE9rom\xE8tres disponibles.'}; doc['Accelerometer']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'accelerometer.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Accelerometer']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27acc\xE9l\xE9rom\xE8tre au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'accelerometer.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27acc\xE9l\xE9rom\xE8tre 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\x27acc\xE9l\xE9rom\xE8tre (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Accelerometer']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27acc\xE9l\xE9rom\xE8tre (pas plus de 6 caract\xE8res).',lib:'accelerometer.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27acc\xE9l\xE9rom\xE8tre (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27acc\xE9l\xE9rom\xE8tre (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Accelerometer']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en g, sous forme de nombre \xE0 virgule.',lib:'accelerometer.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en g, 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 g, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Accelerometer']['get_currentValue']={syn:'Retourne la valeur actuelle de l\x27acc\xE9l\xE9ration, en g, sous forme de nombre \xE0 virgule.',lib:'accelerometer.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de l\x27acc\xE9l\xE9ration, en g, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de l\x27acc\xE9l\xE9ration, en g, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Accelerometer']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27acc\xE9l\xE9rom\xE8tre.',lib:'accelerometer.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27acc\xE9l\xE9rom\xE8tre. 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\x27acc\xE9l\xE9rom\xE8tre.'}; doc['Accelerometer']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27acc\xE9l\xE9rom\xE8tre.',lib:'accelerometer.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\x27acc\xE9l\xE9rom\xE8tre. 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\x27acc\xE9l\xE9rom\xE8tre.'}; doc['Accelerometer']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27acc\xE9l\xE9rom\xE8tre au format `NOM_MODULE.NOM_FONCTION`.',lib:'accelerometer.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27acc\xE9l\xE9rom\xE8tre en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Accelerometer']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'accelerometer.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Accelerometer']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27acc\xE9l\xE9rom\xE8tre, sans r\xE9f\xE9rence au module.',lib:'accelerometer.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de l\x27acc\xE9l\xE9rom\xE8tre, sans r\xE9f\xE9rence au module. Par example `relay1`.

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27acc\xE9l\xE9rom\xE8tre 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\x27acc\xE9l\xE9rom\xE8tre (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27acc\xE9l\xE9rom\xE8tre (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Accelerometer']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour l\x27acc\xE9l\xE9ration depuis le d\xE9marrage du module.',lib:'accelerometer.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour l\x27acc\xE9l\xE9ration depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour l\x27acc\xE9l\xE9ration depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Accelerometer']['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:'accelerometer.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Accelerometer']['get_logicalName']={syn:'Retourne le nom logique de l\x27acc\xE9l\xE9rom\xE8tre.',lib:'accelerometer.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27acc\xE9l\xE9rom\xE8tre.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27acc\xE9l\xE9rom\xE8tre.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Accelerometer']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour l\x27acc\xE9l\xE9ration depuis le d\xE9marrage du module.',lib:'accelerometer.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour l\x27acc\xE9l\xE9ration depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour l\x27acc\xE9l\xE9ration depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Accelerometer']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'accelerometer.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['Accelerometer']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'accelerometer.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['Accelerometer']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'accelerometer.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Accelerometer']['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:'accelerometer.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Accelerometer']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'accelerometer.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Accelerometer']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle l\x27acc\xE9l\xE9ration est exprim\xE9e.',lib:'accelerometer.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle l\x27acc\xE9l\xE9ration est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle l\x27acc\xE9l\xE9ration est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Accelerometer']['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:'accelerometer.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['Accelerometer']['get_xValue']={syn:'Retourne la composante X de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule.',lib:'accelerometer.get_xValue()',pro:'function get_xValue()',cmt:'

Retourne la composante X de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la composante X de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_XVALUE_INVALID`.'}; doc['Accelerometer']['get_yValue']={syn:'Retourne la composante Y de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule.',lib:'accelerometer.get_yValue()',pro:'function get_yValue()',cmt:'

Retourne la composante Y de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la composante Y de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_YVALUE_INVALID`.'}; doc['Accelerometer']['get_zValue']={syn:'Retourne la composante Z de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule.',lib:'accelerometer.get_zValue()',pro:'function get_zValue()',cmt:'

Retourne la composante Z de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la composante Z de l\x27acc\xE9l\xE9ration, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ZVALUE_INVALID`.'}; doc['Accelerometer']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27acc\xE9l\xE9rom\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'accelerometer.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27acc\xE9l\xE9rom\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27acc\xE9l\xE9rom\xE8tre 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\x27acc\xE9l\xE9rom\xE8tre est joignable, `false` sinon'}; doc['Accelerometer']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27acc\xE9l\xE9rom\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'accelerometer.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27acc\xE9l\xE9rom\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27acc\xE9l\xE9rom\xE8tre 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.'}; doc['Accelerometer']['load']={syn:'Met en cache les valeurs courantes de l\x27acc\xE9l\xE9rom\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'accelerometer.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27acc\xE9l\xE9rom\xE8tre, 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.'}; doc['Accelerometer']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'accelerometer.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Accelerometer']['load_async']={syn:'Met en cache les valeurs courantes de l\x27acc\xE9l\xE9rom\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'accelerometer.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27acc\xE9l\xE9rom\xE8tre, 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.'}; doc['Accelerometer']['nextAccelerometer']={syn:'Continue l\x27\xE9num\xE9ration des acc\xE9l\xE9rom\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstAccelerometer()`.',lib:'accelerometer.nextAccelerometer()',pro:'function nextAccelerometer()',cmt:'

Continue l\x27\xE9num\xE9ration des acc\xE9l\xE9rom\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstAccelerometer()`.

',ret:'un pointeur sur un objet `YAccelerometer` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Accelerometer']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'accelerometer.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Accelerometer']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'accelerometer.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['Accelerometer']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'accelerometer.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Accelerometer']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'accelerometer.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Accelerometer']['set_logicalName']={syn:'Modifie le nom logique de l\x27acc\xE9l\xE9rom\xE8tre.',lib:'accelerometer.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27acc\xE9l\xE9rom\xE8tre. 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\x27acc\xE9l\xE9rom\xE8tre.'},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.'}; doc['Accelerometer']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'accelerometer.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Accelerometer']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'accelerometer.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Accelerometer']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'accelerometer.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Accelerometer']['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:'accelerometer.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['Accelerometer']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'accelerometer.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Accelerometer']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'accelerometer.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Accelerometer']['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:'accelerometer.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 machine virtuelle 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: Accelerometer) //--- (generated code: Magnetometer) doc['Magnetometer']={'':{syn:'Interface de la fonction Magnetometer',inc:'<script type='text/javascript' src='yocto_magnetometer.js'></script>',cmt:'

La classe YSensor est la classe parente de tous les senseurs Yoctopuce. Elle permet de lire la valeur courante et l\x27unit\xE9 de n\x27importe quel capteur, de lire les valeurs min/max, de configurer la fr\xE9quence d\x27enregistrement autonome des donn\xE9es et de r\xE9cup\xE9rer les mesures enregistr\xE9es. Elle permet aussi d\x27enregistrer un callback appel\xE9 lorsque la valeur mesur\xE9e change ou \xE0 intervalle pr\xE9d\xE9fini. L\x27utilisation de cette classe plut\xF4t qu\x27une de ces sous-classes permet de cr\xE9er des application g\xE9n\xE9riques, compatibles m\xEAme avec les capteurs Yoctopuce futurs. Note: la classe YAnButton est le seul type d\x27entr\xE9e analogique qui n\x27h\xE9rite pas de YSensor.

'}}; doc['Magnetometer']['FindMagnetometer']={syn:'Permet de retrouver un magn\xE9tom\xE8tre d\x27apr\xE8s un identifiant donn\xE9.',lib:'YMagnetometer.FindMagnetometer()',pro:'function FindMagnetometer(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le magn\xE9tom\xE8tre soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YMagnetometer.isOnline()` pour tester si le magn\xE9tom\xE8tre 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 le magn\xE9tom\xE8tre sans ambigu\xEFt\xE9'},ret:'un objet de classe `YMagnetometer` qui permet ensuite de contr\xF4ler le magn\xE9tom\xE8tre.'}; doc['Magnetometer']['FirstMagnetometer']={syn:'Commence l\x27\xE9num\xE9ration des magn\xE9tom\xE8tres accessibles par la librairie.',lib:'YMagnetometer.FirstMagnetometer()',pro:'function FirstMagnetometer()',cmt:'

Commence l\x27\xE9num\xE9ration des magn\xE9tom\xE8tres accessibles par la librairie. Utiliser la fonction `YMagnetometer.nextMagnetometer()` pour it\xE9rer sur les autres magn\xE9tom\xE8tres.

',ret:'un pointeur sur un objet `YMagnetometer`, correspondant au premier magn\xE9tom\xE8tre accessible en ligne, ou `null` si il n\x27y a pas de magn\xE9tom\xE8tres disponibles.'}; doc['Magnetometer']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'magnetometer.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Magnetometer']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du magn\xE9tom\xE8tre au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'magnetometer.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du magn\xE9tom\xE8tre 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 magn\xE9tom\xE8tre (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Magnetometer']['get_advertisedValue']={syn:'Retourne la valeur courante du magn\xE9tom\xE8tre (pas plus de 6 caract\xE8res).',lib:'magnetometer.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du magn\xE9tom\xE8tre (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du magn\xE9tom\xE8tre (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Magnetometer']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en mT, sous forme de nombre \xE0 virgule.',lib:'magnetometer.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en mT, 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 mT, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Magnetometer']['get_currentValue']={syn:'Retourne la valeur actuelle du champ magn\xE9tique, en mT, sous forme de nombre \xE0 virgule.',lib:'magnetometer.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle du champ magn\xE9tique, en mT, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle du champ magn\xE9tique, en mT, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Magnetometer']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du magn\xE9tom\xE8tre.',lib:'magnetometer.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du magn\xE9tom\xE8tre. 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 magn\xE9tom\xE8tre.'}; doc['Magnetometer']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du magn\xE9tom\xE8tre.',lib:'magnetometer.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du magn\xE9tom\xE8tre. 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 magn\xE9tom\xE8tre.'}; doc['Magnetometer']['get_friendlyName']={syn:'Retourne un identifiant global du magn\xE9tom\xE8tre au format `NOM_MODULE.NOM_FONCTION`.',lib:'magnetometer.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le magn\xE9tom\xE8tre en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Magnetometer']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'magnetometer.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Magnetometer']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du magn\xE9tom\xE8tre, sans r\xE9f\xE9rence au module.',lib:'magnetometer.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du magn\xE9tom\xE8tre, sans r\xE9f\xE9rence au module. Par example `relay1`.

',ret:'une cha\xEEne de caract\xE8res identifiant le magn\xE9tom\xE8tre (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['Magnetometer']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du magn\xE9tom\xE8tre au format `SERIAL.FUNCTIONID`.',lib:'magnetometer.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du magn\xE9tom\xE8tre 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 magn\xE9tom\xE8tre (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le magn\xE9tom\xE8tre (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Magnetometer']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour le champ magn\xE9tique depuis le d\xE9marrage du module.',lib:'magnetometer.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour le champ magn\xE9tique depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour le champ magn\xE9tique depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Magnetometer']['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:'magnetometer.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Magnetometer']['get_logicalName']={syn:'Retourne le nom logique du magn\xE9tom\xE8tre.',lib:'magnetometer.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du magn\xE9tom\xE8tre.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du magn\xE9tom\xE8tre.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Magnetometer']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour le champ magn\xE9tique depuis le d\xE9marrage du module.',lib:'magnetometer.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour le champ magn\xE9tique depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour le champ magn\xE9tique depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Magnetometer']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'magnetometer.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['Magnetometer']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'magnetometer.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['Magnetometer']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'magnetometer.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Magnetometer']['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:'magnetometer.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Magnetometer']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'magnetometer.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Magnetometer']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle le champ magn\xE9tique est exprim\xE9e.',lib:'magnetometer.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle le champ magn\xE9tique est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle le champ magn\xE9tique est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Magnetometer']['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:'magnetometer.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['Magnetometer']['get_xValue']={syn:'Retourne la composante X du champ magn\xE9tique, sous forme de nombre \xE0 virgule.',lib:'magnetometer.get_xValue()',pro:'function get_xValue()',cmt:'

Retourne la composante X du champ magn\xE9tique, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la composante X du champ magn\xE9tique, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_XVALUE_INVALID`.'}; doc['Magnetometer']['get_yValue']={syn:'Retourne la composante Y du champ magn\xE9tique, sous forme de nombre \xE0 virgule.',lib:'magnetometer.get_yValue()',pro:'function get_yValue()',cmt:'

Retourne la composante Y du champ magn\xE9tique, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la composante Y du champ magn\xE9tique, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_YVALUE_INVALID`.'}; doc['Magnetometer']['get_zValue']={syn:'Retourne la composante Z du champ magn\xE9tique, sous forme de nombre \xE0 virgule.',lib:'magnetometer.get_zValue()',pro:'function get_zValue()',cmt:'

Retourne la composante Z du champ magn\xE9tique, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la composante Z du champ magn\xE9tique, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ZVALUE_INVALID`.'}; doc['Magnetometer']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le magn\xE9tom\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'magnetometer.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le magn\xE9tom\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du magn\xE9tom\xE8tre 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 magn\xE9tom\xE8tre est joignable, `false` sinon'}; doc['Magnetometer']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le magn\xE9tom\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'magnetometer.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le magn\xE9tom\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du magn\xE9tom\xE8tre 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.'}; doc['Magnetometer']['load']={syn:'Met en cache les valeurs courantes du magn\xE9tom\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'magnetometer.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du magn\xE9tom\xE8tre, 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.'}; doc['Magnetometer']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'magnetometer.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Magnetometer']['load_async']={syn:'Met en cache les valeurs courantes du magn\xE9tom\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'magnetometer.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du magn\xE9tom\xE8tre, 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.'}; doc['Magnetometer']['nextMagnetometer']={syn:'Continue l\x27\xE9num\xE9ration des magn\xE9tom\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstMagnetometer()`.',lib:'magnetometer.nextMagnetometer()',pro:'function nextMagnetometer()',cmt:'

Continue l\x27\xE9num\xE9ration des magn\xE9tom\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstMagnetometer()`.

',ret:'un pointeur sur un objet `YMagnetometer` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Magnetometer']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'magnetometer.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Magnetometer']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'magnetometer.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['Magnetometer']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'magnetometer.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Magnetometer']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'magnetometer.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Magnetometer']['set_logicalName']={syn:'Modifie le nom logique du magn\xE9tom\xE8tre.',lib:'magnetometer.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du magn\xE9tom\xE8tre. 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 magn\xE9tom\xE8tre.'},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.'}; doc['Magnetometer']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'magnetometer.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Magnetometer']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'magnetometer.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Magnetometer']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'magnetometer.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Magnetometer']['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:'magnetometer.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['Magnetometer']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'magnetometer.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Magnetometer']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'magnetometer.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Magnetometer']['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:'magnetometer.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 machine virtuelle 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: Magnetometer) //--- (generated code: RefFrame) doc['RefFrame']={'':{syn:'Configuration du r\xE9f\xE9rentiel',inc:'<script type='text/javascript' src='yocto_refframe.js'></script>',cmt:'

Cette classe permet de configurer l\x27orientation dans laquelle le Yocto-3D est utilis\xE9, afin que les fonctions d\x27orientation relatives au plan de la surface terrestre utilisent le r\xE9f\xE9rentiel appropri\xE9. La classe offre aussi un processus de recalibration tridimensionnel des capteurs, permettant de compenser les variations locales de l\x27acc\xE9l\xE9ration terrestre et d\x27am\xE9liorer la pr\xE9cision des capteurs d\x27inclinaisons.

'}}; doc['RefFrame']['FindRefFrame']={syn:'Permet de retrouver un r\xE9f\xE9rentiel d\x27apr\xE8s un identifiant donn\xE9.',lib:'YRefFrame.FindRefFrame()',pro:'function FindRefFrame(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le r\xE9f\xE9rentiel soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YRefFrame.isOnline()` pour tester si le r\xE9f\xE9rentiel 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 le r\xE9f\xE9rentiel sans ambigu\xEFt\xE9'},ret:'un objet de classe `YRefFrame` qui permet ensuite de contr\xF4ler le r\xE9f\xE9rentiel.'}; doc['RefFrame']['FirstRefFrame']={syn:'Commence l\x27\xE9num\xE9ration des r\xE9f\xE9rentiels accessibles par la librairie.',lib:'YRefFrame.FirstRefFrame()',pro:'function FirstRefFrame()',cmt:'

Commence l\x27\xE9num\xE9ration des r\xE9f\xE9rentiels accessibles par la librairie. Utiliser la fonction `YRefFrame.nextRefFrame()` pour it\xE9rer sur les autres r\xE9f\xE9rentiels.

',ret:'un pointeur sur un objet `YRefFrame`, correspondant au premier r\xE9f\xE9rentiel accessible en ligne, ou `null` si il n\x27y a pas de r\xE9f\xE9rentiels disponibles.'}; doc['RefFrame']['cancel3DCalibration']={syn:'Annule la calibration tridimensionnelle en cours, et r\xE9tabli les r\xE9glages normaux.',lib:'refframe.cancel3DCalibration()',pro:'function cancel3DCalibration()',cmt:'

Annule la calibration tridimensionnelle en cours, et r\xE9tabli les r\xE9glages normaux. En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.

'}; doc['RefFrame']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du r\xE9f\xE9rentiel au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'refframe.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du r\xE9f\xE9rentiel 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\xE9f\xE9rentiel (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['RefFrame']['get_3DCalibrationHint']={syn:'Retourne les instructions \xE0 suivre pour proc\xE9der \xE0 la calibration tridimensionnelle initi\xE9e avec la m\xE9thode `start3DCalibration`.',lib:'refframe.get_3DCalibrationHint()',pro:'function get_3DCalibrationHint()',cmt:'

Retourne les instructions \xE0 suivre pour proc\xE9der \xE0 la calibration tridimensionnelle initi\xE9e avec la m\xE9thode `start3DCalibration`.

',ret:'une cha\xEEne de caract\xE8res.'}; doc['RefFrame']['get_3DCalibrationLogMsg']={syn:'Retourne le dernier message de log produit par le processus de calibration.',lib:'refframe.get_3DCalibrationLogMsg()',pro:'function get_3DCalibrationLogMsg()',cmt:'

Retourne le dernier message de log produit par le processus de calibration. Si aucun nouveau message n\x27est disponible, retourne une cha\xEEne vide.

',ret:'une cha\xEEne de caract\xE8res.'}; doc['RefFrame']['get_3DCalibrationProgress']={syn:'Retourne l\x27avancement global du processus de calibration tridimensionnelle initi\xE9 avec la m\xE9thode `start3DCalibration`.',lib:'refframe.get_3DCalibrationProgress()',pro:'function get_3DCalibrationProgress()',cmt:'

Retourne l\x27avancement global du processus de calibration tridimensionnelle initi\xE9 avec la m\xE9thode `start3DCalibration`.

',ret:'une nombre entier entre 0 (pas commenc\xE9) et 100 (termin\xE9).'}; doc['RefFrame']['get_3DCalibrationStage']={syn:'Retourne l\x27index de l\x27\xE9tape courante de la calibration initi\xE9e avec la m\xE9thode `start3DCalibration`.',lib:'refframe.get_3DCalibrationStage()',pro:'function get_3DCalibrationStage()',cmt:'

Retourne l\x27index de l\x27\xE9tape courante de la calibration initi\xE9e avec la m\xE9thode `start3DCalibration`.

',ret:'une nombre entier, croissant au fur et \xE0 mesure de la compl\xE9tion des \xE9tapes.'}; doc['RefFrame']['get_3DCalibrationStageProgress']={syn:'Retourne l\x27avancement de l\x27\xE9tape courante de la calibration initi\xE9e avec la m\xE9thode `start3DCalibration`.',lib:'refframe.get_3DCalibrationStageProgress()',pro:'function get_3DCalibrationStageProgress()',cmt:'

Retourne l\x27avancement de l\x27\xE9tape courante de la calibration initi\xE9e avec la m\xE9thode `start3DCalibration`.

',ret:'une nombre entier entre 0 (pas commenc\xE9) et 100 (termin\xE9).'}; doc['RefFrame']['get_advertisedValue']={syn:'Retourne la valeur courante du r\xE9f\xE9rentiel (pas plus de 6 caract\xE8res).',lib:'refframe.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du r\xE9f\xE9rentiel (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['RefFrame']['get_bearing']={syn:'Retourne le cap de r\xE9f\xE9rence utilis\xE9 par le compas.',lib:'refframe.get_bearing()',pro:'function get_bearing()',cmt:'

Retourne le cap de r\xE9f\xE9rence utilis\xE9 par le compas. Le cap relatif indiqu\xE9 par le compas est la diff\xE9rence entre le Nord magn\xE9tique mesur\xE9 et le cap de r\xE9f\xE9rence sp\xE9cifi\xE9 ici.

',ret:'une valeur numérique représentant le cap de r\xE9f\xE9rence utilis\xE9 par le compas',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_BEARING_INVALID`.'}; doc['RefFrame']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9f\xE9rentiel.',lib:'refframe.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9f\xE9rentiel. 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\xE9f\xE9rentiel.'}; doc['RefFrame']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du r\xE9f\xE9rentiel.',lib:'refframe.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\xE9f\xE9rentiel. 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\xE9f\xE9rentiel.'}; doc['RefFrame']['get_friendlyName']={syn:'Retourne un identifiant global du r\xE9f\xE9rentiel au format `NOM_MODULE.NOM_FONCTION`.',lib:'refframe.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le r\xE9f\xE9rentiel en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['RefFrame']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'refframe.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['RefFrame']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du r\xE9f\xE9rentiel, sans r\xE9f\xE9rence au module.',lib:'refframe.get_functionId()',pro:'function get_functionId()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le r\xE9f\xE9rentiel (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['RefFrame']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du r\xE9f\xE9rentiel au format `SERIAL.FUNCTIONID`.',lib:'refframe.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du r\xE9f\xE9rentiel 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\xE9f\xE9rentiel (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le r\xE9f\xE9rentiel (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['RefFrame']['get_logicalName']={syn:'Retourne le nom logique du r\xE9f\xE9rentiel.',lib:'refframe.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du r\xE9f\xE9rentiel.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du r\xE9f\xE9rentiel.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['RefFrame']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'refframe.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['RefFrame']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'refframe.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['RefFrame']['get_mountOrientation']={syn:'Retourne l\x27orientation \xE0 l\x27installation du module, telle que configur\xE9e afin de d\xE9finir le r\xE9f\xE9rentiel de la boussole et des inclinom\xE8tres.',lib:'refframe.get_mountOrientation()',pro:'function get_mountOrientation()',cmt:'

Retourne l\x27orientation \xE0 l\x27installation du module, telle que configur\xE9e afin de d\xE9finir le r\xE9f\xE9rentiel de la boussole et des inclinom\xE8tres.

',ret:'une valeur parmi l\x27\xE9num\xE9ration `Y_MOUNTORIENTATION` (`Y_MOUNTORIENTATION_TWELVE`, `Y_MOUNTORIENTATION_THREE`, `Y_MOUNTORIENTATION_SIX`, `Y_MOUNTORIENTATION_NINE`) correspondant \xE0 la l\x27orientation de la fl\xE8che \x22X\x22 sur le module par rapport \xE0 un cadran d\x27horloge vu par un observateur au centre de la bo\xEEte. Sur la face BOTTOM le 12h pointe vers l\x27avant, tandis que sur la face TOP le 12h pointe vers l\x27arri\xE8re.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['RefFrame']['get_mountPosition']={syn:'Retourne la position d\x27installation du module, telle que configur\xE9e afin de d\xE9finir le r\xE9f\xE9rentiel de la boussole et des inclinom\xE8tres.',lib:'refframe.get_mountPosition()',pro:'function get_mountPosition()',cmt:'

Retourne la position d\x27installation du module, telle que configur\xE9e afin de d\xE9finir le r\xE9f\xE9rentiel de la boussole et des inclinom\xE8tres.

',ret:'une valeur parmi l\x27\xE9num\xE9ration `Y_MOUNTPOSITION` (`Y_MOUNTPOSITION_BOTTOM`, `Y_MOUNTPOSITION_TOP`, `Y_MOUNTPOSITION_FRONT`, `Y_MOUNTPOSITION_RIGHT`, `Y_MOUNTPOSITION_REAR`, `Y_MOUNTPOSITION_LEFT`), correspondant \xE0 l\x27installation dans une bo\xEEte, sur l\x27une des six faces',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['RefFrame']['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:'refframe.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['RefFrame']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le r\xE9f\xE9rentiel est joignable, sans d\xE9clencher d\x27erreur.',lib:'refframe.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le r\xE9f\xE9rentiel est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du r\xE9f\xE9rentiel 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\xE9f\xE9rentiel est joignable, `false` sinon'}; doc['RefFrame']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le r\xE9f\xE9rentiel est joignable, sans d\xE9clencher d\x27erreur.',lib:'refframe.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le r\xE9f\xE9rentiel est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du r\xE9f\xE9rentiel 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.'}; doc['RefFrame']['load']={syn:'Met en cache les valeurs courantes du r\xE9f\xE9rentiel, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'refframe.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du r\xE9f\xE9rentiel, 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.'}; doc['RefFrame']['load_async']={syn:'Met en cache les valeurs courantes du r\xE9f\xE9rentiel, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'refframe.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du r\xE9f\xE9rentiel, 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.'}; doc['RefFrame']['more3DCalibration']={syn:'Continue le processus de calibration tridimensionnelle des capteurs initi\xE9 avec la m\xE9thode `start3DCalibration`.',lib:'refframe.more3DCalibration()',pro:'function more3DCalibration()',cmt:'

Continue le processus de calibration tridimensionnelle des capteurs initi\xE9 avec la m\xE9thode `start3DCalibration`. Cette m\xE9thode doit \xEAtre appel\xE9e environ 5 fois par secondes apr\xE8s avoir positionn\xE9 le module selon les instructions fournies par la m\xE9thode `get_3DCalibrationHint` (les instructions changent pendant la proc\xE9dure de calibration). En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.

'}; doc['RefFrame']['nextRefFrame']={syn:'Continue l\x27\xE9num\xE9ration des r\xE9f\xE9rentiels commenc\xE9e \xE0 l\x27aide de `yFirstRefFrame()`.',lib:'refframe.nextRefFrame()',pro:'function nextRefFrame()',cmt:'

Continue l\x27\xE9num\xE9ration des r\xE9f\xE9rentiels commenc\xE9e \xE0 l\x27aide de `yFirstRefFrame()`.

',ret:'un pointeur sur un objet `YRefFrame` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['RefFrame']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'refframe.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['RefFrame']['save3DCalibration']={syn:'Applique les param\xE8tres de calibration tridimensionnelle pr\xE9c\xE9demment calcul\xE9s.',lib:'refframe.save3DCalibration()',pro:'function save3DCalibration()',cmt:'

Applique les param\xE8tres de calibration tridimensionnelle pr\xE9c\xE9demment calcul\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9 apr\xE8s le red\xE9marrage du module. En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.

'}; doc['RefFrame']['set_bearing']={syn:'Modifie le cap de r\xE9f\xE9rence utilis\xE9 par le compas.',lib:'refframe.set_bearing()',pro:'function set_bearing(newval)',cmt:'

Modifie le cap de r\xE9f\xE9rence utilis\xE9 par le compas. Le cap relatif indiqu\xE9 par le compas est la diff\xE9rence entre le Nord magn\xE9tique mesur\xE9 et le cap de r\xE9f\xE9rence sp\xE9cifi\xE9 ici. Par exemple, si vous indiquez comme cap de r\xE9f\xE9rence la valeur de la d\xE9clinaison magn\xE9tique terrestre, le compas donnera l\x27orientation par rapport au Nord g\xE9ographique. De m\xEAme, si le capteur n\x27est pas positionn\xE9 dans une des directions standard \xE0 cause d\x27un angle de lacet suppl\xE9mentaire, vous pouvez le configurer comme cap de r\xE9f\xE9rence afin que le compas donne la direction naturelle attendue.

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 cap de r\xE9f\xE9rence utilis\xE9 par le compas'},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.'}; doc['RefFrame']['set_logicalName']={syn:'Modifie le nom logique du r\xE9f\xE9rentiel.',lib:'refframe.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du r\xE9f\xE9rentiel. 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\xE9f\xE9rentiel.'},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.'}; doc['RefFrame']['set_mountPosition']={syn:'Modifie le r\xE9f\xE9rentiel de la boussole et des inclinom\xE8tres.',lib:'refframe.set_mountPosition()',pro:'function set_mountPosition(position, orientation)',cmt:'

Modifie le r\xE9f\xE9rentiel de la boussole et des inclinom\xE8tres. La boussole magn\xE9tique et les inclinom\xE8tres gravitationnels fonctionnent par rapport au plan parall\xE8le \xE0 la surface terrestre. Dans les cas o\xC3\xB9 le module n\x27est pas utilis\xE9 horizontalement et \xE0 l\x27endroit, il faut indiquer son orientation de r\xE9f\xE9rence (parall\xE8le \xE0 la surface terrestre) afin que les mesures soient faites relativement \xE0 cette position.

',par:{position:'une valeur parmi l\x27\xE9num\xE9ration `Y_MOUNTPOSITION` (`Y_MOUNTPOSITION_BOTTOM`, `Y_MOUNTPOSITION_TOP`, `Y_MOUNTPOSITION_FRONT`, `Y_MOUNTPOSITION_RIGHT`, `Y_MOUNTPOSITION_REAR`, `Y_MOUNTPOSITION_LEFT`), correspondant \xE0 l\x27installation dans une bo\xEEte, sur l\x27une des six faces.',orientation:'une valeur parmi l\x27\xE9num\xE9ration `Y_MOUNTORIENTATION` (`Y_MOUNTORIENTATION_TWELVE`, `Y_MOUNTORIENTATION_THREE`, `Y_MOUNTORIENTATION_SIX`, `Y_MOUNTORIENTATION_NINE`) correspondant \xE0 la l\x27orientation de la fl\xE8che \x22X\x22 sur le module par rapport \xE0 un cadran d\x27horloge vu par un observateur au centre de la bo\xEEte. Sur la face BOTTOM le 12h pointe vers l\x27avant, tandis que sur la face TOP le 12h pointe vers l\x27arri\xE8re. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.'}}; doc['RefFrame']['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:'refframe.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['RefFrame']['start3DCalibration']={syn:'Initie le processus de calibration tridimensionnelle des capteurs.',lib:'refframe.start3DCalibration()',pro:'function start3DCalibration()',cmt:'

Initie le processus de calibration tridimensionnelle des capteurs. Cette calibration est utilis\xE9e \xE0 bas niveau pour l\x27estimation innertielle de position et pour am\xE9liorer la pr\xE9cision des mesures d\x27inclinaison. Apr\xE8s avoir appel\xE9 cette m\xE9thode, il faut positionner le module selon les instructions fournies par la m\xE9thode `get_3DCalibrationHint` et appeler `more3DCalibration` environ 5 fois par secondes. La proc\xE9dure de calibration est termin\xE9e lorsque la m\xE9thode `get_3DCalibrationProgress` retourne 100. Il est alors possible d\x27appliquer les param\xE8tres calcul\xE9s, \xE0 l\x27aide de la m\xE9thode `save3DCalibration`. A tout moment, la calibration peut \xEAtre abandonn\xE9e \xE0 l\x27aide de `cancel3DCalibration`. En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.

'}; doc['RefFrame']['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:'refframe.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 machine virtuelle 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: RefFrame) //--- (generated code: Compass) doc['Compass']={'':{syn:'Interface de la fonction Compass',inc:'<script type='text/javascript' src='yocto_compass.js'></script>',cmt:'

La classe YSensor est la classe parente de tous les senseurs Yoctopuce. Elle permet de lire la valeur courante et l\x27unit\xE9 de n\x27importe quel capteur, de lire les valeurs min/max, de configurer la fr\xE9quence d\x27enregistrement autonome des donn\xE9es et de r\xE9cup\xE9rer les mesures enregistr\xE9es. Elle permet aussi d\x27enregistrer un callback appel\xE9 lorsque la valeur mesur\xE9e change ou \xE0 intervalle pr\xE9d\xE9fini. L\x27utilisation de cette classe plut\xF4t qu\x27une de ces sous-classes permet de cr\xE9er des application g\xE9n\xE9riques, compatibles m\xEAme avec les capteurs Yoctopuce futurs. Note: la classe YAnButton est le seul type d\x27entr\xE9e analogique qui n\x27h\xE9rite pas de YSensor.

'}}; doc['Compass']['FindCompass']={syn:'Permet de retrouver un compas d\x27apr\xE8s un identifiant donn\xE9.',lib:'YCompass.FindCompass()',pro:'function FindCompass(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le compas soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YCompass.isOnline()` pour tester si le compas 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 le compas sans ambigu\xEFt\xE9'},ret:'un objet de classe `YCompass` qui permet ensuite de contr\xF4ler le compas.'}; doc['Compass']['FirstCompass']={syn:'Commence l\x27\xE9num\xE9ration des compas accessibles par la librairie.',lib:'YCompass.FirstCompass()',pro:'function FirstCompass()',cmt:'

Commence l\x27\xE9num\xE9ration des compas accessibles par la librairie. Utiliser la fonction `YCompass.nextCompass()` pour it\xE9rer sur les autres compas.

',ret:'un pointeur sur un objet `YCompass`, correspondant au premier compas accessible en ligne, ou `null` si il n\x27y a pas de compas disponibles.'}; doc['Compass']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'compass.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Compass']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du compas au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'compass.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du compas 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 compas (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Compass']['get_advertisedValue']={syn:'Retourne la valeur courante du compas (pas plus de 6 caract\xE8res).',lib:'compass.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du compas (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Compass']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en degr\xE9s, sous forme de nombre \xE0 virgule.',lib:'compass.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en degr\xE9s, 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 degr\xE9s, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Compass']['get_currentValue']={syn:'Retourne la valeur actuelle du cap relatif, en degr\xE9s, sous forme de nombre \xE0 virgule.',lib:'compass.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle du cap relatif, en degr\xE9s, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle du cap relatif, en degr\xE9s, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Compass']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du compas.',lib:'compass.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du compas. 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 compas.'}; doc['Compass']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du compas.',lib:'compass.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du compas. 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 compas.'}; doc['Compass']['get_friendlyName']={syn:'Retourne un identifiant global du compas au format `NOM_MODULE.NOM_FONCTION`.',lib:'compass.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le compas en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Compass']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'compass.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Compass']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du compas, sans r\xE9f\xE9rence au module.',lib:'compass.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du compas 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 compas (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le compas (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Compass']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour le cap relatif depuis le d\xE9marrage du module.',lib:'compass.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour le cap relatif depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour le cap relatif depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Compass']['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:'compass.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Compass']['get_logicalName']={syn:'Retourne le nom logique du compas.',lib:'compass.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du compas.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du compas.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Compass']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour le cap relatif depuis le d\xE9marrage du module.',lib:'compass.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour le cap relatif depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour le cap relatif depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Compass']['get_magneticHeading']={syn:'Retourne la direction du nord magn\xE9tique, ind\xE9pendemment du cap configur\xE9.',lib:'compass.get_magneticHeading()',pro:'function get_magneticHeading()',cmt:'

Retourne la direction du nord magn\xE9tique, ind\xE9pendemment du cap configur\xE9.

',ret:'une valeur numérique représentant la direction du nord magn\xE9tique, ind\xE9pendemment du cap configur\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_MAGNETICHEADING_INVALID`.'}; doc['Compass']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'compass.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['Compass']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'compass.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['Compass']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'compass.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Compass']['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:'compass.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Compass']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'compass.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Compass']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle le cap relatif est exprim\xE9e.',lib:'compass.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle le cap relatif est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle le cap relatif est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Compass']['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:'compass.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['Compass']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le compas est joignable, sans d\xE9clencher d\x27erreur.',lib:'compass.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le compas est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du compas 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 compas est joignable, `false` sinon'}; doc['Compass']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le compas est joignable, sans d\xE9clencher d\x27erreur.',lib:'compass.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le compas est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du compas 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.'}; doc['Compass']['load']={syn:'Met en cache les valeurs courantes du compas, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'compass.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du compas, 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.'}; doc['Compass']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'compass.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Compass']['load_async']={syn:'Met en cache les valeurs courantes du compas, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'compass.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du compas, 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.'}; doc['Compass']['nextCompass']={syn:'Continue l\x27\xE9num\xE9ration des compas commenc\xE9e \xE0 l\x27aide de `yFirstCompass()`.',lib:'compass.nextCompass()',pro:'function nextCompass()',cmt:'

Continue l\x27\xE9num\xE9ration des compas commenc\xE9e \xE0 l\x27aide de `yFirstCompass()`.

',ret:'un pointeur sur un objet `YCompass` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Compass']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'compass.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Compass']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'compass.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['Compass']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'compass.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Compass']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'compass.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Compass']['set_logicalName']={syn:'Modifie le nom logique du compas.',lib:'compass.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du compas. 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 compas.'},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.'}; doc['Compass']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'compass.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Compass']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'compass.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Compass']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'compass.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Compass']['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:'compass.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['Compass']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'compass.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Compass']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'compass.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Compass']['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:'compass.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 machine virtuelle 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: Compass) //--- (generated code: Gyro) doc['Gyro']={'':{syn:'Interface de la fonction Gyro',inc:'<script type='text/javascript' src='yocto_gyro.js'></script>',cmt:'

La classe YSensor est la classe parente de tous les senseurs Yoctopuce. Elle permet de lire la valeur courante et l\x27unit\xE9 de n\x27importe quel capteur, de lire les valeurs min/max, de configurer la fr\xE9quence d\x27enregistrement autonome des donn\xE9es et de r\xE9cup\xE9rer les mesures enregistr\xE9es. Elle permet aussi d\x27enregistrer un callback appel\xE9 lorsque la valeur mesur\xE9e change ou \xE0 intervalle pr\xE9d\xE9fini. L\x27utilisation de cette classe plut\xF4t qu\x27une de ces sous-classes permet de cr\xE9er des application g\xE9n\xE9riques, compatibles m\xEAme avec les capteurs Yoctopuce futurs. Note: la classe YAnButton est le seul type d\x27entr\xE9e analogique qui n\x27h\xE9rite pas de YSensor.

'}}; doc['Gyro']['FindGyro']={syn:'Permet de retrouver un gyroscope d\x27apr\xE8s un identifiant donn\xE9.',lib:'YGyro.FindGyro()',pro:'function FindGyro(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le gyroscope soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YGyro.isOnline()` pour tester si le gyroscope 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 le gyroscope sans ambigu\xEFt\xE9'},ret:'un objet de classe `YGyro` qui permet ensuite de contr\xF4ler le gyroscope.'}; doc['Gyro']['FirstGyro']={syn:'Commence l\x27\xE9num\xE9ration des gyroscopes accessibles par la librairie.',lib:'YGyro.FirstGyro()',pro:'function FirstGyro()',cmt:'

Commence l\x27\xE9num\xE9ration des gyroscopes accessibles par la librairie. Utiliser la fonction `YGyro.nextGyro()` pour it\xE9rer sur les autres gyroscopes.

',ret:'un pointeur sur un objet `YGyro`, correspondant au premier gyroscope accessible en ligne, ou `null` si il n\x27y a pas de gyroscopes disponibles.'}; doc['Gyro']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'gyro.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Gyro']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du gyroscope au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'gyro.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du gyroscope 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 gyroscope (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Gyro']['get_advertisedValue']={syn:'Retourne la valeur courante du gyroscope (pas plus de 6 caract\xE8res).',lib:'gyro.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du gyroscope (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Gyro']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en degr\xE9s par seconde, sous forme de nombre \xE0 virgule.',lib:'gyro.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en degr\xE9s par seconde, 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 degr\xE9s par seconde, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Gyro']['get_currentValue']={syn:'Retourne la valeur actuelle de la vitesse angulaire, en degr\xE9s par seconde, sous forme de nombre \xE0 virgule.',lib:'gyro.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la vitesse angulaire, en degr\xE9s par seconde, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de la vitesse angulaire, en degr\xE9s par seconde, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Gyro']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du gyroscope.',lib:'gyro.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du gyroscope. 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 gyroscope.'}; doc['Gyro']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du gyroscope.',lib:'gyro.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du gyroscope. 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 gyroscope.'}; doc['Gyro']['get_friendlyName']={syn:'Retourne un identifiant global du gyroscope au format `NOM_MODULE.NOM_FONCTION`.',lib:'gyro.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le gyroscope en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Gyro']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'gyro.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Gyro']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du gyroscope, sans r\xE9f\xE9rence au module.',lib:'gyro.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du gyroscope 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 gyroscope (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le gyroscope (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Gyro']['get_heading']={syn:'Retourne une estimation du cap (angle de lacet), bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.',lib:'gyro.get_heading()',pro:'function get_heading()',cmt:'

Retourne une estimation du cap (angle de lacet), bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique. L\x27axe de lacet peut \xEAtre attribu\xE9 \xE0 n\x27importe laquelle des direction physiques X, Y ou Z du module \xE0 l\x27aide des m\xE9thodes de la classe `YRefFrame`.

',ret:'un nombre \xE0 virgule correspondant au cap, exprim\xE9 en degr\xE9s (entre 0 et 360).'}; doc['Gyro']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la vitesse angulaire depuis le d\xE9marrage du module.',lib:'gyro.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la vitesse angulaire depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la vitesse angulaire depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Gyro']['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:'gyro.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Gyro']['get_logicalName']={syn:'Retourne le nom logique du gyroscope.',lib:'gyro.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du gyroscope.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du gyroscope.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Gyro']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la vitesse angulaire depuis le d\xE9marrage du module.',lib:'gyro.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la vitesse angulaire depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la vitesse angulaire depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Gyro']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'gyro.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['Gyro']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'gyro.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['Gyro']['get_pitch']={syn:'Retourne une estimation de l\x27assiette (angle de tangage), bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.',lib:'gyro.get_pitch()',pro:'function get_pitch()',cmt:'

Retourne une estimation de l\x27assiette (angle de tangage), bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique. L\x27axe de tangage peut \xEAtre attribu\xE9 \xE0 n\x27importe laquelle des direction physiques X, Y ou Z du module \xE0 l\x27aide des m\xE9thodes de la classe `YRefFrame`.

',ret:'un nombre \xE0 virgule correspondant \xE0 l\x27assiette, exprim\xE9e en degr\xE9s (entre -90 et +90).'}; doc['Gyro']['get_quaternionW']={syn:'Retourne la composante `w` (composante r\xE9elle) du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.',lib:'gyro.get_quaternionW()',pro:'function get_quaternionW()',cmt:'

Retourne la composante `w` (composante r\xE9elle) du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.

',ret:'un nombre \xE0 virgule correspondant \xE0 la composante `w` du quaternion.'}; doc['Gyro']['get_quaternionX']={syn:'Retourne la composante `x` du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.',lib:'gyro.get_quaternionX()',pro:'function get_quaternionX()',cmt:'

Retourne la composante `x` du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique. La composante `x` est essentiellement corr\xE9l\xE9e aux rotations sur l\x27axe de roulis.

',ret:'un nombre \xE0 virgule correspondant \xE0 la composante `x` du quaternion.'}; doc['Gyro']['get_quaternionY']={syn:'Retourne la composante `y` du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.',lib:'gyro.get_quaternionY()',pro:'function get_quaternionY()',cmt:'

Retourne la composante `y` du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique. La composante `y` est essentiellement corr\xE9l\xE9e aux rotations sur l\x27axe de tangage.

',ret:'un nombre \xE0 virgule correspondant \xE0 la composante `y` du quaternion.'}; doc['Gyro']['get_quaternionZ']={syn:'Retourne la composante `z` du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.',lib:'gyro.get_quaternionZ()',pro:'function get_quaternionZ()',cmt:'

Retourne la composante `z` du quaternion d\xE9crivant l\x27orientation estimat\xE9e du module, bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique. La composante `z` est essentiellement corr\xE9l\xE9e aux rotations sur l\x27axe de lacet.

',ret:'un nombre \xE0 virgule correspondant \xE0 la composante `z` du quaternion.'}; doc['Gyro']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'gyro.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Gyro']['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:'gyro.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Gyro']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'gyro.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Gyro']['get_roll']={syn:'Retourne une estimation de l\x27inclinaison (angle de roulis), bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique.',lib:'gyro.get_roll()',pro:'function get_roll()',cmt:'

Retourne une estimation de l\x27inclinaison (angle de roulis), bas\xE9e sur l\x27int\xE9gration de mesures gyroscopiques combin\xE9e \xE0 des mesures statiques d\x27acc\xE9l\xE9ration et de champ magn\xE9tique. L\x27axe de roulis peut \xEAtre attribu\xE9 \xE0 n\x27importe laquelle des direction physiques X, Y ou Z du module \xE0 l\x27aide des m\xE9thodes de la classe `YRefFrame`.

',ret:'un nombre \xE0 virgule correspondant \xE0 l\x27inclinaison, exprim\xE9e en degr\xE9s (entre -180 et +180).'}; doc['Gyro']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la vitesse angulaire est exprim\xE9e.',lib:'gyro.get_unit()',pro:'function get_unit()',cmt:'

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

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la vitesse angulaire est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Gyro']['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:'gyro.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['Gyro']['get_xValue']={syn:'Retourne la vitesse angulaire autour de l\x27axe X du module, sous forme de nombre \xE0 virgule.',lib:'gyro.get_xValue()',pro:'function get_xValue()',cmt:'

Retourne la vitesse angulaire autour de l\x27axe X du module, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la vitesse angulaire autour de l\x27axe X du module, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_XVALUE_INVALID`.'}; doc['Gyro']['get_yValue']={syn:'Retourne la vitesse angulaire autour de l\x27axe Y du module, sous forme de nombre \xE0 virgule.',lib:'gyro.get_yValue()',pro:'function get_yValue()',cmt:'

Retourne la vitesse angulaire autour de l\x27axe Y du module, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la vitesse angulaire autour de l\x27axe Y du module, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_YVALUE_INVALID`.'}; doc['Gyro']['get_zValue']={syn:'Retourne la vitesse angulaire autour de l\x27axe Z du module, sous forme de nombre \xE0 virgule.',lib:'gyro.get_zValue()',pro:'function get_zValue()',cmt:'

Retourne la vitesse angulaire autour de l\x27axe Z du module, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la vitesse angulaire autour de l\x27axe Z du module, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ZVALUE_INVALID`.'}; doc['Gyro']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le gyroscope est joignable, sans d\xE9clencher d\x27erreur.',lib:'gyro.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le gyroscope est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du gyroscope 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 gyroscope est joignable, `false` sinon'}; doc['Gyro']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le gyroscope est joignable, sans d\xE9clencher d\x27erreur.',lib:'gyro.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le gyroscope est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du gyroscope 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.'}; doc['Gyro']['load']={syn:'Met en cache les valeurs courantes du gyroscope, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'gyro.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du gyroscope, 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.'}; doc['Gyro']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'gyro.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Gyro']['load_async']={syn:'Met en cache les valeurs courantes du gyroscope, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'gyro.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du gyroscope, 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.'}; doc['Gyro']['nextGyro']={syn:'Continue l\x27\xE9num\xE9ration des gyroscopes commenc\xE9e \xE0 l\x27aide de `yFirstGyro()`.',lib:'gyro.nextGyro()',pro:'function nextGyro()',cmt:'

Continue l\x27\xE9num\xE9ration des gyroscopes commenc\xE9e \xE0 l\x27aide de `yFirstGyro()`.

',ret:'un pointeur sur un objet `YGyro` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Gyro']['registerAnglesCallback']={syn:'Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque changement de l\x27estimation de l\x27orientation du module.',lib:'gyro.registerAnglesCallback()',pro:'function registerAnglesCallback(callback)',cmt:'

Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque changement de l\x27estimation de l\x27orientation du module. La fr\xE9quence d\x27appel est typiquement de 95Hz durant un mouvement. Ce callback n\x27est appel\xE9 que durant l\x27ex\xE9cution de `ySleep` ou `yHandleEvents`. Cela permet \xE0 l\x27appelant de contr\xF4ler quand le callback peut se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que le callback ne soit pas appel\xE9s trop tard. Pour d\xE9sactiver le 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 quatre arguments: l\x27objet YGyro du module qui a tourn\xE9, et les valeurs des trois angles roll, pitch et heading en degr\xE9s (nombres \xE0 virgules).'}}; doc['Gyro']['registerQuaternionCallback']={syn:'Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque changement de l\x27estimation de l\x27orientation du module.',lib:'gyro.registerQuaternionCallback()',pro:'function registerQuaternionCallback(callback)',cmt:'

Enregistre une fonction de callback qui sera appel\xE9e \xE0 chaque changement de l\x27estimation de l\x27orientation du module. La fr\xE9quence d\x27appel est typiquement de 95Hz durant un mouvement. Ce callback n\x27est appel\xE9 que durant l\x27ex\xE9cution de `ySleep` ou `yHandleEvents`. Cela permet \xE0 l\x27appelant de contr\xF4ler quand le callback peut se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que le callback ne soit pas appel\xE9s trop tard. Pour d\xE9sactiver le 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 cinq arguments: l\x27objet YGyro du module qui a tourn\xE9, et les valeurs des quatre composantes w, x, y et z du quaternion (nombres \xE0 virgules).'}}; doc['Gyro']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'gyro.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Gyro']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'gyro.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['Gyro']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'gyro.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Gyro']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'gyro.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Gyro']['set_logicalName']={syn:'Modifie le nom logique du gyroscope.',lib:'gyro.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du gyroscope. 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 gyroscope.'},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.'}; doc['Gyro']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'gyro.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Gyro']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'gyro.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Gyro']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'gyro.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Gyro']['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:'gyro.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['Gyro']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'gyro.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Gyro']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'gyro.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Gyro']['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:'gyro.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 machine virtuelle 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: Gyro) //--- (generated code: Tilt) doc['Tilt']={'':{syn:'Interface de la fonction Tilt',inc:'<script type='text/javascript' src='yocto_tilt.js'></script>',cmt:'

La classe YSensor est la classe parente de tous les senseurs Yoctopuce. Elle permet de lire la valeur courante et l\x27unit\xE9 de n\x27importe quel capteur, de lire les valeurs min/max, de configurer la fr\xE9quence d\x27enregistrement autonome des donn\xE9es et de r\xE9cup\xE9rer les mesures enregistr\xE9es. Elle permet aussi d\x27enregistrer un callback appel\xE9 lorsque la valeur mesur\xE9e change ou \xE0 intervalle pr\xE9d\xE9fini. L\x27utilisation de cette classe plut\xF4t qu\x27une de ces sous-classes permet de cr\xE9er des application g\xE9n\xE9riques, compatibles m\xEAme avec les capteurs Yoctopuce futurs. Note: la classe YAnButton est le seul type d\x27entr\xE9e analogique qui n\x27h\xE9rite pas de YSensor.

'}}; doc['Tilt']['FindTilt']={syn:'Permet de retrouver un inclinom\xE8tre d\x27apr\xE8s un identifiant donn\xE9.',lib:'YTilt.FindTilt()',pro:'function FindTilt(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27inclinom\xE8tre soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YTilt.isOnline()` pour tester si l\x27inclinom\xE8tre 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 l\x27inclinom\xE8tre sans ambigu\xEFt\xE9'},ret:'un objet de classe `YTilt` qui permet ensuite de contr\xF4ler l\x27inclinom\xE8tre.'}; doc['Tilt']['FirstTilt']={syn:'Commence l\x27\xE9num\xE9ration des inclinom\xE8tres accessibles par la librairie.',lib:'YTilt.FirstTilt()',pro:'function FirstTilt()',cmt:'

Commence l\x27\xE9num\xE9ration des inclinom\xE8tres accessibles par la librairie. Utiliser la fonction `YTilt.nextTilt()` pour it\xE9rer sur les autres inclinom\xE8tres.

',ret:'un pointeur sur un objet `YTilt`, correspondant au premier inclinom\xE8tre accessible en ligne, ou `null` si il n\x27y a pas de inclinom\xE8tres disponibles.'}; doc['Tilt']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'tilt.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Tilt']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27inclinom\xE8tre au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'tilt.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27inclinom\xE8tre 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\x27inclinom\xE8tre (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Tilt']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27inclinom\xE8tre (pas plus de 6 caract\xE8res).',lib:'tilt.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27inclinom\xE8tre (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27inclinom\xE8tre (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Tilt']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en degr\xE9s, sous forme de nombre \xE0 virgule.',lib:'tilt.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en degr\xE9s, 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 degr\xE9s, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Tilt']['get_currentValue']={syn:'Retourne la valeur actuelle de l\x27inclinaison, en degr\xE9s, sous forme de nombre \xE0 virgule.',lib:'tilt.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de l\x27inclinaison, en degr\xE9s, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de l\x27inclinaison, en degr\xE9s, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Tilt']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27inclinom\xE8tre.',lib:'tilt.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27inclinom\xE8tre. 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\x27inclinom\xE8tre.'}; doc['Tilt']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27inclinom\xE8tre.',lib:'tilt.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\x27inclinom\xE8tre. 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\x27inclinom\xE8tre.'}; doc['Tilt']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27inclinom\xE8tre au format `NOM_MODULE.NOM_FONCTION`.',lib:'tilt.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27inclinom\xE8tre en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Tilt']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'tilt.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Tilt']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27inclinom\xE8tre, sans r\xE9f\xE9rence au module.',lib:'tilt.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de l\x27inclinom\xE8tre, sans r\xE9f\xE9rence au module. Par example `relay1`.

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27inclinom\xE8tre 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\x27inclinom\xE8tre (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27inclinom\xE8tre (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Tilt']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour l\x27inclinaison depuis le d\xE9marrage du module.',lib:'tilt.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour l\x27inclinaison depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour l\x27inclinaison depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Tilt']['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:'tilt.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Tilt']['get_logicalName']={syn:'Retourne le nom logique de l\x27inclinom\xE8tre.',lib:'tilt.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27inclinom\xE8tre.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27inclinom\xE8tre.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Tilt']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour l\x27inclinaison depuis le d\xE9marrage du module.',lib:'tilt.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour l\x27inclinaison depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour l\x27inclinaison depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Tilt']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'tilt.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['Tilt']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'tilt.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['Tilt']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'tilt.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Tilt']['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:'tilt.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Tilt']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'tilt.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Tilt']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle l\x27inclinaison est exprim\xE9e.',lib:'tilt.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle l\x27inclinaison est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle l\x27inclinaison est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Tilt']['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:'tilt.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['Tilt']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27inclinom\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'tilt.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27inclinom\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27inclinom\xE8tre 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\x27inclinom\xE8tre est joignable, `false` sinon'}; doc['Tilt']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27inclinom\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'tilt.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27inclinom\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27inclinom\xE8tre 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.'}; doc['Tilt']['load']={syn:'Met en cache les valeurs courantes de l\x27inclinom\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'tilt.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27inclinom\xE8tre, 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.'}; doc['Tilt']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'tilt.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Tilt']['load_async']={syn:'Met en cache les valeurs courantes de l\x27inclinom\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'tilt.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27inclinom\xE8tre, 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.'}; doc['Tilt']['nextTilt']={syn:'Continue l\x27\xE9num\xE9ration des inclinom\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstTilt()`.',lib:'tilt.nextTilt()',pro:'function nextTilt()',cmt:'

Continue l\x27\xE9num\xE9ration des inclinom\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstTilt()`.

',ret:'un pointeur sur un objet `YTilt` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Tilt']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'tilt.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Tilt']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'tilt.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['Tilt']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'tilt.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Tilt']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'tilt.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Tilt']['set_logicalName']={syn:'Modifie le nom logique de l\x27inclinom\xE8tre.',lib:'tilt.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27inclinom\xE8tre. 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\x27inclinom\xE8tre.'},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.'}; doc['Tilt']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'tilt.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Tilt']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'tilt.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Tilt']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'tilt.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Tilt']['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:'tilt.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['Tilt']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'tilt.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Tilt']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'tilt.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Tilt']['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:'tilt.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 machine virtuelle 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: Tilt) //--- (generated code: Qt) doc['Qt']={'':{syn:'Interface du quaternion',inc:'<script type='text/javascript' src='yocto_gyro.js'></script>',cmt:'

La class YQt de la librairie Yoctopuce permet d\x27acc\xE9der \xE0 l\x27estimation de l\x27orientation tridimentionnelle du Yocto-3D sous forme d\x27un quaternion. Il n\x27est en g\xE9n\xE9ral pas n\xE9cessaire d\x27y acc\xE9der directement, la classe YGyro offrant une abstraction de plus haut niveau.

'}}; doc['Qt']['FindQt']={syn:'Permet de retrouver un \xE9l\xE9ment de quaternion d\x27apr\xE8s un identifiant donn\xE9.',lib:'YQt.FindQt()',pro:'function FindQt(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27\xE9l\xE9ment de quaternion soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YQt.isOnline()` pour tester si l\x27\xE9l\xE9ment de quaternion 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 l\x27\xE9l\xE9ment de quaternion sans ambigu\xEFt\xE9'},ret:'un objet de classe `YQt` qui permet ensuite de contr\xF4ler l\x27\xE9l\xE9ment de quaternion.'}; doc['Qt']['FirstQt']={syn:'Commence l\x27\xE9num\xE9ration des \xE9l\xE9ments de quaternion accessibles par la librairie.',lib:'YQt.FirstQt()',pro:'function FirstQt()',cmt:'

Commence l\x27\xE9num\xE9ration des \xE9l\xE9ments de quaternion accessibles par la librairie. Utiliser la fonction `YQt.nextQt()` pour it\xE9rer sur les autres \xE9l\xE9ments de quaternion.

',ret:'un pointeur sur un objet `YQt`, correspondant au premier \xE9l\xE9ment de quaternion accessible en ligne, ou `null` si il n\x27y a pas de \xE9l\xE9ments de quaternion disponibles.'}; doc['Qt']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'qt.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Qt']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27\xE9l\xE9ment de quaternion au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'qt.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27\xE9l\xE9ment de quaternion 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\x27\xE9l\xE9ment de quaternion (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Qt']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27\xE9l\xE9ment de quaternion (pas plus de 6 caract\xE8res).',lib:'qt.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27\xE9l\xE9ment de quaternion (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27\xE9l\xE9ment de quaternion (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Qt']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en unit\xE9s, sous forme de nombre \xE0 virgule.',lib:'qt.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en unit\xE9s, 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 unit\xE9s, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Qt']['get_currentValue']={syn:'Retourne la valeur actuelle de la coordonn\xE9e, en unit\xE9s, sous forme de nombre \xE0 virgule.',lib:'qt.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la coordonn\xE9e, en unit\xE9s, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de la coordonn\xE9e, en unit\xE9s, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Qt']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27\xE9l\xE9ment de quaternion.',lib:'qt.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27\xE9l\xE9ment de quaternion. 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\x27\xE9l\xE9ment de quaternion.'}; doc['Qt']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27\xE9l\xE9ment de quaternion.',lib:'qt.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\x27\xE9l\xE9ment de quaternion. 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\x27\xE9l\xE9ment de quaternion.'}; doc['Qt']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27\xE9l\xE9ment de quaternion au format `NOM_MODULE.NOM_FONCTION`.',lib:'qt.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27\xE9l\xE9ment de quaternion en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Qt']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'qt.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Qt']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27\xE9l\xE9ment de quaternion, sans r\xE9f\xE9rence au module.',lib:'qt.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de l\x27\xE9l\xE9ment de quaternion, sans r\xE9f\xE9rence au module. Par example `relay1`.

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27\xE9l\xE9ment de quaternion 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\x27\xE9l\xE9ment de quaternion (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27\xE9l\xE9ment de quaternion (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Qt']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la coordonn\xE9e depuis le d\xE9marrage du module.',lib:'qt.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la coordonn\xE9e depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la coordonn\xE9e depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Qt']['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:'qt.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Qt']['get_logicalName']={syn:'Retourne le nom logique de l\x27\xE9l\xE9ment de quaternion.',lib:'qt.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27\xE9l\xE9ment de quaternion.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27\xE9l\xE9ment de quaternion.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Qt']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la coordonn\xE9e depuis le d\xE9marrage du module.',lib:'qt.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la coordonn\xE9e depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la coordonn\xE9e depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Qt']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'qt.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['Qt']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'qt.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['Qt']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'qt.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Qt']['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:'qt.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Qt']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'qt.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Qt']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la coordonn\xE9e est exprim\xE9e.',lib:'qt.get_unit()',pro:'function get_unit()',cmt:'

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

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la coordonn\xE9e est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Qt']['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:'qt.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['Qt']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27\xE9l\xE9ment de quaternion est joignable, sans d\xE9clencher d\x27erreur.',lib:'qt.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27\xE9l\xE9ment de quaternion est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27\xE9l\xE9ment de quaternion 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\x27\xE9l\xE9ment de quaternion est joignable, `false` sinon'}; doc['Qt']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27\xE9l\xE9ment de quaternion est joignable, sans d\xE9clencher d\x27erreur.',lib:'qt.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27\xE9l\xE9ment de quaternion est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27\xE9l\xE9ment de quaternion 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.'}; doc['Qt']['load']={syn:'Met en cache les valeurs courantes de l\x27\xE9l\xE9ment de quaternion, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'qt.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27\xE9l\xE9ment de quaternion, 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.'}; doc['Qt']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'qt.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Qt']['load_async']={syn:'Met en cache les valeurs courantes de l\x27\xE9l\xE9ment de quaternion, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'qt.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27\xE9l\xE9ment de quaternion, 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.'}; doc['Qt']['nextQt']={syn:'Continue l\x27\xE9num\xE9ration des \xE9l\xE9ments de quaternion commenc\xE9e \xE0 l\x27aide de `yFirstQt()`.',lib:'qt.nextQt()',pro:'function nextQt()',cmt:'

Continue l\x27\xE9num\xE9ration des \xE9l\xE9ments de quaternion commenc\xE9e \xE0 l\x27aide de `yFirstQt()`.

',ret:'un pointeur sur un objet `YQt` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Qt']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'qt.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Qt']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'qt.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['Qt']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'qt.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Qt']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'qt.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Qt']['set_logicalName']={syn:'Modifie le nom logique de l\x27\xE9l\xE9ment de quaternion.',lib:'qt.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27\xE9l\xE9ment de quaternion. 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\x27\xE9l\xE9ment de quaternion.'},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.'}; doc['Qt']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'qt.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Qt']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'qt.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Qt']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'qt.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Qt']['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:'qt.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['Qt']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'qt.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Qt']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'qt.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Qt']['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:'qt.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 machine virtuelle 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: Qt) //--- (generated code: PwmOutput) doc['PwmOutput']={'':{syn:'Interface de la fonction Pwm',inc:'<script type='text/javascript' src='yocto_pwmoutput.js'></script>',cmt:'

La librairie de programmation Yoctopuce permet simplement de configurer, d\xE9marrer et arr\xEAter le PWM.

'}}; doc['PwmOutput']['FindPwmOutput']={syn:'Permet de retrouver un PWM d\x27apr\xE8s un identifiant donn\xE9.',lib:'YPwmOutput.FindPwmOutput()',pro:'function FindPwmOutput(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le PWM soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YPwmOutput.isOnline()` pour tester si le PWM 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 le PWM sans ambigu\xEFt\xE9'},ret:'un objet de classe `YPwmOutput` qui permet ensuite de contr\xF4ler le PWM.'}; doc['PwmOutput']['FirstPwmOutput']={syn:'Commence l\x27\xE9num\xE9ration des PWM accessibles par la librairie.',lib:'YPwmOutput.FirstPwmOutput()',pro:'function FirstPwmOutput()',cmt:'

Commence l\x27\xE9num\xE9ration des PWM accessibles par la librairie. Utiliser la fonction `YPwmOutput.nextPwmOutput()` pour it\xE9rer sur les autres PWM.

',ret:'un pointeur sur un objet `YPwmOutput`, correspondant au premier PWM accessible en ligne, ou `null` si il n\x27y a pas de PWM disponibles.'}; doc['PwmOutput']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du PWM au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'pwmoutput.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du PWM 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 PWM (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['PwmOutput']['dutyCycleMove']={syn:'D\xE9clenche une variation progressive de la longueur des impulsions vers une valeur donn\xE9e.',lib:'pwmoutput.dutyCycleMove()',pro:'function dutyCycleMove(target, ms_duration)',cmt:'

D\xE9clenche une variation progressive de la longueur des impulsions vers une valeur donn\xE9e.

',par:{target:'nouveau duty cycle \xE0 la fin de la transition (nombre flottant, entre 0 et 1)',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.'}; doc['PwmOutput']['get_advertisedValue']={syn:'Retourne la valeur courante du PWM (pas plus de 6 caract\xE8res).',lib:'pwmoutput.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du PWM (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['PwmOutput']['get_dutyCycle']={syn:'Retourne le duty cycle du PWM, en pour cents.',lib:'pwmoutput.get_dutyCycle()',pro:'function get_dutyCycle()',cmt:'

Retourne le duty cycle du PWM, en pour cents.

',ret:'une valeur numérique représentant le duty cycle du PWM, en pour cents',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DUTYCYCLE_INVALID`.'}; doc['PwmOutput']['get_dutyCycleAtPowerOn']={syn:'Retourne le duty cycle du PWM au d\xE9marrage du module, sous la forme d\x27un nombre \xE0 virgule entre 0 et 100 ',lib:'pwmoutput.get_dutyCycleAtPowerOn()',pro:'function get_dutyCycleAtPowerOn()',cmt:'

Retourne le duty cycle du PWM au d\xE9marrage du module, sous la forme d\x27un nombre \xE0 virgule entre 0 et 100

',ret:'une valeur numérique représentant le duty cycle du PWM au d\xE9marrage du module, sous la forme d\x27un nombre \xE0 virgule entre 0 et 100',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DUTYCYCLEATPOWERON_INVALID`.'}; doc['PwmOutput']['get_enabled']={syn:'Retourne l\x27\xE9tat de fonctionnement du PWM.',lib:'pwmoutput.get_enabled()',pro:'function get_enabled()',cmt:'

Retourne l\x27\xE9tat de fonctionnement du PWM.

',ret:'soit `Y_ENABLED_FALSE`, soit `Y_ENABLED_TRUE`, selon l\x27\xE9tat de fonctionnement du PWM',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ENABLED_INVALID`.'}; doc['PwmOutput']['get_enabledAtPowerOn']={syn:'Retourne l\x27\xE9tat de fonctionnement du PWM \xE0 la mise sous tension du module.',lib:'pwmoutput.get_enabledAtPowerOn()',pro:'function get_enabledAtPowerOn()',cmt:'

Retourne l\x27\xE9tat de fonctionnement du PWM \xE0 la mise sous tension du module.

',ret:'soit `Y_ENABLEDATPOWERON_FALSE`, soit `Y_ENABLEDATPOWERON_TRUE`, selon l\x27\xE9tat de fonctionnement du PWM \xE0 la mise sous tension du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ENABLEDATPOWERON_INVALID`.'}; doc['PwmOutput']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du PWM.',lib:'pwmoutput.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du PWM. 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 PWM.'}; doc['PwmOutput']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du PWM.',lib:'pwmoutput.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du PWM. 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 PWM.'}; doc['PwmOutput']['get_frequency']={syn:'Retourne la fr\xE9quence du PWM en Hz.',lib:'pwmoutput.get_frequency()',pro:'function get_frequency()',cmt:'

Retourne la fr\xE9quence du PWM en Hz.

',ret:'une valeur numérique représentant la fr\xE9quence du PWM en Hz',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_FREQUENCY_INVALID`.'}; doc['PwmOutput']['get_friendlyName']={syn:'Retourne un identifiant global du PWM au format `NOM_MODULE.NOM_FONCTION`.',lib:'pwmoutput.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le PWM en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['PwmOutput']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'pwmoutput.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['PwmOutput']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du PWM, sans r\xE9f\xE9rence au module.',lib:'pwmoutput.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du PWM 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 PWM (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le PWM (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['PwmOutput']['get_logicalName']={syn:'Retourne le nom logique du PWM.',lib:'pwmoutput.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du PWM.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du PWM.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['PwmOutput']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'pwmoutput.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['PwmOutput']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'pwmoutput.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['PwmOutput']['get_period']={syn:'Retourne la p\xE9riode du PWM en millisecondes.',lib:'pwmoutput.get_period()',pro:'function get_period()',cmt:'

Retourne la p\xE9riode du PWM en millisecondes.

',ret:'une valeur numérique représentant la p\xE9riode du PWM en millisecondes',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PERIOD_INVALID`.'}; doc['PwmOutput']['get_pulseDuration']={syn:'Retourne la longueur d\x27une impulsion du PWM en millisecondes, sous forme d\x27un chiffre \xE0 virgule.',lib:'pwmoutput.get_pulseDuration()',pro:'function get_pulseDuration()',cmt:'

Retourne la longueur d\x27une impulsion du PWM en millisecondes, sous forme d\x27un chiffre \xE0 virgule.

',ret:'une valeur numérique représentant la longueur d\x27une impulsion du PWM en millisecondes, sous forme d\x27un chiffre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PULSEDURATION_INVALID`.'}; doc['PwmOutput']['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:'pwmoutput.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['PwmOutput']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le PWM est joignable, sans d\xE9clencher d\x27erreur.',lib:'pwmoutput.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le PWM est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du PWM 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 PWM est joignable, `false` sinon'}; doc['PwmOutput']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le PWM est joignable, sans d\xE9clencher d\x27erreur.',lib:'pwmoutput.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le PWM est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du PWM 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.'}; doc['PwmOutput']['load']={syn:'Met en cache les valeurs courantes du PWM, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'pwmoutput.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du PWM, 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.'}; doc['PwmOutput']['load_async']={syn:'Met en cache les valeurs courantes du PWM, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'pwmoutput.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du PWM, 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.'}; doc['PwmOutput']['nextPwmOutput']={syn:'Continue l\x27\xE9num\xE9ration des PWM commenc\xE9e \xE0 l\x27aide de `yFirstPwmOutput()`.',lib:'pwmoutput.nextPwmOutput()',pro:'function nextPwmOutput()',cmt:'

Continue l\x27\xE9num\xE9ration des PWM commenc\xE9e \xE0 l\x27aide de `yFirstPwmOutput()`.

',ret:'un pointeur sur un objet `YPwmOutput` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['PwmOutput']['pulseDurationMove']={syn:'D\xE9clenche une transition progressive de la longueur des impulsions vers une valeur donn\xE9e.',lib:'pwmoutput.pulseDurationMove()',pro:'function pulseDurationMove(ms_target, ms_duration)',cmt:'

D\xE9clenche une transition progressive de la longueur des impulsions vers une valeur donn\xE9e. N\x27importe quel changement de fr\xE9quence, duty cycle, p\xE9riode ou encore de longueur d\x27impulsion annulera tout processus de transition en cours.

',par:{ms_target:'nouvelle longueur des impulsions \xE0 la fin de la transition (nombre flottant, repr\xE9sentant la longueur en millisecondes)',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.'}; doc['PwmOutput']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'pwmoutput.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['PwmOutput']['set_dutyCycle']={syn:'Modifie le duty cycle du PWM, en pour cents.',lib:'pwmoutput.set_dutyCycle()',pro:'function set_dutyCycle(newval)',cmt:'

Modifie le duty cycle du PWM, en pour cents.

',par:{newval:'une valeur numérique représentant le duty cycle du PWM, en pour cents'},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.'}; doc['PwmOutput']['set_dutyCycleAtPowerOn']={syn:'Modifie le duty cycle du PWM au d\xE9marrage du module.',lib:'pwmoutput.set_dutyCycleAtPowerOn()',pro:'function set_dutyCycleAtPowerOn(newval)',cmt:'

Modifie le duty cycle du PWM 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 le duty cycle du PWM 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.'}; doc['PwmOutput']['set_enabled']={syn:'D\xE9marre ou arr\xEAte le PWM.',lib:'pwmoutput.set_enabled()',pro:'function set_enabled(newval)',cmt:'

D\xE9marre ou arr\xEAte le PWM.

',par:{newval:'soit `Y_ENABLED_FALSE`, soit `Y_ENABLED_TRUE`'},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.'}; doc['PwmOutput']['set_enabledAtPowerOn']={syn:'Modifie l\x27\xE9tat du fonctionnement du PWM \xE0 la mise sous tension du module.',lib:'pwmoutput.set_enabledAtPowerOn()',pro:'function set_enabledAtPowerOn(newval)',cmt:'

Modifie l\x27\xE9tat du fonctionnement du PWM \xE0 la mise sous tension du module. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module sinon la modification n\x27aura aucun effet.

',par:{newval:'soit `Y_ENABLEDATPOWERON_FALSE`, soit `Y_ENABLEDATPOWERON_TRUE`, selon l\x27\xE9tat du fonctionnement du PWM \xE0 la mise sous tension 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.'}; doc['PwmOutput']['set_frequency']={syn:'Modifie la fr\xE9quence du PWM.',lib:'pwmoutput.set_frequency()',pro:'function set_frequency(newval)',cmt:'

Modifie la fr\xE9quence du PWM. Le duty cycle est conserv\xE9 gr\xE2ce \xE0 un changement automatique de la longueur des impulsions.

',par:{newval:'une valeur numérique représentant la fr\xE9quence du PWM'},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.'}; doc['PwmOutput']['set_logicalName']={syn:'Modifie le nom logique du PWM.',lib:'pwmoutput.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du PWM. 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 PWM.'},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.'}; doc['PwmOutput']['set_period']={syn:'Modifie la p\xE9riode du PWM en millisecondes.',lib:'pwmoutput.set_period()',pro:'function set_period(newval)',cmt:'

Modifie la p\xE9riode du PWM en millisecondes.

',par:{newval:'une valeur numérique représentant la p\xE9riode du PWM 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.'}; doc['PwmOutput']['set_pulseDuration']={syn:'Modifie la longueur des impulsions du PWM, en millisecondes.',lib:'pwmoutput.set_pulseDuration()',pro:'function set_pulseDuration(newval)',cmt:'

Modifie la longueur des impulsions du PWM, en millisecondes. Attention, la longueur d\x27une impulsion ne peut pas \xEAtre plus grande que la p\xE9riode, sinon la longueur sera automatiquement tronqu\xE9e \xE0 la p\xE9riode.

',par:{newval:'une valeur numérique représentant la longueur des impulsions du PWM, 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.'}; doc['PwmOutput']['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:'pwmoutput.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['PwmOutput']['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:'pwmoutput.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 machine virtuelle 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: PwmOutput) //--- (generated code: PwmPowerSource) doc['PwmPowerSource']={'':{syn:'Interface de la fonction PwmPowerSource',inc:'<script type='text/javascript' src='yocto_pwmpowersource.js'></script>',cmt:'

La librairie de programmation Yoctopuce permet de configurer la source de tension utilis\xE9e par tous les PWM situ\xE9s sur un m\xEAme module.

'}}; doc['PwmPowerSource']['FindPwmPowerSource']={syn:'Permet de retrouver une source de tension d\x27apr\xE8s un identifiant donn\xE9.',lib:'YPwmPowerSource.FindPwmPowerSource()',pro:'function FindPwmPowerSource(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:

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

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 `YPwmPowerSource.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 `YPwmPowerSource` qui permet ensuite de contr\xF4ler la source de tension.'}; doc['PwmPowerSource']['FirstPwmPowerSource']={syn:'Commence l\x27\xE9num\xE9ration des Source de tension accessibles par la librairie.',lib:'YPwmPowerSource.FirstPwmPowerSource()',pro:'function FirstPwmPowerSource()',cmt:'

Commence l\x27\xE9num\xE9ration des Source de tension accessibles par la librairie. Utiliser la fonction `YPwmPowerSource.nextPwmPowerSource()` pour it\xE9rer sur les autres Source de tension.

',ret:'un pointeur sur un objet `YPwmPowerSource`, correspondant \xE0 la premi\xE8re source de tension accessible en ligne, ou `null` si il n\x27y a pas de Source de tension disponibles.'}; doc['PwmPowerSource']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de la source de tension au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'pwmpowersource.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de la source 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 source de tension (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['PwmPowerSource']['get_advertisedValue']={syn:'Retourne la valeur courante de la source de tension (pas plus de 6 caract\xE8res).',lib:'pwmpowersource.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['PwmPowerSource']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la source de tension.',lib:'pwmpowersource.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la source 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 source de tension.'}; doc['PwmPowerSource']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de la source de tension.',lib:'pwmpowersource.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 source 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 source de tension.'}; doc['PwmPowerSource']['get_friendlyName']={syn:'Retourne un identifiant global de la source de tension au format `NOM_MODULE.NOM_FONCTION`.',lib:'pwmpowersource.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant la source de tension en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['PwmPowerSource']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'pwmpowersource.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['PwmPowerSource']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de la source de tension, sans r\xE9f\xE9rence au module.',lib:'pwmpowersource.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique de la source 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 source de tension (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant la source de tension (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['PwmPowerSource']['get_logicalName']={syn:'Retourne le nom logique de la source de tension.',lib:'pwmpowersource.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['PwmPowerSource']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'pwmpowersource.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['PwmPowerSource']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'pwmpowersource.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['PwmPowerSource']['get_powerMode']={syn:'Retourne la source de tension utilis\xE9 par tous les PWM du m\xEAme module.',lib:'pwmpowersource.get_powerMode()',pro:'function get_powerMode()',cmt:'

Retourne la source de tension utilis\xE9 par tous les PWM du m\xEAme module.

',ret:'une valeur parmi `Y_POWERMODE_USB_5V`, `Y_POWERMODE_USB_3V`, `Y_POWERMODE_EXT_V` et `Y_POWERMODE_OPNDRN` représentant la source de tension utilis\xE9 par tous les PWM du m\xEAme module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_POWERMODE_INVALID`.'}; doc['PwmPowerSource']['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:'pwmpowersource.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['PwmPowerSource']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant la source de tension est joignable, sans d\xE9clencher d\x27erreur.',lib:'pwmpowersource.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant la source de tension est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de la source 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 source de tension est joignable, `false` sinon'}; doc['PwmPowerSource']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant la source de tension est joignable, sans d\xE9clencher d\x27erreur.',lib:'pwmpowersource.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant la source de tension est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de la source 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.'}; doc['PwmPowerSource']['load']={syn:'Met en cache les valeurs courantes de la source de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'pwmpowersource.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de la source 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.'}; doc['PwmPowerSource']['load_async']={syn:'Met en cache les valeurs courantes de la source de tension, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'pwmpowersource.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de la source 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.'}; doc['PwmPowerSource']['nextPwmPowerSource']={syn:'Continue l\x27\xE9num\xE9ration des Source de tension commenc\xE9e \xE0 l\x27aide de `yFirstPwmPowerSource()`.',lib:'pwmpowersource.nextPwmPowerSource()',pro:'function nextPwmPowerSource()',cmt:'

Continue l\x27\xE9num\xE9ration des Source de tension commenc\xE9e \xE0 l\x27aide de `yFirstPwmPowerSource()`.

',ret:'un pointeur sur un objet `YPwmPowerSource` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['PwmPowerSource']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'pwmpowersource.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['PwmPowerSource']['set_logicalName']={syn:'Modifie le nom logique de la source de tension.',lib:'pwmpowersource.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\x27appel se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['PwmPowerSource']['set_powerMode']={syn:'Modifie le mode fonctionnement des PWM qui peut sortir du 5 volts isol\xE9 issu de l\x27USB, du 3V isol\xE9 issu de l\x27USB, une tension arbitraire issue de l\x27alimentation externe.',lib:'pwmpowersource.set_powerMode()',pro:'function set_powerMode(newval)',cmt:'

Modifie le mode fonctionnement des PWM qui peut sortir du 5 volts isol\xE9 issu de l\x27USB, du 3V isol\xE9 issu de l\x27USB, une tension arbitraire issue de l\x27alimentation externe. Le PWM peut aussi en mode open drain, dans ce code il tire activement la ligne \xE0 z\xE9ro volts. Attention ce param\xE8tre est commun \xE0 tous les PWM du module, si vous changez le valeur de ce param\xE8tre, tous les PWM situ\xE9s sur le m\xEAme module seront affect\xE9s. Si vous souhaitez que le changement de ce param\xE8tre soit conserv\xE9 apr\xE8s un red\xE9marrage du module, n\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()`.

',par:{newval:'une valeur parmi `Y_POWERMODE_USB_5V`, `Y_POWERMODE_USB_3V`, `Y_POWERMODE_EXT_V` et `Y_POWERMODE_OPNDRN` représentant le mode fonctionnement des PWM qui peut sortir du 5 volts isol\xE9 issu de l\x27USB, du 3V isol\xE9 issu de l\x27USB, une tension arbitraire issue de l\x27alimentation externe'},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.'}; doc['PwmPowerSource']['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:'pwmpowersource.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['PwmPowerSource']['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:'pwmpowersource.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 machine virtuelle 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: PwmPowerSource) //--- (generated code: Altitude) doc['Altitude']={'':{syn:'Interface de la fonction Altitude',inc:'<script type='text/javascript' src='yocto_altitude.js'></script>',cmt:'

La classe YAltitude permet de lire et de configurer les capteurs d\x27altitude Yoctopuce. Elle h\xE9rite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es. De plus, pour les capteurs barom\xE9triques, elle permet de faire la configuration de la pression de r\xE9f\xE9rence au niveau de la mer (QNH).

'}}; doc['Altitude']['FindAltitude']={syn:'Permet de retrouver un altimetre d\x27apr\xE8s un identifiant donn\xE9.',lib:'YAltitude.FindAltitude()',pro:'function FindAltitude(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27altim\xE8tre soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YAltitude.isOnline()` pour tester si l\x27altim\xE8tre 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 l\x27altim\xE8tre sans ambigu\xEFt\xE9'},ret:'un objet de classe `YAltitude` qui permet ensuite de contr\xF4ler l\x27altim\xE8tre.'}; doc['Altitude']['FirstAltitude']={syn:'Commence l\x27\xE9num\xE9ration des altim\xE8tres accessibles par la librairie.',lib:'YAltitude.FirstAltitude()',pro:'function FirstAltitude()',cmt:'

Commence l\x27\xE9num\xE9ration des altim\xE8tres accessibles par la librairie. Utiliser la fonction `YAltitude.nextAltitude()` pour it\xE9rer sur les autres altim\xE8tres.

',ret:'un pointeur sur un objet `YAltitude`, correspondant au premier altim\xE8tre accessible en ligne, ou `null` si il n\x27y a pas de altim\xE8tres disponibles.'}; doc['Altitude']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'altitude.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Altitude']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27altim\xE8tre au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'altitude.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27altim\xE8tre 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\x27altim\xE8tre (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Altitude']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27altim\xE8tre (pas plus de 6 caract\xE8res).',lib:'altitude.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27altim\xE8tre (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27altim\xE8tre (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Altitude']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en m\xE8tres, sous forme de nombre \xE0 virgule.',lib:'altitude.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en m\xE8tres, 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 m\xE8tres, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Altitude']['get_currentValue']={syn:'Retourne la valeur actuelle de l\x27altitude, en m\xE8tres, sous forme de nombre \xE0 virgule.',lib:'altitude.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de l\x27altitude, en m\xE8tres, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de l\x27altitude, en m\xE8tres, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Altitude']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27altim\xE8tre.',lib:'altitude.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27altim\xE8tre. 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\x27altim\xE8tre.'}; doc['Altitude']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27altim\xE8tre.',lib:'altitude.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\x27altim\xE8tre. 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\x27altim\xE8tre.'}; doc['Altitude']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27altim\xE8tre au format `NOM_MODULE.NOM_FONCTION`.',lib:'altitude.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27altim\xE8tre en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Altitude']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'altitude.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Altitude']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27altim\xE8tre, sans r\xE9f\xE9rence au module.',lib:'altitude.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de l\x27altim\xE8tre, sans r\xE9f\xE9rence au module. Par example `relay1`.

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27altim\xE8tre 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\x27altim\xE8tre (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27altim\xE8tre (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Altitude']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour l\x27altitude depuis le d\xE9marrage du module.',lib:'altitude.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour l\x27altitude depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour l\x27altitude depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Altitude']['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:'altitude.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Altitude']['get_logicalName']={syn:'Retourne le nom logique de l\x27altim\xE8tre.',lib:'altitude.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27altim\xE8tre.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27altim\xE8tre.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Altitude']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour l\x27altitude depuis le d\xE9marrage du module.',lib:'altitude.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour l\x27altitude depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour l\x27altitude depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Altitude']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'altitude.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['Altitude']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'altitude.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['Altitude']['get_qnh']={syn:'Retourne la pression de r\xE9f\xE9rence au niveau de la mer utilis\xE9e pour le calcul de l\x27altitude (QNH).',lib:'altitude.get_qnh()',pro:'function get_qnh()',cmt:'

Retourne la pression de r\xE9f\xE9rence au niveau de la mer utilis\xE9e pour le calcul de l\x27altitude (QNH).

',ret:'une valeur numérique représentant la pression de r\xE9f\xE9rence au niveau de la mer utilis\xE9e pour le calcul de l\x27altitude (QNH)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_QNH_INVALID`.'}; doc['Altitude']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'altitude.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Altitude']['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:'altitude.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Altitude']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'altitude.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Altitude']['get_technology']={syn:'Renvoie la technologie employ\xE9e par la fonction pour calculer l\x27altitude.',lib:'altitude.get_technology()',pro:'function get_technology()',cmt:'

Renvoie la technologie employ\xE9e par la fonction pour calculer l\x27altitude. les valeur possible sont \x22barometric\x22 et \x22gps\x22

',ret:'une chaîne de caractères',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_TECHNOLOGY_INVALID`.'}; doc['Altitude']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle l\x27altitude est exprim\xE9e.',lib:'altitude.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle l\x27altitude est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle l\x27altitude est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Altitude']['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:'altitude.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['Altitude']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27altim\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'altitude.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27altim\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27altim\xE8tre 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\x27altim\xE8tre est joignable, `false` sinon'}; doc['Altitude']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27altim\xE8tre est joignable, sans d\xE9clencher d\x27erreur.',lib:'altitude.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27altim\xE8tre est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27altim\xE8tre 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.'}; doc['Altitude']['load']={syn:'Met en cache les valeurs courantes de l\x27altim\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'altitude.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27altim\xE8tre, 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.'}; doc['Altitude']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'altitude.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Altitude']['load_async']={syn:'Met en cache les valeurs courantes de l\x27altim\xE8tre, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'altitude.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27altim\xE8tre, 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.'}; doc['Altitude']['nextAltitude']={syn:'Continue l\x27\xE9num\xE9ration des altim\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstAltitude()`.',lib:'altitude.nextAltitude()',pro:'function nextAltitude()',cmt:'

Continue l\x27\xE9num\xE9ration des altim\xE8tres commenc\xE9e \xE0 l\x27aide de `yFirstAltitude()`.

',ret:'un pointeur sur un objet `YAltitude` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Altitude']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'altitude.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Altitude']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'altitude.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['Altitude']['set_currentValue']={syn:'Modifie l\x27altitude actuelle suppos\xE9e.',lib:'altitude.set_currentValue()',pro:'function set_currentValue(newval)',cmt:'

Modifie l\x27altitude actuelle suppos\xE9e. Ceci permet de compenser les changements de pression ou de travailler en mode relatif.

',par:{newval:'une valeur numérique représentant l\x27altitude actuelle suppos\xE9e'},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.'}; doc['Altitude']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'altitude.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Altitude']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'altitude.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Altitude']['set_logicalName']={syn:'Modifie le nom logique de l\x27altim\xE8tre.',lib:'altitude.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27altim\xE8tre. 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\x27altim\xE8tre.'},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.'}; doc['Altitude']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'altitude.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Altitude']['set_qnh']={syn:'Modifie la pression de r\xE9f\xE9rence au niveau de la mer utilis\xE9e pour le calcul de l\x27altitude (QNH).',lib:'altitude.set_qnh()',pro:'function set_qnh(newval)',cmt:'

Modifie la pression de r\xE9f\xE9rence au niveau de la mer utilis\xE9e pour le calcul de l\x27altitude (QNH). Ceci permet de compenser les changements de pression atmosph\xE9rique dus au climat.

',par:{newval:'une valeur numérique représentant la pression de r\xE9f\xE9rence au niveau de la mer utilis\xE9e pour le calcul de l\x27altitude (QNH)'},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.'}; doc['Altitude']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'altitude.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Altitude']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'altitude.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Altitude']['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:'altitude.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['Altitude']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'altitude.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Altitude']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'altitude.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Altitude']['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:'altitude.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 machine virtuelle 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: Altitude) //--- (generated code: Motor) doc['Motor']={'':{syn:'Interface de la fonction Motor',inc:'<script type='text/javascript' src='yocto_motor.js'></script>',cmt:'

La librairie de programmation yoctopuce permet de piloter la puissance envoy\xE9e au moteur pour le faire tourner aussi bien dans un sens que dans l\x27autre, mais aussi de piloter des acc\xE9l\xE9rations lin\xE9aires: le moteur acc\xE9l\xE9re alors tout seul sans que vous vous ayez \xE0 vous en occuper. La librairie permet aussi de freiner le moteur: cela est r\xE9alis\xE9 en court-circuitant les p\xF4les du moteur, ce qui le transforme en frein \xE9lectro-magn\xE9tique.

'}}; doc['Motor']['FindMotor']={syn:'Permet de retrouver un moteur d\x27apr\xE8s un identifiant donn\xE9.',lib:'YMotor.FindMotor()',pro:'function FindMotor(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le moteur soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YMotor.isOnline()` pour tester si le moteur 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 le moteur sans ambigu\xEFt\xE9'},ret:'un objet de classe `YMotor` qui permet ensuite de contr\xF4ler le moteur.'}; doc['Motor']['FirstMotor']={syn:'Commence l\x27\xE9num\xE9ration des moteur accessibles par la librairie.',lib:'YMotor.FirstMotor()',pro:'function FirstMotor()',cmt:'

Commence l\x27\xE9num\xE9ration des moteur accessibles par la librairie. Utiliser la fonction `YMotor.nextMotor()` pour it\xE9rer sur les autres moteur.

',ret:'un pointeur sur un objet `YMotor`, correspondant au premier moteur accessible en ligne, ou `null` si il n\x27y a pas de moteur disponibles.'}; doc['Motor']['brakingForceMove']={syn:'Modifie progressivement la force de freinage appliqu\xE9e au moteur sur une dur\xE9e donn\xE9e.',lib:'motor.brakingForceMove()',pro:'function brakingForceMove(targetPower, delay)',cmt:'

Modifie progressivement la force de freinage appliqu\xE9e au moteur sur une dur\xE9e donn\xE9e.

',par:{targetPower:'force de freinage finale, en pourcentage',delay:'dur\xE9e (en ms) sur laquelle le changement de puissance sera effectu\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.'}; doc['Motor']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du moteur au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'motor.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du moteur 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 moteur (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Motor']['drivingForceMove']={syn:'Modifie progressivement la puissance envoy\xE9e au moteur sur une dur\xE9e donn\xE9e.',lib:'motor.drivingForceMove()',pro:'function drivingForceMove(targetPower, delay)',cmt:'

Modifie progressivement la puissance envoy\xE9e au moteur sur une dur\xE9e donn\xE9e.

',par:{targetPower:'puissance finale d\xE9sir\xE9e, en pourcentage de -100% \xE0 +100%',delay:'dur\xE9e (en ms) sur laquelle le changement de puissance sera effectu\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.'}; doc['Motor']['get_advertisedValue']={syn:'Retourne la valeur courante du moteur (pas plus de 6 caract\xE8res).',lib:'motor.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du moteur (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Motor']['get_brakingForce']={syn:'Retourne la force de freinage appliqu\xE9e au moteur, sous forme de pourcentage.',lib:'motor.get_brakingForce()',pro:'function get_brakingForce()',cmt:'

Retourne la force de freinage appliqu\xE9e au moteur, sous forme de pourcentage. La valeur 0 correspond ne pas freiner (moteur en roue libre).

',ret:'une valeur numérique représentant la force de freinage appliqu\xE9e au moteur, sous forme de pourcentage',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_BRAKINGFORCE_INVALID`.'}; doc['Motor']['get_cutOffVoltage']={syn:'Retourne la limite de l\x27alimentation en dessous de laquelle le contr\xF4leur va automatiquement se mettre en erreur et couper la consommation.',lib:'motor.get_cutOffVoltage()',pro:'function get_cutOffVoltage()',cmt:'

Retourne la limite de l\x27alimentation en dessous de laquelle le contr\xF4leur va automatiquement se mettre en erreur et couper la consommation. Ce r\xE9glage permet d\x27\xE9viter d\x27endommager un accumulateur un continuant \xE0 l\x27utiliser une fois \x22vide\x22.

',ret:'une valeur numérique représentant la limite de l\x27alimentation en dessous de laquelle le contr\xF4leur va automatiquement se mettre en erreur et couper la consommation',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CUTOFFVOLTAGE_INVALID`.'}; doc['Motor']['get_drivingForce']={syn:'Retourne la puissance actuelle envoy\xE9e au moteur, sous forme de nombre r\xE9el entre -100% et +100%.',lib:'motor.get_drivingForce()',pro:'function get_drivingForce()',cmt:'

Retourne la puissance actuelle envoy\xE9e au moteur, sous forme de nombre r\xE9el entre -100% et +100%.

',ret:'une valeur numérique représentant la puissance actuelle envoy\xE9e au moteur, sous forme de nombre r\xE9el entre -100% et +100%',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DRIVINGFORCE_INVALID`.'}; doc['Motor']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moteur.',lib:'motor.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moteur. 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 moteur.'}; doc['Motor']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moteur.',lib:'motor.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du moteur. 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 moteur.'}; doc['Motor']['get_failSafeTimeout']={syn:'Retourne le temps en millisecondes pendant lequel le variateur pourra fonctionner sans instruction du processus de contr\xF4le.',lib:'motor.get_failSafeTimeout()',pro:'function get_failSafeTimeout()',cmt:'

Retourne le temps en millisecondes pendant lequel le variateur pourra fonctionner sans instruction du processus de contr\xF4le. Pass\xE9 ce delai, le contr\xF4leur arr\xEAtera le moteur et passera en mode erreur FAILSAFE. La s\xE9curit\xE9 failsafe est d\xE9sactiv\xE9e quand la valeur est \xE0 z\xE9ro.

',ret:'un entier représentant le temps en millisecondes pendant lequel le variateur pourra fonctionner sans instruction du processus de contr\xF4le',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_FAILSAFETIMEOUT_INVALID`.'}; doc['Motor']['get_frequency']={syn:'Retourne la fr\xE9quence du signal PWM utilis\xE9 pour contr\xF4ler le moteur.',lib:'motor.get_frequency()',pro:'function get_frequency()',cmt:'

Retourne la fr\xE9quence du signal PWM utilis\xE9 pour contr\xF4ler le moteur.

',ret:'une valeur numérique représentant la fr\xE9quence du signal PWM utilis\xE9 pour contr\xF4ler le moteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_FREQUENCY_INVALID`.'}; doc['Motor']['get_friendlyName']={syn:'Retourne un identifiant global du moteur au format `NOM_MODULE.NOM_FONCTION`.',lib:'motor.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le moteur en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Motor']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'motor.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Motor']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du moteur, sans r\xE9f\xE9rence au module.',lib:'motor.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du moteur 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 moteur (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le moteur (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Motor']['get_logicalName']={syn:'Retourne le nom logique du moteur.',lib:'motor.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du moteur.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du moteur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Motor']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'motor.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['Motor']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'motor.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['Motor']['get_motorStatus']={syn:'Retourne l\x27\xE9tat du contr\xF4leur de moteur.',lib:'motor.get_motorStatus()',pro:'function get_motorStatus()',cmt:'

Retourne l\x27\xE9tat du contr\xF4leur de moteur. Les \xE9tats possibles sont: IDLE si le moteur est \xE0 l\x27arr\xEAt/en roue libre, pr\xEAt \xE0 d\xE9marrer; FORWD si le contr\xF4leur fait tourner le moteur en marche avant; BACKWD si le contr\xF4leur fait tourner le moteur en marche arri\xE8re; BRAKE si le contr\xF4leur est en train de freiner; LOVOLT si le contr\xF4leur a d\xE9tect\xE9 une tension trop basse; HICURR si le contr\xF4leur a d\xE9tect\xE9 une surconsommation; HIHEAT si le contr\xF4leur a d\xE9tect\xE9 une surchauffe; FAILSF si le contr\xF4leur est pass\xE9 en protection failsafe.

Si le contr\xF4leur est en erreur (LOVOLT, HICURR, HIHEAT,FAILSF), il doit \xEAtre explicitement r\xE9initialis\xE9 avec la fonction `resetStatus`.

',ret:'une valeur parmi `Y_MOTORSTATUS_IDLE`, `Y_MOTORSTATUS_BRAKE`, `Y_MOTORSTATUS_FORWD`, `Y_MOTORSTATUS_BACKWD`, `Y_MOTORSTATUS_LOVOLT`, `Y_MOTORSTATUS_HICURR`, `Y_MOTORSTATUS_HIHEAT` et `Y_MOTORSTATUS_FAILSF` représentant l\x27\xE9tat du contr\xF4leur de moteur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_MOTORSTATUS_INVALID`.'}; doc['Motor']['get_overCurrentLimit']={syn:'Retourne la valeur limite du courant (en mA) au dessus de laquelle le contr\xF4leur va automatiquement se mettre en erreur.',lib:'motor.get_overCurrentLimit()',pro:'function get_overCurrentLimit()',cmt:'

Retourne la valeur limite du courant (en mA) au dessus de laquelle le contr\xF4leur va automatiquement se mettre en erreur. Une valeur nulle signifie qu\x27aucune limite n\x27est d\xE9finie.

',ret:'un entier représentant la valeur limite du courant (en mA) au dessus de laquelle le contr\xF4leur va automatiquement se mettre en erreur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_OVERCURRENTLIMIT_INVALID`.'}; doc['Motor']['get_starterTime']={syn:'Retourne la dur\xE9e (en ms) pendant laquelle le moteur est pilot\xE9 \xE0 basse fr\xE9quence pour faciliter son d\xE9marrage.',lib:'motor.get_starterTime()',pro:'function get_starterTime()',cmt:'

Retourne la dur\xE9e (en ms) pendant laquelle le moteur est pilot\xE9 \xE0 basse fr\xE9quence pour faciliter son d\xE9marrage.

',ret:'un entier représentant la dur\xE9e (en ms) pendant laquelle le moteur est pilot\xE9 \xE0 basse fr\xE9quence pour faciliter son d\xE9marrage',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_STARTERTIME_INVALID`.'}; doc['Motor']['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:'motor.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['Motor']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le moteur est joignable, sans d\xE9clencher d\x27erreur.',lib:'motor.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le moteur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du moteur 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 moteur est joignable, `false` sinon'}; doc['Motor']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le moteur est joignable, sans d\xE9clencher d\x27erreur.',lib:'motor.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le moteur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du moteur 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.'}; doc['Motor']['keepALive']={syn:'R\xE9arme la s\xE9curit\xE9 failsafe du contr\xF4leur.',lib:'motor.keepALive()',pro:'function keepALive()',cmt:'

R\xE9arme la s\xE9curit\xE9 failsafe du contr\xF4leur. Lorsque le moteur est en marche et que la s\xE9curit\xE9 failsafe est activ\xE9e, cette fonction doit \xEAtre appel\xE9e p\xE9riodiquement pour confirmer le bon fonctionnement du processus de contr\xF4le. A d\xE9faut, le moteur s\x27arr\xEAtera automatiquement au bout du temps pr\xE9vu. Notez que l\x27appel \xE0 une fonction de type set du moteur r\xE9arme aussi la s\xE9curit\xE9 failsafe.

'}; doc['Motor']['load']={syn:'Met en cache les valeurs courantes du moteur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'motor.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du moteur, 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.'}; doc['Motor']['load_async']={syn:'Met en cache les valeurs courantes du moteur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'motor.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du moteur, 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.'}; doc['Motor']['nextMotor']={syn:'Continue l\x27\xE9num\xE9ration des moteur commenc\xE9e \xE0 l\x27aide de `yFirstMotor()`.',lib:'motor.nextMotor()',pro:'function nextMotor()',cmt:'

Continue l\x27\xE9num\xE9ration des moteur commenc\xE9e \xE0 l\x27aide de `yFirstMotor()`.

',ret:'un pointeur sur un objet `YMotor` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Motor']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'motor.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['Motor']['resetStatus']={syn:'R\xE9initialise l\x27\xE9tat du contr\xF4leur \xE0 IDLE.',lib:'motor.resetStatus()',pro:'function resetStatus()',cmt:'

R\xE9initialise l\x27\xE9tat du contr\xF4leur \xE0 IDLE. Cette fonction doit \xEAtre explicitement appel\xE9e apr\xE8s toute condition d\x27erreur pour permettre au contr\xF4leur de repartir.

'}; doc['Motor']['set_brakingForce']={syn:'Modifie imm\xE9diatement la force de freinage appliqu\xE9e au moteur (en pourcents).',lib:'motor.set_brakingForce()',pro:'function set_brakingForce(newval)',cmt:'

Modifie imm\xE9diatement la force de freinage appliqu\xE9e au moteur (en pourcents). La valeur 0 correspond \xE0 ne pas freiner (moteur en roue libre). Lorsque la force de freinage est chang\xE9e, la puissance de traction est remise \xE0 z\xE9ro.

',par:{newval:'une valeur numérique représentant imm\xE9diatement la force de freinage appliqu\xE9e au moteur (en pourcents)'},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.'}; doc['Motor']['set_cutOffVoltage']={syn:'Modifie la limite de l\x27alimentation en dessous de laquelle le contr\xF4leur va automatiquement se mettre en erreur et couper la consommation.',lib:'motor.set_cutOffVoltage()',pro:'function set_cutOffVoltage(newval)',cmt:'

Modifie la limite de l\x27alimentation en dessous de laquelle le contr\xF4leur va automatiquement se mettre en erreur et couper la consommation. Ce r\xE9glage permet d\x27\xE9viter d\x27endommager un accumulateur un continuant \xE0 l\x27utiliser une fois \x22vide\x22. Attention, quel que soit le r\xE9glage du cutoff, le variateur passera en erreur si l\x27alimentation passe (m\xEAme bri\xE8vement) en dessous de 3V.

',par:{newval:'une valeur numérique représentant la limite de l\x27alimentation en dessous de laquelle le contr\xF4leur va automatiquement se mettre en erreur et couper la consommation'},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.'}; doc['Motor']['set_drivingForce']={syn:'Modifie imm\xE9diatement la puissance envoy\xE9e au moteur.',lib:'motor.set_drivingForce()',pro:'function set_drivingForce(newval)',cmt:'

Modifie imm\xE9diatement la puissance envoy\xE9e au moteur. La valeur est donn\xE9e en pourcentage de -100% \xE0 +100%. Si vous voulez m\xE9nager votre m\xE9canique et \xE9viter d\x27induire des consommations excessives qui pourraient d\xE9passer les capacit\xE9s du contr\xF4leur, \xE9vitez les changements de r\xE9gime trop brusques. Par exemple, passer brutalement de marche avant \xE0 marche arri\xE8re est une tr\xE8s mauvaise id\xE9e. A chaque fois que la puissance envoy\xE9e au moteur est chang\xE9e, le freinage est remis \xE0 z\xE9ro.

',par:{newval:'une valeur numérique représentant imm\xE9diatement la puissance envoy\xE9e au moteur'},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.'}; doc['Motor']['set_failSafeTimeout']={syn:'Modifie le temps en millisecondes pendant lequel le variateur pourra fonctionner sans instruction du processus de contr\xF4le.',lib:'motor.set_failSafeTimeout()',pro:'function set_failSafeTimeout(newval)',cmt:'

Modifie le temps en millisecondes pendant lequel le variateur pourra fonctionner sans instruction du processus de contr\xF4le. Pass\xE9 ce delai, le contr\xF4leur arr\xEAtera le moteur et passera en mode erreur FAILSAFE. La s\xE9curit\xE9 failsafe est d\xE9sactiv\xE9e quand la valeur est \xE0 z\xE9ro.

',par:{newval:'un entier représentant le temps en millisecondes pendant lequel le variateur pourra fonctionner sans instruction du processus de contr\xF4le'},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.'}; doc['Motor']['set_frequency']={syn:'Modifie la fr\xE9quence du signal PWM utilis\xE9e pour contr\xF4ler le moteur.',lib:'motor.set_frequency()',pro:'function set_frequency(newval)',cmt:'

Modifie la fr\xE9quence du signal PWM utilis\xE9e pour contr\xF4ler le moteur. Une fr\xE9quence basse est g\xE9n\xE9ralement plus efficace (les composant chauffent moins et le moteur d\xE9marre plus facilement), mais un bruit audible peut \xEAtre g\xE9n\xE9r\xE9. Une fr\xE9quence \xE9lev\xE9e peut r\xE9duire le bruit, mais il y a plus d\x27\xE9nergie perdue en chaleur.

',par:{newval:'une valeur numérique représentant la fr\xE9quence du signal PWM utilis\xE9e pour contr\xF4ler le moteur'},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.'}; doc['Motor']['set_logicalName']={syn:'Modifie le nom logique du moteur.',lib:'motor.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du moteur. 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 moteur.'},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.'}; doc['Motor']['set_overCurrentLimit']={syn:'Modifie la valeur limite du courant (en mA) au dessus de laquelle le contr\xF4leur va automatiquement se mettre en erreur.',lib:'motor.set_overCurrentLimit()',pro:'function set_overCurrentLimit(newval)',cmt:'

Modifie la valeur limite du courant (en mA) au dessus de laquelle le contr\xF4leur va automatiquement se mettre en erreur. Une valeur nulle signifie qu\x27aucune limite n\x27est d\xE9finie. Attention, quel que soit le r\xE9glage choisi, le variateur passera en erreur si le courant passe, m\xEAme bri\xE8vement, en dessus de 32A.

',par:{newval:'un entier représentant la valeur limite du courant (en mA) au dessus de laquelle le contr\xF4leur va automatiquement se mettre en erreur'},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.'}; doc['Motor']['set_starterTime']={syn:'Modifie la dur\xE9e (en ms) pendant laquelle le moteur est pilot\xE9 \xE0 basse fr\xE9quence pour faciliter son d\xE9marrage.',lib:'motor.set_starterTime()',pro:'function set_starterTime(newval)',cmt:'

Modifie la dur\xE9e (en ms) pendant laquelle le moteur est pilot\xE9 \xE0 basse fr\xE9quence pour faciliter son d\xE9marrage.

',par:{newval:'un entier représentant la dur\xE9e (en ms) pendant laquelle le moteur est pilot\xE9 \xE0 basse fr\xE9quence pour faciliter son d\xE9marrage'},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.'}; doc['Motor']['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:'motor.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['Motor']['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:'motor.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 machine virtuelle 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: Motor) //--- (generated code: SerialPort) doc['SerialPort']={'':{syn:'Interface de la fonction SerialPort',inc:'<script type='text/javascript' src='yocto_serialport.js'></script>',cmt:'

La fonction SerialPort permet de piloter enti\xE8rement un module d\x27interface s\xE9rie Yoctopuce, pour envoyer et recevoir des donn\xE9es et configurer les param\xE8tres de transmission (vitesse, nombre de bits, parit\xE9, contr\xF4le de flux et protocole). Notez que les interfaces s\xE9rie Yoctopuce ne sont pas des visibles comme des ports COM virtuels. Ils sont faits pour \xEAtre utilis\xE9s comme tous les autres modules Yoctopuce.

'}}; doc['SerialPort']['FindSerialPort']={syn:'Permet de retrouver une port s\xE9rie d\x27apr\xE8s un identifiant donn\xE9.',lib:'YSerialPort.FindSerialPort()',pro:'function FindSerialPort(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le port s\xE9rie soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YSerialPort.isOnline()` pour tester si le port s\xE9rie 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 le port s\xE9rie sans ambigu\xEFt\xE9'},ret:'un objet de classe `YSerialPort` qui permet ensuite de contr\xF4ler le port s\xE9rie.'}; doc['SerialPort']['FirstSerialPort']={syn:'Commence l\x27\xE9num\xE9ration des le port s\xE9rie accessibles par la librairie.',lib:'YSerialPort.FirstSerialPort()',pro:'function FirstSerialPort()',cmt:'

Commence l\x27\xE9num\xE9ration des le port s\xE9rie accessibles par la librairie. Utiliser la fonction `YSerialPort.nextSerialPort()` pour it\xE9rer sur les autres le port s\xE9rie.

',ret:'un pointeur sur un objet `YSerialPort`, correspondant au premier port s\xE9rie accessible en ligne, ou `null` si il n\x27y a pas du port s\xE9rie disponibles.'}; doc['SerialPort']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du port s\xE9rie au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'serialport.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du port s\xE9rie 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 port s\xE9rie (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['SerialPort']['get_CTS']={syn:'Lit l\x27\xE9tat de la ligne CTS.',lib:'serialport.get_CTS()',pro:'function get_CTS()',cmt:'

Lit l\x27\xE9tat de la ligne CTS. La ligne CTS est habituellement pilot\xE9e par le signal RTS du p\xE9riph\xE9rique s\xE9rie connect\xE9.

',ret:'1 si le CTS est signal\xE9 (niveau haut), 0 si le CTS n\x27est pas actif (niveau bas).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['get_advertisedValue']={syn:'Retourne la valeur courante du port s\xE9rie (pas plus de 6 caract\xE8res).',lib:'serialport.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante du port s\xE9rie (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du port s\xE9rie (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['SerialPort']['get_currentJob']={syn:'Retourne le nom du fichier de t\xE2ches actif en ce moment.',lib:'serialport.get_currentJob()',pro:'function get_currentJob()',cmt:'

Retourne le nom du fichier de t\xE2ches actif en ce moment.

',ret:'une chaîne de caractères représentant le nom du fichier de t\xE2ches actif en ce moment',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTJOB_INVALID`.'}; doc['SerialPort']['get_errCount']={syn:'Retourne le nombre d\x27erreurs de communication d\xE9tect\xE9es depuis la derni\xE8re mise \xE0 z\xE9ro.',lib:'serialport.get_errCount()',pro:'function get_errCount()',cmt:'

Retourne le nombre d\x27erreurs de communication d\xE9tect\xE9es depuis la derni\xE8re mise \xE0 z\xE9ro.

',ret:'un entier représentant le nombre d\x27erreurs de communication d\xE9tect\xE9es depuis la derni\xE8re mise \xE0 z\xE9ro',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ERRCOUNT_INVALID`.'}; doc['SerialPort']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port s\xE9rie.',lib:'serialport.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port s\xE9rie. 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 port s\xE9rie.'}; doc['SerialPort']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port s\xE9rie.',lib:'serialport.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du port s\xE9rie. 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 port s\xE9rie.'}; doc['SerialPort']['get_friendlyName']={syn:'Retourne un identifiant global du port s\xE9rie au format `NOM_MODULE.NOM_FONCTION`.',lib:'serialport.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le port s\xE9rie en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['SerialPort']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'serialport.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['SerialPort']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du port s\xE9rie, sans r\xE9f\xE9rence au module.',lib:'serialport.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel du port s\xE9rie, sans r\xE9f\xE9rence au module. Par example `relay1`.

',ret:'une cha\xEEne de caract\xE8res identifiant le port s\xE9rie (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['SerialPort']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du port s\xE9rie au format `SERIAL.FUNCTIONID`.',lib:'serialport.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du port s\xE9rie 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 port s\xE9rie (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le port s\xE9rie (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['SerialPort']['get_lastMsg']={syn:'Retourne le dernier message re\xE7u (pour les protocoles de type Line, Frame et Modbus).',lib:'serialport.get_lastMsg()',pro:'function get_lastMsg()',cmt:'

Retourne le dernier message re\xE7u (pour les protocoles de type Line, Frame et Modbus).

',ret:'une chaîne de caractères représentant le dernier message re\xE7u (pour les protocoles de type Line, Frame et Modbus)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LASTMSG_INVALID`.'}; doc['SerialPort']['get_logicalName']={syn:'Retourne le nom logique du port s\xE9rie.',lib:'serialport.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du port s\xE9rie.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du port s\xE9rie.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['SerialPort']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'serialport.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['SerialPort']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'serialport.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['SerialPort']['get_protocol']={syn:'Retourne le type de protocole utilis\xE9 sur la communication s\xE9rie, sous forme d\x27une cha\xEEne de caract\xE8res.',lib:'serialport.get_protocol()',pro:'function get_protocol()',cmt:'

Retourne le type de protocole utilis\xE9 sur la communication s\xE9rie, sous forme d\x27une cha\xEEne de caract\xE8res. Les valeurs possibles sont \x22Line\x22 pour des messages ASCII s\xE9par\xE9s par des retours de ligne, \x22Frame:[timeout]ms\x22 pour des messages binaires s\xE9par\xE9s par une temporisation, \x22Modbus-ASCII\x22 pour des messages MODBUS en mode ASCII, \x22Modbus-RTU\x22 pour des messages MODBUS en mode RTU, \x22Char\x22 pour un flux ASCII continu ou \x22Byte\x22 pour un flux binaire continue.

',ret:'une chaîne de caractères représentant le type de protocole utilis\xE9 sur la communication s\xE9rie, sous forme d\x27une cha\xEEne de caract\xE8res',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PROTOCOL_INVALID`.'}; doc['SerialPort']['get_rxCount']={syn:'Retourne le nombre d\x27octets re\xE7us depuis la derni\xE8re mise \xE0 z\xE9ro.',lib:'serialport.get_rxCount()',pro:'function get_rxCount()',cmt:'

Retourne le nombre d\x27octets re\xE7us depuis la derni\xE8re mise \xE0 z\xE9ro.

',ret:'un entier représentant le nombre d\x27octets re\xE7us depuis la derni\xE8re mise \xE0 z\xE9ro',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_RXCOUNT_INVALID`.'}; doc['SerialPort']['get_rxMsgCount']={syn:'Retourne le nombre de messages re\xE7us depuis la derni\xE8re mise \xE0 z\xE9ro.',lib:'serialport.get_rxMsgCount()',pro:'function get_rxMsgCount()',cmt:'

Retourne le nombre de messages re\xE7us depuis la derni\xE8re mise \xE0 z\xE9ro.

',ret:'un entier représentant le nombre de messages re\xE7us depuis la derni\xE8re mise \xE0 z\xE9ro',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_RXMSGCOUNT_INVALID`.'}; doc['SerialPort']['get_serialMode']={syn:'Retourne les param\xE8tres de communication du port, sous forme d\x27une cha\xEEne de caract\xE8res du type \x229600,8N1\x22.',lib:'serialport.get_serialMode()',pro:'function get_serialMode()',cmt:'

Retourne les param\xE8tres de communication du port, sous forme d\x27une cha\xEEne de caract\xE8res du type \x229600,8N1\x22. La cha\xEEne contient le taux de transfert, le nombre de bits de donn\xE9es, la parit\xE9 parit\xE9 et le nombre de bits d\x27arr\xEAt. Un suffixe suppl\xE9mentaire optionnel est inclus si une option de contr\xF4le de flux est active: \x22CtsRts\x22 pour le contr\xF4le de flux mat\xE9riel, \x22XOnXOff\x22 pour le contr\xF4le de flux logique et \x22Simplex\x22 pour l\x27utilisation du signal RTS pour l\x27acquisition d\x27un bus partag\xE9 (tel qu\x27utilis\xE9 pour certains adaptateurs RS485 par exemple).

',ret:'une chaîne de caractères représentant les param\xE8tres de communication du port, sous forme d\x27une cha\xEEne de caract\xE8res du type \x229600,8N1\x22',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SERIALMODE_INVALID`.'}; doc['SerialPort']['get_startupJob']={syn:'Retourne le nom du fichier de t\xE2ches \xE0 ex\xE9cuter au d\xE9marrage du module.',lib:'serialport.get_startupJob()',pro:'function get_startupJob()',cmt:'

Retourne le nom du fichier de t\xE2ches \xE0 ex\xE9cuter au d\xE9marrage du module.

',ret:'une chaîne de caractères représentant le nom du fichier de t\xE2ches \xE0 ex\xE9cuter au d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_STARTUPJOB_INVALID`.'}; doc['SerialPort']['get_txCount']={syn:'Retourne le nombre d\x27octets transmis depuis la derni\xE8re mise \xE0 z\xE9ro.',lib:'serialport.get_txCount()',pro:'function get_txCount()',cmt:'

Retourne le nombre d\x27octets transmis depuis la derni\xE8re mise \xE0 z\xE9ro.

',ret:'un entier représentant le nombre d\x27octets transmis depuis la derni\xE8re mise \xE0 z\xE9ro',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_TXCOUNT_INVALID`.'}; doc['SerialPort']['get_txMsgCount']={syn:'Retourne le nombre de messages envoy\xE9s depuis la derni\xE8re mise \xE0 z\xE9ro.',lib:'serialport.get_txMsgCount()',pro:'function get_txMsgCount()',cmt:'

Retourne le nombre de messages envoy\xE9s depuis la derni\xE8re mise \xE0 z\xE9ro.

',ret:'un entier représentant le nombre de messages envoy\xE9s depuis la derni\xE8re mise \xE0 z\xE9ro',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_TXMSGCOUNT_INVALID`.'}; doc['SerialPort']['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:'serialport.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['SerialPort']['get_voltageLevel']={syn:'Retourne le niveau de tension utilis\xE9 par le module sur le port s\xE9rie.',lib:'serialport.get_voltageLevel()',pro:'function get_voltageLevel()',cmt:'

Retourne le niveau de tension utilis\xE9 par le module sur le port s\xE9rie.

',ret:'une valeur parmi `Y_VOLTAGELEVEL_OFF`, `Y_VOLTAGELEVEL_TTL3V`, `Y_VOLTAGELEVEL_TTL3VR`, `Y_VOLTAGELEVEL_TTL5V`, `Y_VOLTAGELEVEL_TTL5VR`, `Y_VOLTAGELEVEL_RS232` et `Y_VOLTAGELEVEL_RS485` représentant le niveau de tension utilis\xE9 par le module sur le port s\xE9rie',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_VOLTAGELEVEL_INVALID`.'}; doc['SerialPort']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le port s\xE9rie est joignable, sans d\xE9clencher d\x27erreur.',lib:'serialport.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le port s\xE9rie est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du port s\xE9rie 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 port s\xE9rie est joignable, `false` sinon'}; doc['SerialPort']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le port s\xE9rie est joignable, sans d\xE9clencher d\x27erreur.',lib:'serialport.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le port s\xE9rie est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du port s\xE9rie 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.'}; doc['SerialPort']['load']={syn:'Met en cache les valeurs courantes du port s\xE9rie, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'serialport.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du port s\xE9rie, 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.'}; doc['SerialPort']['load_async']={syn:'Met en cache les valeurs courantes du port s\xE9rie, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'serialport.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du port s\xE9rie, 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.'}; doc['SerialPort']['modbusReadBits']={syn:'Lit un ou plusieurs bits contigus depuis un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusReadBits()',pro:'function modbusReadBits(slaveNo, pduAddr, nBits)',cmt:'

Lit un ou plusieurs bits contigus depuis un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x01 (Read Coils).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 interroger',pduAddr:'adresse relative du premier bit \xE0 lire (index\xE9 \xE0 partir de z\xE9ro).',nBits:'nombre de bits \xE0 lire'},ret:'un vecteur d\x27entiers, correspondant chacun \xE0 un bit.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['SerialPort']['modbusReadInputBits']={syn:'Lit un ou plusieurs bits contigus depuis un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusReadInputBits()',pro:'function modbusReadInputBits(slaveNo, pduAddr, nBits)',cmt:'

Lit un ou plusieurs bits contigus depuis un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x02 (Read Discrete Inputs).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 interroger',pduAddr:'adresse relative du premier bit \xE0 lire (index\xE9 \xE0 partir de z\xE9ro).',nBits:'nombre de bits \xE0 lire'},ret:'un vecteur d\x27entiers, correspondant chacun \xE0 un bit.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['SerialPort']['modbusReadInputRegisters']={syn:'Lit un ou plusieurs registres d\x27entr\xE9e (registre enlecture seule) depuis un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusReadInputRegisters()',pro:'function modbusReadInputRegisters(slaveNo, pduAddr, nWords)',cmt:'

Lit un ou plusieurs registres d\x27entr\xE9e (registre enlecture seule) depuis un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x04 (Read Input Registers).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 interroger',pduAddr:'adresse relative du premier registre d\x27entr\xE9e \xE0 lire (index\xE9 \xE0 partir de z\xE9ro).',nWords:'nombre de registres d\x27entr\xE9e \xE0 lire'},ret:'un vecteur d\x27entiers, correspondant chacun \xE0 une valeur d\x27entr\xE9e (16 bits).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['SerialPort']['modbusReadRegisters']={syn:'Lit un ou plusieurs registres interne depuis un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusReadRegisters()',pro:'function modbusReadRegisters(slaveNo, pduAddr, nWords)',cmt:'

Lit un ou plusieurs registres interne depuis un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x03 (Read Holding Registers).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 interroger',pduAddr:'adresse relative du premier registre interne \xE0 lire (index\xE9 \xE0 partir de z\xE9ro).',nWords:'nombre de registres internes \xE0 lire'},ret:'un vecteur d\x27entiers, correspondant chacun \xE0 une valeur de registre (16 bits).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['SerialPort']['modbusWriteAndReadRegisters']={syn:'Modifie l\x27\xE9tat de plusieurs bits (ou relais) contigus sur un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusWriteAndReadRegisters()',pro:'function modbusWriteAndReadRegisters(slaveNo, pduWriteAddr, values, pduReadAddr, nReadWords)',cmt:'

Modifie l\x27\xE9tat de plusieurs bits (ou relais) contigus sur un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x17 (Read/Write Multiple Registers).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 piloter',pduWriteAddr:'adresse relative du premier registre interne \xE0 modifier (index\xE9 \xE0 partir de z\xE9ro).',values:'vecteur de valeurs 16 bits \xE0 appliquer',pduReadAddr:'adresse relative du premier registre interne \xE0 lire (index\xE9 \xE0 partir de z\xE9ro).',nReadWords:'nombre de registres internes \xE0 lire'},ret:'un vecteur d\x27entiers, correspondant chacun \xE0 une valeur de registre (16 bits) lue.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['SerialPort']['modbusWriteBit']={syn:'Modifie l\x27\xE9tat d\x27un seul bit (ou relais) sur un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusWriteBit()',pro:'function modbusWriteBit(slaveNo, pduAddr, value)',cmt:'

Modifie l\x27\xE9tat d\x27un seul bit (ou relais) sur un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x05 (Write Single Coil).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 piloter',pduAddr:'adresse relative du bit \xE0 modifier (index\xE9 \xE0 partir de z\xE9ro).',value:'la valeur \xE0 appliquer (0 pour l\x27\xE9tat OFF, non-z\xE9ro pour l\x27\xE9tat ON)'},ret:'le nombre de bits affect\xE9s sur le p\xE9riph\xE9rique (1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne z\xE9ro.'}; doc['SerialPort']['modbusWriteBits']={syn:'Modifie l\x27\xE9tat de plusieurs bits (ou relais) contigus sur un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusWriteBits()',pro:'function modbusWriteBits(slaveNo, pduAddr, bits)',cmt:'

Modifie l\x27\xE9tat de plusieurs bits (ou relais) contigus sur un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x0f (Write Multiple Coils).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 piloter',pduAddr:'adresse relative du premier bit \xE0 modifier (index\xE9 \xE0 partir de z\xE9ro).',bits:'vecteur de bits \xE0 appliquer (un entier par bit)'},ret:'le nombre de bits affect\xE9s sur le p\xE9riph\xE9rique',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne z\xE9ro.'}; doc['SerialPort']['modbusWriteRegister']={syn:'Modifie la valeur d\x27un registre interne 16 bits sur un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusWriteRegister()',pro:'function modbusWriteRegister(slaveNo, pduAddr, value)',cmt:'

Modifie la valeur d\x27un registre interne 16 bits sur un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x06 (Write Single Register).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 piloter',pduAddr:'adresse relative du registre \xE0 modifier (index\xE9 \xE0 partir de z\xE9ro).',value:'la valeur 16 bits \xE0 appliquer'},ret:'le nombre de registres affect\xE9s sur le p\xE9riph\xE9rique (1)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne z\xE9ro.'}; doc['SerialPort']['modbusWriteRegisters']={syn:'Modifie l\x27\xE9tat de plusieurs registres internes 16 bits contigus sur un p\xE9riph\xE9rique MODBUS.',lib:'serialport.modbusWriteRegisters()',pro:'function modbusWriteRegisters(slaveNo, pduAddr, values)',cmt:'

Modifie l\x27\xE9tat de plusieurs registres internes 16 bits contigus sur un p\xE9riph\xE9rique MODBUS. Cette m\xE9thode utilise le code de fonction MODBUS 0x10 (Write Multiple Registers).

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave \xE0 piloter',pduAddr:'adresse relative du premier registre interne \xE0 modifier (index\xE9 \xE0 partir de z\xE9ro).',values:'vecteur de valeurs 16 bits \xE0 appliquer'},ret:'le nombre de registres affect\xE9s sur le p\xE9riph\xE9rique',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne z\xE9ro.'}; doc['SerialPort']['nextSerialPort']={syn:'Continue l\x27\xE9num\xE9ration des le port s\xE9rie commenc\xE9e \xE0 l\x27aide de `yFirstSerialPort()`.',lib:'serialport.nextSerialPort()',pro:'function nextSerialPort()',cmt:'

Continue l\x27\xE9num\xE9ration des le port s\xE9rie commenc\xE9e \xE0 l\x27aide de `yFirstSerialPort()`.

',ret:'un pointeur sur un objet `YSerialPort` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['SerialPort']['queryLine']={syn:'Envoie un message sous forme de ligne de texte sur le port s\xE9rie, et lit la r\xE9ponse re\xE7ue.',lib:'serialport.queryLine()',pro:'function queryLine(query, maxWait)',cmt:'

Envoie un message sous forme de ligne de texte sur le port s\xE9rie, et lit la r\xE9ponse re\xE7ue. Cette fonction est pr\xE9vue pour \xEAtre utilis\xE9e lorsque le module est configur\xE9 en protocole \x27Line\x27.

',par:{query:'le message \xE0 envoyer (sans le retour de chariot)',maxWait:'le temps maximum d\x27attente pour obtenir une r\xE9ponse (en millisecondes).'},ret:'la premi\xE8re ligne de texte re\xE7ue apr\xE8s l\x27envoi du message. Les lignes suivantes peuvent \xEAtre obtenues avec des appels \xE0 readLine ou readMessages.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['queryMODBUS']={syn:'Envoie un message \xE0 un p\xE9riph\xE9rique MODBUS esclave connect\xE9 au port s\xE9rie, et lit la r\xE9ponse re\xE7ue.',lib:'serialport.queryMODBUS()',pro:'function queryMODBUS(slaveNo, pduBytes)',cmt:'

Envoie un message \xE0 un p\xE9riph\xE9rique MODBUS esclave connect\xE9 au port s\xE9rie, et lit la r\xE9ponse re\xE7ue. Le contenu du message est le PDU, fourni sous forme de vecteur d\x27octets.

',par:{slaveNo:'addresse du p\xE9riph\xE9rique MODBUS esclave',pduBytes:'message \xE0 envoyer (PDU), sous forme de vecteur d\x27octets. Le premier octet du PDU est le code de fonction MODBUS.'},ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide (ou une r\xE9ponse d\x27erreur).'}; doc['SerialPort']['readArray']={syn:'Lit le contenu du tampon de r\xE9ception sous forme de liste d\x27octets, \xE0 partir de la position courante dans le flux de donn\xE9e.',lib:'serialport.readArray()',pro:'function readArray(nChars)',cmt:'

Lit le contenu du tampon de r\xE9ception sous forme de liste d\x27octets, \xE0 partir de la position courante dans le flux de donn\xE9e. Si le contenu \xE0 la position n\x27est plus disponible dans le tampon de r\xE9ception, la fonction ne retournera que les donn\xE9es disponibles.

',par:{nChars:'le nombre maximum de bytes \xE0 lire'},ret:'une liste de bytes avec le contenu du tampon de r\xE9ception.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['readBin']={syn:'Lit le contenu du tampon de r\xE9ception sous forme d\x27objet binaire, \xE0 partir de la position courante dans le flux de donn\xE9e.',lib:'serialport.readBin()',pro:'function readBin(nChars)',cmt:'

Lit le contenu du tampon de r\xE9ception sous forme d\x27objet binaire, \xE0 partir de la position courante dans le flux de donn\xE9e. Si le contenu \xE0 la position n\x27est plus disponible dans le tampon de r\xE9ception, la fonction ne retournera que les donn\xE9es disponibles.

',par:{nChars:'le nombre maximum de bytes \xE0 lire'},ret:'un objet binaire avec le contenu du tampon de r\xE9ception.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['readByte']={syn:'Lit le prochain byte dans le tampon de r\xE9ception, \xE0 partir de la position courante dans le flux de donn\xE9e.',lib:'serialport.readByte()',pro:'function readByte()',cmt:'

Lit le prochain byte dans le tampon de r\xE9ception, \xE0 partir de la position courante dans le flux de donn\xE9e. Si le contenu \xE0 la position n\x27est plus disponible dans le tampon de r\xE9ception, ou si aucun octet n\x27est disponible pour l\x27instant, la fonction retourne YAPI_NO_MORE_DATA.

',ret:'le prochain byte',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['readHex']={syn:'Lit le contenu du tampon de r\xE9ception sous forme hexad\xE9cimale, \xE0 partir de la position courante dans le flux de donn\xE9e.',lib:'serialport.readHex()',pro:'function readHex(nBytes)',cmt:'

Lit le contenu du tampon de r\xE9ception sous forme hexad\xE9cimale, \xE0 partir de la position courante dans le flux de donn\xE9e. Si le contenu \xE0 la position n\x27est plus disponible dans le tampon de r\xE9ception, la fonction ne retournera que les donn\xE9es disponibles.

',par:{nBytes:'le nombre maximal d\x27octets \xE0 lire'},ret:'une cha\xEEne de caract\xE8re avec le contenu du tampon de r\xE9ception, encod\xE9 en hexad\xE9cimal',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['readLine']={syn:'Lit la prochaine ligne (ou le prochain message) du tampon de r\xE9ception, \xE0 partir de la position courante dans le flux de donn\xE9e.',lib:'serialport.readLine()',pro:'function readLine()',cmt:'

Lit la prochaine ligne (ou le prochain message) du tampon de r\xE9ception, \xE0 partir de la position courante dans le flux de donn\xE9e. Cette fonction est destin\xE9e \xE0 \xEAtre utilis\xE9e lorsque le module est configur\xE9 pour un protocole bas\xE9 message, comme en mode \x27Line\x27 ou en protocole MODBUS.

Si le contenu \xE0 la position n\x27est plus disponible dans le tampon de r\xE9ception, la fonction retournera la plus ancienne ligne disponible et d\xE9placera le pointeur de position juste apr\xE8s. Si aucune nouvelle ligne enti\xE8re n\x27est disponible, la fonction retourne un cha\xEEne vide.

',ret:'une cha\xEEne de caract\xE8re avec une ligne de texte',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['readMessages']={syn:'Cherche les messages entrants dans le tampon de r\xE9ception correspondant \xE0 un format donn\xE9, \xE0 partir de la position courante.',lib:'serialport.readMessages()',pro:'function readMessages(pattern, maxWait)',cmt:'

Cherche les messages entrants dans le tampon de r\xE9ception correspondant \xE0 un format donn\xE9, \xE0 partir de la position courante. Cette fonction ne compare et ne retourne que les caract\xE8res imprimables. Les protocoles binaires sont g\xE9r\xE9s sous forme de repr\xE9sentation hexad\xE9cimale.

La recherche retourne tous les messages trouv\xE9s qui correspondent au format. Tant qu\x27aucun message ad\xE9quat n\x27est trouv\xE9, la fonction attendra, au maximum pour le temps sp\xE9cifi\xE9 en argument (en millisecondes).

',par:{pattern:'une expression r\xE9guli\xE8re limit\xE9e d\xE9crivant le format de message d\xE9sir\xE9, ou une cha\xEEne vide si aucun filtrage des messages n\x27est d\xE9sir\xE9. Pour les protocoles binaires, le format est appliqu\xE9 \xE0 la repr\xE9sentation hexad\xE9cimale du message.',maxWait:'le temps maximum d\x27attente pour obtenir un message, tant qu\x27aucun n\x27est trouv\xE9 dans le tampon de r\xE9ception (en millisecondes).'},ret:'un tableau de cha\xEEnes de caract\xE8res contenant les messages trouv\xE9s. Les messages binaires sont convertis automatiquement en repr\xE9sentation hexad\xE9cimale.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un tableau vide.'}; doc['SerialPort']['readStr']={syn:'Lit le contenu du tampon de r\xE9ception sous forme de string, \xE0 partir de la position courante dans le flux de donn\xE9e.',lib:'serialport.readStr()',pro:'function readStr(nChars)',cmt:'

Lit le contenu du tampon de r\xE9ception sous forme de string, \xE0 partir de la position courante dans le flux de donn\xE9e. Si le contenu \xE0 la position n\x27est plus disponible dans le tampon de r\xE9ception, la fonction ne retournera que les donn\xE9es disponibles.

',par:{nChars:'le nombre maximum de caract\xE8res \xE0 lire'},ret:'une cha\xEEne de caract\xE8re avec le contenu du tampon de r\xE9ception.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne un code d\x27erreur n\xE9gatif.'}; doc['SerialPort']['read_avail']={syn:'Retourne le nombre de bytes pr\xEAts \xE0 \xEAtre lus dans le tampon de r\xE9ception, depuis la position courante dans le flux de donn\xE9e utilis\xE9 par l\x27objet YSerialPort.',lib:'serialport.read_avail()',pro:'function read_avail()',cmt:'

Retourne le nombre de bytes pr\xEAts \xE0 \xEAtre lus dans le tampon de r\xE9ception, depuis la position courante dans le flux de donn\xE9e utilis\xE9 par l\x27objet YSerialPort.

',ret:'le nombre d\x27octets pr\xEAts \xE0 \xEAtre lus'}; doc['SerialPort']['read_seek']={syn:'Change le pointeur de position courante dans le flux de donn\xE9e \xE0 la valeur sp\xE9cifi\xE9e.',lib:'serialport.read_seek()',pro:'function read_seek(absPos)',cmt:'

Change le pointeur de position courante dans le flux de donn\xE9e \xE0 la valeur sp\xE9cifi\xE9e. Cette fonction n\x27a pas d\x27effet sur le module, elle ne fait que changer la valeur stock\xE9e dans l\x27objet YSerialPort qui sera utilis\xE9e pour les prochaines operations de lecture.

',par:{absPos:'index de position absolue pour les op\xE9rations de lecture suivantes.'},ret:'rien du tout.'}; doc['SerialPort']['read_tell']={syn:'Retourne la valeur actuelle du pointeur de position courante dans le flux de donn\xE9e utilis\xE9 par l\x27objet YSerialPort.',lib:'serialport.read_tell()',pro:'function read_tell()',cmt:'

Retourne la valeur actuelle du pointeur de position courante dans le flux de donn\xE9e utilis\xE9 par l\x27objet YSerialPort.

',ret:'l\x27index de position absolue pour les prochaines op\xE9rations de lecture.'}; doc['SerialPort']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'serialport.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['SerialPort']['reset']={syn:'Remet \xE0 z\xE9ro tous les compteurs et efface les tampons.',lib:'serialport.reset()',pro:'function reset()',cmt:'

Remet \xE0 z\xE9ro tous les compteurs et efface les tampons.

',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['SerialPort']['selectJob']={syn:'Charge et execute le fichier de t\xE2che sp\xE9cifi\xE9.',lib:'serialport.selectJob()',pro:'function selectJob(jobfile)',cmt:'

Charge et execute le fichier de t\xE2che sp\xE9cifi\xE9. Le fichier doit avoir \xE9t\xE9 pr\xE9alablement cr\xE9\xE9 en utilisant l\x27interface graphique, ou t\xE9l\xE9charg\xE9 sur le module \xE0 l\x27aide de la fonction `uploadJob()`.

',par:{jobfile:'nom du fichier de t\xE2che (fichier sur le module)'},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['SerialPort']['set_RTS']={syn:'Change manuellement l\x27\xE9tat de la ligne RTS.',lib:'serialport.set_RTS()',pro:'function set_RTS(val)',cmt:'

Change manuellement l\x27\xE9tat de la ligne RTS. Cette fonction n\x27a pas d\x27effet lorsque le contr\xF4le du flux par CTS/RTS est actif, car la ligne RTS est alors pilot\xE9e automatiquement.

',par:{val:'1 pour activer la ligne RTS, 0 pour la d\xE9sactiver'},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['SerialPort']['set_currentJob']={syn:'Modifie le nom du job \xE0 ex\xE9cuter au d\xE9marrage du module.',lib:'serialport.set_currentJob()',pro:'function set_currentJob(newval)',cmt:'

Modifie le nom du job \xE0 ex\xE9cuter au d\xE9marrage du module. 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 le nom du job \xE0 ex\xE9cuter 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.'}; doc['SerialPort']['set_logicalName']={syn:'Modifie le nom logique du port s\xE9rie.',lib:'serialport.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du port s\xE9rie. 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 port s\xE9rie.'},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.'}; doc['SerialPort']['set_protocol']={syn:'Modifie le type de protocol utilis\xE9 sur la communication s\xE9rie.',lib:'serialport.set_protocol()',pro:'function set_protocol(newval)',cmt:'

Modifie le type de protocol utilis\xE9 sur la communication s\xE9rie. Les valeurs possibles sont \x22Line\x22 pour des messages ASCII s\xE9par\xE9s par des retours de ligne, \x22Frame:[timeout]ms\x22 pour des messages binaires s\xE9par\xE9s par une temporisation, \x22Modbus-ASCII\x22 pour des messages MODBUS en mode ASCII, \x22Modbus-RTU\x22 pour des messages MODBUS en mode RTU, \x22Char\x22 pour un flux ASCII continu ou \x22Byte\x22 pour un flux binaire continue. Le suffixe \x22/[wait]ms\x22 peut \xEAtre ajout\xE9 pour r\xE9duire la cadence d\x27\xE9mission de sorte \xE0 ce qu\x27il y ait au minimum le nombre sp\xE9cifi\xE9 de millisecondes d\x27intervalle entre l\x27envoi de chaque byte.

',par:{newval:'une chaîne de caractères représentant le type de protocol utilis\xE9 sur la communication s\xE9rie'},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.'}; doc['SerialPort']['set_serialMode']={syn:'Modifie les param\xE8tres de communication du port, sous forme d\x27une cha\xEEne de caract\xE8res du type \x229600,8N1\x22.',lib:'serialport.set_serialMode()',pro:'function set_serialMode(newval)',cmt:'

Modifie les param\xE8tres de communication du port, sous forme d\x27une cha\xEEne de caract\xE8res du type \x229600,8N1\x22. La cha\xEEne contient le taux de transfert, le nombre de bits de donn\xE9es, la parit\xE9 parit\xE9 et le nombre de bits d\x27arr\xEAt. Un suffixe suppl\xE9mentaire optionnel peut \xEAtre inclus pour activer une option de contr\xF4le de flux: \x22CtsRts\x22 pour le contr\xF4le de flux mat\xE9riel, \x22XOnXOff\x22 pour le contr\xF4le de flux logique et \x22Simplex\x22 pour l\x27utilisation du signal RTS pour l\x27acquisition d\x27un bus partag\xE9 (tel qu\x27utilis\xE9 pour certains adaptateurs RS485 par exemple).

',par:{newval:'une chaîne de caractères représentant les param\xE8tres de communication du port, sous forme d\x27une cha\xEEne de caract\xE8res du type \x229600,8N1\x22'},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.'}; doc['SerialPort']['set_startupJob']={syn:'Modifie le nom du job \xE0 ex\xE9cuter au d\xE9marrage du module.',lib:'serialport.set_startupJob()',pro:'function set_startupJob(newval)',cmt:'

Modifie le nom du job \xE0 ex\xE9cuter au d\xE9marrage du module. 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 le nom du job \xE0 ex\xE9cuter 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.'}; doc['SerialPort']['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:'serialport.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['SerialPort']['set_voltageLevel']={syn:'Modifie le niveau de tension utilis\xE9 par le module sur le port s\xE9rie.',lib:'serialport.set_voltageLevel()',pro:'function set_voltageLevel(newval)',cmt:'

Modifie le niveau de tension utilis\xE9 par le module sur le port s\xE9rie. Les valeurs valides d\xE9pendent du mod\xE8le de module Yoctopuce h\xE9bergeant le port s\xE9rie. Consultez la documentation de votre module pour savoir quelles valeurs sont support\xE9es. Affecter une valeur invalide n\x27aura aucun effet.

',par:{newval:'une valeur parmi `Y_VOLTAGELEVEL_OFF`, `Y_VOLTAGELEVEL_TTL3V`, `Y_VOLTAGELEVEL_TTL3VR`, `Y_VOLTAGELEVEL_TTL5V`, `Y_VOLTAGELEVEL_TTL5VR`, `Y_VOLTAGELEVEL_RS232` et `Y_VOLTAGELEVEL_RS485` représentant le niveau de tension utilis\xE9 par le module sur le port s\xE9rie'},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.'}; doc['SerialPort']['uploadJob']={syn:'Sauvegarde une d\xE9finition de t\xE2che (au format JSON) dans un fichier.',lib:'serialport.uploadJob()',pro:'function uploadJob(jobfile, jsonDef)',cmt:'

Sauvegarde une d\xE9finition de t\xE2che (au format JSON) dans un fichier. Le fichier peut ensuite \xEAtre activ\xE9 \xE0 l\x27aide de la m\xE9thode `selectJob()`.

',par:{jobfile:'nom du fichier de t\xE2che sur le module',jsonDef:'une cha\xEEne de caract\xE8res contenant la d\xE9finition du job en JSON'},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['SerialPort']['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:'serialport.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 machine virtuelle 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.'}; doc['SerialPort']['writeArray']={syn:'Envoie une s\xE9quence d\x27octets (fournie sous forme d\x27une liste) sur le port s\xE9rie.',lib:'serialport.writeArray()',pro:'function writeArray(byteList)',cmt:'

Envoie une s\xE9quence d\x27octets (fournie sous forme d\x27une liste) sur le port s\xE9rie.

',par:{byteList:'la liste d\x27octets \xE0 envoyer'},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['SerialPort']['writeBin']={syn:'Envoie un objet binaire tel quel sur le port s\xE9rie.',lib:'serialport.writeBin()',pro:'function writeBin(buff)',cmt:'

Envoie un objet binaire tel quel sur le port s\xE9rie.

',par:{buff:'l\x27objet binaire \xE0 envoyer'},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['SerialPort']['writeByte']={syn:'Envoie un unique byte sur le port s\xE9rie.',lib:'serialport.writeByte()',pro:'function writeByte(code)',cmt:'

Envoie un unique byte sur le port s\xE9rie.

',par:{code:'le byte \xE0 envoyer'},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['SerialPort']['writeHex']={syn:'Envoie une s\xE9quence d\x27octets (fournie sous forme de cha\xEEne hexad\xE9cimale) sur le port s\xE9rie.',lib:'serialport.writeHex()',pro:'function writeHex(hexString)',cmt:'

Envoie une s\xE9quence d\x27octets (fournie sous forme de cha\xEEne hexad\xE9cimale) sur le port s\xE9rie.

',par:{hexString:'la cha\xEEne hexad\xE9cimale \xE0 envoyer'},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['SerialPort']['writeLine']={syn:'Envoie une cha\xEEne de caract\xE8res sur le port s\xE9rie, suivie d\x27un saut de ligne (CR LF).',lib:'serialport.writeLine()',pro:'function writeLine(text)',cmt:'

Envoie une cha\xEEne de caract\xE8res sur le port s\xE9rie, suivie d\x27un saut de ligne (CR LF).

',par:{text:'la cha\xEEne de caract\xE8res \xE0 envoyer'},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['SerialPort']['writeMODBUS']={syn:'Envoie une commande MODBUS (fournie sous forme de cha\xEEne hexad\xE9cimale) sur le port s\xE9rie.',lib:'serialport.writeMODBUS()',pro:'function writeMODBUS(hexString)',cmt:'

Envoie une commande MODBUS (fournie sous forme de cha\xEEne hexad\xE9cimale) sur le port s\xE9rie. Le message doit commencer par l\x27adresse de destination. Le CRC (ou LRC) MODBUS est ajout\xE9 automatiquement par la fonction. Cette fonction n\x27attend pas de r\xE9ponse.

',par:{hexString:'le message \xE0 envoyer, en hexad\xE9cimal, sans le CRC/LRC'},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['SerialPort']['writeStr']={syn:'Envoie une cha\xEEne de caract\xE8res telle quelle sur le port s\xE9rie.',lib:'serialport.writeStr()',pro:'function writeStr(text)',cmt:'

Envoie une cha\xEEne de caract\xE8res telle quelle sur le port s\xE9rie.

',par:{text:'la cha\xEEne de caract\xE8res \xE0 envoyer'},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.'}; //--- (end of generated code: SerialPort) //--- (generated code: PwmInput) doc['PwmInput']={'':{syn:'Interface de la fonction PwmInput',inc:'<script type='text/javascript' src='yocto_pwminput.js'></script>',cmt:'

La classe YPwmInput permet de lire et de configurer les capteurs PWM Yoctopuce. Elle h\xE9rite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es. De plus, elle permet de configurer le param\xE8tre du signal utilis\xE9 pour transmettre l\x27information: le duty cycle, le fr\xE9quence ou la longueur de la pulsation.

'}}; doc['PwmInput']['FindPwmInput']={syn:'Permet de retrouver une entr\xE9e PWM d\x27apr\xE8s un identifiant donn\xE9.',lib:'YPwmInput.FindPwmInput()',pro:'function FindPwmInput(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27entr\xE9e PWM soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YPwmInput.isOnline()` pour tester si l\x27entr\xE9e PWM 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 l\x27entr\xE9e PWM sans ambigu\xEFt\xE9'},ret:'un objet de classe `YPwmInput` qui permet ensuite de contr\xF4ler l\x27entr\xE9e PWM.'}; doc['PwmInput']['FirstPwmInput']={syn:'Commence l\x27\xE9num\xE9ration des Entr\xE9e PWM accessibles par la librairie.',lib:'YPwmInput.FirstPwmInput()',pro:'function FirstPwmInput()',cmt:'

Commence l\x27\xE9num\xE9ration des Entr\xE9e PWM accessibles par la librairie. Utiliser la fonction `YPwmInput.nextPwmInput()` pour it\xE9rer sur les autres Entr\xE9e PWM.

',ret:'un pointeur sur un objet `YPwmInput`, correspondant \xE0 la premi\xE8re entr\xE9e PWM accessible en ligne, ou `null` si il n\x27y a pas de Entr\xE9e PWM disponibles.'}; doc['PwmInput']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'pwminput.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['PwmInput']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27entr\xE9e PWM au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'pwminput.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27entr\xE9e PWM 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\x27entr\xE9e PWM (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['PwmInput']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27entr\xE9e PWM (pas plus de 6 caract\xE8res).',lib:'pwminput.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27entr\xE9e PWM (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27entr\xE9e PWM (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['PwmInput']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en Hz, sous forme de nombre \xE0 virgule.',lib:'pwminput.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en Hz, 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 Hz, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['PwmInput']['get_currentValue']={syn:'Retourne la valeur courante de la fonctionnalit\xE9 PwmInput, sous forme de nombre \xE0 virgule.',lib:'pwminput.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur courante de la fonctionnalit\xE9 PwmInput, sous forme de nombre \xE0 virgule. En fonction du r\xE9glage pwmReportMode, cela peut \xEAtre soit la fr\xE9quence en Hz, le duty cycle en % ou encore la longueur d\x27impulsion en ms.

',ret:'une valeur numérique représentant la valeur courante de la fonctionnalit\xE9 PwmInput, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['PwmInput']['get_dutyCycle']={syn:'Retourne le duty cycle du PWM, en pour cents.',lib:'pwminput.get_dutyCycle()',pro:'function get_dutyCycle()',cmt:'

Retourne le duty cycle du PWM, en pour cents.

',ret:'une valeur numérique représentant le duty cycle du PWM, en pour cents',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DUTYCYCLE_INVALID`.'}; doc['PwmInput']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27entr\xE9e PWM.',lib:'pwminput.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27entr\xE9e PWM. 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\x27entr\xE9e PWM.'}; doc['PwmInput']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27entr\xE9e PWM.',lib:'pwminput.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\x27entr\xE9e PWM. 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\x27entr\xE9e PWM.'}; doc['PwmInput']['get_frequency']={syn:'Retourne la fr\xE9quence du PWM en Hz.',lib:'pwminput.get_frequency()',pro:'function get_frequency()',cmt:'

Retourne la fr\xE9quence du PWM en Hz.

',ret:'une valeur numérique représentant la fr\xE9quence du PWM en Hz',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_FREQUENCY_INVALID`.'}; doc['PwmInput']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27entr\xE9e PWM au format `NOM_MODULE.NOM_FONCTION`.',lib:'pwminput.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27entr\xE9e PWM en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['PwmInput']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'pwminput.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['PwmInput']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27entr\xE9e PWM, sans r\xE9f\xE9rence au module.',lib:'pwminput.get_functionId()',pro:'function get_functionId()',cmt:'

Retourne l\x27identifiant mat\xE9riel de l\x27entr\xE9e PWM, sans r\xE9f\xE9rence au module. Par example `relay1`.

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27entr\xE9e PWM 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\x27entr\xE9e PWM (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27entr\xE9e PWM (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['PwmInput']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour le PWM depuis le d\xE9marrage du module.',lib:'pwminput.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour le PWM depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour le PWM depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['PwmInput']['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:'pwminput.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['PwmInput']['get_logicalName']={syn:'Retourne le nom logique de l\x27entr\xE9e PWM.',lib:'pwminput.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27entr\xE9e PWM.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27entr\xE9e PWM.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['PwmInput']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour le PWM depuis le d\xE9marrage du module.',lib:'pwminput.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour le PWM depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour le PWM depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['PwmInput']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'pwminput.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['PwmInput']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'pwminput.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['PwmInput']['get_period']={syn:'Retourne la p\xE9riode du PWM en millisecondes.',lib:'pwminput.get_period()',pro:'function get_period()',cmt:'

Retourne la p\xE9riode du PWM en millisecondes.

',ret:'une valeur numérique représentant la p\xE9riode du PWM en millisecondes',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PERIOD_INVALID`.'}; doc['PwmInput']['get_pulseCounter']={syn:'Retourne la valeur du compteur d\x27impulsions.',lib:'pwminput.get_pulseCounter()',pro:'function get_pulseCounter()',cmt:'

Retourne la valeur du compteur d\x27impulsions. Ce compteur est en r\xE9alit\xE9 incr\xE9ment\xE9 deux fois par p\xE9riode. Ce compteur est limit\xE9 \xE0 1 milliard.

',ret:'un entier représentant la valeur du compteur d\x27impulsions',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PULSECOUNTER_INVALID`.'}; doc['PwmInput']['get_pulseDuration']={syn:'Retourne la longueur d\x27une impulsion du PWM en millisecondes, sous forme d\x27un chiffre \xE0 virgule.',lib:'pwminput.get_pulseDuration()',pro:'function get_pulseDuration()',cmt:'

Retourne la longueur d\x27une impulsion du PWM en millisecondes, sous forme d\x27un chiffre \xE0 virgule.

',ret:'une valeur numérique représentant la longueur d\x27une impulsion du PWM en millisecondes, sous forme d\x27un chiffre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PULSEDURATION_INVALID`.'}; doc['PwmInput']['get_pulseTimer']={syn:'Retourne le timer du compteur d\x27impulsions (ms) ',lib:'pwminput.get_pulseTimer()',pro:'function get_pulseTimer()',cmt:'

Retourne le timer du compteur d\x27impulsions (ms)

',ret:'un entier représentant le timer du compteur d\x27impulsions (ms)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PULSETIMER_INVALID`.'}; doc['PwmInput']['get_pwmReportMode']={syn:'Retourne le type de param\xE8tre (fr\xE9quence, duty cycle , longueur d\x27impulsion ou nombre de changements d\x27\xE9tat) renvoy\xE9 par la fonction get_currentValue et les callback.',lib:'pwminput.get_pwmReportMode()',pro:'function get_pwmReportMode()',cmt:'

Retourne le type de param\xE8tre (fr\xE9quence, duty cycle , longueur d\x27impulsion ou nombre de changements d\x27\xE9tat) renvoy\xE9 par la fonction get_currentValue et les callback.

',ret:'une valeur parmi `Y_PWMREPORTMODE_PWM_DUTYCYCLE`, `Y_PWMREPORTMODE_PWM_FREQUENCY`, `Y_PWMREPORTMODE_PWM_PULSEDURATION` et `Y_PWMREPORTMODE_PWM_EDGECOUNT` représentant le type de param\xE8tre (fr\xE9quence, duty cycle , longueur d\x27impulsion ou nombre de changements d\x27\xE9tat) renvoy\xE9 par la fonction get_currentValue et les callback',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PWMREPORTMODE_INVALID`.'}; doc['PwmInput']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'pwminput.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['PwmInput']['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:'pwminput.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['PwmInput']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'pwminput.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['PwmInput']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la valeur retourn\xE9e par get_currentValue et les callback est exprim\xE9e.',lib:'pwminput.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle la valeur retourn\xE9e par get_currentValue et les callback est exprim\xE9e. Cette unit\xE9 d\xE9pend du r\xE9glage pwmReportMode.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la valeur retourn\xE9e par get_currentValue et les callback est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['PwmInput']['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:'pwminput.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['PwmInput']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27entr\xE9e PWM est joignable, sans d\xE9clencher d\x27erreur.',lib:'pwminput.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27entr\xE9e PWM est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27entr\xE9e PWM 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\x27entr\xE9e PWM est joignable, `false` sinon'}; doc['PwmInput']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27entr\xE9e PWM est joignable, sans d\xE9clencher d\x27erreur.',lib:'pwminput.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27entr\xE9e PWM est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27entr\xE9e PWM 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.'}; doc['PwmInput']['load']={syn:'Met en cache les valeurs courantes de l\x27entr\xE9e PWM, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'pwminput.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27entr\xE9e PWM, 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.'}; doc['PwmInput']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'pwminput.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['PwmInput']['load_async']={syn:'Met en cache les valeurs courantes de l\x27entr\xE9e PWM, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'pwminput.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27entr\xE9e PWM, 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.'}; doc['PwmInput']['nextPwmInput']={syn:'Continue l\x27\xE9num\xE9ration des Entr\xE9e PWM commenc\xE9e \xE0 l\x27aide de `yFirstPwmInput()`.',lib:'pwminput.nextPwmInput()',pro:'function nextPwmInput()',cmt:'

Continue l\x27\xE9num\xE9ration des Entr\xE9e PWM commenc\xE9e \xE0 l\x27aide de `yFirstPwmInput()`.

',ret:'un pointeur sur un objet `YPwmInput` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['PwmInput']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'pwminput.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['PwmInput']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'pwminput.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['PwmInput']['resetCounter']={syn:'R\xE9initialise le compteur d\x27impulsions et son timer.',lib:'pwminput.resetCounter()',pro:'function resetCounter()',cmt:'

R\xE9initialise le compteur d\x27impulsions et son timer.

',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['PwmInput']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'pwminput.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['PwmInput']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'pwminput.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['PwmInput']['set_logicalName']={syn:'Modifie le nom logique de l\x27entr\xE9e PWM.',lib:'pwminput.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27entr\xE9e PWM. 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\x27entr\xE9e PWM.'},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.'}; doc['PwmInput']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'pwminput.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['PwmInput']['set_pwmReportMode']={syn:'Change le type de param\xE8tre (fr\xE9quence, duty cycle, longueur d\x27impulsion ou nombre de changement d\x27\xE9tat) renvoy\xE9 par la fonction get_currentValue et les callback.',lib:'pwminput.set_pwmReportMode()',pro:'function set_pwmReportMode(newval)',cmt:'

Change le type de param\xE8tre (fr\xE9quence, duty cycle, longueur d\x27impulsion ou nombre de changement d\x27\xE9tat) renvoy\xE9 par la fonction get_currentValue et les callback. Seuls les six digits de droite du nombre de changements d\x27\xE9tat sont transmis, pour les valeurs plus grandes que un million, utiliser get_pulseCounter().

',par:{newval:'une valeur parmi `Y_PWMREPORTMODE_PWM_DUTYCYCLE`, `Y_PWMREPORTMODE_PWM_FREQUENCY`, `Y_PWMREPORTMODE_PWM_PULSEDURATION` et `Y_PWMREPORTMODE_PWM_EDGECOUNT`'},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.'}; doc['PwmInput']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'pwminput.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['PwmInput']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'pwminput.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['PwmInput']['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:'pwminput.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['PwmInput']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'pwminput.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['PwmInput']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'pwminput.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['PwmInput']['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:'pwminput.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 machine virtuelle 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: PwmInput) //--- (generated code: SegmentedDisplay) doc['SegmentedDisplay']={'':{syn:'Interface de la fonction SegmentedDisplay',inc:'<script type='text/javascript' src='yocto_segmenteddisplay.js'></script>',cmt:'

La classe SegmentedDisplay permet de g\xE9rer des afficheurs \xE0 segments

'}}; doc['SegmentedDisplay']['FindSegmentedDisplay']={syn:'Permet de retrouver un afficheur d\x27apr\xE8s un identifiant donn\xE9.',lib:'YSegmentedDisplay.FindSegmentedDisplay()',pro:'function FindSegmentedDisplay(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27afficheur soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YSegmentedDisplay.isOnline()` pour tester si l\x27afficheur 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 l\x27afficheur sans ambigu\xEFt\xE9'},ret:'un objet de classe `YSegmentedDisplay` qui permet ensuite de contr\xF4ler l\x27afficheur.'}; doc['SegmentedDisplay']['FirstSegmentedDisplay']={syn:'Commence l\x27\xE9num\xE9ration des un afficheur accessibles par la librairie.',lib:'YSegmentedDisplay.FirstSegmentedDisplay()',pro:'function FirstSegmentedDisplay()',cmt:'

Commence l\x27\xE9num\xE9ration des un afficheur accessibles par la librairie. Utiliser la fonction `YSegmentedDisplay.nextSegmentedDisplay()` pour it\xE9rer sur les autres un afficheur.

',ret:'un pointeur sur un objet `YSegmentedDisplay`, correspondant au premier afficheur accessible en ligne, ou `null` si il n\x27y a pas de un afficheur disponibles.'}; doc['SegmentedDisplay']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27afficheur au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'segmenteddisplay.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27afficheur 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\x27afficheur (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['SegmentedDisplay']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27afficheur (pas plus de 6 caract\xE8res).',lib:'segmenteddisplay.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27afficheur (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27afficheur (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['SegmentedDisplay']['get_displayedText']={syn:'Retourne le texte actuellement affich\xE9 \xE0 l\x27\xE9cran.',lib:'segmenteddisplay.get_displayedText()',pro:'function get_displayedText()',cmt:'

Retourne le texte actuellement affich\xE9 \xE0 l\x27\xE9cran.

',ret:'une chaîne de caractères représentant le texte actuellement affich\xE9 \xE0 l\x27\xE9cran',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DISPLAYEDTEXT_INVALID`.'}; doc['SegmentedDisplay']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27afficheur.',lib:'segmenteddisplay.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27afficheur. 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\x27afficheur.'}; doc['SegmentedDisplay']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27afficheur.',lib:'segmenteddisplay.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\x27afficheur. 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\x27afficheur.'}; doc['SegmentedDisplay']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27afficheur au format `NOM_MODULE.NOM_FONCTION`.',lib:'segmenteddisplay.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27afficheur en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['SegmentedDisplay']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'segmenteddisplay.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['SegmentedDisplay']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27afficheur, sans r\xE9f\xE9rence au module.',lib:'segmenteddisplay.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27afficheur 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\x27afficheur (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27afficheur (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['SegmentedDisplay']['get_logicalName']={syn:'Retourne le nom logique de l\x27afficheur.',lib:'segmenteddisplay.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27afficheur.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27afficheur.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['SegmentedDisplay']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'segmenteddisplay.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['SegmentedDisplay']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'segmenteddisplay.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['SegmentedDisplay']['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:'segmenteddisplay.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['SegmentedDisplay']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27afficheur est joignable, sans d\xE9clencher d\x27erreur.',lib:'segmenteddisplay.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27afficheur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27afficheur 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\x27afficheur est joignable, `false` sinon'}; doc['SegmentedDisplay']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27afficheur est joignable, sans d\xE9clencher d\x27erreur.',lib:'segmenteddisplay.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27afficheur est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27afficheur 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.'}; doc['SegmentedDisplay']['load']={syn:'Met en cache les valeurs courantes de l\x27afficheur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'segmenteddisplay.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27afficheur, 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.'}; doc['SegmentedDisplay']['load_async']={syn:'Met en cache les valeurs courantes de l\x27afficheur, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'segmenteddisplay.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27afficheur, 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.'}; doc['SegmentedDisplay']['nextSegmentedDisplay']={syn:'Continue l\x27\xE9num\xE9ration des un afficheur commenc\xE9e \xE0 l\x27aide de `yFirstSegmentedDisplay()`.',lib:'segmenteddisplay.nextSegmentedDisplay()',pro:'function nextSegmentedDisplay()',cmt:'

Continue l\x27\xE9num\xE9ration des un afficheur commenc\xE9e \xE0 l\x27aide de `yFirstSegmentedDisplay()`.

',ret:'un pointeur sur un objet `YSegmentedDisplay` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['SegmentedDisplay']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'segmenteddisplay.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['SegmentedDisplay']['set_displayedText']={syn:'Modifie le texte actuellement affich\xE9 \xE0 l\x27\xE9cran.',lib:'segmenteddisplay.set_displayedText()',pro:'function set_displayedText(newval)',cmt:'

Modifie le texte actuellement affich\xE9 \xE0 l\x27\xE9cran.

',par:{newval:'une chaîne de caractères représentant le texte actuellement affich\xE9 \xE0 l\x27\xE9cran'},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.'}; doc['SegmentedDisplay']['set_logicalName']={syn:'Modifie le nom logique de l\x27afficheur.',lib:'segmenteddisplay.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27afficheur. 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\x27afficheur.'},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.'}; doc['SegmentedDisplay']['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:'segmenteddisplay.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['SegmentedDisplay']['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:'segmenteddisplay.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 machine virtuelle 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: SegmentedDisplay) //--- (generated code: Buzzer) doc['Buzzer']={'':{syn:'Interface de la fonction Buzzer',inc:'<script type='text/javascript' src='yocto_buzzer.js'></script>',cmt:'

La librairie de programmation Yoctopuce permet de choisir la fr\xE9quence et le volume \xE0 laquelle le buzzer doit sonner. Il est aussi possible de pr\xE9-programmer une s\xE9quence \xE0 jouer.

'}}; doc['Buzzer']['FindBuzzer']={syn:'Permet de retrouver un buzzer d\x27apr\xE8s un identifiant donn\xE9.',lib:'YBuzzer.FindBuzzer()',pro:'function FindBuzzer(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le buzzer soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YBuzzer.isOnline()` pour tester si le buzzer 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 le buzzer sans ambigu\xEFt\xE9'},ret:'un objet de classe `YBuzzer` qui permet ensuite de contr\xF4ler le buzzer.'}; doc['Buzzer']['FirstBuzzer']={syn:'Commence l\x27\xE9num\xE9ration des buzzer accessibles par la librairie.',lib:'YBuzzer.FirstBuzzer()',pro:'function FirstBuzzer()',cmt:'

Commence l\x27\xE9num\xE9ration des buzzer accessibles par la librairie. Utiliser la fonction `YBuzzer.nextBuzzer()` pour it\xE9rer sur les autres buzzer.

',ret:'un pointeur sur un objet `YBuzzer`, correspondant au premier buzzer accessible en ligne, ou `null` si il n\x27y a pas de buzzer disponibles.'}; doc['Buzzer']['addFreqMoveToPlaySeq']={syn:'Ajoute une transition en fr\xE9quence \xE0 la s\xE9quence \xE0 jouer.',lib:'buzzer.addFreqMoveToPlaySeq()',pro:'function addFreqMoveToPlaySeq(freq, msDelay)',cmt:'

Ajoute une transition en fr\xE9quence \xE0 la s\xE9quence \xE0 jouer.

',par:{freq:'fr\xE9quence d\xE9sir\xE9e \xE0 la fin de la transition, en Hz',msDelay:'dur\xE9e en millisecondes de la transition.'},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['Buzzer']['addPulseToPlaySeq']={syn:'Ajoute une impulsion \xE0 la s\xE9quence \xE0 jouer.',lib:'buzzer.addPulseToPlaySeq()',pro:'function addPulseToPlaySeq(freq, msDuration)',cmt:'

Ajoute une impulsion \xE0 la s\xE9quence \xE0 jouer.

',par:{freq:'fr\xE9quence de l\x27impulsion en Hz',msDuration:'dur\xE9e de l\x27impulsion 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['Buzzer']['addVolMoveToPlaySeq']={syn:'Ajoute une transition en volume \xE0 la s\xE9quence \xE0 jouer.',lib:'buzzer.addVolMoveToPlaySeq()',pro:'function addVolMoveToPlaySeq(volume, msDuration)',cmt:'

Ajoute une transition en volume \xE0 la s\xE9quence \xE0 jouer. La fr\xE9quence courante reste inchang\xE9e: si elle est \xE0 z\xE9ro, la transition n\x27aura aucun effet.

',par:{volume:'volume d\xE9sir\xE9 \xE0 la fin de la transition, en pourcentage.',msDuration:'dur\xE9e en millisecondes de la transition.'},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['Buzzer']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du buzzer au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'buzzer.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du buzzer 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 buzzer (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Buzzer']['freqMove']={syn:'Fait varier la fr\xE9quence du buzzer pendant un temps donn\xE9.',lib:'buzzer.freqMove()',pro:'function freqMove(frequency, duration)',cmt:'

Fait varier la fr\xE9quence du buzzer pendant un temps donn\xE9.

',par:{frequency:'fr\xE9quence \xE0 atteindre en hertz, une fr\xE9quence inf\xE9rieure \xE0 25Hz arr\xEAtera le buzzer.',duration:'dur\xE9e de l\x27impulsion en milliseconds'},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['Buzzer']['get_advertisedValue']={syn:'Retourne la valeur courante du buzzer (pas plus de 6 caract\xE8res).',lib:'buzzer.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

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

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du buzzer. 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 buzzer.'}; doc['Buzzer']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du buzzer.',lib:'buzzer.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du buzzer. 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 buzzer.'}; doc['Buzzer']['get_frequency']={syn:'Retourne la fr\xE9quence du signal envoy\xE9 sur le buzzer/haut parleur.',lib:'buzzer.get_frequency()',pro:'function get_frequency()',cmt:'

Retourne la fr\xE9quence du signal envoy\xE9 sur le buzzer/haut parleur.

',ret:'une valeur numérique représentant la fr\xE9quence du signal envoy\xE9 sur le buzzer/haut parleur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_FREQUENCY_INVALID`.'}; doc['Buzzer']['get_friendlyName']={syn:'Retourne un identifiant global du buzzer au format `NOM_MODULE.NOM_FONCTION`.',lib:'buzzer.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le buzzer en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Buzzer']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'buzzer.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Buzzer']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du buzzer, sans r\xE9f\xE9rence au module.',lib:'buzzer.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du buzzer 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 buzzer (par example `RELAYLO1-123456.relay1`).

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

Retourne le nom logique du buzzer.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du buzzer.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Buzzer']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'buzzer.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['Buzzer']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'buzzer.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['Buzzer']['get_playSeqMaxSize']={syn:'Retourne la longueur maximum de la s\xE9quence \xE0 jouer ',lib:'buzzer.get_playSeqMaxSize()',pro:'function get_playSeqMaxSize()',cmt:'

Retourne la longueur maximum de la s\xE9quence \xE0 jouer

',ret:'un entier représentant la longueur maximum de la s\xE9quence \xE0 jouer',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PLAYSEQMAXSIZE_INVALID`.'}; doc['Buzzer']['get_playSeqSignature']={syn:'Retourne la signature de la signature de la s\xE9quence \xE0 jouer.',lib:'buzzer.get_playSeqSignature()',pro:'function get_playSeqSignature()',cmt:'

Retourne la signature de la signature de la s\xE9quence \xE0 jouer. Les s\xE9quences \xE0 jouer ne pouvant pas \xEAtre relues depuis le module, ce m\xE9canisme peut \xEAtre utilis\xE9 pour d\xE9tecter si une s\xE9quence sp\xE9cifique est d\xE9j\xE0 programm\xE9e.

',ret:'un entier représentant la signature de la signature de la s\xE9quence \xE0 jouer',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PLAYSEQSIGNATURE_INVALID`.'}; doc['Buzzer']['get_playSeqSize']={syn:'Retourne la longueur actuelle de la s\xE9quence \xE0 jouer ',lib:'buzzer.get_playSeqSize()',pro:'function get_playSeqSize()',cmt:'

Retourne la longueur actuelle de la s\xE9quence \xE0 jouer

',ret:'un entier représentant la longueur actuelle de la s\xE9quence \xE0 jouer',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PLAYSEQSIZE_INVALID`.'}; doc['Buzzer']['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:'buzzer.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['Buzzer']['get_volume']={syn:'Retourne le volume du signal envoy\xE9 sur le buzzer/haut parleur.',lib:'buzzer.get_volume()',pro:'function get_volume()',cmt:'

Retourne le volume du signal envoy\xE9 sur le buzzer/haut parleur.

',ret:'un entier représentant le volume du signal envoy\xE9 sur le buzzer/haut parleur',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_VOLUME_INVALID`.'}; doc['Buzzer']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le buzzer est joignable, sans d\xE9clencher d\x27erreur.',lib:'buzzer.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le buzzer est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du buzzer 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 buzzer est joignable, `false` sinon'}; doc['Buzzer']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le buzzer est joignable, sans d\xE9clencher d\x27erreur.',lib:'buzzer.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le buzzer est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du buzzer 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.'}; doc['Buzzer']['load']={syn:'Met en cache les valeurs courantes du buzzer, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'buzzer.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du buzzer, 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.'}; doc['Buzzer']['load_async']={syn:'Met en cache les valeurs courantes du buzzer, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'buzzer.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du buzzer, 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.'}; doc['Buzzer']['nextBuzzer']={syn:'Continue l\x27\xE9num\xE9ration des buzzer commenc\xE9e \xE0 l\x27aide de `yFirstBuzzer()`.',lib:'buzzer.nextBuzzer()',pro:'function nextBuzzer()',cmt:'

Continue l\x27\xE9num\xE9ration des buzzer commenc\xE9e \xE0 l\x27aide de `yFirstBuzzer()`.

',ret:'un pointeur sur un objet `YBuzzer` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Buzzer']['pulse']={syn:'Active le buzzer pendant un temps donn\xE9.',lib:'buzzer.pulse()',pro:'function pulse(frequency, duration)',cmt:'

Active le buzzer pendant un temps donn\xE9.

',par:{frequency:'fr\xE9quence de l\x27impulsion, en hertz',duration:'dur\xE9e de l\x27impulsion en milliseconds'},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['Buzzer']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'buzzer.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['Buzzer']['resetPlaySeq']={syn:'efface le contenu de la sequence \xE0 jouer et mets la fr\xE9quence \xE0 z\xE9ro.',lib:'buzzer.resetPlaySeq()',pro:'function resetPlaySeq()',cmt:'

efface le contenu de la sequence \xE0 jouer et mets la fr\xE9quence \xE0 z\xE9ro.

',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['Buzzer']['set_frequency']={syn:'Modifie la fr\xE9quence du signal envoy\xE9 sur le buzzer/speaker.',lib:'buzzer.set_frequency()',pro:'function set_frequency(newval)',cmt:'

Modifie la fr\xE9quence du signal envoy\xE9 sur le buzzer/speaker. Une fr\xE9quence nulle stoppe le buzzer.

',par:{newval:'une valeur numérique représentant la fr\xE9quence du signal envoy\xE9 sur le buzzer/speaker'},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.'}; doc['Buzzer']['set_logicalName']={syn:'Modifie le nom logique du buzzer.',lib:'buzzer.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du buzzer. 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 buzzer.'},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.'}; doc['Buzzer']['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:'buzzer.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['Buzzer']['set_volume']={syn:'Modifie le volume du signal envoy\xE9 sur le buzzer/haut parleur.',lib:'buzzer.set_volume()',pro:'function set_volume(newval)',cmt:'

Modifie le volume du signal envoy\xE9 sur le buzzer/haut parleur.

',par:{newval:'un entier représentant le volume du signal envoy\xE9 sur le buzzer/haut parleur'},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.'}; doc['Buzzer']['startPlaySeq']={syn:'D\xE9marre l\x27ex\xE9cution de la s\xE9quence \xE0 jouer pr\xE9programm\xE9e.',lib:'buzzer.startPlaySeq()',pro:'function startPlaySeq()',cmt:'

D\xE9marre l\x27ex\xE9cution de la s\xE9quence \xE0 jouer pr\xE9programm\xE9e. La s\xE9quence va tourner en boucle jusqu\x27\xE0 ce qu\x27elle soit stopp\xE9e par stopPlaySeq ou un changement explicite.

',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['Buzzer']['stopPlaySeq']={syn:'Arr\xEAte l\x27ex\xE9cution de la s\xE9quence \xE0 jouer pr\xE9programm\xE9e et mets la fr\xE9quence \xE0 z\xE9ro.',lib:'buzzer.stopPlaySeq()',pro:'function stopPlaySeq()',cmt:'

Arr\xEAte l\x27ex\xE9cution de la s\xE9quence \xE0 jouer pr\xE9programm\xE9e et mets la fr\xE9quence \xE0 z\xE9ro.

',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['Buzzer']['volumeMove']={syn:'Fait varier le volume du buzzer pendant un temps donn\xE9, la fr\xE9quence reste inchang\xE9e.',lib:'buzzer.volumeMove()',pro:'function volumeMove(volume, duration)',cmt:'

Fait varier le volume du buzzer pendant un temps donn\xE9, la fr\xE9quence reste inchang\xE9e.

',par:{volume:'volume \xE0 atteindre en %.',duration:'dur\xE9e de la transition en milliseconds'},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['Buzzer']['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:'buzzer.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 machine virtuelle 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: Buzzer) //--- (generated code: FirmwareUpdate) doc['FirmwareUpdate']={'':{syn:'Interface de contr\xF4le pour la mise \xE0 jour de firmware',inc:'<script type='text/javascript' src='yocto_api.js'></script>',cmt:'

La classe YFirmwareUpdate permet de contr\xF4ler la mise \xE0 jour du de firmware d\x27un module Yoctopuce. Cette classe ne doit pas \xEAtre instancier directement, mais est retourn\xE9e par la m\xE9thode `updateFirmware` de l\x27un objet YModule.

'}}; doc['FirmwareUpdate']['CheckFirmware']={syn:'Test si le fichi\xE9 byn est valid pour le module.',lib:'YFirmwareUpdate.CheckFirmware()',pro:'function CheckFirmware(serial, path, minrelease)',cmt:'

Test si le fichi\xE9 byn est valid pour le module. Il est possible de passer un r\xE9pertoire qui contiens plusieurs fichier byn. Dans ce cas cette methode retourne le path du fichier byn compatible le plus r\xE9cent. Cette fonction ignore les firmware qui son plus ancien que minrelease.

',par:{serial:'le num\xE9ro de s\xE9rie du module \xE0 mettre \xE0 jour',path:'le path sur un fichier byn ou un r\xE9pertoire contenant plusieurs fichier byn',minrelease:'un entier postitif'},ret:': le path du fichier byn a utiliser ou une chaine vide si aucun firmware plus r\xE9cent est disponible En cas d\x27erreur, retourne une chaine de caract\xE8re qui comment par \x22error:\x22.'}; doc['FirmwareUpdate']['get_progress']={syn:'Retourne l\x27\xE9tat d\x27avancement de la mise \xE0 jour de firmware, sur une \xE9chelle de 0 \xE0 100.',lib:'firmwareupdate.get_progress()',pro:'function get_progress()',cmt:'

Retourne l\x27\xE9tat d\x27avancement de la mise \xE0 jour de firmware, sur une \xE9chelle de 0 \xE0 100. A l\x27instanciation de l\x27objet l\x27avancement est nul. Au fur et \xE0 mesure l\x27avancement progresse pour atteindre la valeur 100. Quand la valeur de 100 est retourn\xE9 la mise \xE0 jour s\x27est termin\xE9e avec succ\xE8s. En cas d\x27erreur pendant la mise \xE0 jour une valeur n\xE9gative est retourn\xE9e et la description de l\x27erreur peu \xEAtre obtenu avec la m\xE9thode `get_progressMessage`.

',ret:'un nombre entier entre 0 et 100 repr\xE9sentant l\x27avancement de la mise \xE0 jour du firmware, ou un code d\x27erreur n\xE9gatif en cas de probl\xE8me.'}; doc['FirmwareUpdate']['get_progressMessage']={syn:'le dernier message de la mise \xE0 jour de firmware.',lib:'firmwareupdate.get_progressMessage()',pro:'function get_progressMessage()',cmt:'

le dernier message de la mise \xE0 jour de firmware. En cas d\x27erreur durant la mise \xE0 jour le message d\x27erreur est retourn\xE9.

',ret:'un cha\xEEne de caract\xE8re avec le dernier message, ou le message d\x27erreur si la mise \xE0 jour n\x27a pas r\xE9ussi'}; doc['FirmwareUpdate']['startUpdate']={syn:'D\xE9marre la mise \xE0 jour de firmware.',lib:'firmwareupdate.startUpdate()',pro:'function startUpdate()',cmt:'

D\xE9marre la mise \xE0 jour de firmware. La m\xE9thode d\xE9marre en arri\xE8re plan le processus de mise \xE0 jour de firmware. Cet m\xE9thode rend la main imm\xE9diatement. l\x27\xE9tat d\x27avancement de la mise \xE0 jour peut \xEAtre suivit \xE0 l\x27aide des m\xE9thodes `get_progress()` et `get_progressMessage()`.

',ret:'un nombre entier entre 0 et 100 repr\xE9sentant l\x27avancement de la mise \xE0 jour du firmware, ou un code d\x27erreur n\xE9gatif en cas de probl\xE8me.',ext:'En cas d\x27erreur, un code d\x27erreur n\xE9gatif.'}; //--- (end of generated code: FirmwareUpdate) //--- (generated code: Gps) doc['Gps']={'':{syn:'Interface de la fonction GPS',inc:'<script type='text/javascript' src='yocto_gps.js'></script>',cmt:'

La fonction Gps permet d\x27extraire les donn\xE9es de positionnement du module GPS. Cette classe permet d\x27obtenir toutes les informations n\xE9cessaires. Cependant, si vous souhaitez d\xE9finir des callbacks sur des changement de position, utilisez plut\xF4t les classes YLatitude et YLongitude.

'}}; doc['Gps']['FindGps']={syn:'Permet de retrouver un GPS d\x27apr\xE8s un identifiant donn\xE9.',lib:'YGps.FindGps()',pro:'function FindGps(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le GPS soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YGps.isOnline()` pour tester si le GPS 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 le GPS sans ambigu\xEFt\xE9'},ret:'un objet de classe `YGps` qui permet ensuite de contr\xF4ler le GPS.'}; doc['Gps']['FirstGps']={syn:'Commence l\x27\xE9num\xE9ration des le GPS accessibles par la librairie.',lib:'YGps.FirstGps()',pro:'function FirstGps()',cmt:'

Commence l\x27\xE9num\xE9ration des le GPS accessibles par la librairie. Utiliser la fonction `YGps.nextGps()` pour it\xE9rer sur les autres le GPS.

',ret:'un pointeur sur un objet `YGps`, correspondant au premier GPS accessible en ligne, ou `null` si il n\x27y a pas du GPS disponibles.'}; doc['Gps']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du GPS au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'gps.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du GPS 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 GPS (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Gps']['get_advertisedValue']={syn:'Retourne la valeur courante du GPS (pas plus de 6 caract\xE8res).',lib:'gps.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du GPS (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Gps']['get_altitude']={syn:'Retourne l\x27altitude courante, Attention: la technologie GPS ne permet d\x27obtenir une altitude pr\xE9cise, des erreurs de plusieurs dizaine des m\xE8tres sont courantes.',lib:'gps.get_altitude()',pro:'function get_altitude()',cmt:'

Retourne l\x27altitude courante, Attention: la technologie GPS ne permet d\x27obtenir une altitude pr\xE9cise, des erreurs de plusieurs dizaine des m\xE8tres sont courantes.

',ret:'une valeur numérique représentant l\x27altitude courante, Attention: la technologie GPS ne permet d\x27obtenir une altitude pr\xE9cise, des erreurs de plusieurs dizaine des m\xE8tres sont courantes',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ALTITUDE_INVALID`.'}; doc['Gps']['get_coordSystem']={syn:'Retourne le syst\xE8me de repr\xE9sentation utilis\xE9 pour les donn\xE9es de positionnement.',lib:'gps.get_coordSystem()',pro:'function get_coordSystem()',cmt:'

Retourne le syst\xE8me de repr\xE9sentation utilis\xE9 pour les donn\xE9es de positionnement.

',ret:'une valeur parmi `Y_COORDSYSTEM_GPS_DMS`, `Y_COORDSYSTEM_GPS_DM` et `Y_COORDSYSTEM_GPS_D` représentant le syst\xE8me de repr\xE9sentation utilis\xE9 pour les donn\xE9es de positionnement',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_COORDSYSTEM_INVALID`.'}; doc['Gps']['get_dateTime']={syn:'Retourne l\x27heure courante au format \x22AAAA/MM/JJ hh:mm:ss\x22 ',lib:'gps.get_dateTime()',pro:'function get_dateTime()',cmt:'

Retourne l\x27heure courante au format \x22AAAA/MM/JJ hh:mm:ss\x22

',ret:'une chaîne de caractères représentant l\x27heure courante au format \x22AAAA/MM/JJ hh:mm:ss\x22',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DATETIME_INVALID`.'}; doc['Gps']['get_dilution']={syn:'Retourne la dilution de pr\xE9cision horizontale.',lib:'gps.get_dilution()',pro:'function get_dilution()',cmt:'

Retourne la dilution de pr\xE9cision horizontale. Plus ce chiffre est petit, plus la pr\xE9cision est grande.

',ret:'une valeur numérique représentant la dilution de pr\xE9cision horizontale',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DILUTION_INVALID`.'}; doc['Gps']['get_direction']={syn:'Retourne la direction du d\xE9placement en degr\xE9s par rapport au nord vrai (g\xE9ographique).',lib:'gps.get_direction()',pro:'function get_direction()',cmt:'

Retourne la direction du d\xE9placement en degr\xE9s par rapport au nord vrai (g\xE9ographique).

',ret:'une valeur numérique représentant la direction du d\xE9placement en degr\xE9s par rapport au nord vrai (g\xE9ographique)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_DIRECTION_INVALID`.'}; doc['Gps']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du GPS.',lib:'gps.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du GPS. 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 GPS.'}; doc['Gps']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du GPS.',lib:'gps.get_errorType()',pro:'function get_errorType()',cmt:'

Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du GPS. 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 GPS.'}; doc['Gps']['get_friendlyName']={syn:'Retourne un identifiant global du GPS au format `NOM_MODULE.NOM_FONCTION`.',lib:'gps.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le GPS en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Gps']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'gps.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Gps']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du GPS, sans r\xE9f\xE9rence au module.',lib:'gps.get_functionId()',pro:'function get_functionId()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le GPS (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['Gps']['get_groundSpeed']={syn:'Retourne la vitesse au sol actuelle en Km/h.',lib:'gps.get_groundSpeed()',pro:'function get_groundSpeed()',cmt:'

Retourne la vitesse au sol actuelle en Km/h.

',ret:'une valeur numérique représentant la vitesse au sol actuelle en Km/h',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_GROUNDSPEED_INVALID`.'}; doc['Gps']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du GPS au format `SERIAL.FUNCTIONID`.',lib:'gps.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du GPS 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 GPS (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le GPS (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Gps']['get_isFixed']={syn:'Retourne TRUE si le r\xE9cepteur a trouv\xE9 suffisamment de satellites pour fonctionner ',lib:'gps.get_isFixed()',pro:'function get_isFixed()',cmt:'

Retourne TRUE si le r\xE9cepteur a trouv\xE9 suffisamment de satellites pour fonctionner

',ret:'soit `Y_ISFIXED_FALSE`, soit `Y_ISFIXED_TRUE`, selon TRUE si le r\xE9cepteur a trouv\xE9 suffisamment de satellites pour fonctionner',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ISFIXED_INVALID`.'}; doc['Gps']['get_latitude']={syn:'Retourne la latitude courante.',lib:'gps.get_latitude()',pro:'function get_latitude()',cmt:'

Retourne la latitude courante.

',ret:'une chaîne de caractères représentant la latitude courante',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LATITUDE_INVALID`.'}; doc['Gps']['get_logicalName']={syn:'Retourne le nom logique du GPS.',lib:'gps.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du GPS.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du GPS.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Gps']['get_longitude']={syn:'Retourne la longitude courante.',lib:'gps.get_longitude()',pro:'function get_longitude()',cmt:'

Retourne la longitude courante.

',ret:'une chaîne de caractères représentant la longitude courante',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LONGITUDE_INVALID`.'}; doc['Gps']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'gps.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['Gps']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'gps.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['Gps']['get_satCount']={syn:'Retourne le nombre de satellites visibles.',lib:'gps.get_satCount()',pro:'function get_satCount()',cmt:'

Retourne le nombre de satellites visibles.

',ret:'un entier représentant le nombre de satellites visibles',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_SATCOUNT_INVALID`.'}; doc['Gps']['get_unixTime']={syn:'Retourne l\x27heure courante au format Unix (nombre de secondes \xE9coul\xE9es depuis le 1er janvier 1970).',lib:'gps.get_unixTime()',pro:'function get_unixTime()',cmt:'

Retourne l\x27heure courante au format Unix (nombre de secondes \xE9coul\xE9es depuis le 1er janvier 1970).

',ret:'un entier représentant l\x27heure courante au format Unix (nombre de secondes \xE9coul\xE9es depuis le 1er janvier 1970)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIXTIME_INVALID`.'}; doc['Gps']['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:'gps.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['Gps']['get_utcOffset']={syn:'Retourne le nombre de secondes de d\xE9callage entre l\x27heure courante et l\x27heure UTC (time zone).',lib:'gps.get_utcOffset()',pro:'function get_utcOffset()',cmt:'

Retourne le nombre de secondes de d\xE9callage entre l\x27heure courante et l\x27heure UTC (time zone).

',ret:'un entier représentant le nombre de secondes de d\xE9callage entre l\x27heure courante et l\x27heure UTC (time zone)',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UTCOFFSET_INVALID`.'}; doc['Gps']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le GPS est joignable, sans d\xE9clencher d\x27erreur.',lib:'gps.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le GPS est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du GPS 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 GPS est joignable, `false` sinon'}; doc['Gps']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le GPS est joignable, sans d\xE9clencher d\x27erreur.',lib:'gps.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le GPS est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du GPS 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.'}; doc['Gps']['load']={syn:'Met en cache les valeurs courantes du GPS, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'gps.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du GPS, 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.'}; doc['Gps']['load_async']={syn:'Met en cache les valeurs courantes du GPS, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'gps.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du GPS, 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.'}; doc['Gps']['nextGps']={syn:'Continue l\x27\xE9num\xE9ration des le GPS commenc\xE9e \xE0 l\x27aide de `yFirstGps()`.',lib:'gps.nextGps()',pro:'function nextGps()',cmt:'

Continue l\x27\xE9num\xE9ration des le GPS commenc\xE9e \xE0 l\x27aide de `yFirstGps()`.

',ret:'un pointeur sur un objet `YGps` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Gps']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'gps.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['Gps']['set_coordSystem']={syn:'Change le syst\xE8me de repr\xE9sentation utilis\xE9 pour les donn\xE9es de positionnement.',lib:'gps.set_coordSystem()',pro:'function set_coordSystem(newval)',cmt:'

Change le syst\xE8me de repr\xE9sentation utilis\xE9 pour les donn\xE9es de positionnement.

',par:{newval:'une valeur parmi `Y_COORDSYSTEM_GPS_DMS`, `Y_COORDSYSTEM_GPS_DM` et `Y_COORDSYSTEM_GPS_D`'},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.'}; doc['Gps']['set_logicalName']={syn:'Modifie le nom logique du GPS.',lib:'gps.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du GPS. 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 GPS.'},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.'}; doc['Gps']['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:'gps.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['Gps']['set_utcOffset']={syn:'Modifie le nombre de secondes de d\xE9calage entre l\x27heure courante et l\x27heure UTC (time zone).',lib:'gps.set_utcOffset()',pro:'function set_utcOffset(newval)',cmt:'

Modifie le nombre de secondes de d\xE9calage entre l\x27heure courante et l\x27heure UTC (time zone). Le d\xE9callage est automatiquement arrondi au quart d\x27heure le plus proche. Si l\x27heure UTC est connue, l\x27heure courante sera automatiquement adapt\xE9e en fonction du d\xE9calage choisi.

',par:{newval:'un entier représentant le nombre de secondes de d\xE9calage entre l\x27heure courante et l\x27heure UTC (time zone)'},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.'}; doc['Gps']['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:'gps.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 machine virtuelle 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: Gps) //--- (generated code: Latitude) doc['Latitude']={'':{syn:'Interface de la fonction Latitude',inc:'<script type='text/javascript' src='yocto_latitude.js'></script>',cmt:'

La classe YLatitude permet de lire la latitude sur les capteurs de g\xE9olocalisation Yoctopuce. Elle h\xE9rite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es.

'}}; doc['Latitude']['FindLatitude']={syn:'Permet de retrouver un capteur de latitude d\x27apr\xE8s un identifiant donn\xE9.',lib:'YLatitude.FindLatitude()',pro:'function FindLatitude(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le capteur de latitude soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YLatitude.isOnline()` pour tester si le capteur de latitude 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 le capteur de latitude sans ambigu\xEFt\xE9'},ret:'un objet de classe `YLatitude` qui permet ensuite de contr\xF4ler le capteur de latitude.'}; doc['Latitude']['FirstLatitude']={syn:'Commence l\x27\xE9num\xE9ration des capteurs de latitude accessibles par la librairie.',lib:'YLatitude.FirstLatitude()',pro:'function FirstLatitude()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs de latitude accessibles par la librairie. Utiliser la fonction `YLatitude.nextLatitude()` pour it\xE9rer sur les autres capteurs de latitude.

',ret:'un pointeur sur un objet `YLatitude`, correspondant au premier capteur delatitude accessible en ligne, ou `null` si il n\x27y a pas de capteurs de latitude disponibles.'}; doc['Latitude']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'latitude.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Latitude']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de latitude au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'latitude.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de latitude 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 latitude (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Latitude']['get_advertisedValue']={syn:'Retourne la valeur courante du capteur de latitude (pas plus de 6 caract\xE8res).',lib:'latitude.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur de latitude (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Latitude']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en deg/1000, sous forme de nombre \xE0 virgule.',lib:'latitude.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en deg/1000, 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 deg/1000, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Latitude']['get_currentValue']={syn:'Retourne la valeur actuelle de la latitude, en deg/1000, sous forme de nombre \xE0 virgule.',lib:'latitude.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la latitude, en deg/1000, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de la latitude, en deg/1000, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Latitude']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de latitude.',lib:'latitude.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de latitude. 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 latitude.'}; doc['Latitude']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de latitude.',lib:'latitude.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 latitude. 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 latitude.'}; doc['Latitude']['get_friendlyName']={syn:'Retourne un identifiant global du capteur de latitude au format `NOM_MODULE.NOM_FONCTION`.',lib:'latitude.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de latitude en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Latitude']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'latitude.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Latitude']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du capteur de latitude, sans r\xE9f\xE9rence au module.',lib:'latitude.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du capteur de latitude 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 latitude (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de latitude (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Latitude']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la latitude depuis le d\xE9marrage du module.',lib:'latitude.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la latitude depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la latitude depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Latitude']['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:'latitude.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Latitude']['get_logicalName']={syn:'Retourne le nom logique du capteur de latitude.',lib:'latitude.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur de latitude.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de latitude.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Latitude']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la latitude depuis le d\xE9marrage du module.',lib:'latitude.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la latitude depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la latitude depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Latitude']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'latitude.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['Latitude']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'latitude.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['Latitude']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'latitude.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Latitude']['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:'latitude.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Latitude']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'latitude.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Latitude']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la latitude est exprim\xE9e.',lib:'latitude.get_unit()',pro:'function get_unit()',cmt:'

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

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la latitude est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Latitude']['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:'latitude.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['Latitude']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de latitude est joignable, sans d\xE9clencher d\x27erreur.',lib:'latitude.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de latitude est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de latitude 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 latitude est joignable, `false` sinon'}; doc['Latitude']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de latitude est joignable, sans d\xE9clencher d\x27erreur.',lib:'latitude.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de latitude est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de latitude 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.'}; doc['Latitude']['load']={syn:'Met en cache les valeurs courantes du capteur de latitude, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'latitude.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur de latitude, 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.'}; doc['Latitude']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'latitude.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Latitude']['load_async']={syn:'Met en cache les valeurs courantes du capteur de latitude, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'latitude.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur de latitude, 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.'}; doc['Latitude']['nextLatitude']={syn:'Continue l\x27\xE9num\xE9ration des capteurs de latitude commenc\xE9e \xE0 l\x27aide de `yFirstLatitude()`.',lib:'latitude.nextLatitude()',pro:'function nextLatitude()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de latitude commenc\xE9e \xE0 l\x27aide de `yFirstLatitude()`.

',ret:'un pointeur sur un objet `YLatitude` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Latitude']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'latitude.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Latitude']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'latitude.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['Latitude']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'latitude.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Latitude']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'latitude.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Latitude']['set_logicalName']={syn:'Modifie le nom logique du capteur de latitude.',lib:'latitude.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur de latitude. 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 latitude.'},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.'}; doc['Latitude']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'latitude.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Latitude']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'latitude.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Latitude']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'latitude.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Latitude']['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:'latitude.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['Latitude']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'latitude.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Latitude']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'latitude.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Latitude']['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:'latitude.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 machine virtuelle 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: Latitude) //--- (generated code: Longitude) doc['Longitude']={'':{syn:'Interface de la fonction Longitude',inc:'<script type='text/javascript' src='yocto_longitude.js'></script>',cmt:'

La classe YLongitude permet de lire la longitude sur les capteurs de g\xE9olocalisation Yoctopuce. Elle h\xE9rite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es.

'}}; doc['Longitude']['FindLongitude']={syn:'Permet de retrouver un capteur de longitude d\x27apr\xE8s un identifiant donn\xE9.',lib:'YLongitude.FindLongitude()',pro:'function FindLongitude(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le capteur de longitude soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YLongitude.isOnline()` pour tester si le capteur de longitude 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 le capteur de longitude sans ambigu\xEFt\xE9'},ret:'un objet de classe `YLongitude` qui permet ensuite de contr\xF4ler le capteur de longitude.'}; doc['Longitude']['FirstLongitude']={syn:'Commence l\x27\xE9num\xE9ration des capteurs de longitude accessibles par la librairie.',lib:'YLongitude.FirstLongitude()',pro:'function FirstLongitude()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs de longitude accessibles par la librairie. Utiliser la fonction `YLongitude.nextLongitude()` pour it\xE9rer sur les autres capteurs de longitude.

',ret:'un pointeur sur un objet `YLongitude`, correspondant au premier capteur delongitude accessible en ligne, ou `null` si il n\x27y a pas de capteurs de longitude disponibles.'}; doc['Longitude']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'longitude.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['Longitude']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de longitude au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'longitude.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de longitude 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 longitude (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Longitude']['get_advertisedValue']={syn:'Retourne la valeur courante du capteur de longitude (pas plus de 6 caract\xE8res).',lib:'longitude.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur de longitude (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Longitude']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en deg/1000, sous forme de nombre \xE0 virgule.',lib:'longitude.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en deg/1000, 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 deg/1000, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['Longitude']['get_currentValue']={syn:'Retourne la valeur actuelle de la longitude, en deg/1000, sous forme de nombre \xE0 virgule.',lib:'longitude.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la longitude, en deg/1000, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de la longitude, en deg/1000, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['Longitude']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de longitude.',lib:'longitude.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de longitude. 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 longitude.'}; doc['Longitude']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de longitude.',lib:'longitude.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 longitude. 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 longitude.'}; doc['Longitude']['get_friendlyName']={syn:'Retourne un identifiant global du capteur de longitude au format `NOM_MODULE.NOM_FONCTION`.',lib:'longitude.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de longitude en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Longitude']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'longitude.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Longitude']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du capteur de longitude, sans r\xE9f\xE9rence au module.',lib:'longitude.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique du capteur de longitude 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 longitude (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de longitude (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Longitude']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la longitude depuis le d\xE9marrage du module.',lib:'longitude.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la longitude depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la longitude depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['Longitude']['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:'longitude.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['Longitude']['get_logicalName']={syn:'Retourne le nom logique du capteur de longitude.',lib:'longitude.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur de longitude.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de longitude.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Longitude']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la longitude depuis le d\xE9marrage du module.',lib:'longitude.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la longitude depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la longitude depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['Longitude']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'longitude.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['Longitude']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'longitude.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['Longitude']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'longitude.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['Longitude']['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:'longitude.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['Longitude']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'longitude.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['Longitude']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la longitude est exprim\xE9e.',lib:'longitude.get_unit()',pro:'function get_unit()',cmt:'

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

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la longitude est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['Longitude']['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:'longitude.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['Longitude']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de longitude est joignable, sans d\xE9clencher d\x27erreur.',lib:'longitude.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de longitude est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de longitude 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 longitude est joignable, `false` sinon'}; doc['Longitude']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de longitude est joignable, sans d\xE9clencher d\x27erreur.',lib:'longitude.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de longitude est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de longitude 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.'}; doc['Longitude']['load']={syn:'Met en cache les valeurs courantes du capteur de longitude, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'longitude.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur de longitude, 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.'}; doc['Longitude']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'longitude.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['Longitude']['load_async']={syn:'Met en cache les valeurs courantes du capteur de longitude, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'longitude.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur de longitude, 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.'}; doc['Longitude']['nextLongitude']={syn:'Continue l\x27\xE9num\xE9ration des capteurs de longitude commenc\xE9e \xE0 l\x27aide de `yFirstLongitude()`.',lib:'longitude.nextLongitude()',pro:'function nextLongitude()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de longitude commenc\xE9e \xE0 l\x27aide de `yFirstLongitude()`.

',ret:'un pointeur sur un objet `YLongitude` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Longitude']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'longitude.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['Longitude']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'longitude.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['Longitude']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'longitude.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['Longitude']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'longitude.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['Longitude']['set_logicalName']={syn:'Modifie le nom logique du capteur de longitude.',lib:'longitude.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur de longitude. 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 longitude.'},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.'}; doc['Longitude']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'longitude.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['Longitude']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'longitude.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['Longitude']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'longitude.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['Longitude']['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:'longitude.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['Longitude']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'longitude.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Longitude']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'longitude.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['Longitude']['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:'longitude.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 machine virtuelle 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: Longitude) //--- (generated code: GroundSpeed) doc['GroundSpeed']={'':{syn:'Interface de la fonction GroundSpeed',inc:'<script type='text/javascript' src='yocto_groundspeed.js'></script>',cmt:'

La classe YGroundSpeed permet de lire la vitesse sol sur les capteurs de g\xE9olocalisation Yoctopuce. Elle h\xE9rite de la class YSensor toutes les fonctions de base des capteurs Yoctopuce: lecture de mesures, callbacks, enregistreur de donn\xE9es.

'}}; doc['GroundSpeed']['FindGroundSpeed']={syn:'Permet de retrouver un capteur de vitesse/sol d\x27apr\xE8s un identifiant donn\xE9.',lib:'YGroundSpeed.FindGroundSpeed()',pro:'function FindGroundSpeed(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que le capteur de vitesse/sol soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YGroundSpeed.isOnline()` pour tester si le capteur de vitesse/sol 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 le capteur de vitesse/sol sans ambigu\xEFt\xE9'},ret:'un objet de classe `YGroundSpeed` qui permet ensuite de contr\xF4ler le capteur de vitesse/sol.'}; doc['GroundSpeed']['FirstGroundSpeed']={syn:'Commence l\x27\xE9num\xE9ration des capteurs de vitesse/sol accessibles par la librairie.',lib:'YGroundSpeed.FirstGroundSpeed()',pro:'function FirstGroundSpeed()',cmt:'

Commence l\x27\xE9num\xE9ration des capteurs de vitesse/sol accessibles par la librairie. Utiliser la fonction `YGroundSpeed.nextGroundSpeed()` pour it\xE9rer sur les autres capteurs de vitesse/sol.

',ret:'un pointeur sur un objet `YGroundSpeed`, correspondant au premier capteur vitesse/sol accessible en ligne, ou `null` si il n\x27y a pas de capteurs de vitesse/sol disponibles.'}; doc['GroundSpeed']['calibrateFromPoints']={syn:'Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur.',lib:'groundspeed.calibrateFromPoints()',pro:'function calibrateFromPoints(rawValues, refValues)',cmt:'

Enregistre des points de correction de mesure, typiquement pour compenser l\x27effet d\x27un bo\xEEtier sur les mesures rendues par le capteur. Il est possible d\x27enregistrer jusqu\x27\xE0 cinq points de correction. Les points de correction doivent \xEAtre fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation lin\xE9aire de l\x27erreur entre les points sp\xE9cifi\xE9s. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module si le r\xE9glage doit \xEAtre pr\xE9serv\xE9.

Pour plus de plus amples possibilit\xE9s d\x27appliquer une surcalibration aux capteurs, veuillez contacter support@yoctopuce.com.

',par:{rawValues:'tableau de nombres flottants, correspondant aux valeurs brutes rendues par le capteur pour les points de correction.',refValues:'tableau de nombres flottants, correspondant aux valeurs corrig\xE9es d\xE9sir\xE9es pour les points de correction.'},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['GroundSpeed']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de vitesse/sol au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'groundspeed.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance du capteur de vitesse/sol 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 vitesse/sol (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['GroundSpeed']['get_advertisedValue']={syn:'Retourne la valeur courante du capteur de vitesse/sol (pas plus de 6 caract\xE8res).',lib:'groundspeed.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante du capteur de vitesse/sol (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['GroundSpeed']['get_currentRawValue']={syn:'Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en km/h, sous forme de nombre \xE0 virgule.',lib:'groundspeed.get_currentRawValue()',pro:'function get_currentRawValue()',cmt:'

Retourne la valeur brute retourn\xE9e par le capteur (sans arrondi ni calibration), en km/h, 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 km/h, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTRAWVALUE_INVALID`.'}; doc['GroundSpeed']['get_currentValue']={syn:'Retourne la valeur actuelle de la vitesse/sol, en km/h, sous forme de nombre \xE0 virgule.',lib:'groundspeed.get_currentValue()',pro:'function get_currentValue()',cmt:'

Retourne la valeur actuelle de la vitesse/sol, en km/h, sous forme de nombre \xE0 virgule.

',ret:'une valeur numérique représentant la valeur actuelle de la vitesse/sol, en km/h, sous forme de nombre \xE0 virgule',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CURRENTVALUE_INVALID`.'}; doc['GroundSpeed']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de vitesse/sol.',lib:'groundspeed.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de vitesse/sol. 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 vitesse/sol.'}; doc['GroundSpeed']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation du capteur de vitesse/sol.',lib:'groundspeed.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 vitesse/sol. 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 vitesse/sol.'}; doc['GroundSpeed']['get_friendlyName']={syn:'Retourne un identifiant global du capteur de vitesse/sol au format `NOM_MODULE.NOM_FONCTION`.',lib:'groundspeed.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de vitesse/sol en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['GroundSpeed']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'groundspeed.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['GroundSpeed']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel du capteur de vitesse/sol, sans r\xE9f\xE9rence au module.',lib:'groundspeed.get_functionId()',pro:'function get_functionId()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de vitesse/sol (ex: `relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FUNCTIONID_INVALID`.'}; doc['GroundSpeed']['get_hardwareId']={syn:'Retourne l\x27identifiant mat\xE9riel unique du capteur de vitesse/sol au format `SERIAL.FUNCTIONID`.',lib:'groundspeed.get_hardwareId()',pro:'function get_hardwareId()',cmt:'

Retourne l\x27identifiant mat\xE9riel unique du capteur de vitesse/sol 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 vitesse/sol (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant le capteur de vitesse/sol (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['GroundSpeed']['get_highestValue']={syn:'Retourne la valeur maximale observ\xE9e pour la vitesse/sol depuis le d\xE9marrage du module.',lib:'groundspeed.get_highestValue()',pro:'function get_highestValue()',cmt:'

Retourne la valeur maximale observ\xE9e pour la vitesse/sol depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur maximale observ\xE9e pour la vitesse/sol depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_HIGHESTVALUE_INVALID`.'}; doc['GroundSpeed']['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:'groundspeed.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 `Y_LOGFREQUENCY_INVALID`.'}; doc['GroundSpeed']['get_logicalName']={syn:'Retourne le nom logique du capteur de vitesse/sol.',lib:'groundspeed.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique du capteur de vitesse/sol.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique du capteur de vitesse/sol.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['GroundSpeed']['get_lowestValue']={syn:'Retourne la valeur minimale observ\xE9e pour la vitesse/sol depuis le d\xE9marrage du module.',lib:'groundspeed.get_lowestValue()',pro:'function get_lowestValue()',cmt:'

Retourne la valeur minimale observ\xE9e pour la vitesse/sol depuis le d\xE9marrage du module.

',ret:'une valeur numérique représentant la valeur minimale observ\xE9e pour la vitesse/sol depuis le d\xE9marrage du module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOWESTVALUE_INVALID`.'}; doc['GroundSpeed']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'groundspeed.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['GroundSpeed']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'groundspeed.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['GroundSpeed']['get_recordedData']={syn:'Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9.',lib:'groundspeed.get_recordedData()',pro:'function get_recordedData(startTime, endTime)',cmt:'

Retourne un objet DataSet repr\xE9sentant des mesures de ce capteur pr\xE9c\xE9demment enregistr\xE9es \xE0 l\x27aide du DataLogger, pour l\x27intervalle de temps sp\xE9cifi\xE9. Veuillez vous r\xE9f\xE9rer \xE0 la documentation de la classe DataSet pour plus plus d\x27informations sur la mani\xE8re d\x27obtenir un aper\xE7u des mesures pour la p\xE9riode, et comment charger progressivement une grande quantit\xE9 de mesures depuis le dataLogger.

Cette m\xE9thode ne fonctionne que si le module utilise un firmware r\xE9cent, car les objets DataSet ne sont pas support\xE9s par les firmwares ant\xE9rieurs \xE0 la r\xE9vision 13000.

',par:{startTime:'le d\xE9but de l\x27intervalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite sur le d\xE9but des mesures.',endTime:'la find de l\x27intercalle de mesure d\xE9sir\xE9, c\x27est \xE0 dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut \xEAtre utilis\xE9e pour ne poser aucune limite de fin.'},ret:'une instance de YDataSet, dont les m\xE9thodes permettent de d\x27acc\xE9der aux donn\xE9es historiques souhait\xE9es.'}; doc['GroundSpeed']['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:'groundspeed.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 `Y_REPORTFREQUENCY_INVALID`.'}; doc['GroundSpeed']['get_resolution']={syn:'Retourne la r\xE9solution des valeurs mesur\xE9es.',lib:'groundspeed.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.

',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 `Y_RESOLUTION_INVALID`.'}; doc['GroundSpeed']['get_unit']={syn:'Retourne l\x27unit\xE9 dans laquelle la vitesse/sol est exprim\xE9e.',lib:'groundspeed.get_unit()',pro:'function get_unit()',cmt:'

Retourne l\x27unit\xE9 dans laquelle la vitesse/sol est exprim\xE9e.

',ret:'une chaîne de caractères représentant l\x27unit\xE9 dans laquelle la vitesse/sol est exprim\xE9e',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_UNIT_INVALID`.'}; doc['GroundSpeed']['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:'groundspeed.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['GroundSpeed']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de vitesse/sol est joignable, sans d\xE9clencher d\x27erreur.',lib:'groundspeed.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de vitesse/sol est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de vitesse/sol 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 vitesse/sol est joignable, `false` sinon'}; doc['GroundSpeed']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant le capteur de vitesse/sol est joignable, sans d\xE9clencher d\x27erreur.',lib:'groundspeed.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant le capteur de vitesse/sol est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache du capteur de vitesse/sol 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.'}; doc['GroundSpeed']['load']={syn:'Met en cache les valeurs courantes du capteur de vitesse/sol, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'groundspeed.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes du capteur de vitesse/sol, 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.'}; doc['GroundSpeed']['loadCalibrationPoints']={syn:'R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.',lib:'groundspeed.loadCalibrationPoints()',pro:'function loadCalibrationPoints(rawValues, refValues)',cmt:'

R\xE9cup\xE8re les points de correction de mesure pr\xE9c\xE9demment enregistr\xE9s \xE0 l\x27aide de la m\xE9thode `calibrateFromPoints`.

',par:{rawValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs brutes des points de correction.',refValues:'tableau de nombres flottants, qui sera rempli par la fonction avec les valeurs d\xE9sir\xE9es des points de correction.'},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['GroundSpeed']['load_async']={syn:'Met en cache les valeurs courantes du capteur de vitesse/sol, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'groundspeed.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes du capteur de vitesse/sol, 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.'}; doc['GroundSpeed']['nextGroundSpeed']={syn:'Continue l\x27\xE9num\xE9ration des capteurs de vitesse/sol commenc\xE9e \xE0 l\x27aide de `yFirstGroundSpeed()`.',lib:'groundspeed.nextGroundSpeed()',pro:'function nextGroundSpeed()',cmt:'

Continue l\x27\xE9num\xE9ration des capteurs de vitesse/sol commenc\xE9e \xE0 l\x27aide de `yFirstGroundSpeed()`.

',ret:'un pointeur sur un objet `YGroundSpeed` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['GroundSpeed']['registerTimedReportCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique.',lib:'groundspeed.registerTimedReportCallback()',pro:'function registerTimedReportCallback(callback)',cmt:'

Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque notification p\xE9riodique. 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 callbacks peuvent se produire. Il est important d\x27appeler l\x27une de ces deux fonctions p\xE9riodiquement pour garantir que les callbacks 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 un objet YMeasure d\xE9crivant la nouvelle valeur publi\xE9e.'}}; doc['GroundSpeed']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'groundspeed.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['GroundSpeed']['set_highestValue']={syn:'Modifie la m\xE9moire de valeur maximale observ\xE9e.',lib:'groundspeed.set_highestValue()',pro:'function set_highestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur maximale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur maximale observ\xE9e'},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.'}; doc['GroundSpeed']['set_logFrequency']={syn:'Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger.',lib:'groundspeed.set_logFrequency()',pro:'function set_logFrequency(newval)',cmt:'

Modifie la fr\xE9quence d\x27enregistrement des mesures dans le datalogger. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver l\x27enregistrement des mesures de cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence d\x27enregistrement des mesures dans le datalogger'},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.'}; doc['GroundSpeed']['set_logicalName']={syn:'Modifie le nom logique du capteur de vitesse/sol.',lib:'groundspeed.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique du capteur de vitesse/sol. 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 vitesse/sol.'},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.'}; doc['GroundSpeed']['set_lowestValue']={syn:'Modifie la m\xE9moire de valeur minimale observ\xE9e.',lib:'groundspeed.set_lowestValue()',pro:'function set_lowestValue(newval)',cmt:'

Modifie la m\xE9moire de valeur minimale observ\xE9e.

',par:{newval:'une valeur numérique représentant la m\xE9moire de valeur minimale observ\xE9e'},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.'}; doc['GroundSpeed']['set_reportFrequency']={syn:'Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es.',lib:'groundspeed.set_reportFrequency()',pro:'function set_reportFrequency(newval)',cmt:'

Modifie la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es. La fr\xE9quence peut \xEAtre sp\xE9cifi\xE9e en mesures par secondes, en mesures par minutes (par exemple \x2215/m\x22) ou en mesures par heure (par exemple \x224/h\x22). Pour d\xE9sactiver les notifications p\xE9riodiques pour cette fonction, utilisez la valeur \x22OFF\x22.

',par:{newval:'une chaîne de caractères représentant la fr\xE9quence de notification p\xE9riodique des valeurs mesur\xE9es'},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.'}; doc['GroundSpeed']['set_resolution']={syn:'Modifie la r\xE9solution des valeurs physique mesur\xE9es.',lib:'groundspeed.set_resolution()',pro:'function set_resolution(newval)',cmt:'

Modifie la r\xE9solution des valeurs physique mesur\xE9es. La r\xE9solution correspond \xE0 la pr\xE9cision de l\x27affichage des mesures. Elle ne change pas la pr\xE9cision de la mesure elle-m\xEAme.

',par:{newval:'une valeur numérique représentant la r\xE9solution des valeurs physique mesur\xE9es'},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.'}; doc['GroundSpeed']['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:'groundspeed.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['GroundSpeed']['startDataLogger']={syn:'D\xE9marre l\x27enregistreur de donn\xE9es du module.',lib:'groundspeed.startDataLogger()',pro:'function startDataLogger()',cmt:'

D\xE9marre l\x27enregistreur de donn\xE9es du module. Attention, l\x27enregistreur ne sauvera les mesures de ce capteur que si la fr\xE9quence d\x27enregistrement (logFrequency) n\x27est pas sur \x22OFF\x22.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['GroundSpeed']['stopDataLogger']={syn:'Arr\xEAte l\x27enregistreur de donn\xE9es du module.',lib:'groundspeed.stopDataLogger()',pro:'function stopDataLogger()',cmt:'

Arr\xEAte l\x27enregistreur de donn\xE9es du module.

',ret:'`YAPI_SUCCESS` si l\x27op\xE9ration se d\xE9roule sans erreur.'}; doc['GroundSpeed']['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:'groundspeed.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 machine virtuelle 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: GroundSpeed) //--- (generated code: PowerOutput) doc['PowerOutput']={'':{syn:'Interface d\x27alimentation de sortie',inc:'<script type='text/javascript' src='yocto_poweroutput.js'></script>',cmt:'

La librairie de programmation Yoctopuce permet de contr\xF4ler l\x27alimentation mise a disposition sur certain module tels que le Yocto-Serial

'}}; doc['PowerOutput']['FindPowerOutput']={syn:'Permet de retrouver une alimentation d\x27apr\xE8s un identifiant donn\xE9.',lib:'YPowerOutput.FindPowerOutput()',pro:'function FindPowerOutput(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27alimentation soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YPowerOutput.isOnline()` pour tester si l\x27alimentation 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 l\x27alimentation sans ambigu\xEFt\xE9'},ret:'un objet de classe `YPowerOutput` qui permet ensuite de contr\xF4ler l\x27alimentation.'}; doc['PowerOutput']['FirstPowerOutput']={syn:'Commence l\x27\xE9num\xE9ration des alimentation accessibles par la librairie.',lib:'YPowerOutput.FirstPowerOutput()',pro:'function FirstPowerOutput()',cmt:'

Commence l\x27\xE9num\xE9ration des alimentation accessibles par la librairie. Utiliser la fonction `YPowerOutput.nextPowerOutput()` pour it\xE9rer sur les autres alimentation.

',ret:'un pointeur sur un objet `YPowerOutput`, correspondant \xE0 la premiere alimentation accessible en ligne, ou `null` si il n\x27y a pas de alimentation disponibles.'}; doc['PowerOutput']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27alimentation au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'poweroutput.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27alimentation 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\x27alimentation (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['PowerOutput']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27alimentation (pas plus de 6 caract\xE8res).',lib:'poweroutput.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27alimentation (pas plus de 6 caract\xE8res).

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

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27alimentation. 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\x27alimentation.'}; doc['PowerOutput']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27alimentation.',lib:'poweroutput.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\x27alimentation. 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\x27alimentation.'}; doc['PowerOutput']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27alimentation au format `NOM_MODULE.NOM_FONCTION`.',lib:'poweroutput.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27alimentation en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['PowerOutput']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'poweroutput.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['PowerOutput']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27alimentation, sans r\xE9f\xE9rence au module.',lib:'poweroutput.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27alimentation 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\x27alimentation (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27alimentation (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['PowerOutput']['get_logicalName']={syn:'Retourne le nom logique de l\x27alimentation.',lib:'poweroutput.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27alimentation.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27alimentation.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['PowerOutput']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'poweroutput.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['PowerOutput']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'poweroutput.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['PowerOutput']['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:'poweroutput.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['PowerOutput']['get_voltage']={syn:'Retourne voltage envoy\xE9 sur l\x27alimentation mise \xE0 disposition sur le module.',lib:'poweroutput.get_voltage()',pro:'function get_voltage()',cmt:'

Retourne voltage envoy\xE9 sur l\x27alimentation mise \xE0 disposition sur le module.

',ret:'une valeur parmi `Y_VOLTAGE_OFF`, `Y_VOLTAGE_OUT3V3` et `Y_VOLTAGE_OUT5V` représentant voltage envoy\xE9 sur l\x27alimentation mise \xE0 disposition sur le module',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_VOLTAGE_INVALID`.'}; doc['PowerOutput']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27alimentation est joignable, sans d\xE9clencher d\x27erreur.',lib:'poweroutput.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27alimentation est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27alimentation 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\x27alimentation est joignable, `false` sinon'}; doc['PowerOutput']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27alimentation est joignable, sans d\xE9clencher d\x27erreur.',lib:'poweroutput.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27alimentation est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27alimentation 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.'}; doc['PowerOutput']['load']={syn:'Met en cache les valeurs courantes de l\x27alimentation, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'poweroutput.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27alimentation, 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.'}; doc['PowerOutput']['load_async']={syn:'Met en cache les valeurs courantes de l\x27alimentation, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'poweroutput.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27alimentation, 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.'}; doc['PowerOutput']['nextPowerOutput']={syn:'Continue l\x27\xE9num\xE9ration des alimentation commenc\xE9e \xE0 l\x27aide de `yFirstPowerOutput()`.',lib:'poweroutput.nextPowerOutput()',pro:'function nextPowerOutput()',cmt:'

Continue l\x27\xE9num\xE9ration des alimentation commenc\xE9e \xE0 l\x27aide de `yFirstPowerOutput()`.

',ret:'un pointeur sur un objet `YPowerOutput` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['PowerOutput']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'poweroutput.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['PowerOutput']['set_logicalName']={syn:'Modifie le nom logique de l\x27alimentation.',lib:'poweroutput.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27alimentation. 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\x27alimentation.'},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.'}; doc['PowerOutput']['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:'poweroutput.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['PowerOutput']['set_voltage']={syn:'Modifie le voltage de l\x27alimentation mise \xE0 disposition par le module.',lib:'poweroutput.set_voltage()',pro:'function set_voltage(newval)',cmt:'

Modifie le voltage de l\x27alimentation mise \xE0 disposition par le module. 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 `Y_VOLTAGE_OFF`, `Y_VOLTAGE_OUT3V3` et `Y_VOLTAGE_OUT5V` représentant le voltage de l\x27alimentation mise \xE0 disposition par le 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.'}; doc['PowerOutput']['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:'poweroutput.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 machine virtuelle 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: PowerOutput) //--- (generated code: Cellular) doc['Cellular']={'':{syn:'Interface de la fonction Cellular',inc:'<script type='text/javascript' src='yocto_cellular.js'></script>',cmt:'

La fonction YCellular permet de configurer et de contr\xF4ler la configuration du r\xE9seau cellulaire sur les modules Yoctopuce qui en sont dot\xE9s.

'}}; doc['Cellular']['FindCellular']={syn:'Permet de retrouver une interface cellulaire d\x27apr\xE8s un identifiant donn\xE9.',lib:'YCellular.FindCellular()',pro:'function FindCellular(func)',cmt:'

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

- NomLogiqueFonction
- NoSerieModule.IdentifiantFonction
- NoSerieModule.NomLogiqueFonction
- NomLogiqueModule.IdentifiantMat\xE9riel
- NomLogiqueModule.NomLogiqueFonction

Cette fonction n\x27exige pas que l\x27interface cellulaire soit en ligne au moment ou elle est appel\xE9e, l\x27objet retourn\xE9 sera n\xE9anmoins valide. Utiliser la m\xE9thode `YCellular.isOnline()` pour tester si l\x27interface cellulaire 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 l\x27interface cellulaire sans ambigu\xEFt\xE9'},ret:'un objet de classe `YCellular` qui permet ensuite de contr\xF4ler l\x27interface cellulaire.'}; doc['Cellular']['FirstCellular']={syn:'Commence l\x27\xE9num\xE9ration des interfaces r\xE9seau cellulaire accessibles par la librairie.',lib:'YCellular.FirstCellular()',pro:'function FirstCellular()',cmt:'

Commence l\x27\xE9num\xE9ration des interfaces r\xE9seau cellulaire accessibles par la librairie. Utiliser la fonction `YCellular.nextCellular()` pour it\xE9rer sur les autres interfaces r\xE9seau cellulaire.

',ret:'un pointeur sur un objet `YCellular`, correspondant \xE0 la premi\xE8re interface cellulaire accessible en ligne, ou `null` si il n\x27y a pas de interfaces r\xE9seau cellulaire disponibles.'}; doc['Cellular']['describe']={syn:'Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27interface cellulaire au format `TYPE(NAME)=SERIAL.FUNCTIONID`.',lib:'cellular.describe()',pro:'function describe()',cmt:'

Retourne un court texte d\xE9crivant de mani\xE8re non-ambig\xFCe l\x27instance de l\x27interface cellulaire 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 cellulaire (ex: `Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1`)'}; doc['Cellular']['get_advertisedValue']={syn:'Retourne la valeur courante de l\x27interface cellulaire (pas plus de 6 caract\xE8res).',lib:'cellular.get_advertisedValue()',pro:'function get_advertisedValue()',cmt:'

Retourne la valeur courante de l\x27interface cellulaire (pas plus de 6 caract\xE8res).

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant la valeur courante de l\x27interface cellulaire (pas plus de 6 caract\xE8res).',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_ADVERTISEDVALUE_INVALID`.'}; doc['Cellular']['get_apn']={syn:'Retourne le nom du point d\x27acc\xE8s (APN) \xE0 utiliser, si n\xE9cessaire.',lib:'cellular.get_apn()',pro:'function get_apn()',cmt:'

Retourne le nom du point d\x27acc\xE8s (APN) \xE0 utiliser, si n\xE9cessaire. Lorsque l\x27APN est vide, celui propos\xE9 par l\x27op\xE9rateur cellulaire est utilis\xE9e.

',ret:'une chaîne de caractères représentant le nom du point d\x27acc\xE8s (APN) \xE0 utiliser, si n\xE9cessaire',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_APN_INVALID`.'}; doc['Cellular']['get_apnSecret']={syn:'Retourne une string opaque si des param\xE8tres d\x27identification sur l\x27APN ont \xE9t\xE9 configur\xE9s dans le module, ou une cha\xEEne vide autrement.',lib:'cellular.get_apnSecret()',pro:'function get_apnSecret()',cmt:'

Retourne une string opaque si des param\xE8tres d\x27identification sur l\x27APN ont \xE9t\xE9 configur\xE9s dans le module, ou une cha\xEEne vide autrement. Pour configurer ces param\xE8tres, utilisez la m\xE9thode `set_apnAuth()`.

',ret:'une chaîne de caractères représentant une string opaque si des param\xE8tres d\x27identification sur l\x27APN ont \xE9t\xE9 configur\xE9s dans le module, ou une cha\xEEne vide autrement',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_APNSECRET_INVALID`.'}; doc['Cellular']['get_cellOperator']={syn:'Retourne le nom de l\x27op\xE9rateur de r\xE9seau cellulaire actuellement utilis\xE9.',lib:'cellular.get_cellOperator()',pro:'function get_cellOperator()',cmt:'

Retourne le nom de l\x27op\xE9rateur de r\xE9seau cellulaire actuellement utilis\xE9.

',ret:'une chaîne de caractères représentant le nom de l\x27op\xE9rateur de r\xE9seau cellulaire actuellement utilis\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_CELLOPERATOR_INVALID`.'}; doc['Cellular']['get_enableData']={syn:'Retourne la condition dans laquelle le service de donn\xE9es IP (GRPS) doit \xEAtre activ\xE9.',lib:'cellular.get_enableData()',pro:'function get_enableData()',cmt:'

Retourne la condition dans laquelle le service de donn\xE9es IP (GRPS) doit \xEAtre activ\xE9. Lorsque le service de donn\xE9e n\x27est pas actif, seules les communications par SMS sont possibles.

',ret:'une valeur parmi `Y_ENABLEDATA_HOMENETWORK`, `Y_ENABLEDATA_ROAMING` et `Y_ENABLEDATA_NEVER` représentant la condition dans laquelle le service de donn\xE9es IP (GRPS) doit \xEAtre activ\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_ENABLEDATA_INVALID`.'}; doc['Cellular']['get_errorMessage']={syn:'Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface cellulaire.',lib:'cellular.get_errorMessage()',pro:'function get_errorMessage()',cmt:'

Retourne le message correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface cellulaire. 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 cellulaire.'}; doc['Cellular']['get_errorType']={syn:'Retourne le code d\x27erreur correspondant \xE0 la derni\xE8re erreur survenue lors de l\x27utilisation de l\x27interface cellulaire.',lib:'cellular.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 cellulaire. 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 cellulaire.'}; doc['Cellular']['get_friendlyName']={syn:'Retourne un identifiant global de l\x27interface cellulaire au format `NOM_MODULE.NOM_FONCTION`.',lib:'cellular.get_friendlyName()',pro:'function get_friendlyName()',cmt:'

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

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27interface cellulaire en utilisant les noms logiques (ex: `MyCustomName.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_FRIENDLYNAME_INVALID`.'}; doc['Cellular']['get_functionDescriptor']={syn:'Retourne un identifiant unique de type `YFUN_DESCR` correspondant \xE0 la fonction.',lib:'cellular.get_functionDescriptor()',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`.',ext:'Si la fonction n\x27a jamais \xE9t\xE9 contact\xE9e, la valeur retourn\xE9e sera `Y_FUNCTIONDESCRIPTOR_INVALID`'}; doc['Cellular']['get_functionId']={syn:'Retourne l\x27identifiant mat\xE9riel de l\x27interface cellulaire, sans r\xE9f\xE9rence au module.',lib:'cellular.get_functionId()',pro:'function get_functionId()',cmt:'

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

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

Retourne l\x27identifiant mat\xE9riel unique de l\x27interface cellulaire 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 cellulaire (par example `RELAYLO1-123456.relay1`).

',ret:'une cha\xEEne de caract\xE8res identifiant l\x27interface cellulaire (ex: `RELAYLO1-123456.relay1`)',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_HARDWAREID_INVALID`.'}; doc['Cellular']['get_linkQuality']={syn:'Retourne la qualit\xE9 de la connection, exprim\xE9e en pourcents.',lib:'cellular.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 `Y_LINKQUALITY_INVALID`.'}; doc['Cellular']['get_lockedOperator']={syn:'Retourne le nom de l\x27op\xE9rateur de r\xE9seau cellulaire \xE0 utiliser exclusivement, si le choix automatique est d\xE9sactiv\xE9, ou une cha\xEEne vide si la carte SIM s\xE9lectionne automatiquement l\x27op\xE9rateur selon ceux disponibles.',lib:'cellular.get_lockedOperator()',pro:'function get_lockedOperator()',cmt:'

Retourne le nom de l\x27op\xE9rateur de r\xE9seau cellulaire \xE0 utiliser exclusivement, si le choix automatique est d\xE9sactiv\xE9, ou une cha\xEEne vide si la carte SIM s\xE9lectionne automatiquement l\x27op\xE9rateur selon ceux disponibles.

',ret:'une chaîne de caractères représentant le nom de l\x27op\xE9rateur de r\xE9seau cellulaire \xE0 utiliser exclusivement, si le choix automatique est d\xE9sactiv\xE9, ou une cha\xEEne vide si la carte SIM s\xE9lectionne automatiquement l\x27op\xE9rateur selon ceux disponibles',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_LOCKEDOPERATOR_INVALID`.'}; doc['Cellular']['get_logicalName']={syn:'Retourne le nom logique de l\x27interface cellulaire.',lib:'cellular.get_logicalName()',pro:'function get_logicalName()',cmt:'

Retourne le nom logique de l\x27interface cellulaire.

',ret:'une cha\xEEne de caract\xE8res repr\xE9sentant le nom logique de l\x27interface cellulaire.',ext:'En cas d\x27erreur, d\xE9clenche une exception ou retourne `Y_LOGICALNAME_INVALID`.'}; doc['Cellular']['get_message']={syn:'Retourne le dernier message de diagnostique de l\x27interface au r\xE9seau sans fil.',lib:'cellular.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 `Y_MESSAGE_INVALID`.'}; doc['Cellular']['get_module']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'cellular.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['Cellular']['get_module_async']={syn:'Retourne l\x27objet `YModule` correspondant au module Yoctopuce qui h\xE9berge la fonction.',lib:'cellular.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['Cellular']['get_pin']={syn:'Retourne une string opaque si un code PIN a \xE9t\xE9 configur\xE9 dans le module pour acc\xE9der \xE0 la carte SIM, ou une cha\xEEne vide il n\x27a pas \xE9t\xE9 configur\xE9 ou si la SIM a rejet\xE9 le code indiqu\xE9.',lib:'cellular.get_pin()',pro:'function get_pin()',cmt:'

Retourne une string opaque si un code PIN a \xE9t\xE9 configur\xE9 dans le module pour acc\xE9der \xE0 la carte SIM, ou une cha\xEEne vide il n\x27a pas \xE9t\xE9 configur\xE9 ou si la SIM a rejet\xE9 le code indiqu\xE9.

',ret:'une chaîne de caractères représentant une string opaque si un code PIN a \xE9t\xE9 configur\xE9 dans le module pour acc\xE9der \xE0 la carte SIM, ou une cha\xEEne vide il n\x27a pas \xE9t\xE9 configur\xE9 ou si la SIM a rejet\xE9 le code indiqu\xE9',ext:'En cas d\x27erreur, déclenche une exception ou retourne `Y_PIN_INVALID`.'}; doc['Cellular']['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:'cellular.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['Cellular']['isOnline']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface cellulaire est joignable, sans d\xE9clencher d\x27erreur.',lib:'cellular.isOnline()',pro:'function isOnline()',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27interface cellulaire est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27interface cellulaire 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 cellulaire est joignable, `false` sinon'}; doc['Cellular']['isOnline_async']={syn:'V\xE9rifie si le module h\xE9bergeant l\x27interface cellulaire est joignable, sans d\xE9clencher d\x27erreur.',lib:'cellular.isOnline_async()',pro:'function isOnline_async(callback, context)',cmt:'

V\xE9rifie si le module h\xE9bergeant l\x27interface cellulaire est joignable, sans d\xE9clencher d\x27erreur. Si les valeurs des attributs en cache de l\x27interface cellulaire 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.'}; doc['Cellular']['load']={syn:'Met en cache les valeurs courantes de l\x27interface cellulaire, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'cellular.load()',pro:'function load(msValidity)',cmt:'

Met en cache les valeurs courantes de l\x27interface cellulaire, 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.'}; doc['Cellular']['load_async']={syn:'Met en cache les valeurs courantes de l\x27interface cellulaire, avec une dur\xE9e de validit\xE9 sp\xE9cifi\xE9e.',lib:'cellular.load_async()',pro:'function load_async(msValidity, callback, context)',cmt:'

Met en cache les valeurs courantes de l\x27interface cellulaire, 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.'}; doc['Cellular']['nextCellular']={syn:'Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau cellulaire commenc\xE9e \xE0 l\x27aide de `yFirstCellular()`.',lib:'cellular.nextCellular()',pro:'function nextCellular()',cmt:'

Continue l\x27\xE9num\xE9ration des interfaces r\xE9seau cellulaire commenc\xE9e \xE0 l\x27aide de `yFirstCellular()`.

',ret:'un pointeur sur un objet `YCellular` accessible en ligne, ou `null` lorsque l\x27\xE9num\xE9ration est termin\xE9e.'}; doc['Cellular']['quickCellSurvey']={syn:'Retourne la liste d\x27identifiants pour les antennes GSM \xE0 proximit\xE9, telle que requise pour g\xE9olocaliser rapidement le module.',lib:'cellular.quickCellSurvey()',pro:'function quickCellSurvey()',cmt:'

Retourne la liste d\x27identifiants pour les antennes GSM \xE0 proximit\xE9, telle que requise pour g\xE9olocaliser rapidement le module. La premi\xE8re antenne list\xE9e est la cellule active, et les suivantes sont les cellules voisines list\xE9e par la cellule active.

',ret:'une liste de YCellRecord.'}; doc['Cellular']['registerValueCallback']={syn:'Enregistre la fonction de callback qui est appel\xE9e \xE0 chaque changement de la valeur publi\xE9e.',lib:'cellular.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['Cellular']['sendPUK']={syn:'Envoie le code PUK \xE0 la carte SIM pour la d\xE9bloquer apr\xE8s trois \xE9checs cons\xE9cutifs de code PIN, et \xE9tablit un nouveau code PIN dans la SIM.',lib:'cellular.sendPUK()',pro:'function sendPUK(puk, newPin)',cmt:'

Envoie le code PUK \xE0 la carte SIM pour la d\xE9bloquer apr\xE8s trois \xE9checs cons\xE9cutifs de code PIN, et \xE9tablit un nouveau code PIN dans la SIM. Seules dix tentatives cons\xE9cutives de d\xE9blocage sont possibles: apr\xE8s dix tentatives infructueuses, la carte SIM sera d\xE9finitivement inutilisable. Apr\xE8s avoir appel\xE9 cette fonction, vous devrez aussi appeler la m\xE9thode `set_pin()` pour indiquer au YoctoHub le nouveau PIN \xE0 utiliser dans le futur.

',par:{puk:'code PUK de la carte SIM',newPin:'nouveau code PIN \xE0 configurer dans la carte SIM'},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['Cellular']['set_apn']={syn:'Retourne le nom du point d\x27acc\xE8s (APN) \xE0 utiliser, si n\xE9cessaire.',lib:'cellular.set_apn()',pro:'function set_apn(newval)',cmt:'

Retourne le nom du point d\x27acc\xE8s (APN) \xE0 utiliser, si n\xE9cessaire. Lorsque l\x27APN est vide, celui propos\xE9 par l\x27op\xE9rateur cellulaire est utilis\xE9e.

',par:{newval:'une chaîne de caractères'},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.'}; doc['Cellular']['set_apnAuth']={syn:'Configure les param\xE8tres d\x27identification pour se connecter \xE0 l\x27APN.',lib:'cellular.set_apnAuth()',pro:'function set_apnAuth(username, password)',cmt:'

Configure les param\xE8tres d\x27identification pour se connecter \xE0 l\x27APN. Les protocoles PAP et CHAP sont tous deux support\xE9s.

',par:{username:'nom d\x27utilisateur',password:'mot de passe'},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['Cellular']['set_enableData']={syn:'Modifie la condition dans laquelle le service de donn\xE9es IP (GRPS) doit \xEAtre activ\xE9.',lib:'cellular.set_enableData()',pro:'function set_enableData(newval)',cmt:'

Modifie la condition dans laquelle le service de donn\xE9es IP (GRPS) doit \xEAtre activ\xE9. Le service peut \xEAtre soit compl\xE8tement d\xE9sactiv\xE9, soit limit\xE9 au r\xE9seau de de l\x27\xE9metteur de la carte SIM, soit \xEAtre activ\xE9 pour tous les r\xE9seaux en partenariat avec la carte SIM (roaming). Attention, l\x27utilisation de donn\xE9es en roaming peut conduire \xE0 des co\xFBts de t\xE9l\xE9communication exhorbitants ! Lorsque le service de donn\xE9e n\x27est pas actif, seules les communications par SMS sont possibles.

',par:{newval:'une valeur parmi `Y_ENABLEDATA_HOMENETWORK`, `Y_ENABLEDATA_ROAMING` et `Y_ENABLEDATA_NEVER` représentant la condition dans laquelle le service de donn\xE9es IP (GRPS) doit \xEAtre activ\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.'}; doc['Cellular']['set_lockedOperator']={syn:'Modifie le nom de l\x27op\xE9rateur de r\xE9seau cellulaire \xE0 utiliser.',lib:'cellular.set_lockedOperator()',pro:'function set_lockedOperator(newval)',cmt:'

Modifie le nom de l\x27op\xE9rateur de r\xE9seau cellulaire \xE0 utiliser. Si le nom est une cha\xEEne vide, le choix sera fait automatiquement selon la carte SIM. Sinon, seul l\x27op\xE9rateur choisi sera utilis\xE9.

',par:{newval:'une chaîne de caractères représentant le nom de l\x27op\xE9rateur de r\xE9seau cellulaire \xE0 utiliser'},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.'}; doc['Cellular']['set_logicalName']={syn:'Modifie le nom logique de l\x27interface cellulaire.',lib:'cellular.set_logicalName()',pro:'function set_logicalName(newval)',cmt:'

Modifie le nom logique de l\x27interface cellulaire. 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 cellulaire.'},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.'}; doc['Cellular']['set_pin']={syn:'Modifie le code PIN utilis\xE9 par le module pour acc\xE9der \xE0 la carte SIM.',lib:'cellular.set_pin()',pro:'function set_pin(newval)',cmt:'

Modifie le code PIN utilis\xE9 par le module pour acc\xE9der \xE0 la carte SIM. Cette fonction ne change pas le code sur la carte SIM elle-m\xEAme, mais uniquement le param\xE8tre utilis\xE9 par le module pour essayer d\x27en obtenir l\x27acc\xE8s. Si le code SIM ne fonctionne pas d\xE8s le premier essai, il sera automatiquement oubli\xE9 et un message \x22Enter SIM PIN\x22 appara\xEEtre dans l\x27attribut \x27message\x27. Il faudra alors appeler \xE0 nouveau cette m\xE9thode avec le bon code PIN. Apr\xE8s trois essais infructueux cons\xE9cutifs le message devient \x22Enter SIM PUK\x22 et il faut alors entrer le code PUK de la carte SIM avec la m\xE9thode `sendPUK`. N\x27oubliez pas d\x27appeler la m\xE9thode `saveToFlash()` du module pour que le param\xE8tre soit sauvegard\xE9 dans la flash.

',par:{newval:'une chaîne de caractères représentant le code PIN utilis\xE9 par le module pour acc\xE9der \xE0 la carte SIM'},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.'}; doc['Cellular']['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:'cellular.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['Cellular']['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:'cellular.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 machine virtuelle 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: Cellular) //--- (end of generated code) function isClassMethod(str_method) { return str_method.charAt(0) == str_method.charAt(0).toUpperCase(); } // add function aliases to the substitution list for(classname in doc) { for(funcname in doc[classname]) { if(isClassMethod(funcname)) { // class method, generate shortcut sub['y'+funcname] = doc[classname][funcname].lib; } } } function ApplySub(text,classname) { var pos, endpos = 0, key, rep; if(sub['null'] != 'null') text = text.replace('`null`','`'+sub['null']+'`'); if(UseShortcuts) return text; if(classname.substr(0,1)!='Y') classname = 'Y'+classname; while((pos = text.toLowerCase().indexOf('`',endpos)) >= endpos) { pos += 4; endpos = text.indexOf('=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) { //onDragMove & onDragMove are optinnals callbacks fct(DomElement,position) where position is an associtative array "x","y 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; // ie; if ((event.button!=0) && (document.addEventListener)) return; // other; } if (!source) source= this; if (!source) return; var originalsource=source; while (source.tagName!="DIV") { if (source.tagName=="A") return false; // there is a link (a probably a button) on the way: cancel drag 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(str_classindex, m) { var funcproto = doc[str_classindex][m].pro; if(isClassMethod(m)) { if(UseShortcuts) { funcproto = funcproto.replace(m, 'y'+m); } else if(doc[str_classindex][m].lib.substr(0,1) == '[' && funcproto.substr(0,1) != '+') { var params = doc[str_classindex][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(str_classindex,str_name) { if ((str_classindex=='')&&(str_name=='')) { document.getElementById("FunctionsLayerInner").innerHTML =NotFound; return; } var fcthtml=''; fcthtml = ""; lastindex_shown =str_classindex; if (str_name) { lastname_shown = str_name; var fct = doc[str_classindex][str_name]; var funcname = fct.lib; var funcproto = proto(str_classindex, str_name); if(UseShortcuts && isClassMethod(str_name)) { funcname = 'y'+str_name+'()'; } fcthtml = ""+funcname+'' +"
"+funcproto+'' +'
'+ApplySub(fct.cmt,str_classindex); if (fct.par) { fcthtml += ""+ParamLabel+'
\n'; fcthtml +='

' for (var p in fct.par) fcthtml +='
'+p+' | : '+ApplySub(fct.par[p],str_classindex)+'
\n'; fcthtml +='

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

'+ApplySub(fct.ret,str_classindex)+'

\n'; } if (fct.ext) fcthtml+=ApplySub(fct.ext,str_classindex); } else if (str_classindex!='') { fcthtml = ""+str_classindex+'
' + "

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

" + "

"+IncludeLabel+"

" + "

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

" + "

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

"; for (m in doc[str_classindex]) { if (m!='') { var funcproto = proto(str_classindex, m); fcthtml +="

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

'; } } } document.getElementById("FunctionsLayerInner").innerHTML = fcthtml; } function expand(source,openonly) { if (document.getElementById(source.id+"List").style.display=='' && !openonly) { document.getElementById(source.id+"List").style.display='none'; document.getElementById(source.id).src=plusimage; } else { document.getElementById(source.id+"List").style.display=''; document.getElementById(source.id).src=minusimage; } } function ShowFunctions(str_currentClassName) { var marginhtml = ""; for (var classname in doc) { var icon = plusimage; var fct = "expand"; var display = "none" if (str_currentClassName==classname) { icon = minusimage; fct = "expand"; display = "" } marginhtml = marginhtml+" "; marginhtml = marginhtml+""+classname+'
'; marginhtml = marginhtml+ "
"; for (var method in doc[classname]) { if (method!='') { var funcname = doc[classname][method].lib; if(UseShortcuts && isClassMethod(method)) funcname = 'y'+method+'()'; marginhtml = marginhtml+""+funcname+''; } } marginhtml = marginhtml+'
' } document.getElementById("MarginLayer").innerHTML = marginhtml; } function fctMatch(classname,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 classname in doc) { var container = document.getElementById(classname+"List"); for (var method in doc[classname]) if (method!='') { var it = document.getElementById(classname+'.'+method); if (it) it.style.display="block"; } document.getElementById(classname).style.visibility='visible'; var container = document.getElementById(classname+"List"); if (container["originalDisplay"]!="") { document.getElementById(classname+"List").style.display='none'; document.getElementById(classname).src=plusimage; } else { document.getElementById(classname+"List").style.display=''; document.getElementById(classname).src=minusimage; } container["originalDisplay"]=null; } Show(lastindex_shown,lastname_shown); return; } var firstindex = ''; var firstname = ''; qvalue = value; value = ''; for(var i = 0; i < qvalue.length; i++) { var c = qvalue.charAt(i); if(c == '\\' || c == '[' || c == ']' || c == '(' || c == ')') { value += '.'; } else { if (c!=' ') value+='['+qvalue.charAt(i)+']'; else value+=' '; } } for (var classname in doc) { var matchfound=false; var container = document.getElementById(classname+"List"); if (!container["originalDisplay"]) container["originalDisplay"]=null; if (container["originalDisplay"]==null) container["originalDisplay"] = container.style.display; values = value.split(' '); for (var method in doc[classname]) { var it = document.getElementById(classname+'.'+method); var match = fctMatch(classname,method,values); if (match) { if (it) it.style.display="block"; matchfound=true; if (firstindex=='') {firstindex=classname; firstname = method;} } else { if (it) it.style.display="none"; } } if (matchfound) { document.getElementById(classname+"List").style.display=''; document.getElementById(classname).src=minusimage; document.getElementById(classname).style.visibility='visible'; } else { document.getElementById(classname+"List").style.display='none'; document.getElementById(classname).style.visibility='hidden'; document.getElementById(classname).src=plusimage; } } Show(firstindex,firstname); } function initSearch() { if (searchTimer!=null) clearTimeout(searchTimer); searchTimer = setTimeout('doSearch()',500); } function sortObject(o) { var sorted = {}, key, a = []; for (key in o) { if (key != 'YAPI' && o.hasOwnProperty(key)) { a.push(key); } } a.sort(); if (o['YAPI']) sorted['YAPI']=o['YAPI']; for (key = 0; key < a.length; key++) { sorted[a[key]] = o[a[key]]; } return sorted; } function OOcheckboxChange() { UseShortcuts = document.forms["yoctoForm"].elements["OOcheckbox"].checked; ShowFunctions(lastindex_shown); Show(lastindex_shown,lastname_shown); } -->`

| www.yoctopuce.com