pwm.hpp

/*
 * Author: Brendan Le Foll <brendan.le.foll@intel.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include "pwm.h"
#include <stdexcept>

namespace mraa {

class Pwm {
    public:
        Pwm(int pin, bool owner=true, int chipid=-1) {
            if (chipid == -1) {
                m_pwm = mraa_pwm_init(pin);
            }
            else {
                m_pwm = mraa_pwm_init_raw(pin, chipid);
            }

            if (m_pwm == NULL) {
                throw std::invalid_argument("Error initialising PWM on pin");
            }

            if (!owner) {
                mraa_pwm_owner(m_pwm, 0);
            }
        }
        ~Pwm() {
            mraa_pwm_close(m_pwm);
        }
        mraa_result_t write(float percentage) {
            return mraa_pwm_write(m_pwm, percentage);
        }
        float read() {
            return mraa_pwm_read(m_pwm);
        }
        mraa_result_t period(float period) {
            return mraa_pwm_period(m_pwm, period);
        }
        mraa_result_t period_ms(int ms) {
            return mraa_pwm_period_ms(m_pwm, ms);
        }
        mraa_result_t period_us(int us) {
            return mraa_pwm_period_us(m_pwm, us);
        }
        mraa_result_t pulsewidth(float seconds) {
            return mraa_pwm_pulsewidth(m_pwm, seconds);
        }
        mraa_result_t pulsewidth_ms(int ms) {
            return mraa_pwm_pulsewidth_ms(m_pwm, ms);
        }
        mraa_result_t pulsewidth_us(int us) {
            return mraa_pwm_pulsewidth_us(m_pwm, us);
        }
        mraa_result_t enable(bool enable) {
            if (enable)
                return mraa_pwm_enable(m_pwm, 1);
            else
                return mraa_pwm_enable(m_pwm, 0);
        }
        mraa_result_t config_ms(int period, float duty) {
            return mraa_pwm_config_ms(m_pwm, period, duty);
        }
        mraa_result_t config_percent(int period, float duty) {
            return mraa_pwm_config_percent(m_pwm, period, duty);
        }

    private:
        mraa_pwm_context m_pwm;
};

}