uc8151

package

v0.0.0-...-0087ba1 Latest Latest Go to latest Published: Dec 25, 2023 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/chiefMarlin/tinygo-drivers

Links

Open Source Insights

Documentation ¶

Overview ¶

Package uc8151 implements a driver for e-ink displays controlled by UC8151

Inspired by https://github.com/pimoroni/pimoroni-pico/blob/main/drivers/uc8151/uc8151.cpp Datasheet: https://www.buydisplay.com/download/ic/UC8151C.pdf

Index ¶

Constants
type Config
type Device
- func New(bus drivers.SPI, csPin, dcPin, rstPin, busyPin machine.Pin) Device
type Rotation
type Speed

Constants ¶

View Source

const (
	// Display resolution
	EPD_WIDTH  = 128
	EPD_HEIGHT = 296

	PSR      = 0x00
	PWR      = 0x01
	POF      = 0x02
	PFS      = 0x03
	PON      = 0x04
	PMES     = 0x05
	BTST     = 0x06
	DSLP     = 0x07
	DTM1     = 0x10
	DSP      = 0x11
	DRF      = 0x12
	DTM2     = 0x13
	LUT_VCOM = 0x20
	LUT_WW   = 0x21
	LUT_BW   = 0x22
	LUT_WB   = 0x23
	LUT_BB   = 0x24
	PLL      = 0x30
	TSC      = 0x40
	TSE      = 0x41
	TSR      = 0x43
	TSW      = 0x42
	CDI      = 0x50
	LPD      = 0x51
	TCON     = 0x60
	TRES     = 0x61
	REV      = 0x70
	FLG      = 0x71
	AMV      = 0x80
	VV       = 0x81
	VDCS     = 0x82
	PTL      = 0x90
	PTIN     = 0x91
	PTOU     = 0x92
	PGM      = 0xa0
	APG      = 0xa1
	ROTP     = 0xa2
	CCSET    = 0xe0
	PWS      = 0xe3
	TSSET    = 0xe5

	RES_96x230  = 0b00000000
	RES_96x252  = 0b01000000
	RES_128x296 = 0b10000000
	RES_160x296 = 0b11000000

	LUT_OTP = 0b00000000
	LUT_REG = 0b00100000

	FORMAT_BWR = 0b00000000
	FORMAT_BW  = 0b00010000

	SCAN_DOWN = 0b00000000
	SCAN_UP   = 0b00001000

	SHIFT_LEFT  = 0b00000000
	SHIFT_RIGHT = 0b00000100

	BOOSTER_OFF = 0b00000000
	BOOSTER_ON  = 0b00000010

	RESET_SOFT = 0b00000000
	RESET_NONE = 0b00000001

	VDS_EXTERNAL = 0b00000000
	VDS_INTERNAL = 0b00000010

	VDG_EXTERNAL = 0b00000000
	VDG_INTERNAL = 0b00000001

	VCOM_VD = 0b00000000
	VCOM_VG = 0b00000100

	VGHL_16V = 0b00000000
	VGHL_15V = 0b00000001
	VGHL_14V = 0b00000010
	VGHL_13V = 0b00000011

	START_10MS = 0b00000000
	START_20MS = 0b01000000
	START_30MS = 0b10000000
	START_40MS = 0b11000000

	STRENGTH_1 = 0b00000000
	STRENGTH_2 = 0b00001000
	STRENGTH_3 = 0b00010000
	STRENGTH_4 = 0b00011000
	STRENGTH_5 = 0b00100000
	STRENGTH_6 = 0b00101000
	STRENGTH_7 = 0b00110000
	STRENGTH_8 = 0b00111000

	OFF_0_27US = 0b00000000
	OFF_0_34US = 0b00000001
	OFF_0_40US = 0b00000010
	OFF_0_54US = 0b00000011
	OFF_0_80US = 0b00000100
	OFF_1_54US = 0b00000101
	OFF_3_34US = 0b00000110
	OFF_6_58US = 0b00000111

	FRAMES_1 = 0b00000000
	FRAMES_2 = 0b00010000
	FRAMES_3 = 0b00100000
	FRAMES_4 = 0b00110000

	TEMP_INTERNAL = 0b00000000
	TEMP_EXTERNAL = 0b10000000

	OFFSET_0 = 0b00000000
	OFFSET_1 = 0b00000001
	OFFSET_2 = 0b00000010
	OFFSET_3 = 0b00000011
	OFFSET_4 = 0b00000100
	OFFSET_5 = 0b00000101
	OFFSET_6 = 0b00000110
	OFFSET_7 = 0b00000111

	OFFSET_MIN_8 = 0b00001000
	OFFSET_MIN_7 = 0b00001001
	OFFSET_MIN_6 = 0b00001010
	OFFSET_MIN_5 = 0b00001011
	OFFSET_MIN_4 = 0b00001100
	OFFSET_MIN_3 = 0b00001101
	OFFSET_MIN_2 = 0b00001110
	OFFSET_MIN_1 = 0b00001111

	HZ_29  = 0b00111111
	HZ_33  = 0b00111110
	HZ_40  = 0b00111101
	HZ_50  = 0b00111100
	HZ_67  = 0b00111011
	HZ_100 = 0b00111010
	HZ_200 = 0b00111001

	NO_ROTATION  Rotation = 0
	ROTATION_90  Rotation = 1 // 90 degrees clock-wise rotation
	ROTATION_180 Rotation = 2
	ROTATION_270 Rotation = 3

	DEFAULT Speed = 0
	MEDIUM  Speed = 1
	FAST    Speed = 2
	TURBO   Speed = 3
)

Registers

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Width    int16
	Height   int16
	Rotation Rotation // Rotation is clock-wise
	Speed    Speed    // Value from DEFAULT, MEDIUM, FAST, TURBO
	Blocking bool
}

type Device ¶

type Device struct {
	// contains filtered or unexported fields
}

func New ¶

func New(bus drivers.SPI, csPin, dcPin, rstPin, busyPin machine.Pin) Device

New returns a new epd2in13x driver. Pass in a fully configured SPI bus.

func (*Device) ClearBuffer ¶

func (d *Device) ClearBuffer()

ClearBuffer sets the buffer to 0xFF (white)

func (*Device) ClearDisplay ¶

func (d *Device) ClearDisplay()

ClearDisplay erases the device SRAM

func (*Device) Configure ¶

func (d *Device) Configure(cfg Config)

Configure sets up the device.

func (*Device) Display ¶

func (d *Device) Display() error

Display sends the buffer to the screen.

func (*Device) DisplayRect ¶

func (d *Device) DisplayRect(x int16, y int16, width int16, height int16) error

DisplayRect sends only an area of the buffer to the screen. The rectangle points need to be a multiple of 8 in the screen. They might not work as expected if the screen is rotated.

func (*Device) Invert ¶

func (d *Device) Invert(invert bool)

Invert sets the display' invert mode

func (*Device) IsBusy ¶

func (d *Device) IsBusy() bool

IsBusy returns the busy status of the display

func (*Device) PowerOff ¶

func (d *Device) PowerOff()

PowerOff power off the device

func (*Device) Reset ¶

func (d *Device) Reset()

Reset resets the device

func (*Device) SendCommand ¶

func (d *Device) SendCommand(command uint8)

SendCommand sends a command to the display

func (*Device) SendData ¶

func (d *Device) SendData(data uint8)

SendData sends a data byte to the display

func (*Device) SetBlocking ¶

func (d *Device) SetBlocking(blocking bool)

SetBlocking changes the blocking flag of the device

func (*Device) SetLUT ¶

func (d *Device) SetLUT(speed Speed)

SetLUT sets the look up tables for full or partial updates

func (*Device) SetPixel ¶

func (d *Device) SetPixel(x int16, y int16, c color.RGBA)

SetPixel modifies the internal buffer in a single pixel. The display have 2 colors: black and white We use RGBA(0,0,0, 255) as white (transparent) Anything else as black

func (*Device) SetRotation ¶

func (d *Device) SetRotation(rotation Rotation)

SetRotation changes the rotation (clock-wise) of the device

func (*Device) SetSpeed ¶

func (d *Device) SetSpeed(speed Speed)

SetSpeed changes the refresh speed of the device (the display needs to re-configure)

func (*Device) Size ¶

func (d *Device) Size() (w, h int16)

Size returns the current size of the display.

func (*Device) WaitUntilIdle ¶

func (d *Device) WaitUntilIdle()

WaitUntilIdle waits until the display is ready

type Rotation ¶

type Rotation uint8

type Speed ¶

type Speed uint8

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL