David Grayson / PololuLedStrip

This library lets you control the addressable RGB LED strips from Pololu Robotics & Electronics.

Dependents:   WoYaoChengGOng V2-WoYaoChengGOng STM32_MagneticLight tape_Led_Sample ... more

Summary

This is a library for the mbed that allows you to control these addressable RGB LED products from Pololu:

This library is optimized for the SK6812 and WS2812B, so it transmits colors in green-red-blue order.

If you have a WS2811 LED or a high-speed TM1804 LED strip, please note that its red and green channels are swapped relative to the WS2812B, so you will need to swap those channels in your code. You might prefer to use the version of the library from October 2013, which does not require you to swap red and green in your code.

If you need to control the older, low-speed LED strips (items #2540, #2541, and #2542), you will need to use the version of this library from March 2013.

This library allows complete control over the color of an arbitrary number of LED strips with an arbitrary number of LEDs. Each LED can be individually controlled, and LED strips can be chained together.

This library should also work with any other LED strip based on the SK6812, WS281x, or TM1804.

Supported Platforms

This library has been tested on the mbed NXP LPC1768 (Cortex-M3 at 96 MHz), the mbed NXP LPC11U24 (Cortex-M0 at 48 MHz), and the NUCLEO-F303K8 (Cortex-M4 at 72 MHz). It will probably work on many other boards without modification.

This library does not work on chips families such as the STM32F4 where there is a single register for setting and clearing the value of an output pin. The library checks for the GPIO_IP_WITHOUT_BRR preprocessor macro and triggers a compile-time error if that macro is set.

Getting Started

Software

Here are two example programs that show how to use the library:

Import programLedStripRainbow

This is an example program for the PololuLedStrip library. It generates a simple moving rainbow pattern.

Last commit 01 Nov 2017 by David Grayson

Import programLedStripGradient

This is an example program for the PololuLedStrip library. It generates a simple moving gradient pattern.

Last commit 01 Nov 2017 by David Grayson

As a first step, you should compile and upload one of these to the mbed. When the program runs, the mbed should output color data on pin p8 dozens of times per second. The expected signal is documented on the Pololu website. The example programs only send colors for 60 LEDs, but they can easily be changed to send more for a longer strip.

Hardware

The addressable RGB LED strips can be purchased on Pololu's website using the links above.

The LED strip’s data input connector has two pins that should be connected to the Arduino. The LED strip’s ground will need to be connected to one of the mbed’s GND pins, and the LED strip’s signal input line will be need to be connected to one of the Arduino’s I/O lines. Our example programs assume the signal line is connected to p8. These connections can be made using two Male-Female Premium Jumper Wires, with the female ends plugging into the LED strip and the male ends plugged into a breadboard that houses the mbed.

You will also need to connect a suitable power supply to the LED strip using one of the power connectors. The power supply must be at the right voltage and provide enough current to meet the LED strip's requirements.

If everything works properly, you will see a moving pattern of colors on the LED strip.

Timing Details

This library takes about 1.3 ms to update 30 LEDs (1 meter). The LED strips use a high speed one-wire protocol with relatively strict timing requirements, so this library disables interrupts to ensure reliable color transmission. Unfortunately, disabling the interrupts could cause problems in other libraries that uses interrupts.

This library provides an interruptFriendly option that can let it coexist with interrupt-based libraries. When this option is enabled, the library will temporarily enable interrupts after each color is sent, about every 45 microseconds. If you can keep all of your interrupts short enough, then this option should allow this library to work in conjunction with your interrupt-based libraries. However, if you have an interrupt enabled that takes too long, then this interrupt will sometimes cause an extra long low pulse to emitted, which will be interpreted by the LED strip as a reset command. This can cause visible flickering in the LED strip. To turn on the interruptFriendly option, add this line to the beginning of your main() function:

PololuLedStrip::interruptFriendly = true;

Chaining LED Strips together

No special code is required to chain LED strips together. An X-meter LED strip chained to a Y-meter LED strip can be controlled in exactly the same way as a single (X+Y)-meter LED strip.

PololuLedStrip.h@0:06475317f283, 2013-02-27 (annotated)

Committer:
DavidEGrayson
Date:
Wed Feb 27 00:28:26 2013 +0000
Revision:
0:06475317f283
Child:
1:102307d9b701
Still working;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
DavidEGrayson 0:06475317f283 1 #include "mbed.h"
DavidEGrayson 0:06475317f283 2
DavidEGrayson 0:06475317f283 3 #ifndef _POLOLU_LED_STRIP_H
DavidEGrayson 0:06475317f283 4 #define _POLOLU_LED_STRIP_H
DavidEGrayson 0:06475317f283 5
DavidEGrayson 0:06475317f283 6 namespace Pololu
DavidEGrayson 0:06475317f283 7 {
DavidEGrayson 0:06475317f283 8 #ifndef _POLOLU_RGB_COLOR
DavidEGrayson 0:06475317f283 9 #define _POLOLU_RGB_COLOR
DavidEGrayson 0:06475317f283 10 typedef struct rgb_color
DavidEGrayson 0:06475317f283 11 {
DavidEGrayson 0:06475317f283 12 uint8_t red, green, blue;
DavidEGrayson 0:06475317f283 13 } rgb_color;
DavidEGrayson 0:06475317f283 14 #endif
DavidEGrayson 0:06475317f283 15
DavidEGrayson 0:06475317f283 16 extern "C" int led_strip_write_color(rgb_color *, volatile uint32_t * set, volatile uint32_t * clear, uint32_t mask);
DavidEGrayson 0:06475317f283 17
DavidEGrayson 0:06475317f283 18 class PololuLedStrip
DavidEGrayson 0:06475317f283 19 {
DavidEGrayson 0:06475317f283 20 gpio_t gpio;
DavidEGrayson 0:06475317f283 21 public:
DavidEGrayson 0:06475317f283 22 PololuLedStrip(PinName pin);
DavidEGrayson 0:06475317f283 23 void write(rgb_color * colors, unsigned int count);
DavidEGrayson 0:06475317f283 24 static bool interruptFriendly;
DavidEGrayson 0:06475317f283 25 };
DavidEGrayson 0:06475317f283 26
DavidEGrayson 0:06475317f283 27 bool PololuLedStrip::interruptFriendly;
DavidEGrayson 0:06475317f283 28
DavidEGrayson 0:06475317f283 29 PololuLedStrip::PololuLedStrip(PinName pinName)
DavidEGrayson 0:06475317f283 30 {
DavidEGrayson 0:06475317f283 31 gpio_init(&gpio, pinName, PIN_OUTPUT);
DavidEGrayson 0:06475317f283 32 }
DavidEGrayson 0:06475317f283 33
DavidEGrayson 0:06475317f283 34 void PololuLedStrip::write(rgb_color * colors, unsigned int count)
DavidEGrayson 0:06475317f283 35 {
DavidEGrayson 0:06475317f283 36 __disable_irq(); // Disable interrupts temporarily because we don't want our pulse timing to be messed up.
DavidEGrayson 0:06475317f283 37
DavidEGrayson 0:06475317f283 38 while(count--)
DavidEGrayson 0:06475317f283 39 {
DavidEGrayson 0:06475317f283 40 led_strip_write_color(colors++, gpio.reg_set, gpio.reg_clr, gpio.mask);
DavidEGrayson 0:06475317f283 41
DavidEGrayson 0:06475317f283 42 if (interruptFriendly)
DavidEGrayson 0:06475317f283 43 {
DavidEGrayson 0:06475317f283 44 __enable_irq();
DavidEGrayson 0:06475317f283 45 __nop();
DavidEGrayson 0:06475317f283 46 __nop();
DavidEGrayson 0:06475317f283 47 __nop();
DavidEGrayson 0:06475317f283 48 __disable_irq();
DavidEGrayson 0:06475317f283 49 }
DavidEGrayson 0:06475317f283 50 }
DavidEGrayson 0:06475317f283 51 __enable_irq(); // Re-enable interrupts now that we are done.
DavidEGrayson 0:06475317f283 52 wait_us(24); // Hold the line low for 24 microseconds to send the reset signal.
DavidEGrayson 0:06475317f283 53 }
DavidEGrayson 0:06475317f283 54 }
DavidEGrayson 0:06475317f283 55
DavidEGrayson 0:06475317f283 56 using namespace Pololu;
DavidEGrayson 0:06475317f283 57
DavidEGrayson 0:06475317f283 58 #endif