Usb ws2812 - Revision history

Rew: /* lshift and rshift */

2021-08-23T09:12:40Z

lshift and rshift

Rew: /* rbl */

2021-01-26T17:43:33Z

rbl

Rew: /* Protocol */

2021-01-26T17:28:52Z

Protocol

Rew: /* Pinout */

2021-01-20T13:09:14Z

Pinout

Rew: /* Pinout */

2021-01-20T13:04:32Z

Pinout

Rew: /* Pinout */

2021-01-20T13:03:25Z

Pinout

Rew: /* wiring */

2021-01-20T12:39:29Z

wiring

Rew: /* Changelog */

2021-01-20T12:35:09Z

Changelog

Rew: /* fade */

2021-01-20T12:34:45Z

fade

Rew: /* Changelog */

2018-05-18T06:55:17Z

Changelog

@@ Line 163: / Line 163: @@
 Shift a range of pixels one pixel left (towards the controller) or right (away from the controller).
-There are two arguments. the starting position and the number of pixels to involve in the shift. Default is to start at zero and "all pixels".
+There are three arguments. The starting position and the number of pixels to involve in the shift and the number of pixels to shift (i.e. shift by 3 pixels). Default is to start at zero and "all pixels", and just one position.
+example:
+ lshift 50 60 3
+will shift pixels 50-109 by three pixels. (pixel 50 gets the value from pixel 53, 51 from 54 etc.).
+The maximum number of pixels you can shift in one go is 10 at the moment.
 If you give only one argument, the starting position defaults to zero, if you give two arguments, the first is the starting position the second is the number of pixels.

@@ Line 209: / Line 209: @@
 ==== rbl ====
-Reset to bootloader.
+Reset to BootLoader.
 Should you need to upgrade the firmware, this will Reset the device into the BootLoader. On older versions you had to keep the button pressed while plugging the device into the USB cable. That would still be the recovery procedure if say a firmware is downloaded that crashes before it provides the virtual com port.
+==== bitsperled ====
+Without an argument it will print the current setting. If you provide an argument you can set it. Only 24 and 32 are currently allowed.
+==== write ====
+write the current settings to non volatile memory so that they will apply after the next powercycle. In the past, this module wrote changed settings to flash immediately. However for consistency we're moving to just modifying the active settings with the commands and then requiring a "write" to make these settings permanent.
+Currently "bitsperled" is the only setting that requires the write.
 == Future hardware enhancements ==

@@ Line 131: / Line 131: @@
 == Protocol ==
-When you connect the board to your PC or raspberry PI, you will get a virtual com port. You can use your favorite communications program to talk to the device. (I personally use "kermit" because I've been using that for 30 years. "Minicom" is also a good option)
+When you connect the board to your PC or raspberry PI, you will get a virtual com port. You can use your favorite communications program to talk to the device. (I personally use "kermit" because I've been using that for over 30 years. "Minicom" is also a good option)
+=== specifying pixel colors ===
+Adressable leds are starting to appear that have 32 bits driving RGBW 4 different color leds, while the original WS2812 leds have 24 bits driving RGB 3 colored leds.
+On a hardware level WS2812 leds want the data in GRB order. Because everybody says "RGB" it is easier to memorize that the order of the colors are RGB. So the board translates this for you.
+So when you need to specify a color for a WS2812 (or compatible 24-bit) led, you specify rrggbb: Two hex digits for each color. You may omit leading zeros if you want, to the firmware in your usb-ws2812 it is just a number.
+To keep existing software compatible with this, the format for 32-bit leds is WRGB: you specify 8 hex digits, wwrrggbb. Again, leading zeros may be omitted, so when you just specify rrggbb, the white led simply won't be driven.
+=== list of commands ===
 The board supports the following commands:
-=== help ===
+==== help ====
 Print a list of supported commands, and also the compilation time of the firmware.
 You might see a few commands that are there for debugging purposes. Consider those not described here as "do not use".
-=== pix ===
+==== pix ====
  pix <num> <color>
@@ Line 146: / Line 159: @@
 Set pixel "num" to color "color". Color is specified in 6 hexadecimal digits specifying the color in RGB order. Specifying 102030 will set the red component to 0x10, or about 1/16th of full intensity, the green component to 0x20/0xff or aobut 1/8th of full intensity and blue to about 3/16th.
-===  lshift and rshift ===
+====  lshift and rshift ====
 Shift a range of pixels one pixel left (towards the controller) or right (away from the controller).
@@ Line 154: / Line 167: @@
 If you give only one argument, the starting position defaults to zero, if you give two arguments, the first is the starting position the second is the number of pixels.
-===  rainbow ===
+====  rainbow ====
 Create a rainbow color effect.
@@ Line 162: / Line 175: @@
 will create a rainbow starting at the led "start" and extend over "nleds" leds. The rainbow starts with red, fades via yellow, green, cyan, blue, violet back to red, so it is cyclic.
-===  white ===
+====  white ====
 will set all leds to white.
-===  black ===
+====  black ====
 will set all leds  off (black).
-=== color ===
+==== color ====
 sets a fixed color.
@@ Line 178: / Line 191: @@
 Sets "nleds" starting at "start" to the color specified by "color".
-===  fade ===
+====  fade ====
 creates a fade from one color to another color.
@@ Line 187: / Line 200: @@
 This is one of the latest commands added. Some of the boards in the field do not have this yet.
-===   uid ===
+====   uid ====
 print the unique identifier for this board.
 Some chips have a Unique identifier on board. This one does. It gets formatted to readable ascii and printed with this command. If you have multiple boards, you can use this to keep them apart.
+==== rbl ====
+Reset to bootloader.
+Should you need to upgrade the firmware, this will Reset the device into the BootLoader. On older versions you had to keep the button pressed while plugging the device into the USB cable. That would still be the recovery procedure if say a firmware is downloaded that crashes before it provides the virtual com port.
 == Future hardware enhancements ==

@@ Line 104: / Line 104: @@
+Please ignore the other connectors on the board. There is SWD: Single Wire Debug. This helps us develop software. For hacking: pin1 is 3V3 and pin 3 is GND. There is also a connector SPI. This was meant to allow this board to prototype getting the led-data over SPI, or possibly control other modules over SPI.
-Please ignore the other connectors on the board.
 === wiring ===

@@ Line 59: / Line 59: @@
 ! function !! pin !! pin !! function
 |-
-| D7 || 16 || 15 || GND || Data for led-chain 7.
+| D7 || 16 || 15 || GND || two pins for led-chain 7.
 |-
-| D6 || 14 || 13 || GND || Data for led-chain 6.
+| D6 || 14 || 13 || GND || two pins for led-chain 6.
 |-
-| D5 || 12 || 11 || GND || Data for led-chain 5.
+| D5 || 12 || 11 || GND || two pins for led-chain 5.
 |-
-| D4 || 10 ||  9 || GND || Data for led-chain 4.
+| D4 || 10 ||  9 || GND || two pins for led-chain 4.
 |-
-| d3 ||  8 ||  7 || GND || Data for led-chain 3.
+| d3 ||  8 ||  7 || GND || two pins for led-chain 3.
 |-
-| D2 ||  6 ||  5 || GND || Data for led-chain 2.
+| D2 ||  6 ||  5 || GND || two pins for led-chain 2.
 |-
-| D1 ||  4 ||  3 || GND || Data for led-chain 1.
+| D1 ||  4 ||  3 || GND || two pins for led-chain 1.
 |-
-| D0 ||  2 ||  1 || GND || Data for led-chain 0.
+| D0 ||  2 ||  1 || GND || two pins for led-chain 0.
 |-
 |}

@@ Line 34: / Line 34: @@
 ! function !! pin !! pin !! function
 |-
-| GND || 1 || 2 || D7 || Data for led-chain 7.
+| GND || 1 || 2 || D0 || Data for led-chain 0.
 |-
-| GND || 3 || 4 || D6 || Data for led-chain 6.
+| GND || 3 || 4 || D1 || Data for led-chain 1.
 |-
-| GND || 5 || 6 || D5 || Data for led-chain 5.
+| GND || 5 || 6 || D2 || Data for led-chain 2.
 |-
-| GND || 7 || 8 || D4 || Data for led-chain 4.
+| GND || 7 || 8 || D3 || Data for led-chain 3.
 |-
-| GND || 9 || 10 || D3 || Data for led-chain 3.
+| GND || 9 || 10 || D4 || Data for led-chain 4.
 |-
-| GND || 11 || 12 || D2 || Data for led-chain 2.
+| GND || 11 || 12 || D5 || Data for led-chain 5.
 |-
-| GND || 13 || 14 || D1 || Data for led-chain 1.
+| GND || 13 || 14 || D6 || Data for led-chain 6.
 |-
-| GND || 15 || 16 || D0 || Data for led-chain 0.
+| GND || 15 || 16 || D7 || Data for led-chain 7.
 |-
 |}
@@ Line 54: / Line 54: @@
 Note, pin one of this connector is bottom-right when the logo is right-side up. Pin 16 is top-left. All the pins on the right are all ground, the pins on the left are the data pins.
+Or closer resembling the layout on the board:
-Each pin controls a number of leds. On the current version that number is 384. On a previous version it was 75. Let's call that number "N". Soonish you will be able to set the number of leds per string up to the maximum of the board.
+{| border=1
+! function !! pin !! pin !! function
+|-
+| D7 || 16 || 15 || GND || Data for led-chain 7.
+|-
+| D6 || 14 || 13 || GND || Data for led-chain 6.
+|-
+| D5 || 12 || 11 || GND || Data for led-chain 5.
+|-
+| D4 || 10 ||  9 || GND || Data for led-chain 4.
+|-
+| d3 ||  8 ||  7 || GND || Data for led-chain 3.
+|-
+| D2 ||  6 ||  5 || GND || Data for led-chain 2.
+|-
+| D1 ||  4 ||  3 || GND || Data for led-chain 1.
+|-
+| D0 ||  2 ||  1 || GND || Data for led-chain 0.
+|-
+|}
+Each pin controls a number of leds. On the current version that number is 384. On a previous version it was 75. Let's call that number "N". You can configure the number of leds per string up to the maximum of the board.
 {| border=1

@@ Line 84: / Line 84: @@
 === wiring ===
-Your WS2812 led string has three wires. One is usually marked "GND" or "V-", one is marked "VCC" or "V+" and the last is the data-in, marked "D" or "Din".
+Your WS2812 led string has three wires. One is usually marked "GND" or "V-", one is marked "VCC" or "V+" and the last is the data-in, marked "D", "DI", "I", "IN" or "Din".
-Our WS2812 board has a three pin ground-data-vcc connector. This is for "quick test" purposes: The usb powersupply of the board is not able to provide current for more than a few leds (about ten). The quick test connector has pinout ground-data-vcc, just like most WS2812 led strips.
+Our WS2812 board has a three pin ground-data-vcc connector. This is for "quick test" purposes: The usb powersupply of the board is not able to provide current for more than a few leds (about ten). The quick test connector has pinout ground-data-vcc, just like most WS2812 led strips. If you have the board upright, USB on the left, bitwizard logo correctly oriented, pin 1 is on the right. Take care not to reverse your led strip: It kills the leds instantly.
-When you are ready to connect longer strips, you need to have a separate 5V supply for the led strip. Connect the 0 and 5V of the powersupply to the GND (V-) and VCC (V+) of the led strip. Then connect the GND (V-) Of the led strip to the GND of the USB_WS2812 board. And connect the Din of the ledd strip to one of the data pins on the USB_WS2812 board.
+When you are ready to connect longer strips, you need to have a separate 5V supply for the led strip. Connect the 0 and 5V of the powersupply to the GND (V-) and VCC (V+) of the led strip. Then connect the GND (V-) Of the led strip to the GND of the USB_WS2812 board. And connect the Din of the led strip to one of the data pins on the USB_WS2812 board.
+The 8 datalines count from bottom to top, D0..D7. The datalines are on the left (next to the resistors), and the GND for each strip is on the right (next to our logo).
 === LEDs ===

@@ Line 176: / Line 176: @@
 == Changelog ==
+This is the HARDWARE changelog.
 === 1.0 ===

@@ Line 176: / Line 176: @@
 === 1.0 ===
+* nov 2015 Initial version
-* Initial public release
+=== 1.1 ===
+* dec 2015 minor fixes.
+=== 1.2 ===
+* dec 2016 added SPI connector.