HardwarePWM.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * HardwarePWM.h
 *
 * Original Author: https://github.com/hrsavla
 *
 * This HW_PWM library enables Sming framework user to use ESP SDK PWM API
 * Period of PWM is fixed to 1000ms / Frequency = 1khz
 * Duty at 100% = 22222. Duty at 0% = 0
 * You can use function setPeriod() to change frequency/period.
 * Calculate the Duty as per the formulae give in ESP8266 SDK
 * Duty = (Period *1000)/45
 *
 * PWM can be generated on up to 8 pins (ie All pins except pin 16)
 * Created on August 17, 2015, 2:27 PM
 *
 ****/
 
#pragma once
 
#include <cstdint>
#include <driver/pwm.h>
 
#define PWM_BAD_CHANNEL 0xff 
 
class HardwarePWM
{
public:
    HardwarePWM(const uint8_t* pins, uint8_t no_of_pins);
 
    virtual ~HardwarePWM();
 
    bool analogWrite(uint8_t pin, uint32_t duty)
    {
        return setDuty(pin, duty);
    }
 
    bool setDutyChan(uint8_t chan, uint32_t duty, bool update = true);
 
    bool setDuty(uint8_t pin, uint32_t duty, bool update = true)
    {
        uint8_t chan = getChannel(pin);
        return setDutyChan(chan, duty, update);
    }
 
    uint32_t getDutyChan(uint8_t chan) const;
 
    uint32_t getDuty(uint8_t pin)
    {
        uint8_t chan = getChannel(pin);
        return getDutyChan(chan);
    }
 
    void setPeriod(uint32_t period);
 
    uint32_t getPeriod() const;
 
    uint8_t getChannel(uint8_t pin) const;
 
    uint32_t getMaxDuty() const
    {
        return maxduty;
    }
 
    void update();
 
    uint32_t getFrequency(uint8_t pin) const;
 
private:
    uint8_t channel_count;
    uint8_t channels[PWM_CHANNEL_NUM_MAX];
    uint32_t maxduty{0};
};