glcd_sh1106
Library for GLCD using the SH1106 display controller.

Author Rob Jansen, Copyright © 2026..2026, all rights reserved.
Adapted-by
Compiler 2.5r9

Description 

Text and graphics library for the graphic display module using 
             the SH1106 display controller. The library supports displays
             with a resolution of 128 x 32 or 128 x 64 (default).


Sources 

Library glcd_ssd1306.jal used as starting point.
         SH1106 Data Sheet from Sino wealth version 2.6


Notes 

This library supports the control of the display via one of two
       interfaces IIC or 4-wire SPI which depends on the interface that is 
       included by the main program before including this library. 
       This library supports control of the module using I2C software, 
       I2C hardware, I2C hardware2, SPI hardware and SPI hardware2. 
       Next to that the user can select a software SPI interface. In order 
       to use this define the following:
       -) const SSD1306_SOFTWARE_SPI = TRUE


Dependencies

No dependency found



Summary

Global variables/contants

Procedures

Private

Functions

Private

API details

Global variables/contants

Procedures

  • sh1106_set_start_line(byte in start_line) 

    Description: Set the display start line.
 The procedure can be used to implement a vertical scroll feature.
Parameters: 
 start_line - 0..SH1106_MAX_Y_PIXELS - 1

  • sh1106_write_pixel(byte in x, byte in y) 

    Description: Not implemented for text only mode
Notes:
 Only defined as dummy procedure for the glcd_common library.

  • sh1106_display_on() 

    Description: Switch the display on
Parameters: 
 None

  • sh1106_clear_screen() 

    Description: Clear the screen
Parameters: 
 None
Notes:
 Cursor is set to the position 0,0.

  • sh1106_display_resume() 

    Description: Resume the display
Parameters: 
 None

  • sh1106_display_off() 

    Description: Switch the display off
Parameters: 
 None

  • sh1106_write_char(byte in x, byte in y, byte in char) 

    Description: Write a character at position (x,y)
 It uses the font previously selected with glcd_font_use(FONT_ID) and honors
 glcd_background_color variable, and glcd_pen_color.
Parameters: 
 x    - x-coordinate in range 0..SH1106_MAX_X_PIXELS - 1
 y    - y-coordinate in range 0..SH1106_MAX_Y_PIXELS - 1
 char - ASCII character
Notes:
 Although x and y are given in pixels, the y coordindate will be mapped on
 display lines (pages) using glcd_font_current_height_. So when called y must
 always be defined in steps of glcd_font_current_height_. 
 When using glcd_common library, a glcd'put pseudo-variable will be defined,
 and can be called as an OUTPUT device (eg. glcd = "x").
 Only available when using fonts.

  • sh1106_update_display() 

    Description: Copy the changed area of the graphics cache to the display
Parameters: 
 None
Notes:
 Only used for graphics mode. This procedure is to be used when using 
 graphics features like pixes, lines, circles, etc. glcd_cache_update() 
 must be called next to update the display.

  • sh1106_send_command_parameter(byte in command, byte in parameter) 

    Description: Send a command to the sh1106 with the given parameter 
Parameters: 
 command   - instruction for the sh1106 from the datasheet
 parameter - data for the sh1106 as described in the datasheet

  • sh1106_display_all_on() 

    Description: Put all segments of the display on
Parameters: 
 None

  • sh1106_send_command(byte in command) 

    Description: Send a command to the sh1106
Parameters: 
 command - instruction for the sh1106 from the datasheet

  • sh1106_set_contrast(byte in contrast) 

    Description: Set the display contrast
Parameters: 
 contrast - 0x00..0xFF

  • sh1106_goto(byte in x, byte in y) 

    Description: Set the display to given coordinates
Parameters: 
 x - x-coordinate in range 0..SH1106_MAX_X_PIXELS - 1
 y - page number in 0..7 
Notes:
 Text must start on page boundaries.

  • sh1106_init() 

    Description: Initialize the SH1106 library and display
 When SPI is used and the reset pin is defined then the module will also be 
 hardware reset.
Parameters: 
 None
Notes:
 The use IIC interface or SPI interface must be initialized.

  • sh1106_display_normal() 

    Description: Put the display in normal (non-inverse) mode
Parameters: 
 None

  • sh1106_display_inverse() 

    Description: Put the display in inverse mode
Parameters: 
 None

  • glcd_clear_cache() 

    Description: Clear the graphics cache
Parameters: 
 None
Notes:
 Only used for graphics mode; glcd_cache_update() must be called next.

Private
  • _sh1106_stop_transmission() 

    Description: Stop an IIC transmission or SPI transmission
Parameters: 
 None

  • _sh1106_write_byte(byte in data) 

    Description: Write a byte to the SH1106
Parameters: 
 data - data byte to be written.
Notes:
 Used to send a number of data bytes in one transmission.
 Transmission must have been started using _sh1106_start_transmission() and
 must be stopped when done by using _sh1106_stop_transmission().

  • _sh1106_start_transmission(bit in transmission) 

    Description: Start an IIC transmission or SPI data or command transmission 
Parameters: 
 transmission - TRUE is data transmission, FALSE is command transmission

  • _sh1106_write_one_data_byte(byte in data) 

    Description: Write one data byte to the SH1106
Parameters: 
 data - data byte to be written.
Notes:
 Used to send one data byte in one transmission.


Functions

Private

Related samples

Here are the list of samples which use this library:

16f182516f1825_glcd_sh1106_font.jal
16f1885716f18857_glcd_sh1106_font_graphics.jal