Difference between revisions of "Sensor-Color LED"

From Microduino Wiki
Jump to: navigation, search
(Programming)
(Programming)
 
(15 intermediate revisions by the same user not shown)
Line 61: Line 61:
 
<tab name="Arduino for Microduino" style="width:100%;">
 
<tab name="Arduino for Microduino" style="width:100%;">
 
==Introduction==
 
==Introduction==
The ColorLED is used as an output pin. The Adafruit_NeoPixel library '''([https://learn.adafruit.com/adafruit-neopixel-uberguide/arduino-library Read more])''' is used to control the ColorLED.
+
The ColorLED is used as an output pin. The library is based on the Adafruit_NeoPixel library '''([https://learn.adafruit.com/adafruit-neopixel-uberguide/arduino-library Read more])''' is used to control the ColorLED. Most of the functions are similar.
 
==Key Functions==
 
==Key Functions==
*Required Libraries: Adafruit_NeoPixel
+
*Required Libraries: '''Microduino_ColorLED.h'''
 
*Key Functions:
 
*Key Functions:
** '''___.begin()''' - initializes the ColorLED object
+
** Constructor: '''ColorLED strip = ColorLED(num_colorleds, colorled_pin)''' - creates the ColorLED object
** '''___.setPixelColor(colorled_index, red_value, green_value, blue_value)''' - configures the color value for that colorled index.
+
***'''num_colorleds''' - defines the number of ColorLEDs connected to the '''colorled_pin'''
 +
***'''colorled_pin''' - defines the pin the ColorLEDs is connected to
 +
** '''strip.begin()''' - initializes the ColorLED object
 +
** '''strip.setPixelColor(colorled_index, red_value, green_value, blue_value)''' - configures the color value for that colorled index, must call '''strip.show()''' for the ColorLED to actually display the change
 
***'''colorled_index''' - is the index of the ColorLED to configure, first in the chain is 0, second is 1, etc
 
***'''colorled_index''' - is the index of the ColorLED to configure, first in the chain is 0, second is 1, etc
 
***'''red_value''' - red value to set, between 0 (off) and 255 (maximum on)
 
***'''red_value''' - red value to set, between 0 (off) and 255 (maximum on)
 
***'''green_value''' - green value to set, between 0 (off) and 255 (maximum on)
 
***'''green_value''' - green value to set, between 0 (off) and 255 (maximum on)
 
***'''blue_value''' - blue value to set, between 0 (off) and 255 (maximum on)
 
***'''blue_value''' - blue value to set, between 0 (off) and 255 (maximum on)
 
+
** '''strip.show()''' - call this function after setting the color values for the ColorLED to actually display the color
 
 
** '''tone(pin_number, frequency)''' - starts generating a frequency signal on the pin, will not stop until noTone(pin_number) is called '''([https://www.arduino.cc/en/Reference/Tone Read more])'''
 
***'''pin_number''' - is the pin number that the trinket is connected to
 
***'''frequency''' - a frequency value to generate on the pin
 
** '''noTone(pin_number)''' - stops generating a frequency on the pin '''([https://www.arduino.cc/en/Reference/noTone Read more])'''
 
***'''pin_number''' - is the pin number that the trinket is connected to
 
** '''tone(pin_number, frequency, duration)''' - generates a frequency signal on the pin for a set amount of time '''([https://www.arduino.cc/en/Reference/Tone Read more])'''
 
***'''pin_number''' - is the pin number that the trinket is connected to
 
***'''frequency''' - a frequency value to generate on the pin
 
***'''duration''' - the duration in milliseconds to generate the frequency signal
 
  
 
==Example==
 
==Example==
 
This is a simple example which:
 
This is a simple example which:
*Starts the Buzzer at a 440hz frequency.
+
*Turns the ColorLED to red
 
*Waits 1 second.  
 
*Waits 1 second.  
*Turns off the Buzzer.
+
*Turns the ColorLED to green
 
*Wait 1 second.
 
*Wait 1 second.
*Runs the Buzzer at a 294hz frequency for 2 seconds
+
*Turns the ColorLED to blue
*Waits 5 seconds.
+
*Waits 1 second.
  
 
'''Note''': Important lines of code are highlighted.
 
'''Note''': Important lines of code are highlighted.
  
<syntaxhighlight lang="cpp" highlight="1,2,14,15,18,19,24,25">
+
<syntaxhighlight lang="cpp" highlight="1-3,5,6,8,9,11,12,20,21,23,24,30-33,38-41,46-49">
//Define the pin the buzzer is connected to
+
//Include the required libraries to control the ColorLED
const int BUZZER_PIN = 6;
+
//Based on: https://learn.adafruit.com/adafruit-neopixel-uberguide/arduino-library
 +
#include <Microduino_ColorLED.h>
 +
 
 +
//Define the pin the ColorLED is connected to
 +
const int COLORLED_PIN = 6;
 +
 
 +
//Define the number of ColorLEDs daisy chained together
 +
const int COLORLED_NUM = 1;
 +
 
 +
//Declare and initialize the ColorLED object
 +
ColorLED strip = ColorLED(COLORLED_NUM, COLORLED_PIN);
  
 
void setup() {
 
void setup() {
Line 103: Line 106:
 
   //Initial serial communication port at 9600 baud
 
   //Initial serial communication port at 9600 baud
 
   Serial.begin(9600);
 
   Serial.begin(9600);
 +
 +
  //Initialize the ColorLED class object
 +
  strip.begin();
 +
 +
  //Initialize all ColorLEDs to 'off'
 +
  strip.show();
 
}
 
}
  
Line 108: Line 117:
 
   // put your main code here, to run repeatedly:
 
   // put your main code here, to run repeatedly:
  
   //Start the Buzzer with a 440hz frequency
+
   //Configure the first ColorLED to maximum red
   tone(BUZZER_PIN, 440);
+
   strip.setPixelColor(0, 255, 0, 0);
   //Wait 1 second
+
   //Set the ColorLED
 +
  strip.show();
 +
 
 +
  //wait 1 second
 
   delay(1000);
 
   delay(1000);
  //Turn off the Buzzer
 
  noTone(BUZZER_PIN);
 
  
   //Wait 1 second
+
   //Configure the first ColorLED to maximum green
 +
  strip.setPixelColor(0, 0, 255, 0);
 +
  //Set the ColorLED
 +
  strip.show();
 +
 
 +
  //wait 1 second
 
   delay(1000);
 
   delay(1000);
  
   //Run the Buzzer with a 294hz frequency for 2000 milliseconds (2 seconds)
+
   //Configure the first ColorLED to maximum blue
   tone(BUZZER_PIN, 294, 2000);
+
  strip.setPixelColor(0, 0, 0, 255);
 +
   //Set the ColorLED
 +
  strip.show();
  
   //Wait 5 seconds
+
   //wait 1 second
   delay(5000);
+
   delay(1000);
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 20:06, 1 December 2017

Language: English  • 中文
Microduino-Color led

The product number of Sensor-Color LED is: MSDL11

Sensor-Color LED is full color LED, adopting single serial cascade protocol.

Only one I/O port can control the RGB color of each LED on the line.

If the power supply supports, it can support the cascade of as many as 1024 LEDs.



Introduction of Sensor Pin

Sensor backpin.png

Color LED
General Pin Out Sensor / Trinket's Pin Out
PIN1 (GND) GND
PIN2 (VCC) VCC
PIN3 (SIGNAL-A) Digital Output (One-wire communication)
PIN4 (SIGNAL-B) Not Connected
  • General Pin Out is the standard pin out of a Sensor / Trinket connector.
  • Sensor / Trinket's Pin Out is this specific Sensor / Trinket's wiring in relation to the General Pin Out.
  • SIGNAL-A / SIGNAL-B are signals that could be digital input, digital output, analog input or analog output. Or special signals such as serial communication (SoftwareSerial, IIC (I2C), etc) or other special signals.
  • Not Connected refers to the Pin not being used for this particular Sensor / Trinket.
  • Read more about the hub module.

Features

  • With small size which is easy to install;
  • Adopts single serial cascade protocol, which makes it cascadable;
  • Only one I/O port can control the RGB color of each LED on the line;
  • Can achieve 256-grade (1600W) toning of RGB, and the scanning frequency is not less then 400Hz/s

Specification

  • Sensor voltage
    • 5V working voltage
  • Size of the sensor
    • Size of the board: 23.5mm*13mm
    • 1.27mm-spacing 4Pin interface connected with sensorhub
    • CAD drawing of the sensor: File:Sensor CAD.zip
  • Function description
    • Adopts WS2812 lampwick
    • Adopts single serial cascade protocol, which makes it cascadable
    • Only one I/O port can control the RGB color of each LED on the line
    • Can achieve 256-grade (1600W) toning or RGB, and the scanning frequency is not less then 400Hz/s
    • When the updating speed is 30 frame/s, the cascading number is no less than 1024
  • Connection
    • This sensor can be connected to the following interfaces of the core: D2~D13,A0~A7
    • Multiple sensors cascade: Connect the (OUT) of the former Sensor-Color LED to the (IN) of the latter Sensor-Color LED.

Documents

Usage

Basic Functionality

The ColorLED is a trinket which emits different colors based on the set red, green, and blue values. A Core module can control the ColorLED to output the desired colors.

Note: ColorLEDs can be connected together in a daisy chain fashion, and each ColorLED can be addressed individually using the index number. First ColorLED being 0, second ColorLED being 1, etc.

Programming

Introduction

The ColorLED is used as an output pin. The library is based on the Adafruit_NeoPixel library (Read more) is used to control the ColorLED. Most of the functions are similar.

Key Functions

  • Required Libraries: Microduino_ColorLED.h
  • Key Functions:
    • Constructor: ColorLED strip = ColorLED(num_colorleds, colorled_pin) - creates the ColorLED object
      • num_colorleds - defines the number of ColorLEDs connected to the colorled_pin
      • colorled_pin - defines the pin the ColorLEDs is connected to
    • strip.begin() - initializes the ColorLED object
    • strip.setPixelColor(colorled_index, red_value, green_value, blue_value) - configures the color value for that colorled index, must call strip.show() for the ColorLED to actually display the change
      • colorled_index - is the index of the ColorLED to configure, first in the chain is 0, second is 1, etc
      • red_value - red value to set, between 0 (off) and 255 (maximum on)
      • green_value - green value to set, between 0 (off) and 255 (maximum on)
      • blue_value - blue value to set, between 0 (off) and 255 (maximum on)
    • strip.show() - call this function after setting the color values for the ColorLED to actually display the color

Example

This is a simple example which:

  • Turns the ColorLED to red
  • Waits 1 second.
  • Turns the ColorLED to green
  • Wait 1 second.
  • Turns the ColorLED to blue
  • Waits 1 second.

Note: Important lines of code are highlighted.

//Include the required libraries to control the ColorLED
//Based on: https://learn.adafruit.com/adafruit-neopixel-uberguide/arduino-library
#include <Microduino_ColorLED.h>

//Define the pin the ColorLED is connected to
const int COLORLED_PIN = 6;

//Define the number of ColorLEDs daisy chained together
const int COLORLED_NUM = 1;

//Declare and initialize the ColorLED object
ColorLED strip = ColorLED(COLORLED_NUM, COLORLED_PIN);

void setup() {
  // put your setup code here, to run once:

  //Initial serial communication port at 9600 baud
  Serial.begin(9600);

  //Initialize the ColorLED class object
  strip.begin();

  //Initialize all ColorLEDs to 'off'
  strip.show();
}

void loop() {
  // put your main code here, to run repeatedly:

  //Configure the first ColorLED to maximum red
  strip.setPixelColor(0, 255, 0, 0);
  //Set the ColorLED
  strip.show();

  //wait 1 second
  delay(1000);

  //Configure the first ColorLED to maximum green
  strip.setPixelColor(0, 0, 255, 0);
  //Set the ColorLED
  strip.show();

  //wait 1 second
  delay(1000);

  //Configure the first ColorLED to maximum blue
  strip.setPixelColor(0, 0, 0, 255);
  //Set the ColorLED
  strip.show();

  //wait 1 second
  delay(1000);
}

Copy and paste the code above to the Arduino IDE or

Download the above example: n/a

Program Download

Programming

  • Follow the Software Getting Started Guide.
  • Select the Board, Processor and Port.
  • Click [File]->[Open], browse to the project program address, and click "Microduino_Sensor-Color_LED_Test.ino" to open the program.
  • After confirming all these items are correct, click "→" to download the program to the development board.

Hardware Setup

  • Referring to the following diagram, connect the Sensor-Color LED to the digital port D6 of Microduino-Sensorhub.


Microduino-sensorhub Shake.JPG


Results

  • After download, observe the LED strip..
  • LED flashes in red and green successively with the interval of 1s.

Application

  • LED full color light source

Project

History

Gallery

File:MicroduinoColorLED-F.JPG
mCookie-Color_LED-Front
File:Microduino-ColorLED-b.JPG
mCookie-Color_LED-Back
Retrieved from "https://wiki.microduinoinc.com/index.php?title=Sensor-Color_LED&oldid=21716"