Skip to content

Library for connecting to an AnimatedLEDStrip server from clients written in C++

License

Notifications You must be signed in to change notification settings

AnimatedLEDStrip/client-cpp

Repository files navigation

AnimatedLEDStrip Client Library for C++

Build Status codecov

This library allows a C++ 11 client to connect to an AnimatedLEDStrip server, allowing the client to send animations to the server and receive currently running animations from the server, among other information.

Creating an AnimationSender

An AnimationSender is constructed with two arguments:

  • host: The IP address of the server (as a c-style string)
  • port: The port that the client should connect to (as an int)
AnimationSender sender("10.0.0.254", 5);

Starting the AnimationSender

An AnimationSender is started by calling the start() method on the instance. start() will return 0 if the connection is successful, -1 if there is an error.

sender.start();

Stopping the AnimationSender

To stop the AnimationSender, call its end() method. end() will return 0 if the disconnection is successful, -1 if there is an error.

sender.end();

Sending Data

An animation can be sent to the server by creating an instance of the AnimationData struct, then calling sendAnimation with the struct as the argument.

ColorContainer cc;
cc.addColor(0xFF);
cc.addColor(0xFF00);

AnimationData data;
data.addColor(cc);

sender.sendAnimation(data);

AnimationData type notes

The C++ library uses the following values for continuous and direction:

  • continuous: DEFAULT, CONTINUOUS, NONCONTINUOUS
  • direction: FORWARD, BACKWARD

Receiving Data

Received animations are saved to runningAnimations.

To retrieve an animation, use

sender.runningAnimations.[ID];

where ID is the string ID of the animation.

About

Library for connecting to an AnimatedLEDStrip server from clients written in C++

Resources

License

Stars

Watchers

Forks