format_list_bulleted

Fonctions de réglage

Reconfigurer les paramètres par défault de votre robot

nameWrite()

Syntaxe

Robby.nameWrite(name);

Description

nameWrite() permet de donner à nom à Robby qui sera enregistré dans son EEPROM (mémoire dont les valeurs sont gardés même après avoir éteint le robot). La fonction ne renvoie aucune variable et prend comme argument une liste d'au maximum 8 char.

Exemple

#include <BRAINZY.h>

void setup(){
  //votre code...
  Robby.nameWrite("monRobot");
}

void loop(){
  //votre code...
}

nameRead()

Syntaxe

Robby.nameRead(container);

Description

nameRead() permet de récupérer le nom de Robby pré-enregistré dans l'EEPROM. La fonction ne renvoie aucune variable et prend comme argument une liste de 8 char qui sera modifié pour recevoir le nom.

Exemple

#include <BRAINZY.h>

char container[8];

void setup(){
  //votre code...
  Robby.nameRead(container);
}

void loop(){
  //votre code...
}

setMode()

Syntaxe

Robby.setMode(modeid);

Description

setMode() permet de définir le mode de déplacement de Robby. La fonction ne renvoie aucune variable et prend comme argument l'une des constantes d'identifications suivantes :

  • DIFFERENTIALstructure différentielle
  • OMNIDIRECTIONALstructure omnidirectionelle

Exemple

#include <BRAINZY.h>

void setup(){
  Robby.setMode(DIFFERENTIAL);
  //votre code...
}

void loop(){
  //votre code...
}

setWidth()

Syntaxe

Robby.setWidth(w);

Description

setWidth() permet de redéfinir l'écartement des roues (distance en mm). La fonction ne renvoie aucune variable et prend comme argument un float.

warningCette fonction doit être appelée après setMode().

Exemple

#include <BRAINZY.h>

float w = 250;

void setup(){
  Robby.setMode(DIFFERENTIAL);
  Robby.setWidth(w);
  //votre code...
}

void loop(){
  //votre code...
}

getWidth()

Syntaxe

Robby.getWidth();

Description

getWidth() permet de récupérer l'écartement des roues (distance en mm). La fonction renvoie un float et ne prend aucun argument.

Exemple

#include <BRAINZY.h>

float w = 0;

void setup(){
  //votre code...
  w = Robby.getWidth();
}

void loop(){
  //votre code...
}

setDiameterWheel()

Syntaxe

Robby.setDiameterWheel(d);

Description

setDiameterWheel() permet de redéfinir le diamètre des roues (distance en mm). La fonction ne renvoie aucune variable et prend comme argument un float.

warningCette fonction doit être appelée après setMode().

Exemple

#include <BRAINZY.h>

float d = 60;

void setup(){
  Robby.setMode(DIFFERENTIAL);
  Robby.setDiameterWheel(d);
  //votre code...
}

void loop(){
  //votre code...
}

getDiameterWheel()

Syntaxe

Robby.getDiameterWheel();

Description

getDiameterWheel() permet de récupérer le diamètre des roues (distance en mm). La fonction renvoie un float et ne prend aucun argument.

Exemple

#include <BRAINZY.h>

float d = 0;

void setup(){
  //votre code...
  d = Robby.getDiameterWheel();
}

void loop(){
  //votre code...
}

setMaxTranslationVelocity()

Syntaxe

Robby.setMaxTranslationVelocity(s);

Description

setMaxTranslationVelocity() permet de redéfinir la vitesse maximale de translation [TODO unité à définir]. La fonction ne renvoie aucune variable et prend comme argument un float.

Exemple

#include <BRAINZY.h>

float s = 0.5;

void setup(){
  //votre code...
  Robby.setMaxTranslationVelocity(s);
}

void loop(){
  //votre code...
}

getMaxTranslationVelocity()

Syntaxe

Robby.getMaxTranslationVelocity();

Description

getMaxTranslationVelocity() permet de récupérer la vitesse maximale de translation [TODO unité à définir]. La fonction renvoie un float et ne prend aucun argument.

Exemple

#include <BRAINZY.h>

float s = 0;

void setup(){
  //votre code...
  s = Robby.getMaxTranslationVelocity();
}

void loop(){
  //votre code...
}

setMaxRotationVelocity()

Syntaxe

Robby.setMaxRotationVelocity(s);

Description

setMaxRotationVelocity() permet de redéfinir la vitesse maximale de rotation [TODO unité à définir]. La fonction ne renvoie aucune variable et prend comme argument un float.

Exemple

#include <BRAINZY.h>

float s = 0.15;

void setup(){
  //votre code...
  Robby.setMaxRotationVelocity(s);
}

void loop(){
  //votre code...
}

getMaxRotationVelocity()

Syntaxe

Robby.getMaxRotationVelocity();

Description

getMaxRotationVelocity() permet de récupérer la vitesse maximale de rotation [TODO unité à définir]. La fonction renvoie un float et ne prend aucun argument.

Exemple

#include <BRAINZY.h>

float s = 0;

void setup(){
  //votre code...
  s = Robby.getMaxRotationVelocity();
}

void loop(){
  //votre code...
}

setTranslationAcceleration()

Syntaxe

Robby.setTranslationAcceleration(a);

Description

setTranslationAcceleration() permet de redéfinir l'accélération maximale de translation [TODO unité à définir]. La fonction ne renvoie aucune variable et prend comme argument un float.

Exemple

#include <BRAINZY.h>

float a = 0.00025;

void setup(){
  //votre code...
  Robby.setTranslationAcceleration(a);
}

void loop(){
  //votre code...
}

getTranslationAcceleration()

Syntaxe

Robby.getTranslationAcceleration();

Description

getTranslationAcceleration() permet de récupérer l'accélération maximale de translation [TODO unité à définir]. La fonction renvoie un float et ne prend aucun argument.

Exemple

#include <BRAINZY.h>

float a = 0;

void setup(){
  //votre code...
  a = Robby.getTranslationAcceleration();
}

void loop(){
  //votre code...
}

setRotationAcceleration()

Syntaxe

Robby.setRotationAcceleration(a);

Description

setRotationAcceleration() permet de redéfinir l'accélération maximale de rotation [TODO unité à définir]. La fonction ne renvoie aucune variable et prend comme argument un float.

Exemple

#include <BRAINZY.h>

float a = 0.00015;

void setup(){
  //votre code...
  Robby.setRotationAcceleration(a);
}

void loop(){
  //votre code...
}

getRotationAcceleration()

Syntaxe

Robby.getRotationAcceleration();

Description

getRotationAcceleration() permet de récupérer l'accélération maximale de rotation [TODO unité à définir]. La fonction renvoie un float et ne prend aucun argument.

Exemple

#include <BRAINZY.h>

float a = 0;

void setup(){
  //votre code...
  a = Robby.getRotationAcceleration();
}

void loop(){
  //votre code...
}

attachMotors()

Syntaxe

Pour les structures différentielles

Robby.attachMotors(leftmotor1,leftmotor2,rightmotor1,rightmotor2);

Pour les structures omnidirectionelles

Robby.attachMotors(leftmotor1,leftmotor2,rightmotor1,rightmotor2,frontmotor1,frontmotor2);

Description

attachMotors() permet de définir les pins de sortie des moteurs.
Pin ID Description
MOT1_1
MOT1_2
Pins de la BRAINZY Board associés
aux bornes du moteur gauche
MOT2_1
MOT2_2
Pins de la BRAINZY Board associés
aux bornes du moteur droit
MOT3_1
MOT3_2
Pins de la BRAINZY Board associés
aux bornes du moteur avant

infoCette fonction est implémenté dans setMode().

Exemple

#include <BRAINZY.h>

void setup(){
  Robby.attachMotors(MOT1_1,MOT1_2,MOT2_1,MOT2_2,MOT3_1,MOT3_2);
  //votre code...
}

void loop(){
  //votre code...
}

attachEncoders()

Syntaxe

Pour les structures différentielles

Robby.attachEncoders(leftencoderA,leftencoderB,rightencoderA,rightencoderB);

Pour les structures omnidirectionelles

Robby.attachEncoders(leftencoderA,leftencoderB,rightencoderA,rightencoderB,frontencoderA,frontencoderB);

Description

attachEncoders() permet de définir les pins d'entrée des codeurs incrémentaux.
Pin ID Description
ENC1_A
ENC1_B
Pins de la BRAINZY Board associés
au codeur du moteur gauche
ENC2_A
ENC2_B
Pins de la BRAINZY Board associés
au codeur du moteur droit
ENC3_A
ENC3_B
Pins de la BRAINZY Board associés
au codeur du moteur avant

infoCette fonction est implémenté dans setMode().

Exemple

#include <BRAINZY.h>

void setup(){
  Robby.attachEncoders(ENC1_A,ENC1_B,ENC2_A,ENC2_B,ENC3_A,ENC3_B);
  //votre code...
}

void loop(){
  //votre code...
}

attachBattery()

Syntaxe

Robby.attachBattery(firstcell,secondcell,thirdcell);

Description

attachBattery() permet de définir les pins d'entrée des cellules de la batterie.

Pin ID Description
BATT1 Pin de la BRAINZY Board associé
à la 1er cellule
BATT2 Pin de la BRAINZY Board associé
aux 2 premières cellules (en série)
BATT3 Pin de la BRAINZY Board associé
aux 3 cellules (en série)

infoCette fonction est implémenté dans setMode().

Exemple

#include <BRAINZY.h>

void setup(){
  Robby.attachBattery(BATT1,BATT2,BATT3);
  //votre code...
}

void loop(){
  //votre code...
}

sendAT()

Syntaxe

Robby.sendAT(port,msg,timeout,debug);

Description

sendAT() permet d'envoyer des commandes AT aux modules Bluetooth et/ou Wifi via le port série. La fonction ne renvoie aucune variable et prend comme arguments le port série sur lequel communiquer (HardwareSerial), le message à envoyer (String), et deux autres arguments facultatifs : le temps maximum d'attente d'une réponse (unsigned long en ms - par défault 1000ms), un debugger (bool) pour afficher la réponse sur le port série USB si true (false par défaut).

infoConsultez ces tutoriels pour connaître les commandes AT des modules Wifi et Bluetooth.

warningPour utiliser cette fonction le port série Wifi et/ou Bluetooth doit être ouvert avec les vitesses de communication respective 115200 baud et 38400 baud. Si le debugger est activé, le port série USB doit aussi être ouvert.

Exemple

#include <BRAINZY.h>

void setup(){
  //votre code...
  USB.begin(115200);
  Wifi.begin(115200);
  Robby.sendAT(Wifi,"AT",1000,true);
}

void loop(){
  //votre code...
}