Diff: HCSR04.h

Revision:

3:12d6d751f4fc

Parent:

0:d1d7bb1c1f6c

Child:

4:be89035b2c42

diff -r d1d7bb1c1f6c -r 12d6d751f4fc HCSR04.h
--- a/HCSR04.h	Thu Feb 05 19:00:51 2015 +0000
+++ b/HCSR04.h	Sun Feb 22 17:15:47 2015 +0000
@@ -1,3 +1,37 @@
+/**
+ * @author Nestor Pereira-Neto  Team: SalvadorEngenharia
+ *
+ * @section LICENSE
+ *
+ * Copyright (c) 2010 ARM Limited
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @section DESCRIPTION
+ *
+ * Biblioteca para uso do sonar HC-SR04, possui rotinas para permitir medições 
+ * de distências retornado valores em centímetros, polegadas ou o tempo 
+ * percorrido pelo som (em microsegundos).
+ * Esta biblioteca pode ser usada com qualquer pino do microcontrolador.
+ */
+
+
 #ifndef HCSR04_H
 #define HCSR04_H
 
@@ -5,7 +39,8 @@
 
 
 
-/** Sonar HC-SR04 example.
+/** 
+ * Sonar HC-SR04 example.
  * @code
  * #include "mbed.h"
  * #include "HCSR04.h"
@@ -13,11 +48,11 @@
  * DigitalOut myled(LED1);
  * Serial pc(USBTX,USBRX);     
  *
- * HCSR04 sonar(PTB0, PTD3);
+ * HCSR04 sonar(PTD5, PTA13);
  *
  * int main() {
  *     while(1) {
- *         printf("Distancia detectada pelo sensor Frente %.2f cm \n", sonar.echo()); 
+ *         printf("Distancia detectada pelo sensor Frente %.2f cm \n", sonar.getCm()); 
  *         wait_ms(1000);
  *     }
  * }
@@ -27,7 +62,7 @@
 
 class HCSR04 {    
     public:    
-        /** Constructor, create HC_SR04 instance 
+        /** Constructor, create HCSR04 instance 
           *
           * @param trigger TRIG pin
           * @param echo ECHO pin
@@ -52,12 +87,12 @@
         
     private:
         float tdist;        //Leitura do tempo transcorrido
-        float distcm;       //
-        float distin;   
+        float distcm;       //Guarda o valor da distanciância em centímetros
+        float distin;       //Guarda o valor da distência em polegadas
         
         DigitalOut _t;      //Configuração do pino de Trigger  
         DigitalIn _e;       //Configuração do pino de Echo
-        Timer _tempo;
+        Timer _tempo;       //Cria um objeto timer
         
 };