Forum

CandiStick API Guid...
 
Notifications
Clear all

CandiStick API Guide


CrackedConsole
(@crackedconsole)
Member Admin
Joined: 3 years ago
Posts: 365
Topic starter  

I have had a few requests on the CandiStick API and how to communicate with the lights.
They work off HTTP requests, below is a rough draft of the command break down.
I am working on cleaning this up to make it more understandable for end users, keep an eye out for updates.

 

String definitions

First octet main options will be [0] - [10]
settings options are [s] [fs] and [fc]

[effect][colorcount][blending][rgb colors]

[setting][value]

Number breakdown

palette = 0
color = 1
effect = 2

speed = 4
firespark = 6
fireccooling = 7

off = 10
on = 11

Primary

0- P: Palette
0-4 How many colors in the Palette 0 Is the rainbow Palette, 5 is clouds, 6 is Ocean, 7 is Forest, 8 is Lava, 9 is Party, 10 is rainbowstripe
0-3 Blending Type (0 = LinearBlend palette 1 = No Blend palette 2 = Static Colors 3 = Static colors moving)
0-255 is the RGB color range

[0][0-4][0-2][0-255]x3[0-255]x3[0-255]x3[0-255]x3

1- C: Color
0-255x3 to set a static color
[1][0-255]x3

2- E: Effect
0 is Fire effect
1 is Fire palette (color count) (color1-4)
2 is Breathe (color count) (color1-4)
3 is Heartbeat (color) (speed) (speed2)
4 is strobe (color) (count) (delay) (pause)
5 is sparkle (color) (speed)
6 is meteor (color) (size) (traildecay) <true> (speed delay)
7 is knightrider (color) (delay between)
[2][0][0-255][0-255][0-255]

10 Toggle Power

Palettes
0 rainbow
5 clouds
6 ocean
7 forest
8 lava
9 party
10 rainbow 2

Settings

4 - S: Speed, how fast the Palette will run
0-255
[4][0-255]

5 - B: Brightness, how bright will the LEDs be
0-255
[5][0-255]

6 - FS: Flame spark, how often the flame will flicker
0-255
[6][0-255]

7 - FC: Flame cooling, how tall will the flame be
0-255
[7][0-255]

 

[Color] [Fades] [Palettes] [Fire] [Effects]

Color - Single Color, Brightnes
Fades - Single - 4 colors, speed
Palettes - Built in, 2-4 Palette, 2-4 Stripe, 2-4 wipe, speed
Fire - Default, 2-4 color, spark, cooling,speed
Effects - strobe, meteor, twinkle, cylon, heartbeat?, color, speed

 

Palette example
0;4;0;0,255,255;255,0,0;0,0,255;255,255,255;

Effect examples

Palette 3 color static
http://10.0.0.99/0;3;2;255;0;0;255;255;255;0;0;255;

Palette 3 color no blend
http://10.0.0.99/0;3;1;255;0;0;255;255;255;0;0;255;

Palette 3 color linear blend
http://10.0.0.99/0;3;0;255;0;0;255;255;255;0;0;255;

Breath
http://10.0.0.77/2;2;0;0;255;5;250;

Heartbeat
http://10.0.0.77/2;3;0;0;255;5;250;

Strobe
http://10.0.0.100/2;4;255;255;255;1;100;50

Sparkle
http://10.0.0.77/2;5;255;255;255;50;

Meteor
http://10.0.0.77/2;6;0;0;255;10;64;10;250;


Quote
Share: