Skip to content
This repository has been archived by the owner on Dec 9, 2020. It is now read-only.

Server API

Jonas Sander edited this page Nov 10, 2018 · 19 revisions

Up to date as of version 1.6

Table of Content

Overview

Here is a full list of all the server API commands. for arduled to understand the command every command should end with $. For example: client.print(GETTOTALLEDCOUNT() + "$")

Server API commands

There is a preset number of commands to choose from, which are listed here:

Misc Commands

Command Function
GETTOTALLEDCOUNT Method Gets the current total LED count in the currently send setup
GETSERVERNAME Method Gets the name of the server

Fade Colors Commands

Command Function
FADECOLOR Method This command can be used to make the LEDs fade.

Individual LED Commands

Command Function
INDIVIDUALCOLOR Method This command can be used to set the color of individual LEDs.

Visualizer Commands

Command Function
VISUALIZER Method This command can be used to start, stop and configure the visualizer.
GETVISUALIZERCONFIGS Method This command can be used to get the names of saved config files for the visualizer.

Ambilight Commands

Command Function
AMBILIGHT Method This command can be used for limited control over the ambilight section.
GETAMBILIGHTCONFIGS Method This command can be used to get the filenames of saved config files for the Ambilight section.

Animations Commands

Command Function
ANIMATION Method This command can be used for limited control over the animations section.
GETANIMATIONCONFIGS Method This command can be used to get the filenames of config files for the animations section.

Instructions Commands

Command Function
INSTRUCTIONS Method This command can be used for limited control over the instructions section.
GETINSTRUCTIONSCONFIGS Method This command can be used to get the names of saved config files for the instructions section.

Control Interaction Commands

Command Function
CLICKBUTTON Method This command can be used to press a button in ArduLED.
SETTEXTCONTROL Method This command can be used to set the text of a textbox in ArduLED.
SETTACKBARCONTROL Method This command can be used to set the value of a trackbar control in ArduLED.
SETNUMERICCONTROL Method This command can be used to set the value of a numericupdown control in ArduLED.
SETCOMBOBOXINDEXCONTROL Method This command can be used to set the index of a combobox control in ArduLED.
SETCHECKBOXCONTROL Method This command can be used to set the state of a checkbox
GETCOMBOBOXLIST Method This command can be used to get the list of items in a combobox control in ArduLED.
GETTRACKBARVALUE Method This command can be used to get the value of a trackbar in ArduLED.
GETCHECKBOXSTATE Method This command can be used to get the state of a checkbox in ArduLED.

All the return values are in a string format, since its being transmitted on a char basis. This means that you would have to parse the actural value yourself.

Server Return Codes

As well as some return codes (These are by default commented out, can be found under ServerAPISection.cs):

Return code Function
G Good, input, executing command
U Unknown command
B Error in input
Clone this wiki locally