Thomas Morris / Mbed OS PROJ324_Final

Fork of ELEC351_Group_T by Plymouth ELEC351 Group T

Revision:
51:47f5db68500b
Parent:
48:244d6d81bb52
Child:
52:99915f5240b2
--- a/LCD.hpp	Tue Jan 09 12:19:12 2018 +0000
+++ b/LCD.hpp	Tue Jan 09 15:15:08 2018 +0000
@@ -1,3 +1,11 @@
+/*
+This is our LCD driver Class
+It enables us to write to any given LCD by passing in parameters
+Then calling functions to display to information to the LCD
+*/
+
+
+
 #ifndef _LCD_HPP_ //Known as header guards
 #define _LCD_HPP_
 
@@ -10,9 +18,9 @@
     
 public: 
  
-    LCD(PinName E, PinName RS, PinName RW, PinName DB0, PinName DB1, PinName DB2, PinName DB3, PinName DB4, PinName DB5, PinName DB6, PinName DB7);
-    ~LCD();
-    void clock_in();
+    LCD(PinName E, PinName RS, PinName RW, PinName DB0, PinName DB1, PinName DB2, PinName DB3, PinName DB4, PinName DB5, PinName DB6, PinName DB7);//Constructor
+    ~LCD();                                                                                                                                        //Destructor
+    void clock_in();                                                                                                                               //Waits for 
     void Function_Set();
     void Display_Off();
     void Display_Clear();
@@ -23,11 +31,11 @@
     void Initialise();
     
 private:    
- 
+    //Private member variables to prevent them being accessed externally 
     DigitalOut _E;
     DigitalOut _RS;
     DigitalOut _RW;
-    
+    //Data Pins
     DigitalOut _DB0;
     DigitalOut _DB1;
     DigitalOut _DB2;
@@ -36,7 +44,6 @@
     DigitalOut _DB5;
     DigitalOut _DB6;
     DigitalOut _DB7;
-    
 };