rover_buzzer.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2017 FH Dortmund and others
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Description:
 *    RoverBuzzer API - Interfaces for Rover buzzer application development
 *    Header file
 *
 * Contributors:
 *    M.Ozcelikors <mozcelikors@gmail.com>, created C++API 05.12.2017
 *
 */

#ifndef ROVERAPI_ROVER_BUZZER_HPP_
#define ROVERAPI_ROVER_BUZZER_HPP_

#include <roverapi/rover_gpio.hpp>

namespace rover
{
    class RoverBuzzer : public RoverGpio
    {
        private:
            /* Pins */
            static const int DEFAULT_BUZZER_PIN = 28; //BCM-20, wiringpi 28

            int BUZZER_PIN;

            /* Variable members */
            int BUZZER_FREQUENCY;

            int ROVERBUZZER_INIT_;

        public:

            RoverBuzzer();

            void initialize (void);

            void setBuzzerFrequency (const int buzzer_freq);

            int getBuzzerFrequency (void);

            void setBuzzerOn (void);

            void setBuzzerOff (void);

            void setBuzzerPin (const int pin);

            void setBuzzerTone (const int buzzer_freq);

            void shutdownTone (void);
    };
}


#endif /* ROVERAPI_ROVER_BUZZER_HPP_ */