src/servo/es08a.h

   1 /*
   2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <string>
  27 #include "servo.h"
  28
  29 namespace upm {
  30
  31 #define MIN_PULSE_WIDTH      600
  32 #define MAX_PULSE_WIDTH      2500
  33
  34 /**
  35  * @brief C++ API for ES08A servo component
  36  *
  37  * This file defines the ES08A C++ interface for libes08a
  38  *
  39  * @snippet es08a.cxx Interesting
  40  *
  41  */
  42 class ES08A : public Servo {
  43     public:
  44         /**
  45          * Instanciates a ES08A object
  46          *
  47          * @param pin servo pin number
  48          */
  49         ES08A (int pin);
  50
  51         /**
  52          * ES08A object destructor.
  53          */
  54         ~ES08A ();
  55 };
  56
  57 }