embedded
/
devices
mirror of https://github.com/periph/devices
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Address the initial review comments

Browse Source
pull/55/head
Çağlar Onur 3 years ago committed by Çağlar Onur
parent 8c02fb687a
commit f2d8384275
No known key found for this signature in database
GPG Key ID: 97DC0A9223E81DE4
5 changed files with 101 additions and 98 deletions
Show Stats Download Patch File Download Diff File

2
inky/example_test.go
Unescape Escape View File

@ -60,7 +60,7 @@ func Example() {
} }
} }
func ExampleImpression() { func ExampleNewImpression() {
path := flag.String("image", "", "Path to image file (600x448) to display") path := flag.String("image", "", "Path to image file (600x448) to display")
flag.Parse() flag.Parse()

100
inky/impression.go
Unescape Escape View File

@ -50,34 +50,34 @@ var (
) )
const ( const (
UC8159PSR = 0x00 uc8159PSR = 0x00
UC8159PWR = 0x01 uc8159PWR = 0x01
UC8159POF = 0x02 uc8159POF = 0x02
UC8159PFS = 0x03 uc8159PFS = 0x03
UC8159PON = 0x04 uc8159PON = 0x04
UC8159BTST = 0x06 uc8159BTST = 0x06
UC8159DSLP = 0x07 uc8159DSLP = 0x07
UC8159DTM1 = 0x10 uc8159DTM1 = 0x10
UC8159DSP = 0x11 uc8159DSP = 0x11
UC8159DRF = 0x12 uc8159DRF = 0x12
UC8159IPC = 0x13 uc8159IPC = 0x13
UC8159PLL = 0x30 uc8159PLL = 0x30
UC8159TSC = 0x40 uc8159TSC = 0x40
UC8159TSE = 0x41 uc8159TSE = 0x41
UC8159TSW = 0x42 uc8159TSW = 0x42
UC8159TSR = 0x43 uc8159TSR = 0x43
UC8159CDI = 0x50 uc8159CDI = 0x50
UC8159LPD = 0x51 uc8159LPD = 0x51
UC8159TCON = 0x60 uc8159TCON = 0x60
UC8159TRES = 0x61 uc8159TRES = 0x61
UC8159DAM = 0x65 uc8159DAM = 0x65
UC8159REV = 0x70 uc8159REV = 0x70
UC8159FLG = 0x71 uc8159FLG = 0x71
UC8159AMV = 0x80 uc8159AMV = 0x80
UC8159VV = 0x81 uc8159VV = 0x81
UC8159VDCS = 0x82 uc8159VDCS = 0x82
UC8159PWS = 0xE3 uc8159PWS = 0xE3
UC8159TSSET = 0xE5 uc8159TSSET = 0xE5
) )
// DevImpression is a handle to an Inky Impression. // DevImpression is a handle to an Inky Impression.
@ -90,7 +90,7 @@ type DevImpression struct {
Pix []uint8 Pix []uint8
// Saturation level used by the color palette. // Saturation level used by the color palette.
saturation float64 saturation uint
// Resolution magic number used for resetting the panel. // Resolution magic number used for resetting the panel.
res int res int
} }
@ -101,7 +101,7 @@ func NewImpression(p spi.Port, dc gpio.PinOut, reset gpio.PinOut, busy gpio.PinI
return nil, fmt.Errorf("unsupported color: %v", o.ModelColor) return nil, fmt.Errorf("unsupported color: %v", o.ModelColor)
} }
c, err := p.Connect(3000*physic.KiloHertz, spi.Mode0, CS0Pin) c, err := p.Connect(3000*physic.KiloHertz, spi.Mode0, cs0Pin)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to connect to inky over spi: %v", err) return nil, fmt.Errorf("failed to connect to inky over spi: %v", err)
} }
@ -128,7 +128,7 @@ func NewImpression(p spi.Port, dc gpio.PinOut, reset gpio.PinOut, busy gpio.PinI
model: o.Model, model: o.Model,
variant: o.DisplayVariant, variant: o.DisplayVariant,
}, },
saturation: 0.5, // Looks good enough for most of the images. saturation: 50, // Looks good enough for most of the images.
} }
switch o.Model { switch o.Model {
@ -155,7 +155,7 @@ func NewImpression(p spi.Port, dc gpio.PinOut, reset gpio.PinOut, busy gpio.PinI
// blend recalculates the palette based on the saturation level. // blend recalculates the palette based on the saturation level.
func (d *DevImpression) blend() []color.Color { func (d *DevImpression) blend() []color.Color {
sat := d.saturation sat := float64(d.saturation / 100)
pr := []color.Color{} pr := []color.Color{}
for i := 0; i < 7; i++ { for i := 0; i < 7; i++ {
@ -176,14 +176,14 @@ func (d *DevImpression) blend() []color.Color {
} }
// Saturation returns the current saturation level. // Saturation returns the current saturation level.
func (d *DevImpression) Saturation() float64 { func (d *DevImpression) Saturation() uint {
return d.saturation return d.saturation
} }
// SetSaturaton changes the saturation level. This will not take effect until the next Draw(). // SetSaturaton changes the saturation level. This will not take effect until the next Draw().
func (d *DevImpression) SetSaturation(level float64) error { func (d *DevImpression) SetSaturation(level uint) error {
if level < 0 && level > 1 { if level > 100 {
return fmt.Errorf("saturation level needs to be between 0 and 1") return fmt.Errorf("saturation level needs to be between 0 and 100")
} }
d.saturation = level d.saturation = level
// so that caller can recalculate next time they need it. // so that caller can recalculate next time they need it.
@ -244,7 +244,7 @@ func (d *DevImpression) reset() error {
binary.LittleEndian.PutUint16(tres[0:], uint16(d.width)) binary.LittleEndian.PutUint16(tres[0:], uint16(d.width))
binary.LittleEndian.PutUint16(tres[2:], uint16(d.height)) binary.LittleEndian.PutUint16(tres[2:], uint16(d.height))
if err := d.sendCommand(UC8159TRES, tres); err != nil { if err := d.sendCommand(uc8159TRES, tres); err != nil {
return err return err
} }
@ -259,7 +259,7 @@ func (d *DevImpression) reset() error {
// 0b11 = 600x448 // 0b11 = 600x448
// 0b10 = 640x400 // 0b10 = 640x400
if err := d.sendCommand( if err := d.sendCommand(
UC8159PSR, uc8159PSR,
[]byte{ []byte{
byte(d.res<<6) | 0b101111, // See above for more magic numbers byte(d.res<<6) | 0b101111, // See above for more magic numbers
0x08, // display_colours == UC81597C 0x08, // display_colours == UC81597C
@ -269,7 +269,7 @@ func (d *DevImpression) reset() error {
// Power Settings // Power Settings
if err := d.sendCommand( if err := d.sendCommand(
UC8159PWR, uc8159PWR,
[]byte{ []byte{
(0x06 << 3) | // ??? - not documented in UC8159 datasheet (0x06 << 3) | // ??? - not documented in UC8159 datasheet
(0x01 << 2) | // SOURCE_INTERNAL_DC_DC (0x01 << 2) | // SOURCE_INTERNAL_DC_DC
@ -289,12 +289,12 @@ func (d *DevImpression) reset() error {
// PLL = 2MHz * (M / N) // PLL = 2MHz * (M / N)
// PLL = 2MHz * (7 / 4) // PLL = 2MHz * (7 / 4)
// PLL = 2,800,000 ??? // PLL = 2,800,000 ???
if err := d.sendCommand(UC8159PLL, []byte{0x3C}); err != nil { if err := d.sendCommand(uc8159PLL, []byte{0x3C}); err != nil {
return err return err
} }
// 0b00111100 // 0b00111100
// Send the TSE register to the display // Send the TSE register to the display
if err := d.sendCommand(UC8159TSE, []byte{0x00}); err != nil { // Color if err := d.sendCommand(uc8159TSE, []byte{0x00}); err != nil { // Color
return err return err
} }
// VCOM and Data Interval setting // VCOM and Data Interval setting
@ -304,31 +304,31 @@ func (d *DevImpression) reset() error {
cdi := make([]byte, 2) cdi := make([]byte, 2)
binary.LittleEndian.PutUint16(cdi[0:], uint16(d.border<<5)|0x17) // 0b00110111 binary.LittleEndian.PutUint16(cdi[0:], uint16(d.border<<5)|0x17) // 0b00110111
if err := d.sendCommand(UC8159CDI, cdi); err != nil { if err := d.sendCommand(uc8159CDI, cdi); err != nil {
return err return err
} }
// Gate/Source non-overlap period // Gate/Source non-overlap period
// 0b11110000 = Source to Gate (0b0010 = 12nS, default) // 0b11110000 = Source to Gate (0b0010 = 12nS, default)
// 0b00001111 = Gate to Source // 0b00001111 = Gate to Source
if err := d.sendCommand(UC8159TCON, []byte{0x22}); err != nil { // 0b00100010 if err := d.sendCommand(uc8159TCON, []byte{0x22}); err != nil { // 0b00100010
return err return err
} }
// Disable external flash // Disable external flash
if err := d.sendCommand(UC8159DAM, []byte{0x00}); err != nil { if err := d.sendCommand(uc8159DAM, []byte{0x00}); err != nil {
return err return err
} }
// UC81597C // UC81597C
if err := d.sendCommand(UC8159PWS, []byte{0xAA}); err != nil { if err := d.sendCommand(uc8159PWS, []byte{0xAA}); err != nil {
return err return err
} }
// Power off sequence // Power off sequence
// 0b00110000 = power off sequence of VDH and VDL, 0b00 = 1 frame (default) // 0b00110000 = power off sequence of VDH and VDL, 0b00 = 1 frame (default)
// All other bits ignored? // All other bits ignored?
if err := d.sendCommand(UC8159PFS, []byte{0x00}); err != nil { // PFS_1_FRAME if err := d.sendCommand(uc8159PFS, []byte{0x00}); err != nil { // PFS_1_FRAME
return err return err
} }
@ -340,21 +340,21 @@ func (d *DevImpression) update(pix []uint8) error {
return err return err
} }
if err := d.sendCommand(UC8159DTM1, pix); err != nil { if err := d.sendCommand(uc8159DTM1, pix); err != nil {
return err return err
} }
if err := d.sendCommand(UC8159PON, nil); err != nil { if err := d.sendCommand(uc8159PON, nil); err != nil {
return err return err
} }
d.wait(200 * time.Millisecond) d.wait(200 * time.Millisecond)
if err := d.sendCommand(UC8159DRF, nil); err != nil { if err := d.sendCommand(uc8159DRF, nil); err != nil {
return err return err
} }
d.wait(32 * time.Second) d.wait(32 * time.Second)
if err := d.sendCommand(UC8159POF, nil); err != nil { if err := d.sendCommand(uc8159POF, nil); err != nil {
return err return err
} }
d.wait(200 * time.Millisecond) d.wait(200 * time.Millisecond)

21
inky/inky.go
Unescape Escape View File

@ -22,7 +22,7 @@ var _ display.Drawer = &Dev{}
var _ conn.Resource = &Dev{} var _ conn.Resource = &Dev{}
const ( const (
CS0Pin = 8 cs0Pin = 8
) )
var borderColor = map[Color]byte{ var borderColor = map[Color]byte{
@ -62,7 +62,9 @@ type Dev struct {
// Model being used. // Model being used.
model Model model Model
// Variant of the panel. // Variant of the panel.
variant int variant uint
// PCB Variant of the panel. Represents a version string as a number (12 -> 1.2).
pcbVariant uint
} }
// New opens a handle to an Inky pHAT or wHAT. // New opens a handle to an Inky pHAT or wHAT.
@ -71,7 +73,7 @@ func New(p spi.Port, dc gpio.PinOut, reset gpio.PinOut, busy gpio.PinIn, o *Opts
return nil, fmt.Errorf("unsupported color: %v", o.ModelColor) return nil, fmt.Errorf("unsupported color: %v", o.ModelColor)
} }
c, err := p.Connect(488*physic.KiloHertz, spi.Mode0, CS0Pin) c, err := p.Connect(488*physic.KiloHertz, spi.Mode0, cs0Pin)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to connect to inky over spi: %v", err) return nil, fmt.Errorf("failed to connect to inky over spi: %v", err)
} }
@ -96,6 +98,7 @@ func New(p spi.Port, dc gpio.PinOut, reset gpio.PinOut, busy gpio.PinIn, o *Opts
border: o.BorderColor, border: o.BorderColor,
model: o.Model, model: o.Model,
variant: o.DisplayVariant, variant: o.DisplayVariant,
pcbVariant: o.PCBVariant,
} }
switch o.Model { switch o.Model {
@ -137,9 +140,9 @@ func (d *Dev) SetModelColor(c Color) error {
// String implements conn.Resource. // String implements conn.Resource.
func (d *Dev) String() string { func (d *Dev) String() string {
v, ok := displayVariantMap[d.variant] index := int(d.variant)
if ok { if index < len(displayVariantMap) {
return v return displayVariantMap[index]
} }
return "Inky pHAT" return "Inky pHAT"
} }
@ -152,17 +155,17 @@ func (d *Dev) Width() int {
return d.width return d.width
} }
// SetBorder changes the border color. This will not take effect until the next Draw(). // SetFlipVertically flips the image horizontally.
func (d *Dev) SetFlipVertically(f bool) { func (d *Dev) SetFlipVertically(f bool) {
d.flipVertically = f d.flipVertically = f
} }
// SetBorder changes the border color. This will not take effect until the next Draw(). // SetFlipHorizontally flips the image horizontally.
func (d *Dev) SetFlipHorizontally(f bool) { func (d *Dev) SetFlipHorizontally(f bool) {
d.flipHorizontally = f d.flipHorizontally = f
} }
// Halt implements conn.Resource // Halt implements conn.Resource.
func (d *Dev) Halt() error { func (d *Dev) Halt() error {
return nil return nil
} }

52
inky/opts.go
Unescape Escape View File

@ -12,27 +12,27 @@ import (
) )
var ( var (
displayVariantMap = map[int]string{ displayVariantMap = []string{
0: "", "",
1: "Red pHAT (High-Temp)", "Red pHAT (High-Temp)",
2: "Yellow wHAT", "Yellow wHAT",
3: "Black wHAT", "Black wHAT",
4: "Black pHAT", "Black pHAT",
5: "Yellow pHAT", "Yellow pHAT",
6: "Red wHAT", "Red wHAT",
7: "Red wHAT (High-Temp)", "Red wHAT (High-Temp)",
8: "Red wHAT", "Red wHAT",
9: "", "",
10: "Black pHAT (SSD1608)", "Black pHAT (SSD1608)",
11: "Red pHAT (SSD1608)", "Red pHAT (SSD1608)",
12: "Yellow pHAT (SSD1608)", "Yellow pHAT (SSD1608)",
13: "", "",
14: "7-Colour (UC8159)", "7-Colour (UC8159)",
15: "7-Colour 640x400 (UC8159)", "7-Colour 640x400 (UC8159)",
16: "7-Colour 640x400 (UC8159)", "7-Colour 640x400 (UC8159)",
17: "Black wHAT (SSD1683)", "Black wHAT (SSD1683)",
18: "Red wHAT (SSD1683)", "Red wHAT (SSD1683)",
19: "Yellow wHAT (SSD1683)", "Yellow wHAT (SSD1683)",
} }
) )
@ -51,8 +51,8 @@ type Opts struct {
BorderColor Color BorderColor Color
// Board information. // Board information.
PCBVariant float64 PCBVariant uint
DisplayVariant int DisplayVariant uint
} }
// DetectOpts tries to read the device opts from EEPROM. // DetectOpts tries to read the device opts from EEPROM.
@ -83,8 +83,8 @@ func DetectOpts(bus i2c.Bus) (*Opts, error) {
default: default:
return nil, fmt.Errorf("failed to get ops: color %v not supported", data[4]) return nil, fmt.Errorf("failed to get ops: color %v not supported", data[4])
} }
// PCB Variant is stored as a number in the eeprom but is actually corresponds a version string (12 -> 1.2)
options.PCBVariant = float64(data[5] / 10.0) options.PCBVariant = uint(data[5])
switch data[6] { switch data[6] {
case 1, 4, 5: case 1, 4, 5:
@ -101,7 +101,7 @@ func DetectOpts(bus i2c.Bus) (*Opts, error) {
return nil, fmt.Errorf("failed to get ops: display type %v not supported", data[6]) return nil, fmt.Errorf("failed to get ops: display type %v not supported", data[6])
} }
options.DisplayVariant = int(data[6]) options.DisplayVariant = uint(data[6])
return options, nil return options, nil
} }

6
inky/types.go
Unescape Escape View File

@ -1,9 +1,9 @@
// Copyright 2023 The Periph Authors. All rights reserved. // Copyright 2023 The Periph Authors. All rights reserved.
// Use of this source code is governed under the Apache License, Version 2.0 // Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file. // that can be found in the LICENSE file.
package inky
//go:generate stringer -type=Model,Color,ImpressionColor -output types_string.go //go:generate stringer -type=Model,Color,ImpressionColor -output types_string.go
package inky
import ( import (
"fmt" "fmt"
@ -35,7 +35,7 @@ func (m *Model) Set(s string) error {
case "IMPRESSION57": case "IMPRESSION57":
*m = IMPRESSION57 *m = IMPRESSION57
default: default:
return fmt.Errorf("unknown model %q: expected either PHAT or WHAT", s) return fmt.Errorf("unknown model %q: expected PHAT, PHAT2, WHAT, IMPRESSION4 or IMPRESSION57", s)
} }
return nil return nil
} }
@ -65,7 +65,7 @@ func (c *Color) Set(s string) error {
case "white": case "white":
*c = White *c = White
default: default:
return fmt.Errorf("unknown color %q: expected either black, red, yellow, white or multi", s) return fmt.Errorf("unknown color %q: expected either black, red, yellow or white", s)
} }
return nil return nil
} }

Write Preview
Loading…
Cancel
Save