SSD1325 grayscale support (#1064)

* SSD1325 grayscale support implemented

* Linted

* Fix garbage on display at power-up

* Rebase

* Linted

* Add brightness control, CS fixes

* Fix up SSD1327 init

* Add turn_on() and turn_off() methods

* Set brightness later in setup(), logging tweak

* Added is_on() method

* Added  grayscale image support

* Updated to use Color, 1327 GS fix
This commit is contained in:
Keith Burzinski 2020-07-09 19:53:49 -05:00 committed by GitHub
parent c693c219f4
commit 7fa98e288f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 129 additions and 86 deletions

View file

@ -7,8 +7,8 @@ namespace display {
static const char *TAG = "display"; static const char *TAG = "display";
const Color COLOR_OFF = 0; const Color COLOR_OFF(0, 0, 0, 0);
const Color COLOR_ON = 1; const Color COLOR_ON(1, 1, 1, 1);
void DisplayBuffer::init_internal_(uint32_t buffer_length) { void DisplayBuffer::init_internal_(uint32_t buffer_length) {
this->buffer_ = new uint8_t[buffer_length]; this->buffer_ = new uint8_t[buffer_length];
@ -214,10 +214,10 @@ void DisplayBuffer::image(int x, int y, Color color, Image *image, bool invert)
this->draw_pixel_at(x + img_x, y + img_y, image->get_pixel(img_x, img_y) ? color : COLOR_OFF); this->draw_pixel_at(x + img_x, y + img_y, image->get_pixel(img_x, img_y) ? color : COLOR_OFF);
} }
} }
} else if (image->get_type() == GRAYSCALE4) { } else if (image->get_type() == GRAYSCALE) {
for (int img_x = 0; img_x < image->get_width(); img_x++) { for (int img_x = 0; img_x < image->get_width(); img_x++) {
for (int img_y = 0; img_y < image->get_height(); img_y++) { for (int img_y = 0; img_y < image->get_height(); img_y++) {
this->draw_pixel_at(x + img_x, y + img_y, image->get_grayscale4_pixel(img_x, img_y)); this->draw_pixel_at(x + img_x, y + img_y, image->get_grayscale_pixel(img_x, img_y));
} }
} }
} else if (image->get_type() == RGB565) { } else if (image->get_type() == RGB565) {
@ -457,14 +457,11 @@ int Image::get_color_pixel(int x, int y) const {
int color = (pgm_read_byte(this->data_start_ + pos) << 8) + (pgm_read_byte(this->data_start_ + pos + 1)); int color = (pgm_read_byte(this->data_start_ + pos) << 8) + (pgm_read_byte(this->data_start_ + pos + 1));
return color; return color;
} }
int Image::get_grayscale4_pixel(int x, int y) const { Color Image::get_grayscale_pixel(int x, int y) const {
if (x < 0 || x >= this->width_ || y < 0 || y >= this->height_) if (x < 0 || x >= this->width_ || y < 0 || y >= this->height_)
return 0; return 0;
const uint32_t pos = (x + y * this->width_) / 2; const uint32_t pos = (x + y * this->width_);
// 2 = number of pixels per byte, 4 = pixel shift return Color(pgm_read_byte(this->data_start_ + pos) << 24);
uint8_t shift = (x % 2) * 4;
int color = (pgm_read_byte(this->data_start_ + pos) >> shift) & 0x0f;
return color;
} }
int Image::get_width() const { return this->width_; } int Image::get_width() const { return this->width_; }
int Image::get_height() const { return this->height_; } int Image::get_height() const { return this->height_; }

View file

@ -68,7 +68,7 @@ extern const Color COLOR_OFF;
/// Turn the pixel ON. /// Turn the pixel ON.
extern const Color COLOR_ON; extern const Color COLOR_ON;
enum ImageType { BINARY = 0, GRAYSCALE4 = 1, RGB565 = 2 }; enum ImageType { BINARY = 0, GRAYSCALE = 1, RGB565 = 2 };
enum DisplayRotation { enum DisplayRotation {
DISPLAY_ROTATION_0_DEGREES = 0, DISPLAY_ROTATION_0_DEGREES = 0,
@ -385,7 +385,7 @@ class Image {
Image(const uint8_t *data_start, int width, int height, int type); Image(const uint8_t *data_start, int width, int height, int type);
bool get_pixel(int x, int y) const; bool get_pixel(int x, int y) const;
int get_color_pixel(int x, int y) const; int get_color_pixel(int x, int y) const;
int get_grayscale4_pixel(int x, int y) const; Color get_grayscale_pixel(int x, int y) const;
int get_width() const; int get_width() const;
int get_height() const; int get_height() const;
ImageType get_type() const; ImageType get_type() const;

View file

@ -11,7 +11,7 @@ _LOGGER = logging.getLogger(__name__)
DEPENDENCIES = ['display'] DEPENDENCIES = ['display']
MULTI_CONF = True MULTI_CONF = True
ImageType = {'binary': 0, 'grayscale4': 1, 'rgb565': 2} ImageType = {'binary': 0, 'grayscale': 1, 'rgb565': 2}
Image_ = display.display_ns.class_('Image') Image_ = display.display_ns.class_('Image')
@ -41,20 +41,18 @@ def to_code(config):
image.thumbnail(config[CONF_RESIZE]) image.thumbnail(config[CONF_RESIZE])
if CONF_TYPE in config: if CONF_TYPE in config:
if config[CONF_TYPE].startswith('GRAYSCALE4'): if config[CONF_TYPE].startswith('GRAYSCALE'):
width, height = image.size width, height = image.size
image = image.convert('L', dither=Image.NONE) image = image.convert('L', dither=Image.NONE)
pixels = list(image.getdata()) pixels = list(image.getdata())
data = [0 for _ in range(height * width // 2)] data = [0 for _ in range(height * width)]
pos = 0 pos = 0
for pixnum, pix in enumerate(pixels): for pix in pixels:
pixshift = (pixnum % 2) * 4 data[pos] = pix
data[pos] |= (pix >> 4) << pixshift
if pixshift != 0:
pos += 1 pos += 1
rhs = [HexInt(x) for x in data] rhs = [HexInt(x) for x in data]
prog_arr = cg.progmem_array(config[CONF_RAW_DATA_ID], rhs) prog_arr = cg.progmem_array(config[CONF_RAW_DATA_ID], rhs)
cg.new_Pvariable(config[CONF_ID], prog_arr, width, height, ImageType['grayscale4']) cg.new_Pvariable(config[CONF_ID], prog_arr, width, height, ImageType['grayscale'])
elif config[CONF_TYPE].startswith('RGB565'): elif config[CONF_TYPE].startswith('RGB565'):
width, height = image.size width, height = image.size
image = image.convert('RGB') image = image.convert('RGB')

View file

@ -2,7 +2,8 @@ import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome import pins from esphome import pins
from esphome.components import display from esphome.components import display
from esphome.const import CONF_EXTERNAL_VCC, CONF_LAMBDA, CONF_MODEL, CONF_RESET_PIN from esphome.const import CONF_BRIGHTNESS, CONF_EXTERNAL_VCC, CONF_LAMBDA, CONF_MODEL, \
CONF_RESET_PIN
from esphome.core import coroutine from esphome.core import coroutine
ssd1325_base_ns = cg.esphome_ns.namespace('ssd1325_base') ssd1325_base_ns = cg.esphome_ns.namespace('ssd1325_base')
@ -22,12 +23,13 @@ SSD1325_MODEL = cv.enum(MODELS, upper=True, space="_")
SSD1325_SCHEMA = display.FULL_DISPLAY_SCHEMA.extend({ SSD1325_SCHEMA = display.FULL_DISPLAY_SCHEMA.extend({
cv.Required(CONF_MODEL): SSD1325_MODEL, cv.Required(CONF_MODEL): SSD1325_MODEL,
cv.Optional(CONF_RESET_PIN): pins.gpio_output_pin_schema, cv.Optional(CONF_RESET_PIN): pins.gpio_output_pin_schema,
cv.Optional(CONF_BRIGHTNESS, default=1.0): cv.percentage,
cv.Optional(CONF_EXTERNAL_VCC): cv.boolean, cv.Optional(CONF_EXTERNAL_VCC): cv.boolean,
}).extend(cv.polling_component_schema('1s')) }).extend(cv.polling_component_schema('1s'))
@coroutine @coroutine
def setup_ssd1036(var, config): def setup_ssd1325(var, config):
yield cg.register_component(var, config) yield cg.register_component(var, config)
yield display.register_display(var, config) yield display.register_display(var, config)
@ -35,6 +37,8 @@ def setup_ssd1036(var, config):
if CONF_RESET_PIN in config: if CONF_RESET_PIN in config:
reset = yield cg.gpio_pin_expression(config[CONF_RESET_PIN]) reset = yield cg.gpio_pin_expression(config[CONF_RESET_PIN])
cg.add(var.set_reset_pin(reset)) cg.add(var.set_reset_pin(reset))
if CONF_BRIGHTNESS in config:
cg.add(var.init_brightness(config[CONF_BRIGHTNESS]))
if CONF_EXTERNAL_VCC in config: if CONF_EXTERNAL_VCC in config:
cg.add(var.set_external_vcc(config[CONF_EXTERNAL_VCC])) cg.add(var.set_external_vcc(config[CONF_EXTERNAL_VCC]))
if CONF_LAMBDA in config: if CONF_LAMBDA in config:

View file

@ -8,7 +8,11 @@ namespace ssd1325_base {
static const char *TAG = "ssd1325"; static const char *TAG = "ssd1325";
static const uint8_t BLACK = 0; static const uint8_t BLACK = 0;
static const uint8_t WHITE = 1; static const uint8_t WHITE = 15;
static const uint8_t SSD1325_MAX_CONTRAST = 127;
static const uint8_t SSD1325_COLORMASK = 0x0f;
static const uint8_t SSD1325_COLORSHIFT = 4;
static const uint8_t SSD1325_PIXELSPERBYTE = 2;
static const uint8_t SSD1325_SETCOLADDR = 0x15; static const uint8_t SSD1325_SETCOLADDR = 0x15;
static const uint8_t SSD1325_SETROWADDR = 0x75; static const uint8_t SSD1325_SETROWADDR = 0x75;
@ -33,6 +37,7 @@ static const uint8_t SSD1325_SETROWPERIOD = 0xB2;
static const uint8_t SSD1325_SETCLOCK = 0xB3; static const uint8_t SSD1325_SETCLOCK = 0xB3;
static const uint8_t SSD1325_SETPRECHARGECOMP = 0xB4; static const uint8_t SSD1325_SETPRECHARGECOMP = 0xB4;
static const uint8_t SSD1325_SETGRAYTABLE = 0xB8; static const uint8_t SSD1325_SETGRAYTABLE = 0xB8;
static const uint8_t SSD1325_SETDEFAULTGRAYTABLE = 0xB9;
static const uint8_t SSD1325_SETPRECHARGEVOLTAGE = 0xBC; static const uint8_t SSD1325_SETPRECHARGEVOLTAGE = 0xBC;
static const uint8_t SSD1325_SETVCOMLEVEL = 0xBE; static const uint8_t SSD1325_SETVCOMLEVEL = 0xBE;
static const uint8_t SSD1325_SETVSL = 0xBF; static const uint8_t SSD1325_SETVSL = 0xBF;
@ -44,30 +49,48 @@ static const uint8_t SSD1325_COPY = 0x25;
void SSD1325::setup() { void SSD1325::setup() {
this->init_internal_(this->get_buffer_length_()); this->init_internal_(this->get_buffer_length_());
this->command(SSD1325_DISPLAYOFF); /* display off */ this->command(SSD1325_DISPLAYOFF); // display off
this->command(SSD1325_SETCLOCK); /* set osc division */ this->command(SSD1325_SETCLOCK); // set osc division
this->command(0xF1); /* 145 */ this->command(0xF1); // 145
this->command(SSD1325_SETMULTIPLEX); /* multiplex ratio */ this->command(SSD1325_SETMULTIPLEX); // multiplex ratio
if (this->model_ == SSD1327_MODEL_128_128) if (this->model_ == SSD1327_MODEL_128_128)
this->command(0x7f); // duty = height - 1 this->command(0x7f); // duty = height - 1
else else
this->command(0x3f); // duty = 1/64 this->command(0x3f); // duty = 1/64
this->command(SSD1325_SETOFFSET); /* set display offset --- */ this->command(SSD1325_SETOFFSET); // set display offset
if (this->model_ == SSD1327_MODEL_128_128) if (this->model_ == SSD1327_MODEL_128_128)
this->command(0x00); // 0 this->command(0x00); // 0
else else
this->command(0x4C); // 76 this->command(0x4C); // 76
this->command(SSD1325_SETSTARTLINE); /*set start line */ this->command(SSD1325_SETSTARTLINE); // set start line
this->command(0x00); /* ------ */ this->command(0x00); // ...
this->command(SSD1325_MASTERCONFIG); /*Set Master Config DC/DC Converter*/ this->command(SSD1325_MASTERCONFIG); // Set Master Config DC/DC Converter
this->command(0x02); this->command(0x02);
this->command(SSD1325_SETREMAP); /* set segment remap------ */ this->command(SSD1325_SETREMAP); // set segment remapping
if (this->model_ == SSD1327_MODEL_128_128) if (this->model_ == SSD1327_MODEL_128_128)
this->command(0x55); // 0x56 is flipped horizontally: enable column swap, disable nibble remap this->command(0x53); // COM bottom-up, split odd/even, enable column and nibble remapping
else else
this->command(0x56); this->command(0x50); // COM bottom-up, split odd/even
this->command(SSD1325_SETCURRENT + 0x2); /* Set Full Current Range */ this->command(SSD1325_SETCURRENT + 0x2); // Set Full Current Range
this->command(SSD1325_SETGRAYTABLE); this->command(SSD1325_SETGRAYTABLE);
// gamma ~2.2
if (this->model_ == SSD1327_MODEL_128_128) {
this->command(0);
this->command(1);
this->command(2);
this->command(3);
this->command(6);
this->command(8);
this->command(12);
this->command(16);
this->command(20);
this->command(26);
this->command(32);
this->command(39);
this->command(46);
this->command(54);
this->command(63);
} else {
this->command(0x01); this->command(0x01);
this->command(0x11); this->command(0x11);
this->command(0x22); this->command(0x22);
@ -76,8 +99,7 @@ void SSD1325::setup() {
this->command(0x54); this->command(0x54);
this->command(0x65); this->command(0x65);
this->command(0x76); this->command(0x76);
this->command(SSD1325_SETCONTRAST); /* set contrast current */ }
this->command(0x7F); // max!
this->command(SSD1325_SETROWPERIOD); this->command(SSD1325_SETROWPERIOD);
this->command(0x51); this->command(0x51);
this->command(SSD1325_SETPHASELEN); this->command(SSD1325_SETPHASELEN);
@ -87,22 +109,25 @@ void SSD1325::setup() {
this->command(SSD1325_SETPRECHARGECOMPENABLE); this->command(SSD1325_SETPRECHARGECOMPENABLE);
this->command(0x28); this->command(0x28);
this->command(SSD1325_SETVCOMLEVEL); // Set High Voltage Level of COM Pin this->command(SSD1325_SETVCOMLEVEL); // Set High Voltage Level of COM Pin
this->command(0x1C); //? this->command(0x1C);
this->command(SSD1325_SETVSL); // set Low Voltage Level of SEG Pin this->command(SSD1325_SETVSL); // set Low Voltage Level of SEG Pin
this->command(0x0D | 0x02); this->command(0x0D | 0x02);
this->command(SSD1325_NORMALDISPLAY); /* set display mode */ this->command(SSD1325_NORMALDISPLAY); // set display mode
this->command(SSD1325_DISPLAYON); /* display ON */ set_brightness(this->brightness_);
this->fill(BLACK); // clear display - ensures we do not see garbage at power-on
this->display(); // ...write buffer, which actually clears the display's memory
this->turn_on(); // display ON
} }
void SSD1325::display() { void SSD1325::display() {
this->command(SSD1325_SETCOLADDR); /* set column address */ this->command(SSD1325_SETCOLADDR); // set column address
this->command(0x00); /* set column start address */ this->command(0x00); // set column start address
this->command(0x3F); /* set column end address */ this->command(0x3F); // set column end address
this->command(SSD1325_SETROWADDR); /* set row address */ this->command(SSD1325_SETROWADDR); // set row address
this->command(0x00); /* set row start address */ this->command(0x00); // set row start address
if (this->model_ == SSD1327_MODEL_128_128) if (this->model_ == SSD1327_MODEL_128_128)
this->command(0x7F); // 127 is last row this->command(127); // set last row
else else
this->command(0x3F); // 63 is last row this->command(63); // set last row
this->write_display_data(); this->write_display_data();
} }
@ -110,6 +135,27 @@ void SSD1325::update() {
this->do_update_(); this->do_update_();
this->display(); this->display();
} }
void SSD1325::set_brightness(float brightness) {
// validation
if (brightness > 1)
this->brightness_ = 1.0;
else if (brightness < 0)
this->brightness_ = 0;
else
this->brightness_ = brightness;
// now write the new brightness level to the display
this->command(SSD1325_SETCONTRAST);
this->command(int(SSD1325_MAX_CONTRAST * (this->brightness_)));
}
bool SSD1325::is_on() { return this->is_on_; }
void SSD1325::turn_on() {
this->command(SSD1325_DISPLAYON);
this->is_on_ = true;
}
void SSD1325::turn_off() {
this->command(SSD1325_DISPLAYOFF);
this->is_on_ = false;
}
int SSD1325::get_height_internal() { int SSD1325::get_height_internal() {
switch (this->model_) { switch (this->model_) {
case SSD1325_MODEL_128_32: case SSD1325_MODEL_128_32:
@ -141,23 +187,25 @@ int SSD1325::get_width_internal() {
} }
} }
size_t SSD1325::get_buffer_length_() { size_t SSD1325::get_buffer_length_() {
return size_t(this->get_width_internal()) * size_t(this->get_height_internal()) / 8u; return size_t(this->get_width_internal()) * size_t(this->get_height_internal()) / SSD1325_PIXELSPERBYTE;
} }
void HOT SSD1325::draw_absolute_pixel_internal(int x, int y, Color color) { void HOT SSD1325::draw_absolute_pixel_internal(int x, int y, Color color) {
if (x >= this->get_width_internal() || x < 0 || y >= this->get_height_internal() || y < 0) if (x >= this->get_width_internal() || x < 0 || y >= this->get_height_internal() || y < 0)
return; return;
uint32_t color4 = color.to_grayscale4();
uint16_t pos = x + (y / 8) * this->get_width_internal(); // where should the bits go in the big buffer array? math...
uint8_t subpos = y % 8; uint16_t pos = (x / SSD1325_PIXELSPERBYTE) + (y * this->get_width_internal() / SSD1325_PIXELSPERBYTE);
if (color.is_on()) { uint8_t shift = (x % SSD1325_PIXELSPERBYTE) * SSD1325_COLORSHIFT;
this->buffer_[pos] |= (1 << subpos); // ensure 'color4' is valid (only 4 bits aka 1 nibble) and shift the bits left when necessary
} else { color4 = (color4 & SSD1325_COLORMASK) << shift;
this->buffer_[pos] &= ~(1 << subpos); // first mask off the nibble we must change...
} this->buffer_[pos] &= (~SSD1325_COLORMASK >> shift);
// ...then lay the new nibble back on top. done!
this->buffer_[pos] |= color4;
} }
void SSD1325::fill(Color color) { void SSD1325::fill(Color color) {
uint8_t fill = color.is_on() ? 0xFF : 0x00; const uint32_t color4 = color.to_grayscale4();
uint8_t fill = (color4 & SSD1325_COLORMASK) | ((color4 & SSD1325_COLORMASK) << SSD1325_COLORSHIFT);
for (uint32_t i = 0; i < this->get_buffer_length_(); i++) for (uint32_t i = 0; i < this->get_buffer_length_(); i++)
this->buffer_[i] = fill; this->buffer_[i] = fill;
} }

View file

@ -26,6 +26,11 @@ class SSD1325 : public PollingComponent, public display::DisplayBuffer {
void set_model(SSD1325Model model) { this->model_ = model; } void set_model(SSD1325Model model) { this->model_ = model; }
void set_reset_pin(GPIOPin *reset_pin) { this->reset_pin_ = reset_pin; } void set_reset_pin(GPIOPin *reset_pin) { this->reset_pin_ = reset_pin; }
void set_external_vcc(bool external_vcc) { this->external_vcc_ = external_vcc; } void set_external_vcc(bool external_vcc) { this->external_vcc_ = external_vcc; }
void init_brightness(float brightness) { this->brightness_ = brightness; }
void set_brightness(float brightness);
bool is_on();
void turn_on();
void turn_off();
float get_setup_priority() const override { return setup_priority::PROCESSOR; } float get_setup_priority() const override { return setup_priority::PROCESSOR; }
void fill(Color color) override; void fill(Color color) override;
@ -45,6 +50,8 @@ class SSD1325 : public PollingComponent, public display::DisplayBuffer {
SSD1325Model model_{SSD1325_MODEL_128_64}; SSD1325Model model_{SSD1325_MODEL_128_64};
GPIOPin *reset_pin_{nullptr}; GPIOPin *reset_pin_{nullptr};
bool external_vcc_{false}; bool external_vcc_{false};
bool is_on_{false};
float brightness_{1.0};
}; };
} // namespace ssd1325_base } // namespace ssd1325_base

View file

@ -19,7 +19,7 @@ CONFIG_SCHEMA = cv.All(ssd1325_base.SSD1325_SCHEMA.extend({
def to_code(config): def to_code(config):
var = cg.new_Pvariable(config[CONF_ID]) var = cg.new_Pvariable(config[CONF_ID])
yield ssd1325_base.setup_ssd1036(var, config) yield ssd1325_base.setup_ssd1325(var, config)
yield spi.register_spi_device(var, config) yield spi.register_spi_device(var, config)
dc = yield cg.gpio_pin_expression(config[CONF_DC_PIN]) dc = yield cg.gpio_pin_expression(config[CONF_DC_PIN])

View file

@ -21,9 +21,11 @@ void SPISSD1325::setup() {
void SPISSD1325::dump_config() { void SPISSD1325::dump_config() {
LOG_DISPLAY("", "SPI SSD1325", this); LOG_DISPLAY("", "SPI SSD1325", this);
ESP_LOGCONFIG(TAG, " Model: %s", this->model_str_()); ESP_LOGCONFIG(TAG, " Model: %s", this->model_str_());
if (this->cs_)
LOG_PIN(" CS Pin: ", this->cs_); LOG_PIN(" CS Pin: ", this->cs_);
LOG_PIN(" DC Pin: ", this->dc_pin_); LOG_PIN(" DC Pin: ", this->dc_pin_);
LOG_PIN(" Reset Pin: ", this->reset_pin_); LOG_PIN(" Reset Pin: ", this->reset_pin_);
ESP_LOGCONFIG(TAG, " Initial Brightness: %.2f", this->brightness_);
ESP_LOGCONFIG(TAG, " External VCC: %s", YESNO(this->external_vcc_)); ESP_LOGCONFIG(TAG, " External VCC: %s", YESNO(this->external_vcc_));
LOG_UPDATE_INTERVAL(this); LOG_UPDATE_INTERVAL(this);
} }
@ -48,20 +50,7 @@ void HOT SPISSD1325::write_display_data() {
this->cs_->digital_write(false); this->cs_->digital_write(false);
delay(1); delay(1);
this->enable(); this->enable();
for (uint16_t x = 0; x < this->get_width_internal(); x += 2) { this->write_array(this->buffer_, this->get_buffer_length_());
for (uint16_t y = 0; y < this->get_height_internal(); y += 8) { // we write 8 pixels at once
uint8_t left8 = this->buffer_[y * 16 + x];
uint8_t right8 = this->buffer_[y * 16 + x + 1];
for (uint8_t p = 0; p < 8; p++) {
uint8_t d = 0;
if (left8 & (1 << p))
d |= 0xF0;
if (right8 & (1 << p))
d |= 0x0F;
this->write_byte(d);
}
}
}
if (this->cs_) if (this->cs_)
this->cs_->digital_write(true); this->cs_->digital_write(true);
this->disable(); this->disable();