Diff: mcp3208.h

Revision:

2:93009a423b45

Parent:

1:316f86115221

--- a/mcp3208.h	Tue May 24 13:58:00 2011 +0000
+++ b/mcp3208.h	Tue May 24 14:06:57 2011 +0000
@@ -1,56 +1,70 @@
-#include "mbed.h"
-
-
-#ifndef MCP3208_H
-#define MCP3208_H
-
-
-enum Polarity {
-    POL_EVEN_POSITIVE,
-    POL_EVEN_NEGATIVE
-};
-
-
-/** Class for interfacing to the MCP3208 SPI-based ADC.
- *
- * This class will also allow interfacing to the MCP3204, but only four
- * inputs are provided by that chip, as opposed to the eight of the MCP3208.
- */
-class MCP3208
-{
-public:
-    MCP3208(SPI bus, PinName cs);
-    ~MCP3208();
-    
-    /** Read from a single-ended input.
-     *
-     * @param channel The channel number to read from.
-     *
-     * @param returns The sampled value as a float between 0.0 and 1.0.
-     */
-    float read_input(int channel);
-    
-    /** Read from a pair of differential inputs.
-     *
-     * In differential mode, the channels are referred to as 0 to 3, with
-     * polarity set in a separate parameter. This avoids the user having to set
-     * the polarity as part of the channel number or having channel numbers
-     * increase by two (i.e. the channels being 0, 2, 4, and 6).
-     *
-     * @param channel The channel number to read from.
-     * @param polarity The polarity of the differential signal.
-     *
-     * @param returns The sampled value as a float between 0.0 and 1.0.
-     */
-    float read_diff_input(int channel, Polarity polarity);
-  
-private:
-    DigitalOut m_cs;
-    SPI m_bus;
-    
-    void select();
-    void deselect();
-};
-
-
-#endif
+/**
+ * @file mcp3208.h
+ */
+
+#include "mbed.h"
+
+
+#ifndef MCP3208_H
+#define MCP3208_H
+
+
+/** Polarity setting for differential inputs.
+ *
+ * POL_EVEN_POSITIVE sets channel [0|2|4|6] as the positive side and channel
+ * [1|3|5|7] as the negative side. POL_EVEN_NEGATIVE sets the opposite.
+ */
+enum Polarity {
+    POL_EVEN_POSITIVE,
+    POL_EVEN_NEGATIVE
+};
+
+
+/** Class for interfacing to the MCP3208 SPI-based ADC.
+ *
+ * This class will also allow interfacing to the MCP3204, but only four
+ * inputs are provided by that chip, as opposed to the eight of the MCP3208.
+ */
+class MCP3208
+{
+public:
+    /** Create an MCP3208 object.
+     *
+     * @param bus An SPI bus object.
+     * @param cs The name of a pin to use as the chip select.
+     */
+    MCP3208(SPI bus, PinName cs);
+    ~MCP3208();
+    
+    /** Read from a single-ended input.
+     *
+     * @param channel The channel number to read from.
+     *
+     * @param returns The sampled value as a float between 0.0 and 1.0.
+     */
+    float read_input(int channel);
+    
+    /** Read from a pair of differential inputs.
+     *
+     * In differential mode, the channels are referred to as 0 to 3, with
+     * polarity set in a separate parameter. This avoids the user having to set
+     * the polarity as part of the channel number or having channel numbers
+     * increase by two (i.e. the channels being 0, 2, 4, and 6).
+     *
+     * @param channel The channel number to read from.
+     * @param polarity The polarity of the differential signal.
+     *
+     * @param returns The sampled value as a float between 0.0 and 1.0.
+     */
+    float read_diff_input(int channel, Polarity polarity);
+  
+private:
+    DigitalOut m_cs;
+    SPI m_bus;
+    
+    void select();
+    void deselect();
+};
+
+
+#endif