added libraries

source/libraries/INPUT_74HC4051/INPUT_74HC4051.h

@@ -1,31 +1,63 @@
-/*
+/**
-	INPUT_72HC4051.h - Library for reading inputs from 74HC4051 multiplexer
+ * @file INPUT_74HC4051.h
-
+ * 
-	library is for specialiced use: all I/O ports are used as analog inputs, values are stored and a callback function is called, when a value changes
+ * @author Lukas Haubaum (lukas@haubaum.de)
-  
+ * 
-*/
+ * @date February, 2013
+ * 
+ * @brief arduino library for reading inputs from 74HC4051 multiplexer
+ * 
+ * library is for specialiced use: all I/O ports are used as analog inputs, values are stored and a callback function is called, when a value changes
+ * 	
+ * */
 #ifndef INPUT_74HC4051_h
 #define INPUT_74HC4051_h
 
-#define INPUT_74HC4051_TOLERANCE 1
+
+#define INPUT_74HC4051_TOLERANCE 1 /**< I/O DIRECTION REGISTER PORT A - Controls the direction of the data I/O. */
 
 #if !defined(CallbackFunction)
+/**
+ * callback function
+ * 
+ * @param address
+ * @param pin
+ * @param value
+ */
 typedef void (*CallbackFunction)(int,int,int);
 #endif
 
 class INPUT_74HC4051
 {
-	public:
+	public:		
-		void begin(uint8_t analog, uint8_t s0, uint8_t s1, uint8_t s2,CallbackFunction cbF);
+		/**
-		void loop(void);
+		 * initalize the class, should be called in setup() function
+		 * 
+		 * @param analog input pin on arduino, connected Z pin here
+		 * @param digital output pin for S0
+		 * @param digital output pin for S0
+		 * @param digital output pin for S0
+		 * @param callback function
+		 */
+		void begin(uint8_t analog, uint8_t s0, uint8_t s1, uint8_t s2,CallbackFunction cbF);		
+		/**
+		 * read values and call callback function on change, should be called in loop()
+		 */
+		void loop(void);		
+		/**
+		 * get value of specific pin (0-7)
+		 * 
+		 * @param pin
+		 * @return value of pin
+		 */
 		int getSpecificValue(uint8_t pin);
 	private:
-		uint8_t _analog;
+		uint8_t _analog; /**< analog input pin on arduino, connected Z pin here */ 
-		uint8_t _s0;
+		uint8_t _s0; /**< digital output pin for S0 */ 
-		uint8_t _s1;
+		uint8_t _s1; /**< digital output pin for S0 */ 
-		uint8_t _s2;
+		uint8_t _s2; /**< digital output pin for S0 */ 
-		int _value[8];
+		int _value[8]; /**< read values */ 
-		CallbackFunction _callbackFunction;
+		CallbackFunction _callbackFunction; /**< callback function */ 
 };
 
 

source/libraries/INPUT_MCP23017/INPUT_MCP23017.cpp

@@ -6,6 +6,7 @@
 void INPUT_MCP23017::begin(uint8_t addr,CallbackFunction cbF) {
 	Wire.begin();
 	
+	//check hardware address
 	if (addr > 7)
 		_addr = 7;
 	else _addr =  addr;
@@ -14,35 +15,35 @@ void INPUT_MCP23017::begin(uint8_t addr,CallbackFunction cbF) {
 		
 	//set all ports as inputs
 	Wire.beginTransmission(MCP23017_ADDRESS | _addr);
-	Wire.write((byte)MCP23017_IODIRA);
+	Wire.write((byte)MCP23017_IODIRA); //PORT A
-	Wire.write(0xFF);  // all inputs on port A
+	Wire.write(0xFF);
 	Wire.endTransmission();
 
 	Wire.beginTransmission(MCP23017_ADDRESS | _addr);
-	Wire.write(MCP23017_IODIRB);
+	Wire.write(MCP23017_IODIRB); //PORT B
-	Wire.write(0xFF);  // all inputs on port B
+	Wire.write(0xFF);
 	Wire.endTransmission();
 	
 	//activate pullup resistors
 	Wire.beginTransmission(MCP23017_ADDRESS | _addr);
-	Wire.write(MCP23017_GPPUA); 
+	Wire.write(MCP23017_GPPUA); //PORT A
-	Wire.write(0xFF);	// all pullup resistors on port A
+	Wire.write(0xFF);
 	Wire.endTransmission();
 	
 	Wire.beginTransmission(MCP23017_ADDRESS | _addr);
-	Wire.write(MCP23017_GPPUB); 
+	Wire.write(MCP23017_GPPUB); //PORT B 
-	Wire.write(0xFF);	// all pullup resistors on port B
+	Wire.write(0xFF); 
 	Wire.endTransmission();
 
 	//inverse all inputs
 	Wire.beginTransmission(MCP23017_ADDRESS | _addr);
-	Wire.write((byte)MCP23017_IPOLA);
+	Wire.write((byte)MCP23017_IPOLA); //PORT A
-	Wire.write(0xFF);  // inverse all inputs
+	Wire.write(0xFF); 
 	Wire.endTransmission();
 
 	Wire.beginTransmission(MCP23017_ADDRESS | _addr);
-	Wire.write(MCP23017_IPOLB);
+	Wire.write(MCP23017_IPOLB);  //PORT B
-	Wire.write(0xFF);    // inverse all inputs
+	Wire.write(0xFF);    
 	Wire.endTransmission();
 
 	//init start values

source/libraries/INPUT_MCP23017/INPUT_MCP23017.h

@@ -1,55 +1,88 @@
-/*
+/**
-	INPUT_MCP23017.h - Library for reading inputs from MCP23017 port Expander
+ * @file INPUT_MCP23017.h
-
+ * 
-	library is for specialiced use: all I/O ports are used as digital inputs with internal pullup resistor active, values are stored and a callback function is called, when a value changes
+ * @author Lukas Haubaum (lukas@haubaum.de)
-  
+ * 
-*/
+ * @date February, 2013
-*/
+ * 
+ * @brief arduino library for reading inputs from MCP23017 port Expander
+ * 
+ * library is for specialiced use: all I/O ports are used as digital inputs with internal pullup resistor active, values are stored and a callback function is called, when a value changes
+ * 	
+ * */
 #ifndef INPUT_MCP23017_h
 #define INPUT_MCP23017_h
 
 #if !defined(CallbackFunction)
+/**
+ * callback function
+ * 
+ * @param address
+ * @param pin
+ * @param value
+ */
 typedef void (*CallbackFunction)(int,int,int);
 #endif
 
 class INPUT_MCP23017
 {
 	public:
-		void begin(uint8_t addr,CallbackFunction cbF);
+		/**
-		void loop(void);
+		 * initalize the class, should be called in setup() function
+		 * 
+		 * @param hardware address (0-7)
+		 * @param callback function
+		 */
+		void begin(uint8_t addr,CallbackFunction cbF);		
+		/**
+		 * read values and call callback function on change, should be called in loop()
+		 */
+		void loop(void);		
+		/**
+		 * get value of specific pin (0-15)
+		 * 
+		 * @param pin
+		 * @return value of pin
+		 */
 		int getSpecificValue(uint8_t pin);
 	private:
-		uint8_t _addr;
+		uint8_t _addr; /**< hardware address (0-7) */ 
-		int _value[16];
+		int _value[16]; /**< read values */ 
-		CallbackFunction _callbackFunction;
+		CallbackFunction _callbackFunction; /**< callback function */ 
 };
 
-#define MCP23017_ADDRESS 0x20
+#define MCP23017_ADDRESS 0x20 /**< hardware address */
 
-// registers (from https://github.com/adafruit/Adafruit-MCP23017-Arduino-Library/blob/master/Adafruit_MCP23017.h)
+/**
-#define MCP23017_IODIRA 0x00
+ * registers of MCP23017 (BANK = 0)
-#define MCP23017_IPOLA 0x02
+ * 
-#define MCP23017_GPINTENA 0x04
+ * default is 0 except for I/O DIRECTION REGISTERS
-#define MCP23017_DEFVALA 0x06
+ * 
-#define MCP23017_INTCONA 0x08
+ * for detailed description see http://ww1.microchip.com/downloads/en/DeviceDoc/21952b.pdf
-#define MCP23017_IOCONA 0x0A
+ * 
-#define MCP23017_GPPUA 0x0C
+ * */
-#define MCP23017_INTFA 0x0E
+#define MCP23017_IODIR_A 0x00 		/**< I/O DIRECTION REGISTER PORT A - Controls the direction of the data I/O. */
-#define MCP23017_INTCAPA 0x10
+#define MCP23017_IODIR_B 0x01 		/**< I/O DIRECTION REGISTER PORT B - Controls the direction of the data I/O. */
-#define MCP23017_GPIOA 0x12
+#define MCP23017_IPOL_A 0x02 		/**<  INPUT POLARITY REGISTER PORT A - This register allows the user to configure the polarity on the corresponding GPIO port bits. */
-#define MCP23017_OLATA 0x14
+#define MCP23017_IPOL_B 0x03 		/**< INPUT POLARITY REGISTER PORT B - This register allows the user to configure the polarity on the corresponding GPIO port bits. */
-
+#define MCP23017_GPINTEN_A 0x04 	/**< INTERRUPT-ON-CHANGE CONTROL REGISTER PORT A - The GPINTEN register controls the interrupt-on-change feature for each pin. */
-#define MCP23017_IODIRB 0x01
+#define MCP23017_GPINTEN_B 0x05 	/**< INTERRUPT-ON-CHANGE CONTROL REGISTER PORT B - The GPINTEN register controls the interrupt-on-change feature for each pin. */
-#define MCP23017_IPOLB 0x03
+#define MCP23017_DEFVAL_A 0x06 		/**< DEFAULT COMPARE REGISTER FOR INTERRUPT-ON-CHANGE PORT A - The default comparison value is configured in the DEFVAL register. */
-#define MCP23017_GPINTENB 0x05
+#define MCP23017_DEFVAL_B 0x07 		/**< DEFAULT COMPARE REGISTER FOR INTERRUPT-ON-CHANGE PORT B - The default comparison value is configured in the DEFVAL register.. */
-#define MCP23017_DEFVALB 0x07
+#define MCP23017_INTCON_A 0x08 		/**< INTERRUPT CONTROL REGISTER PORT A - The INTCON register controls how the associated pin value is compared for the interrupt-on-change feature. */
-#define MCP23017_INTCONB 0x09
+#define MCP23017_INTCON_B 0x09 		/**< INTERRUPT CONTROL REGISTER PORT B - The INTCON register controls how the associated pin value is compared for the interrupt-on-change feature.*/
-#define MCP23017_IOCONB 0x0B
+#define MCP23017_IOCON_A 0x0A 		/**<  CONFIGURATION REGISTER - The IOCON register contains several bits for configuring the device. BANK/MIRROR/SEQOP/DISSLW/HAEN/ODR/INTPOL/— */
-#define MCP23017_GPPUB 0x0D
+#define MCP23017_IOCON_B 0x0B 		/**<  CONFIGURATION REGISTER - The IOCON register contains several bits for configuring the device. BANK/MIRROR/SEQOP/DISSLW/HAEN/ODR/INTPOL/— */
-#define MCP23017_INTFB 0x0F
+#define MCP23017_GPPU_A 0x0C 		/**< PULL-UP RESISTOR CONFIGURATION REGISTER PORT A - The GPPU register controls the pull-up resistors for the port pins. */
-#define MCP23017_INTCAPB 0x11
+#define MCP23017_GPPU_B 0x0D 		/**< PULL-UP RESISTOR CONFIGURATION REGISTER PORT B - The GPPU register controls the pull-up resistors for the port pins. */
-#define MCP23017_GPIOB 0x13
+#define MCP23017_INTF_A 0x0E 		/**< INTERRUPT FLAG REGISTER PORT A - The INTF register reflects the interrupt condition on the port pins of any pin that is enabled for interrupts via the GPINTEN register. */
-#define MCP23017_OLATB 0x15
+#define MCP23017_INTF_B 0x0F 		/**< INTERRUPT FLAG REGISTER PORT B - The INTF register reflects the interrupt condition on the port pins of any pin that is enabled for interrupts via the GPINTEN register. */
+#define MCP23017_INTCAP_A 0x10 		/**< INTERRUPT CAPTURE REGISTER PORT A - The INTCAP register captures the GPIO port value at the time the interrupt occurred. */
+#define MCP23017_INTCAP_B 0x11 		/**< INTERRUPT CAPTURE REGISTER PORT B - The INTCAP register captures the GPIO port value at the time the interrupt occurred. */
+#define MCP23017_GPIO_A 0x12  		/**< PORT REGISTER PORT A - The GPIO register reflects the value on the port. */
+#define MCP23017_GPIO_B 0x13 		/**< PORT REGISTER PORT B - The GPIO register reflects the value on the port. */
+#define MCP23017_OLAT_A 0x14 		/**< OUTPUT LATCH REGISTER PORT A - The OLAT register provides access to the output latches. */
+#define MCP23017_OLAT_B 0x15 		/**< OUTPUT LATCH REGISTER PORT B - The OLAT register provides access to the output latches. */
 
 
 #endif