rover_button.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:
 *    RoverButton API - Interfaces for Rover button application development - Header file
 *
 * Contributors:
 *    M.Ozcelikors <mozcelikors@gmail.com>, created C++API 05.12.2017
 *
 */

#ifndef ROVERAPI_ROVER_BUTTON_HPP_
#define ROVERAPI_ROVER_BUTTON_HPP_


#include <roverapi/rover_gpio.hpp>

namespace rover
{

    enum RoverButtonType_t { USER_BUTTON = 0,
                             SHUTDOWN_BUTTON = 1,
                             CUSTOM_BUTTON = 2};

    class RoverButton : public RoverGpio
    {
        private:
            static const int SHUTDOWN_BUTTON_PIN = 29;  //BCM-21, wiringpi 29

            static const int USER_BUTTON_PIN = 27;      //BCM-16, wiringpi 27

            int buttonPin;

            RoverButtonType_t buttonType;

            int ROVERBUTTON_INIT_;

        public:
            RoverButton (const RoverButtonType_t button_type);

            void initialize (void);

            int readButton (void);

            void setButtonPin (const int button_pin);
    };
}


#endif /* ROVERAPI_ROVER_BUTTON_HPP_ */