Quick Start Guide
Get your NeoRing running in under 5 minutes.
Prerequisites
- Arduino IDE (1.8+) or Arduino IDE 2.x
- An Arduino-compatible board (Uno, Nano, ESP32, RP2040, etc.)
- A USB cable
- 3 jumper wires
Step 1: Install the Library
- Download RobotechPixel-1.0.1.zip
- Open Arduino IDE
- Go to Sketch → Include Library → Add .ZIP Library...
- Select the downloaded ZIP file
- Install the Adafruit NeoPixel dependency: Sketch → Include Library → Manage Libraries, search "Adafruit NeoPixel", click Install
Step 2: Wire the NeoRing
Connect 3 wires from your board to the NeoRing:
| NeoRing Pad | Arduino Pin | Description |
|---|---|---|
| VCC | 5V | Power supply |
| GND | GND | Ground |
| DIN | Pin 7 | Data input |
Note: At full brightness with all LEDs white, the NeoRing draws up to 0.68A (measured). A single board is USB-safe even at full brightness on USB-C (1.5A) or USB 3.x (900mA) ports. USB 2.0 (500mA) is marginal at full brightness — reduce brightness or use an external supply. The default firmware limits brightness to 150/255 as a conservative default for multi-board setups.
Step 3: Upload the Library Effects Demo
Open the included demo: File → Examples → RobotechPixel → LibraryEffectsDemo
Or paste this into a new sketch:
#include <RobotechPixel.h>
// Board type, number of boards, data pin
RobotechPixel px(BOARD_NEORING, 1, 7);
void setup() {
Serial.begin(115200);
px.begin();
px.setBrightness(150);
}
void loop() {
fxAutoCycle(px, millis());
}
Upload, then open the Serial Monitor (115200 baud). The NeoRing starts in Auto Cycle mode, rotating through all 26 built-in effects.
Step 4: Explore Effects
Type a letter in the Serial Monitor to jump to any effect:
| Key | Effect | Key | Effect |
|---|---|---|---|
| a | Auto Cycle | n | Twinkle |
| b | Pixel Walk | o | Color Cycle |
| c | Radar Sweep | p | Rainbow Wheel |
| d | Dual Spin | q | Wave |
| e | Comets | r | Ripple Pulse |
| f | Comet Crosser | s | Color Wipe |
| g | Orbit | t | Breathing |
| h | Meteor Shower | u | Heartbeat |
| i | Cylon | v | Fire Ring |
| j | Theater Chase | w | Starfield |
| k | Sparkle | x | Strobe |
| l | Confetti | y | Police |
| m | Sparks | z | Clock |
Send B<0-255> to change brightness (e.g. B255 for full, B50 for dim).
Step 5: Tweak Parameters
Each effect has tunable parameters. In the LibraryEffectsDemo sketch, find the effect in the switch statement and change its values:
// Try different colors and speeds
case 'c':
fxRadarSweep(px, now,
/*color*/ 0xFF0000, // change from green to red
/*tailLen*/ 24, // longer tail
/*wait*/ 15); // faster sweep
break;
Edit, re-upload, and see the difference. Check the Effects Reference to see all parameters for every effect, or use the live effects previewer to try different colors and settings in your browser before uploading.
Step 6: Control Individual LEDs
When you're ready to go beyond built-in effects, open File → Examples → RobotechPixel → LEDAccess. This example shows how to address individual LEDs by global index, ring position, and ring helpers — the building blocks for writing your own effects.
Next Steps
- Effects Reference — All 26 effects with parameters and live preview
- Wiring Guide — Power considerations and multi-board wiring
- Electrical Specs — Detailed electrical characteristics
- API Reference — Full library documentation
