Quickstart

The Webcandy Client is responsible for receiving lighting configurations and running them on a Fadecandy. It must be run from the a computer with a Fadecandy plugged in.The source code can be found on Github.

Installation

The latest stable build can be installed via pip: $ pip install webcandy-client. This will give you access to two executables: wc-controller and wc-client.

wc-controller

wc-controller is used to run lighting configurations manually and offline. This provides a simple way to use or test LEDs without additional overhead.

Usage info: $ wc-controller --help

Examples:

$ wc-controller --pattern SolidColor --color #aa00aa

$ wc-controller --pattern Fade --color-list #ff0000 #00ff00 #0000ff

$ wc-controller --pattern Off

Lighting configurations can also be specified and saved via JSON files. For example, if you had a file called rainbow_fade.json:

{
    "pattern": "Fade",
    "speed": 7,
    "color_list": [
        "#ff0000",
        "#ff7f00",
        "#ffff00",
        "#00ff00",
        "#0000ff",
        "#8b00ff"
    ]
}

Then:

$ wc-controller --file rainbow_stripes.json

wc-client

wc-client connects to a Webcandy server and receives lighting change requests via the internet. If you would like to use the Webcandy website or control your LEDs from a different device, here is how you would do it:

1. Head over to https://webcandy.io and create an account if you don’t have one already.

2. Start up wc-client. For this example a placeholder username/password combination is used, replace those values with your own credentials: $ wc-client RGBLover573 password123 MyClient

3. Go back to https://webcandy.io and log in. If you were already logged in, click the “Refresh” button. You should now see a client named “MyClient” is selected, and lighting controls are available. Make a lighting configuration and click “Submit” and you should see your LEDs change!

Because the lights can be changed from the website, this works on any device, not just the one with the Fadecandy plugged in.

For help and advanced usage information, run $ wc-client --help.