PushButton.h

00001 /*******************************************************************************
00002  * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a
00005  * copy of this software and associated documentation files (the "Software"),
00006  * to deal in the Software without restriction, including without limitation
00007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008  * and/or sell copies of the Software, and to permit persons to whom the
00009  * Software is furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included
00012  * in all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020  * OTHER DEALINGS IN THE SOFTWARE.
00021  *
00022  * Except as contained in this notice, the name of Maxim Integrated
00023  * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024  * Products, Inc. Branding Policy.
00025  *
00026  * The mere transfer of this software does not imply any licenses
00027  * of trade secrets, proprietary technology, copyrights, patents,
00028  * trademarks, maskwork rights, or any other form of intellectual
00029  * property whatsoever. Maxim Integrated Products, Inc. retains all
00030  * ownership rights.
00031  *******************************************************************************
00032  */
00033 #ifndef _PUSHBUTTON_H
00034 #define _PUSHBUTTON_H
00035 
00036 #include "mbed.h"
00037 
00038 class PushButton {
00039 public:
00040   /**
00041   * @brief Constructor with a PinName
00042   */
00043   PushButton(PinName pin);
00044   /**
00045   * @brief Get the pushed state of the button
00046   */
00047   bool GetButtonFallState(void);
00048   /**
00049   * @brief Clear the pushed state of the button
00050   */
00051   void clearButtonFallState(void);
00052   /**
00053   * @brief Read the button input
00054   * @return Represented as 0 or 1 (int)
00055   */
00056   int Read(void);
00057   /**
00058   * @brief Set the state
00059   * @param state Set the button state to this value
00060   */
00061   void SetButtonFallState(bool state);
00062 
00063 private:
00064   InterruptIn interruptButton;
00065   bool buttonFallState;
00066   PinName pin;
00067 };
00068 
00069 #endif /* _PUSHBUTTON_H */