neopixel

import {NeoPixel} from 'mikro/neopixel'

Drive WS2812 (RGBRed, Green, Blue) and SK6812 (RGBWRed, Green, Blue, White) addressable LEDs.

Usage

import {NeoPixel} from 'mikro/neopixel'

const pixels = NeoPixel(8, {count: 24}).orPanic('Failed to set up the LED strip')

pixels.fill(255, 0, 0).orPanic('fill failed') // all red
pixels.show().orPanic('show failed') // push to hardware

pixels.setPixel(0, 0, 255, 0).orPanic('set failed') // first pixel green
pixels.show().orPanic('show failed')

pixels.clear().orPanic('clear failed') // all off
pixels.end() // release hardware

Functions

NeoPixel(gpio, options)

function NeoPixel(gpio: number, options: NeoPixelOptions): Result<NeoPixel, NeoPixelError>

Claims the GPIOGeneral-Purpose Input/Output pin connected to the data line and returns a Result with the handle. The pin must be able to drive a signal, or you get InvalidGpio. If another handle, a peripheral or the console holds it, you get GpioInUse.

Parameters:

• gpio: GPIOGeneral-Purpose Input/Output number of the pin connected to the data line
• options: see NeoPixelOptions

Methods

pixels.setPixel(index, r, g, b, w?)

setPixel(index: number, r: number, g: number, b: number, w?: number): Result<void, NeoPixelError>

Set a single pixel's color. Values are 0–255 per channel. The w parameter is only used with RGBWRed, Green, Blue, White LEDs.

pixels.fill(r, g, b, w?)

fill(r: number, g: number, b: number, w?: number): Result<void, NeoPixelError>

Set all pixels to the same color.

pixels.show()

show(): Result<void, NeoPixelError>

Transmit the pixel buffer to the pixels. Colors set via setPixel and fill are not visible until show() is called.

pixels.clear()

clear(): Result<void, NeoPixelError>

Turn off all pixels and transmit (equivalent to fill(0, 0, 0) + show()).

pixels.end()

end(): void

Release the RMT hardware channel and the GPIOGeneral-Purpose Input/Output pin. Calling it again does nothing. After end() the other methods do nothing and return ok(), and the first such call prints a warning. The handle keeps the hardware and its GPIOGeneral-Purpose Input/Output pin until you call end(), even when your code no longer refers to the handle.

Types

NeoPixelOptions

interface NeoPixelOptions {
  count: number // number of LEDs, 1 to 1024
  rgbw?: boolean // true for SK6812 RGBW LEDs (default: false)
}

Errors

NeoPixelError

Variant	Fields	Description
GpioInUse	owner, message	Another handle, peripheral or the console holds the pin
InvalidGpio	message	The chip has no such GPIOGeneral-Purpose Input/Output, or the GPIOGeneral-Purpose Input/Output cannot drive a signal
InvalidParam	message	count is out of range
ConfigFailed	message	ESP-IDFEspressif IoT Development Framework rejected the RMT configuration; message names the call and error code
IndexOutOfRange	—	Pixel index >= count
ShowFailed	message	Failed to transmit data

NeoPixel is a registered trademark of Adafruit Industries.