Display - OLED SSD1306

.

Plugin details

Type: Display

Name: OLED SSD1306

Status: NORMAL DISPLAY CLIMATE

GitHub: P023_OLED.ino

Maintainer: .

Used libraries: .

Description

This plugin features a basic display of a text template, including device values, on black and white OLed displays, using the SSD1306 and SH1106 controllers.

Configuration

../_images/P023_DeviceConfiguration.png

  • Name: A unique name should be entered here.

  • Enabled: The device can be disabled or enabled. When not enabled the device should not use any resources.

I2C Options

The available settings here depend on the build used. At least the Force Slow I2C speed option is available, but selections for the I2C Multiplexer can also be shown. For details see the Hardware page

Device Settings

../_images/P023_ControllerOptions.png

  • Controller: Select the controller chip that is used for the display. There are 2 options available, SSD1306 and SH1106.

../_images/P023_RotationOptions.png

  • Rotation: Select if the display is mounted normally or upside-down (rotated 180 degrees).

../_images/P023_DisplaySizeOptions.png

  • Display Size: Select the pixel resolution of the display.

../_images/P023_FontWidthOptions.png

  • Font Width: The Normal option uses a mono-spaced font to display the text, where Optimized is similar to a proportionally spaced font, where each character uses only the pixels it needs.

  • Line 1 .. Line 8: All user defined texts may contain references to system variables or task values which will be interpreted when displayed on screen.

For example: [bme#Temp#D2.1] {D}C [bme#Hum]%

  • GPIO <- Display button(optional): Setting up a Display Button, allows to configure a Display Timeout and wake the display on demand, either by a button, or by using some presence detection.

  • Display Timeout: The numbers of seconds after which the display is turned off. When set to 0 no timeout is active.

  • Interval By default, Interval will be set to 0. If set to a non-zero value, the pre-configured content will be updated automatically using that interval (seconds).

General

Commands available

Command

Extra information

oledcmd,off

Turn the display off.

oledcmd,on

Turn the display on.

oledcmd,clear

Remove all content from the screen.

oled,<line>,<column>,<content>

<line>: The line to place the content on, range: 1..8.

<column>: The column to start writing the content. The number of characters that can be displayed can vary, depending on the Font Width setting.

<content>: The text content to place on the display. Can include system variables, taskvalue references, etc.

Write a line of text on the display, at the given position.

Change log

Changed in version 2.0: …

added Major overhaul for 2.0 release.

Added in version 1.0: …

added Initial release version.