Impeoved some functions implementations in CLCD_program.c. Addes a test file, CLCD_test.c

Author: abdoaboganima

HAL/CLCD/CLCD_config.h

@@ -1,13 +1,13 @@
- /*****************************************************************************
+/**
  * @file CLCD_config.h
  * @author Abdulrahman Aboghanima ([email protected])
  * @brief User configuration for the CLCD
  * @version 0.1
  * @date 2022-01-26
- * 
  * @copyright Copyright (c) 2022
  * 
- ****************************************************************************/
+ */
+
 /**   @addtogroup HAL_drivers
  * @{ @addtogroup CLCD_drivers
  * @{ @addtogroup CLCD_config

HAL/CLCD/CLCD_output.gif

@@ -1,18 +1,25 @@
+/**
+ *
+ * @file       CLCD_private.h
+ * @brief      Contains private Macros to then `CLCD_Module`
+ * @author     Abdulrahman Aboghanima
+ * @date       Fri Mar 11 17:58:49 2022
+ * @copyright  Copyright (c) 2022
+ * @version    0.1
+ *
+ */
+
 #ifndef _CLCD_PRIVATE_H_
 #define _CLCD_PRIVATE_H_
 
 
-
-
 /**
- * @brief USE 4-bit mode LCD
- * 
+ * @brief USE 4-bit mode LCD 
  */
 #define  MODE_4_BIT  1
 
 /**
  * @brief USE 8-bit mode LCD
- * 
  */
 #define	 MODE_8_BIT  2
 

HAL/CLCD/CLCD_private.h

@@ -2,15 +2,16 @@
  * @file CLCD_program.c
  * @author Abdulrahman Aboghanima ([email protected])
  * @brief The implementations of the CLCD_drivers
- * @version 0.1
+ * @version 0.2
  * @copyright Copyright (c) 2022
  */
 #include "../../LIB/STD_TYPES.h"
 #include "../../LIB/BIT_MATH.h"
-#include "CLCD_interface.h"
-#include "CLCD_config.h" 
 #include "CLCD_private.h"
+#include "CLCD_config.h" 
+#include "CLCD_interface.h"
 #include <util/delay.h>
+
 static inline void setEnableForSomeTime()
 {
   DIO_SetPinValue(CLCD_CTRL_PORT, CLCD_EN_PIN, DIO_PIN_HIGH);
@@ -59,7 +60,7 @@ static inline void CLCD_SendData(const uint8_t Data)
 }
 void CLCD_Clear(void)
 {
-  CLCD_SendCommand(0b00000001);
+  CLCD_SendCommand(0b00000010);
 }
 void CLCD_Blink(void)
 {
@@ -105,31 +106,19 @@ void CLCD_Init(void)
 
 void CLCD_SendString(const char *string)
 {
-  uint8_t i=0;
-  while(string[i]!='\0')
-    CLCD_SendData(string[i++]);
-    
+  while(*string!='\0') CLCD_SendData(*string++);
 }
 
 void CLCD_GoTOXY(const uint8_t XPos, const uint8_t YPos)
 {
-  uint8_t localAddress=0;
-  if(XPos==0){
-    /* location is in the first line */
-    localAddress=YPos;
-  }
-  else if(XPos==1){
-    /* location is in the second line */
-    localAddress=YPos+0x40;
-  }
   /* Set bit number 7 for Setting DDRAM Address command then send the command */
-  CLCD_SendCommand(0x80|localAddress);
+  /* If the XPos==0, it's the first line, else it is the second*/
+  CLCD_SendCommand(0x80|( XPos ? YPos+0x40 : YPos));
 }
 
 void CLCD_SendSpecialChar(const uint8_t *charArray, const uint8_t charIndex, const uint8_t XPos, const uint8_t YPos)
 {
-  /* Command for writing on the CGRAM*/
-  CLCD_SendCommand(charIndex*8 | 0x40);
+  CLCD_SendCommand(charIndex*8 | 0x40); /* Command for writing on the CGRAM*/
 
   /*
    * The Data now is going to be sent in the CGRAM 

HAL/CLCD/CLCD_program.c

@@ -0,0 +1,47 @@
+/*
+ * main.c
+ *
+ *  Created on: Aug 21, 2021
+ *      Author: Abdulrahman Aboghanima
+ */
+#include "../../LIB/STD_TYPES.h"
+#include "../../HAL/CLCD/CLCD_interface.h"
+#include "../../MCAL/DIO/DIO_interface.h"
+#include <util/delay.h>
+
+int main(void){
+
+  const uint8_t customChar[][8] = {
+				   {0x00, 0x00, 0x07, 0x14, 0x1F, 0x00, 0x10, 0x00},
+				   {0x00, 0x00, 0x04, 0x04, 0x1F, 0x00, 0x00, 0x00},
+				   {0x06, 0x06, 0x06, 0x06, 0x1E, 0x00, 0x00, 0x00},
+				   {0x00, 0x00, 0x00, 0x01, 0x01, 0x02, 0x04, 0x08},
+				   {0x00, 0x0C, 0x02, 0x01, 0x1F, 0x00, 0x00, 0x00},
+				   {0x00, 0x00, 0x0E, 0x0A, 0x1F, 0x00, 0x00, 0x00},
+				   {0x00, 0x00, 0x04, 0x11, 0x11, 0x11, 0x0E, 0x00}
+  };
+  
+  CLCD_Init();
+
+  for(uint8_t i=0; i<7; i++)
+    CLCD_SendSpecialChar(customChar[i], i, 0, 12-i);
+  
+  CLCD_GoTOXY(1, 6);
+  CLCD_SendString(utoa(1234, 10));
+
+  while(1){
+
+    CLCD_Init();
+    CLCD_GoTOXY(0, 0);
+    CLCD_SendString("Welcome to Repo");
+    _delay_ms(100);
+    CLCD_Init();
+    CLCD_GoTOXY(1, 1);
+    CLCD_SendString("Welcome to Repo");
+    _delay_ms(100);
+    
+  }
+
+  return 0;
+
+}

HAL/CLCD/CLCD_test.c

@@ -0,0 +1,8 @@
+# CLCD, Character Liquid Crystal Display, module.
+
+A driver with simple functions to interface with the *LCD*.
+
+(**NOTE**: *It has been tested on the 16x2 display only.*)
+
+
+![Simulation of the CLCD](./CLCD_output.gif)