La librairie de programmation Yoctopuce permet de commande la tension de srotir du module. Vous pouvez affecter une valeur fixe,ou faire des transition de voltage.
Pour utiliser les fonctions décrites ici, vous devez inclure:
#import "yocto_vsource.h" Fonction globales
Permet de retrouver une source de tension d'après un identifiant donné.
yFirstVSource()
Commence l'énumération des sources de tension accessibles par la librairie. Méthodes des objets YVSource
vsource→describe()
Retourne un court texte décrivant la fonction.
vsource→get_advertisedValue()
Retourne la valeur courante de la source de tension (pas plus de 6 caractères).
vsource→get_errorMessage()
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de la fonction.
vsource→get_errorType()
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de la fonction.
vsource→get_extPowerFailure()
Rend TRUE si le voltage de l'alimentation externe est trop bas.
vsource→get_failure()
Indique si le module est en condition d'erreur.
vsource→get_functionDescriptor()
Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.
vsource→get_hardwareId()
Retourne l'identifiant unique de la fonction.
vsource→get_logicalName()
Retourne le nom logique de la source de tension.
vsource→get_module()
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
vsource→get_module_async(callback, context)
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
vsource→get_overCurrent()
Rend TRUE si l'appareil connecté à la sortie du module consomme trop de courant.
vsource→get_overHeat()
Rend TRUE si le module est en surchauffe.
vsource→get_overLoad()
Rend TRUE si le module n'est pas capable de tenir la tension de sortie demandée.
vsource→get_regulationFailure()
Rend TRUE si le voltage de sortie de trop élevé par report à la tension demandée demandée.
vsource→get_unit()
Retourne l'unité dans laquelle la tension est exprimée.
vsource→get_userData()
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode
set_userData.
vsource→get_voltage()
Retourne la valeur de la commande de tension de sortie en mV
Vérifie si le module hébergeant la fonction est joignable, sans déclencher d'erreur.
vsource→isOnline_async(callback, context)
Vérifie si le module hébergeant la fonction est joignable, sans déclencher d'erreur.
vsource→load(msValidity)
Met en cache les valeurs courantes de la fonction, avec une durée de validité spécifiée.
vsource→load_async(msValidity, callback, context)
Met en cache les valeurs courantes de la fonction, avec une durée de validité spécifiée.
vsource→nextVSource()
Continue l'énumération des sources de tension commencée à l'aide de yFirstVSource().
vsource→pulse(voltage, ms_duration)
Active la sortie à une tension donnée, et pour durée spécifiée, puis revient ensuite spontanément à zéro volt.
vsource→registerValueCallback(callback)
Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.
vsource→reset()
Réinitilialise la sortie du module.
vsource→set_logicalName(newval)
Modifie le nom logique de la source de tension.
vsource→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.
vsource→set_voltage(newval)
Règle la tension de sortie du module (en milliVolts).
vsource→voltageMove(target, ms_duration)
Déclenche une variation constante de la sortie vers une valeur donnée.
yFindVSource()
Permet de retrouver une source de tension d'après un identifiant donné.
YVSource* yFindVSource( NSString* 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 la source de tension soit en ligne au moment ou elle est appelée, l'objet retourné sera néanmoins valide. Utiliser la méthode YVSource.isOnline () pour tester si la source de tension 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 :
funcune chaîne de caractères qui référence la source de tension sans ambiguïté
Retourne :
yFirstVSource()
Commence l'énumération des sources de tension accessibles par la librairie.
YVSource* yFirstVSource( )
Utiliser la fonction YVSource.nextVSource() pour itérer sur les autres sources de tension.
Retourne :
un pointeur sur un objet YVSource, correspondant à la première source de tension accessible en ligne, ou null si il n'y a pas de sources de tension disponibles.
[vsource describe]
Retourne un court texte décrivant la fonction.
-(NSString*) describe
Ce texte inclut toujours le nom de la classe, et peut contenir en sus soit le nom logique de la fonction, soit son identifiant hardware.
Retourne :
une chaîne de caractères décrivant la fonction
[vsource advertisedValue]
Retourne la valeur courante de la source de tension (pas plus de 6 caractères).
-(NSString*) advertisedValue
Retourne :
une chaîne de caractères représentant la valeur courante de la source de tension (pas plus de 6 caractères)
En cas d'erreur, déclenche une exception ou retourne Y_ADVERTISEDVALUE_INVALID.
Retourne le message correspondant à la dernière erreur survenue lors de l'utilisation de la fonction.
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 la fonction
Retourne le code d'erreur correspondant à la dernière erreur survenue lors de l'utilisation de la fonction.
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 la fonction
[vsource extPowerFailure]
Rend TRUE si le voltage de l'alimentation externe est trop bas.
-(Y_EXTPOWERFAILURE_enum) extPowerFailure
Retourne :
soit Y_EXTPOWERFAILURE_FALSE, soit Y_EXTPOWERFAILURE_TRUE
En cas d'erreur, déclenche une exception ou retourne Y_EXTPOWERFAILURE_INVALID.
[vsource failure]
Indique si le module est en condition d'erreur.
-(Y_FAILURE_enum) failure
Il possible de savoir de quelle erreur il s'agit en testant get_overheat, get_overcurrent etc... Lorsqu'un condition d'erreur est rencontée, la tension de sortie est mise à zéro est ne peut pas être changée tant la fonction reset() n'aura pas appellée.
Retourne :
soit Y_FAILURE_FALSE, soit Y_FAILURE_TRUE
En cas d'erreur, déclenche une exception ou retourne Y_FAILURE_INVALID.
[vsource vsourceDescriptor]
Retourne un identifiant unique de type YFUN_DESCR correspondant à la fonction.
-(YFUN_DESCR) 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
Retourne l'identifiant unique de la fonction.
L'identifiant unique est composé du numéro de série du module et de l'identifiant matériel de la fonction.
Retourne :
une chaîne de caractères identifiant la fonction En cas d'erreur, déclenche une exception ou retourne
Y_HARDWAREID_INVALID.
[vsource logicalName]
Retourne le nom logique de la source de tension.
-(NSString*) logicalName
Retourne :
une chaîne de caractères représentant le nom logique de la source de tension
[vsource module]
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
-(YModule*) 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
Retourne l'objet YModule correspondant au module Yoctopuce qui héberge la fonction.
Si la fonction ne peut être trouvée sur aucun module, l'instance de YModule retournée ne sera pas joignable.
Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.
Paramètres :
callbackfonction 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.
[vsource overCurrent]
Rend TRUE si l'appareil connecté à la sortie du module consomme trop de courant.
-(Y_OVERCURRENT_enum) overCurrent
Retourne :
soit Y_OVERCURRENT_FALSE, soit Y_OVERCURRENT_TRUE
En cas d'erreur, déclenche une exception ou retourne Y_OVERCURRENT_INVALID.
[vsource overHeat]
Rend TRUE si le module est en surchauffe.
-(Y_OVERHEAT_enum) overHeat
Retourne :
soit Y_OVERHEAT_FALSE, soit Y_OVERHEAT_TRUE
En cas d'erreur, déclenche une exception ou retourne Y_OVERHEAT_INVALID.
[vsource overLoad]
Rend TRUE si le module n'est pas capable de tenir la tension de sortie demandée.
-(Y_OVERLOAD_enum) overLoad
Retourne :
En cas d'erreur, déclenche une exception ou retourne Y_OVERLOAD_INVALID.
[vsource regulationFailure]
Rend TRUE si le voltage de sortie de trop élevé par report à la tension demandée demandée.
-(Y_REGULATIONFAILURE_enum) regulationFailure
Retourne :
soit Y_REGULATIONFAILURE_FALSE, soit Y_REGULATIONFAILURE_TRUE
En cas d'erreur, déclenche une exception ou retourne
Y_REGULATIONFAILURE_INVALID.
[vsource unit]
Retourne l'unité dans laquelle la tension est exprimée.
-(NSString*) unit
Retourne :
une chaîne de caractères représentant l'unité dans laquelle la tension est exprimée
En cas d'erreur, déclenche une exception ou retourne Y_UNIT_INVALID.
[vsource userData]
Retourne le contenu de l'attribut userData, précédemment stocké à l'aide de la méthode
set_userData.
-(void*) 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.
[vsource voltage]
Retourne la valeur de la commande de tension de sortie en mV
-(int) voltage
Retourne :
un entier représentant la valeur de la commande de tension de sortie en mV
En cas d'erreur, déclenche une exception ou retourne Y_VOLTAGE_INVALID.
[vsource isOnline]
Vérifie si le module hébergeant la fonction est joignable, sans déclencher d'erreur.
-(BOOL) isOnline
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité.
Retourne :
Vérifie si le module hébergeant la fonction est joignable, sans déclencher d'erreur.
Si les valeurs des attributs en cache de la fonction sont valides au moment de l'appel, le module est considéré joignable. Cette fonction ne cause en aucun cas d'exception, quelle que soit l'erreur qui pourrait se produire lors de la vérification de joignabilité.
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 VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.
Paramètres :
callbackfonction 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.
[vsource load: ]
Met en cache les valeurs courantes de la fonction, avec une durée de validité spécifiée.
-(YRETCODE) load : (int) 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 :
msValidityun 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.
Met en cache les valeurs courantes de la fonction, avec une durée de validité spécifiée.
Par défaut, lorsqu'on accède à un module, tous les attributs des fonctions du module sont automatiquement mises en cache pour la durée standard (5 ms). Cette méthode peut être utilisée pour marquer occasionellement les données cachées comme valides pour une plus longue période, par exemple dans le but de réduire le trafic réseau.
Cette version asynchrone n'existe qu'en Javascript. Elle utilise une fonction de callback plutôt qu'une simple valeur de retour, pour éviter de bloquer la VM Javascript de Firefox, qui n'implémente pas le passage de contrôle entre threads durant les appels d'entrée/sortie bloquants.
Paramètres :
msValidityun 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 :
[vsource nextVSource]
Continue l'énumération des sources de tension commencée à l'aide de yFirstVSource
().
-(YVSource*) nextVSource
Retourne :
un pointeur sur un objet YVSource accessible en ligne, ou null lorsque l'énumération est terminée.
[vsource pulse: ]
Active la sortie à une tension donnée, et pour durée spécifiée, puis revient ensuite spontanément à zéro volt.
-(int) pulse : (int) voltage : (int) ms_duration
Paramètres :
voltage tension demandée, en millivolts
ms_durationdurée de l'impulsion, 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.
[vsource registerValueCallback: ]
Enregistre la fonction de callback qui est appelée à chaque changement de la valeur publiée.
-(void) registerValueCallback : (YFunctionUpdateCallback) 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 :
callbackla 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.
[vsource reset]
Réinitilialise la sortie du module.
-(int) reset
Cette fonction doit être appelée après une condition d'erreur. Après toute condition d'erreur, le voltage de sortie est mis à zéro et ne peut pas être changé tant que cette fonction n'aura pas été appelée.
Retourne :
YAPI_SUCCESS si l'opération se déroule sans erreur.
[vsource setLogicalName: ]
Modifie le nom logique de la source de tension.
-(int) setLogicalName : (NSString*) newval
Vous pouvez utiliser yCheckLogicalName() pour vérifier si votre paramètre est valide. N'oubliez pas d'appeler la méthode saveToFlash() du module si le réglage doit être préservé.
Paramètres :
newvalune chaîne de caractères représentant le nom logique de la source de 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.
[vsource setUserData: ]
Enregistre un contexte libre dans l'attribut userData de la fonction, afin de le retrouver plus tard à l'aide de la méthode get_userData.
-(void) setUserData : (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 :
dataobjet quelconque à mémoriser
[vsource setVoltage: ]
Règle la tension de sortie du module (en milliVolts).
-(int) setVoltage : (int) newval
Paramètres :
newvalun entier
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.
[vsource voltageMove: ]
Déclenche une variation constante de la sortie vers une valeur donnée.
-(int) voltageMove : (int) target : (int) ms_duration
Paramètres :
target nouvelle valeur de sortie à la fin de la transition, en milliVolts.
ms_durationdurée de la transition, en millisecondes
Retourne :
YAPI_SUCCESS si l'opération se déroule sans erreur.