index :: hw

hw.rpi.display.ssd1306

driver for OLED display on ssd1306 chip for Raspberry Pi

available since version: 0.9.8

---

information

Both I²C and SPI connections are supported. I²C connection is not fast. Note: you should send [flush( message to transfer internal pixel buffer to the device

arguments:

• MODE display connection. See @mode
  type: symbol
  

methods:

• brightness set display brightness
  parameters:
  • LEVEL brightness level from 0 (lowest) to 4 (brightest). Normal level is 2.
    type: int
    required: True
    
• clear clear display and optionally flush internal buffer
  parameters:
  • [FLUSH=0] flush internal buffer to the device
    type: bool
    

• flush flush internal buffer to the device
  

• font set current font
  parameters:
  • FONT font name
    type: symbol
    required: True
    
• invert invert display
  parameters:
  • VALUE value
    type: bool
    required: True
    
• mirror mirror display
  parameters:
  • VALUE value
    type: bool
    required: True
    
• pixel draw pixel
  parameters:

  • X X coord (from the left)
    type: int
    required: True
    

  • Y Y coord (from the top)
    type: int
    required: True
    

  • VALUE pixel value
    type: bool
    required: True
    

• rotation set display rotation
  parameters:
  • [ANGLE] rotation angle
    type: int
    
• switch_on switch on display (needed for SPI connection)
  parameters:
  • VALUE value
    type: bool
    required: True
    
• text draw text on the display
  parameters:

  • TXT text
    type: symbol
    required: True
    

  • X left text X coordinate
    type: int
    required: True
    

  • Y top text Y coordinate
    type: int
    required: True
    

• write bitmap write bitmap to the display buffer
  parameters:

  • X bitmap X coordinate
    type: int
    required: True
    

  • Y bitmap Y coordinate
    type: int
    required: True
    

  • WIDTH bitmap width in pixels
    type: int
    required: True
    

  • PIXELS list of pixels (0 or 1)
    type: list
    required: True
    

• write bytes write raw byte list to the display buffer and move internal cursor position
  parameters:
  • BYTES list of bytes (integers in 0..255 range). Each byte describes a single column of 8 pixels in height
    type: list
    required: True
    

properties:

• @i2c_addr (initonly) Get/set I²C address. Also 'default' value is accepted (for addr 0x3c) and 'alt' (for addr 0x3d)
  type: int
  range: -4..119
  default: -1
  

• @i2c_bus (initonly) Get/set I²C bus
  type: atom
  enum: 1, 2, 3, 4, 5, 6, default, none
  default: none
  

• @mode (initonly) Get/set display connection
  type: symbol
  enum: i2c, spi
  default: i2c
  

• @size (initonly) Get/set display size
  type: list
  default: 128 64
  

• @spi_bus (initonly) Get/set SPI bus
  type: int
  range: 0..6
  default: 0
  

• @spi_cs (initonly) Get/set CS (chip select) GPIO pin
  type: int
  range: -1..127
  default: -1
  

• @spi_dc (initonly) Get/set DC (data/command) GPIO pin
  type: int
  range: -1..127
  default: -1
  

• @spi_freq (initonly) Get/set SPI frequency
  type: int
  units: Hz
  range: 100000..10000000
  default: 1000000
  

• @spi_rs (initonly) Get/set RS (reset) GPIO pin
  type: int
  range: -1..127
  default: -1
  

inlets:

• control input
  type: control

outlets:

• no output
  type: control

keywords:

display ssd1306 spi i2c rpi

Authors: Serge Poltavsky

License: GPL3 or later