Benjamin Ramberg Møklegård / ShiftOut Featured

A library for interfacing with the SN74HC595N Shift register. Includes functions for writing bits, bytes, animation and bits at spesified positions.

Diff: ShiftOut.h

Revision:
3:a0df8989ffa2
Parent:
2:88581826b53c
Child:
4:61198ffab8ca
--- a/ShiftOut.h	Fri Dec 25 12:11:20 2015 +0000
+++ b/ShiftOut.h	Fri Dec 25 21:40:48 2015 +0000
@@ -34,8 +34,8 @@
 void writeByte(unsigned char);
 
 /**
-  * @param: 0xXX or numbers from 0-255
-  * @note Writes a byte to the shift register
+  * @param  0xXX or numbers from 0-255
+  * @note  Writes a byte to the shift register
 */
 
 
@@ -46,8 +46,8 @@
 
 
 /**
-  * @param: 0 or 1
-  * @note Writes a bit to the first output on the shift register
+  * @param  0 or 1
+  * @note  Writes a bit to the first output on the shift register
 */
 
 
@@ -58,8 +58,8 @@
 void animate(int[][8], int, int);
 
 /**
- *  @param: int array
- * @note Writes bits from an 2D array, with configurable delay
+ *  @param  int array
+ *  @note  Writes bits from an 2D array, with configurable delay
 */
 
 /**
@@ -67,7 +67,7 @@
 void animationExample(void);
 
 /**
- *  @note Shows two animation examples 
+ *  @note  Shows two animation examples 
 */
 
 /**
@@ -76,8 +76,8 @@
 void writeBitAtPos(unsigned char, bool);
 
 /**
- *  @param: output, state
- *  Writes to the desired state to the output on the shift register
+ *  @param  output, state
+ *  @note  Writes to the desired state to the output on the shift register
 */
 
 /**
@@ -86,13 +86,14 @@
 void writeArray(char[8]);
 
 /**
- *   @param: char array
- *  Writes the corresponding array item to the output on the shift register
+ *   @param  char array
+ *   @note  Writes the corresponding array item to the output on the shift register
 */
 
 protected:
 void updateRegister(void);
 void updateOutput(void);
+void clearStateArray(void);
 DigitalOut DSERIAL, LATCH, RCLK, SRCLK, RESET; 
 
 };