//
// OOSMOS pwm Class
//
// Copyright (C) 2014-2020  OOSMOS, LLC
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 2 of the License ("GPLv2").
//
// This software may be used without the GPLv2 restrictions by entering
// into a commercial license agreement with OOSMOS, LLC.
// See <https://www.oosmos.com/licensing/>.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef pwm_h
#define pwm_h

#include <stdint.h>

typedef struct pwmTag pwm;

extern pwm * pwmNew(unsigned PinNumber, double DutyCyclePercent);
extern void  pwmSetDutyCyclePercent(pwm * pPWM, double DutyCyclePercent); // 0.0%-100.0%

extern void  pwmOn(pwm * pPWM);
extern void  pwmOff(pwm * pPWM);

#if defined(ESP32)
  extern double   pwmGetSignalFrequency(pwm * pPWM);
  extern void     pwmSetSignalFrequency(pwm * pPWM, double SignalFrequency);

  extern uint32_t pwmGetDutyCycleResolution(pwm * pPWM);
  extern void     pwmSetDutyCycleResolution(pwm * pPWM, uint32_t Resolution);
#endif

#endif
