CRINSA-team2024 2024
Documentation du Club Robot INSA Rennes 2024
Chargement...
Recherche...
Aucune correspondance
Référence de la classe serialtalking.SerialTalking

Serial Talking (python) Plus de détails...

Fonctions membres publiques

 __init__ (self, port, timeout=10)
 Initie une instance de SerialTalking avec un arduino.
 
 connect (self, timeout=5)
 Connecte à un arduino.
 
 disconnect (self)
 Se deconnecte de l'arduino.
 
 available (self)
 écoute la ligne rx et décode le message entrant
 
 get_status_code (self)
 Retourne le code de status de pySerialTransfert.
 
 ping (self)
 Ping l'arduino.
 
 getuuid (self)
 Retourne l'uuid de l'arduino.
 
 setuuid (self, uuid)
 Paramètre l'uuid.
 
 clearEEPROM (self)
 
 getEEPROM (self, address)
 Renvoie une valeur de l'eeprom.
 
 setEEPROM (self, address, value)
 Change une valeur de l'eeprom.
 
 order (self, opcode, *args)
 Envoie un ordre à l'arduino.
 
 request (self, opcode, *args, send_args=None, timeout=5)
 Requête à l'arduino.
 
 free_receiver (self)
 Remet à zero le compteur RX.
 
 free_sender (self)
 Remet à zero le compteur TX.
 
 send_buffer (self, OPCODE)
 Envoie le buffer préconfiguré
 
 read_buffer (self, obj_type)
 Lit le buffer RX.
 
 write_buffer (self, data, data_size=1)
 Ecrit dans le buffer.
 
 get_logs (self)
 
 clear_logs (self)
 

Description détaillée

Serial Talking (python)

Comme SerialTalks mais autre; middleware entre pyserialTransfert et l'user

Documentation des constructeurs et destructeur

◆ __init__()

serialtalking.SerialTalking.__init__ ( self,
port,
timeout = 10 )

Initie une instance de SerialTalking avec un arduino.

Paramètres
portport de l'arduino
timeouttemps max de connection (default à 5sec)
Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

◆ available()

serialtalking.SerialTalking.available ( self)

écoute la ligne rx et décode le message entrant

Renvoie
self.link.available()
Voici le graphe d'appel pour cette fonction :
Voici le graphe des appelants de cette fonction :

◆ clear_logs()

serialtalking.SerialTalking.clear_logs ( self)
Description:
------------
Clear the log_buffer
:return: void
Voici le graphe d'appel pour cette fonction :
Voici le graphe des appelants de cette fonction :

◆ clearEEPROM()

serialtalking.SerialTalking.clearEEPROM ( self)
Paramètres
Voici le graphe d'appel pour cette fonction :

◆ connect()

serialtalking.SerialTalking.connect ( self,
timeout = 5 )

Connecte à un arduino.

Paramètres
timeouttimeout de bas à 5 sec
Voici le graphe d'appel pour cette fonction :
Voici le graphe des appelants de cette fonction :

◆ get_logs()

serialtalking.SerialTalking.get_logs ( self)
Description:
------------
Return all communication that didn't started with 0X7E
:return: log buffer
Voici le graphe d'appel pour cette fonction :
Voici le graphe des appelants de cette fonction :

◆ get_status_code()

serialtalking.SerialTalking.get_status_code ( self)

Retourne le code de status de pySerialTransfert.

Renvoie
self.link.status

◆ getEEPROM()

serialtalking.SerialTalking.getEEPROM ( self,
address )

Renvoie une valeur de l'eeprom.

Paramètres
addressadresse de la valeur
Renvoie
valeur à l'adresse
Voici le graphe d'appel pour cette fonction :

◆ getuuid()

serialtalking.SerialTalking.getuuid ( self)

Retourne l'uuid de l'arduino.

Renvoie
uuid
Voici le graphe d'appel pour cette fonction :

◆ order()

serialtalking.SerialTalking.order ( self,
opcode,
* args )

Envoie un ordre à l'arduino.

Paramètres
opcodeCode de l'opération
*argsarguments d'envoi
Voici le graphe d'appel pour cette fonction :
Voici le graphe des appelants de cette fonction :

◆ ping()

serialtalking.SerialTalking.ping ( self)

Ping l'arduino.

Renvoie
vrai si pingé, faux sinon
Voici le graphe d'appel pour cette fonction :

◆ read_buffer()

serialtalking.SerialTalking.read_buffer ( self,
obj_type )

Lit le buffer RX.

Paramètres
Typede l'obj
Renvoie
valeur
Voici le graphe des appelants de cette fonction :

◆ request()

serialtalking.SerialTalking.request ( self,
opcode,
* args,
send_args = None,
timeout = 5 )

Requête à l'arduino.

Paramètres
opcodeCode de l'opération
*argstype des éléments reçu
send_argsliste des paramètre qui vont avec l'envoi
timeout5sec
Renvoie
Renvoie une liste data des données reçue
Voici le graphe d'appel pour cette fonction :
Voici le graphe des appelants de cette fonction :

◆ send_buffer()

serialtalking.SerialTalking.send_buffer ( self,
OPCODE )

Envoie le buffer préconfiguré

Paramètres
OPCODEcode de l'opération
Renvoie
succes de l'opération
Voici le graphe d'appel pour cette fonction :
Voici le graphe des appelants de cette fonction :

◆ setEEPROM()

serialtalking.SerialTalking.setEEPROM ( self,
address,
value )

Change une valeur de l'eeprom.

Paramètres
addressadresse de la valeur à changer
valuela valeur à changer
Voici le graphe d'appel pour cette fonction :

◆ setuuid()

serialtalking.SerialTalking.setuuid ( self,
uuid )

Paramètre l'uuid.

Paramètres
uuidl'uuid à changer
Voici le graphe d'appel pour cette fonction :

La documentation de cette classe a été générée à partir du fichier suivant :