Référence de la classe I2CDCDriver

Graphe d'héritage de I2CDCDriver:

Graphe de collaboration de I2CDCDriver:

Fonctions membres publiques
	I2CDCDriver (int m1_fwd_port, int m1_bck_port, int m1_pwm, int m2_fwd_port, int m2_bck_port, int m2_pwm, int stdby_port)
	Constructeur du driver DRV8876.
void	init (i2c_dev_t *dev)
	Initialise les broches matérielles. Configure les entrées/sorties et réveille le driver si sleepPin est défini.
int	attach (AbstractMotor *motor) override
	Attache un moteur au canal disponible (ID 0).
int	attach (AbstractMotor *motor, uint8_t id) override
	Attache un moteur à un ID spécifique.
void	setVelocity (float velocity, uint8_t id) override
	Définit la vitesse de sortie pour le moteur spécifié.
float	getVelocity (uint8_t id) const override
	Récupère la dernière vitesse appliquée.
bool	isFaulty () const
	Vérifie l'état de santé du driver.
void	setSleep (bool active)
	Contrôle le mode basse consommation.
	I2CDCDriver (int m1_fwd_port, int m1_bck_port, int m1_pwm, int m2_fwd_port, int m2_bck_port, int m2_pwm, int stdby_port)
	Constructeur du driver DRV8876.
void	init (i2c_dev_t *dev)
	Initialise les broches matérielles. Configure les entrées/sorties et réveille le driver si sleepPin est défini.
int	attach (AbstractMotor *motor) override
	Attache un moteur au canal disponible (ID 0).
int	attach (AbstractMotor *motor, uint8_t id) override
	Attache un moteur à un ID spécifique.
void	setVelocity (float velocity, uint8_t id) override
	Définit la vitesse de sortie pour le moteur spécifié.
float	getVelocity (uint8_t id) const override
	Récupère la dernière vitesse appliquée.
bool	isFaulty () const
	Vérifie l'état de santé du driver.
void	setSleep (bool active)
	Contrôle le mode basse consommation.
Fonctions membres publiques hérités de AbstractDriver
virtual void	detach (const int id)
	Détache le moteur à cet identifiant.
AbstractMotor *	getMotor (const int id) const
	Retourne un pointeur vers le moteur à l'identifiant donné.
virtual void	detach (const int id)
	Détache le moteur à cet identifiant.
AbstractMotor *	getMotor (const int id) const
	Retourne un pointeur vers le moteur à l'identifiant donné.

Membres hérités additionnels
Attributs protégés hérités de AbstractDriver
AbstractMotor *	m_motors [MAX_MOTOR_IN_DRIVER] = {}

Documentation des constructeurs et destructeur

I2CDCDriver() [1/2]

I2CDCDriver::I2CDCDriver	(	int	m1_fwd_port,
		int	m1_bck_port,
		int	m1_pwm,
		int	m2_fwd_port,
		int	m2_bck_port,
		int	m2_pwm,
		int	stdby_port )

Constructeur du driver DRV8876.

Paramètres

scl	Pin SCL.
sda	Pin SDA.

I2CDCDriver() [2/2]

I2CDCDriver::I2CDCDriver	(	int	m1_fwd_port,
		int	m1_bck_port,
		int	m1_pwm,
		int	m2_fwd_port,
		int	m2_bck_port,
		int	m2_pwm,
		int	stdby_port )

Constructeur du driver DRV8876.

Paramètres

scl	Pin SCL.
sda	Pin SDA.

Documentation des fonctions membres

attach() [1/4]

int I2CDCDriver::attach ( AbstractMotor * motor )

overridevirtual

Attache un moteur au canal disponible (ID 0).

Paramètres

motor

Pointeur vers l'objet AbstractMotor.

Renvoie

L'ID affecté (0) ou -1 en cas d'erreur.

Implémente AbstractDriver.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

attach() [2/4]

int I2CDCDriver::attach ( AbstractMotor * motor )

overridevirtual

Attache un moteur au canal disponible (ID 0).

Paramètres

motor

Pointeur vers l'objet AbstractMotor.

Renvoie

L'ID affecté (0) ou -1 en cas d'erreur.

Implémente AbstractDriver.

attach() [3/4]

int I2CDCDriver::attach ( AbstractMotor * motor, uint8_t id )

overridevirtual

Attache un moteur à un ID spécifique.

Paramètres

motor	Pointeur vers l'objet AbstractMotor.
id	Identifiant du canal (doit être 0 pour le DRV8876).

Renvoie

L'ID affecté ou -1 si l'ID est invalide (> 0).

Implémente AbstractDriver.

attach() [4/4]

int I2CDCDriver::attach ( AbstractMotor * motor, uint8_t id )

overridevirtual

Attache un moteur à un ID spécifique.

Paramètres

motor	Pointeur vers l'objet AbstractMotor.
id	Identifiant du canal (doit être 0 pour le DRV8876).

Renvoie

L'ID affecté ou -1 si l'ID est invalide (> 0).

Implémente AbstractDriver.

getVelocity() [1/2]

float I2CDCDriver::getVelocity ( uint8_t id ) const

overridevirtual

Récupère la dernière vitesse appliquée.

Paramètres

id	Identifiant du moteur (0).

Renvoie

Vitesse entre -1.0 et 1.0.

Implémente AbstractDriver.

getVelocity() [2/2]

float I2CDCDriver::getVelocity ( uint8_t id ) const

overridevirtual

Récupère la dernière vitesse appliquée.

Paramètres

id	Identifiant du moteur (0).

Renvoie

Vitesse entre -1.0 et 1.0.

Implémente AbstractDriver.

isFaulty() [1/2]

bool I2CDCDriver::isFaulty

(

)

const

Vérifie l'état de santé du driver.

Renvoie

true si la broche nFAULT est à l'état BAS (Erreur).

isFaulty() [2/2]

bool I2CDCDriver::isFaulty

(

)

const

Vérifie l'état de santé du driver.

Renvoie

true si la broche nFAULT est à l'état BAS (Erreur).

setSleep() [1/2]

void I2CDCDriver::setSleep

(

bool

active

)

Contrôle le mode basse consommation.

Paramètres

active

true pour mettre le driver en sommeil, false pour le réveiller.

setSleep() [2/2]

void I2CDCDriver::setSleep

(

bool

active

)

Contrôle le mode basse consommation.

Paramètres

active

true pour mettre le driver en sommeil, false pour le réveiller.

setVelocity() [1/2]

void I2CDCDriver::setVelocity ( float velocity, uint8_t id )

overridevirtual

Définit la vitesse de sortie pour le moteur spécifié.

• Paramètres

  velocity	Vitesse normalisée entre -1.0 et 1.0. Le signe détermine l'état de la broche DIR.
  id	Identifiant du moteur (0).

Implémente AbstractDriver.

setVelocity() [2/2]

void I2CDCDriver::setVelocity ( float velocity, uint8_t id )

overridevirtual

Définit la vitesse de sortie pour le moteur spécifié.

• Paramètres

  velocity	Vitesse normalisée entre -1.0 et 1.0. Le signe détermine l'état de la broche DIR.
  id	Identifiant du moteur (0).

Implémente AbstractDriver.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• motors/include/I2CDCDriver.h
• Wheeledbase/lib/motors/include/I2CDCDriver.h
• motors/src/I2CDCDriver.cpp
• Wheeledbase/lib/motors/src/I2CDCDriver.cpp