yocto_colorledcluster.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_colorledcluster.h 29186 2017-11-16 10:04:13Z seb $
 *
 * Declares yFindColorLedCluster(), the high-level API for ColorLedCluster functions
 *
 * - - - - - - - - - License information: - - - - - - - - -
 *
 *  Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
 *
 *  Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
 *  non-exclusive license to use, modify, copy and integrate this
 *  file into your software for the sole purpose of interfacing
 *  with Yoctopuce products.
 *
 *  You may reproduce and distribute copies of this file in
 *  source or object form, as long as the sole purpose of this
 *  code is to interface with Yoctopuce products. You must retain
 *  this notice in the distributed source file.
 *
 *  You should refer to Yoctopuce General Terms and Conditions
 *  for additional information regarding your rights and
 *  obligations.
 *
 *  THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
 *  WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 *  WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
 *  EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
 *  INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
 *  COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
 *  SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
 *  LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
 *  CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
 *  BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
 *  WARRANTY, OR OTHERWISE.
 *
 *********************************************************************/


#ifndef YOCTO_COLORLEDCLUSTER_H
#define YOCTO_COLORLEDCLUSTER_H

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

//--- (YColorLedCluster return codes)
//--- (end of YColorLedCluster return codes)
//--- (YColorLedCluster definitions)
class YColorLedCluster; // forward declaration

typedef void (*YColorLedClusterValueCallback)(YColorLedCluster *func, const string& functionValue);
#define Y_ACTIVELEDCOUNT_INVALID        (YAPI_INVALID_UINT)
#define Y_MAXLEDCOUNT_INVALID           (YAPI_INVALID_UINT)
#define Y_BLINKSEQMAXCOUNT_INVALID      (YAPI_INVALID_UINT)
#define Y_BLINKSEQMAXSIZE_INVALID       (YAPI_INVALID_UINT)
#define Y_COMMAND_INVALID               (YAPI_INVALID_STRING)
//--- (end of YColorLedCluster definitions)

//--- (YColorLedCluster declaration)
class YOCTO_CLASS_EXPORT YColorLedCluster: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YColorLedCluster declaration)
protected:
    //--- (YColorLedCluster attributes)
    // Attributes (function value cache)
    int             _activeLedCount;
    int             _maxLedCount;
    int             _blinkSeqMaxCount;
    int             _blinkSeqMaxSize;
    string          _command;
    YColorLedClusterValueCallback _valueCallbackColorLedCluster;

    friend YColorLedCluster *yFindColorLedCluster(const string& func);
    friend YColorLedCluster *yFirstColorLedCluster(void);

    // Function-specific method for parsing of JSON output and caching result
    virtual int     _parseAttr(YJSONObject* json_val);

    // Constructor is protected, use yFindColorLedCluster factory function to instantiate
    YColorLedCluster(const string& func);
    //--- (end of YColorLedCluster attributes)

public:
    ~YColorLedCluster();
    //--- (YColorLedCluster accessors declaration)

    static const int ACTIVELEDCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int MAXLEDCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int BLINKSEQMAXCOUNT_INVALID = YAPI_INVALID_UINT;
    static const int BLINKSEQMAXSIZE_INVALID = YAPI_INVALID_UINT;
    static const string COMMAND_INVALID;

    int                 get_activeLedCount(void);

    inline int          activeLedCount(void)
    { return this->get_activeLedCount(); }

    int             set_activeLedCount(int newval);
    inline int      setActiveLedCount(int newval)
    { return this->set_activeLedCount(newval); }

    int                 get_maxLedCount(void);

    inline int          maxLedCount(void)
    { return this->get_maxLedCount(); }

    int                 get_blinkSeqMaxCount(void);

    inline int          blinkSeqMaxCount(void)
    { return this->get_blinkSeqMaxCount(); }

    int                 get_blinkSeqMaxSize(void);

    inline int          blinkSeqMaxSize(void)
    { return this->get_blinkSeqMaxSize(); }

    string              get_command(void);

    inline string       command(void)
    { return this->get_command(); }

    int             set_command(const string& newval);
    inline int      setCommand(const string& newval)
    { return this->set_command(newval); }

    static YColorLedCluster* FindColorLedCluster(string func);

    virtual int         registerValueCallback(YColorLedClusterValueCallback callback);
    using YFunction::registerValueCallback;

    virtual int         _invokeValueCallback(string value);

    virtual int         sendCommand(string command);

    virtual int         set_rgbColor(int ledIndex,int count,int rgbValue);

    virtual int         set_rgbColorAtPowerOn(int ledIndex,int count,int rgbValue);

    virtual int         set_hslColor(int ledIndex,int count,int hslValue);

    virtual int         rgb_move(int ledIndex,int count,int rgbValue,int delay);

    virtual int         hsl_move(int ledIndex,int count,int hslValue,int delay);

    virtual int         addRgbMoveToBlinkSeq(int seqIndex,int rgbValue,int delay);

    virtual int         addHslMoveToBlinkSeq(int seqIndex,int hslValue,int delay);

    virtual int         addMirrorToBlinkSeq(int seqIndex);

    virtual int         addJumpToBlinkSeq(int seqIndex,int linkSeqIndex);

    virtual int         addUnlinkToBlinkSeq(int seqIndex);

    virtual int         linkLedToBlinkSeq(int ledIndex,int count,int seqIndex,int offset);

    virtual int         linkLedToBlinkSeqAtPowerOn(int ledIndex,int count,int seqIndex,int offset);

    virtual int         linkLedToPeriodicBlinkSeq(int ledIndex,int count,int seqIndex,int periods);

    virtual int         unlinkLedFromBlinkSeq(int ledIndex,int count);

    virtual int         startBlinkSeq(int seqIndex);

    virtual int         stopBlinkSeq(int seqIndex);

    virtual int         resetBlinkSeq(int seqIndex);

    virtual int         set_blinkSeqStateAtPowerOn(int seqIndex,int autostart);

    virtual int         set_blinkSeqSpeed(int seqIndex,int speed);

    virtual int         saveLedsConfigAtPowerOn(void);

    virtual int         saveLedsState(void);

    virtual int         saveBlinkSeq(int seqIndex);

    virtual int         set_rgbColorBuffer(int ledIndex,string buff);

    virtual int         set_rgbColorArray(int ledIndex,vector<int> rgbList);

    virtual int         rgbArrayOfs_move(int ledIndex,vector<int> rgbList,int delay);

    virtual int         rgbArray_move(vector<int> rgbList,int delay);

    virtual int         set_hslColorBuffer(int ledIndex,string buff);

    virtual int         set_hslColorArray(int ledIndex,vector<int> hslList);

    virtual int         hslArray_move(vector<int> hslList,int delay);

    virtual int         hslArrayOfs_move(int ledIndex,vector<int> hslList,int delay);

    virtual string      get_rgbColorBuffer(int ledIndex,int count);

    virtual vector<int> get_rgbColorArray(int ledIndex,int count);

    virtual vector<int> get_rgbColorArrayAtPowerOn(int ledIndex,int count);

    virtual vector<int> get_linkedSeqArray(int ledIndex,int count);

    virtual vector<int> get_blinkSeqSignatures(int seqIndex,int count);

    virtual vector<int> get_blinkSeqStateSpeed(int seqIndex,int count);

    virtual vector<int> get_blinkSeqStateAtPowerOn(int seqIndex,int count);

    virtual vector<int> get_blinkSeqState(int seqIndex,int count);


    inline static YColorLedCluster* Find(string func)
    { return YColorLedCluster::FindColorLedCluster(func); }

           YColorLedCluster *nextColorLedCluster(void);
    inline YColorLedCluster *next(void)
    { return this->nextColorLedCluster();}

           static YColorLedCluster* FirstColorLedCluster(void);
    inline static YColorLedCluster* First(void)
    { return YColorLedCluster::FirstColorLedCluster();}
#ifdef __BORLANDC__
#pragma option pop
#endif
    //--- (end of YColorLedCluster accessors declaration)
};

//--- (YColorLedCluster functions declaration)

inline YColorLedCluster* yFindColorLedCluster(const string& func)
{ return YColorLedCluster::FindColorLedCluster(func);}
inline YColorLedCluster* yFirstColorLedCluster(void)
{ return YColorLedCluster::FirstColorLedCluster();}

//--- (end of YColorLedCluster functions declaration)

#endif