yocto_buzzer.h

Go to the documentation of this file.

/*********************************************************************
 *
 * $Id: yocto_buzzer.h 28748 2017-10-03 08:23:39Z seb $
 *
 * Declares yFindBuzzer(), the high-level API for Buzzer 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_BUZZER_H
#define YOCTO_BUZZER_H

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

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

typedef void (*YBuzzerValueCallback)(YBuzzer *func, const string& functionValue);
#define Y_FREQUENCY_INVALID             (YAPI_INVALID_DOUBLE)
#define Y_VOLUME_INVALID                (YAPI_INVALID_UINT)
#define Y_PLAYSEQSIZE_INVALID           (YAPI_INVALID_UINT)
#define Y_PLAYSEQMAXSIZE_INVALID        (YAPI_INVALID_UINT)
#define Y_PLAYSEQSIGNATURE_INVALID      (YAPI_INVALID_UINT)
#define Y_COMMAND_INVALID               (YAPI_INVALID_STRING)
//--- (end of YBuzzer definitions)

//--- (YBuzzer declaration)
class YOCTO_CLASS_EXPORT YBuzzer: public YFunction {
#ifdef __BORLANDC__
#pragma option push -w-8022
#endif
//--- (end of YBuzzer declaration)
protected:
    //--- (YBuzzer attributes)
    // Attributes (function value cache)
    double          _frequency;
    int             _volume;
    int             _playSeqSize;
    int             _playSeqMaxSize;
    int             _playSeqSignature;
    string          _command;
    YBuzzerValueCallback _valueCallbackBuzzer;

    friend YBuzzer *yFindBuzzer(const string& func);
    friend YBuzzer *yFirstBuzzer(void);

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

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

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

    static const double FREQUENCY_INVALID;
    static const int VOLUME_INVALID = YAPI_INVALID_UINT;
    static const int PLAYSEQSIZE_INVALID = YAPI_INVALID_UINT;
    static const int PLAYSEQMAXSIZE_INVALID = YAPI_INVALID_UINT;
    static const int PLAYSEQSIGNATURE_INVALID = YAPI_INVALID_UINT;
    static const string COMMAND_INVALID;

    int             set_frequency(double newval);
    inline int      setFrequency(double newval)
    { return this->set_frequency(newval); }

    double              get_frequency(void);

    inline double       frequency(void)
    { return this->get_frequency(); }

    int                 get_volume(void);

    inline int          volume(void)
    { return this->get_volume(); }

    int             set_volume(int newval);
    inline int      setVolume(int newval)
    { return this->set_volume(newval); }

    int                 get_playSeqSize(void);

    inline int          playSeqSize(void)
    { return this->get_playSeqSize(); }

    int                 get_playSeqMaxSize(void);

    inline int          playSeqMaxSize(void)
    { return this->get_playSeqMaxSize(); }

    int                 get_playSeqSignature(void);

    inline int          playSeqSignature(void)
    { return this->get_playSeqSignature(); }

    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 YBuzzer*     FindBuzzer(string func);

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

    virtual int         _invokeValueCallback(string value);

    virtual int         sendCommand(string command);

    virtual int         addFreqMoveToPlaySeq(int freq,int msDelay);

    virtual int         addPulseToPlaySeq(int freq,int msDuration);

    virtual int         addVolMoveToPlaySeq(int volume,int msDuration);

    virtual int         addNotesToPlaySeq(string notes);

    virtual int         startPlaySeq(void);

    virtual int         stopPlaySeq(void);

    virtual int         resetPlaySeq(void);

    virtual int         oncePlaySeq(void);

    virtual int         pulse(int frequency,int duration);

    virtual int         freqMove(int frequency,int duration);

    virtual int         volumeMove(int volume,int duration);

    virtual int         playNotes(string notes);


    inline static YBuzzer* Find(string func)
    { return YBuzzer::FindBuzzer(func); }

           YBuzzer         *nextBuzzer(void);
    inline YBuzzer         *next(void)
    { return this->nextBuzzer();}

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

//--- (YBuzzer functions declaration)

inline YBuzzer* yFindBuzzer(const string& func)
{ return YBuzzer::FindBuzzer(func);}
inline YBuzzer* yFirstBuzzer(void)
{ return YBuzzer::FirstBuzzer();}

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

#endif