Skip to content

Instantly share code, notes, and snippets.

@bboyho
Created February 7, 2019 21:48
Show Gist options
  • Save bboyho/08ac65745d508175b1de7925498f438b to your computer and use it in GitHub Desktop.
Save bboyho/08ac65745d508175b1de7925498f438b to your computer and use it in GitHub Desktop.
Testing Custom Character code
/*
OpenLCD is an LCD with Serial/I2C/SPI interfaces.
By: Nathan Seidle
SparkFun Electronics
Date: November 12th, 2015
License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license).
OpenLCD gives the user multiple interfaces (serial, I2C, and SPI) to control an LCD. SerLCD was the original
serial LCD from SparkFun that ran on the PIC 16F88 with only a serial interface and limited feature set.
This is an updated serial LCD.
This example shows how to create a custom character on the display.
The smileyface graphic comes from SerLCD page on Arduino.cc: http://playground.arduino.cc/Code/SerLCDcreateChar
Note: Loading custom characters causes the display to clear
OpenLCD records custom characters to EEPROM so you only need to load it
once, the LCD will remember the graphic after that.
We use software serial because if OpenLCD is attached to an Arduino's hardware serial port during bootloading
it can cause problems for both devices.
Note: If OpenLCD gets into an unknown state or you otherwise can't communicate with it send 18 (0x12 or ctrl+r)
at 9600 baud while the splash screen is active and the unit will reset to 9600 baud.
Emergency reset: If you get OpenLCD stuck into an unknown baud rate, unknown I2C address, etc, there is a
safety mechanism built-in. Tie the RX pin to ground and power up OpenLCD. You should see the splash screen
then "System reset Power cycle me" and the backlight will begin to blink. Now power down OpenLCD and remove
the RX/GND jumper. OpenLCD is now reset to 9600bps with a I2C address of 0x72. Note: This feature can be
disabled if necessary. See *Ignore Emergency Reset* for more information.
To get this code to work, attached an OpenLCD to an Arduino Uno using the following pins:
RX (OpenLCD) to Pin 7 (Arduino)
VIN to 5V
GND to GND
Command cheat sheet:
ASCII / DEC / HEX
'|' / 124 / 0x7C - Put into setting mode
Ctrl+c / 3 / 0x03 - Change width to 20
Ctrl+d / 4 / 0x04 - Change width to 16
Ctrl+e / 5 / 0x05 - Change lines to 4
Ctrl+f / 6 / 0x06 - Change lines to 2
Ctrl+g / 7 / 0x07 - Change lines to 1
Ctrl+h / 8 / 0x08 - Software reset of the system
Ctrl+i / 9 / 0x09 - Enable/disable splash screen
Ctrl+j / 10 / 0x0A - Save currently displayed text as splash
Ctrl+k / 11 / 0x0B - Change baud to 2400bps
Ctrl+l / 12 / 0x0C - Change baud to 4800bps
Ctrl+m / 13 / 0x0D - Change baud to 9600bps
Ctrl+n / 14 / 0x0E - Change baud to 14400bps
Ctrl+o / 15 / 0x0F - Change baud to 19200bps
Ctrl+p / 16 / 0x10 - Change baud to 38400bps
Ctrl+q / 17 / 0x11 - Change baud to 57600bps
Ctrl+r / 18 / 0x12 - Change baud to 115200bps
Ctrl+s / 19 / 0x13 - Change baud to 230400bps
Ctrl+t / 20 / 0x14 - Change baud to 460800bps
Ctrl+u / 21 / 0x15 - Change baud to 921600bps
Ctrl+v / 22 / 0x16 - Change baud to 1000000bps
Ctrl+w / 23 / 0x17 - Change baud to 1200bps
Ctrl+x / 24 / 0x18 - Change the contrast. Follow Ctrl+x with number 0 to 255. 120 is default.
Ctrl+y / 25 / 0x19 - Change the TWI address. Follow Ctrl+x with number 0 to 255. 114 (0x72) is default.
Ctrl+z / 26 / 0x1A - Enable/disable ignore RX pin on startup (ignore emergency reset)
'-' / 45 / 0x2D - Clear display. Move cursor to home position.
/ 128-157 / 0x80-0x9D - Set the primary backlight brightness. 128 = Off, 157 = 100%.
/ 158-187 / 0x9E-0xBB - Set the green backlight brightness. 158 = Off, 187 = 100%.
/ 188-217 / 0xBC-0xD9 - Set the blue backlight brightness. 188 = Off, 217 = 100%.
For example, to change the baud rate to 115200 send 124 followed by 18.
'+' / 43 / 0x2B - Set Backlight to RGB value, follow + by 3 numbers 0 to 255, for the r, g and b values.
For example, to change the backlight to yellow send + followed by 255, 255 and 0.
*/
#include <SoftwareSerial.h>
SoftwareSerial OpenLCD(6, 7); //RX (not used), TX
byte smiley[8] = {
B00000,
B10001,
B00000,
B00000,
B10001,
B01110,
B00000,
B00000,
};
byte person[8] = {
B00000,
B01110,
B10001,
B01110,
B11011,
B00100,
B01010,
B10001,
};
byte emptyHeart[8] = {
B00000,
B00000,
B01010,
B10101,
B10001,
B01010,
B00100,
B00000,
};
byte fullHeart[8] = {
B00000,
B00000,
B01010,
B11111,
B11111,
B01110,
B00100,
B00000,
};
byte ShawnHymel_running1[8] = {
// Run position 1
B01100,
B01100,
B00000,
B01110,
B11100,
B01100,
B11010,
B10011,
};
byte ShawnHymel_running2[8] = {
// Run position 2
B01100,
B01100,
B00000,
B01100,
B01100,
B01100,
B01100,
B01110,
};
byte ShawnHymel_jump1[8] = {
// Jump
B01100,
B01100,
B00000,
B11110,
B01101,
B11111,
B10000,
B00000,
};
byte ShawnHymel_jump2[8] = {
// Jump lower
B11110,
B01101,
B11111,
B10000,
B00000,
B00000,
B00000,
B00000,
};
void setup()
{
Serial.begin(9600); //Start serial communication at 9600 for debug statements
Serial.println("OpenLCD Example Code");
OpenLCD.begin(9600); //Begin communication with OpenLCD
//Send the reset command to the display - this forces the cursor to return to the beginning of the display
OpenLCD.write('|'); //Send setting character
OpenLCD.write('-'); //Send clear display character
OpenLCD.print("Test:");
//Load this custom character into locations in CGRAM
loadCustomCharacter(0, smiley);
delay(1000);
loadCustomCharacter(1, person);
delay(1000);
loadCustomCharacter(2, emptyHeart);
delay(1000);
loadCustomCharacter(3, fullHeart);
delay(1000);
loadCustomCharacter(4, ShawnHymel_running1);
delay(1000);
loadCustomCharacter(5, ShawnHymel_running2);
delay(1000);
loadCustomCharacter(6, ShawnHymel_jump1);
delay(1000);
loadCustomCharacter(7, ShawnHymel_jump2);
delay(1000);
//Loading custom characters causes the display to clear
//OpenLCD.print(" Custom2:");
//printCustomChar(2); //Print the custom char in location 2
OpenLCD.write('|'); //Send setting character
OpenLCD.write('-'); //Send clear display character
//OpenLCD.write("ABCDEFGHIJKLMNOP");
//delay(500);
//OpenLCD.write("abcdefghijklmnop");
//delay(500);
for (int x = 0; x < 8; x++)
{
//OpenLCD.print("C:");
//delay(500);
printCustomChar(x);
delay(500);
}
}
int lastReading = 0;
long startTime = 0;
bool settingSent = false;
void loop()
{
//Do nothing
}
//Display a given custom character that was previously loaded into CGRAM
void printCustomChar(byte charNumber)
{
if (charNumber > 7) {
charNumber = 7; //Error correction
}
OpenLCD.write('|'); //Send setting character
OpenLCD.write(35 + charNumber); //Tell LCD to display custom char # 0-7
}
//Given a character number (0 to 7 is valid)
//Given an 8 byte array
//Record this data as a custom character to CGRAM
void loadCustomCharacter(byte charNumber, byte charData[])
{
if (charNumber > 7) {
charNumber = 7; //Error correction
}
OpenLCD.write('|'); //Send setting character
OpenLCD.write(27 + charNumber); //27 is the first custom character spot
for (byte x = 0 ; x < 8 ; x++) { //There are 8 bytes of data we need to load
OpenLCD.write(charData[x]); //Write 8 bytes of graphic data to display
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment