MAV'RIC
/home/travis/build/lis-epfl/MAVRIC_Library/hal/common/pwm.hpp
00001 /*******************************************************************************
00002  * Copyright (c) 2009-2016, MAV'RIC Development Team
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright notice,
00009  * this list of conditions and the following disclaimer.
00010  *
00011  * 2. Redistributions in binary form must reproduce the above copyright notice,
00012  * this list of conditions and the following disclaimer in the documentation
00013  * and/or other materials provided with the distribution.
00014  *
00015  * 3. Neither the name of the copyright holder nor the names of its contributors
00016  * may be used to endorse or promote products derived from this software without
00017  * specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00020  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00023  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00024  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00025  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00026  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00027  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00028  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00029  * POSSIBILITY OF SUCH DAMAGE.
00030  ******************************************************************************/
00031 
00032 /*******************************************************************************
00033  * \file pwm.hpp
00034  *
00035  * \author MAV'RIC Team
00036  * \author Felix Schill
00037  * \author Julien Lecoeur
00038  * \author Nicolas Dousse
00039  *
00040  * \brief Abstract class for PWM
00041  *
00042  ******************************************************************************/
00043 
00044 
00045 #ifndef PWM_HPP_
00046 #define PWM_HPP_
00047 
00048 #include <cstdbool>
00049 #include <cstdint>
00050 
00051 class Pwm
00052 {
00053 public:
00059     virtual bool init(void) = 0;
00060 
00061 
00069     virtual bool set_pulse_width_us(uint16_t pulse_us) = 0;
00070 
00071 
00079     virtual bool set_period_us(uint16_t period_us) = 0;
00080 };
00081 
00082 
00083 #endif /* PWM_HPP_ */
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines