Utilisation :

Exemple d'utilisation en Python
    
 from tuxisalive.api import *
 tux = TuxAPI('127.0.0.1', 270)
 tux.server.autoConnect(CLIENT_LEVEL_RESTRICTED, 'MonAppli', 'monMotdePasse')
 tux.server.waitConnected(10.0)
 tux.dongle.waitConnected(10.0)
 tux.radio.waitConnected(10.0)
 if tux.access.waitAcquire(10.0, ACCESS_PRIORITY_NORMAL): # On prend la ressource
     # votre code ici
     # exemple tux.flippers.up()

     # exemple tux.flippers.down()

     ...
     tux.access.release() # On relache la ressource
 ...
 tux.server.disconnect()
 tux.destroy()

ou à partir du tuxsh

>>> tux.flippers.up()
True

Fonctions :

tux.flippers.


down()
    Baisse les ailes.

    @retour: succès de la commande ( True ou False ).

exemple :

>>> tux.flippers.down()
True


getMovingState()
    Est ce que les ailes bougent ?
    
    @retour: True ou False (booléen).


getPosition()
    Renvoie la position des ailes.
    
    @retour: (NDEF|UP|DOWN)  # (Non Défini|Levées|Baissées)

exemple :

>>> tux.flippers.getPosition()
'UP'


off()
    Stop le mouvement des ailes.

    @retour: succès de la commande ( True ou False ).


on(nombre, EtatFinal='NDEF',vitesse=5)
    Bouge les ailes un certain nombre de fois.
    
    @paramètre nombre: nombre de mouvement.
    @paramètre EtatFinal: état final voulu après le mouvement.
                        (NDEF|UP|DOWN)  # (Non Défini|Levées|Baissées)
    @paramètre vitesse: vitesse du mouvement.
                       (1|2|3|4|5)  # 1 = Très Lentement, 2 = Lentement, 3 = Normal, 4 = Rapide, 5 = Très Rapide.

    @retour: succès de la commande ( True ou False ).

exemple :

>>> tux.flippers.on(5)
True

ou

>>> tux.flippers.on(5,'UP')
True

onAsync(nombre, EtatFinal='NDEF', vitesse=5)
    Bouge les ailes un certain nombre de fois. Asynchrone.
    
    @paramètre nombre: nombre de mouvement.
    @paramètre EtatFinal: état final voulu après le mouvement.
                        (NDEF|UP|DOWN)  # (Non Défini|Levées|Baissées)
    @paramètre vitesse: vitesse du mouvement.
                       (1|2|3|4|5)  # 1 = Très Lentement, 2 = Lentement, 3 = Normal, 4 = Rapide, 5 = Très Rapide.

    @retour: succès de la commande ( True ou False ).



exemple :

voir l'utilisation de fonction on précédente

onDuring(temps, EtatFinal='NDEF', vitesse=5)
    Bouge les ailes pendant un certain temps en seconde.
    
    @paramètre temps: temps en seconde.
    @paramètre EtatFinal: état final voulu après le mouvement.
                       (NDEF|UP|DOWN)  # (Non Défini|Levées|Baissées)
    @paramètre vitesse: vitesse du mouvement.
                       (1|2|3|4|5)  # 1 = Très Lentement, 2 = Lentement, 3 = Normal, 4 = Rapide, 5 = Très Rapide.

    @retour: succès de la commande ( True ou False ).

exemple :

>>> tux.flippers.onDuring(5.0,'DOWN')  # Bouge les ailes pendant 5 secondes, ailes baissées à la fin
True

ou

>>> tux.flippers.onDuring(5.0)  # Bouge les ailes pendant 5 secondes
True

onDuringAsync(temps, EtatFinal='NDEF', vitesse=5)
    Bouge les ailes pendant un certain temps en seconde.  Asynchrone.
    
    @paramètre temps: temps en seconde.
    @paramètre EtatFinal: état final voulu après le mouvement.
                        (NDEF|UP|DOWN)  # (Non Défini|Levées|Baissées)
    @paramètre vitesse: vitesse du mouvement.
                       (1|2|3|4|5)  # 1 = Très Lentement, 2 = Lentement, 3 = Normal, 4 = Rapide, 5 = Très Rapide.

    @retour: succès de la commande ( True ou False ).

exemple :

voir l'utilisation de la fonction onDuring précédente

setSpeed(vitesse)
    Fixe la vitesse du mouvement des ailes.
    
   @paramètre vitesse: vitesse du mouvement.
                       (1|2|3|4|5)  # 1 = Très Lentement, 2 = Lentement, 3 = Normal, 4 = Rapide, 5 = Très Rapide.
    @retour: succès de la commande ( True ou False ).

exemple :

>>> tux.flippers.setSpeed(1)
True


up()
    Lève les ailes.


    @retour: succès de la commande ( True ou False ).


exemple :

>>> tux.flippers.up()
True


waitMovingOff(temps)
    Attend, un certain temps, que les ailes ne bougent pas.
    
    @paramètre temps: temps maximum d'attente en seconde.
    @retour: résultat de l'état d'attente.


waitPosition(position, temps)
    Attend, un certain temps, une position spécifique des ailes.
    
    @paramètre position: position à attendre.
    @paramètre temps: temps maximum d'attente en seconde.
    @retour: résultat de l'état d'attente.