Beeper.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Utils_Beeper_
#define HH_SENF_Utils_Beeper_ 1

// Custom includes
#include <string>
#include <senf/Scheduler/TimerEvent.hh>

//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    class Beeper
    {
    public:
        Beeper(std::string const & device = "/dev/console");
        ~Beeper();

        void beep_sync(float freq, unsigned length, unsigned count = 1, unsigned delay = 100);

        void beep_async(float freq, unsigned length, unsigned count = 1, unsigned delay = 100);

        void stop_beep();               
        bool start_beep(float freq);    

    private:
        static const unsigned CLOCK_TICK_RATE = 1193180;

        int fd_;
        scheduler::TimerEvent timer_;

#ifndef DOXYGEN
        struct {
            float freq;
            unsigned length;
            unsigned count;
            unsigned delay;
            bool action;
        } params_;
#endif

        void timeout();
    };

}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "Beeper.cci"
//#include "Beeper.ct"
//#include "Beeper.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: