Initial code for SeeedStudio monochrome GROVE 16x2 LCD

Based on the common class EBF_AiP31068_I2C_16x2_LCD

Author: 4project-co-il

src/Core/EBF_PlugAndPlayDevice.h

@@ -43,6 +43,7 @@ typedef enum : uint32_t {
 	PNP_ID_2INPUT,							// Module with 2 inputs connected directly to interrupt lines
 	PNP_ID_2BUTTONS_INPUT,					// Module with 2 buttons connected directly to interrupt lines
 	PNP_ID_SPARKFUN_QWIIC_SERLCD,			// SparkFun QWIIC SerLCD. Both 2 and 4 rows versions
+	PNP_ID_SEEED_MONOCHROME_GROVE_16x2_LCD,	// SeeedStudio monochrome GROVE 16x2 LCD. Black on Yellow, Black on Red, White on Blue
 } PnP_DeviceId;
 
 // 2 bytes

src/EBF_PlugAndPlay.h

@@ -23,5 +23,6 @@
 #include "PlugAndPlay/PnP_Module_2Input.h"
 #include "PlugAndPlay/PnP_Module_2ButtonsInput.h"
 #include "PlugAndPlay/PnP_Module_SparkFun_QWIIC_SerLCD.h"
+#include "PlugAndPlay/PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD.h"
 
 #endif

src/EBF_Products.h

@@ -17,5 +17,6 @@
 #include "Products/EBF_Servo.h"
 #include "Products/EBF_HC-SR04_DistanceSensor.h"
 #include "Products/EBF_STTS22H_TemperatureSensor.h"
-
+#include "Products/EBF_SparkFun_QWIIC_SerLCD.h"
+#include "Products/EBF_Seeed_Monochrome_GROVE_16x2_LCD.h"
 #endif

src/PlugAndPlay/EEPROMs/EEPROM_Seeed_Monochrome_GROVE_LCD.cpp

@@ -0,0 +1,45 @@
+#include <Arduino.h>
+#include "EBF.h"
+#include "EBF_PlugAndPlay.h"
+#include "EBF_PlugAndPlayManager.h"
+
+// EBF objects creation, should be global
+EBF_Core EBF;
+PnP_StatusLed led;
+
+void setup()
+{
+	uint8_t rc;
+
+	// EBF is the first thing that should be initialized, with the maximum timers to be used
+	EBF.Init();
+
+	// Status LED initialization
+	led.Init();
+
+	// Device EEPROM programming code
+	PnP_DeviceInfo deviceInfo;
+	memset(&deviceInfo, 0, sizeof(PnP_DeviceInfo));
+
+	deviceInfo.headerId = 0x506E502A;	// "PnP*"
+	deviceInfo.version = 1;
+	deviceInfo.deviceIDs[0] = PNP_ID_SEEED_MONOCHROME_GROVE_16x2_LCD;
+	deviceInfo.numberOfEndpoints = 1;
+	deviceInfo.endpointData[0].endpointId = 1;
+	deviceInfo.endpointData[0].i2cAddress = 0x3E;
+	deviceInfo.numberOfInterrupts = 0;
+
+	rc = EBF_PlugAndPlayManager::WriteDeviceEEPROM(0x50 + EBF_PlugAndPlayManager::PNP_EEPROM_DEVICE, deviceInfo);
+	if (rc == EBF_OK) {
+		led.Blink(100, 900);
+	} else {
+		led.Blink(100, 100);
+	}
+}
+
+void loop()
+{
+	// Let EBF to do all the processing
+	// Your logic should be done in the callback functions
+	EBF.Process();
+}

src/PlugAndPlay/PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD.cpp

@@ -0,0 +1,46 @@
+#include "PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD.h"
+
+PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD::PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD() : EBF_Seeed_Monochrome_GROVE_16x2_LCD(NULL)
+{
+	this->type = HAL_Type::PnP_DEVICE;
+	this->id = PnP_DeviceId::PNP_ID_SEEED_MONOCHROME_GROVE_16x2_LCD;
+}
+
+uint8_t PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD::Init()
+{
+	uint8_t rc = EBF_OK;
+	PnP_DeviceInfo deviceInfo;
+	uint8_t endpointIndex;
+	EBF_PlugAndPlayI2C *pPnPI2C;
+	EBF_PlugAndPlayHub *pAssignedHub;
+
+	EBF_PlugAndPlayManager *pPnpManager = EBF_PlugAndPlayManager::GetInstance();
+
+	// Assign the current instance to physical PnP device and get all needed information
+	rc = pPnpManager->AssignDevice(this, deviceInfo, endpointIndex, &pPnPI2C, &pAssignedHub);
+	if(rc != EBF_OK) {
+		return rc;
+	}
+
+	pI2C = pPnPI2C;
+
+	// Initialize the device
+	rc = EBF_Seeed_Monochrome_GROVE_16x2_LCD::Init(deviceInfo.endpointData[endpointIndex].i2cAddress);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	// Fix type and ID after the EBF_Instance init
+	this->type = HAL_Type::PnP_DEVICE;
+	this->id = PnP_DeviceId::PNP_ID_SEEED_MONOCHROME_GROVE_16x2_LCD;
+	// PnP is interrupt driven, no polling is needed. And this is an output-only device.
+	this->pollIntervalMs = EBF_NO_POLLING;
+
+	// Attach interrupt lines for that device
+	rc = pAssignedHub->AssignInterruptLines(pPnPI2C->GetPortNumber(), endpointIndex, deviceInfo);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	return rc;
+}

src/PlugAndPlay/PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD.h

@@ -0,0 +1,24 @@
+#ifndef __PnP_MODULE_SEEED_MONOCHROME_GROVE_16x2_LCD_H__
+#define __PnP_MODULE_SEEED_MONOCHROME_GROVE_16x2_LCD_H__
+
+#include <Arduino.h>
+#if __has_include("EBF_Config.h")
+	#include "EBF_Config.h"
+#endif
+
+#include "../Core/EBF_Global.h"
+#include "../Core/EBF_PlugAndPlayDevice.h"
+#include "../Core/EBF_PlugAndPlayManager.h"
+#include "../Core/EBF_PlugAndPlayI2C.h"
+#include "../Products/EBF_Seeed_Monochrome_GROVE_16x2_LCD.h"
+#include <Wire.h>
+
+class PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD : public EBF_Seeed_Monochrome_GROVE_16x2_LCD {
+	public:
+		PnP_Module_Seeed_Monochrome_GROVE_16x2_LCD();
+
+		uint8_t Init();
+
+};
+
+#endif

src/Products/EBF_AiP31068_I2C_16x2_LCD.cpp

@@ -0,0 +1,257 @@
+#include "EBF_AiP31068_I2C_16x2_LCD.h"
+
+extern void EBF_EmptyCallback();
+
+// Part of the code is based on the Grove_LCD_RGB_Backlight
+// https://github.com/Seeed-Studio/Grove_LCD_RGB_Backlight
+
+// Initializing EBF_AiP31068_I2C_16x2_LCD class instance.
+// The i2cAddress should specify the device I2C address (0x3E default)
+uint8_t EBF_AiP31068_I2C_16x2_LCD::Init(uint8_t i2cAddress)
+{
+	uint8_t rc;
+
+	this->i2cAddress = i2cAddress;
+
+	rc = EBF_HalInstance::Init(HAL_Type::I2C_INTERFACE, i2cAddress);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	// This is output only device, polling is not needed
+	SetPollingInterval(EBF_NO_POLLING);
+
+	displayControl = 0;
+	displayMode = 0;
+
+	// According to datasheet, the LCS needs more than 15mSec after power up. Have to delay
+	delay(20);
+
+	// Initialize the LCD for 2 line move
+	rc = SendCommand(LCD_FUNCTIONSET | LCD_FUNC_2LINE);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+    // Turn the display on with no cursor and no blinking by default
+    displayControl = LCD_DISPLAYON | LCD_CURSOROFF | LCD_BLINKOFF;
+	rc = SendCommand(LCD_DISPLAYCONTROL | displayControl);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	// Clear the display
+	rc = Clear();
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	// LTR direction by default
+    displayMode = LCD_ENTRYLEFT | LCD_ENTRYSHIFTDEC;
+    rc = SendCommand(LCD_ENTRYMODESET | displayMode);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	return EBF_OK;
+}
+
+uint8_t EBF_AiP31068_I2C_16x2_LCD::SendCommand(uint8_t command)
+{
+	uint8_t rc;
+	pI2C->beginTransmission(i2cAddress);
+	pI2C->write(LCD_COMMAND_PREFIX);
+	pI2C->write(command);
+	rc = pI2C->endTransmission();
+
+	if (rc != 0) {
+		return EBF_COMMUNICATION_PROBLEM;
+	}
+
+	return EBF_OK;
+}
+
+// Called to process the instance after pollInterval
+// Nothing to do for output only device
+uint8_t EBF_AiP31068_I2C_16x2_LCD::Process()
+{
+	return EBF_OK;
+}
+
+size_t EBF_AiP31068_I2C_16x2_LCD::write(uint8_t b)
+{
+	uint8_t rc;
+
+	pI2C->beginTransmission(i2cAddress);
+	pI2C->write(LCD_DATA_PREFIX);
+	pI2C->write(b);
+	rc = pI2C->endTransmission();
+
+	if (rc == 0) {
+		return 1;
+	} else {
+		return 0;
+	}
+}
+
+// Clears the display and moves to the first row/col position
+uint8_t EBF_AiP31068_I2C_16x2_LCD::Clear()
+{
+	uint8_t rc;
+
+	rc = SendCommand(LCD_CLEARDISPLAY);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	// TODO: delay() is bad, but looks like there is no other way to do it
+	delayMicroseconds(1500);	// According to datasheet, the HD44780 needs 1.52mSec after clear command
+
+	return EBF_OK;
+}
+
+// Moves to the first row/col position without clearing the display
+uint8_t EBF_AiP31068_I2C_16x2_LCD::Home()
+{
+	uint8_t rc;
+
+	rc = SendCommand(LCD_RETURNHOME);
+	if (rc != EBF_OK) {
+		return rc;
+	}
+
+	// TODO: delay() is bad, but looks like there is no other way to do it
+	delayMicroseconds(1500);	// According to datasheet, the HD44780 needs 1.52mSec after home command
+
+	return EBF_OK;
+}
+
+// Moves the cursor to specified row and column
+uint8_t EBF_AiP31068_I2C_16x2_LCD::SetCursor(uint8_t col, uint8_t row)
+{
+	if (row == 0) {
+		col |= 0x80;
+	} else {
+		col |= 0xC0;
+	}
+
+	return SendCommand(col);
+}
+
+// Turns ON the displayed text
+uint8_t EBF_AiP31068_I2C_16x2_LCD::DisplayOn()
+{
+	displayControl |= LCD_DISPLAYON;
+	return SendCommand(LCD_DISPLAYCONTROL | displayControl);
+}
+
+// Turns OFF the displayed text
+uint8_t EBF_AiP31068_I2C_16x2_LCD::DisplayOff()
+{
+	displayControl &= ~LCD_DISPLAYON;
+	return SendCommand(LCD_DISPLAYCONTROL | displayControl);
+}
+
+// Turns ON the underline cursor
+uint8_t EBF_AiP31068_I2C_16x2_LCD::CursorOn()
+{
+	displayControl |= LCD_CURSORON;
+	return SendCommand(LCD_DISPLAYCONTROL | displayControl);
+}
+
+// Turns OFF the underline cursor
+uint8_t EBF_AiP31068_I2C_16x2_LCD::CursorOff()
+{
+	displayControl &= ~LCD_CURSORON;
+	return SendCommand(LCD_DISPLAYCONTROL | displayControl);
+}
+
+// Enable the blinking cursor
+uint8_t EBF_AiP31068_I2C_16x2_LCD::BlinkOn()
+{
+	displayControl |= LCD_BLINKON;
+	return SendCommand(LCD_DISPLAYCONTROL | displayControl);
+}
+
+// Disable the blinking cursor
+uint8_t EBF_AiP31068_I2C_16x2_LCD::BlinkOff()
+{
+	displayControl &= ~LCD_BLINKON;
+	return SendCommand(LCD_DISPLAYCONTROL | displayControl);
+}
+
+// Scroll the display left by 1 character
+uint8_t EBF_AiP31068_I2C_16x2_LCD::ScrollLeft()
+{
+	return SendCommand(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVELEFT);
+}
+
+// Scroll the display left by specified number of characters
+uint8_t EBF_AiP31068_I2C_16x2_LCD::ScrollLeft(uint8_t count)
+{
+	uint8_t rc;
+
+	for (uint8_t i=0; i<count; i++) {
+		rc = ScrollLeft();
+		if (rc != EBF_OK) {
+			return rc;
+		}
+
+		// Have to wait between the commands
+		delayMicroseconds(50);
+	}
+
+	return EBF_OK;
+}
+
+// Scroll the display right by 1 character
+uint8_t EBF_AiP31068_I2C_16x2_LCD::ScrollRight()
+{
+	return SendCommand(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVERIGHT);
+}
+
+// Scroll the display right by specified number of characters
+uint8_t EBF_AiP31068_I2C_16x2_LCD::ScrollRight(uint8_t count)
+{
+	uint8_t rc;
+
+	for (uint8_t i=0; i<count; i++) {
+		rc = ScrollRight();
+		if (rc != EBF_OK) {
+			return rc;
+		}
+
+		// Have to wait between the commands
+		delayMicroseconds(50);
+	}
+
+	return EBF_OK;
+}
+
+// Changes the direction of text flow to LTR - Left-To-Right
+uint8_t EBF_AiP31068_I2C_16x2_LCD::DirectionLTR()
+{
+	displayMode |= LCD_ENTRYLEFT;
+	return SendCommand(LCD_ENTRYMODESET | displayMode);
+}
+
+// Changes the direction of text flow to RTL - Right-To-Left
+uint8_t EBF_AiP31068_I2C_16x2_LCD::DirectionRTL()
+{
+	displayMode &= ~LCD_ENTRYLEFT;
+	return SendCommand(LCD_ENTRYMODESET | displayMode);
+}
+
+// Enable the autoscroll
+uint8_t EBF_AiP31068_I2C_16x2_LCD::AutoScrollOn()
+{
+	displayMode |= LCD_ENTRYSHIFTINC;
+	return SendCommand(LCD_ENTRYMODESET | displayMode);
+}
+
+// Disable the autoscroll
+uint8_t EBF_AiP31068_I2C_16x2_LCD::AutoScrollOff()
+{
+	displayMode &= ~LCD_ENTRYSHIFTINC;
+	return SendCommand(LCD_ENTRYMODESET | displayMode);
+}