com.diozero.devices.oled.SH1106 Maven / Gradle / Ivy

Go to download
package com.diozero.devices.oled;

/*
 * #%L
 * Organisation: diozero
 * Project:      diozero - Core
 * Filename:     SH1106.java
 * 
 * This file is part of the diozero project. More information about this project
 * can be found at https://www.diozero.com/.
 * %%
 * Copyright (C) 2016 - 2024 diozero
 * %%
 * 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.util.List;

/**
 * OLED that typically has an internal ram of 132 bytes by 8 rows (1056 bytes). Each row is "paged" to the display, so
 * each image written is several updates. When used in 128-column mode, an automatic offset of {@code 2} is applied,
 * which typically will center the image in the display.
 *
 * 
 * Links
 * 
 * 
 * Adafruit Circuit Python
 * SH1106
 * 
 */
public class SH1106 extends MonochromeSsdOled {
	static final List _INIT_SEQUENCE = List.of( //
			// divide ratio/oscillator: divide by 2, fOsc (POR)}
			new byte[] { DISPLAY_CLOCK_DIV_OSC_FREQ, (byte) 0x80 },
			new byte[] { SET_MULTIPLEX_RATIO, (byte) 0x3f }, // multiplex ratio = 64 (POR)
			new byte[] { SET_DISPLAY_OFFSET, (byte) 0x00 }, // set display offset mode = 0x0
			new byte[] { SET_DISPLAY_START_LINE_0 }, // set start line
			new byte[] { SET_IREF_INTERNAL, (byte) 0x8b }, // turn on DC/DC
			new byte[] { SET_SEGMENT_REMAP_ON }, // segment remap = 1 (POR=0, down rotation)
			new byte[] { COM_OUTPUT_SCAN_DIR_REMAPPED }, // scan decrement
			new byte[] { SET_COM_PINS_HW_CONFIG, (byte) 0x12 }, // set com pins
			new byte[] { SET_CONTRAST, (byte) 0xff }, // contrast setting = 0xff
			// pre-charge/dis-charge period mode: 2 DCLKs/2 DCLKs (POR)
			new byte[] { SET_PRECHARGE_PERIOD, (byte) 0x1f },
			new byte[] { SET_VCOMH_DESELECT_LEVEL, (byte) 0x40 }, // VCOM deselect level = 0.770 (POR)
			new byte[] { SET_MEMORY_ADDR_MODE, (byte) 0x20 }, //
			new byte[] { (byte) 0x33 }, // turn on VPP to 9V
			new byte[] { NORMAL_DISPLAY }, // normal (not reversed) display
			new byte[] { RESUME_TO_RAM_CONTENT_DISPLAY } // entire display off, retain RAM, normal status (POR)
	);
	private final byte rowOffset;

	/**
	 * Most common constructor.
	 *
	 * @param device the connection
	 */
	public SH1106(SsdOledCommunicationChannel device) {
		this(device, DEFAULT_WIDTH, Height.TALL);
	}

	/**
	 * Constructor for variable sizes.
	 *
	 * @param device     the connection
	 * @param width      the width of the display
	 * @param heightType the height of the display
	 */
	public SH1106(SsdOledCommunicationChannel device, int width, Height heightType) {
		super(device, width, heightType.lines);
		// because this driver actually has 132 ram bytes, offset by 2 to get the display "centered"
		if (width == DEFAULT_WIDTH) {
			rowOffset = 2;
		} else {
			rowOffset = 0;
		}
	}

	/**
	 * Constructor for variable sizes and "centering" of the display (e.g. 132 bytes RAM, but 128 display)
	 *
	 * @param device the connection
	 * @param width  the width of the display
	 * @param height the height of the display
	 */
	public SH1106(SsdOledCommunicationChannel device, int width, int height, byte rowOffset) {
		super(device, width, height);
		this.rowOffset = rowOffset;
	}

	@Override
	protected void init() {
		setDisplayOn(false);
		_INIT_SEQUENCE.forEach((this::command));
		setDisplayOn(true);
	}

	@Override
	protected void goTo(int x, int y) {
		throw new UnsupportedOperationException("Not currently supported in this class of display.");
	}

	/**
	 * {@inheritDoc}
	 * 
	 * > Overridden for page mode. This may be more generic and thus can be moved to the super class.
	 * 
	 */
	@Override
	public void show() {
		byte columnStart = (byte) (SET_LOWER_COLUMN_START_ADDR | rowOffset);

		for (int p = 0; p < pages; p++) {
			byte selectRow = (byte) (SET_PAGE_START_ADDR | p);

			channel.sendCommand(SET_HIGHER_COLUMN_START_ADDR);
			channel.sendCommand(columnStart);
			channel.sendCommand(selectRow);
			channel.sendData(getBuffer(), width * p, width);
		}
	}
}