apa102

Documentation

Overview

Package apa102 implements a driver for the APA102 SPI LED.

Datasheet: https://cdn-shop.adafruit.com/product-files/2343/APA102C.pdf

Index

• Constants
• type Device
  • func New(b drivers.SPI) *Device
  • func NewSoftwareSPI(sckPin, sdoPin machine.Pin, delay uint32) *Device
  • func (d *Device) Write(buf []byte) (n int, err error)
  • func (d *Device) WriteColors(cs []color.RGBA) (n int, err error)

Constants

const (
	// BGR aka "Blue Green Red" is the current APA102 LED color order.
	BGR = iota

	// BRG aka "Blue Red Green" is the typical APA102 color order from 2015-2017.
	BRG

	// GRB aka "Green Red Blue" is the typical APA102 color order from pre-2015.
	GRB
)

Types

type Device

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

Device wraps APA102 SPI LEDs.

func New

func New(b drivers.SPI) *Device

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

func NewSoftwareSPI

func NewSoftwareSPI(sckPin, sdoPin machine.Pin, delay uint32) *Device

NewSoftwareSPI returns a new APA102 driver that will use a software based implementation of the SPI protocol.

func (*Device) Write

func (d *Device) Write(buf []byte) (n int, err error)

Write the raw bytes using the APA102 protocol.

func (*Device) WriteColors

func (d *Device) WriteColors(cs []color.RGBA) (n int, err error)

WriteColors writes the given RGBA color slice out using the APA102 protocol. The A value (Alpha channel) is used for brightness, set to 0xff (255) for maximum.