Changeset 138

Timestamp:

02/08/08 22:48:47 (11 months ago)

Author:

mlalondesvn

Message:

MODIF - More commenting and headers

Location:

HDQ

Files:

• hdq.cpp (modified) (2 diffs)
• hdq.h (modified) (2 diffs)

HDQ/hdq.cpp

@@ +1 @@
+/**
+ * Texas Instruments HDQ implementation for the Arduino API
+ * (cleft) Matthieu Lalonde 2008 (matth@mlalonde.net)
+ * Creative Commons BY-SA-NC
+ * 
+ * http://trac.mlalonde.net/cral/browser/HDQ/
+ * 
+ * Revision 1
+ *
+**/
+
+/* ***************** *
+ * HDQ Usage example *
+** ***************** *
+
+#include "hdq.h"
+HDQ HDQ(HDQ_DEFAULT_PIN);
+
+uint8_t r;
+
+for (uint8_t jj = 0; jj < 0x10; jj++) {
+    r = HDQ.read(jj);
+
+    Serial.print("Register 0x");
+    Serial.print(jj, HEX);
+    Serial.print(": ");
+    Serial.print(r, BIN);
+    Serial.print(" 0x");
+    Serial.println(r, HEX);
+}
+
+r = HDQ.read(0x1e);
+
+Serial.print("Register 0x1e: ");
+Serial.print(r, BIN);
+Serial.print(" 0x");
+Serial.println(r, HEX);
+
+r = HDQ.read(0x7e);
+
+Serial.print("Register 0x7e: ");
+Serial.print(r, BIN);
+Serial.print(" 0x");
+Serial.println(r, HEX);
+
+HDQ.write(0x05, B11011101);
+
+r = HDQ.read(0x05);
+
+Serial.print("Register 0x05: ");
+Serial.print(r, BIN);
+Serial.print(" 0x");
+Serial.println(r, HEX);
+
+HDQ.write(0x05, B00111001);
+
+r = HDQ.read(0x05);
+
+Serial.print("Register 0x05: ");
+Serial.print(r, BIN);
+Serial.print(" 0x");
+Serial.println(r, HEX);
+
+*/
+
 extern "C" {
     #include "WConstants.h"
@@ -7 +72 @@
 #include "hdq.h"
 
-#define _HDQ_readPin() (*inputReg & bitmask)>>pin /* Change me to inline!*/
+#define _HDQ_readPin() (*inputReg & bitmask)>>pin   /* Change me to inline!*/
 
 /**
  * Constructor
- * @param pin: pin number to attach to
+ * @param pinArg: pin number to attach to
 **/
 HDQ::HDQ(uint8_t pinArg)

HDQ/hdq.h

@@ +1 @@
+/**
+ * Texas Instruments HDQ implementation for the Arduino API
+ * (cleft) Matthieu Lalonde 2008 (matth@mlalonde.net)
+ * Creative Commons BY-SA-NC
+ * 
+ * http://trac.mlalonde.net/cral/browser/HDQ/
+ * 
+ * Revision 1
+ *
+**/
+
 #ifndef _HDQ_H_
 #define _HDQ_H_
@@ -54 +65 @@
         /**
          * Constructor
-         * @param pin: pin number to attach to
+         * @param pinArg: pin number to attach to
         **/
         HDQ(uint8_t pinArg = HDQ_DEFAULT_PIN);