mirror of
https://github.com/Matiasus/SSD1306.git
synced 2024-10-03 18:18:46 -04:00
131 lines
5.2 KiB
Markdown
131 lines
5.2 KiB
Markdown
# C Library for SSD1306 0.96" OLED display
|
|
|
|
## SSD1306 Description
|
|
Detailed information are described in [Datasheet SSD1306](https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf).
|
|
|
|
## Library
|
|
C library is aimed for driving [0.96" OLED display with SSD1306 driver](#demonstration) 128x64 through TWI's Atmega328p.
|
|
|
|
### Versions
|
|
- 1.0 - basic functions. The first publication.
|
|
- 2.0 - more changes:
|
|
- rebuild to cacheMemLcd array. It means that every request is stored in cache array and then is depicted on the display by function [SSD1306_UpdateScreen (uint8_t)](#ssd1306_updatescreen).
|
|
- Added new function -> [SSD1306_DrawLine (uint8_t, uint8_t, uint8_t, uint8_t)](#ssd1306_drawline). Possible depicted any line (horizontal, vertical, with slope).
|
|
- Possible to use for more than 1 display (not tested, cause displays that I have avialable had the same addresses).
|
|
|
|
## Dependencies
|
|
- [font.c](https://github.com/Matiasus/SSD1306/blob/readme-edits/lib/font.c)
|
|
- [font.h](https://github.com/Matiasus/SSD1306/blob/readme-edits/lib/font.h)
|
|
- [twi.c](https://github.com/Matiasus/SSD1306/blob/readme-edits/lib/twi.c)
|
|
- [twi.h](https://github.com/Matiasus/SSD1306/blob/readme-edits/lib/twi.h)
|
|
|
|
Font.c can be modified according to application requirements with form defined in font.c. Maximal permissible horizontal dimension is 8 bits.
|
|
|
|
### Usage
|
|
Prior defined for MCU Atmega328p / Atmega8 / Atmega16. Need to be carefull with TWI ports definition.
|
|
|
|
| PORT | [Atmega16](http://ww1.microchip.com/downloads/en/devicedoc/doc2466.pdf) | [Atmega8](https://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-2486-8-bit-AVR-microcontroller-ATmega8_L_datasheet.pdf) / [Atmega328](https://ww1.microchip.com/downloads/en/DeviceDoc/ATmega48A-PA-88A-PA-168A-PA-328-P-DS-DS40002061B.pdf) |
|
|
| :---: | :---: | :---: |
|
|
| SCL | PC0 | PC5 |
|
|
| SDA | PC1 | PC4 |
|
|
|
|
### Tested
|
|
Library was tested and proved on **_0.96″ OLED Display with SSD1306 driver_** and **_Atmega328p_**.
|
|
|
|
## Init OLED Sequence
|
|
Init sequence OLED display was defined according to page 64 (next to last page) of [Datasheet SSD1306](https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf).
|
|
|
|
```
|
|
// +---------------------------+
|
|
// | Set MUX Ratio |
|
|
// +---------------------------+
|
|
// | 0xA8, 0x3F |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set Display Offset |
|
|
// +---------------------------+
|
|
// | 0xD3, 0x00 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set Display Start Line |
|
|
// +---------------------------+
|
|
// | 0x40 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set Segment Remap |
|
|
// +---------------------------+
|
|
// | 0xA0 / 0xA1 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set COM Output Scan |
|
|
// | Direction |
|
|
// +---------------------------+
|
|
// | 0xC0 / 0xC8 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set COM Pins hardware |
|
|
// | configuration |
|
|
// +---------------------------+
|
|
// | 0xDA, 0x02 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set Contrast Control |
|
|
// +---------------------------+
|
|
// | 0x81, 0x7F |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Disable Entire Display On |
|
|
// +---------------------------+
|
|
// | 0xA4 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set Normal Display |
|
|
// +---------------------------+
|
|
// | 0xA6 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Set Osc Frequency |
|
|
// +---------------------------+
|
|
// | 0xD5, 0x80 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Enable charge pump |
|
|
// | regulator |
|
|
// +---------------------------+
|
|
// | 0x8D, 0x14 |
|
|
// +---------------------------+
|
|
// |
|
|
// +---------------------------+
|
|
// | Display On |
|
|
// +---------------------------+
|
|
// | 0xAF |
|
|
// +---------------------------+
|
|
```
|
|
## Functions
|
|
- [SSD1306_Init (uint8_t)](#ssd1306_init) - Init display
|
|
- [SSD1306_ClearScreen (void)](#ssd1306_clearscreen) - Clear screen
|
|
- [SSD1306_NormalScreen (uint8_t)](#ssd1306_normalscreen) - Normal screen
|
|
- [SSD1306_InverseScreen (uint8_t)](#ssd1306_inversescreen) - Inverse screen
|
|
- [SSD1306_SetPosition (uint8_t, uint8_t)](#ssd1306_setposition) - Set position
|
|
- [SSD1306_DrawChar (char)](#ssd1306_drawchar) - Draw specific character
|
|
- [SSD1306_DrawString (char*)](#ssd1306_drawstring) - Draw specific string
|
|
- [SSD1306_UpdateScreen (uint8_t)](#ssd1306_updatescreen) - Update content on display
|
|
- [SSD1306_DrawLine (uint8_t, uint8_t, uint8_t, uint8_t)](#ssd1306_drawline) - Draw line
|
|
|
|
## Demonstration
|
|
<img src="img/ssd1306_v20.png" />
|
|
|
|
## Links
|
|
- [Datasheet SSD1306](https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf)
|
|
- [Atmega328](https://ww1.microchip.com/downloads/en/DeviceDoc/ATmega48A-PA-88A-PA-168A-PA-328-P-DS-DS40002061B.pdf)
|