Yoctopuce Yocto Thermocouple Mode d'emploi

describe()

Retourne un court texte décrivant le module.

module

download(

pathname )

Télécharge le fichier choisi du module et retourne son contenu.

module

functionCount()

Retourne le nombre de fonctions (sans compter l'interface "module") existant sur le module.

module

functionId(

functionIndex )

Retourne l'identifiant matériel de la nième fonction du module.

module

functionName(

functionIndex )

Retourne le nom logique de la nième fonction du module.

module

functionValue(

functionIndex )

Retourne la valeur publiée par la nième fonction du module.

module

get_beacon()

Retourne l'état de la balise de localisation.

module

get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.

module

get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.

module

get_firmwareRelease()

Retourne la version du logiciel embarqué du module.

module

Retourne l'identifiant unique du module.

module

get_icon2d()

www.yoctopuce.com

151

19. Référence de l'API de haut niveau

Retourne l'icône du module.

module

get_lastLogs()

Retourne une chaine de charactère contenant les derniers logs du module.

module

get_logicalName()

Retourne le nom logique du module.

module

get_luminosity()

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

module

get_persistentSettings()

Retourne l'état courant des réglages persistents du module.

module

get_productId()

Retourne l'identifiant USB du module, préprogrammé en usine.

module

get_productName()

Retourne le nom commercial du module, préprogrammé en usine.

module

get_productRelease()

Retourne le numéro de version matériel du module, préprogrammé en usine.

module

get_rebootCountdown()

Retourne le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé.

module

get_serialNumber()

Retourne le numéro de série du module, préprogrammé en usine.

module

get_upTime()

Retourne le numbre de millisecondes écoulées depuis la mise sous tension du module

module

get_usbBandwidth()

Retourne le nombre d'interface USB utilisé par le module.

module

get_usbCurrent()

Retourne le courant consommé par le module sur le bus USB, en milliampères.

module

get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData .

module

isOnline()

Vérifie si le module est joignable, sans déclencher d'erreur.

module

isOnline_async(

callback , context )

Vérifie si le module est joignable, sans déclencher d'erreur.

module

load(

msValidity )

Met en cache les valeurs courantes du module, avec une durée de validité spécifiée.

module

load_async(

msValidity , callback , context )

Met en cache les valeurs courantes du module, avec une durée de validité spécifiée.

module

nextModule()

Continue l'énumération des modules commencée à l'aide de yFirstModule() .

module

reboot(

secBeforeReboot )

Agende un simple redémarrage du module dans un nombre donné de secondes.

module

revertFromFlash()

Recharge les réglages stockés dans le mémoire non volatile du module, comme à la mise sous tension du module.

module

saveToFlash()

Sauve les réglages courants dans la mémoire non volatile du module.

module

set_beacon(

newval )

152 www.yoctopuce.com

19. Référence de l'API de haut niveau

Allume ou éteint la balise de localisation du module.

module

set_logicalName(

newval )

Change le nom logique du module.

module

set_luminosity(

newval )

Modifie la luminosité des leds informatives du module.

module

set_usbBandwidth(

newval )

Modifie le nombre d'interface USB utilisé par le module.

module

set_userData(

data )

Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData .

module

triggerFirmwareUpdate(

secBeforeReboot )

Agende un redémarrage du module en mode spécial de reprogrammation du logiciel embarqué.

module

wait_async(

callback , context )

Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre.

www.yoctopuce.com

153

19. Référence de l'API de haut niveau

YModule.FindModule() yFindModule()

YModule

Permet de retrouver un module d'après son numéro de série ou son nom logique.

js function yFindModule( func ) nodejs function FindModule( func ) php cpp m pas function yFindModule( $func )

YModule* yFindModule( string func )

+(YModule*) yFindModule : (NSString*) func function yFindModule( func : string): TYModule vb cs java py function yFindModule( ByVal func As String) As YModule

YModule FindModule( string func )

YModule FindModule( String func ) def FindModule( func )

Cette fonction n'exige pas que le module soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YModule.isOnline() pour tester si le module est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée. La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres : func une chaîne de caractères contenant soit le numéro de série, soit le nom logique du module désiré

Retourne : un objet de classe YModule qui permet ensuite de contrôler le module ou d'obtenir de plus amples informations sur le module.

154 www.yoctopuce.com

YModule.FirstModule() yFirstModule()

19. Référence de l'API de haut niveau

YModule

Commence l'énumération des modules accessibles par la librairie.

js nodejs function yFirstModule( ) function FirstModule( ) php cpp function yFirstModule( )

YModule* yFirstModule( ) m pas vb cs java py

YModule* yFirstModule( ) function yFirstModule( ): TYModule function yFirstModule( ) As YModule

YModule FirstModule( )

YModule FirstModule( ) def FirstModule( )

Utiliser la fonction YModule.nextModule() pour itérer sur les autres modules.

Retourne : un pointeur sur un objet YModule , correspondant au premier module accessible en ligne, ou null si aucun module n'a été trouvé.

www.yoctopuce.com

155

19. Référence de l'API de haut niveau module

→ describe()

Retourne un court texte décrivant le module.

js function describe( ) nodejs function describe( ) php function describe( ) cpp m pas vb cs java py string describe( )

-(NSString*) describe function describe( ): string function describe( ) As String string describe( )

String describe( ) def describe( )

Ce texte peut contenir soit le nom logique du module, soit son numéro de série.

Retourne : une chaîne de caractères décrivant le module

YModule

156 www.yoctopuce.com

module

→ download()

Télécharge le fichier choisi du module et retourne son contenu.

js function download( pathname ) nodejs function download( pathname ) php function download( $pathname ) cpp m pas vb py cmd string download( string pathname )

-(NSData*) download : (NSString*) pathname function download( pathname : string): TByteArray function download( ) As Byte def download( pathname )

YModule target download pathname

Paramètres : pathname nom complet du fichier

Retourne : le contenu du fichier chargé

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

19. Référence de l'API de haut niveau

YModule www.yoctopuce.com

157

19. Référence de l'API de haut niveau module

→ functionCount() YModule

Retourne le nombre de fonctions (sans compter l'interface "module") existant sur le module.

js function functionCount( ) nodejs function functionCount( ) php function functionCount( ) cpp m pas vb cs py int functionCount( )

-(int) functionCount function functionCount( ): integer function functionCount( ) As Integer int functionCount( ) def functionCount( )

Retourne : le nombre de fonctions sur le module

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

158 www.yoctopuce.com

module

→ functionId()

Retourne l'identifiant matériel de la nième fonction du module.

js function functionId( functionIndex ) nodejs function functionId( functionIndex ) php function functionId( $functionIndex ) cpp m pas vb cs py string functionId( int functionIndex )

-(NSString*) functionId : (int) functionIndex function functionId( functionIndex : integer): string function functionId( ByVal functionIndex As Integer) As String string functionId( int functionIndex ) def functionId( functionIndex )

19. Référence de l'API de haut niveau

YModule

Paramètres : functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 0 pour la première fonction.

Retourne : une chaîne de caractères correspondant à l'identifiant matériel unique de la fonction désirée

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

www.yoctopuce.com

159

19. Référence de l'API de haut niveau module

→ functionName()

Retourne le nom logique de la nième fonction du module.

js function functionName( functionIndex ) nodejs function functionName( functionIndex ) php function functionName( $functionIndex ) cpp m pas vb cs py string functionName( int functionIndex )

-(NSString*) functionName : (int) functionIndex function functionName( functionIndex : integer): string function functionName( ByVal functionIndex As Integer) As String string functionName( int functionIndex ) def functionName( functionIndex )

YModule

Paramètres : functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 0 pour la première fonction.

Retourne : une chaîne de caractères correspondant au nom logique de la fonction désirée

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

160 www.yoctopuce.com

module

→ functionValue()

Retourne la valeur publiée par la nième fonction du module.

js function functionValue( functionIndex ) nodejs function functionValue( functionIndex ) php function functionValue( $functionIndex ) cpp m pas vb cs py string functionValue( int functionIndex )

-(NSString*) functionValue : (int) functionIndex function functionValue( functionIndex : integer): string function functionValue( ByVal functionIndex As Integer) As String string functionValue( int functionIndex ) def functionValue( functionIndex )

19. Référence de l'API de haut niveau

YModule

Paramètres : functionIndex l'index de la fonction pour laquelle l'information est désirée, en commençant à 0 pour la première fonction.

Retourne : une chaîne de caractères correspondant à la valeur publiée par la fonction désirée

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

www.yoctopuce.com

161

19. Référence de l'API de haut niveau module

→ get_beacon() module

→ beacon()

Retourne l'état de la balise de localisation.

js function get_beacon( ) nodejs function get_beacon( ) php cpp m pas function get_beacon( )

Y_BEACON_enum get_beacon( )

-(Y_BEACON_enum) beacon function get_beacon( ): Integer vb cs java py cmd function get_beacon( ) As Integer int get_beacon( ) int get_beacon( ) def get_beacon( )

YModule target get_beacon

Retourne : soit Y_BEACON_OFF , soit Y_BEACON_ON , selon l'état de la balise de localisation

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

YModule

162 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ get_errorMessage() module

→ errorMessage()

YModule

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.

js nodejs function get_errorMessage( ) function get_errorMessage( ) php cpp function get_errorMessage( ) string get_errorMessage( ) m pas vb cs java py

-(NSString*) errorMessage function get_errorMessage( ): string function get_errorMessage( ) As String string get_errorMessage( )

String get_errorMessage( ) def get_errorMessage( )

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

Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du module www.yoctopuce.com

163

19. Référence de l'API de haut niveau module

→ get_errorType() module

→ errorType()

YModule

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'objet module.

js function get_errorType( ) nodejs function get_errorType( ) php cpp pas vb function get_errorType( )

YRETCODE get_errorType( ) function get_errorType( ): YRETCODE function get_errorType( ) As YRETCODE cs java py

YRETCODE get_errorType( ) int get_errorType( ) def get_errorType( )

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

Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du module

164 www.yoctopuce.com

module

→ get_firmwareRelease() module

→ firmwareRelease()

Retourne la version du logiciel embarqué du module.

js nodejs function get_firmwareRelease( ) function get_firmwareRelease( ) php cpp function get_firmwareRelease( ) string get_firmwareRelease( ) m pas vb cs

-(NSString*) firmwareRelease function get_firmwareRelease( ): string function get_firmwareRelease( ) As String string get_firmwareRelease( ) java py cmd

String get_firmwareRelease( ) def get_firmwareRelease( )

YModule target get_firmwareRelease

19. Référence de l'API de haut niveau

YModule

Retourne : une chaîne de caractères représentant la version du logiciel embarqué du module

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

www.yoctopuce.com

165

19. Référence de l'API de haut niveau module

→ get_hardwareId() module

→ hardwareId()

Retourne l'identifiant unique du module.

js function get_hardwareId( ) nodejs function get_hardwareId( ) php cpp m vb function get_hardwareId( ) string get_hardwareId( )

-(NSString*) hardwareId function get_hardwareId( ) As String cs java py string get_hardwareId( )

String get_hardwareId( ) def get_hardwareId( )

L'identifiant unique est composé du numéro de série du module suivi de la chaîne ".module".

YModule

Retourne : une chaîne de caractères identifiant la fonction

166 www.yoctopuce.com

module

→ get_icon2d() module

→ icon2d()

Retourne l'icône du module.

js nodejs function get_icon2d( ) function get_icon2d( ) php cpp function get_icon2d( ) string get_icon2d( ) m pas vb py cmd

-(NSData*) icon2d function get_icon2d( ): TByteArray function get_icon2d( ) As Byte def get_icon2d( )

YModule target get_icon2d

L'icone est au format PNG et a une taille maximale de 1536 octets.

Retourne : un buffer binaire contenant l'icone, au format png.

19. Référence de l'API de haut niveau

YModule www.yoctopuce.com

167

19. Référence de l'API de haut niveau module

→ get_lastLogs() module

→ lastLogs()

Retourne une chaine de charactère contenant les derniers logs du module.

js function get_lastLogs( ) nodejs function get_lastLogs( ) php cpp m pas function get_lastLogs( ) string get_lastLogs( )

-(NSString*) lastLogs function get_lastLogs( ): string vb cs java py cmd function get_lastLogs( ) As String string get_lastLogs( )

String get_lastLogs( ) def get_lastLogs( )

YModule target get_lastLogs

Cette methode retourne les derniers logs qui sont encore stocké dans le module.

Retourne : une chaine de charactère contenant les derniers logs du module.

YModule

168 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ get_logicalName() module

→ logicalName()

Retourne le nom logique du module.

js nodejs function get_logicalName( ) function get_logicalName( ) php cpp function get_logicalName( ) string get_logicalName( ) m pas vb cs

-(NSString*) logicalName function get_logicalName( ): string function get_logicalName( ) As String string get_logicalName( ) java py cmd

String get_logicalName( ) def get_logicalName( )

YModule target get_logicalName

Retourne : une chaîne de caractères représentant le nom logique du module

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

YModule www.yoctopuce.com

169

19. Référence de l'API de haut niveau module

→ get_luminosity() module

→ luminosity()

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

js function get_luminosity( ) nodejs function get_luminosity( ) php cpp m pas function get_luminosity( ) int get_luminosity( )

-(int) luminosity function get_luminosity( ): LongInt vb cs java py cmd function get_luminosity( ) As Integer int get_luminosity( ) int get_luminosity( ) def get_luminosity( )

YModule target get_luminosity

Retourne : un entier représentant la luminosité des leds informatives du module (valeur entre 0 et 100)

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

YModule

170 www.yoctopuce.com

module

→ get_persistentSettings() module

→ persistentSettings()

Retourne l'état courant des réglages persistents du module.

js nodejs function get_persistentSettings( ) function get_persistentSettings( ) php cpp function get_persistentSettings( )

Y_PERSISTENTSETTINGS_enum get_persistentSettings( ) m pas vb cs

-(Y_PERSISTENTSETTINGS_enum) persistentSettings function get_persistentSettings( ): Integer function get_persistentSettings( ) As Integer int get_persistentSettings( ) java py cmd int get_persistentSettings( ) def get_persistentSettings( )

YModule target get_persistentSettings

19. Référence de l'API de haut niveau

YModule

Retourne : une valeur parmi Y_PERSISTENTSETTINGS_LOADED , Y_PERSISTENTSETTINGS_SAVED et

Y_PERSISTENTSETTINGS_MODIFIED représentant l'état courant des réglages persistents du module

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

www.yoctopuce.com

171

19. Référence de l'API de haut niveau module

→ get_productId() module

→ productId()

Retourne l'identifiant USB du module, préprogrammé en usine.

js function get_productId( ) nodejs function get_productId( ) php cpp m pas function get_productId( ) int get_productId( )

-(int) productId function get_productId( ): LongInt vb cs java py cmd function get_productId( ) As Integer int get_productId( ) int get_productId( ) def get_productId( )

YModule target get_productId

Retourne : un entier représentant l'identifiant USB du module, préprogrammé en usine

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

YModule

172 www.yoctopuce.com

module

→ get_productName() module

→ productName()

Retourne le nom commercial du module, préprogrammé en usine.

js nodejs function get_productName( ) function get_productName( ) php cpp function get_productName( ) string get_productName( ) m pas vb cs

-(NSString*) productName function get_productName( ): string function get_productName( ) As String string get_productName( ) java py cmd

String get_productName( ) def get_productName( )

YModule target get_productName

19. Référence de l'API de haut niveau

YModule

Retourne : une chaîne de caractères représentant le nom commercial du module, préprogrammé en usine

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

www.yoctopuce.com

173

19. Référence de l'API de haut niveau module

→ get_productRelease() module

→ productRelease()

Retourne le numéro de version matériel du module, préprogrammé en usine.

js function get_productRelease( ) nodejs function get_productRelease( ) php cpp m pas function get_productRelease( ) int get_productRelease( )

-(int) productRelease function get_productRelease( ): LongInt vb cs java py cmd function get_productRelease( ) As Integer int get_productRelease( ) int get_productRelease( ) def get_productRelease( )

YModule target get_productRelease

Retourne : un entier représentant le numéro de version matériel du module, préprogrammé en usine

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

YModule

174 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ get_rebootCountdown() module

→ rebootCountdown()

YModule

Retourne le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé.

js nodejs function get_rebootCountdown( ) function get_rebootCountdown( ) php cpp function get_rebootCountdown( ) int get_rebootCountdown( ) m pas vb cs

-(int) rebootCountdown function get_rebootCountdown( ): LongInt function get_rebootCountdown( ) As Integer int get_rebootCountdown( ) java py cmd int get_rebootCountdown( ) def get_rebootCountdown( )

YModule target get_rebootCountdown

Retourne : un entier représentant le nombre de secondes restantes avant un redémarrage du module, ou zéro si aucun redémarrage n'a été agendé

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

www.yoctopuce.com

175

19. Référence de l'API de haut niveau module

→ get_serialNumber() module

→ serialNumber()

Retourne le numéro de série du module, préprogrammé en usine.

js function get_serialNumber( ) nodejs function get_serialNumber( ) php cpp m pas function get_serialNumber( ) string get_serialNumber( )

-(NSString*) serialNumber function get_serialNumber( ): string vb cs java py cmd function get_serialNumber( ) As String string get_serialNumber( )

String get_serialNumber( ) def get_serialNumber( )

YModule target get_serialNumber

Retourne : une chaîne de caractères représentant le numéro de série du module, préprogrammé en usine

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

YModule

176 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ get_upTime() module

→ upTime()

Retourne le numbre de millisecondes écoulées depuis la mise sous tension du module js nodejs function get_upTime( ) function get_upTime( ) php cpp function get_upTime( ) s64 get_upTime( ) m pas vb cs

-(s64) upTime function get_upTime( ): int64 function get_upTime( ) As Long long get_upTime( ) java py cmd long get_upTime( ) def get_upTime( )

YModule target get_upTime

YModule

Retourne : un entier représentant le numbre de millisecondes écoulées depuis la mise sous tension du module

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

www.yoctopuce.com

177

19. Référence de l'API de haut niveau module

→ get_usbBandwidth() module

→ usbBandwidth()

Retourne le nombre d'interface USB utilisé par le module.

js function get_usbBandwidth( ) nodejs function get_usbBandwidth( ) php cpp m pas function get_usbBandwidth( )

Y_USBBANDWIDTH_enum get_usbBandwidth( )

-(Y_USBBANDWIDTH_enum) usbBandwidth function get_usbBandwidth( ): Integer vb cs java py cmd function get_usbBandwidth( ) As Integer int get_usbBandwidth( ) int get_usbBandwidth( ) def get_usbBandwidth( )

YModule target get_usbBandwidth

YModule

Retourne : soit Y_USBBANDWIDTH_SIMPLE , soit Y_USBBANDWIDTH_DOUBLE , selon le nombre d'interface

USB utilisé par le module

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

178 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ get_usbCurrent() module

→ usbCurrent()

Retourne le courant consommé par le module sur le bus USB, en milliampères.

js nodejs function get_usbCurrent( ) function get_usbCurrent( ) php cpp function get_usbCurrent( ) int get_usbCurrent( ) m pas vb cs

-(int) usbCurrent function get_usbCurrent( ): LongInt function get_usbCurrent( ) As Integer int get_usbCurrent( ) java py cmd int get_usbCurrent( ) def get_usbCurrent( )

YModule target get_usbCurrent

YModule

Retourne : un entier représentant le courant consommé par le module sur le bus USB, en milliampères

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

www.yoctopuce.com

179

19. Référence de l'API de haut niveau module

→ get_userData() module

→ userData()

YModule

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData .

js function get_userData( ) nodejs function get_userData( ) php function get_userData( ) cpp m pas vb cs java py void * get_userData( )

-(void*) userData function get_userData( ): Tobject function get_userData( ) As Object object get_userData( )

Object get_userData( ) def get_userData( )

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

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

180 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ isOnline() YModule

Vérifie si le module est joignable, sans déclencher d'erreur.

js function isOnline( ) nodejs function isOnline( ) php function isOnline( ) cpp m pas vb cs java py bool isOnline( )

-(BOOL) isOnline function isOnline( ): boolean function isOnline( ) As Boolean bool isOnline( ) boolean isOnline( ) def isOnline( )

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

Retourne : true si le module est joignable, false sinon www.yoctopuce.com

181

19. Référence de l'API de haut niveau module

→ isOnline_async() YModule

Vérifie si le module est joignable, sans déclencher d'erreur.

js function isOnline_async( callback , context ) nodejs function isOnline_async( callback , context )

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

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

182 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ load() YModule

Met en cache les valeurs courantes du module, avec une durée de validité spécifiée.

js function load( msValidity ) nodejs function load( msValidity ) php function load( $msValidity ) cpp m pas vb cs java py

YRETCODE load( int msValidity )

-(YRETCODE) load : (int) msValidity function load( msValidity : integer): YRETCODE function load( ByVal msValidity As Integer) As YRETCODE

YRETCODE load( int msValidity ) int load( long msValidity ) def load( msValidity )

Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.

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

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

www.yoctopuce.com

183

19. Référence de l'API de haut niveau module

→ load_async() YModule

Met en cache les valeurs courantes du module, avec une durée de validité spécifiée.

js function load_async( msValidity , callback , context ) nodejs function load_async( msValidity , callback , context )

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

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

184 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ nextModule()

Continue l'énumération des modules commencée à l'aide de yFirstModule() .

js nodejs function nextModule( ) function nextModule( ) php cpp function nextModule( )

YModule * nextModule( ) m pas vb cs java py

-(YModule*) nextModule function nextModule( ): TYModule function nextModule( ) As YModule

YModule nextModule( )

YModule nextModule( ) def nextModule( )

YModule

Retourne : un pointeur sur un objet YModule accessible en ligne, ou null lorsque l'énumération est terminée.

www.yoctopuce.com

185

19. Référence de l'API de haut niveau module

→ reboot()

Agende un simple redémarrage du module dans un nombre donné de secondes.

js function reboot( secBeforeReboot ) nodejs function reboot( secBeforeReboot ) php function reboot( $secBeforeReboot ) cpp m pas vb cs java py cmd int reboot( int secBeforeReboot )

-(int) reboot : (int) secBeforeReboot function reboot( secBeforeReboot : LongInt): LongInt function reboot( ) As Integer int reboot( int secBeforeReboot ) int reboot( int secBeforeReboot ) def reboot( secBeforeReboot )

YModule target reboot secBeforeReboot

YModule

Paramètres : secBeforeReboot nombre de secondes avant de redémarrer

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

186 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ revertFromFlash() YModule

Recharge les réglages stockés dans le mémoire non volatile du module, comme à la mise sous tension du module.

js function revertFromFlash( ) nodejs function revertFromFlash( ) php function revertFromFlash( ) cpp m pas vb cs java py cmd int revertFromFlash( )

-(int) revertFromFlash function revertFromFlash( ): LongInt function revertFromFlash( ) As Integer int revertFromFlash( ) int revertFromFlash( ) def revertFromFlash( )

YModule target revertFromFlash

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

www.yoctopuce.com

187

19. Référence de l'API de haut niveau module

→ saveToFlash() YModule

Sauve les réglages courants dans la mémoire non volatile du module.

js function saveToFlash( ) nodejs function saveToFlash( ) php function saveToFlash( ) cpp m pas vb cs java py cmd int saveToFlash( )

-(int) saveToFlash function saveToFlash( ): LongInt function saveToFlash( ) As Integer int saveToFlash( ) int saveToFlash( ) def saveToFlash( )

YModule target saveToFlash

Attention le nombre total de sauvegardes possibles durant la vie du module est limité (environ 100000 cycles). N'appelez pas cette fonction dans une boucle.

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

188 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ set_beacon() module

→ setBeacon()

Allume ou éteint la balise de localisation du module.

js nodejs function set_beacon( newval ) function set_beacon( newval ) php cpp function set_beacon( $newval ) int set_beacon( Y_BEACON_enum newval ) m pas vb cs

-(int) setBeacon : (Y_BEACON_enum) newval function set_beacon( newval : Integer): integer function set_beacon( ByVal newval As Integer) As Integer int set_beacon( int newval ) java py cmd int set_beacon( int newval ) def set_beacon( newval )

YModule target set_beacon newval

Paramètres : newval soit Y_BEACON_OFF , soit Y_BEACON_ON

Retourne :

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

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

YModule www.yoctopuce.com

189

19. Référence de l'API de haut niveau module

→ set_logicalName() module

→ setLogicalName()

Change le nom logique du module.

js function set_logicalName( newval ) nodejs function set_logicalName( newval ) php cpp m pas function set_logicalName( $newval ) int set_logicalName( const string& newval )

-(int) setLogicalName : (NSString*) newval function set_logicalName( newval : string): integer vb cs java py cmd function set_logicalName( ByVal newval As String) As Integer int set_logicalName( string newval ) int set_logicalName( String newval ) def set_logicalName( newval )

YModule target set_logicalName newval

YModule

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres : newval une chaîne de caractères

Retourne :

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

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

190 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ set_luminosity() module

→ setLuminosity()

Modifie la luminosité des leds informatives du module.

js nodejs function set_luminosity( newval ) function set_luminosity( newval ) php cpp function set_luminosity( $newval ) int set_luminosity( int newval ) m pas vb cs

-(int) setLuminosity : (int) newval function set_luminosity( newval : LongInt): integer function set_luminosity( ByVal newval As Integer) As Integer int set_luminosity( int newval ) java py cmd int set_luminosity( int newval ) def set_luminosity( newval )

YModule target set_luminosity newval

YModule

Le paramêtre est une valeur entre 0 et 100. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres : newval un entier représentant la luminosité des leds informatives du module

Retourne :

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

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

www.yoctopuce.com

191

19. Référence de l'API de haut niveau module

→ set_usbBandwidth() module

→ setUsbBandwidth()

Modifie le nombre d'interface USB utilisé par le module.

js function set_usbBandwidth( newval ) nodejs function set_usbBandwidth( newval ) php cpp m pas function set_usbBandwidth( $newval ) int set_usbBandwidth( Y_USBBANDWIDTH_enum newval )

-(int) setUsbBandwidth : (Y_USBBANDWIDTH_enum) newval function set_usbBandwidth( newval : Integer): integer vb cs java py cmd function set_usbBandwidth( ByVal newval As Integer) As Integer int set_usbBandwidth( int newval ) int set_usbBandwidth( int newval ) def set_usbBandwidth( newval )

YModule target set_usbBandwidth newval

Vous devez redémarrer le module après avoir changé ce réglage.

YModule

Paramètres : newval soit Y_USBBANDWIDTH_SIMPLE , soit Y_USBBANDWIDTH_DOUBLE , selon le nombre d'interface USB utilisé par le module

Retourne :

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

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

192 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ set_userData() module

→ setUserData()

YModule

Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData .

js function set_userData( data ) nodejs function set_userData( data ) php function set_userData( $data ) cpp m pas vb cs java py void set_userData( void* data )

-(void) setUserData : (void*) data procedure set_userData( data : Tobject) procedure set_userData( ByVal data As Object) void set_userData( object data ) void set_userData( Object data ) def set_userData( data )

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

Paramètres : data objet quelconque à mémoriser www.yoctopuce.com

193

19. Référence de l'API de haut niveau module

→ triggerFirmwareUpdate() YModule

Agende un redémarrage du module en mode spécial de reprogrammation du logiciel embarqué.

js function triggerFirmwareUpdate( secBeforeReboot ) nodejs function triggerFirmwareUpdate( secBeforeReboot ) php function triggerFirmwareUpdate( $secBeforeReboot ) cpp m pas vb cs java py cmd int triggerFirmwareUpdate( int secBeforeReboot )

-(int) triggerFirmwareUpdate : (int) secBeforeReboot function triggerFirmwareUpdate( secBeforeReboot : LongInt): LongInt function triggerFirmwareUpdate( ) As Integer int triggerFirmwareUpdate( int secBeforeReboot ) int triggerFirmwareUpdate( int secBeforeReboot ) def triggerFirmwareUpdate( secBeforeReboot )

YModule target triggerFirmwareUpdate secBeforeReboot

Paramètres : secBeforeReboot nombre de secondes avant de redémarrer

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

194 www.yoctopuce.com

19. Référence de l'API de haut niveau module

→ wait_async() YModule

Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre.

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

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

Paramètres : callback fonction de callback qui sera appelée dès que toutes les commandes en cours d'exécution sur le module seront terminées La fonction callback reçoit deux arguments: le contexte fourni par l'appelant et l'objet fonction concerné.

context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne : rien du tout : www.yoctopuce.com

195

19. Référence de l'API de haut niveau

19.3. Interface de la fonction Temperature

La librairie de programmation Yoctopuce permet lire une valeur instantanée du capteur, ainsi que les extrémas atteints.

Pour utiliser les fonctions décrites ici, vous devez inclure: js nodejs php cpp

#include "yocto_temperature.h" m pas vb cs java py

#import "yocto_temperature.h" uses yocto_temperature; yocto_temperature.vb

yocto_temperature.cs

import com.yoctopuce.YoctoAPI.YTemperature; from yocto_temperature import *

Fonction globales

yFindTemperature(

func )

Permet de retrouver un capteur de température d'après un identifiant donné.

yFirstTemperature()

Commence l'énumération des capteurs de température accessibles par la librairie.

Méthodes des objets

YTemperature

calibrateFromPoints(

rawValues , refValues )

Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un boîtier sur les mesures rendues par le capteur.

describe()

R e t o u r n e u n c o u r t t e x t e d é c r i v a n t l e c a p t e u r d e t e m p é r a t u r e a u f o r m a t

T Y P E ( N A M E ) = S E R I A L . F U N C T I O N I D .

get_advertisedValue()

Retourne la valeur courante du capteur de température (pas plus de 6 caractères).

get_currentRawValue()

Retourne la valeur brute retournée par le capteur (sans arrondi ni calibration).

get_currentValue()

Retourne la valeur mesurée actuelle.

get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du capteur de température.

get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du capteur de température.

get_friendlyName()

Retourne un identifiant global du capteur de température au format NOM_MODULE.NOM_FONCTION

get_functionDescriptor()

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

get_functionId()

Retourne l'identifiant matériel du capteur de température, sans référence au module.

196 www.yoctopuce.com

19. Référence de l'API de haut niveau

Retourne l'identifiant matériel unique du capteur de température au format SERIAL.FUNCTIONID

get_highestValue()

Retourne la valeur maximale observée.

get_logFrequency()

Retourne la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données.

get_logicalName()

Retourne le nom logique du capteur de température.

get_lowestValue()

Retourne la valeur minimale observée.

get_module()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

get_module_async(

callback , context )

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

get_recordedData(

startTime , endTime )

Retourne un objet DataSet représentant des mesures de ce capteur précédemment enregistrées à l'aide du

DataLogger, pour l'intervalle de temps spécifié.

get_reportFrequency()

Retourne la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction.

get_resolution()

Retourne la résolution des valeurs mesurées.

get_sensorType()

Retourne le type de capteur de température utilisé par le module

get_unit()

Retourne l'unité dans laquelle la valeur mesurée est exprimée.

get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData .

isOnline()

Vérifie si le module hébergeant le capteur de température est joignable, sans déclencher d'erreur.

isOnline_async(

callback , context )

Vérifie si le module hébergeant le capteur de température est joignable, sans déclencher d'erreur.

load(

msValidity )

Met en cache les valeurs courantes du capteur de température, avec une durée de validité spécifiée.

loadCalibrationPoints(

rawValues , refValues )

Récupère les points de correction de mesure précédemment enregistrés à l'aide de la méthode calibrateFromPoints .

load_async(

msValidity , callback , context )

Met en cache les valeurs courantes du capteur de température, avec une durée de validité spécifiée.

nextTemperature()

Continue l'énumération des capteurs de température commencée à l'aide de yFirstTemperature() .

registerTimedReportCallback(

callback )

Enregistre la fonction de callback qui est appelée à chaque notification périodique.

registerValueCallback(

callback )

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

set_highestValue(

newval ) www.yoctopuce.com

197

19. Référence de l'API de haut niveau

Modifie la mémoire de valeur maximale observée.

set_logFrequency(

newval )

Modifie la fréquence d'enregistrement des mesures dans le datalogger.

set_logicalName(

newval )

Modifie le nom logique du capteur de température.

set_lowestValue(

newval )

Modifie la mémoire de valeur minimale observée.

set_reportFrequency(

newval )

Modifie la fréquence de notification périodique des valeurs mesurées.

set_resolution(

newval )

Modifie la résolution des valeurs physique mesurées.

set_sensorType(

newval )

Change le type de senseur utilisé par le module.

set_userData(

data )

Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData .

wait_async(

callback , context )

Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre.

198 www.yoctopuce.com

YTemperature.FindTemperature() yFindTemperature()

19. Référence de l'API de haut niveau

YTemperature

Permet de retrouver un capteur de température d'après un identifiant donné.

js nodejs function yFindTemperature( func ) function FindTemperature( func ) php cpp function yFindTemperature( $func )

YTemperature* yFindTemperature( const string& func ) m pas vb cs java py

YTemperature* yFindTemperature( NSString* func ) function yFindTemperature( func : string): TYTemperature function yFindTemperature( ByVal func As String) As YTemperature

YTemperature FindTemperature( string func )

YTemperature FindTemperature( String func ) def FindTemperature( func )

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

●

NomLogiqueFonction

NoSerieModule.IdentifiantFonction

NoSerieModule.NomLogiqueFonction

NomLogiqueModule.IdentifiantMatériel

NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que le capteur de température soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YTemperature.isOnline() pour tester si le capteur de température est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée.

La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres : func une chaîne de caractères qui référence le capteur de température sans ambiguïté

Retourne : un objet de classe YTemperature qui permet ensuite de contrôler le capteur de température.

www.yoctopuce.com

199

19. Référence de l'API de haut niveau

YTemperature.FirstTemperature() yFirstTemperature()

YTemperature

Commence l'énumération des capteurs de température accessibles par la librairie.

js function yFirstTemperature( ) nodejs function FirstTemperature( ) php cpp m pas function yFirstTemperature( )

YTemperature* yFirstTemperature( )

YTemperature* yFirstTemperature( ) function yFirstTemperature( ): TYTemperature vb cs java py function yFirstTemperature( ) As YTemperature

YTemperature FirstTemperature( )

YTemperature FirstTemperature( ) def FirstTemperature( )

Utiliser la fonction YTemperature.nextTemperature() pour itérer sur les autres capteurs de température.

Retourne : un pointeur sur un objet YTemperature , correspondant à le premier capteur de température accessible en ligne, ou null si il n'y a pas de capteurs de température disponibles.

200 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ calibrateFromPoints() YTemperature

Enregistre des points de correction de mesure, typiquement pour compenser l'effet d'un boîtier sur les mesures rendues par le capteur.

js cpp function calibrateFromPoints( rawValues , refValues ) nodejs function calibrateFromPoints( rawValues , refValues ) php function calibrateFromPoints( $rawValues , $refValues ) int calibrateFromPoints( vector<double> rawValues , vector<double> refValues ) m -(int) calibrateFromPoints : (NSMutableArray*) rawValues

: (NSMutableArray*) refValues pas function calibrateFromPoints( rawValues : TDoubleArray, refValues : TDoubleArray): LongInt vb cs procedure calibrateFromPoints( ) int calibrateFromPoints( List<double> rawValues ,

List<double> refValues ) java int calibrateFromPoints( ArrayList<Double> rawValues ,

ArrayList<Double> refValues ) py cmd def calibrateFromPoints( rawValues , refValues )

YTemperature target calibrateFromPoints rawValues refValues

Il est possible d'enregistrer jusqu'à cinq points de correction. Les points de correction doivent être fournis en ordre croissant, et dans la plage valide du capteur. Le module effectue automatiquement une interpolation linéaire de l'erreur entre les points spécifiés. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Pour plus de plus amples possibilités d'appliquer une surcalibration aux capteurs, veuillez contacter [email protected].

Paramètres : 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ées www.yoctopuce.com

201

19. Référence de l'API de haut niveau temperature

→ describe() YTemperature

R e t o u r n e u n c o u r t t e x t e d é c r i v a n t l e c a p t e u r d e t e m p é r a t u r e a u f o r m a t

T Y P E ( N A M E ) = S E R I A L . F U N C T I O N I D .

js function describe( ) nodejs function describe( ) php cpp m pas function describe( ) string describe( )

-(NSString*) describe function describe( ): string vb cs java py function describe( ) As String string describe( )

String describe( ) def describe( )

Plus précisément, TYPE correspond au type de fonction, NAME correspond au nom utilsé lors du premier accès a la fonction, SERIAL correspond au numéro de série du module si le module est connecté, ou "unresolved" sinon, et FUNCTIONID correspond à l'identifiant matériel de la fonction s i l e m o d u l e e s t c o n n e c t é . P a r e x e m p l e , L a m e t h o d e v a r e t o u r n e r

Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1

si le module est déjà connecté ou Relay(BadCustomeName.relay1)=unresolved si le module n'est pas déjà connecté. Cette methode ne declenche aucune transaction USB ou TCP et peut donc être utilisé dans un debuggeur.

Retourne : u n e c h a î n e d e c a r a c t è r e s d é c r i v a n t l e c a p t e u r d e t e m p é r a t u r e ( e x :

R e l a y ( M y C u s t o m N a m e . r e l a y 1 ) = R E L A Y L O 1 - 1 2 3 4 5 6 . r e l a y 1 )

202 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_advertisedValue() temperature

→ advertisedValue()

Retourne la valeur courante du capteur de température (pas plus de 6 caractères).

js nodejs function get_advertisedValue( ) function get_advertisedValue( ) php cpp function get_advertisedValue( ) string get_advertisedValue( ) m pas vb cs

-(NSString*) advertisedValue function get_advertisedValue( ): string function get_advertisedValue( ) As String string get_advertisedValue( ) java py cmd

String get_advertisedValue( ) def get_advertisedValue( )

YTemperature target get_advertisedValue

YTemperature

Retourne : une chaîne de caractères représentant la valeur courante du capteur de température (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID .

www.yoctopuce.com

203

19. Référence de l'API de haut niveau temperature

→ get_currentRawValue() temperature

→ currentRawValue()

Retourne la valeur brute retournée par le capteur (sans arrondi ni calibration).

js function get_currentRawValue( ) nodejs function get_currentRawValue( ) php cpp m pas function get_currentRawValue( ) double get_currentRawValue( )

-(double) currentRawValue function get_currentRawValue( ): double vb cs java py cmd function get_currentRawValue( ) As Double double get_currentRawValue( ) double get_currentRawValue( ) def get_currentRawValue( )

YTemperature target get_currentRawValue

YTemperature

Retourne : une valeur numérique représentant la valeur brute retournée par le capteur (sans arrondi ni calibration)

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

204 www.yoctopuce.com

temperature

→ get_currentValue() temperature

→ currentValue()

Retourne la valeur mesurée actuelle.

js nodejs function get_currentValue( ) function get_currentValue( ) php cpp function get_currentValue( ) double get_currentValue( ) m pas vb cs

-(double) currentValue function get_currentValue( ): double function get_currentValue( ) As Double double get_currentValue( ) java py cmd double get_currentValue( ) def get_currentValue( )

YTemperature target get_currentValue

19. Référence de l'API de haut niveau

YTemperature

Retourne : une valeur numérique représentant la valeur mesurée actuelle

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

www.yoctopuce.com

205

19. Référence de l'API de haut niveau temperature

→ get_errorMessage() temperature

→ errorMessage()

YTemperature

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation du capteur de température.

js function get_errorMessage( ) nodejs function get_errorMessage( ) php cpp m pas function get_errorMessage( ) string get_errorMessage( )

-(NSString*) errorMessage function get_errorMessage( ): string vb cs java py function get_errorMessage( ) As String string get_errorMessage( )

String get_errorMessage( ) def get_errorMessage( )

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

Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation du capteur de température.

206 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_errorType() temperature

→ errorType()

YTemperature

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation du capteur de température.

js nodejs function get_errorType( ) function get_errorType( ) php cpp function get_errorType( )

YRETCODE get_errorType( ) pas vb cs java py function get_errorType( ): YRETCODE function get_errorType( ) As YRETCODE

YRETCODE get_errorType( ) int get_errorType( ) def get_errorType( )

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

Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation du capteur de température.

www.yoctopuce.com

207

19. Référence de l'API de haut niveau temperature

→ get_friendlyName() temperature

→ friendlyName()

YTemperature

R e t o u r n e u n i d e n t i f i a n t g l o b a l d u c a p t e u r d e t e m p é r a t u r e a u f o r m a t

N O M _ M O D U L E . N O M _ F O N C T I O N .

js function get_friendlyName( ) nodejs function get_friendlyName( ) php function get_friendlyName( ) cpp m cs java py string get_friendlyName( )

-(NSString*) friendlyName string get_friendlyName( )

String get_friendlyName( ) def get_friendlyName( )

Le chaîne retournée utilise soit les noms logiques du module et du capteur de température si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel du capteur de température (par exemple: MyCustomName.relay1

)

Retourne : une chaîne de caractères identifiant le capteur de température en utilisant les noms logiques (ex:

MyCustomName.relay1

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

Y_FRIENDLYNAME_INVALID .

208 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_functionDescriptor() temperature

→ functionDescriptor()

YTemperature

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

js function get_functionDescriptor( ) nodejs function get_functionDescriptor( ) php function get_functionDescriptor( ) cpp m pas vb cs java py

YFUN_DESCR get_functionDescriptor( )

-(YFUN_DESCR) functionDescriptor function get_functionDescriptor( ): YFUN_DESCR function get_functionDescriptor( ) As YFUN_DESCR

YFUN_DESCR get_functionDescriptor( )

String get_functionDescriptor( ) def get_functionDescriptor( )

Cet identifiant peut être utilisé pour tester si deux instance de YFunction référencent physiquement la même fonction sur le même module.

Retourne : un identifiant de type YFUN_DESCR . Si la fonction n'a jamais été contactée, la valeur retournée sera

Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com

209

19. Référence de l'API de haut niveau temperature

→ get_functionId() temperature

→ functionId()

YTemperature

Retourne l'identifiant matériel du capteur de température, sans référence au module.

js function get_functionId( ) nodejs function get_functionId( ) php cpp m vb function get_functionId( ) string get_functionId( )

-(NSString*) functionId function get_functionId( ) As String cs java py string get_functionId( )

String get_functionId( ) def get_functionId( )

Par example relay1 .

Retourne : une chaîne de caractères identifiant le capteur de température (ex: relay1 ) En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID .

210 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_hardwareId() temperature

→ hardwareId()

YTemperature

Retourne l'identifiant matériel unique du capteur de température au format SERIAL.FUNCTIONID

js function get_hardwareId( ) nodejs function get_hardwareId( ) php function get_hardwareId( ) cpp m vb cs java py string get_hardwareId( )

-(NSString*) hardwareId function get_hardwareId( ) As String string get_hardwareId( )

String get_hardwareId( ) def get_hardwareId( )

L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel du capteur de température (par example RELAYLO1-123456.relay1

Retourne : une chaîne de caractères identifiant le capteur de température (ex: RELAYLO1-123456.relay1

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

www.yoctopuce.com

211

19. Référence de l'API de haut niveau temperature

→ get_highestValue() temperature

→ highestValue()

Retourne la valeur maximale observée.

js function get_highestValue( ) nodejs function get_highestValue( ) php cpp m pas function get_highestValue( ) double get_highestValue( )

-(double) highestValue function get_highestValue( ): double vb cs java py cmd function get_highestValue( ) As Double double get_highestValue( ) double get_highestValue( ) def get_highestValue( )

YTemperature target get_highestValue

YTemperature

Retourne : une valeur numérique représentant la valeur maximale observée

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

212 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_logFrequency() temperature

→ logFrequency()

YTemperature

Retourne la fréquence d'enregistrement des mesures dans le datalogger, ou "OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données.

js nodejs function get_logFrequency( ) function get_logFrequency( ) php cpp function get_logFrequency( ) string get_logFrequency( ) m pas vb cs

-(NSString*) logFrequency function get_logFrequency( ): string function get_logFrequency( ) As String string get_logFrequency( ) java py cmd

String get_logFrequency( ) def get_logFrequency( )

YTemperature target get_logFrequency

Retourne : une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger, ou

"OFF" si les mesures ne sont pas stockées dans la mémoire de l'enregistreur de données

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

www.yoctopuce.com

213

19. Référence de l'API de haut niveau temperature

→ get_logicalName() temperature

→ logicalName()

Retourne le nom logique du capteur de température.

js function get_logicalName( ) nodejs function get_logicalName( ) php cpp m pas function get_logicalName( ) string get_logicalName( )

-(NSString*) logicalName function get_logicalName( ): string vb cs java py cmd function get_logicalName( ) As String string get_logicalName( )

String get_logicalName( ) def get_logicalName( )

YTemperature target get_logicalName

YTemperature

Retourne : une chaîne de caractères représentant le nom logique du capteur de température. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID .

214 www.yoctopuce.com

temperature

→ get_lowestValue() temperature

→ lowestValue()

Retourne la valeur minimale observée.

js nodejs function get_lowestValue( ) function get_lowestValue( ) php cpp function get_lowestValue( ) double get_lowestValue( ) m pas vb cs

-(double) lowestValue function get_lowestValue( ): double function get_lowestValue( ) As Double double get_lowestValue( ) java py cmd double get_lowestValue( ) def get_lowestValue( )

YTemperature target get_lowestValue

19. Référence de l'API de haut niveau

YTemperature

Retourne : une valeur numérique représentant la valeur minimale observée

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

www.yoctopuce.com

215

19. Référence de l'API de haut niveau temperature

→ get_module() temperature

→ module()

YTemperature

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

js function get_module( ) nodejs function get_module( ) php function get_module( ) cpp m pas vb cs java py

YModule * get_module( )

-(YModule*) module function get_module( ): TYModule function get_module( ) As YModule

YModule get_module( )

YModule get_module( ) def get_module( )

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Retourne : une instance de YModule

216 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_module_async() temperature

→ module_async()

YTemperature

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

js function get_module_async( callback , context ) nodejs function get_module_async( callback , context )

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

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

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

www.yoctopuce.com

217

19. Référence de l'API de haut niveau temperature

→ get_recordedData() temperature

→ recordedData()

YTemperature

Retourne un objet DataSet représentant des mesures de ce capteur précédemment enregistrées à l'aide du DataLogger, pour l'intervalle de temps spécifié.

js function get_recordedData( startTime , endTime ) nodejs function get_recordedData( startTime , endTime ) php cpp m function get_recordedData( $startTime , $endTime )

YDataSet get_recordedData( s64 startTime , s64 endTime )

-(YDataSet*) recordedData : (s64) startTime

: (s64) endTime pas vb cs java py cmd function get_recordedData( startTime : int64, endTime : int64): TYDataSet function get_recordedData( ) As YDataSet

YDataSet get_recordedData( long startTime , long endTime )

YDataSet get_recordedData( long startTime , long endTime ) def get_recordedData( startTime , endTime )

YTemperature target get_recordedData startTime endTime

Veuillez vous référer à la documentation de la classe DataSet pour plus plus d'informations sur la manière d'obtenir un aperçu des mesures pour la période, et comment charger progressivement une grande quantité de mesures depuis le dataLogger.

Cette méthode ne fonctionne que si le module utilise un firmware récent, car les objets DataSet ne sont pas supportés par les firmwares antérieurs à la révision 13000.

Paramètres : startTime le début de l'intervalle de mesure désiré, c'est à dire en nombre de secondes depuis le 1er janvier 1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite sur le début des mesures.

endTime la find de l'intercalle de mesure désiré, c'est à dire en nombre de secondes depuis le 1er janvier

1970 UTC. La valeur 0 peut être utilisée pour ne poser aucune limite de fin.

Retourne : une instance de YDataSet, dont les méthodes permettent de d'accéder aux données historiques souhaitées.

218 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_reportFrequency() temperature

→ reportFrequency()

YTemperature

Retourne la fréquence de notification périodique des valeurs mesurées, ou "OFF" si les notifications périodiques sont désactivées pour cette fonction.

js nodejs function get_reportFrequency( ) function get_reportFrequency( ) php cpp function get_reportFrequency( ) string get_reportFrequency( ) m pas vb cs

-(NSString*) reportFrequency function get_reportFrequency( ): string function get_reportFrequency( ) As String string get_reportFrequency( ) java py cmd

String get_reportFrequency( ) def get_reportFrequency( )

YTemperature target get_reportFrequency

Retourne : une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées, ou

"OFF" si les notifications périodiques sont désactivées pour cette fonction

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

www.yoctopuce.com

219

19. Référence de l'API de haut niveau temperature

→ get_resolution() temperature

→ resolution()

YTemperature

Retourne la résolution des valeurs mesurées.

js function get_resolution( ) nodejs function get_resolution( ) php cpp m pas function get_resolution( ) double get_resolution( )

-(double) resolution function get_resolution( ): double vb cs java py cmd function get_resolution( ) As Double double get_resolution( ) double get_resolution( ) def get_resolution( )

YTemperature target get_resolution

La résolution correspond à la précision numérique de la représentation des mesures. Elle n'est pas forcément identique à la précision réelle du capteur.

Retourne : une valeur numérique représentant la résolution des valeurs mesurées

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

220 www.yoctopuce.com

temperature

→ get_sensorType() temperature

→ sensorType()

Retourne le type de capteur de température utilisé par le module js nodejs function get_sensorType( ) function get_sensorType( ) php cpp function get_sensorType( )

Y_SENSORTYPE_enum get_sensorType( ) m pas vb cs

-(Y_SENSORTYPE_enum) sensorType function get_sensorType( ): Integer function get_sensorType( ) As Integer int get_sensorType( ) java py cmd int get_sensorType( ) def get_sensorType( )

YTemperature target get_sensorType

19. Référence de l'API de haut niveau

YTemperature

Retourne : u n e v a l e u r p a r m i Y _ S E N S O R T Y P E _ D I G I T A L , Y _ S E N S O R T Y P E _ T Y P E _ K ,

Y_SENSORTYPE_TYPE_E , Y_SENSORTYPE_TYPE_J , Y_SENSORTYPE_TYPE_N ,

Y_SENSORTYPE_TYPE_R , Y_SENSORTYPE_TYPE_S , Y_SENSORTYPE_TYPE_T ,

Y _ S E N S O R T Y P E _ P T 1 0 0 _ 4 W I R E S , Y _ S E N S O R T Y P E _ P T 1 0 0 _ 3 W I R E S e t

Y_SENSORTYPE_PT100_2WIRES représentant le type de capteur de température utilisé par le module

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

www.yoctopuce.com

221

19. Référence de l'API de haut niveau temperature

→ get_unit() temperature

→ unit()

Retourne l'unité dans laquelle la valeur mesurée est exprimée.

js function get_unit( ) nodejs function get_unit( ) php cpp m pas function get_unit( ) string get_unit( )

-(NSString*) unit function get_unit( ): string vb cs java py cmd function get_unit( ) As String string get_unit( )

String get_unit( ) def get_unit( )

YTemperature target get_unit

Retourne : une chaîne de caractères représentant l'unité dans laquelle la valeur mesurée est exprimée

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

YTemperature

222 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ get_userData() temperature

→ userData()

YTemperature

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData .

js function get_userData( ) nodejs function get_userData( ) php function get_userData( ) cpp m pas vb cs java py void * get_userData( )

-(void*) userData function get_userData( ): Tobject function get_userData( ) As Object object get_userData( )

Object get_userData( ) def get_userData( )

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

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

www.yoctopuce.com

223

19. Référence de l'API de haut niveau temperature

→ isOnline() YTemperature

Vérifie si le module hébergeant le capteur de température est joignable, sans déclencher d'erreur.

js function isOnline( ) nodejs function isOnline( ) php function isOnline( ) cpp m pas vb cs java py bool isOnline( )

-(BOOL) isOnline function isOnline( ): boolean function isOnline( ) As Boolean bool isOnline( ) boolean isOnline( ) def isOnline( )

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

Retourne : true si le capteur de température est joignable, false sinon

224 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ isOnline_async() YTemperature

Vérifie si le module hébergeant le capteur de température est joignable, sans déclencher d'erreur.

js function isOnline_async( callback , context ) nodejs function isOnline_async( callback , context )

Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la machine virtuelle Javascript avec une attente active.

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

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

www.yoctopuce.com

225

19. Référence de l'API de haut niveau temperature

→ load() YTemperature

Met en cache les valeurs courantes du capteur de température, avec une durée de validité spécifiée.

js function load( msValidity ) nodejs function load( msValidity ) php function load( $msValidity ) cpp m pas vb cs java py

YRETCODE load( int msValidity )

-(YRETCODE) load : (int) msValidity function load( msValidity : integer): YRETCODE function load( ByVal msValidity As Integer) As YRETCODE

YRETCODE load( int msValidity ) int load( long msValidity ) def load( msValidity )

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

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

226 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ loadCalibrationPoints() YTemperature

Récupère les points de correction de mesure précédemment enregistrés à l'aide de la méthode calibrateFromPoints .

js nodejs function loadCalibrationPoints( rawValues , refValues ) function loadCalibrationPoints( rawValues , refValues ) php cpp function loadCalibrationPoints( &$rawValues , &$refValues ) int loadCalibrationPoints( vector<double>& rawValues , vector<double>& refValues ) m -(int) loadCalibrationPoints : (NSMutableArray*) rawValues

: (NSMutableArray*) refValues pas function loadCalibrationPoints( var rawValues : TDoubleArray, var refValues : TDoubleArray): LongInt vb cs procedure loadCalibrationPoints( ) int loadCalibrationPoints( List<double> rawValues ,

List<double> refValues ) java int loadCalibrationPoints( ArrayList<Double> rawValues ,

ArrayList<Double> refValues ) py cmd def loadCalibrationPoints( rawValues , refValues )

YTemperature target loadCalibrationPoints rawValues refValues

Paramètres : 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ésirées des points de correction.

Retourne :

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

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

www.yoctopuce.com

227

19. Référence de l'API de haut niveau temperature

→ load_async() YTemperature

Met en cache les valeurs courantes du capteur de température, avec une durée de validité spécifiée.

js function load_async( msValidity , callback , context ) nodejs function load_async( msValidity , callback , context )

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

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

228 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ nextTemperature() YTemperature

Continue l'énumération des capteurs de température commencée à l'aide de yFirstTemperature() .

js nodejs function nextTemperature( ) function nextTemperature( ) php cpp function nextTemperature( )

YTemperature * nextTemperature( ) m pas vb cs java py

-(YTemperature*) nextTemperature function nextTemperature( ): TYTemperature function nextTemperature( ) As YTemperature

YTemperature nextTemperature( )

YTemperature nextTemperature( ) def nextTemperature( )

Retourne : un pointeur sur un objet YTemperature accessible en ligne, ou null lorsque l'énumération est terminée.

www.yoctopuce.com

229

19. Référence de l'API de haut niveau temperature

→ registerTimedReportCallback() YTemperature

Enregistre la fonction de callback qui est appelée à chaque notification périodique.

js function registerTimedReportCallback( callback ) nodejs function registerTimedReportCallback( callback ) php function registerTimedReportCallback( $callback ) cpp m pas vb cs java py int registerTimedReportCallback( YTemperatureTimedReportCallback callback )

-(int) registerTimedReportCallback : (YTemperatureTimedReportCallback) callback function registerTimedReportCallback( callback : TYTemperatureTimedReportCallback): LongInt function registerTimedReportCallback( ) As Integer int registerTimedReportCallback( TimedReportCallback callback ) int registerTimedReportCallback( TimedReportCallback callback ) def registerTimedReportCallback( callback )

Ce callback n'est appelé que durant l'exécution de ySleep ou yHandleEvents . Cela permet à l'appelant de contrôler quand les callback peuvent se produire. Il est important d'appeler l'une de ces deux fonctions périodiquement pour garantir que les callback ne soient pas appelés trop tard. Pour désactiver un callback, il suffit d'appeler cette méthode en lui passant un pointeur nul.

Paramètres : callback la fonction de callback à rappeler, ou un pointeur nul. La fonction de callback doit accepter deux arguments: l'object fonction dont la valeur a changé, et un objet YMeasure décrivant la nouvelle valeur publiée.

230 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ registerValueCallback() YTemperature

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

js function registerValueCallback( callback ) nodejs function registerValueCallback( callback ) php function registerValueCallback( $callback ) cpp m pas vb cs java py int registerValueCallback( YTemperatureValueCallback callback )

-(int) registerValueCallback : (YTemperatureValueCallback) callback function registerValueCallback( callback : TYTemperatureValueCallback): LongInt function registerValueCallback( ) As Integer int registerValueCallback( ValueCallback callback ) int registerValueCallback( UpdateCallback callback ) def registerValueCallback( callback )

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

www.yoctopuce.com

231

19. Référence de l'API de haut niveau temperature

→ set_highestValue() temperature

→ setHighestValue()

Modifie la mémoire de valeur maximale observée.

js function set_highestValue( newval ) nodejs function set_highestValue( newval ) php cpp m pas function set_highestValue( $newval ) int set_highestValue( double newval )

-(int) setHighestValue : (double) newval function set_highestValue( newval : double): integer vb cs java py cmd function set_highestValue( ByVal newval As Double) As Integer int set_highestValue( double newval ) int set_highestValue( double newval ) def set_highestValue( newval )

YTemperature target set_highestValue newval

Paramètres : newval une valeur numérique représentant la mémoire de valeur maximale observée

Retourne :

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

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

YTemperature

232 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ set_logFrequency() temperature

→ setLogFrequency()

YTemperature

Modifie la fréquence d'enregistrement des mesures dans le datalogger.

js nodejs function set_logFrequency( newval ) function set_logFrequency( newval ) php cpp function set_logFrequency( $newval ) int set_logFrequency( const string& newval ) m pas vb cs

-(int) setLogFrequency : (NSString*) newval function set_logFrequency( newval : string): integer function set_logFrequency( ByVal newval As String) As Integer int set_logFrequency( string newval ) java py cmd int set_logFrequency( String newval ) def set_logFrequency( newval )

YTemperature target set_logFrequency newval

La fréquence peut être spécifiée en mesures par secondes, en mesures par minutes (par exemple

"15/m") ou en mesures par heure (par exemple "4/h"). Pour désactiver l'enregistrement des mesures de cette fonction, utilisez la valeur "OFF".

Paramètres : newval une chaîne de caractères représentant la fréquence d'enregistrement des mesures dans le datalogger

Retourne :

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

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

www.yoctopuce.com

233

19. Référence de l'API de haut niveau temperature

→ set_logicalName() temperature

→ setLogicalName()

Modifie le nom logique du capteur de température.

js function set_logicalName( newval ) nodejs function set_logicalName( newval ) php cpp m pas function set_logicalName( $newval ) int set_logicalName( const string& newval )

YTemperature target set_logicalName newval

YTemperature

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres : newval une chaîne de caractères représentant le nom logique du capteur de température.

Retourne :

YAPI_SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

234 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ set_lowestValue() temperature

→ setLowestValue()

Modifie la mémoire de valeur minimale observée.

js nodejs function set_lowestValue( newval ) function set_lowestValue( newval ) php cpp function set_lowestValue( $newval ) int set_lowestValue( double newval ) m pas vb cs

-(int) setLowestValue : (double) newval function set_lowestValue( newval : double): integer function set_lowestValue( ByVal newval As Double) As Integer int set_lowestValue( double newval ) java py cmd int set_lowestValue( double newval ) def set_lowestValue( newval )

YTemperature target set_lowestValue newval

Paramètres : newval une valeur numérique représentant la mémoire de valeur minimale observée

Retourne :

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

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

YTemperature www.yoctopuce.com

235

19. Référence de l'API de haut niveau temperature

→ set_reportFrequency() temperature

→ setReportFrequency()

YTemperature

Modifie la fréquence de notification périodique des valeurs mesurées.

js function set_reportFrequency( newval ) nodejs function set_reportFrequency( newval ) php cpp m pas function set_reportFrequency( $newval ) int set_reportFrequency( const string& newval )

-(int) setReportFrequency : (NSString*) newval function set_reportFrequency( newval : string): integer vb cs java py cmd function set_reportFrequency( ByVal newval As String) As Integer int set_reportFrequency( string newval ) int set_reportFrequency( String newval ) def set_reportFrequency( newval )

YTemperature target set_reportFrequency newval

La fréquence peut être spécifiée en mesures par secondes, en mesures par minutes (par exemple

"15/m") ou en mesures par heure (par exemple "4/h"). Pour désactiver les notifications périodiques pour cette fonction, utilisez la valeur "OFF".

Paramètres : newval une chaîne de caractères représentant la fréquence de notification périodique des valeurs mesurées

Retourne :

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

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

236 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ set_resolution() temperature

→ setResolution()

YTemperature

Modifie la résolution des valeurs physique mesurées.

js nodejs function set_resolution( newval ) function set_resolution( newval ) php cpp function set_resolution( $newval ) int set_resolution( double newval ) m pas vb cs

-(int) setResolution : (double) newval function set_resolution( newval : double): integer function set_resolution( ByVal newval As Double) As Integer int set_resolution( double newval ) java py cmd int set_resolution( double newval ) def set_resolution( newval )

YTemperature target set_resolution newval

La résolution correspond à la précision de l'affichage des mesures. Elle ne change pas la précision de la mesure elle-même.

Paramètres : newval une valeur numérique représentant la résolution des valeurs physique mesurées

Retourne :

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

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

www.yoctopuce.com

237

19. Référence de l'API de haut niveau temperature

→ set_sensorType() temperature

→ setSensorType()

YTemperature

Change le type de senseur utilisé par le module.

js function set_sensorType( newval ) nodejs function set_sensorType( newval ) php cpp m pas function set_sensorType( $newval ) int set_sensorType( Y_SENSORTYPE_enum newval )

-(int) setSensorType : (Y_SENSORTYPE_enum) newval function set_sensorType( newval : Integer): integer vb cs java py cmd function set_sensorType( ByVal newval As Integer) As Integer int set_sensorType( int newval ) int set_sensorType( int newval ) def set_sensorType( newval )

YTemperature target set_sensorType newval

Cette function sert à spécifier le type de thermocouple (K,E, etc..) raccordé au module. Cette fonction n'aura pas d'effet si le module utilise un capteur digital. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres : newval une valeur parmi Y_SENSORTYPE_DIGITAL , Y_SENSORTYPE_TYPE_K ,

Y_SENSORTYPE_TYPE_E , Y_SENSORTYPE_TYPE_J , Y_SENSORTYPE_TYPE_N ,

Y_SENSORTYPE_TYPE_R , Y_SENSORTYPE_TYPE_S , Y_SENSORTYPE_TYPE_T ,

Y_SENSORTYPE_PT100_4WIRES , Y_SENSORTYPE_PT100_3WIRES et

Y_SENSORTYPE_PT100_2WIRES

Retourne :

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

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

238 www.yoctopuce.com

19. Référence de l'API de haut niveau temperature

→ set_userData() temperature

→ setUserData()

YTemperature

Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData .

js function set_userData( data ) nodejs function set_userData( data ) php function set_userData( $data ) cpp m pas vb cs java py void set_userData( void* data )

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

Paramètres : data objet quelconque à mémoriser www.yoctopuce.com

239

19. Référence de l'API de haut niveau temperature

→ wait_async() YTemperature

Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre.

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

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

context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne : rien du tout :

240 www.yoctopuce.com

19. Référence de l'API de haut niveau

19.4. Interface de la fonction DataLogger

Pour utiliser les fonctions décrites ici, vous devez inclure: js nodejs php cpp m pas vb cs java py

#include "yocto_datalogger.h"

#import "yocto_datalogger.h" uses yocto_datalogger; yocto_datalogger.vb

yocto_datalogger.cs

import com.yoctopuce.YoctoAPI.YDataLogger; from yocto_datalogger import *

Fonction globales

yFindDataLogger(

func )

Permet de retrouver un enregistreur de données d'après un identifiant donné.

yFirstDataLogger()

Commence l'énumération des enregistreurs de données accessibles par la librairie.

Méthodes des objets

YDataLogger

describe()

R e t o u r n e u n c o u r t t e x t e d é c r i v a n t l ' e n r e g i s t r e u r d e d o n n é e s a u f o r m a t

T Y P E ( N A M E ) = S E R I A L . F U N C T I O N I D .

forgetAllDataStreams()

Efface tout l'historique des mesures de l'enregistreur de données.

get_advertisedValue()

Retourne la valeur courante de l'enregistreur de données (pas plus de 6 caractères).

get_autoStart()

Retourne le mode d'activation automatique de l'enregistreur de données à la mise sous tension.

get_currentRunIndex()

Retourne le numéro du Run actuel, correspondant au nombre de fois que le module a été mis sous tension avec la fonction d'enregistreur de données active.

get_dataSets()

Retourne une liste d'objets YDataSet permettant de récupérer toutes les mesures stockées par l'enregistreur de données.

get_dataStreams(

v )

Construit une liste de toutes les séquences de mesures mémorisées par l'enregistreur (ancienne méthode).

get_errorMessage()

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données.

get_errorType()

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données.

get_friendlyName()

www.yoctopuce.com

241

19. Référence de l'API de haut niveau

Retourne un identifiant global de l'enregistreur de données au format NOM_MODULE.NOM_FONCTION

get_functionDescriptor()

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

get_functionId()

Retourne l'identifiant matériel de l'enregistreur de données, sans référence au module.

Retourne l'identifiant matériel unique de l'enregistreur de données au format SERIAL.FUNCTIONID

get_logicalName()

Retourne le nom logique de l'enregistreur de données.

get_module()

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

get_module_async(

callback , context )

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

get_recording()

Retourne l'état d'activation de l'enregistreur de données.

get_timeUTC()

Retourne le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue.

get_userData()

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData .

isOnline()

Vérifie si le module hébergeant l'enregistreur de données est joignable, sans déclencher d'erreur.

isOnline_async(

callback , context )

Vérifie si le module hébergeant l'enregistreur de données est joignable, sans déclencher d'erreur.

load(

msValidity )

Met en cache les valeurs courantes de l'enregistreur de données, avec une durée de validité spécifiée.

load_async(

msValidity , callback , context )

Met en cache les valeurs courantes de l'enregistreur de données, avec une durée de validité spécifiée.

nextDataLogger()

Continue l'énumération des enregistreurs de données commencée à l'aide de yFirstDataLogger() .

registerValueCallback(

callback )

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

set_autoStart(

newval )

Modifie le mode d'activation automatique de l'enregistreur de données à la mise sous tension.

set_logicalName(

newval )

Modifie le nom logique de l'enregistreur de données.

set_recording(

newval )

Modifie l'état d'activation de l'enregistreur de données.

set_timeUTC(

newval )

Modifie la référence de temps UTC, afin de l'attacher aux données enregistrées.

set_userData(

data )

Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData .

wait_async(

callback , context )

Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre.

242 www.yoctopuce.com

YDataLogger.FindDataLogger() yFindDataLogger()

19. Référence de l'API de haut niveau

YDataLogger

Permet de retrouver un enregistreur de données d'après un identifiant donné.

js nodejs function yFindDataLogger( func ) function FindDataLogger( func ) php cpp function yFindDataLogger( $func )

YDataLogger* yFindDataLogger( string func ) m pas vb cs java py

+(YDataLogger*) yFindDataLogger : (NSString*) func function yFindDataLogger( func : string): TYDataLogger function yFindDataLogger( ByVal func As String) As YDataLogger

YDataLogger FindDataLogger( string func )

YDataLogger FindDataLogger( String func ) def FindDataLogger( func )

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

●

NomLogiqueFonction

NoSerieModule.IdentifiantFonction

NoSerieModule.NomLogiqueFonction

NomLogiqueModule.IdentifiantMatériel

NomLogiqueModule.NomLogiqueFonction

Cette fonction n'exige pas que l'enregistreur de données soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YDataLogger.isOnline() pour tester si l'enregistreur de données est utilisable à un moment donné. En cas d'ambiguïté lorsqu'on fait une recherche par nom logique, aucune erreur ne sera notifiée: la première instance trouvée sera renvoyée.

La recherche se fait d'abord par nom matériel, puis par nom logique.

Paramètres : func une chaîne de caractères qui référence l'enregistreur de données sans ambiguïté

Retourne : un objet de classe YDataLogger qui permet ensuite de contrôler l'enregistreur de données.

www.yoctopuce.com

243

19. Référence de l'API de haut niveau

YDataLogger.FirstDataLogger() yFirstDataLogger()

YDataLogger

Commence l'énumération des enregistreurs de données accessibles par la librairie.

js function yFirstDataLogger( ) nodejs function FirstDataLogger( ) php cpp m pas function yFirstDataLogger( )

YDataLogger* yFirstDataLogger( )

YDataLogger* yFirstDataLogger( ) function yFirstDataLogger( ): TYDataLogger vb cs java py function yFirstDataLogger( ) As YDataLogger

YDataLogger FirstDataLogger( )

YDataLogger FirstDataLogger( ) def FirstDataLogger( )

Utiliser la fonction YDataLogger.nextDataLogger() pour itérer sur les autres enregistreurs de données.

Retourne : un pointeur sur un objet YDataLogger , correspondant à le premier enregistreur de données accessible en ligne, ou null si il n'y a pas de enregistreurs de données disponibles.

244 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ describe() YDataLogger

R e t o u r n e u n c o u r t t e x t e d é c r i v a n t l ' e n r e g i s t r e u r d e d o n n é e s a u f o r m a t

T Y P E ( N A M E ) = S E R I A L . F U N C T I O N I D .

js nodejs function describe( ) function describe( ) php cpp function describe( ) string describe( ) m pas vb cs java py

-(NSString*) describe function describe( ): string function describe( ) As String string describe( )

String describe( ) def describe( )

Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1

Retourne : u n e c h a î n e d e c a r a c t è r e s d é c r i v a n t l ' e n r e g i s t r e u r d e d o n n é e s ( e x :

R e l a y ( M y C u s t o m N a m e . r e l a y 1 ) = R E L A Y L O 1 - 1 2 3 4 5 6 . r e l a y 1 ) www.yoctopuce.com

245

19. Référence de l'API de haut niveau datalogger

→ forgetAllDataStreams()

Efface tout l'historique des mesures de l'enregistreur de données.

js function forgetAllDataStreams( ) nodejs function forgetAllDataStreams( ) php function forgetAllDataStreams( ) cpp m pas vb cs java py cmd int forgetAllDataStreams( )

-(int) forgetAllDataStreams function forgetAllDataStreams( ): LongInt function forgetAllDataStreams( ) As Integer int forgetAllDataStreams( ) int forgetAllDataStreams( ) def forgetAllDataStreams( )

YDataLogger target forgetAllDataStreams

Cette méthode remet aussi à zéro le compteur de Runs.

Retourne :

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

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

YDataLogger

246 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_advertisedValue() datalogger

→ advertisedValue()

Retourne la valeur courante de l'enregistreur de données (pas plus de 6 caractères).

js nodejs function get_advertisedValue( ) function get_advertisedValue( ) php cpp function get_advertisedValue( ) string get_advertisedValue( ) m pas vb cs

-(NSString*) advertisedValue function get_advertisedValue( ): string function get_advertisedValue( ) As String string get_advertisedValue( ) java py cmd

String get_advertisedValue( ) def get_advertisedValue( )

YDataLogger target get_advertisedValue

YDataLogger

Retourne : une chaîne de caractères représentant la valeur courante de l'enregistreur de données (pas plus de 6 caractères). En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID .

www.yoctopuce.com

247

19. Référence de l'API de haut niveau datalogger

→ get_autoStart() datalogger

→ autoStart()

YDataLogger

Retourne le mode d'activation automatique de l'enregistreur de données à la mise sous tension.

js function get_autoStart( ) nodejs function get_autoStart( ) php cpp m pas function get_autoStart( )

Y_AUTOSTART_enum get_autoStart( )

-(Y_AUTOSTART_enum) autoStart function get_autoStart( ): Integer vb cs java py cmd function get_autoStart( ) As Integer int get_autoStart( ) int get_autoStart( ) def get_autoStart( )

YDataLogger target get_autoStart

Retourne : soit Y_AUTOSTART_OFF , soit Y_AUTOSTART_ON , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension

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

248 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_currentRunIndex() datalogger

→ currentRunIndex()

YDataLogger

Retourne le numéro du Run actuel, correspondant au nombre de fois que le module a été mis sous tension avec la fonction d'enregistreur de données active.

js nodejs function get_currentRunIndex( ) function get_currentRunIndex( ) php cpp function get_currentRunIndex( ) int get_currentRunIndex( ) m pas vb cs

-(int) currentRunIndex function get_currentRunIndex( ): LongInt function get_currentRunIndex( ) As Integer int get_currentRunIndex( ) java py cmd int get_currentRunIndex( ) def get_currentRunIndex( )

YDataLogger target get_currentRunIndex

Retourne : un entier représentant le numéro du Run actuel, correspondant au nombre de fois que le module a été mis sous tension avec la fonction d'enregistreur de données active

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

www.yoctopuce.com

249

19. Référence de l'API de haut niveau datalogger

→ get_dataSets() datalogger

→ dataSets()

YDataLogger

Retourne une liste d'objets YDataSet permettant de récupérer toutes les mesures stockées par l'enregistreur de données.

js function get_dataSets( ) nodejs function get_dataSets( ) php cpp m pas function get_dataSets( ) vector<YDataSet> get_dataSets( )

-(NSMutableArray*) dataSets function get_dataSets( ): TYDataSetArray vb cs java py cmd function get_dataSets( ) As List

List<YDataSet> get_dataSets( )

ArrayList<YDataSet> get_dataSets( ) def get_dataSets( )

YDataLogger target get_dataSets

Cette méthode ne fonctionne que si le module utilise un firmware récent, car les objets YDataSet ne sont pas supportés par les firmwares antérieurs à la révision 13000.

Retourne : une liste d'objets YDataSet

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

250 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_dataStreams() datalogger

→ dataStreams()

YDataLogger

Construit une liste de toutes les séquences de mesures mémorisées par l'enregistreur (ancienne méthode).

js nodejs function get_dataStreams( v ) function get_dataStreams( v ) php cpp function get_dataStreams( &$v ) int get_dataStreams( ) m pas vb cs java py

-(int) dataStreams : (NSArray**) v function get_dataStreams( v : Tlist): integer procedure get_dataStreams( ByVal v As List) int get_dataStreams( List<YDataStream> v ) int get_dataStreams( ArrayList<YDataStream> v ) def get_dataStreams( v )

L'appelant doit passer par référence un tableau vide pout stocker les objets YDataStream, et la méthode va les remplire avec des objets décrivant les séquences de données disponibles.

Cette méthode est préservée pour maintenir la compatibilité avec les applications existantes. Pour les nouvelles applications, il est préférable d'utiliser la méthode get_dataSets() ou d'appeler directement la méthode get_recordedData() sur l'objet représentant le capteur désiré.

Paramètres : v un tableau de YDataStreams qui sera rempli avec les séquences trouvées

Retourne :

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

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

www.yoctopuce.com

251

19. Référence de l'API de haut niveau datalogger

→ get_errorMessage() datalogger

→ errorMessage()

YDataLogger

Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données.

js function get_errorMessage( ) nodejs function get_errorMessage( ) php cpp m pas function get_errorMessage( ) string get_errorMessage( )

-(NSString*) errorMessage function get_errorMessage( ): string vb cs java py function get_errorMessage( ) As String string get_errorMessage( )

String get_errorMessage( ) def get_errorMessage( )

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

Retourne : une chaîne de caractères correspondant au message de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.

252 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_errorType() datalogger

→ errorType()

YDataLogger

Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de l'enregistreur de données.

js nodejs function get_errorType( ) function get_errorType( ) php cpp function get_errorType( )

YRETCODE get_errorType( ) pas vb cs java py function get_errorType( ): YRETCODE function get_errorType( ) As YRETCODE

YRETCODE get_errorType( ) int get_errorType( ) def get_errorType( )

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

Retourne : un nombre correspondant au code de la dernière erreur qui s'est produit lors de l'utilisation de l'enregistreur de données.

www.yoctopuce.com

253

19. Référence de l'API de haut niveau datalogger

→ get_friendlyName() datalogger

→ friendlyName()

YDataLogger

R e t o u r n e u n i d e n t i f i a n t g l o b a l d e l ' e n r e g i s t r e u r d e d o n n é e s a u f o r m a t

N O M _ M O D U L E . N O M _ F O N C T I O N .

js function get_friendlyName( ) nodejs function get_friendlyName( ) php function get_friendlyName( ) cpp m cs java py string get_friendlyName( )

-(NSString*) friendlyName string get_friendlyName( )

String get_friendlyName( ) def get_friendlyName( )

Le chaîne retournée utilise soit les noms logiques du module et de l'enregistreur de données si ils sont définis, soit respectivement le numéro de série du module et l'identifant matériel de l'enregistreur de données (par exemple: MyCustomName.relay1

)

Retourne : une chaîne de caractères identifiant l'enregistreur de données en utilisant les noms logiques (ex:

MyCustomName.relay1

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

Y_FRIENDLYNAME_INVALID .

254 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_functionDescriptor() datalogger

→ functionDescriptor()

YDataLogger

Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.

js function get_functionDescriptor( ) nodejs function get_functionDescriptor( ) php function get_functionDescriptor( ) cpp m pas vb cs java py

YFUN_DESCR get_functionDescriptor( )

-(YFUN_DESCR) functionDescriptor function get_functionDescriptor( ): YFUN_DESCR function get_functionDescriptor( ) As YFUN_DESCR

YFUN_DESCR get_functionDescriptor( )

String get_functionDescriptor( ) def get_functionDescriptor( )

Cet identifiant peut être utilisé pour tester si deux instance de YFunction référencent physiquement la même fonction sur le même module.

Retourne : un identifiant de type YFUN_DESCR . Si la fonction n'a jamais été contactée, la valeur retournée sera

Y_FUNCTIONDESCRIPTOR_INVALID www.yoctopuce.com

255

19. Référence de l'API de haut niveau datalogger

→ get_functionId() datalogger

→ functionId()

YDataLogger

Retourne l'identifiant matériel de l'enregistreur de données, sans référence au module.

js function get_functionId( ) nodejs function get_functionId( ) php cpp m vb function get_functionId( ) string get_functionId( )

-(NSString*) functionId function get_functionId( ) As String cs java py string get_functionId( )

String get_functionId( ) def get_functionId( )

Par example relay1 .

Retourne : une chaîne de caractères identifiant l'enregistreur de données (ex: relay1 ) En cas d'erreur, déclenche une exception ou retourne Y_FUNCTIONID_INVALID .

256 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_hardwareId() datalogger

→ hardwareId()

YDataLogger

Retourne l'identifiant matériel unique de l'enregistreur de données au format

SERIAL.FUNCTIONID

js function get_hardwareId( ) nodejs function get_hardwareId( ) php function get_hardwareId( ) cpp m vb cs java py string get_hardwareId( )

-(NSString*) hardwareId function get_hardwareId( ) As String string get_hardwareId( )

String get_hardwareId( ) def get_hardwareId( )

L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de l'enregistreur de données (par example RELAYLO1-123456.relay1

Retourne : une chaîne de caractères identifiant l'enregistreur de données (ex: RELAYLO1-123456.relay1

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

www.yoctopuce.com

257

19. Référence de l'API de haut niveau datalogger

→ get_logicalName() datalogger

→ logicalName()

Retourne le nom logique de l'enregistreur de données.

js function get_logicalName( ) nodejs function get_logicalName( ) php cpp m pas function get_logicalName( ) string get_logicalName( )

-(NSString*) logicalName function get_logicalName( ): string vb cs java py cmd function get_logicalName( ) As String string get_logicalName( )

String get_logicalName( ) def get_logicalName( )

YDataLogger target get_logicalName

YDataLogger

Retourne : une chaîne de caractères représentant le nom logique de l'enregistreur de données. En cas d'erreur, déclenche une exception ou retourne Y_LOGICALNAME_INVALID .

258 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_module() datalogger

→ module()

YDataLogger

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

js function get_module( ) nodejs function get_module( ) php function get_module( ) cpp m pas vb cs java py

YModule * get_module( )

-(YModule*) module function get_module( ): TYModule function get_module( ) As YModule

YModule get_module( )

YModule get_module( ) def get_module( )

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

Retourne : une instance de YModule www.yoctopuce.com

259

19. Référence de l'API de haut niveau datalogger

→ get_module_async() datalogger

→ module_async()

YDataLogger

Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.

js function get_module_async( callback , context ) nodejs function get_module_async( callback , context )

Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.

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

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

260 www.yoctopuce.com

datalogger

→ get_recording() datalogger

→ recording()

Retourne l'état d'activation de l'enregistreur de données.

js nodejs function get_recording( ) function get_recording( ) php cpp function get_recording( )

Y_RECORDING_enum get_recording( ) m pas vb cs

-(Y_RECORDING_enum) recording function get_recording( ): Integer function get_recording( ) As Integer int get_recording( ) java py cmd int get_recording( ) def get_recording( )

YDataLogger target get_recording

19. Référence de l'API de haut niveau

YDataLogger

Retourne : soit Y_RECORDING_OFF , soit Y_RECORDING_ON , selon l'état d'activation de l'enregistreur de données

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

www.yoctopuce.com

261

19. Référence de l'API de haut niveau datalogger

→ get_timeUTC() datalogger

→ timeUTC()

Retourne le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue.

js function get_timeUTC( ) nodejs function get_timeUTC( ) php cpp m pas function get_timeUTC( ) s64 get_timeUTC( )

-(s64) timeUTC function get_timeUTC( ): int64 vb cs java py cmd function get_timeUTC( ) As Long long get_timeUTC( ) long get_timeUTC( ) def get_timeUTC( )

YDataLogger target get_timeUTC

Retourne : un entier représentant le timestamp Unix de l'heure UTC actuelle, lorsqu'elle est connue

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

YDataLogger

262 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ get_userData() datalogger

→ userData()

YDataLogger

Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode set_userData .

js function get_userData( ) nodejs function get_userData( ) php function get_userData( ) cpp m pas vb cs java py void * get_userData( )

-(void*) userData function get_userData( ): Tobject function get_userData( ) As Object object get_userData( )

Object get_userData( ) def get_userData( )

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

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

www.yoctopuce.com

263

19. Référence de l'API de haut niveau datalogger

→ isOnline() YDataLogger

Vérifie si le module hébergeant l'enregistreur de données est joignable, sans déclencher d'erreur.

js function isOnline( ) nodejs function isOnline( ) php function isOnline( ) cpp m pas vb cs java py bool isOnline( )

-(BOOL) isOnline function isOnline( ): boolean function isOnline( ) As Boolean bool isOnline( ) boolean isOnline( ) def isOnline( )

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

Retourne : true si l'enregistreur de données est joignable, false sinon

264 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ isOnline_async() YDataLogger

Vérifie si le module hébergeant l'enregistreur de données est joignable, sans déclencher d'erreur.

js function isOnline_async( callback , context ) nodejs function isOnline_async( callback , context )

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

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

www.yoctopuce.com

265

19. Référence de l'API de haut niveau datalogger

→ load() YDataLogger

Met en cache les valeurs courantes de l'enregistreur de données, avec une durée de validité spécifiée.

js function load( msValidity ) nodejs function load( msValidity ) php function load( $msValidity ) cpp m pas vb cs java py

YRETCODE load( int msValidity )

-(YRETCODE) load : (int) msValidity function load( msValidity : integer): YRETCODE function load( ByVal msValidity As Integer) As YRETCODE

YRETCODE load( int msValidity ) int load( long msValidity ) def load( msValidity )

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

Retourne :

YAPI_SUCCESS si l'opération se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

266 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ load_async() YDataLogger

Met en cache les valeurs courantes de l'enregistreur de données, avec une durée de validité spécifiée.

js function load_async( msValidity , callback , context ) nodejs function load_async( msValidity , callback , context )

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

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

www.yoctopuce.com

267

19. Référence de l'API de haut niveau datalogger

→ nextDataLogger() YDataLogger

Continue l'énumération des enregistreurs de données commencée à l'aide de yFirstDataLogger() .

js function nextDataLogger( ) nodejs function nextDataLogger( ) php cpp m pas function nextDataLogger( )

YDataLogger * nextDataLogger( )

-(YDataLogger*) nextDataLogger function nextDataLogger( ): TYDataLogger vb cs java py function nextDataLogger( ) As YDataLogger

YDataLogger nextDataLogger( )

YDataLogger nextDataLogger( ) def nextDataLogger( )

Retourne : un pointeur sur un objet YDataLogger accessible en ligne, ou null lorsque l'énumération est terminée.

268 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ registerValueCallback() YDataLogger

Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.

-(int) registerValueCallback : (YDataLoggerValueCallback) callback function registerValueCallback( callback : TYDataLoggerValueCallback): LongInt function registerValueCallback( ) As Integer int registerValueCallback( ValueCallback callback ) int registerValueCallback( UpdateCallback callback ) def registerValueCallback( callback )

www.yoctopuce.com

269

19. Référence de l'API de haut niveau datalogger

→ set_autoStart() datalogger

→ setAutoStart()

YDataLogger

Modifie le mode d'activation automatique de l'enregistreur de données à la mise sous tension.

js function set_autoStart( newval ) nodejs function set_autoStart( newval ) php cpp m pas function set_autoStart( $newval ) int set_autoStart( Y_AUTOSTART_enum newval )

-(int) setAutoStart : (Y_AUTOSTART_enum) newval function set_autoStart( newval : Integer): integer vb cs java py cmd function set_autoStart( ByVal newval As Integer) As Integer int set_autoStart( int newval ) int set_autoStart( int newval ) def set_autoStart( newval )

YDataLogger target set_autoStart newval

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

Paramètres : newval soit Y_AUTOSTART_OFF , soit Y_AUTOSTART_ON , selon le mode d'activation automatique de l'enregistreur de données à la mise sous tension

Retourne :

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

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

270 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ set_logicalName() datalogger

→ setLogicalName()

Modifie le nom logique de l'enregistreur de données.

js nodejs function set_logicalName( newval ) function set_logicalName( newval ) php cpp function set_logicalName( $newval ) int set_logicalName( const string& newval ) m pas vb cs

-(int) setLogicalName : (NSString*) newval function set_logicalName( newval : string): integer function set_logicalName( ByVal newval As String) As Integer int set_logicalName( string newval ) java py cmd int set_logicalName( String newval ) def set_logicalName( newval )

YDataLogger target set_logicalName newval

YDataLogger

Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.

Paramètres : newval une chaîne de caractères représentant le nom logique de l'enregistreur de données.

Retourne :

YAPI_SUCCESS si l'appel se déroule sans erreur. En cas d'erreur, déclenche une exception ou retourne un code d'erreur négatif.

www.yoctopuce.com

271

19. Référence de l'API de haut niveau datalogger

→ set_recording() datalogger

→ setRecording()

Modifie l'état d'activation de l'enregistreur de données.

js function set_recording( newval ) nodejs function set_recording( newval ) php cpp m pas function set_recording( $newval ) int set_recording( Y_RECORDING_enum newval )

-(int) setRecording : (Y_RECORDING_enum) newval function set_recording( newval : Integer): integer vb cs java py cmd function set_recording( ByVal newval As Integer) As Integer int set_recording( int newval ) int set_recording( int newval ) def set_recording( newval )

YDataLogger target set_recording newval

YDataLogger

Paramètres : newval soit Y_RECORDING_OFF , soit Y_RECORDING_ON , selon l'état d'activation de l'enregistreur de données

Retourne :

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

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

272 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ set_timeUTC() datalogger

→ setTimeUTC()

Modifie la référence de temps UTC, afin de l'attacher aux données enregistrées.

js nodejs function set_timeUTC( newval ) function set_timeUTC( newval ) php cpp function set_timeUTC( $newval ) int set_timeUTC( s64 newval ) m pas vb cs

-(int) setTimeUTC : (s64) newval function set_timeUTC( newval : int64): integer function set_timeUTC( ByVal newval As Long) As Integer int set_timeUTC( long newval ) java py cmd int set_timeUTC( long newval ) def set_timeUTC( newval )

YDataLogger target set_timeUTC newval

YDataLogger

Paramètres : newval un entier représentant la référence de temps UTC, afin de l'attacher aux données enregistrées

Retourne :

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

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

www.yoctopuce.com

273

19. Référence de l'API de haut niveau datalogger

→ set_userData() datalogger

→ setUserData()

YDataLogger

Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData .

js function set_userData( data ) nodejs function set_userData( data ) php function set_userData( $data ) cpp m pas vb cs java py void set_userData( void* data )

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

Paramètres : data objet quelconque à mémoriser

274 www.yoctopuce.com

19. Référence de l'API de haut niveau datalogger

→ wait_async() YDataLogger

Attend que toutes les commandes asynchrones en cours d'exécution sur le module soient terminées, et appelle le callback passé en paramètre.

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

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

context contexte fourni par l'appelant, et qui sera passé tel-quel à la fonction de callback

Retourne : rien du tout : www.yoctopuce.com

275

19. Référence de l'API de haut niveau

19.5. Séquence de données enregistrées

Les objets YDataSet permettent de récupérer un ensemble de mesures enregistrées correspondant à un capteur donné, pour une période choisie. Ils permettent le chargement progressif des données.

Lorsque l'objet YDataSet est instancié par la fonction get_recordedData() , aucune donnée n'est encore chargée du module. Ce sont les appels successifs à la méthode loadMore() qui procèdent au chargement effectif des données depuis l'enregistreur de données.

Un résumé des mesures disponibles est disponible via la fonction get_preview() dès le premier appel à loadMore() . Les mesures elles-même sont disponibles via la fonction get_measures() au fur et à mesure de leur chargement.

Cette classe ne fonctionne que si le module utilise un firmware récent, car les objets YDataSet ne sont pas supportés par les firmwares antérieurs à la révision 13000.

Pour utiliser les fonctions décrites ici, vous devez inclure: js nodejs php cpp m

#include "yocto_api.h"

#import "yocto_api.h" pas vb cs java py uses yocto_api; yocto_api.vb

yocto_api.cs

import com.yoctopuce.YoctoAPI.YModule; from yocto_api import *

Méthodes des objets

YDataSet

dataset

get_endTimeUTC()

Retourne l'heure absolue de la fin des mesures disponibles, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix).

dataset

get_functionId()

Retourne l'identifiant matériel de la fonction qui a effectué les mesures, sans référence au module.

dataset

Retourne l'identifiant matériel unique de la fonction qui a effectué les mesures, au format

SERIAL.FUNCTIONID

dataset

get_measures()

Retourne toutes les mesures déjà disponibles pour le DataSet, sous forme d'une liste d'objets YMeasure.

dataset

get_preview()

Retourne une version résumée des mesures qui pourront être obtenues de ce YDataSet, sous forme d'une liste d'objets YMeasure.

dataset

get_progress()

Retourne l'état d'avancement du chargement des données, sur une échelle de 0 à 100.

dataset

get_startTimeUTC()

Retourne l'heure absolue du début des mesures disponibels, sous forme du nombre de secondes depuis le

1er janvier 1970 (date/heure au format Unix).

dataset

get_summary()

Retourne un objet YMeasure résumant tout le YDataSet.

dataset

get_unit()

276 www.yoctopuce.com

19. Référence de l'API de haut niveau

Retourne l'unité dans laquelle la valeur mesurée est exprimée.

dataset

loadMore()

Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, et met à jour l'indicateur d'avancement.

dataset

loadMore_async(

callback , context )

Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, de manière asynchrone.

www.yoctopuce.com

277

19. Référence de l'API de haut niveau dataset

→ get_endTimeUTC() dataset

→ endTimeUTC()

YDataSet

Retourne l'heure absolue de la fin des mesures disponibles, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix).

js function get_endTimeUTC( ) nodejs function get_endTimeUTC( ) php cpp m pas function get_endTimeUTC( ) s64 get_endTimeUTC( )

-(s64) endTimeUTC function get_endTimeUTC( ): int64 vb cs java py function get_endTimeUTC( ) As Long long get_endTimeUTC( ) long get_endTimeUTC( ) def get_endTimeUTC( )

Lorsque l'objet YDataSet est créé, l'heure de fin est celle qui a été passée en paramètre à la fonction get_dataSet . Dès le premier appel à la méthode loadMore() , l'heure de fin est mise à jour à la dernière mesure effectivement disponible dans l'enregistreur de données pour la plage spécifiée.

Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la dernière mesure.

278 www.yoctopuce.com

19. Référence de l'API de haut niveau dataset

→ get_functionId() dataset

→ functionId()

YDataSet

Retourne l'identifiant matériel de la fonction qui a effectué les mesures, sans référence au module.

js nodejs function get_functionId( ) function get_functionId( ) php cpp function get_functionId( ) string get_functionId( ) m pas vb cs java py

-(NSString*) functionId function get_functionId( ): string function get_functionId( ) As String string get_functionId( )

String get_functionId( ) def get_functionId( )

Par example temperature1 .

Retourne : une chaîne de caractères identifiant la fonction (ex: temperature1 ) www.yoctopuce.com

279

19. Référence de l'API de haut niveau dataset

→ get_hardwareId() dataset

→ hardwareId()

YDataSet

Retourne l'identifiant matériel unique de la fonction qui a effectué les mesures, au format

SERIAL.FUNCTIONID

js function get_hardwareId( ) nodejs function get_hardwareId( ) php function get_hardwareId( ) cpp m pas vb cs java py string get_hardwareId( )

-(NSString*) hardwareId function get_hardwareId( ): string function get_hardwareId( ) As String string get_hardwareId( )

String get_hardwareId( ) def get_hardwareId( )

L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction

(par example THRMCPL1-123456.temperature1

Retourne : une chaîne de caractères identifiant la fonction (ex: THRMCPL1-123456.temperature1

)

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

280 www.yoctopuce.com

19. Référence de l'API de haut niveau dataset

→ get_measures() dataset

→ measures()

YDataSet

Retourne toutes les mesures déjà disponibles pour le DataSet, sous forme d'une liste d'objets

YMeasure.

js nodejs function get_measures( ) function get_measures( ) php cpp function get_measures( ) vector<YMeasure> get_measures( ) m pas vb cs java py

-(NSMutableArray*) measures function get_measures( ): TYMeasureArray function get_measures( ) As List

List<YMeasure> get_measures( )

ArrayList<YMeasure> get_measures( ) def get_measures( )

Chaque élément contient: - le moment ou la mesure a débuté - le moment ou la mesure s'est terminée la valeur minimale observée dans l'intervalle de temps - la valeur moyenne observée dans l'intervalle de temps - la valeur maximale observée dans l'intervalle de temps

Avant d'appeler cette méthode, vous devez appeler loadMore() pour charger des données depuis l'enregistreur sur le module. L'appel doit être répété plusieurs fois pour charger toutes les données, mais vous pouvez commencer à utiliser les données disponibles avant qu'elles n'aient été toutes chargées

Les mesures les plus anciennes sont toujours chargées les premières, et les plus récentes 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ù il y a eu un ajustement de l'horloge UTC de l'enregistreur de données pendant l'enregistrement.

Retourne : un tableau d'enregistrements, chaque enregistrement représentant une mesure effectuée à un moment précis.

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

www.yoctopuce.com

281

19. Référence de l'API de haut niveau dataset

→ get_preview() dataset

→ preview()

YDataSet

Retourne une version résumée des mesures qui pourront être obtenues de ce YDataSet, sous forme d'une liste d'objets YMeasure.

js function get_preview( ) nodejs function get_preview( ) php cpp m pas function get_preview( ) vector<YMeasure> get_preview( )

-(NSMutableArray*) preview function get_preview( ): TYMeasureArray vb cs java py function get_preview( ) As List

List<YMeasure> get_preview( )

ArrayList<YMeasure> get_preview( ) def get_preview( )

Chaque élément contient: - le début d'un intervalle de temps - la fin d'un intervalle de temps - la valeur minimale observée dans l'intervalle de temps - la valeur moyenne observée dans l'intervalle de temps la valeur maximale observée dans l'intervalle de temps

Le résumé des mesures est disponible dès que loadMore() a été appelé pour la première fois.

Retourne : un tableau d'enregistrements, chaque enregistrement représentant les mesures observée durant un certain intervalle de temps.

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

282 www.yoctopuce.com

19. Référence de l'API de haut niveau dataset

→ get_progress() dataset

→ progress()

Retourne l'état d'avancement du chargement des données, sur une échelle de 0 à 100.

js nodejs function get_progress( ) function get_progress( ) php cpp function get_progress( ) int get_progress( ) m pas vb cs java py

-(int) progress function get_progress( ): LongInt function get_progress( ) As Integer int get_progress( ) int get_progress( ) def get_progress( )

YDataSet

A l'instanciation de l'objet par la fonction get_dataSet() , l'avancement est nul. Au fur et à mesure des appels à loadMore() , l'avancement progresse pour atteindre la valeur 100 lorsque toutes les mesures ont été chargées.

Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées.

www.yoctopuce.com

283

19. Référence de l'API de haut niveau dataset

→ get_startTimeUTC() dataset

→ startTimeUTC()

YDataSet

Retourne l'heure absolue du début des mesures disponibels, sous forme du nombre de secondes depuis le 1er janvier 1970 (date/heure au format Unix).

js function get_startTimeUTC( ) nodejs function get_startTimeUTC( ) php cpp m pas function get_startTimeUTC( ) s64 get_startTimeUTC( )

-(s64) startTimeUTC function get_startTimeUTC( ): int64 vb cs java py function get_startTimeUTC( ) As Long long get_startTimeUTC( ) long get_startTimeUTC( ) def get_startTimeUTC( )

Lorsque l'objet YDataSet est créé, l'heure de départ est celle qui a été passée en paramètre à la fonction get_dataSet . Dès le premier appel à la méthode loadMore() , l'heure de départ est mise

à jour à la première mesure effectivement disponible dans l'enregistreur de données pour la plage spécifiée.

Retourne : un entier positif correspondant au nombre de secondes écoulées entre le 1er janvier 1970 et la première mesure enregistrée.

284 www.yoctopuce.com

19. Référence de l'API de haut niveau dataset

→ get_summary() dataset

→ summary()

YDataSet

Retourne un objet YMeasure résumant tout le YDataSet.

js nodejs function get_summary( ) function get_summary( ) php cpp function get_summary( )

YMeasure get_summary( ) m pas vb cs java py

-(YMeasure*) summary function get_summary( ): TYMeasure function get_summary( ) As YMeasure

YMeasure get_summary( )

YMeasure get_summary( ) def get_summary( )

Il inclut les information suivantes: - le moment de la première mesure - le moment de la dernière mesure - la valeur minimale observée dans l'intervalle de temps - la valeur moyenne observée dans l'intervalle de temps - la valeur maximale observée dans l'intervalle de temps

Ce résumé des mesures est disponible dès que loadMore() a été appelé pour la première fois.

Retourne : un objet YMeasure www.yoctopuce.com

285

19. Référence de l'API de haut niveau dataset

→ get_unit() dataset

→ unit()

Retourne l'unité dans laquelle la valeur mesurée est exprimée.

js function get_unit( ) nodejs function get_unit( ) php cpp m pas function get_unit( ) string get_unit( )

-(NSString*) unit function get_unit( ): string vb cs java py function get_unit( ) As String string get_unit( )

String get_unit( ) def get_unit( )

Retourne : une chaîne de caractères représentant une unité physique.

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

YDataSet

286 www.yoctopuce.com

19. Référence de l'API de haut niveau dataset

→ loadMore() YDataSet

Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, et met à jour l'indicateur d'avancement.

js function loadMore( ) nodejs function loadMore( ) php function loadMore( ) cpp m pas vb cs java py int loadMore( )

-(int) loadMore function loadMore( ): LongInt function loadMore( ) As Integer int loadMore( ) int loadMore( ) def loadMore( )

Retourne : un nombre entier entre 0 et 100 représentant l'avancement du chargement des données demandées, ou un code d'erreur négatif en cas de problème.

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

www.yoctopuce.com

287

19. Référence de l'API de haut niveau dataset

→ loadMore_async() YDataSet

Procède au chargement du bloc suivant de mesures depuis l'enregistreur de données du module, de manière asynchrone.

js function loadMore_async( callback , context ) nodejs function loadMore_async( callback , context )

Paramètres : callback fonction fournie par l'utilisateur, qui sera appelée lorsque la suite du chargement aura été effectué. La fonction callback doit prendre trois arguments: - la variable de contexte à disposition de l'utilisateur - l'objet YDataSet dont la méthode loadMore_async a été appelée - le résultat de l'appel: soit l'état d'avancement du chargement (0...100), ou un code d'erreur négatif en cas de problème.

context variable de contexte à disposition de l'utilisateur

Retourne : rien.

288 www.yoctopuce.com

19. Référence de l'API de haut niveau

19.6. Valeur mesurée

Les objets YMeasure sont utilisés dans l'interface de programmation Yoctopuce pour représenter une valeur observée un moment donnée. Ces objets sont utilisés en particulier en conjonction avec la classe YDataSet.

Pour utiliser les fonctions décrites ici, vous devez inclure: js nodejs php cpp m pas vb cs java py

#include "yocto_api.h"

#import "yocto_api.h" uses yocto_api; yocto_api.vb

yocto_api.cs

import com.yoctopuce.YoctoAPI.YModule; from yocto_api import *

Méthodes des objets

YMeasure

measure

get_averageValue()

Retourne la valeur moyenne observée durant l'intervalle de temps couvert par la mesure.

measure

get_endTimeUTC()

Retourne l'heure absolue de la fin de la mesure, sous forme du nombre de secondes depuis le 1er janvier

1970 UTC (date/heure au format Unix).

measure

get_maxValue()

Retourne la plus grande valeur observée durant l'intervalle de temps couvert par la mesure.

measure

get_minValue()

Retourne la plus petite valeur observée durant l'intervalle de temps couvert par la mesure.

measure