ws2812

package

v0.27.0 Latest Latest Go to latest Published: Feb 26, 2024 License: BSD-3-Clause Imports: 3 Imported by: 93

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

Package ws2812 implements a driver for WS2812 and SK6812 RGB LED strips.

This section is empty.

This section is empty.

This section is empty.

type Device struct {
	Pin machine.Pin
	// contains filtered or unexported fields
}

Device wraps a pin object for an easy driver interface.

func New(pin machine.Pin) Device

deprecated, use NewWS2812 or NewSK6812 depending on which device you want. calls NewWS2812() to avoid breaking everyone's existing code.

func NewSK6812(pin machine.Pin) Device

New returns a new SK6812(RGBA) driver. It does not touch the pin object: you have to configure it as an output pin before calling New.

func NewWS2812(pin machine.Pin) Device

New returns a new WS2812(RGB) driver. It does not touch the pin object: you have to configure it as an output pin before calling New.

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

Write the raw bitstring out using the WS2812 protocol.

func (d Device) WriteByte(c byte) error

Send a single byte using the WS2812 protocol.

func (d Device) WriteColors(buf []color.RGBA) (err error)

Write the given color slice out using the WS2812 protocol. Colors are sent out in the usual GRB(A) format.