com.diozero.devices.SSD1331 Maven / Gradle / Ivy
package com.diozero.devices;
/*
* #%L
* Organisation: mattjlewis
* Project: Device I/O Zero - Core
* Filename: SSD1331.java
*
* This file is part of the diozero project. More information about this project
* can be found at http://www.diozero.com/
* %%
* Copyright (C) 2016 - 2017 mattjlewis
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
import java.awt.image.BufferedImage;
import com.diozero.api.DigitalOutputDevice;
/**
* Encapsulates the serial interface to the 16-bit colour (5-6-5 RGB) SSD1331
* 96x64 OLED display hardware. On creation, an initialisation sequence is
* pumped to the display to properly configure it. Further control commands can
* then be called to affect the brightness and other settings.
*
* Wiring:
*
* GND .... Ground
* Vcc .... 3v3
* SCL .... SCLK (SPI)
* SDA .... MOSI (SPI)
* RES .... Reset (GPIO) [27]
* DC .... Data/Command Select (GPIO) [22]
* CS .... Chip Select (SPI)
*
*
*
* Links
*
*
* - Datasheet
* - Python
* code
*
*/
public class SSD1331 extends ColourSsdOled {
private static final int WIDTH = 96;
private static final int HEIGHT = 64;
private static final byte SET_COLUMN_ADDRESS = 0x15;
private static final byte SET_ROW_ADDRESS = 0x75;
private static final byte CONTRAST_COLOUR_A = (byte) 0x81;
private static final byte CONTRAST_COLOUR_B = (byte) 0x82;
private static final byte CONTRAST_COLOUR_C = (byte) 0x83;
private static final byte MASTER_CURRENT_CONTROL = (byte) 0x87;
private static final byte PRECHARGE_SPEED_COLOUR_A = (byte) 0x8A;
private static final byte PRECHARGE_SPEED_COLOUR_B = (byte) 0x8B;
private static final byte PRECHARGE_SPEED_COLOUR_C = (byte) 0x8C;
private static final byte REMAP_AND_COLOUR_DEPTH = (byte) 0xA0;
private static final byte DISPLAY_START_LINE = (byte) 0xA1;
private static final byte DISPLAY_OFFSET = (byte) 0xA2;
private static final byte DISPLAY_MODE_NORMAL = (byte) 0xA4;
private static final byte DISPLAY_MODE_ALL_ON = (byte) 0xA5;
private static final byte DISPLAY_MODE_ALL_OFF = (byte) 0xA6;
private static final byte DISPLAY_MODE_INVERSE = (byte) 0xA7;
private static final byte MULTIPLEX_RATIO = (byte) 0xA8;
private static final byte DIM_MODE = (byte) 0xAB;
private static final byte MASTER_CONFIG = (byte) 0xAD;
private static final byte POWER_SAVE_MODE = (byte) 0xB0;
private static final byte PHASE12_PERIOD = (byte) 0xB1;
private static final byte DISPLAY_CLOCK_DIVIDER = (byte) 0xB3;
private static final byte GRAY_SCALE_TABLE = (byte) 0xB8;
private static final byte ENABLE_LINEAR_GRAY_SCALE_TABLE = (byte) 0xB9;
private static final byte PRECHARGE_LEVEL = (byte) 0xBB;
private static final byte VOLTAGE = (byte) 0xBE;
public SSD1331(int controller, int chipSelect, DigitalOutputDevice dcPin, DigitalOutputDevice resetPin) {
super(controller, chipSelect, dcPin, resetPin, WIDTH, HEIGHT, BufferedImage.TYPE_USHORT_565_RGB);
}
@Override
protected void init() {
reset();
// Display off
setDisplayOn(false);
// Seg remap:
// 0 -> Horizontal address increment
// 1 -> RAM Column 0 to 95 maps to Pin Seg (SA,SB,SC) 95 to 0
// 0 -> RGB
// 0 -> Disable left-right swapping on COM
// 1 -> Scan from COM [N-1] to COM0
// 1 -> Enable COM split odd-even
// 01 -> 65k colour
command(REMAP_AND_COLOUR_DEPTH, (byte) 0b01110010);
// Set Display start line
command(DISPLAY_START_LINE, (byte) 0x00);
// Set display offset
command(DISPLAY_OFFSET, (byte) 0x00);
// Normal display
command(DISPLAY_MODE_NORMAL);
// Set multiplex (0x3F is the default)
command(MULTIPLEX_RATIO, (byte) 0x3F);
// Master configure (Bit A[0] must be set to 0b after RESET)
command(MASTER_CONFIG, (byte) 0b10001110);
// Power save mode (0x1A = Enable, 0x0B = Disable)
command(POWER_SAVE_MODE, (byte) 0x0B);
// Phase12 period (phase 1 = 4, phase 2 = 7)
command(PHASE12_PERIOD, (byte) 0b0111_0100);
// Clock divider (divide ratio = 1, Fosc frequency = 13)
command(DISPLAY_CLOCK_DIVIDER, (byte) 0b1101_0000);
// Set precharge speeds
command(PRECHARGE_SPEED_COLOUR_A, (byte) 0x80, PRECHARGE_SPEED_COLOUR_B, (byte) 0x80, PRECHARGE_SPEED_COLOUR_C, (byte) 0x80);
// Set pre-charge voltage (default is 0x3E 0b111110)
command(PRECHARGE_LEVEL, (byte) 0b00111110);
// Set voltage (default is 0x3E which is 0.83 * Vcc)
command(VOLTAGE, (byte) 0x3E);
// Master current control (default is 0x0F)
command(MASTER_CURRENT_CONTROL, (byte) 0x0F);
setContrast((byte) 0xFF);
clear();
setDisplayOn(true);
}
@Override
protected void goTo(int x, int y) {
command(SET_COLUMN_ADDRESS, (byte) x, (byte) (width - 1));
command(SET_ROW_ADDRESS, (byte) y, (byte) (height - 1));
}
/**
* Sets if the display should be inverted
*
* @param invert
* Invert state
*/
@Override
public void invertDisplay(boolean invert) {
command(invert ? DISPLAY_MODE_INVERSE : DISPLAY_MODE_NORMAL);
}
/**
* Switches the display contrast to the desired level, in the range
* 0-255. Note that setting the level to a low (or zero) value will
* not necessarily dim the display to nearly off. In other words,
* this method is **NOT** suitable for fade-in/out animation.
* @param level Desired contrast level in the range 0..255
*/
@Override
public void setContrast(byte level) {
command(CONTRAST_COLOUR_A, level, CONTRAST_COLOUR_B, level, CONTRAST_COLOUR_C, level);
}
@Override
public void setContrast(byte red, byte green, byte blue) {
command(CONTRAST_COLOUR_A, red, CONTRAST_COLOUR_B, green, CONTRAST_COLOUR_C, blue);
}
}