#include <velocistaEdu.h>

Métodos públicos
void	establecerVelocidad (int velocidadIzquierda, int velocidadDerecha) const

boolean	botonLiberado ()

void	actualizarSensoresLinea ()

int	obtenerMedidaLinea () const

void	obtenerSensoresLinea (unsigned int s[4]) const

void	obtenerCuentaEncoders (unsigned int &encoderIzquierdo, unsigned int &encoderDerecho) const

void	resetearCuentaEncoders () const

unsigned int	obtenerTensionBateria () const

void	encenderLed (const LEDS led) const

void	apagarLed (const LEDS led) const

void	reproducirNota (unsigned int nota, unsigned int duracion) const

Métodos protegidos
	VelocistaEdu (const boolean cambiarPolaridadMotorIzquierdo=false, const boolean cambiarPolaridadMotorDerecho=false)

Atributos protegidos
boolean	esperandoSoltarBoton_
	Permite controlar el momento en el que se libera el boton.

unsigned int	s_ [4]
	Guarda el valor de los sensores infrarrojos.

const bool	motorIzquierdoAvanza_
	Valor que se le debe poner al pin de direccion izquierdo para que el motor izquierdo avance.

const bool	motorDerechoAvanza_
	Valor que se le debe poner al pin de direccion derecho para que el motor derecho avance.

Amigas
VelocistaEdu &	obtenerRobot (const boolean cambiarPolaridadMotorIzquierdo, const boolean cambiarPolaridadMotorDerecho)

Descripción detallada

Clase de control del velocistaEdu Tiene las funciones basicas para empezar a usar el kit de velocista El objeto de control solo se puede obtener mediante una llamada a la funcion obtenerRobot Esto implementa un patron singleton para asegurar que solo hay un objeto de tipo VelocistaEdu en el programa

Documentación del constructor y destructor

VelocistaEdu::VelocistaEdu	(	const boolean	cambiarPolaridadMotorIzquierdo = `false`,
		const boolean	cambiarPolaridadMotorDerecho = `false`
	)

protected

Constructor que inicializa los pines usados por el kit Es privado, con lo que solo se pueden crear objetos de la clase VelocistaEdu haciendo uso de la funcion amiga obtenerRobot

Ver también: obtenerRobot()

Parámetros

[in]	cambiarPolaridadMotorIzquierdo	cambia la polaridad del motor izquierdo
[in]	cambiarPolaridadMotorDerecho	cambia la polaridad del motor derecho

Documentación de las funciones miembro

void VelocistaEdu::actualizarSensoresLinea ( )

Funcion que actualiza las variables internas que guardan los valores de los sensores infrarrojos

Ver también: obtenerMedidaLinea(); obtenerSensoresLinea()

void VelocistaEdu::apagarLed ( const LEDS led ) const

inline

Funcion que apaga un LED

Parámetros

[in] led el led que se quiere apagar

boolean VelocistaEdu::botonLiberado ( )

Funcion que comprueba las pulsaciones en el boton del robot

Devuelve: true cuando se suelta el boton, false en el resto de condiciones

void VelocistaEdu::encenderLed ( const LEDS led ) const

inline

Funcion que enciende un LED

Parámetros

[in] led el led que se quiere encender

void VelocistaEdu::establecerVelocidad	(	int	velocidadIzquierda,
		int	velocidadDerecha
	)		const

Funcion que establece pone un pwm en los motores

Parámetros

[in]	velocidadIzquierda	PWM para el motor izquierdo
[in]	velocidadDerecha	PWM para el motor derecho

void VelocistaEdu::obtenerCuentaEncoders	(	unsigned int &	encoderIzquierdo,
		unsigned int &	encoderDerecho
	)		const

Funcion que permite obtener la cuenta interna de los encoders

Ver también: resetearCuentaEncoders()

Parámetros

[out]	encoderIzquierdo	variable donde se guardara la cuenta para el encoder de la rueda izquierda
[out]	encoderDerecho	variable donde se guardara la cuenta para el encoder de la rueda derecha

int VelocistaEdu::obtenerMedidaLinea ( ) const

funcion que devuelve la posicion de la linea detectada Cuando la linea se deja de detectar devuelve el ultimo valor bueno conocido Es necesario haber llamado a la funcion actualizarSensoresLinea() para usar los valores de los sensores mas actuales

Ver también: actualizarSensoresLinea(); obtenerSensoresLinea()

Devuelve: La posicion de la linea entre -30 y 30 (aproximadamente)

void VelocistaEdu::obtenerSensoresLinea ( unsigned int s[4] ) const

inline

Funcion que guarda en un array los ultimos valores conocidos de los sensores inrarojos Es necesario haber llamado a la funcion actualizarSensoresLinea() para usar los valores de los sensores mas actuales

Ver también: actualizarSensoresLinea(); obtenerMedidaLinea()

Parámetros

[out] s array donde se guardaran los valores de los sensores

unsigned int VelocistaEdu::obtenerTensionBateria ( ) const

funcion que devuelve la tension de la bateria

Devuelve: La tension de la bateria en mV

void VelocistaEdu::reproducirNota	(	unsigned int	nota,
		unsigned int	duracion
	)		const

inline

Funcion que reproduce una nota en el buzzer

Parámetros

[in]	nota	la nota en hercios a reproducir
[in]	duracion	la duracion en milisegundos de la nota

void VelocistaEdu::resetearCuentaEncoders ( ) const

Funcion que pone la cuenta de los encoder a 0

Ver también: obtenerCuentaEncoders()

Documentación de las funciones relacionadas y clases amigas

VelocistaEdu& obtenerRobot	(	const boolean	cambiarPolaridadMotorIzquierdo,
		const boolean	cambiarPolaridadMotorDerecho
	)

friend

Funcion amiga de la clase VelocistaEdu. Esto permite que pueda acceder a los miembros y metodos privados De esta forma esta funcion es capaz de crear un objeto de tipo VelocistaEdu, pues el constructor es privado

Parámetros

[in]	cambiarPolaridadMotorIzquierdo	cambia la polaridad del motor izquierdo. Solo funiona la primera vez que es llada la funcion
[in]	cambiarPolaridadMotorDerecho	cambia la polaridad del motor derecho. Solo funiona la primera vez que es llada la funcion

La documentación para esta clase fue generada a partir de los siguientes ficheros:

/home/emigjul/Documents/PersonalProjects/git/velocistaEdu/src/velocistaEdu.h
/home/emigjul/Documents/PersonalProjects/git/velocistaEdu/src/velocistaEdu.cpp

Métodos públicos

Métodos protegidos

Atributos protegidos

Amigas

Descripción detallada

Documentación del constructor y destructor

Documentación de las funciones miembro

Documentación de las funciones relacionadas y clases amigas