frodovdr/hyperion.ng
1
0
Fork 0
mirror of https://github.com/hyperion-project/hyperion.ng.git synced 2025-03-01 10:33:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen comments added

Browse Source
This commit is contained in:
johan
2013-08-31 14:36:54 +02:00
parent 1a2dd19a7b
commit 3187fc84a6
8 changed files with 195 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/hyperion-remote/CustomParameter.h
View File

@@ -10,11 +10,14 @@
// hyperion-remote includes
#include "ColorTransformValues.h"
/// Data parameter for a color
typedef vlofgren::PODParameter<QColor> ColorParameter;
typedef vlofgren::PODParameter<QImage> ImageParameter;
typedef vlofgren::PODParameter<ColorTransformValues> TransformParameter;
/// Data parameter for an image
typedef vlofgren::PODParameter<QImage> ImageParameter;
/// Data parameter for color transform values (list of three values)
typedef vlofgren::PODParameter<ColorTransformValues> TransformParameter;
namespace vlofgren {
template<>

39
src/hyperion-remote/JsonConnection.h
View File

@@ -19,26 +19,44 @@
class JsonConnection
{
public:
/// @brief COnstructor
/// @param address The address of the Hyperion server (for example "192.168.0.32:19444)
/// @param printJson Boolean indicating if the sent and received json is written to stdout
JsonConnection(const std::string & address, bool printJson);
/// @brief Destructor
~JsonConnection();
/// Set all leds to the specified color
/// @brief Set all leds to the specified color
/// @param color The color
/// @param priority The priority
/// @param duration The duration in milliseconds
void setColor(QColor color, int priority, int duration);
/// Set the leds according to the given image (assume the image is stretched to the display size)
/// @brief Set the leds according to the given image (assume the image is stretched to the display size)
/// @param image The image
/// @param priority The priority
/// @param duration The duration in milliseconds
void setImage(QImage image, int priority, int duration);
/// Retrieve a list of all occupied priority channels
/// @brief Retrieve a list of all occupied priority channels
/// @return String with the server info
QString getServerInfo();
/// Clear the given priority channel
/// @brief Clear the given priority channel
/// @param priority The priority
void clear(int priority);
/// Clear all priority channels
/// @brief Clear all priority channels
void clearAll();
/// Set the color transform of the leds
/// Note that providing a NULL will leave the settings on the server unchanged
/// @brief Set the color transform of the leds
/// @note Note that providing a NULL will leave the settings on the server unchanged
/// @param saturation The HSV saturation gain
/// @param value The HSV value gain
/// @param threshold The threshold
/// @param blacklevel The blacklevel
/// @param whitelevel The whitelevel
void setTransform(
double * saturation,
double * value,
@@ -48,9 +66,14 @@ public:
ColorTransformValues * whitelevel);
private:
/// Send a json command message and receive its reply
/// @brief Send a json command message and receive its reply
/// @param message The message to send
/// @return The returned reply
Json::Value sendMessage(const Json::Value & message);
/// @brief Parse a reply message
/// @param reply The received reply
/// @return true if the reply indicates success
bool parseReply(const Json::Value & reply);
private: