/trunk/code/projects/libdragonfly/analog.c - Diff - Colony - Robotics Club

Revision 862

Updated analog.c and analog.h documentation and regenerated the docs. No need to remake the library as its just comments.

     		an_val[i].adc8 = 0;
+    	}
     	//cli();
     	// ADMUX register
     	// Bit 7,6 - Set voltage reference to AVcc (0b01)
     	// Bit 5 - ADLAR set to simplify moving from register
-...
     	ADMUX = 0;
     	ADMUX |= ADMUX_OPT | _BV(MUX0);
     	// ADC Status Register A
     	// Bit 7 - ADEN is set (enables analog)
     	// Bit 6 - Start conversion bit is set (must be done once for free-running mode)
-...
     		analog_start_loop();
     	else
     		analog_stop_loop();
     	//sei();
+    }
     /**
      * Returns the 8-bit analog conversion of which from
      * the lookup table. If the requested port is the BOM_PORT
      * you will get an automatic 0 since the BOM_PORT is not
      * read in the loop and not stored. If you need that port
      * you should use the functions in bom.c. There is an analog_get8
      * function which for instant lookups but should be avoided unless
      * you know what you're doing.
+     *
      * @param which the port that you want to read
+     *
      * @bug may cause a seg fault if which is a larger value
      * than exists in an_val table. Not sure if we should fix
      * this or not since it would add overhead.
+     *
      * @return 8-bit analog value for the which port requested
+     *
      * @see analog10, analog_get8, analog_get10
      **/
     unsigned int analog8(int which) {
     	if (which == BOM_PORT) {
     		return 0;
-...
      * you will get an automatic 0 since the BOM_PORT is not
      * read in the loop and not stored. If you need that port
      * you should use the functions in bom.c. There is an analog_get10
      * function which for instant lookups but should be avoided.
      * function which for instant lookups but should be avoided unless
      * you know what you are doing.
+     *
      * @param which the port that you want to read
+     *
-...
+    	}
+    }
     /**
      * Starts the analog update loop. Will continue to run
      * until analog_stop_loop is called.
-...
     	adc_loop_running = 0x0;
+    }
     /**
      * Reads an eight bit number from an analog port.
      * Reads an 8-bit number from an analog port.
      * analog_init must be called before using this function.
      * The analog loop must also be stopped before using this
      * function or you will mess up the lookup table. You
      * must also reenabled the loop when you are done unless
      * you are doing more instant reads. See analog_stop_loop
      * and analog_start_loop for more information about the loop.
+     *
      * @param which the analog port to read from. One of
      * the constants AN0 - AN7.
+     *
      * @return the eight bit input to the specified port
      * @return the 8-bit input to the specified port
+     *
      * @see analog_init, analog10
      * @see analog_init, analog_get10, analog8, analog_stop_loop,
      * analog_start_loop
      **/
     unsigned int analog_get8(int which) {
     	// Let any previous conversion finish
-...
+    }
     /**
      * Reads a ten bit number from the specified port.
      * Reads an 10-bit number from an analog port.
      * analog_init must be called before using this function.
      * The analog loop must also be stopped before using this
      * function or you will mess up the lookup table. You
      * must also reenabled the loop when you are done unless
      * you are doing more instant reads. See analog_stop_loop
      * and analog_start_loop for more information about the loop.
+     *
+     *
      * @param which the analog port to read from. Typically
      * a constant, one of AN0 - AN7.
+     *
      * @return the ten bit number input to the specified port
      * @return the 10-bit number input to the specified port
+     *
      * @see analog_init, analog8
      * @see analog_init, analog_get8, analog10, analog_stop_loop,
      * analog_start_loop
      **/
     unsigned int analog_get10(int which) {
     	int adc_h;

Also available in: Unified diff

Project

General

Profile

Colony

Revision 862