Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gavinlyonsrepo/NOKIA_5110_RPI

Nokia 5110 LCD SPI C++ library for the raspberry pi single board computer ecosystem, PCD8544 controller
https://github.com/gavinlyonsrepo/NOKIA_5110_RPI

display-library library library-rpi nokia-5110 nokia-display nokia5110 raspberry-pi raspberrypi rpi

Last synced: about 1 month ago
JSON representation

Nokia 5110 LCD SPI C++ library for the raspberry pi single board computer ecosystem, PCD8544 controller

Host: GitHub
URL: https://github.com/gavinlyonsrepo/NOKIA_5110_RPI
Owner: gavinlyonsrepo
License: gpl-3.0
Created: 2021-06-24T15:14:25.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-02-11T15:21:35.000Z (7 months ago)
Last Synced: 2024-07-27T04:34:25.665Z (about 2 months ago)
Topics: display-library, library, library-rpi, nokia-5110, nokia-display, nokia5110, raspberry-pi, raspberrypi, rpi
Language: C++
Homepage: https://gavinlyonsrepo.github.io/
Size: 356 KB
Stars: 6
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # NOKIA_5110_RPI

## Table of contents

  * [Overview](#overview)

  * [See Also](see-also)

  * [Installation](#installation)

  * [Test](#test)

  * [Hardware](#hardware)

  * [Software](#software)

 	* [API](#api)

 	* [SPI](#spi)

 	* [File system](#file-system)

 	* [Fonts](#fonts)

	* [Bitmap](#bitmap)

  * [Output](#output)

## Overview

* Name: NOKIA_5110_RPI

* Description:

0. C++ Library for Nokia 5110 LCD, PCD8544 Driver. 84 x 48 pixels.

1. Dynamic install-able Raspberry Pi C++ library.

2. Invert colour, rotate, sleep, contrast bias control supported.

3. 12 fonts.

4. Graphics class included.

5. Polymorphic print class included.

6. Bitmaps supported.

7. Hardware and Software SPI

8. Dependency: bcm2835 Library

* Author: Gavin Lyons

* Port of my PIC library at [github link.](https://github.com/gavinlyonsrepo/pic_18F47K42_projects)

* Development Tool chain. 

	1. Raspberry PI 3 model b

	2. C++, g++ (Debian 12.2.0) 

	3. Raspbian , Debian 12 bookworm OS, , 64 bit.

	4. kernel : aarch64 Linux 6.1.0-rpi7-rpi-v8

	5. [bcm2835 Library 1.71 dependency](http://www.airspayce.com/mikem/bcm2835/). Provides low level SPI bus, delays and GPIO control.

## See Also

[Combined Display library 'Display_Lib_RPI'](https://github.com/gavinlyonsrepo/Display_Lib_RPI)

## Installation

1. Install the dependency bcm2835 Library if not installed (at time of writing latest version is 1.71)

	* The bcm2835 library  provides SPI bus, delays and GPIO control.

	* Install the C libraries of bcm2835, [Installation instructions here](http://www.airspayce.com/mikem/bcm2835/)

2. Download the NOKIA_5110_RPI library

	* Open a Terminal in a folder where you want to download,build & test library

	* Run following command to download from github.

```sh

curl -sL https://github.com/gavinlyonsrepo/NOKIA_5110_RPI/archive/1.4.tar.gz | tar xz

```

3. Run "make" to run the makefile to install library, it will be

    installed to usr/lib and usr/include

```sh

cd NOKIA_5110_RPI-1.4

make

sudo make install

```

## Test

1. Next step is to test LCD and installed library with the main.cpp test file.

Wire up your LCD. Next enter the example folder and run the makefile in THAT folder,

This second makefile builds the example file using the just installed library.

and creates a test exe file in "example/bin". Note : make run uses sudo, bcm2835 library requires sudo.

```sh

cd example/

make

make run

```

2. There are 7 examples files to try out.

To decide which one the makefile builds simply edit "SRC" variable at top of the makefile in examples folder.

in the "User SRC directory Option Section". Pick an example "SRC" directory path and ONE ONLY.

Comment out the rest and repeat: make and run bin/test.

| Filepath | File Function | SPI |

| ---- | ---- | ---- |

| src/HelloWorld | Basic use case | HW |

| src/HelloWorld_SWSPI | Basic use case SW SPI | SW |

| src/TextTests | Text & fonts | HW |

| src/GraphicTests | Graphics | HW |

| src/BitmapTests | Bitmaps | HW |

| src/FunctionTests | Function testing | HW |

| src/SpeedTest | Frame rate per second test | HW |

## Hardware

The Nokia 5110 is a basic graphic LCD screen for lots of applications.

GPIO function on RPI, 5 Nokia 5110 LCD lines SPI bus. Use any GPIO user likes for Software SPI.

For Hardware the user can use any GPIO for reset and data/command line

Example file set up ::

| RPI pin(HW SPI) | RPI pin(SW SPI)| Nokia 5110 LCD |

| ------ | ------ | ------ |

| SPI_CLK | GPIO22 | LCD_CLK Pin 5 clock in |

| SPI_MOSI | GPIO27 | LCD_DIN Pin 4 data in |

| GPIO24 | GPIO24 | LCD_DC Pin 3 data/command|

| SPI_CE0 or SPI_CE1 | GPIO 8 | LCD_CE Pin 2 chip enable |

| GPIO25 | GPIO25 | LCD_RST Pin 1 reset|

Connect Nokia 5110 VCC(pin 6)to 3.3V.

The user may have to adjust LCD contrast and bias settings,

to the screen at hand for optimal display.

A resistor or potentiometer can be connected between (Nokia LCD)

GND(pin8) and LIGHT(pin7) to switch on /off backlight and adjust brightness.

[Nokia 5110 LCD dataSheet ](https://www.sparkfun.com/datasheets/LCD/Monochrome/Nokia5110.pdf)

![PICTURE](https://github.com/gavinlyonsrepo/pic_16F1619_projects/blob/master/images/NOKIA2.jpg)

## Software

### API

The Software is commented mostly for"doxygen" and if users uses "doxygen" software

an API HTML document can be generated. A Doxyfile is in doc sub folder in repository.

### SPI

This library supports both Hardware SPI and software SPI.

The constructor of the main class is overloaded. 

Which SPI is started depends on which constructor called by user.

Hardware SPI uses bcm2835 library spi module.

The SPI settings are in LCDSPIHWSettings function.

If there are multiple SPI devices on Bus(with different settings) the user can call this method 

to refresh settings before a tranche of LCD commands.

Default Speed is BCM2835_SPI_CLOCK_DIVIDER_64,

6.25MHz on RPI3. This can be adjusted in code or you can pass

the divider value in the contructor as an argument. These values are

defined by enum bcm2835SPIClockDivider. For full list see

![bcm2](https://github.com/gavinlyonsrepo/NOKIA_5110_RPI/blob/main/extra/images/bcm2.png)

User can also adjust which HW SPI chip enable pin they use(CE0 or CE1).

in constructor arguments. This device uses bit order MSB First and SPI Mode 0.

Measured SPI speed results Version 1.3 are in the SpeedTest example file header comment block.

The parameter LCDHardwareSPI is a GPIO uS delay that

can be used to slow down or speed up Software SPI.

By default it is set to 2uS. It may have to be adjusted depending on device/CPU used.

### File system

There are two makefiles

    1. Makefile at root directory builds and installs library at a system level.

    2. Makefile in example directory build example file to an executable.

### Fonts

Font data table:

| num | enum name | Char size XbyY | ASCII range | Size bytes | Size Scale-able |

| ------ | ------ | ------ | ------ |  ------ | ----- |

| 1 | $_Default | 5x8 |0-0x7F|635 |Y|

| 2 | $_Thick   | 7x8 |0x20-0x5A, no lowercase letters |406|Y|

| 3 | $_SevenSeg  | 4x8 |0x20-0x7A |360|Y|

| 4 | $_Wide | 8x8 |0x20-0x5A, no lowercase letters|464|Y|

| 5 | $_Tiny | 3x8 |0x20-0x7E |285|Y|

| 6 | $_Homespun  | 7x8 |0x20-0x7E |658|Y|

| 7 | $_Bignum | 16x32 |0x2D-0x3A ,0-10 - . / : |896|N|

| 8 | $_Mednum | 16x16 |0x2D-0x3A ,0-10 - . / :|448|N|

| 9 | $_ArialRound| 16x24 | 0x20-0x7E |4608|N|

| 10 | $_ArialBold | 16x16 |0x20-0x7E |3072|N|

| 11 | $_Mia| 8x16 | 0x20-0x7E |1520|N|

| 12 | $_Dedica | 6x12 |0x20-0x7E |1152|N|

1. $ = LCDFontType

2. A print class is available to print out many data types.

3. Fonts 1-6 are byte high(at text size 1) scale-able fonts, columns of padding added by SW.

4. Font 7-8 are large numerical fonts and cannot be scaled(just one size).

5. Fonts 9-12 large Alphanumeric fonts and cannot be scaled(just one size)

Font Methods:

| Font num | Method | Notes |

| ------ | ------ | ------ |

| 1-6 | drawChar|Y| draws single  character |

| 1-6 | drawText |Y| draws character array |

| 7-12 | drawChar|N| draws single  character |

| 7-12 | drawText|N| draws character array |

| 1-12 | print | Polymorphic print class which will print out many data types |

These methods return an enum( LCD_Return_Codes_e), non-zero in event of an error (see API doc). Such as wrong font chosen , ASCII character outside

chosen fonts range, character out of screen bounds and invalid character array pointer object.

### Bitmap

Two different bitmaps methods can be used.

| num | Method name | data addressing | Notes | 

| ------ | ------ | ------ | ------ |   

| 1 | drawBitmap() |vertical| Draws bitmaps to the buffer, Bitmap's height must be divisible by 8| 

| 2 | customChar()| vertical | Draws a custom character on screen 5by8, PIC legacy function | 

The drawBitmap will return an error( enum( LCD_Return_Codes_e)) if : The Bitmap is completely off screen , 

Invalid Bitmap pointer object, bitmap bigger than screen , bitmap bigger/smaller than provided width and height co-ordinates

( This helps prevents buffer overflow if user enters wrong data.).

The Bitmap's height must be divisible by 8. I.e for a full screen bitmap with width=84 and height=48.

Bitmap excepted size = 84 * (48/8) = 504 bytes.

Bitmaps can be turned to data [here at link]( https://javl.github.io/image2cpp/) 

See example file "BitmapTests" for more details.

## Output

Example output.

![OUTPUT](https://github.com/gavinlyonsrepo/pic_18F47K42_projects/blob/master/images/nokiagraph1.jpg)