WS2812B/APA102 Linux driver for Minnowboard Max
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin/Debug
headers
.gitignore
Circuit.jpg
Makefile
README.md
compile.sh
dma.c
gpio.c
main.c
pwm.c
rgbcielch.c
rgbled.c
rgbled_devices.c
rgbled_driver.c
rgbled_driver.h
rgbled_x11.c

README.md

minnowmax-rgbled

WS2812B/APA102 Linux driver for Minnowboard Max This is an experimental scholar project for the Minnowboard Max platform. The objective is to provide a Linux driver that use the SPI and DMA of the Minnowboard Max to interface with the LED strips of WS2812B and APA102 types.

In addition, the libraries provide an Ambilight-like function just as the Boblight project.

Requirements

The basic functionality to control RGB LEDs (APA102 & WS2812B) has been tested in the below platforms, BUT, it is intended to work in any Linux distribution:

  • Minnowboard Max
  • Xubuntu 16.04.2
  • Arch Linux

The Ambilight-like function has been tested using the below desktop environments (Using X11):

  • Gnome
  • Xfce

As the hardware used by this driver already has an official Linux module it is needed to blacklist those modules. Add the below lines into your /etc/modprobe.d/blaklist.conf file:

blacklist dw_dmac_core
blacklist dw_dmac
blacklist dw_dmac_pci
blacklist pxa2xx_spi_pci
blacklist pxa2xx_spi

Note: Recent kernels contain dw_dmac driver as a built-in module, if it is your case, it is needed to recompile the kernel and modularize the dw_dmac driver so it can be blacklisted.

Compilation

In the working directory there are two important files to get started:

  • compile.sh
  • Makefile

You would need to install some dependencies in order to compile the driver and the libraries

  • Kernel headers
  • Building Libraries (Ubuntu: build-esential; ArchLinux: base-devel)
  • X11 dev libraries (Ubuntu: libx11-dev libxtst-dev; Archlinux: libx11 libxrender)

To compile and install the driver simply use:

make
make install

Reboot for the changes take effect, or run:

modprobe main_rgbled.ko

For the libraries, the project comes with an example main.c file containing two of the basic functions, the example main.c file is compiled by running the compile.sh script:

./compile.sh

Circuit Diagram

As per my understanding, the WS2812B and APA102 RGB LEDs are intended to be driven with a serial signal oscilating between 0v and 5v. But some users have reported to drive them with signals between 0v and 3.3v (The Minnowboard Max operating voltages for the SPI). However, a level shifter (SN74AHCT125) can be used to amplify the serial signal to the recommended one. Below is a diagram of the circuit used in this project:

Level Shifter RGB LEDs circuit diagram

Usage

To use the driver is needed to include the "headers/rgbled.h" header file in your sources, this file contain the IOCTL functions to communicate with the main_rgbled Linux driver. The functions are the following:

  • rgbled_init - Run this function before anything, this will create the connection to the main_rgbled driver. The function receives a unsigned int value containing the configuration of the driver. Use the macros provided to set the configuration in the variable. The example below will set the driver to control 239 APA102 RGB LEDs using the DMA channel 0:
	uint32_t ledsconfig = RGBLED_CONF_TYPEAPA102 | 
				RGBLED_CONF_DMACH(0) | 
				RGBLED_CONF_LEDNUM(239);

	rgbled_init(&ledsconfig);
  • rgbled_function - Set a function or color preset from the ones available, the function receive one of the following values:
	leds_off  -  Turn off the leds
	leds_on  -  Turn on the leds (Completely white)
	leds_userdefined  -  Wait for a user custom color (See below)
	leds_warm  -  Warm yellowish color
	leds_solar  -  Sun like color
	leds_green  -  Only green leds on
	leds_red  -  Only red leds ona
	leds_blue  -  Only blue leds on
  • rgbled_setcolor - Set the whole led strip with a custom color. See the below example:
led_t test_led = {2,0,20};
rgbled_setcolor(&test_led);
  • rgbled_sendleds - Set the led strip with individual colors for each of the leds. To use this option you need to set the function "leds_userdefined" using the rgbled_function function (Only once). The below example set 3 leds with different colors.
led_t test_leds[3] = {{255,0,0},  // First led RED
			{0,255,0},   // Second led GREEN
  			{0,0,255}};   // Third led BLUE

rgbled_function(leds_userdefined);  // Set the leds_userdefined function first

rgbled_sendleds(&test_leds);   // Send the colors to the led strip
  • rgbled_x11 - This function will start an Ambilight function using the led strip, build a rectangle of leds matching the contour of your screen and place it behind it. Take note of the count of the leds in the top, bottom, right and left of your rectangle, the sum of the leds should be used in the macro RGBLED_CONF_LEDNUM to set the driver configuration. Below is an example:
int top, right, left, bottom, total;
top = 20;  // Leds in the top of the screen
left = 10;  // Leds in the left side of the screen
right = 10;  // Leds in the right side of the screen
bottom = 20;  // Leds in the bottom of the screen
total = top + bottom + left + right; // 60 leds in total

	uint32_t ledsconfig = RGBLED_CONF_TYPEAPA102 | 
				RGBLED_CONF_DMACH(0) | 
				RGBLED_CONF_LEDNUM(total);

	rgbled_init(&ledsconfig);
	
	rgbled_x11(top,  // Number of leds in the top
		right,  // Number of leds in the right side
		bottom,  // Number of leds in the bottom
		left,  // Numer of leds in the left side
		30);  // Desired margin to start taking the color lectures (30 should work fine)

TODO

The basic functions of the driver works fine in the MinnowboardMax platform but more work needs to be done to convert this in a robust entertainment center.

  • Develop a Linux service to receive the petitions.
  • Add more animations.
  • Develop a cloud service to receive cellphone notifications and act accordingly.
  • Create a UDP infrastructure to receive the led color information from other computers.
  • Test in MinnowboardTurbot (Dual and Quad core).

Contact

Please report any issue, suggestion or claim to my personal mail ramoscaciqueernesto@hotmail.com

Youtube video example link

https://youtu.be/njOMS6QHMWM