Difference between revisions of "Matrix - I2C LCD1602"

From FriendlyELEC WiKi
Jump to: navigation, search
(Hardware Connection)
(Update Log)
 
(7 intermediate revisions by the same user not shown)
Line 13: Line 13:
 
* IIC Module PCB dimension(mm): 16 x 42  
 
* IIC Module PCB dimension(mm): 16 x 42  
 
* LCD1602 PCB dimension (mm): 36 x 80
 
* LCD1602 PCB dimension (mm): 36 x 80
[[File:lpdpcb.png|frameless|400px|IIC模块PCB]]
+
[[File:lpdpcb.png|frameless|400px|IIC Module PCB]]
 
[[File:lcdpcb.png|frameless|400px|LCD1602 PCB]]
 
[[File:lcdpcb.png|frameless|400px|LCD1602 PCB]]
  
Line 46: Line 46:
 
* Note: the LCD module has 192 most commonly used characters stored in CGROM. When we write a common character e.g "A" it will directly display "A". In addition it can store up to eight user defined characters in RAM called CGRAM.
 
* Note: the LCD module has 192 most commonly used characters stored in CGROM. When we write a common character e.g "A" it will directly display "A". In addition it can store up to eight user defined characters in RAM called CGRAM.
  
 +
==Applications==
 +
===Connect to NanoPi M1===
 +
Refer to the following connection diagram to connect the module to the NanoPi M1:<br>
 +
[[File:Matrix-I2C_LCD1602_nanopi_m1.jpg|frameless|600px|Matrix-I2C_LCD1602_nanopi_m1]]
 +
 +
Connection Details
 +
{| class="wikitable"
 +
|-
 +
|Matrix-I2C_LCD1602 || NanoPi M1   
 +
|-
 +
|SDA    || Pin3
 +
|-
 +
|SCL    || Pin5
 +
|-
 +
|5V    || Pin4
 +
|-
 +
|GND    || Pin6
 +
|}
 +
 +
===Connect to NanoPi 2===
 +
Refer to the following connection diagram to connect the module to the NanoPi 2:<br>
 +
[[File:Matrix-I2C_LCD1602_nanopi_2.jpg|frameless|600px|Matrix-I2C_LCD1602_nanopi_2]]
 +
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-I2C_LCD1602 || NanoPi 2   
 +
|-
 +
|SDA    || Pin3
 +
|-
 +
|SCL    || Pin5
 +
|-
 +
|5V    || Pin4
 +
|-
 +
|GND    || Pin6
 +
|}
 +
 +
===Connect to NanoPi M2 / NanoPi 2 Fire===
 +
Refer to the following connection diagram to connect the module to the NanoPi M2/ NanoPi 2 Fire.<br>
 +
[[File:Matrix-I2C_LCD1602_nanopi_m2.jpg|frameless|600px|Matrix-I2C_LCD1602_nanopi_m2]]
 +
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-I2C_LCD1602 || NanoPi M2
 +
|-
 +
|SDA    || Pin3
 +
|-
 +
|SCL    || Pin5
 +
|-
 +
|5V    || Pin4
 +
|-
 +
|GND    || Pin6
 +
|}
 +
 +
===Connect to NanoPC-T2===
 +
Refer to the following connection diagram to connect the module to the NanoPC-T2:<br>
 +
[[File:Matrix-I2C_LCD1602_NanoPC-T2.jpg|frameless|600px|Matrix-I2C_LCD1602_NanoPC-T2]]
 +
 +
Connection Details:
 +
{| class="wikitable"
 +
|-
 +
|Matrix-I2C_LCD1602 || NanoPC-T2
 +
|-
 +
|SDA    || Pin6
 +
|-
 +
|SCL    || Pin5
 +
|-
 +
|5V    || Pin29
 +
|-
 +
|GND    || Pin30
 +
|}
 +
 +
==Compile & Run Test Program==
 +
Boot your ARM board with Debian and copy the matrix code:
 +
<syntaxhighlight lang="bash">
 +
$ apt-get update && apt-get install git
 +
$ git clone https://github.com/friendlyarm/matrix.git
 +
</syntaxhighlight>
 +
If your cloning is done successfully a "matrix" directory will be generated.
 +
 +
Compile and install Matrix:
 +
<syntaxhighlight lang="bash">
 +
$ cd matrix
 +
$ make && make install
 +
</syntaxhighlight>
 +
 +
Run test program:
 +
<syntaxhighlight lang="bash">
 +
$ matrix-lcd1602
 +
</syntaxhighlight>
 +
Note: this module is not plug and play therefore before running the module please make sure it is connected to an ARM board.<br>
 +
Here is what you should observe:<br>
 +
[[File:matrix-lcd1602_result.png|frameless|600px|matrix-lcd1602_result]] <br>
 +
The LCD will show the following two lines:<br>
 +
"  B&G Char LCD"    <br>
 +
"--by FriendlyARM" <br>
 +
If the LCD doesn't show them clearly you can adjust the resistor to highlight the characters.
 +
 +
==Code Sample==
 +
This Matrix code sample can work with all the ARM boards mentioned in this module's wiki. The name of this code sample is "matrix-i2c_lcd1602". Here is its source code:
 +
<syntaxhighlight lang="c">
 +
int main(int argc, char ** argv)
 +
{
 +
    int devFD, board;
 +
    int i2cDev = 0;
 +
   
 +
    if ((board = boardInit()) < 0) {
 +
        printf("Fail to init board\n");
 +
        return -1;
 +
    }
 +
   
 +
    if (argc == 2)
 +
        i2cDev = atoi(argv[1]);
 +
    if ((devFD = LCD1602Init(i2cDev)) == -1) {
 +
        printf("Fail to init LCD1602\n");
 +
        return -1;
 +
    }
 +
    if (LCD1602Clear(devFD) == -1) {
 +
        printf("Fail to Clear\n");
 +
    }
 +
    printf("clearing LCD1602\n");
 +
    sleep(1);
 +
    if (LCD1602DispLines(devFD, "  B&G Char LCD", "--by FriendlyARM") == -1) {
 +
        printf("Fail to Display String\n");
 +
    }
 +
    printf("displaying LCD1602\n");
 +
    LCD1602DeInit(devFD);
 +
    return 0;
 +
}
 +
</syntaxhighlight>
 +
For more details about this APIs called in this code sample refer to [[Matrix API reference manual]] <br>
 +
 +
==Connect to Arduino Board==
 +
===Preparations===
 +
Make sure your Arduino board can work. Here is a reference link - https://www.arduino.cc/en/Guide/HomePage <br>
 +
Here we tried the Arduino Uno.
 +
 +
===Hardware Connection===
 +
Refer to the following diagram to connect the Matrix-I2C_LCD1602 to an Arduino Uno<br>
 +
[[File:matrix-i2c_lcd1602_arduino.jpg|frameless|600px|matrix-i2c_lcd1602_arduino]]
 +
 +
===Compile & Run Test Program===
 +
All the matrix modules' code samples for Arduino are maintained on GitHub - https://github.com/friendlyarm/matrix-arduino.git <br>
 +
Clone the matrix code from GitHub
 +
<syntaxhighlight lang="bash">
 +
$ git clone git://github.com/friendlyarm/matrix-arduino.git
 +
</syntaxhighlight>
 +
If this is successful a "matrix-arduino" directory will be generated, which will contain all the matrix modules' code samples.
 +
 +
Copy the entire directory "matrix-i2c_lcd1602" to "Arduino_IDE/libraries"
 +
<syntaxhighlight lang="bash">
 +
$ cd matrix-arduino
 +
$ cp matrix-i2c_lcd1602 Arduino_IDE/libraies -r
 +
</syntaxhighlight>
 +
 +
Start Arduino IDE <br>
 +
Click on File->Examples->matrix-i2c_lcd1602->displaychar and run the test program.<br>
 +
Click on upload and run the test program.<br>
 +
 +
===Code Sample===
 +
<syntaxhighlight lang="c">
 +
#include <Wire.h>
 +
#include <LiquidCrystal_I2C.h>
 +
 +
// set the LCD address to 0x27 for a 16 chars and 2 line display
 +
LiquidCrystal_I2C lcd(0x27,16,2); 
 +
 +
void setup()
 +
{
 +
  lcd.init();                       
 +
  lcd.backlight();
 +
  lcd.setCursor(2, 0);
 +
  lcd.print("B&G Char LCD");
 +
  lcd.setCursor(0, 1);
 +
  lcd.println("--by FriendlyARM");
 +
}
 +
 +
void loop()
 +
{
 +
}
 +
</syntaxhighlight>
 +
 +
<!---
 
==Download Matrix Source Code==
 
==Download Matrix Source Code==
 
All the matrix modules' code samples are open source. They are maintained on GitHub - https://github.com/friendlyarm/matrix.git <br>
 
All the matrix modules' code samples are open source. They are maintained on GitHub - https://github.com/friendlyarm/matrix.git <br>
Line 84: Line 268:
 
|}
 
|}
  
===编译测试程序===
+
===Compile Test Program===
进入Matrix代码仓库,切换到nanopi2分支
+
Please login the matrix hub and enter the nanopi2 branch
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ cd matrix
 
$ cd matrix
Line 91: Line 275:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
编译Matrix配件代码
+
Compile the matrix code
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ make CROSS_COMPILE=arm-linux- clean
 
$ make CROSS_COMPILE=arm-linux- clean
Line 97: Line 281:
 
$ make CROSS_COMPILE=arm-linux- install
 
$ make CROSS_COMPILE=arm-linux- install
 
</syntaxhighlight>
 
</syntaxhighlight>
注意:请确保你的主机PC当前使用的交叉编译器为NanoPi 2配套的arm-linux-gcc-4.9.3。<br>
+
Note: please make sure to install the cross compiler "arm-linux-gcc-4.9.3" on your PC, which is used to compile files for the NanoPi 2.<br>
编译成功后库文件位于install/lib目录下,而测试程序则位于install/usr/bin目录下,模块Matrix-I2C_LCD1602对应的测试程序为matrix-lcd1602。<br>
+
Generated library files are under the "install/lib" directory. The test program is under the "install/usr/bin" directory.<br>
硬件驱动模块位于modules目录下,对应的驱动源码都包含在在NanoPi 2的Linux内核仓库里:https://github.com/friendlyarm/linux-3.4.y.git <br>
+
The modules are under the "modules" directory. The driver's source code is in github: https://github.com/friendlyarm/linux-3.4.y.git <br>
  
===运行测试程序===
+
===Run Test Program===
将带有Debian系统的SD卡插入一台运行Linux的电脑,可以挂载SD卡上的boot和rootfs分区。<br>
+
Please insert a TF card which is flashed with Debian to a Linux host and mount its boot and rootfs sections.<br>
假设rootfs分区的挂载路径为/media/rootfs,执行以下命令将Matrix的硬件驱动、库文件和测试程序拷贝到NanoPi 2的文件系统上。<br>
+
We assume the rootfs is mounted to /media/rootfs then please run the following commands to copy the module, library and test program to the card.<br>
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ cp modules /media/rootfs/ -r
 
$ cp modules /media/rootfs/ -r
Line 110: Line 294:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
将SD卡重新插入NanoPi 2,上电启动,在Debian的shell终端中执行以下命令运行模块Matrix-I2C_LCD1602的测试程序。<br>
+
Insert this TF card to your NanoPi 2, power on and run the following command to test.<br>
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 
$ matrix-lcd1602
 
$ matrix-lcd1602
 
</syntaxhighlight>
 
</syntaxhighlight>
注意:此模块并不支持热插拔,启动系统前需要确保硬件连接正确。<br>
+
Note: this module is not plug and play therefore before running the module please make sure it is connected to a NanoPi 2.<br>
运行效果如下:<br>
+
Here is what you should expect:<br>
 
[[File:matrix-lcd1602_result.png|frameless|600px|matrix-lcd1602_result]] <br>
 
[[File:matrix-lcd1602_result.png|frameless|600px|matrix-lcd1602_result]] <br>
LCD上会显示下列2行字符:<br>
+
The LCD shows the following two lines:<br>
 
"  B&G Char LCD"    <br>
 
"  B&G Char LCD"    <br>
 
"--by FriendlyARM"
 
"--by FriendlyARM"
Line 367: Line 551:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
--->
  
 
==Resources==
 
==Resources==
Line 377: Line 562:
 
* Added the description for "NanoPi 2 branch" in Section 4
 
* Added the description for "NanoPi 2 branch" in Section 4
 
* Added Section 5: Connect to NanoPi 2
 
* Added Section 5: Connect to NanoPi 2
 
+
===June-19-2016===
 +
* Re-organized and simplified wiki
  
 
<!--
 
<!--

Latest revision as of 14:31, 19 June 2016

查看中文

1 Introduction

I2C LCD1602
I2C LCD1602
  • The Matrix-I2C_LCD1602 is an LCD display module composed of an LCD1602 and a PCF8574 module.
  • The LCD1602 can display up to 16x2 characters. It has a parallel interface.
  • The PCF8574 provides GPIO expansion up to 8 bit for I2C. It communicates with a master via I2C and converts data from the master to parallel signals to the LCD1602 thus controls the LCD's display and back light.

2 Features

  • I2C interface, LCD display and backlight control
  • 2.54mm spacing pin
  • IIC Module PCB dimension(mm): 16 x 42
  • LCD1602 PCB dimension (mm): 36 x 80

IIC Module PCB LCD1602 PCB

  • Pin Description:
Pin Description
SDA I2C SDA
SCL I2C SCL
5V Supply Voltage 5V
GND Ground

3 Basic Device Operation

3.1 PCF8574

  • The PCF8574 has I2C parallel expansion. It has an 8bit (P0 - P7) I2C interface.
  • The PCF8574 communicates with a master via I2C. The PCF8574's chip model is PCF8574T whose address specification is as follows:

PCF8574

  • If A2 - A0 are all set to 1 the 7bit address will be 0x27(0100111). By default RW is 0 and it is in the write mode.
  • In the write mode after opening the i2c-0 device and setting up its address the master can write data to it.
  • If you need to read data from it you will need to set the module to the read mode (RW set to 1). Please refer to the PCF8574's datasheet for more details.

3.2 LCD1602

  • The connection diagram between the PCF8574 module and the LCD module is as follows:

1602

  • RS is instruction/data register selection. RW is read/write selection. E is enable signal(edge triggering). BL is back light control. D4-D7 are data bits.
  • The LCD module is controlled by four data bits through which we can send instructions to control its state. Because it has eight instruction/data bits (DB7 - DB0) when writing each instruction/data we need to write the most significant four bits DB7 - DB4 first and then the least significant four bits DB3 - DB0.
  • Note: the LCD module has 192 most commonly used characters stored in CGROM. When we write a common character e.g "A" it will directly display "A". In addition it can store up to eight user defined characters in RAM called CGRAM.

4 Applications

4.1 Connect to NanoPi M1

Refer to the following connection diagram to connect the module to the NanoPi M1:
Matrix-I2C_LCD1602_nanopi_m1

Connection Details

Matrix-I2C_LCD1602 NanoPi M1
SDA Pin3
SCL Pin5
5V Pin4
GND Pin6

4.2 Connect to NanoPi 2

Refer to the following connection diagram to connect the module to the NanoPi 2:
Matrix-I2C_LCD1602_nanopi_2

Connection Details:

Matrix-I2C_LCD1602 NanoPi 2
SDA Pin3
SCL Pin5
5V Pin4
GND Pin6

4.3 Connect to NanoPi M2 / NanoPi 2 Fire

Refer to the following connection diagram to connect the module to the NanoPi M2/ NanoPi 2 Fire.
Matrix-I2C_LCD1602_nanopi_m2

Connection Details:

Matrix-I2C_LCD1602 NanoPi M2
SDA Pin3
SCL Pin5
5V Pin4
GND Pin6

4.4 Connect to NanoPC-T2

Refer to the following connection diagram to connect the module to the NanoPC-T2:
Matrix-I2C_LCD1602_NanoPC-T2

Connection Details:

Matrix-I2C_LCD1602 NanoPC-T2
SDA Pin6
SCL Pin5
5V Pin29
GND Pin30

5 Compile & Run Test Program

Boot your ARM board with Debian and copy the matrix code:

$ apt-get update && apt-get install git
$ git clone https://github.com/friendlyarm/matrix.git

If your cloning is done successfully a "matrix" directory will be generated.

Compile and install Matrix:

$ cd matrix
$ make && make install

Run test program:

$ matrix-lcd1602

Note: this module is not plug and play therefore before running the module please make sure it is connected to an ARM board.
Here is what you should observe:
matrix-lcd1602_result
The LCD will show the following two lines:
" B&G Char LCD"
"--by FriendlyARM"
If the LCD doesn't show them clearly you can adjust the resistor to highlight the characters.

6 Code Sample

This Matrix code sample can work with all the ARM boards mentioned in this module's wiki. The name of this code sample is "matrix-i2c_lcd1602". Here is its source code:

int main(int argc, char ** argv)
{
    int devFD, board;
    int i2cDev = 0;
 
    if ((board = boardInit()) < 0) {
        printf("Fail to init board\n");
        return -1;
    }
 
    if (argc == 2)
        i2cDev = atoi(argv[1]);
    if ((devFD = LCD1602Init(i2cDev)) == -1) {
        printf("Fail to init LCD1602\n");
        return -1;
    }
    if (LCD1602Clear(devFD) == -1) {
        printf("Fail to Clear\n");
    }
    printf("clearing LCD1602\n");
    sleep(1);
    if (LCD1602DispLines(devFD, "  B&G Char LCD", "--by FriendlyARM") == -1) {
        printf("Fail to Display String\n");
    }
    printf("displaying LCD1602\n");
    LCD1602DeInit(devFD);
    return 0;
}

For more details about this APIs called in this code sample refer to Matrix API reference manual

7 Connect to Arduino Board

7.1 Preparations

Make sure your Arduino board can work. Here is a reference link - https://www.arduino.cc/en/Guide/HomePage
Here we tried the Arduino Uno.

7.2 Hardware Connection

Refer to the following diagram to connect the Matrix-I2C_LCD1602 to an Arduino Uno
matrix-i2c_lcd1602_arduino

7.3 Compile & Run Test Program

All the matrix modules' code samples for Arduino are maintained on GitHub - https://github.com/friendlyarm/matrix-arduino.git
Clone the matrix code from GitHub

$ git clone git://github.com/friendlyarm/matrix-arduino.git

If this is successful a "matrix-arduino" directory will be generated, which will contain all the matrix modules' code samples.

Copy the entire directory "matrix-i2c_lcd1602" to "Arduino_IDE/libraries"

$ cd matrix-arduino
$ cp matrix-i2c_lcd1602 Arduino_IDE/libraies -r

Start Arduino IDE
Click on File->Examples->matrix-i2c_lcd1602->displaychar and run the test program.
Click on upload and run the test program.

7.4 Code Sample

#include <Wire.h> 
#include <LiquidCrystal_I2C.h>
 
// set the LCD address to 0x27 for a 16 chars and 2 line display
LiquidCrystal_I2C lcd(0x27,16,2);  
 
void setup()
{
  lcd.init();                        
  lcd.backlight();
  lcd.setCursor(2, 0);
  lcd.print("B&G Char LCD"); 
  lcd.setCursor(0, 1);
  lcd.println("--by FriendlyARM");
}
 
void loop()
{
}


8 Resources

LCD1602.pdf
pcf8574.pdf


9 Update Log

9.1 Feb-23-2016

  • Added the description for "NanoPi 2 branch" in Section 4
  • Added Section 5: Connect to NanoPi 2

9.2 June-19-2016

  • Re-organized and simplified wiki