Skip to content

Latest commit

 

History

History
245 lines (174 loc) · 7.72 KB

README.md

File metadata and controls

245 lines (174 loc) · 7.72 KB

Sobre a GuaraTeca_OBR

A GuaraTeca é uma sub-biblioteca da biblioteca Guarateca, focada na programação de robôs, baseadas em Arduino, para a participação na Olimpiada Brasileira de Robotica - OBR. Reduzindo o tempo de produção e facilitando a compreenção do codigo e totalmente em português.

Esta biblioteca presume o robô do usuário com a seguinte estrutura:

  • De 1 a 4 motores DC, através da PonteH ou MotorShield.
  • Sensores de refletância.
  • Sensores de cor.
  • Sensores ultrassônicos.
  • Sensores acelerômetros e giroscópios.
  • LEDs e demais atuadores simples.

Instalação

  1. Primeiro baixe a biblioteca clicando aqui
  2. Abra a sua IDE do Arduino, clique em Sketch > Incluir Biblioteca > Adicionar biblioteca .ZIP
  3. Procure a biblioteca GuaraTeca_OBR baixada em arquivo .ZIP em sua pasta de downloads
  4. Pronto, agora a sua biblioteca está instalada e pronta para ser utilizada!

Utilização

#define funcao OBR
#include <GuaraTeca.h>

// Inicializa um objeto da classe Led na porta 7
Led led(7);

void setup() {}

void loop() {
  led.liga(100);
  led.desliga(100);
}

Para utilizar a biblioteca, em plataforma Windows basta que definamos a função da Guarateca como "OBR", através de uma constante "funcao", no sketch presente no IDE do Arduino.

#define funcao OBR
#include <GuaraTeca.h>

Ao fazermos isso já aplicamos todas as propriedades de compilação ao nosso arquivo principal. Caso utilize a plataforma Linux, o cabeçalho deverá seguir o seguinte modelo:

#include <Wire.h>
#include <LiquidCrystal.h>
#include <GuaraTeca_MotorShield.h>
#include <GuaraTeca_SensorCor.h>
#include <GuaraTeca_SensorUltrassonico.h>
#include <GuaraTeca_Bluethoth.h>
#include <GuaraTeca_TelaCristalLiquido.h>
#include <GuaraTeca_SensorRefletancia.h>
#include <GuaraTeca_SensorDHT.h>
#include <GuaraTeca_SensorGiroscopioAcelerometro.h>
#include <GuaraTeca_Buzzer.h>
#include <GuaraTeca_SensorChuva.h>
#include <GuaraTeca_Servo.h>
#include <GuaraTeca_PonteH.h>
#include <GuaraTeca_OBR.h>

#define funcao OBR
#include <GuaraTeca.h>

Motores

Para inicializar um par de motores

MRobot "nomeObjeto"( "conexao1", "conexao2", "velocidade");

Este é o construtor de objetos da classe MRobot que tem como função o controle de motores DC com a utilização da MotorShield da Adafruit. Essa classe permite o uso de até 2 motores DC por objeto, ou seja para o uso de mais motores é necessário declarar outro objeto da classe. O controle de velocidade se dá a partir do último parâmetro sendo medido de 0 à 100.

HRobot "nomeObjeto"("1A", "1B", "1V", "2A", "2B", "2V", velocidade);

Este é o construtor de objetos da classe "HRobot" que tem como função o controle de motores DC com a utilização de PonteH dupla de qualquer fabricante. Essa classe permite o controle de 2 motores DC. Os parâmetros a serem passados para a biblioteca são as 6 portas da PonteH dupla, sendo 4 de controle da direção dos motores e 2 de controle de velocidade, de tal modo que os 3 primeiros parâmetros correspondem a 1 dos lados da ponte H na respectiva ordem: pino de controle 1 e 2 do motor seguido do seu pino de velocidade, o mesmo vale para o outro lado, seu último parâmetro corresponde ao controle de velocidade medido de 0 à 100.

Movimentação

"nomeObjeto"."direção"("tempo");

Por padrão para as classes "MRobot" e "HRobot" a movimentação de motores segue o modelo acima. Sendo então o nome do objeto seguido de sua direção no ambiente: "frente", "tras", "esquerda", "direita" ou "para". Seu tempo de duração é definido em segundos, caso o tempo não seja informado ou seja igual a 0 ele iniciara a ação e a manterá em execução até que algo o interrompa.

Auxiliares

"nomeObjeto".DefineVelocidade("V1", "V2");

Esse método tem como função o controle de velocidade dos motores DC das Classes: "MRobot" e "HRobot". Os dois parâmetros são obrigatório.

Sensores

Sensor objeto.([uint8_t pino1, uint8_t pino2]);

Para inicializar um sensor, utilize o construtor Sensor "objeto".(["pino1", "pino2"]), onde "objeto" deve ser substituído pelo nome que você pretende dar ao sensor, e cada "pino" representa o número de um pino ao qual o seu sensor está ligado. Ex.:

Sensor sensorLuz(A0);

A classe Sensor é capaz de controlar diversos tipos de sensores, como os de cor, luz/refletância, ultrassônico, giroscópio e acelerômetro. O reconhecimento do tipo de sensor a ser controlado se dá pela quantidade de pinos que são passados ao construtor, desta forma temos:

  • Parâmetros vazios: sensor giroscópio.
  • 1 pino: sensor de luz/refletância ou sensor de condução.
  • 2 pinos: sensor ultrassônico.
  • 5 pinos: sensor de cor.

Para compreender melhor, observe o exemplo a seguir:

Sensor sensorLuz(A0);
Sensor sensorCor(1, 2, 3, 4, 5);
Sensor sensorUltrassonico(A0);
Sensor giroscopio();
Sensor acelerometro();

Sensores de Luz/Refletância

int luz()

O método luz() retorna um valor do tipo inteiro lido por um sensor de refltância.

sensorLuz.luz();

Sensores de Cor

int cor()

O método cor() retorna um valor do tipo inteiro lido por um sensor de cor/luminosidade.

sensorCor.cor();

Sensores Ultrassônicos

float distancia()

O método distancia() retorna um valor do tipo real lido por um sensor ultrassônico, indicando a distância até um obstáculo em centímetros.

sensorUltrassonico.distancia();

Acelerômetros e Giroscópios

int giroscopioX()

Retorna o valor do eixo X captado por um giroscópio. Ex.:

meuGiroscopio.giroscopioX();

int giroscopioY()

Retorna o valor do eixo Y captado por um giroscópio. Ex.:

meuGiroscopio.giroscopioY();

int giroscopioZ()

Retorna o valor do eixo Z captado por um giroscópio. Ex.:

meuGiroscopio.giroscopioZ();

int acelerometroX()

Retorna o valor do eixo X captado por um acelerômetro. Ex.:

meuAcelerometro.acelerometroX();

int acelerometroY()

Retorna o valor do eixo Y captado por um acelerômetro. Ex.:

meuAcelerometro.acelerometroY();

int acelerometroZ()

Retorna o valor do eixo Z captado por um acelerômetro. Ex.:

meuAcelerometro.acelerometroZ();

LEDs

Led objeto(int pino);

Para inicializar um LED (Light Emitting Diode | Diodo Emissor de Luz), utilize o construtor Led "objeto"("int pino"), onde "objeto" deve ser substituído pelo nome que você pretende dar ao sensor, e "pino" representa o número do pino digital ao qual o LED está ligado.

O exemplo a seguir inicializa um LED no pino digital 3:

Led meuLed(3);

Este mesmo construtor pode ser utilizado por outros componentes que utilizem apenas um pino digital, como um buzzer, por exemplo.

void liga([float ms])

O exemplo abaixo liga meuLed e aguarda 500 milissegundos.

meuLed.liga(500);

É possível utilizar este mesmo método sem um tempo de espera. Ex.:

meuLed.liga();

void desliga([float ms])

O exemplo abaixo desliga meuLed e aguarda 500 milissegundos.

meuLed.desliga(500);

É possível utilizar este mesmo método sem um tempo de espera. Ex.:

meuLed.desliga();

Suporte

Caso encontre falhas ou tenha sugestões, não exite em nos contatar em [email protected] ou [email protected].

Licença

A GuaraTeca é licenciada sob a Licença Pública Geral GNU GPL