Référence de la classe Codewheel

Fait la passerelle entre les roues codeuses et le compteur. Plus de détails...

#include <Codewheel.h>

Est dérivée de NonCopyable, et AbstractCodewheel.

Graphe de collaboration de Codewheel:

Fonctions membres publiques
void	attachCounter (int XY, int AXIS, int SEL1, int SEL2, int OE, int RST)
	Set les pins pour le compteur.
void	attachRegister (int DATA, int LATCH, int CLOCK)
	Set les pins pour les registres du compteur.
long	getCounter ()
	Donne le nombre de tic absolue courant.
long	getCountsPerRev ()
	Donne le nombre de tics par tour courant.
float	getWheelRadius ()
	Donne le rayon de la roue en mm.
void	setCountsPerRev (long countsPerRev)
	Set le nombre de tics par tour.
void	setWheelRadius (float wheelRadius)
	Set le rayon en mm de la roue.
void	reset ()
	Réinitialise le compteur à 0.
float	getTraveledDistance ()
	Donne la distance parcouru.
float	restart ()
	Donne la distance parcouru et reset le compteur.
void	load (int address)
	Charge les données de l'EEPROM avec l'offset.
void	save (int address)
	Sauvegarde les constantes actuelles dans l'EEPROM.

Fonctions membres protégées
void	update ()
	Récupère le nombre de tics stoqués dans le compteur.

Attributs protégés
long	m_currentCounter
	Tic courant.
long	m_startCounter
	Tic depuis le dernier reset.
float	m_wheelRadius
	Rayon de la roue codeuse en mm.
long	m_countsPerRev
	Nombre de tics par tour de roue.
int	m_COUNTER_XY
	Select one of the two quad counters. See below.
int	m_COUNTER_AXIS
	Not a pin: X = 0, Y = 0.
int	m_COUNTER_SEL1
	MSB = 0, 2ND = 1, 3RD = 0, LSB = 1.
int	m_COUNTER_SEL2
	MSB = 0, 2ND = 0, 3RD = 1, LSB = 1.
int	m_COUNTER_OE
	Active LOW. Enable the tri-states output buffers.
int	m_COUNTER_RST
	Active LOW. Clear the internal position counter and the position latch.
int	m_REGISTER_DATA
	Serial data input from the 74HC165 register.
int	m_REGISTER_LATCH
	Active LOW. Latch signal for the 74HC165 register.
int	m_REGISTER_CLOCK
	LOW-to-HIGH edge-triggered. Clock signal for the 74HC165 register.

Description détaillée

Fait la passerelle entre les roues codeuses et le compteur.

class Codewheel

Auteur

Ulysse Darmet Cette classe permet de récupérer les tics des roues codeuses à travers la puce compteuse.

Documentation des fonctions membres

attachCounter()

void Codewheel::attachCounter	(	int	XY,
		int	AXIS,
		int	SEL1,
		int	SEL2,
		int	OE,
		int	RST )

Set les pins pour le compteur.

Paramètres

XY	Voir doc elec
AXIS	Voir doc elec
SEL1	Voir doc elec
SEL2	Voir doc elec
OE	Voir doc elec
RST	Voir doc elec

attachRegister()

void Codewheel::attachRegister	(	int	DATA,
		int	LATCH,
		int	CLOCK )

Set les pins pour les registres du compteur.

Paramètres

DATA
LATCH
CLOCK

getCounter()

long Codewheel::getCounter ( )

inline

Donne le nombre de tic absolue courant.

Renvoie

long Le nombre de tics depuis le dernier reset.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getCountsPerRev()

long Codewheel::getCountsPerRev ( )

inline

Donne le nombre de tics par tour courant.

Renvoie

long Nombre de tics par tour.

getTraveledDistance()

float Codewheel::getTraveledDistance ( )

virtual

Donne la distance parcouru.

Cette méthode donne la distance parcouru par la roue depuis le dernier Codewheel::reset ou Codewheel::restart.

Renvoie

float

Implémente AbstractCodewheel.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getWheelRadius()

float Codewheel::getWheelRadius ( )

inline

Donne le rayon de la roue en mm.

Renvoie

float rayon en mm.

load()

void Codewheel::load

(

int

address

)

Charge les données de l'EEPROM avec l'offset.

Paramètres

address

Offset à utiliser pour lire dans l'EEPROM.

reset()

void Codewheel::reset

(

)

Réinitialise le compteur à 0.

Cette méthode peut rendre caduque le prochain Codewheel::getTraveledDistance.

restart()

float Codewheel::restart ( )

virtual

Donne la distance parcouru et reset le compteur.

Cette méthode appel la méthode Codewheel::getTravemedDistance avant de mettre à jour le compteur de l'arduino (pas du compteur (puce elec)).

Renvoie

float

Implémente AbstractCodewheel.

Voici le graphe d'appel pour cette fonction :

save()

void Codewheel::save

(

int

address

)

Sauvegarde les constantes actuelles dans l'EEPROM.

Paramètres

address

Offset à utiliser pour ecrire dans l'EEPROM.

setCountsPerRev()

void Codewheel::setCountsPerRev

(

long

countsPerRev

)

Set le nombre de tics par tour.

Paramètres

countsPerRev

nb de tics par tour.

setWheelRadius()

void Codewheel::setWheelRadius

(

float

wheelRadius

)

Set le rayon en mm de la roue.

Paramètres

wheelRadius

rayon en mm.

---

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

• C:/Users/boris/Desktop/robotique/team2024/platformIO/LIBS/ARDUINO_LIBS/Codewheel/Codewheel.h
• C:/Users/boris/Desktop/robotique/team2024/platformIO/LIBS/ARDUINO_LIBS/Codewheel/Codewheel.cpp