Struct ssd1675::config::Builder

pub struct Builder<'a> { /* fields omitted */ }

Builder for constructing a display Config.

Dimensions must supplied, all other settings will use a default value if not supplied. However it's likely that LUT values will need to be supplied to successfully use a display.

Example

use ssd1675::{Builder, Dimensions, Rotation};

let config = Builder::new()
    .dimensions(Dimensions {
        rows: 212,
        cols: 104,
    })
    .rotation(Rotation::Rotate270)
    .build()
    .expect("invalid configuration");

Implementations

impl<'a> Builder<'a>

pub fn new() -> Self

Create a new Builder.

pub fn dummy_line_period(self, dummy_line_period: u8) -> Self

Set the number of dummy line period in terms of gate line width (TGate).

Defaults to 0x07. Corresponds to command 0x3A.

pub fn gate_line_width(self, gate_line_width: u8) -> Self

Set the gate line width (TGate).

Defaults to 0x04. Corresponds to command 0x3B.

pub fn vcom(self, value: u8) -> Self

Set VCOM register value.

Defaults to 0x3C. Corresponds to command 0x2C.

pub fn lut(self, lut: &'a [u8]) -> Self

Set lookup table (70 bytes).

Note: The supplied slice must be exactly 70 bytes long.

There is no default for the lookup table. Corresponds to command 0x32. If not supplied then the default in the controller is used. Apparently the display manufacturer will normally supply the LUT values for a particular display batch.

pub fn data_entry_mode(
    self,
    data_entry_mode: DataEntryMode,
    increment_axis: IncrementAxis
) -> Self

Define data entry sequence.

Defaults to DataEntryMode::IncrementAxis, IncrementAxis::Horizontal. Corresponds to command 0x11.

pub fn dimensions(self, dimensions: Dimensions) -> Self

Set the display dimensions.

There is no default for this setting. The dimensions must be set for the builder to successfully build a Config.

pub fn rotation(self, rotation: Rotation) -> Self

Set the display rotation.

Defaults to no rotation (Rotation::Rotate0). Use this to translate between the physical rotation of the display and how the data is displayed on the display.

pub fn build(self) -> Result<Config<'a>, BuilderError>

Build the display Config.

Will fail if dimensions are not set.

Trait Implementations

impl<'a> Default for Builder<'a>

fn default() -> Self

Returns the "default value" for a type.