index :: hw

hw.rpi.spi.ws2812

ws2812 LED strip driver for Raspberry Pi

available since version: 0.9.8

---

information

Note: you should flush (with bang or [flush( message) after almost all pixel/color operations

methods:

• brightness set pixel brightness
  parameters:
  • LEVEL brightness level
    type: int
    required: True
    

• clear turn off all pixels
  

• fill fill all pixels with the RGB color
  parameters:

  • R red color component
    type: int
    required: True
    

  • G greed color component
    type: int
    required: True
    

  • B blue color component
    type: int
    required: True
    

• flush flush all pixels to the strip
  

• fx apply color generator function
  parameters:

  • NAME function name
    type: symbol
    required: True
    

  • [ARG] function param
    type: float
    

  • [BEGIN] range start
    type: int
    

  • [LENGTH] range length
    type: int
    

• rotate shift all pixel by specified amount
  parameters:
  • SHIFT shift amount
    type: int
    required: True
    
• set set single pixel color
  parameters:

  • R red color component
    type: int
    required: True
    

  • G greed color component
    type: int
    required: True
    

  • B blue color component
    type: int
    required: True
    

• set_range set pixel range to the specified color
  parameters:

  • BEGIN range start
    type: int
    required: True
    

  • LENGTH range length
    type: int
    required: True
    

  • R red color component
    type: int
    required: True
    

  • G greed color component
    type: int
    required: True
    

  • B blue color component
    type: int
    required: True
    

• set_slice set pixel slice to the specified color
  parameters:

  • BEGIN range start
    type: int
    required: True
    

  • END range end
    type: int
    required: True
    

  • STEP slice step
    type: int
    required: True
    

  • R red color component
    type: int
    required: True
    

  • G greed color component
    type: int
    required: True
    

  • B blue color component
    type: int
    required: True
    

properties:

• @clear Get/set turn off all pixels when the object is deleted
  type: bool
  default: 1
  

• @size (initonly) Get/set number of leds in the strip
  type: int
  range: 1..4096
  default: 16
  

• @spi_bus (initonly) Get/set spi bus number
  type: int
  range: -1..6
  default: -1
  

• @spi_cs (initonly) Get/set spi CS (chip select/enable). In most cases you don't need to set this property, because LED strips are not using CS pin.
  type: int
  range: 0..3
  default: 0
  

inlets:

• flush pixels to the strip
  type: control

outlets:

• no output
  type: control

keywords:

display neopixel rpi ws2812 led

Authors: Serge Poltavsky

License: GPL3 or later