Copyright 2017 Kit Parenteau

Version score: 0.2.1.1

The lighting controller that comes standard for HD120 RGB fans left something to be desired. This code allows a 5V Arduino AVR to be used as a controller for the fan lighting.

• Tested on Arduino Pro Micro
• FastLED Library 3.1 or newer, and Arduino.cc IDE 1.8.1 or newer are required to compile

This is NOT the same software used to make the Prototype video. Version 0.2.0.0 was used to make the music demo. The prototype video was just the 100-line demo from FastLED.

Consider this to be an ALPHA version. Some assembly required. Do not taunt code. Comments may cause sweating or blindness.

User Features

• Software controlled (Currently by Serial communications)
• Control individual fans.
• Global Brightness Control
• Multiple Modes (And more to come)
• Timing Sync Mode

Coder Features

• Remapping of the fans to put the first LED in the proper place
• Mapping per sides of fans
• Mapping per quadrant of fan
• Uses FastLED - 8-bit mapped stuff makes things easy

Open a serial connection to the Arduino com port at 115200 Baud

• For example, use Serial monitor or command line redirect to the serial port
• If using serial monitor, use Newline line ending setting

Commands can be strung together in one send chunk, however the refresh will pause while the controller is parsing commands. This is generally very fast. At 115,200 baud, it takes about 1ms to send every 12 characters. Command strings exceeding 150 characters may cause one refresh to be delayed, as they normally occur sixty times per second.

Commands consist of a header character followed by any necessary options.

Any character that is not part of a continuing command or a header will be discarded and disregarded.

A greater than symbol followed by three integers with arbitrary separation. We recommend you use single-character separation to avoid excess command read time. This sets directly into the live settings and takes effect immediately.

The integers, in order, are Setting Group, Setting Item, Setting Value. Examples:

>0,0,255    --> Sets group 0, item 0 to 255
>1.0=6      --> Sets group 1, item 0 to 6
>1.0.0>1.1.128>1.2.255    --> Sets three settings at once

A karet symbol followed by three integers with arbitrary separation. We recommend you use single-character separation to avoid excess command read time. This sets into the stage settings and must be transferred to live to take effect.

The integers, in order, are Setting Group, Setting Item, Setting Value. Examples:

^0,0,255    --> Sets group 0, item 0 to 255
^1.0=6      --> Sets group 1, item 0 to 6
^1.0.0^1.1.128^1.2.255    --> Sets three settings at once

A less than symbol. No further input needed. Transfers all settings currently on stage to live settings. This also occurs automatically immediately before a sync ping. This allows settings to be configured and then put into play simultaneously.

An exclamation point. No further input needed. Saves all live settings to the EEPROM on the controller.

A dollar sign. No further input needed. Loads settings from EEPROM on the controller. Also occurs automatically on startup if the setting save area is compatible with the current configuration, otherwise reinitializes the save area.

A question mark. No further input needed. Sends the current live settings across the serial connection. The settings are formatted in such a way that they can be sent back to set them.

An at symbol followed by two integers with arbitrary separation. Shortcut to set a given Item to a given Value on all fans simultaneously. Sets LIVE values. Only affects fans, not strips.

Group 0 is always global. Then zero or more fan groups. Then zero or more strip groups.

0 ==> Nothing. No Global Override

1 ==> Pulse brightness globally between 0 and Max Brightness

2 ==> Flash one fan a color. This will unset after flashing, causing the normal fan actions to continue. Meant for sync special effects. Not for strips.

When global mode item 6 ius set to a rate above zero, the controller will enter Sync Timing Mode. At the speed of the rate, it will move stage settings to live, then send a "Ping" across Serial, consisting of a single question mark. Stage settings can be configured by the computer immediately after receiving a ping and they will be set to live on the next beat. WARNING: The serial port MUST be read by the computer when Sync Timing is enabled otherwise the serial buffer on the controller will overflow and hamper performance severely.

Mode-Dependant Settings are 0-255 unless otherwise indicated Rates are in BPM (60/Rate seconds per cycle)

Modes: 0 ==> Hue Shift - Sine wave color change of all LEDs on the fan between two hues.

Hue Offset allows passing through Red between hues. For example, Start 128 End 255 Phase Offset 64 will start at 192 and end at 64.

1 ==> Single-point Spinner - A rotating light point.

2 ==> Rainbow span across LEDs

3 ==> Four-point spinner

4 ==> Double-Scan - Back and forth patter across two sides of the fan

5 ==> Two-point spinner

6 ==> "BPM" Mode from FastLED 100-Line Demo - Because somebody asked for it. Whatev's.

7 ==> Split Sides

• Both sides can be set to the same hue to pulse a color on the full fan

8 ==> Split Quarters

9 ==> Full Fan RGB Color

• People wanted white.

10 ==> Fade to Black - Will fade at the fade rate and then do nothing more until changed. Useful for sync.

FastLED Hue Chart is Here

• 0 -> Red
• 32 -> Orange
• 64 -> Yellow
• 96 -> Green
• 128 -> Aqua/Teal
• 160 -> Blue
• 192 -> Purple
• 224 -> Pink
• 255 -> Red

Phase Offset applies to some Sine-wave situations. The value for a given rate is always the same. Phase offset creates a 0-255 offset from the base value. This allows, for example, two fan LED sets to operate in reverse of each other at the same rate.

Several interesting effects can be created with various values in the modes. Usually changing a value by a small amount has little effect, but some values can be dramatic.

Changelog 0.2.1.1 - May 13, 2017

• IMPROVED: Removed need for group number in All-Fan prefix

0.2.1.0 - May 13, 2017

• FIXED: Will no longer have severe timing issues when NumberOfStrips is set to 0
• ADDED: Use @ prefix to change a setting item on all fans at once. Ignores group number
• • TODO: Remove need for group number
• IMPROVED: Updated delay calculation logic to accoint for the number of LEDs.

0.2.0.0 - April 23, 2017

• ADDED: EEPROM Saving and Loading
• ADDED: Beat Sync Control
• • Global Sync Mode
• • Staging Settings
• ADDED: Numerous new fan modes
• ADDED: Strip control on separate data pin
• ADDED: Global modes
• MODIFIED: Consolidated some fan modes down into one. For example, "single hue color" is the same as two sides with both sides having the same color.
• ADDED: Ability to query current settings. Results are also in staging mode format and can be pasted back to the serial port to stage them.
• IMPROVED: Some code flow for end binary size.

0.1.1.0 - February 6, 2017

• ADDED: Two more fan modes
• ADDED: Local compile size tracking in comments
• IMPROVED: Cleaned up code and increased comment clarity