You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

readme.md 2.0KB

7 years ago
7 years ago
7 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142
  1. # WS2812Serial - Non-Blocking WS2812B / NeoPixel LEDs Library
  2. Similar to [OctoWS2811](https://www.pjrc.com/teensy/td_libs_OctoWS2811.html), this library
  3. allows you to use WS2811, WS2812, WS2812B / NeoPixel LEDs without blocking interrupts.
  4. ![](ws2812serial.jpg)
  5. Non-blocking allows other libraries, especially
  6. [Audio](https://www.pjrc.com/teensy/td_libs_Audio.html) and high speed serial communication
  7. to function properly while the LEDs update. Complex animation can also run faster,
  8. because the show() function does not wait for the LEDs to update, allowing your code
  9. more time to draw the next frame.
  10. ## Hardware Resources Used
  11. WS2812Serial controls a single LED strip, using only 1 pin. While any number of
  12. LEDs may be connected, in practice 1 pin is best for small projects with less
  13. than 600 LEDs. OctoWS2811 offers 8 parallel outputs for large projects.
  14. Non-blocking performance does come with a cost. 15 bytes of memory are required
  15. per LED, rather than the usual 3 bytes with [FastLED](http://fastled.io/) or
  16. [Adafruit NeoPixel](https://github.com/adafruit/Adafruit_NeoPixel). One of
  17. the [hardware serial ports](https://www.pjrc.com/teensy/td_uart.html) is also
  18. used to transmit the data, making that port unavailable for other uses.
  19. ## Supported Pins & Serial Ports
  20. | Port | Teensy LC | Teensy 3.2 | Teensy 3.5 | Teensy 3.6 |
  21. | :------ | :---------: | :--------: | :--------: | :--------: |
  22. | Serial1 | 1, 4, 5, 24 | 1, 5 | 1, 5, 26 | 1, 5, 26 |
  23. | Serial2 | | 10, 31 | 10 | 10 |
  24. | Serial3 | | 8, 20 | 8, 20 | 8, 20 |
  25. | Serial4 | | | 32 | 32 |
  26. | Serial5 | | | 33 | 33 |
  27. | Serial6 | | | 48 | |
  28. Serial2 & Serial3 on Teensy LC are not supported, due to lack of configurable
  29. oversampling needed to run at the high speed required.
  30. Serial6 on Teensy 3.6 is not currently supported, due to different hardware
  31. registers.