Diff: libs/Adc.cpp

Revision:

2:1df0b61d3b5a

Parent:

0:31e91bb0ef3c

--- a/libs/Adc.cpp	Sat Mar 01 02:37:29 2014 +0000
+++ b/libs/Adc.cpp	Fri Feb 28 18:52:52 2014 -0800
@@ -1,8 +1,8 @@
-/*  
+/*
       This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
       Smoothie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
       Smoothie is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-      You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>. 
+      You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
 */
 
 using namespace std;
@@ -14,10 +14,14 @@
 #include "libs/ADC/adc.h"
 #include "libs/Pin.h"
 
+// This is an interface to the mbed.org ADC library you can find in libs/ADC/adc.h
+// TODO : Having the same name is confusing, should change that
+
 Adc::Adc(){
     this->adc = new ADC(1000, 1);
 }
 
+// Enables ADC on a given pin
 void Adc::enable_pin(Pin* pin){
     PinName pin_name = this->_pin_to_pinname(pin);
     this->adc->burst(1);
@@ -25,27 +29,28 @@
     this->adc->interrupt_state(pin_name,1);
 }
 
+// Read the last value ( burst mode ) on a given pin
 unsigned int Adc::read(Pin* pin){
     return this->adc->read(this->_pin_to_pinname(pin));
 }
 
+// Convert a smoothie Pin into a mBed Pin
 PinName Adc::_pin_to_pinname(Pin* pin){
-    if( pin->port == LPC_GPIO0 && pin->pin == 23 ){ 
+    if( pin->port == LPC_GPIO0 && pin->pin == 23 ){
         return p15;
-    }else if( pin->port == LPC_GPIO0 && pin->pin == 24 ){ 
+    }else if( pin->port == LPC_GPIO0 && pin->pin == 24 ){
         return p16;
-    }else if( pin->port == LPC_GPIO0 && pin->pin == 25 ){ 
+    }else if( pin->port == LPC_GPIO0 && pin->pin == 25 ){
         return p17;
-    }else if( pin->port == LPC_GPIO0 && pin->pin == 26 ){ 
+    }else if( pin->port == LPC_GPIO0 && pin->pin == 26 ){
         return p18;
-    }else if( pin->port == LPC_GPIO1 && pin->pin == 30 ){ 
+    }else if( pin->port == LPC_GPIO1 && pin->pin == 30 ){
         return p19;
-    }else if( pin->port == LPC_GPIO1 && pin->pin == 31 ){ 
+    }else if( pin->port == LPC_GPIO1 && pin->pin == 31 ){
         return p20;
     }else{
-        //TODO: Error
-        error("Bad adc pin");
-        
+        //TODO: Error
+        return NC;
     }
 }